Package com.openinventor.ldm.nodes

Enum SoROI.FlagsType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CROSS  
      CROSS_INVERT  
      ENABLE_X0
      Enable cropping with X slab for term 0 (stage 1)
      ENABLE_X1
      Enable cropping with X slab for term 1 (stage 1)
      ENABLE_X2
      Enable cropping with X slab for term 2 (stage 1)
      ENABLE_Y0
      Enable cropping with Y slab for term 0 (stage 1)
      ENABLE_Y1
      Enable cropping with Y slab for term 1 (stage 1)
      ENABLE_Y2
      Enable cropping with Y slab for term 2 (stage 1)
      ENABLE_Z0
      Enable cropping with Z slab for term 0 (stage 1)
      ENABLE_Z1
      Enable cropping with Z slab for term 1 (stage 1)
      ENABLE_Z2
      Enable cropping with Z slab for term 2 (stage 1)
      EXCLUSION_BOX  
      FENCE  
      FENCE_INVERT  
      INVERT_0
      Invert result for this term 0 (stage 2)
      INVERT_1
      Invert result for this term 1 (stage 2)
      INVERT_2
      Invert result for this term 2 (stage 2)
      INVERT_OUTPUT
      Stage 4: If enabled, the result of stage 4 (union or intersection) is inverted as the last step in cropping
      OR_SELECT
      Stage 3: If set, the result is the union (OR) of term 0, term 1, and term 2.
      SUB_VOLUME
      Convenient enums.

    • 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 SoROI.FlagsType valueOf​(int val)
      Returns the enum constant of this type with the specified integer value
      static SoROI.FlagsType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SoROI.FlagsType[] 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

      • ENABLE_X0

        public static final SoROI.FlagsType ENABLE_X0
        Enable cropping with X slab for term 0 (stage 1)

      • ENABLE_Y0

        public static final SoROI.FlagsType ENABLE_Y0
        Enable cropping with Y slab for term 0 (stage 1)

      • ENABLE_Z0

        public static final SoROI.FlagsType ENABLE_Z0
        Enable cropping with Z slab for term 0 (stage 1)

      • INVERT_0

        public static final SoROI.FlagsType INVERT_0
        Invert result for this term 0 (stage 2)

      • ENABLE_X1

        public static final SoROI.FlagsType ENABLE_X1
        Enable cropping with X slab for term 1 (stage 1)

      • ENABLE_Y1

        public static final SoROI.FlagsType ENABLE_Y1
        Enable cropping with Y slab for term 1 (stage 1)

      • ENABLE_Z1

        public static final SoROI.FlagsType ENABLE_Z1
        Enable cropping with Z slab for term 1 (stage 1)

      • INVERT_1

        public static final SoROI.FlagsType INVERT_1
        Invert result for this term 1 (stage 2)

      • ENABLE_X2

        public static final SoROI.FlagsType ENABLE_X2
        Enable cropping with X slab for term 2 (stage 1)

      • ENABLE_Y2

        public static final SoROI.FlagsType ENABLE_Y2
        Enable cropping with Y slab for term 2 (stage 1)

      • ENABLE_Z2

        public static final SoROI.FlagsType ENABLE_Z2
        Enable cropping with Z slab for term 2 (stage 1)

      • INVERT_2

        public static final SoROI.FlagsType INVERT_2
        Invert result for this term 2 (stage 2)

      • OR_SELECT

        public static final SoROI.FlagsType OR_SELECT
        Stage 3: If set, the result is the union (OR) of term 0, term 1, and term 2. If clear, the result is the intersection (AND) of the three terms

      • INVERT_OUTPUT

        public static final SoROI.FlagsType INVERT_OUTPUT
        Stage 4: If enabled, the result of stage 4 (union or intersection) is inverted as the last step in cropping

      • SUB_VOLUME

        public static final SoROI.FlagsType SUB_VOLUME
        Convenient enums.

    • Method Detail

      • values

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

      • valueOf

        public static SoROI.FlagsType 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 SoROI.FlagsType 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.