Package com.openinventor.inventor.actions

Enum Class SoAction.DistribModes

java.lang.Object
java.lang.Enum<SoAction.DistribModes>
com.openinventor.inventor.actions.SoAction.DistribModes
All Implemented Interfaces:
IntegerValuedEnum, Serializable, Comparable<SoAction.DistribModes>, Constable
Enclosing class:
SoAction
public static enum SoAction.DistribModes extends Enum<SoAction.DistribModes> implements IntegerValuedEnum
(Extender API) This is used to define the way an action is distributed across a cluster.

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 Details

    • LOCAL_ONLY

      public static final SoAction.DistribModes LOCAL_ONLY
      Action is only applied by the application.

    • CLUSTER_ONLY

      public static final SoAction.DistribModes CLUSTER_ONLY
      Action is only applied by OIRU of the cluster.

    • ALL

      public static final SoAction.DistribModes ALL
      Both application and cluster apply the action.

  • Method Details

    • values

      public static SoAction.DistribModes[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SoAction.DistribModes valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • valueOf

      public static SoAction.DistribModes 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.