Loading...
Searching...
No Matches
ValueAccessorRW< TreeType, IsSafe > Class Template Reference

This accessor is thread-safe (at the cost of speed) for both reading and writing to a tree. That is, multiple threads may safely access a single, shared ValueAccessorRW. More...

`#include <openvdb/tree/ValueAccessor.h>`

Inheritance diagram for ValueAccessorRW< TreeType, IsSafe >:

## Public Types

using | TreeType
using | RootNodeT
using | LeafNodeT
using | ValueType
using | BaseT
using | LockT

## Public Member Functions

| ValueAccessorRW (TreeType &tree)
bool | isCached (const Coord &xyz) const
| Return `true` if nodes along the path to the given voxel have been cached.
const ValueType & | getValue (const Coord &xyz) const
| Return the value of the voxel at the given coordinates.
bool | isValueOn (const Coord &xyz) const
| Return the active state of the voxel at the given coordinates.
bool | probeValue (const Coord &xyz, ValueType &value) const
| Return the active state of the voxel as well as its value.
int | getValueDepth (const Coord &xyz) const
bool | isVoxel (const Coord &xyz) const
void | setValue (const Coord &xyz, const ValueType &value)
| Set the value of the voxel at the given coordinates and mark the voxel as active.
void | setValueOn (const Coord &xyz, const ValueType &value)
void | setValueOnly (const Coord &xyz, const ValueType &value)
| Set the value of the voxel at the given coordinate but don't change its active state.
void | setValueOff (const Coord &xyz, const ValueType &value)
| Set the value of the voxel at the given coordinates and mark the voxel as inactive.
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.
void | modifyValueAndActiveState (const Coord &xyz, const ModifyOp &op)
| Apply a functor to the voxel at the given coordinates.
void | setActiveState (const Coord &xyz, bool on=true)
| Set the active state of the voxel at the given coordinates but don't change its value.
NodeType * | getNode ()
| Return the cached node of type NodeType. [Mainly for internal use].
void | insertNode (const Coord &xyz, NodeType &node)
void | eraseNode ()
void | addLeaf (LeafNodeT *leaf)
| Add the specified leaf to this tree, possibly creating a child branch in the process. If the leaf node already exists, replace it.
void | addTile (Index level, const Coord &xyz, const ValueType &value, bool state)
| Add a tile at the specified tree level that contains voxel (x, y, z), possibly deleting existing nodes or creating new nodes in the process.
LeafNodeT * | touchLeaf (const Coord &xyz)
| Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels.
NodeT * | probeNode (const Coord &xyz)
| Return a pointer to the node of the specified type that contains voxel (x, y, z), or `nullptr` if no such node exists.
const NodeT * | probeConstNode (const Coord &xyz) const
LeafNodeT * | probeLeaf (const Coord &xyz)
| Return a pointer to the leaf node that contains voxel (x, y, z), or `nullptr` if no such node exists.
const LeafNodeT * | probeConstLeaf (const Coord &xyz) const
void | clear () override
| Remove all nodes from this cache, then reinsert the root node.
TreeType * | getTree () const
| Return a pointer to the tree associated with this accessor.
TreeType & | tree () const
| Return a reference to the tree associated with this accessor.

## Static Public Member Functions

static Index | numCacheLevels ()
| Return the number of cache levels employed by this accessor.
static bool | isSafe ()
| Return true if this accessor is safe, i.e. registered by the tree from which it is constructed. Un-registered accessors can in rare cases be faster because it avoids the (small) overhead of registration, but they are unsafe if the tree is modified. So unless you're an expert it is highly recommended to set IsSafe = true (which is the default).

## Static Public Attributes

static const bool | IsConstTree
static constexpr bool | BypassLeafAPI

## Protected Attributes

TreeType * | mTree

## Detailed Description

template<typename TreeType, bool IsSafe = true>
class openvdb::v10_0::tree::ValueAccessorRW< TreeType, IsSafe >

This accessor is thread-safe (at the cost of speed) for both reading and writing to a tree. That is, multiple threads may safely access a single, shared ValueAccessorRW.

Warning
  Since the mutex-locking employed by the ValueAccessorRW can seriously impair performance of multithreaded applications, it is recommended that, instead, each thread be assigned its own (non-mutex protected) accessor.

## Member Typedef Documentation

## BaseT

using BaseT

inherited

## LeafNodeT

using LeafNodeT

inherited

## LockT

using LockT

inherited

## RootNodeT

using RootNodeT

inherited

## TreeType

using TreeType

inherited

## ValueType

using ValueType

inherited

## Constructor & Destructor Documentation

## ValueAccessorRW()

template<typename TreeType, bool IsSafe = true>

ValueAccessorRW | ( | TreeType & | tree | ) |

inline

## Member Function Documentation

## addLeaf()

void addLeaf | ( | LeafNodeT * | leaf | ) |

inline inherited

Add the specified leaf to this tree, possibly creating a child branch in the process. If the leaf node already exists, replace it.

## addTile()

