com.openinventor.ldm

Enum SoLDMGlobalResourceParameters.TileCacheTypes

java.lang.Object

java.lang.Enum<SoLDMGlobalResourceParameters.TileCacheTypes>

com.openinventor.ldm.SoLDMGlobalResourceParameters.TileCacheTypes

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoLDMGlobalResourceParameters.TileCacheTypes>

Enclosing class:

SoLDMGlobalResourceParameters

Deprecated.

public static enum SoLDMGlobalResourceParameters.TileCacheTypes
extends java.lang.Enum<SoLDMGlobalResourceParameters.TileCacheTypes>
implements IntegerValuedEnum

Tile cache management policy. See the Memory Management section above for more information including the definitions of CPU Tile Cache and BufferObject cache. Used with setTileCacheType() method.

For tiled data that is not compressed (e.g. a standard LDM format file), the TileCacheType setting has no effect and only the CPU tile cache is used.

Setting the SoPreferences variable LDM_USE_IN_MEM_COMPRESSION to false (zero) effectively sets the tile cache type to mode 'ALL'. Deprecated since Open Inventor 9630
Moved to SoLDMResourceParameters in OIV 10.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Deprecated. For non-tiled data like DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU) and all tiles (both low resolution and full resolution) are stored in the CPU tile cache.
FULLRES_ONLY Deprecated. This option really means "low res only" (the name is fixed is OIV 10).
LOWRES_ONLY Deprecated. FULLRES_ONLY was renamed to LOWRES_ONLY in OIV10, this is here to help transition.
NONE Deprecated. For non-tiled data like DICOM or SEGY or an in-memory volume, no tiles are are stored in the CPU tile cache.

Method Summary

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

NONE

public static final SoLDMGlobalResourceParameters.TileCacheTypes NONE

Deprecated.

For non-tiled data like DICOM or SEGY or an in-memory volume, no tiles are are stored in the CPU tile cache. All tiles are created when needed (e.g. to send data to the GPU), calling the volume reader (SoVolumeReader) and all tiles (both low resolution and full resolution) are stored temporarily in the BufferObject cache. The CPU tile cache is not used. If the entire volume fits in GPU memory, then tiles will only be created once, otherwise performance will be reduced because some time is required when tiles need to be re-created and are not in the BufferObject cache.

For compressed tiled data (e.g. an LDM format file created with compression), the compressed tiles are stored in the CPU tile cache "as is" to reduce the memory requirement. Uncompressed tiles are created from the compressed data when needed (to send data to the GPU) and are stored temporarily in the BufferObject cache.

This mode saves memory but can reduce interactivity.

FULLRES_ONLY

public static final SoLDMGlobalResourceParameters.TileCacheTypes FULLRES_ONLY

Deprecated.

This option really means "low res only" (the name is fixed is OIV 10). For non-tiled data like DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU), but low resolution tiles are stored in the CPU tile cache and full resolution tiles are stored in the BufferObject cache.

For compressed tiled data (e.g. an LDM format file created with compression), low resolution tiles are uncompressed when loaded and stored uncompressed in the CPU tile cache. Full resolution tiles are stored compressed in the CPU tile cache (to reduce the CPU memory requirement). Uncompressed full resolution tiles are created from the compressed data when needed (to send data to the GPU) and are stored in the BufferObject cache.

This setting uses more memory than 'NONE' but saves time when low resolution tiles need to be sent to the GPU. It uses less memory than 'ALL'.

ALL

public static final SoLDMGlobalResourceParameters.TileCacheTypes ALL

Deprecated.

For non-tiled data like DICOM or SEGY or an in-memory volume, tiles are created when needed (to send data to the GPU) and all tiles (both low resolution and full resolution) are stored in the CPU tile cache. This mode is recommended for non-tiled volumes loaded from disk when the volume will fit in memory (generally true for medical volumes).
NOTE: For an in-memory volume, this setting will duplicate the data in memory. For an in-memory volume it's better to use the LOWRES_ONLY or NONE setting.

For tiled data that is compressed (e.g. an LDM format file created with compression), all tiles are uncompressed when loaded and stored uncompressed in the CPU tile cache.

This setting uses the most memory, but saves time when tiles need to be sent to the GPU. The BufferObject cache is not used.

LOWRES_ONLY

public static final SoLDMGlobalResourceParameters.TileCacheTypes LOWRES_ONLY

Deprecated.

FULLRES_ONLY was renamed to LOWRES_ONLY in OIV10, this is here to help transition. Added at the end for better compatibility

Method Detail

values

public static SoLDMGlobalResourceParameters.TileCacheTypes[] values()

Deprecated.

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 (SoLDMGlobalResourceParameters.TileCacheTypes c : SoLDMGlobalResourceParameters.TileCacheTypes.values())
    System.out.println(c);

Returns:

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

valueOf

public static SoLDMGlobalResourceParameters.TileCacheTypes valueOf(java.lang.String name)

Deprecated.

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 SoLDMGlobalResourceParameters.TileCacheTypes 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 SoLDMGlobalResourceParameters.TileCacheTypes valueOf(int val)

Deprecated.

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()

Deprecated.

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.