org.apache.commons.geometry.core.partitioning.bsp

Enum RegionCutRule

java.lang.Object

java.lang.Enum<RegionCutRule>

org.apache.commons.geometry.core.partitioning.bsp.RegionCutRule

All Implemented Interfaces:

Serializable, Comparable<RegionCutRule>

public enum RegionCutRule
extends Enum<RegionCutRule>

Enum describing the possible behaviors when cutting a region BSP tree node with a hyperplane to produce two new child nodes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INHERIT Set both child nodes to the same location as the parent node.
MINUS_INSIDE Set the minus side of the cutting hyperplane as the inside of the region and the plus side as the outside.
PLUS_INSIDE Set the plus side of the cutting hyperplane as the inside of the region and the minus side as the outside.

Method Summary

Modifier and Type	Method and Description
static RegionCutRule	valueOf(String name) Returns the enum constant of this type with the specified name.
static RegionCutRule[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MINUS_INSIDE

public static final RegionCutRule MINUS_INSIDE

Set the minus side of the cutting hyperplane as the inside of the region and the plus side as the outside. This is the default convention for hyperplanes.

PLUS_INSIDE

public static final RegionCutRule PLUS_INSIDE

Set the plus side of the cutting hyperplane as the inside of the region and the minus side as the outside.

INHERIT

public static final RegionCutRule INHERIT

Set both child nodes to the same location as the parent node. For example, if the parent node is marked as inside, both child nodes will be marked as inside. Similarly if the parent node is marked as outside, both child nodes will be marked as outside. This rule can be used to modify the tree structure (to perhaps produce a more efficient, balanced tree) without changing the represented region.

Method Detail

values

public static RegionCutRule[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RegionCutRule c : RegionCutRule.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RegionCutRule valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null