OpenVDB  8.1.1
Public Types | Public Member Functions | List of all members
CacheItem< TreeCacheT, NodeVecT, AtRoot > Class Template Reference

#include <ValueAccessor.h>

Public Types

using NodeType = typename NodeVecT::Front
 
using ValueType = typename NodeType::ValueType
 
using LeafNodeType = typename NodeType::LeafNodeType
 
using CoordLimits = std::numeric_limits< Int32 >
 

Public Member Functions

 CacheItem (TreeCacheT &parent)
 
bool isCached (const Coord &xyz) const
 
void insert (const Coord &xyz, const NodeType *node)
 Cache the given node at this level. More...
 
template<typename OtherNodeType >
void insert (const Coord &xyz, const OtherNodeType *node)
 Forward the given node to another level of the cache. More...
 
void erase (const NodeType *)
 Erase the node at this level. More...
 
template<typename OtherNodeType >
void erase (const OtherNodeType *node)
 Erase the node at another level of the cache. More...
 
void clear ()
 Erase the nodes at this and lower levels of the cache. More...
 
void getNode (const NodeType *&node) const
 Return the cached node (if any) at this level. More...
 
void getNode (const NodeType *&node)
 
void getNode (NodeType *&node)
 
template<typename OtherNodeType >
void getNode (OtherNodeType *&node)
 Forward the request to another level of the cache. More...
 
const ValueTypegetValue (const Coord &xyz)
 Return the value of the voxel at the given coordinates. More...
 
void addLeaf (LeafNodeType *leaf)
 
void addTile (Index level, const Coord &xyz, const ValueType &value, bool state)
 
LeafNodeTypetouchLeaf (const Coord &xyz)
 
LeafNodeTypeprobeLeaf (const Coord &xyz)
 
const LeafNodeTypeprobeConstLeaf (const Coord &xyz)
 
template<typename NodeT >
NodeT * probeNode (const Coord &xyz)
 
template<typename NodeT >
const NodeT * probeConstNode (const Coord &xyz)
 
bool isValueOn (const Coord &xyz)
 Return the active state of the voxel at the given coordinates. More...
 
bool probeValue (const Coord &xyz, ValueType &value)
 Return the active state and value of the voxel at the given coordinates. More...
 
int getValueDepth (const Coord &xyz)
 
bool isVoxel (const Coord &xyz)
 
void setValue (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as active. More...
 
void setValueOnly (const Coord &xyz, const ValueType &value)
 
void setValueOn (const Coord &xyz, const ValueType &value)
 
template<typename ModifyOp >
void modifyValue (const Coord &xyz, const ModifyOp &op)
 Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active. More...
 
template<typename ModifyOp >
void modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
 Apply a functor to the voxel at the given coordinates. More...
 
void setValueOff (const Coord &xyz, const ValueType &value)
 Set the value of the voxel at the given coordinates and mark the voxel as inactive. More...
 
void setActiveState (const Coord &xyz, bool on)
 Set the active state of the voxel at the given coordinates. More...
 
 CacheItem (TreeCacheT &parent, const CacheItem &other)
 Copy another CacheItem's node pointers and hash keys, but not its parent pointer. More...
 
CacheItemcopy (TreeCacheT &parent, const CacheItem &other)
 Copy another CacheItem's node pointers and hash keys, but not its parent pointer. More...
 

Member Typedef Documentation

using CoordLimits = std::numeric_limits<Int32>
using LeafNodeType = typename NodeType::LeafNodeType
using NodeType = typename NodeVecT::Front
using ValueType = typename NodeType::ValueType

Constructor & Destructor Documentation

CacheItem ( TreeCacheT &  parent)
inline
CacheItem ( TreeCacheT &  parent,
const CacheItem< TreeCacheT, NodeVecT, AtRoot > &  other 
)
inline

Copy another CacheItem's node pointers and hash keys, but not its parent pointer.

Member Function Documentation

void addLeaf ( LeafNodeType leaf)
inline
void addTile ( Index  level,
const Coord &  xyz,
const ValueType value,
bool  state 
)
inline
void clear ( )
inline

Erase the nodes at this and lower levels of the cache.

CacheItem& copy ( TreeCacheT &  parent,
const CacheItem< TreeCacheT, NodeVecT, AtRoot > &  other 
)
inline

Copy another CacheItem's node pointers and hash keys, but not its parent pointer.

void erase ( const NodeType )
inline

Erase the node at this level.

void erase ( const OtherNodeType *  node)
inline

Erase the node at another level of the cache.

void getNode ( const NodeType *&  node) const
inline

Return the cached node (if any) at this level.

void getNode ( const NodeType *&  node)
inline
void getNode ( NodeType *&  node)
inline
void getNode ( OtherNodeType *&  node)
inline

Forward the request to another level of the cache.

const ValueType& getValue ( const Coord &  xyz)
inline

Return the value of the voxel at the given coordinates.

int getValueDepth ( const Coord &  xyz)
inline
void insert ( const Coord &  xyz,
const NodeType node 
)
inline

Cache the given node at this level.

void insert ( const Coord &  xyz,
const OtherNodeType *  node 
)
inline

Forward the given node to another level of the cache.

bool isCached ( const Coord &  xyz) const
inline
bool isValueOn ( const Coord &  xyz)
inline

Return the active state of the voxel at the given coordinates.

bool isVoxel ( const Coord &  xyz)
inline
void modifyValue ( const Coord &  xyz,
const ModifyOp &  op 
)
inline

Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active.

See Tree::modifyValue() for details.

void modifyValueAndActiveState ( const Coord &  xyz,
const ModifyOp &  op 
)
inline

Apply a functor to the voxel at the given coordinates.

See Tree::modifyValueAndActiveState() for details.

const LeafNodeType* probeConstLeaf ( const Coord &  xyz)
inline
const NodeT* probeConstNode ( const Coord &  xyz)
inline
LeafNodeType* probeLeaf ( const Coord &  xyz)
inline
NodeT* probeNode ( const Coord &  xyz)
inline
bool probeValue ( const Coord &  xyz,
ValueType value 
)
inline

Return the active state and value of the voxel at the given coordinates.

void setActiveState ( const Coord &  xyz,
bool  on 
)
inline

Set the active state of the voxel at the given coordinates.

void setValue ( const Coord &  xyz,
const ValueType value 
)
inline

Set the value of the voxel at the given coordinates and mark the voxel as active.

void setValueOff ( const Coord &  xyz,
const ValueType value 
)
inline

Set the value of the voxel at the given coordinates and mark the voxel as inactive.

void setValueOn ( const Coord &  xyz,
const ValueType value 
)
inline
void setValueOnly ( const Coord &  xyz,
const ValueType value 
)
inline
LeafNodeType* touchLeaf ( const Coord &  xyz)
inline

The documentation for this class was generated from the following file: