Top-most node of the VDB tree structure. More...
#include <nanovdb/NanoVDB.h>
 
  
| Classes | |
| class | BaseIter | 
| class | ChildIter | 
| class | DenseIter | 
| class | ValueIter | 
| class | ValueOnIter | 
| Public Types | |
| using | DataType = RootData<ChildT> | 
| using | ChildNodeType = ChildT | 
| using | RootType = RootNode<ChildT> | 
| using | RootNodeType = RootType | 
| using | UpperNodeType = ChildT | 
| using | LowerNodeType = typename UpperNodeType::ChildNodeType | 
| using | LeafNodeType = typename ChildT::LeafNodeType | 
| using | ValueType = typename DataType::ValueT | 
| using | FloatType = typename DataType::StatsT | 
| using | BuildType = typename DataType::BuildT | 
| using | CoordType = typename ChildT::CoordType | 
| using | BBoxType = math::BBox<CoordType> | 
| using | AccessorType = DefaultReadAccessor<BuildType> | 
| using | Tile = typename DataType::Tile | 
| using | ChildIterator = ChildIter<RootNode> | 
| using | ConstChildIterator = ChildIter<const RootNode> | 
| using | ValueIterator = ValueIter<RootNode> | 
| using | ConstValueIterator = ValueIter<const RootNode> | 
| using | ValueOnIterator = ValueOnIter<RootNode> | 
| using | ConstValueOnIterator = ValueOnIter<const RootNode> | 
| using | DenseIterator = DenseIter<RootNode> | 
| using | ConstDenseIterator = DenseIter<const RootNode> | 
| 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. | |
| Public Member Functions | |
| __hostdev__ ChildIterator | beginChild () | 
| __hostdev__ ConstChildIterator | cbeginChild () const | 
| __hostdev__ ValueIterator | beginValue () | 
| __hostdev__ ConstValueIterator | cbeginValueAll () const | 
| __hostdev__ ValueOnIterator | beginValueOn () | 
| __hostdev__ ConstValueOnIterator | cbeginValueOn () const | 
| __hostdev__ DenseIterator | beginDense () | 
| __hostdev__ ConstDenseIterator | cbeginDense () const | 
| __hostdev__ ConstDenseIterator | cbeginChildAll () const | 
| RootNode ()=delete | |
| This class cannot be constructed or deleted. | |
| RootNode (const RootNode &)=delete | |
| RootNode & | operator= (const RootNode &)=delete | 
| ~RootNode ()=delete | |
| __hostdev__ AccessorType | getAccessor () const | 
| __hostdev__ DataType * | data () | 
| __hostdev__ const DataType * | data () const | 
| __hostdev__ const BBoxType & | 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. | |
| __hostdev__ const ValueType & | background () const | 
| Return the total number of active voxels in the root and all its child nodes. | |
| __hostdev__ const uint32_t & | tileCount () const | 
| Return the number of tiles encoded in this root node. | |
| __hostdev__ const uint32_t & | getTableSize () const | 
| __hostdev__ const ValueType & | minimum () const | 
| Return a const reference to the minimum active value encoded in this root node and any of its child nodes. | |
| __hostdev__ const ValueType & | maximum () const | 
| Return a const reference to the maximum active value encoded in this root node and any of its child nodes. | |
| __hostdev__ const FloatType & | average () const | 
| Return a const reference to the average of all the active values encoded in this root node and any of its child nodes. | |
| __hostdev__ FloatType | variance () const | 
| Return the variance of all the active values encoded in this root node and any of its child nodes. | |
| __hostdev__ const FloatType & | stdDeviation () const | 
| Return a const reference to the standard deviation of all the active values encoded in this root node and any of its child nodes. | |
| __hostdev__ uint64_t | memUsage () const | 
| Return the actual memory footprint of this root node. | |
| __hostdev__ bool | isEmpty () const | 
| Return true if this RootNode is empty, i.e. contains no values or nodes. | |
| __hostdev__ ValueType | getValue (const CoordType &ijk) const | 
| Return the value of the given voxel. | |
| __hostdev__ ValueType | getValue (int i, int j, int k) const | 
| __hostdev__ bool | isActive (const CoordType &ijk) const | 
| __hostdev__ bool | probeValue (const CoordType &ijk, ValueType &v) const | 
| return the state and updates the value of the specified voxel | |
| __hostdev__ const LeafNodeType * | probeLeaf (const CoordType &ijk) const | 
| __hostdev__ const ChildNodeType * | probeChild (const CoordType &ijk) const | 
| __hostdev__ ChildNodeType * | probeChild (const CoordType &ijk) | 
| template<typename OpT, typename... ArgsT> | |
| __hostdev__ auto | get (const CoordType &ijk, ArgsT &&... args) const | 
| template<typename OpT, typename... ArgsT> | |
| __hostdev__ decltype(OpT::set(util::declval< Tile & >(), util::declval< ArgsT >()...)) | set (const CoordType &ijk, ArgsT &&... args) | 
| __hostdev__ const Tile * | tile (uint32_t n) const | 
| Returns a non-const reference to the tile at the specified linear offset. | |
| __hostdev__ Tile * | tile (uint32_t n) | 
| __hostdev__ Tile * | probeTile (const CoordT &ijk) | 
| __hostdev__ const Tile * | probeTile (const CoordT &ijk) const | 
| __hostdev__ ChildT * | getChild (const Tile *tile) | 
| Returns a const reference to the child node in the specified tile. | |
| __hostdev__ const ChildT * | getChild (const Tile *tile) const | 
| __hostdev__ const ValueT & | getMin () const | 
| __hostdev__ const ValueT & | getMax () const | 
| __hostdev__ void | setMin (const ValueT &v) | 
| __hostdev__ void | setMax (const ValueT &v) | 
| __hostdev__ void | setAvg (const StatsT &v) | 
| __hostdev__ void | setDev (const StatsT &v) | 
| Static Public Member Functions | |
| static __hostdev__ uint64_t | memUsage (uint32_t tableSize) | 
| Return the expected memory footprint in bytes with the specified number of tiles. | |
| template<typename CoordType> | |
| static __hostdev__ KeyT | CoordToKey (const CoordType &ijk) | 
| static __hostdev__ CoordT | KeyToCoord (const KeyT &key) | 
| static __hostdev__ constexpr uint32_t | padding () | 
| Return padding of this class in bytes, due to aliasing and 32B alignment. | |
| Public Attributes | |
| math::BBox< CoordT > | mBBox | 
| uint32_t | mTableSize | 
| ValueT | mBackground | 
| ValueT | mMinimum | 
| ValueT | mMaximum | 
| StatsT | mAverage | 
| StatsT | mStdDevi | 
| Static Public Attributes | |
| static constexpr bool | FIXED_SIZE = DataType::FIXED_SIZE | 
| static constexpr uint32_t | LEVEL = 1 + ChildT::LEVEL | 
| Friends | |
| template<typename, int, int, int> | |
| class | ReadAccessor | 
| template<typename> | |
| class | Tree | 
Top-most node of the VDB tree structure.
| using AccessorType = DefaultReadAccessor<BuildType> | 
| 
 | inherited | 
