Package com.openinventor.inventor.fields

Enum Class SoSFImage3.CopyPolicies

java.lang.Object

java.lang.Enum<SoSFImage3.CopyPolicies>

com.openinventor.inventor.fields.SoSFImage3.CopyPolicies

All Implemented Interfaces:

IntegerValuedEnum, Serializable, Comparable<SoSFImage3.CopyPolicies>, Constable

Enclosing class:

SoSFImage3

public static enum SoSFImage3.CopyPolicies
extends Enum<SoSFImage3.CopyPolicies>
implements IntegerValuedEnum

SoSFImage3 may be manipulating some large amounts of memory. It is therefore convienent to be able to set the memory usage policy dynamically (copying a small 256x256x256 image with only 8 bits color already takes 16MB). By default, the memory policy is COPY, which is consistent with other OIV fields. The most likely to be efficient is NO_COPY. See also setNeverWrite.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COPY	Open Inventor will make a copy of the data (default)
NO_COPY	Passed buffer used.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the integer value of the enum constant.
static SoSFImage3.CopyPolicies	valueOf(int val)	Returns the enum constant of this type with the specified integer value
static SoSFImage3.CopyPolicies	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SoSFImage3.CopyPolicies[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COPY

public static final SoSFImage3.CopyPolicies COPY

Open Inventor will make a copy of the data (default)

NO_COPY

public static final SoSFImage3.CopyPolicies NO_COPY

Passed buffer used.

Method Details

values

public static SoSFImage3.CopyPolicies[] 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 SoSFImage3.CopyPolicies 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 SoSFImage3.CopyPolicies 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.