com.openinventor.ldm

Class SoLDMNodeFrontManager

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.ldm.SoLDMLargeDataManagement

com.openinventor.ldm.SoLDMNodeFrontManager

public class SoLDMNodeFrontManager
extends SoLDMLargeDataManagement

LDM Node Front Manager abstract base class. This class is only needed for advanced users who intend to extend or replace internal LDM algorithms.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

The SoLDMNodeFrontManager is in charge of maintaining a data structure representing the multiresolution organization of the data stored on disk and the state of this data in main memory for a specific frame (tiles loaded in main memory and their importance and attributes for rendering).

The set of tiles of higher weights in this data structure represent the best available textures to fit in texture memory for the frame to render. This collection is the result of the data structure evaluation.

An evaluation of the structure is performed when LDM asks (getNextTexFront, getNextSliceTexFront, getOrderedDataFront) for an update of the texture node front and if the SoLDMNodeFrontManager was previously notified that something changed (geomChangeNotify, resourceChangeNotify, movingChangeNotify) e.g., some geometry has changed, some new tiles have been loaded, etc.

The SoLDMNodeFrontManager asks the SoLDMTileVisitor to compute the weight of each node. Based on these weights, decisions are made to either refine (load tiles of higher resolution) or collapse the multiresolution system (unload). The SoLDMNodeFrontManager works under constraints given by the SoLDMResourceManager (number of texture allowed in texture memory and texture load rate).

If the user does not interact with the model, the quality of the rendering will increase until it reaches an optimal state. The asynchronous loading process continues loading until the weight of the next tile to load is less than the weight of the next tile to unload meaning that the optimal collection of tiles is present in main memory and in texture memory.

See also:

SoLDMResourceManager, SoLDMTileManager

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
void	geomChangeNotify() Calls geomChangeNotify(false).
void	geomChangeNotify(boolean redraw) Notifies SoLDMNodeFrontManager that it's necessary to re-evaluate the data structure due to geometry or property changes.
SoLDMTileID	getDataTileID(SoLDMTileID tileID) Given a tileID, returns the tileID whose data will be used for the input tileID.
int	getFileID(SoLDMTileID tileID) Returns the file ID corresponding to the specified tile ID (ID of the tile in the file).
long	getMaxTileIDAtResolution(int level) return the maximum tileID at a given depth.
int	getMinResolution() Returns how many different subsample levels of the data set the data stores.
int	getNextLoadedStepLevel(int id) Return the level of the next time step.
int	getNumFileIDs() Returns the total number of file IDs used ( < getNumTileIDs() ).
SoLDMTileID	getShape2dTexTileID(SoLdmShape shape, SoLDMTileID tileID) Same thing as getTexTileID but for a 2d shape.
SoLDMTileID	getTexTileID(SoLDMTileID tileID) Given a tileID, returns the tileID whose texture will be used for the input tileID.
SoLDMTileID	getTileID(SbVec3i32 cellPos) Calls getTileID(cellPos, (int)0).
SoLDMTileID	getTileID(SbVec3i32 cellPos, int resolution) Given the position of a cell (i,j,k) and the resolution, returns the tile ID of the corresponding tile.
int	getTileLevel(SoLDMTileID tileID) return the depth of the given tileID.
SbBox3i32	getTilePos(SoLDMTileID tileID) Returns the tile position in data coordinates of the specified tile ID.
float	getWeight(SoLDMTileID tileID) Utility function to get a tile's weight.
boolean	isSliceTexFrontEmpty(int name_17645) Indicates if there is no texture to be loaded yet because nothing is in main memory.
boolean	isTextureFrontEmpty() Indicates if there is no texture to be loaded yet because nothing is in main memory.
void	movingChangeNotify(boolean movingValue) Notifies SoLDMNodeFrontManager if the user is interacting with the scene or not.
int	registerSlice(SoShape name_17636) This function must be called by a slice to notify the nodeFrontManager that a new data structure must be maintained for it.
void	reset2dTexFronts(SoLdmShape shape)
void	resourceChangeNotify() Notifies SoLDMNodeFrontManager that texture resources have changed and the front needs to be recalculated.
void	setSliceMaxVisualResolution(int sliceID, int res) Set the maximum display resolution of slice sliceID.
void	setSlicePlane(int sliceID, SbPlane plane) Tells SoLDMNodeFrontManager what plane the slice is in.
void	shouldInit() Indicates that the manager should be initialized.
void	startTraversalNotify() This function is called at the beginning of each traversal and can be used to initialize whatever variables are necessary for the SoLDMNodeFrontManager.
void	unRegisterSlice(int sliceID) Notifies SoLDMNodeFrontManager that the slice of ID sliceID is no longer valid.

