OpenVDB: Tree< RootT > Class Template Reference

OpenVDB 9.1.0

Public Types | Public Member Functions | Static Public Member Functions | List of all members
Tree< RootT > Class Template Reference

VDB Tree, which is a thin wrapper around a RootNode. More...

`#include <nanovdb/NanoVDB.h>`

Inheritance diagram for Tree< RootT >:

## Public Types
using | DataType = TreeData< RootT::LEVEL >
using | RootType = RootT
using | LeafNodeType = typename RootT::LeafNodeType
using | ValueType = typename RootT::ValueType
using | BuildType = typename RootT::BuildType
using | CoordType = typename RootT::CoordType
using | AccessorType = DefaultReadAccessor< BuildType >
using | Node3 = RootT
using | Node2 = typename RootT::ChildNodeType
using | Node1 = typename Node2::ChildNodeType
using | Node0 = LeafNodeType

## Public Member Functions
| Tree ()=delete
| This class cannot be constructed or deleted. More...
| Tree (const Tree &)=delete
Tree & | operator= (const Tree &)=delete
| ~Tree ()=delete
DataType * | data ()
const DataType * | data () const
RootT & | root ()
const RootT & | root () const
AccessorType | getAccessor () const
ValueType | getValue (const CoordType &ijk) const
| Return the value of the given voxel (regardless of state or location in the tree.) More...
bool | isActive (const CoordType &ijk) const
| Return the active state of the given voxel (regardless of state or location in the tree.) More...
bool | isEmpty () const
| Return true if this tree is empty, i.e. contains no values or nodes. More...
bool | probeValue (const CoordType &ijk, ValueType &v) const
| Combines the previous two methods in a single call. More...
const ValueType & | background () const
| Return a const reference to the background value. More...
void | extrema (ValueType &min, ValueType &max) const
| Sets the extrema values of all the active values in this tree, i.e. in all nodes of the tree. More...
const BBox< CoordType > & | bbox () const
| Return a const reference to the index bounding box of all the active values in this tree, i.e. in all nodes of the tree. More...
uint64_t | activeVoxelCount () const
| Return the total number of active voxels in this tree. More...
const uint32_t & | activeTileCount (uint32_t n) const
| Return the total number of active tiles at the specified level of the tree. More...
template<typename NodeT >
uint32_t | nodeCount () const
uint32_t | nodeCount (int level) const
template<typename NodeT >
NodeT * | getFirstNode ()
| return a pointer to the first node of the specified type More...
template<typename NodeT >
const NodeT * | getFirstNode () const
| return a const pointer to the first node of the specified type More...
template<int LEVEL>
NodeTrait< RootT, LEVEL >::type * | getFirstNode ()
| return a pointer to the first node at the specified level More...
template<int LEVEL>
const NodeTrait< RootT, LEVEL >::type * | getFirstNode () const
| return a const pointer to the first node of the specified level More...

## Static Public Member Functions
static uint64_t | memUsage ()
| return memory usage in bytes for the class More...

## Detailed Description

template<typename RootT>
class nanovdb::Tree< RootT >

VDB Tree, which is a thin wrapper around a RootNode.

## Member Typedef Documentation

## ◆ AccessorType

using AccessorType = DefaultReadAccessor<BuildType>

## ◆ BuildType

using BuildType = typename RootT::BuildType

## ◆ CoordType

using CoordType = typename RootT::CoordType

## ◆ DataType

using DataType = TreeData<RootT::LEVEL>

## ◆ LeafNodeType

using LeafNodeType = typename RootT::LeafNodeType

## ◆ Node0

using Node0 = LeafNodeType

## ◆ Node1

using Node1 = typename Node2::ChildNodeType

## ◆ Node2

using Node2 = typename RootT::ChildNodeType

## ◆ Node3

using Node3 = RootT

## ◆ RootType

using RootType = RootT

## ◆ ValueType

using ValueType = typename RootT::ValueType

## Constructor & Destructor Documentation

## ◆ Tree() [1/2]

Tree | ( |  | ) |
| delete

This class cannot be constructed or deleted.

## ◆ Tree() [2/2]

Tree | ( | const Tree< RootT > & |  | ) |
| delete

## ◆ ~Tree()

~Tree | ( |  | ) |
| delete

## Member Function Documentation

## ◆ activeTileCount()

const uint32_t & activeTileCount | ( | uint32_t | n | ) | const
| inline

Return the total number of active tiles at the specified level of the tree.

n = 0 corresponds to leaf level tiles.

## ◆ activeVoxelCount()

uint64_t activeVoxelCount | ( |  | ) | const
| inline

Return the total number of active voxels in this tree.

## ◆ background()

const ValueType & background | ( |  | ) | const
| inline

Return a const reference to the background value.

## ◆ bbox()

const BBox< CoordType > & bbox | ( |  | ) | const
| inline

Return a const reference to the index bounding box of all the active values in this tree, i.e. in all nodes of the tree.

## ◆ data() [1/2]

DataType * data | ( |  | ) |
| inline

## ◆ data() [2/2]

const DataType * data | ( |  | ) | const
| inline

## ◆ extrema()

void extrema | ( | ValueType & | min,
|  | ValueType & | max
| ) |  | const

Sets the extrema values of all the active values in this tree, i.e. in all nodes of the tree.

## ◆ getAccessor()

AccessorType getAccessor | ( |  | ) | const
| inline

## ◆ getFirstNode() [1/4]

NodeT * getFirstNode | ( |  | ) |
| inline

return a pointer to the first node of the specified type

Warning
  Note it may return NULL if no nodes exist

## ◆ getFirstNode() [2/4]

NodeTrait< RootT, LEVEL >::type * getFirstNode | ( |  | ) |
| inline

return a pointer to the first node at the specified level

Warning
  Note it may return NULL if no nodes exist

## ◆ getFirstNode() [3/4]

const NodeT * getFirstNode | ( |  | ) | const
| inline

return a const pointer to the first node of the specified type

Warning
  Note it may return NULL if no nodes exist

## ◆ getFirstNode() [4/4]

const NodeTrait< RootT, LEVEL >::type * getFirstNode | ( |  | ) | const
| inline

return a const pointer to the first node of the specified level

Warning
  Note it may return NULL if no nodes exist

## ◆ getValue()

ValueType getValue | ( | const CoordType & | ijk | ) | const
| inline

Return the value of the given voxel (regardless of state or location in the tree.)

## ◆ isActive()

bool isActive | ( | const CoordType & | ijk | ) | const
| inline

Return the active state of the given voxel (regardless of state or location in the tree.)

## ◆ isEmpty()

bool isEmpty | ( |  | ) | const
| inline

Return true if this tree is empty, i.e. contains no values or nodes.

## ◆ memUsage()

static uint64_t memUsage | ( |  | ) |
| inlinestatic

return memory usage in bytes for the class

## ◆ nodeCount() [1/2]

uint32_t nodeCount | ( |  | ) | const
| inline

## ◆ nodeCount() [2/2]

uint32_t nodeCount | ( | int | level | ) | const
| inline

## ◆ operator=()

Tree & operator= | ( | const Tree< RootT > & |  | ) |
| delete

## ◆ probeValue()

bool probeValue | ( | const CoordType & | ijk,
|  | ValueType & | v
| ) |  | const
| inline

Combines the previous two methods in a single call.

## ◆ root() [1/2]

RootT & root | ( |  | ) |
| inline

## ◆ root() [2/2]

const RootT & root | ( |  | ) | const
| inline