Package com.openinventor.volumeviz.nodes

Enum Class SoVolumeRender.NumSlicesControls

java.lang.Object
java.lang.Enum<SoVolumeRender.NumSlicesControls>
com.openinventor.volumeviz.nodes.SoVolumeRender.NumSlicesControls
All Implemented Interfaces:
IntegerValuedEnum, Serializable, Comparable<SoVolumeRender.NumSlicesControls>, Constable
Enclosing class:
SoVolumeRender
public static enum SoVolumeRender.NumSlicesControls extends Enum<SoVolumeRender.NumSlicesControls> implements IntegerValuedEnum
Number of samples control mode. Used with numSlicesControl field.

  • Enum Constant Details

    • ALL

      public static final SoVolumeRender.NumSlicesControls ALL
      Use all samples. The number of samples depends on the viewing direction.

    • MANUAL

      public static final SoVolumeRender.NumSlicesControls MANUAL
      Use the number of samples specified by the numSlices field. The number of samples does not depend on the viewing direction.

    • AUTOMATIC

      public static final SoVolumeRender.NumSlicesControls AUTOMATIC
      (Recommended) Use a number of samples computed as follows:
      If numSlices is greater than zero, then
      n = complexity * 2 * numSlices
      where complexity comes from the value of field SoComplexity.value and numSlices comes from the numSlices field. The number of samples does not depend on the viewing direction.

      If numSlices is any value less than or equal to 0, the dimension of the volume data is used instead of numSlices, so
      n = complexity * 2 * volumeDimension
      The number of samples depends on the viewing direction.

      The factor 2 is used because by default complexity is equal to 0.5. So, by default, the behavior for numSlices greater than zero is the same as MANUAL and the default behavior for numSlices less than or equal to zero is the same as ALL.
      You can increase the complexity up to 1.0, which would double the number of samples used. You can decrease the complexity to reduce the number of samples used. The global alpha is corrected so that the brightness looks the same.

    • MAIN_AXIS

      public static final SoVolumeRender.NumSlicesControls MAIN_AXIS
      Use a number of samples computed as follows:
      n = complexity * 2 * volumeDataDimension[mainVisibleAxis]
      where complexity comes from the value of field SoComplexity.value. The number of samples depends on the viewing direction.

      Since:
      Open Inventor 8.1

  • Method Details

    • values

      public static SoVolumeRender.NumSlicesControls[] 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 SoVolumeRender.NumSlicesControls 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 SoVolumeRender.NumSlicesControls 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.