Package com.openinventor.inventor.actions

Enum SoAction.PathCodes

  • All Implemented Interfaces:
    IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoAction.PathCodes>
    Enclosing class:
    SoAction
    public static enum SoAction.PathCodes
extends java.lang.Enum<SoAction.PathCodes>
implements IntegerValuedEnum
    (Extender API) This enum may be used during traversal of nodes to indicate where the node is with respect to the path being traversed.

    Extender API is dedicated to extend the toolkit. This api is available to programmers who wish to extend the toolkit. We strongly suggest to use it only in the cases described in the Toolmaker guide such as creating a new class inherited from SoNode. See Open Inventor Toolmaker.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BELOW_PATH
      Tail node of path or below tail node.
      IN_PATH
      In middle of path chain (not tail node)
      NO_PATH
      Not traversing a path.
      OFF_PATH
      None of the above (Probably to the left)

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the integer value of the enum constant.
      static SoAction.PathCodes valueOf​(int val)
      Returns the enum constant of this type with the specified integer value
      static SoAction.PathCodes valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SoAction.PathCodes[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • IN_PATH

        public static final SoAction.PathCodes IN_PATH
        In middle of path chain (not tail node)

      • BELOW_PATH

        public static final SoAction.PathCodes BELOW_PATH
        Tail node of path or below tail node.

      • OFF_PATH

        public static final SoAction.PathCodes OFF_PATH
        None of the above (Probably to the left)

    • Method Detail

      • values

        public static SoAction.PathCodes[] 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 (SoAction.PathCodes c : SoAction.PathCodes.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SoAction.PathCodes 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 name
        java.lang.NullPointerException - if the argument is null

      • valueOf

        public static SoAction.PathCodes valueOf​(int val)
        Returns the enum constant of this type with the specified integer value
        Returns:
        the enum constant of this type with the specified integer value.

      • getValue

        public int getValue()
        Description copied from interface: IntegerValuedEnum
        Returns the integer value of the enum constant.
        Specified by:
        getValue in interface IntegerValuedEnum
        Returns:
        the integer value of the enum constant.