com.openinventor.ldm.nodes

Enum SoLDMResourceParameters.FixedResolutionReport.ReportCodes

java.lang.Object

java.lang.Enum<SoLDMResourceParameters.FixedResolutionReport.ReportCodes>

com.openinventor.ldm.nodes.SoLDMResourceParameters.FixedResolutionReport.ReportCodes

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoLDMResourceParameters.FixedResolutionReport.ReportCodes>

Enclosing class:

SoLDMResourceParameters.FixedResolutionReport

public static enum SoLDMResourceParameters.FixedResolutionReport.ReportCodes
extends java.lang.Enum<SoLDMResourceParameters.FixedResolutionReport.ReportCodes>
implements IntegerValuedEnum

Available report code.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT If LDM cannot grant a fixed resolution request, the callback function is called with an ABORT report code.
PROGRESS Loading in progress.

Method Summary

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

PROGRESS

public static final SoLDMResourceParameters.FixedResolutionReport.ReportCodes PROGRESS

Loading in progress. In this case, the progress is indicated by the two variables numTilesToLoad and numTilesLoaded. The current resources of the machine allow LDM to load the data at the specified resolution. In this case, the only possible way to receive an ABORT report code from the system is either if the user changes the resources (i.e., decreases the main memory space), or add some new geometry to the scene.

ABORT

public static final SoLDMResourceParameters.FixedResolutionReport.ReportCodes ABORT

If LDM cannot grant a fixed resolution request, the callback function is called with an ABORT report code. In this case, LDM will automatically disable the fixed resolution mode. The FixedResolutionCB callback will be called with an ABORT report code in the following cases:

• The request to load the data at the specified resolution level (resolution argument in the enableFixedResolutionMode function) in main memory for the current geometry (either SoVolumeRender, SoVolumeSkin, SoOrthoSlice, SoObliqueSlice, volume geometries, or other LDM based render nodes) is not possible because the main memory space (set by the setMaxMainMemory function) is not large enough. In this case, the callback is called with an ABORT code immediately after the first sceneGraph traversal, once the fixed resolution mode has been enabled.
• There was a geometry change (i.e., a geometry node was added to the scene graph) and there is not enough room in memory for the geometry nodes to be displayed at the current resolution level. In this case, the memory space needed in addition for LDM to be able to grant the request, is specified by the numTilesToAdd variable. If there is enough main memory resources on the user machine, an automatic memory adjustment can then be realized by calling setMaxTilesInMainMem( getMaxTilesInMainMem() + numTilesToAdd ) right before enableFixedResolutionMode is called again. Those two calls can be done within the callback function so LDM does not disable the fixed resolution mode after an ABORT report code has been sent.

Method Detail

values

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

Returns:

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

valueOf

public static SoLDMResourceParameters.FixedResolutionReport.ReportCodes 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 SoLDMResourceParameters.FixedResolutionReport.ReportCodes 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 SoLDMResourceParameters.FixedResolutionReport.ReportCodes 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.