Methods inherited from class com.openinventor.ldm.SoLDMLargeDataManagement

reset

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTileID

public SoLDMTileID getTileID(SbVec3i32 cellPos)

Calls getTileID(cellPos, (int)0).

geomChangeNotify

public void geomChangeNotify()

Calls geomChangeNotify(false).

getDataTileID

public SoLDMTileID getDataTileID(SoLDMTileID tileID)

Given a tileID, returns the tileID whose data will be used for the input tileID. In other words, the tileID returned is in the data front managed by the Tile Manager and may be the input tileID or its closest ancestor in the front.

reset2dTexFronts

public void reset2dTexFronts(SoLdmShape shape)

getFileID

public int getFileID(SoLDMTileID tileID)

Returns the file ID corresponding to the specified tile ID (ID of the tile in the file). Returns 0 if the tile is outside of the real data set (i.e., no data is present in the file for this tile).

getTilePos

public SbBox3i32 getTilePos(SoLDMTileID tileID)

Returns the tile position in data coordinates of the specified tile ID.

getNumFileIDs

public int getNumFileIDs()

Returns the total number of file IDs used ( < getNumTileIDs() ).
m_numFileIDs must be initialized the first time getNextTexFront is called.

If the data set has dimension x,y,z, then getNumTileIds represents the number of tiles in a cubic data set of dimension D, where

D = nearest greater power of 2 to max(x,y,z)

(This number varies depending on the topology used). A fileID represents the ID of a tile that is actually used and is 0 if the tile is outside of the actual non cubic data set of dimension x,y,z.

getNumFileIDs returns the number of non null fileIds and is used by the Tile Manager. (It represents the maximum number of non-empty tiles that can be present in main memory.)

getTexTileID

public SoLDMTileID getTexTileID(SoLDMTileID tileID)

Given a tileID, returns the tileID whose texture will be used for the input tileID. In other words, the tileID returned is in the texture front and may be the input tileID or its closest ancestor in the front.

getShape2dTexTileID

public SoLDMTileID getShape2dTexTileID(SoLdmShape shape,
                                       SoLDMTileID tileID)

Same thing as getTexTileID but for a 2d shape.

getMinResolution

public int getMinResolution()

Returns how many different subsample levels of the data set the data stores. The number returned is the power of 2 of the lowest resolution.

getTileID

public SoLDMTileID getTileID(SbVec3i32 cellPos,
                             int resolution)

Given the position of a cell (i,j,k) and the resolution, returns the tile ID of the corresponding tile.

getWeight

public float getWeight(SoLDMTileID tileID)

Utility function to get a tile's weight.

startTraversalNotify

public void startTraversalNotify()

This function is called at the beginning of each traversal and can be used to initialize whatever variables are necessary for the SoLDMNodeFrontManager.

getMaxTileIDAtResolution

public long getMaxTileIDAtResolution(int level)

return the maximum tileID at a given depth. Used to prioritize tiles until a given level of resolution

setSlicePlane

public void setSlicePlane(int sliceID,
                          SbPlane plane)

Tells SoLDMNodeFrontManager what plane the slice is in.

geomChangeNotify

public void geomChangeNotify(boolean redraw)

Notifies SoLDMNodeFrontManager that it's necessary to re-evaluate the data structure due to geometry or property changes. The redraw flag specifies whether to redraw the data set or not.

isTextureFrontEmpty

public boolean isTextureFrontEmpty()

Indicates if there is no texture to be loaded yet because nothing is in main memory.

movingChangeNotify

public void movingChangeNotify(boolean movingValue)

Notifies SoLDMNodeFrontManager if the user is interacting with the scene or not.

isSliceTexFrontEmpty

public boolean isSliceTexFrontEmpty(int name_17645)

Indicates if there is no texture to be loaded yet because nothing is in main memory.

resourceChangeNotify

public void resourceChangeNotify()

Notifies SoLDMNodeFrontManager that texture resources have changed and the front needs to be recalculated.

setSliceMaxVisualResolution

public void setSliceMaxVisualResolution(int sliceID,
                                        int res)

Set the maximum display resolution of slice sliceID.

getNextLoadedStepLevel

public int getNextLoadedStepLevel(int id)

Return the level of the next time step.

getTileLevel

public int getTileLevel(SoLDMTileID tileID)

return the depth of the given tileID.

unRegisterSlice

public void unRegisterSlice(int sliceID)

Notifies SoLDMNodeFrontManager that the slice of ID sliceID is no longer valid.

shouldInit

public void shouldInit()

Indicates that the manager should be initialized.

registerSlice

public int registerSlice(SoShape name_17636)

This function must be called by a slice to notify the nodeFrontManager that a new data structure must be maintained for it. The returned value indicates whether the slice has already been registered (true) or not.