com.openinventor.volumeviz.nodes

Enum SoVolumeRender.NumSlicesControls

java.lang.Object

java.lang.Enum<SoVolumeRender.NumSlicesControls>

com.openinventor.volumeviz.nodes.SoVolumeRender.NumSlicesControls

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoVolumeRender.NumSlicesControls>

Enclosing class:

SoVolumeRender

public static enum SoVolumeRender.NumSlicesControls
extends java.lang.Enum<SoVolumeRender.NumSlicesControls>
implements IntegerValuedEnum

Number of samples control mode. Used with numSlicesControl field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Use all samples The number of samples depends on the viewing direction.
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 field of the SoComplexity node and numSlices comes from the numSlices field.
MAIN_AXIS Use a number of samples computed as follows: n = complexity * 2 * volumeDataDimension[mainVisibleAxis] where complexity comes from the #value field of the SoComplexity node.
MANUAL Use the number of samples specified by the numSlices field.

Method Summary

Modifier and Type	Method and Description
static SoVolumeRender.NumSlicesControls	fromValue(int val) Deprecated. Use valueOf(int) instead.
int	getValue() Returns the integer value of the enum constant.
static SoVolumeRender.NumSlicesControls	valueOf(int val) Returns the enum constant of this type with the specified integer value
static SoVolumeRender.NumSlicesControls	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SoVolumeRender.NumSlicesControls[]	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

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 field of the SoComplexity node 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 field of the SoComplexity node. The number of samples depends on the viewing direction.

Since:

Open Inventor 8.1

Method Detail

values

public static SoVolumeRender.NumSlicesControls[] 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 (SoVolumeRender.NumSlicesControls c : SoVolumeRender.NumSlicesControls.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

fromValue

@Deprecated
public static SoVolumeRender.NumSlicesControls fromValue(int val)

Deprecated. Use valueOf(int) instead.

Returns the enum constant of this type with the specified integer value

Returns:

the enum constant of this type with the specified integer value.

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.