| using BuildType = typename DataType::BuildT | 
| using ChildIterator = ChildIter<RootNode> | 
| using ChildNodeType = ChildT | 
| using ConstChildIterator = ChildIter<const RootNode> | 
| using ConstDenseIterator = DenseIter<const RootNode> | 
| using ConstValueIterator = ValueIter<const RootNode> | 
| using ConstValueOnIterator = ValueOnIter<const RootNode> | 
| 
 | inherited | 
| using CoordType = typename ChildT::CoordType | 
| using DenseIterator = DenseIter<RootNode> | 
| using FloatType = typename DataType::StatsT | 
| 
 | inherited | 
Return a key based on the coordinates of a voxel.
| using LeafNodeType = typename ChildT::LeafNodeType | 
| using LowerNodeType = typename UpperNodeType::ChildNodeType | 
| using RootNodeType = RootType | 
| 
 | inherited | 
| using Tile = typename DataType::Tile | 
| using UpperNodeType = ChildT | 
| using ValueIterator = ValueIter<RootNode> | 
| using ValueOnIterator = ValueOnIter<RootNode> | 
| 
 | inherited | 
| using ValueType = typename DataType::ValueT | 
| 
 | delete | 
This class cannot be constructed or deleted.
| 
 | delete | 
| 
 | inline | 
Return a const reference to the average of all the active values encoded in this root node and any of its child nodes.
| 
 | inline | 
Return the total number of active voxels in the root and all its child nodes.
Return a const reference to the background value, i.e. the value associated with any coordinate location that has not been set explicitly.
| 
 | 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.
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inlinestaticinherited | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inlineinherited | 
Returns a const reference to the child node in the specified tile.
| 
 | inlineinherited | 
| 
 | inlineinherited | 
| 
 | inlineinherited | 
| 
 | inline | 
| 
 | inline | 
Return the value of the given voxel.
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Return true if this RootNode is empty, i.e. contains no values or nodes.
| 
 | inlinestaticinherited | 
| 
 | inline | 
Return a const reference to the maximum active value encoded in this root node and any of its child nodes.
| 
 | inline | 
Return the actual memory footprint of this root node.
| 
 | inlinestatic | 
Return the expected memory footprint in bytes with the specified number of tiles.
| 
 | inline | 
Return a const reference to the minimum active value encoded in this root node and any of its child nodes.
| 
 | inlinestaticconstexprinherited | 
Return padding of this class in bytes, due to aliasing and 32B alignment.
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inlineinherited | 
| 
 | inlineinherited | 
| 
 | inline | 
return the state and updates the value of the specified voxel
| 
 | inline | 
| 
 | inlineinherited | 
| 
 | inlineinherited | 
| 
 | inlineinherited | 
| 
 | inlineinherited | 
| 
 | inline | 
Return a const reference to the standard deviation of all the active values encoded in this root node and any of its child nodes.
| 
 | inlineinherited | 
| 
 | inlineinherited | 
Returns a non-const reference to the tile at the specified linear offset.
| 
 | inline | 
Return the number of tiles encoded in this root node.
| 
 | inline | 
Return the variance of all the active values encoded in this root node and any of its child nodes.
| 
 | staticconstexpr | 
| 
 | staticconstexpr | 
| 
 | inherited | 
| 
 | inherited | 
| 
 | inherited | 
| 
 | inherited | 
| 
 | inherited | 
| 
 | inherited | 
| 
 | inherited |