SoLDMResourceParameters::FixedResolutionReport Struct Reference

This structure returns information to the application when fixedResolution is TRUE and resolution is not -1. More...

#include <LDM/nodes/SoLDMResourceParameters.h>

Public Types
enum	ReportCode {   PROGRESS ,   ABORT }
	Available report code. More...

Public Attributes
ReportCode	what
	Report code.
int	numTilesToAdd
	How many more tiles need to be allowed in main memory.
int	numTilesToLoad
	How many tiles need to be loaded.
int	numTilesLoaded
	Number of tiles LDM has already loaded.

Detailed Description

This structure returns information to the application when fixedResolution is TRUE and resolution is not -1.

Definition at line 81 of file SoLDMResourceParameters.h.

Member Enumeration Documentation

ReportCode

enum SoLDMResourceParameters::FixedResolutionReport::ReportCode

Available report code.

Enumerator
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	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.

Definition at line 85 of file SoLDMResourceParameters.h.

Member Data Documentation

numTilesLoaded

int SoLDMResourceParameters::FixedResolutionReport::numTilesLoaded

Number of tiles LDM has already loaded.

The value of this variable is relevant only if the callback is called with a PROGRESS report code.

Definition at line 145 of file SoLDMResourceParameters.h.

numTilesToAdd

int SoLDMResourceParameters::FixedResolutionReport::numTilesToAdd

How many more tiles need to be allowed in main memory.

The value of this variable is relevant only if the callback is called with an ABORT report code. An automatic memory adjustment is possible by calling setMaxTilesInMainMem( getMaxTilesInMainMem() + numTilesToAdd ) and then reenabling the fixed resolution mode within the callback function.

Definition at line 135 of file SoLDMResourceParameters.h.

numTilesToLoad

int SoLDMResourceParameters::FixedResolutionReport::numTilesToLoad

How many tiles need to be loaded.

The value of this variable is relevant only if the callback is called with a PROGRESS report code.

Definition at line 140 of file SoLDMResourceParameters.h.

what

ReportCode SoLDMResourceParameters::FixedResolutionReport::what

Report code.

Definition at line 127 of file SoLDMResourceParameters.h.

---

The documentation for this struct was generated from the following file:

• LDM/nodes/SoLDMResourceParameters.h