void addTile | ( | Index | level,
|  | const Coord & | xyz,
|  | const ValueType & | value,
|  | bool | state )

inline inherited

Add a tile at the specified tree level that contains voxel (x, y, z), possibly deleting existing nodes or creating new nodes in the process.

## clear()

void clear | ( |  | ) |

inline override virtual inherited

Remove all nodes from this cache, then reinsert the root node.

Implements ValueAccessorBase< TreeType, IsSafe >.

## eraseNode()

void eraseNode | ( |  | ) |

inline inherited

If a node of the given type exists in the cache, remove it, so that isCached(xyz) returns `false` for any voxel (x, y, z) contained in that node. [Mainly for internal use]

## getNode()

NodeType * getNode | ( |  | ) |

inline inherited

Return the cached node of type NodeType. [Mainly for internal use].

## getTree()

TreeType * getTree | ( |  | ) | const

inline inherited

Return a pointer to the tree associated with this accessor.

The pointer will be null only if the tree from which this accessor was constructed was subsequently deleted (which generally leaves the accessor in an unsafe state).

## getValue()

const ValueType & getValue | ( | const Coord & | xyz | ) | const

inline inherited

Return the value of the voxel at the given coordinates.

## getValueDepth()

int getValueDepth | ( | const Coord & | xyz | ) | const

inline inherited

Return the tree depth (0 = root) at which the value of voxel (x, y, z) resides, or -1 if (x, y, z) isn't explicitly represented in the tree (i.e., if it is implicitly a background voxel).

## insertNode()

void insertNode | ( | const Coord & | xyz,
|  | NodeType & | node )

inline inherited

Cache the given node, which should lie along the path from the root node to the node containing voxel (x, y, z). [Mainly for internal use]

## isCached()

bool isCached | ( | const Coord & | xyz | ) | const

inline inherited

Return `true` if nodes along the path to the given voxel have been cached.

## isSafe()

bool isSafe | ( |  | ) |

inline static inherited

Return true if this accessor is safe, i.e. registered by the tree from which it is constructed. Un-registered accessors can in rare cases be faster because it avoids the (small) overhead of registration, but they are unsafe if the tree is modified. So unless you're an expert it is highly recommended to set IsSafe = true (which is the default).

## isValueOn()

bool isValueOn | ( | const Coord & | xyz | ) | const

inline inherited

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

## isVoxel()

bool isVoxel | ( | const Coord & | xyz | ) | const

inline inherited

Return `true` if the value of voxel (x, y, z) resides at the leaf level of the tree, i.e., if it is not a tile value.

## modifyValue()

void modifyValue | ( | const Coord & | xyz,
|  | const ModifyOp & | op )

inline inherited

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

See Tree::modifyValue() for details.

## modifyValueAndActiveState()

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

inline inherited

Apply a functor to the voxel at the given coordinates.

See Tree::modifyValueAndActiveState() for details.

## numCacheLevels()

Index numCacheLevels | ( |  | ) |

inline static inherited

Return the number of cache levels employed by this accessor.

## probeConstLeaf()

const LeafNodeT * probeConstLeaf | ( | const Coord & | xyz | ) | const

inline inherited

## probeConstNode()

const NodeT * probeConstNode | ( | const Coord & | xyz | ) | const

inline inherited

## probeLeaf()

LeafNodeT * probeLeaf | ( | const Coord & | xyz | ) |

inline inherited

Return a pointer to the leaf node that contains voxel (x, y, z), or `nullptr` if no such node exists.

## probeNode()

NodeT * probeNode | ( | const Coord & | xyz | ) |

inline inherited

Return a pointer to the node of the specified type that contains voxel (x, y, z), or `nullptr` if no such node exists.

## probeValue()

bool probeValue | ( | const Coord & | xyz,
|  | ValueType & | value ) const

inline inherited

Return the active state of the voxel as well as its value.

## setActiveState()

void setActiveState | ( | const Coord & | xyz,
|  | bool | on = true )

inline inherited

Set the active state of the voxel at the given coordinates but don't change its value.

## setValue()

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

inline inherited

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

## setValueOff()

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

inline inherited

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

## setValueOn()

void setValueOn | ( | const Coord & | xyz,
|  | const ValueType & | value )

inline inherited

## setValueOnly()

void setValueOnly | ( | const Coord & | xyz,
|  | const ValueType & | value )

inline inherited

Set the value of the voxel at the given coordinate but don't change its active state.

## touchLeaf()

LeafNodeT * touchLeaf | ( | const Coord & | xyz | ) |

inline inherited

Return a pointer to the leaf node that contains voxel (x, y, z). If no such node exists, create one, but preserve the values and active states of all voxels.

Use this method to preallocate a static tree topology over which to safely perform multithreaded processing.

## tree()

TreeType & tree | ( |  | ) | const

inline inherited

Return a reference to the tree associated with this accessor.

## Member Data Documentation

## BypassLeafAPI

bool BypassLeafAPI

static constexpr inherited

## IsConstTree

static inherited

## mTree

TreeType* mTree

protected inherited