Enum RegionCutRule
- java.lang.Object
-
- java.lang.Enum<RegionCutRule>
-
- org.apache.commons.geometry.core.partitioning.bsp.RegionCutRule
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<RegionCutRule>
public enum RegionCutRule extends java.lang.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 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.
-
Constructor Summary
Constructors Modifier Constructor Description private
RegionCutRule()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static RegionCutRule
valueOf(java.lang.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.
-
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-