OpenVDB  11.0.0
Public Member Functions | Static Public Member Functions | List of all members
GridMetaData Class Reference

This is a convenient class that allows for access to grid meta-data that are independent of the value type of a grid. That is, this class can be used to get information about a grid without actually knowing its ValueType. More...

#include <nanovdb/NanoVDB.h>

Public Member Functions

template<typename T >
 GridMetaData (const NanoGrid< T > &grid)
 
 GridMetaData (const GridData *gridData)
 
bool safeCast () const
 return true if the RootData follows right after the TreeData. If so, this implies that it's safe to cast the grid from which this instance was constructed to a GridMetaData More...
 
bool isValid () const
 
const GridTypegridType () const
 
const GridClassgridClass () const
 
bool isLevelSet () const
 
bool isFogVolume () const
 
bool isStaggered () const
 
bool isPointIndex () const
 
bool isGridIndex () const
 
bool isPointData () const
 
bool isMask () const
 
bool isUnknown () const
 
bool hasMinMax () const
 
bool hasBBox () const
 
bool hasLongGridName () const
 
bool hasAverage () const
 
bool hasStdDeviation () const
 
bool isBreadthFirst () const
 
uint64_t gridSize () const
 
uint32_t gridIndex () const
 
uint32_t gridCount () const
 
const char * shortGridName () const
 
const Mapmap () const
 
const BBox< Vec3d > & worldBBox () const
 
const BBox< Coord > & indexBBox () const
 
Vec3d voxelSize () const
 
int blindDataCount () const
 
uint64_t activeVoxelCount () const
 
const uint32_t & activeTileCount (uint32_t level) const
 
uint32_t nodeCount (uint32_t level) const
 
uint64_t checksum () const
 
uint32_t rootTableSize () const
 
bool isEmpty () const
 
Version version () const
 

Static Public Member Functions

static bool safeCast (const GridData *gridData)
 return true if it is safe to cast the grid to a pointer of type GridMetaData, i.e. construction can be avoided. More...
 
template<typename T >
static bool safeCast (const NanoGrid< T > &grid)
 return true if it is safe to cast the grid to a pointer of type GridMetaData, i.e. construction can be avoided. More...
 

Detailed Description

This is a convenient class that allows for access to grid meta-data that are independent of the value type of a grid. That is, this class can be used to get information about a grid without actually knowing its ValueType.

Constructor & Destructor Documentation

GridMetaData ( const NanoGrid< T > &  grid)
inline
GridMetaData ( const GridData gridData)
inline

Member Function Documentation

const uint32_t& activeTileCount ( uint32_t  level) const
inline
uint64_t activeVoxelCount ( ) const
inline
int blindDataCount ( ) const
inline
uint64_t checksum ( ) const
inline
const GridClass& gridClass ( ) const
inline
uint32_t gridCount ( ) const
inline
uint32_t gridIndex ( ) const
inline
uint64_t gridSize ( ) const
inline
const GridType& gridType ( ) const
inline
bool hasAverage ( ) const
inline
bool hasBBox ( ) const
inline
bool hasLongGridName ( ) const
inline
bool hasMinMax ( ) const
inline
bool hasStdDeviation ( ) const
inline
const BBox<Coord>& indexBBox ( ) const
inline
bool isBreadthFirst ( ) const
inline
bool isEmpty ( ) const
inline
bool isFogVolume ( ) const
inline
bool isGridIndex ( ) const
inline
bool isLevelSet ( ) const
inline
bool isMask ( ) const
inline
bool isPointData ( ) const
inline
bool isPointIndex ( ) const
inline
bool isStaggered ( ) const
inline
bool isUnknown ( ) const
inline
bool isValid ( ) const
inline
const Map& map ( ) const
inline
uint32_t nodeCount ( uint32_t  level) const
inline
uint32_t rootTableSize ( ) const
inline
bool safeCast ( ) const
inline

return true if the RootData follows right after the TreeData. If so, this implies that it's safe to cast the grid from which this instance was constructed to a GridMetaData

static bool safeCast ( const GridData gridData)
inlinestatic

return true if it is safe to cast the grid to a pointer of type GridMetaData, i.e. construction can be avoided.

static bool safeCast ( const NanoGrid< T > &  grid)
inlinestatic

return true if it is safe to cast the grid to a pointer of type GridMetaData, i.e. construction can be avoided.

const char* shortGridName ( ) const
inline
Version version ( ) const
inline
Vec3d voxelSize ( ) const
inline
const BBox<Vec3d>& worldBBox ( ) const
inline