Package com.openinventor.imageviz.engines

Enum SoImageVizEngine.ComputeModes

java.lang.Object

java.lang.Enum<SoImageVizEngine.ComputeModes>

com.openinventor.imageviz.engines.SoImageVizEngine.ComputeModes

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoImageVizEngine.ComputeModes>

Enclosing class:

SoImageVizEngine

public static enum SoImageVizEngine.ComputeModes
extends java.lang.Enum<SoImageVizEngine.ComputeModes>
implements IntegerValuedEnum

Compute Mode This enum specifies whether the main input will be interpreted as a 3D volume or a stack of 2D images for processing.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODE_2D	The engine processes the input image as a stack of 2D images (slice by slice).
MODE_3D	The engine processes the input image as a 3D volume.
MODE_AUTO	The inputs determine if the processing should be applied in 2D or 3D mode.

Method Summary

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

MODE_2D

public static final SoImageVizEngine.ComputeModes MODE_2D

The engine processes the input image as a stack of 2D images (slice by slice).

MODE_3D

public static final SoImageVizEngine.ComputeModes MODE_3D

The engine processes the input image as a 3D volume.

MODE_AUTO

public static final SoImageVizEngine.ComputeModes MODE_AUTO

The inputs determine if the processing should be applied in 2D or 3D mode. Depending on the expected results, it may be necessary to set explicitly MODE_2D or MODE_3D.

Method Detail

values

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

Returns:

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

valueOf

public static SoImageVizEngine.ComputeModes 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 SoImageVizEngine.ComputeModes 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.