Enum BSPTree.FindNodeCutRule

java.lang.Object
java.lang.Enum<BSPTree.FindNodeCutRule>
org.apache.commons.geometry.core.partitioning.bsp.BSPTree.FindNodeCutRule
All Implemented Interfaces:
Serializable, Comparable<BSPTree.FindNodeCutRule>
Enclosing interface:
BSPTree<P extends Point<P>,N extends BSPTree.Node<P,N>>

public static enum BSPTree.FindNodeCutRule extends Enum<BSPTree.FindNodeCutRule>
Enum specifying possible behaviors when a point used to locate a node falls directly on the cut of an internal node.
  • Enum Constant Details

    • MINUS

      public static final BSPTree.FindNodeCutRule MINUS
      Choose the minus child of the internal node and continue searching. This behavior will result in a leaf node always being returned by the node search.
    • PLUS

      public static final BSPTree.FindNodeCutRule PLUS
      Choose the plus child of the internal node and continue searching. This behavior will result in a leaf node always being returned by the node search.
    • NODE

      public static final BSPTree.FindNodeCutRule NODE
      Choose the internal node and stop searching. This behavior may result in non-leaf nodes being returned by the node search.
  • Constructor Details

    • FindNodeCutRule

      private FindNodeCutRule()
  • Method Details

    • values

      public static BSPTree.FindNodeCutRule[] 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 BSPTree.FindNodeCutRule 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