SoLDMTopoOctree Class

Octree topology queries.

Inheritance Hierarchy

SystemObject
OIV.InventorSoNetBase
OIV.LDMSoLDMTopoOctree

Namespace: OIV.LDM
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoLDMTopoOctree : SoNetBase

Public Class SoLDMTopoOctree
	Inherits SoNetBase

public ref class SoLDMTopoOctree : public SoNetBase

type SoLDMTopoOctree =  
    class
        inherit SoNetBase
    end

The SoLDMTopoOctree type exposes the following members.

Constructors

	Name	Description
	SoLDMTopoOctree	Constructor.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetFileID	Given a tileID, returns the corresponding fileID.
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetLevelMax	Returns the maximum level of the octree tile hierarchy.
	GetNumFileIDs	Returns the number of fileIDs in the volume.
	GetNumTileIDs	Returns the number of tileIDs in the complete (conceptual) octree.
	GetTileID(Int32)	Given a fileID, returns the corresponding tileID.
	GetTileID(SbVec3i32, Int32)	Given the position of a voxel in full resolution voxel coordinates (i,j,k) and a resolution level, returns the tile ID of the corresponding tile.
	GetTilePos	Returns the bounding box, in voxel/cell coordinates, of the specified tile.
	GetTileSize	Return the tilesize used to setup this octree.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Init(SbVec3i32, Int32)	Calls Init(dimension, tileDim, System.Int32(0)).
	Init(SbVec3i32, Int32, Int32)	Initialize with the properties of the data set.
	IsEmpty	Returns false if the octree is empty.
	Level(Int64)	Returns the tile level of the given tile Id.
	Level(SoLDMTileID)	Returns the tile level of the given tile Id.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The OIV.LDM.SoLDMTopoOctree class provides information about the hierarchy of LDM tiles used for a given dataset, which depends only on the dataset dimensions and the tile dimensions.

For example, an application can query the total number of LDM tiles in a data set, the number of resolution levels in the LDM tile hierarchy, the id of the tile that contains a specified voxel position, the position and extent of a specified tile id, and more. An application can conveniently query the OIV.LDM.SoLDMTopoOctree for an actual data set using the OIV.LDM.Nodes.SoDataSet.GetLDMTopoOctree() method or create an LDMTopoOctree object with any specified dimensions. In the latter case, the LDMTopoOctree must be initialized using the OIV.LDM.SoLDMTopoOctree.Init(OIV.Inventor.SbVec3i32, System.Int32, System.Int32) method.

In VolumeViz LDM every tile has both a tileID and a fileID. The tileID is the unique identifier of a tile in the (conceptual) complete, symmetrical hierarchy. The fileID is the index of a tile in a sequential numbering of all the tiles that actually contain data. The tileID is normally used to identify tiles in an application, but the fileID is used, for example, when calling the readTile method in an OIV.LDM.Readers.SoVolumeReader class. In a cubical volume (all three dimensions the same), there are equal numbers of tileIDs and fileIDs, but in most volumes there are many fewer fileIDs than tileIDs.

The terms 'resolution' and 'level' are both used in this class to identify a specific level in the LDM tile hierarchy.

Resolution level is counted up from the bottom. So resolution level 0 is the full resolution tiles. The OIV.LDM.SoLDMTopoOctree.GetTileID(OIV.Inventor.SbVec3i32, System.Int32) method takes resolution level as a parameter.
Tile level is counted down from the top. So tile level 0 is the lowest resolution tile (tile 0) at the top of the hierarchy. The OIV.LDM.SoLDMTopoOctree.Level(OIV.LDM.SoLDMTileID) method returns the tile level, not the resolution level.
Conversion: tileLevel = OIV.LDM.SoLDMTopoOctree.GetLevelMax() - resolutionLevel.

Reference

OIV.LDM Namespace

OIV.LDM.SoLDMTileID