RootData< ChildT > Struct Template Reference

Struct with all the member data of the RootNode (useful during serialization of an openvdb RootNode) More...

#include <nanovdb/NanoVDB.h>

Inherited by RootNode< ChildT > [private].

Classes
struct	Tile

Public Types
using	ValueT = typename ChildT::ValueType
using	BuildT = typename ChildT::BuildType
using	CoordT = typename ChildT::CoordType
using	StatsT = typename ChildT::FloatType
using	KeyT = uint64_t
	Return a key based on the coordinates of a voxel. More...

Public Member Functions
const Tile *	tile (uint32_t n) const
	Returns a non-const reference to the tile at the specified linear offset. More...
Tile *	tile (uint32_t n)
ChildT *	getChild (const Tile *tile)
	Returns a const reference to the child node in the specified tile. More...
const ChildT *	getChild (const Tile *tile) const
const ValueT &	getMin () const
const ValueT &	getMax () const
const StatsT &	average () const
const StatsT &	stdDeviation () const
void	setMin (const ValueT &v)
void	setMax (const ValueT &v)
void	setAvg (const StatsT &v)
void	setDev (const StatsT &v)
	RootData ()=delete
	This class cannot be constructed or deleted. More...
	RootData (const RootData &)=delete
RootData &	operator= (const RootData &)=delete
	~RootData ()=delete

Static Public Member Functions
template<typename CoordType >
static KeyT	CoordToKey (const CoordType &ijk)
static CoordT	KeyToCoord (const KeyT &key)

Public Attributes
BBox< CoordT >	mBBox
uint32_t	mTableSize
ValueT	mBackground
ValueT	mMinimum
ValueT	mMaximum
StatsT	mAverage
StatsT	mStdDevi

Static Public Attributes
static constexpr bool	FIXED_SIZE = false

Detailed Description

template<typename ChildT>
struct nanovdb::RootData< ChildT >

Struct with all the member data of the RootNode (useful during serialization of an openvdb RootNode)

Note

No client code should (or can) interface with this struct so it can safely be ignored!

Member Typedef Documentation

using BuildT = typename ChildT::BuildType

using CoordT = typename ChildT::CoordType

using KeyT = uint64_t

Return a key based on the coordinates of a voxel.

using StatsT = typename ChildT::FloatType

using ValueT = typename ChildT::ValueType

Constructor & Destructor Documentation

RootData ( )

delete

This class cannot be constructed or deleted.

RootData ( const RootData< ChildT > &  )

delete

~RootData ( )

delete

Member Function Documentation

const StatsT& average ( ) const

inline

static KeyT CoordToKey ( const CoordType &  ijk )

inlinestatic

ChildT* getChild ( const Tile *  tile )

inline

Returns a const reference to the child node in the specified tile.

Warning

A child node is assumed to exist in the specified tile

const ChildT* getChild ( const Tile *  tile ) const

inline

const ValueT& getMax ( ) const

inline

const ValueT& getMin ( ) const

inline

static CoordT KeyToCoord ( const KeyT &  key )

inlinestatic

RootData& operator= ( const RootData< ChildT > &  )

delete

void setAvg ( const StatsT &  v )

inline

void setDev ( const StatsT &  v )

inline

void setMax ( const ValueT &  v )

inline

void setMin ( const ValueT &  v )

inline

const StatsT& stdDeviation ( ) const

inline

const Tile* tile ( uint32_t  n ) const

inline

Returns a non-const reference to the tile at the specified linear offset.

Warning

The linear offset is assumed to be in the valid range

Tile* tile ( uint32_t  n )

inline

Member Data Documentation

constexpr bool FIXED_SIZE = false

static

StatsT mAverage

ValueT mBackground

BBox<CoordT> mBBox

ValueT mMaximum

ValueT mMinimum

StatsT mStdDevi

uint32_t mTableSize