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

BuildT

using BuildT = typename ChildT::BuildType

CoordT

using CoordT = typename ChildT::CoordType

KeyT

using KeyT = uint64_t

Return a key based on the coordinates of a voxel.

StatsT

using StatsT = typename ChildT::FloatType

ValueT

using ValueT = typename ChildT::ValueType

Constructor & Destructor Documentation

RootData() [1/2]

RootData ( )

delete

This class cannot be constructed or deleted.

RootData() [2/2]

RootData ( const RootData< ChildT > &  )

delete

~RootData()

~RootData ( )

delete

Member Function Documentation

average()

const StatsT& average ( ) const

inline

CoordToKey()

static KeyT CoordToKey ( const CoordType &  ijk )

inlinestatic

getChild() [1/2]

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

getChild() [2/2]

const ChildT* getChild ( const Tile *  tile ) const

inline

getMax()

const ValueT& getMax ( ) const

inline

getMin()

const ValueT& getMin ( ) const

inline

KeyToCoord()

static CoordT KeyToCoord ( const KeyT &  key )

inlinestatic

operator=()

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

delete

setAvg()

void setAvg ( const StatsT &  v )

inline

setDev()

void setDev ( const StatsT &  v )

inline

setMax()

void setMax ( const ValueT &  v )

inline

setMin()

void setMin ( const ValueT &  v )

inline

stdDeviation()

const StatsT& stdDeviation ( ) const

inline

tile() [1/2]

Tile* tile ( uint32_t  n )

inline

tile() [2/2]

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

Member Data Documentation

FIXED_SIZE

constexpr bool FIXED_SIZE = false

staticconstexpr

mAverage

StatsT mAverage

mBackground

ValueT mBackground

mBBox

BBox<CoordT> mBBox

mMaximum

ValueT mMaximum

mMinimum

ValueT mMinimum

mStdDevi

StatsT mStdDevi

mTableSize

uint32_t mTableSize