OpenVDB: InternalData< ChildT, LOG2DIM > Struct Template Reference

OpenVDB 10.0.1

Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
InternalData< ChildT, LOG2DIM > Struct Template Reference

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

`#include <nanovdb/NanoVDB.h>`

## Classes
union | Tile

## Public Types
using | ValueT = typename ChildT::ValueType
using | BuildT = typename ChildT::BuildType
using | StatsT = typename ChildT::FloatType
using | CoordT = typename ChildT::CoordType
using | MaskT = typename ChildT::template MaskType< LOG2DIM >

## Public Member Functions
void | setChild (uint32_t n, const void *ptr)
template<typename ValueT >
void | setValue (uint32_t n, const ValueT &v)
ChildT * | getChild (uint32_t n)
| Returns a pointer to the child node at the specifed linear offset. More...
const ChildT * | getChild (uint32_t n) const
ValueT | getValue (uint32_t n) const
bool | isActive (uint32_t n) const
bool | isChild (uint32_t n) const
template<typename T >
void | setOrigin (const T &ijk)
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)
| InternalData ()=delete
| This class cannot be constructed or deleted. More...
| InternalData (const InternalData &)=delete
InternalData & | operator= (const InternalData &)=delete
| ~InternalData ()=delete

## Static Public Member Functions
static constexpr uint32_t | padding ()
| Return padding of this class in bytes, due to aliasing and 32B alignment. More...
static uint64_t | memUsage ()

## Public Attributes
BBox< CoordT > | mBBox
uint64_t | mFlags
MaskT | mValueMask
MaskT | mChildMask
ValueT | mMinimum
ValueT | mMaximum
StatsT | mAverage
StatsT | mStdDevi
Tile | mTable [1u<<(3 *LOG2DIM)]

## Static Public Attributes
static constexpr bool | FIXED_SIZE = true

## Detailed Description

template<typename ChildT, uint32_t LOG2DIM>
struct nanovdb::InternalData< ChildT, LOG2DIM >

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

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

## ◆ MaskT

using MaskT = typename ChildT::template MaskType<LOG2DIM>

## ◆ StatsT

using StatsT = typename ChildT::FloatType

## ◆ ValueT

using ValueT = typename ChildT::ValueType

## Constructor & Destructor Documentation

## ◆ InternalData() [1/2]

InternalData | ( |  | ) |
| delete

This class cannot be constructed or deleted.

## ◆ InternalData() [2/2]

InternalData | ( | const InternalData< ChildT, LOG2DIM > & |  | ) |
| delete

## ◆ ~InternalData()

~InternalData | ( |  | ) |
| delete

## Member Function Documentation

## ◆ average()

const StatsT & average | ( |  | ) | const
| inline

## ◆ getChild() [1/2]

ChildT * getChild | ( | uint32_t | n | ) |
| inline

Returns a pointer to the child node at the specifed linear offset.

## ◆ getChild() [2/2]

const ChildT * getChild | ( | uint32_t | n | ) | const
| inline

## ◆ getMax()

const ValueT & getMax | ( |  | ) | const
| inline

## ◆ getMin()

const ValueT & getMin | ( |  | ) | const
| inline

## ◆ getValue()

ValueT getValue | ( | uint32_t | n | ) | const
| inline

## ◆ isActive()

bool isActive | ( | uint32_t | n | ) | const
| inline

## ◆ isChild()

bool isChild | ( | uint32_t | n | ) | const
| inline

## ◆ memUsage()

static uint64_t memUsage | ( |  | ) |
| inlinestatic

## ◆ operator=()

InternalData & operator= | ( | const InternalData< ChildT, LOG2DIM > & |  | ) |
| delete

## ◆ padding()

static constexpr uint32_t padding | ( |  | ) |
| inlinestaticconstexpr

Return padding of this class in bytes, due to aliasing and 32B alignment.

Note
  The extra bytes are not necessarily at the end, but can come from aliasing of individual data members.

## ◆ setAvg()

void setAvg | ( | const StatsT & | v | ) |
| inline

## ◆ setChild()

void setChild | ( | uint32_t | n,
|  | const void * | ptr
| ) |  |
| inline

## ◆ setDev()

void setDev | ( | const StatsT & | v | ) |
| inline

## ◆ setMax()

void setMax | ( | const ValueT & | v | ) |
| inline

## ◆ setMin()

void setMin | ( | const ValueT & | v | ) |
| inline

## ◆ setOrigin()

void setOrigin | ( | const T & | ijk | ) |
| inline

## ◆ setValue()

void setValue | ( | uint32_t | n,
|  | const ValueT & | v
| ) |  |
| inline

## ◆ stdDeviation()

const StatsT & stdDeviation | ( |  | ) | const
| inline

## Member Data Documentation

## ◆ FIXED_SIZE

constexpr bool FIXED_SIZE = true
| staticconstexpr

## ◆ mAverage

StatsT mAverage

## ◆ mBBox

BBox<CoordT> mBBox

## ◆ mChildMask

MaskT mChildMask

## ◆ mFlags

uint64_t mFlags

## ◆ mMaximum

ValueT mMaximum

## ◆ mMinimum

ValueT mMinimum

## ◆ mStdDevi

StatsT mStdDevi

## ◆ mTable

Tile mTable[1u<<(3 *LOG2DIM)]

## ◆ mValueMask

MaskT mValueMask