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 Details

    • 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.
  • Constructor Details

    • RegionCutRule

      private RegionCutRule()
  • Method Details

    • values

      public static RegionCutRule[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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