OpenVDB  8.1.1
Public Types | Public Member Functions | List of all members
SumMergeOp< TreeT > Struct Template Reference

DynamicNodeManager operator to merge trees using a sum operation. More...

#include <Merge.h>

Public Types

using ValueT = typename TreeT::ValueType
 
using RootT = typename TreeT::RootNodeType
 
using LeafT = typename TreeT::LeafNodeType
 

Public Member Functions

template<typename TagT >
 SumMergeOp (TreeT &tree, TagT tag)
 Convenience constructor to sum a single non-const tree with another. This constructor takes a Steal or DeepCopy tag dispatch class. More...
 
 SumMergeOp (const TreeT &tree, DeepCopy tag)
 Convenience constructor to sum a single const tree with another. This constructor requires a DeepCopy tag dispatch class. More...
 
template<typename TreesT , typename TagT >
 SumMergeOp (TreesT &trees, TagT tag)
 Constructor to sum a container of multiple const or non-const tree pointers. A Steal tag requires a container of non-const trees, a DeepCopy tag will accept either const or non-const trees. More...
 
 SumMergeOp (const std::vector< TreeToMerge< TreeT >> &trees)
 Constructor to accept a vector of TreeToMerge objects, primarily used when mixing const/non-const trees. More...
 
 SumMergeOp (const std::deque< TreeToMerge< TreeT >> &trees)
 Constructor to accept a deque of TreeToMerge objects, primarily used when mixing const/non-const trees. More...
 
bool empty () const
 Return true if no trees being merged. More...
 
size_t size () const
 Return the number of trees being merged. More...
 
bool operator() (RootT &root, size_t idx) const
 
template<typename NodeT >
bool operator() (NodeT &node, size_t idx) const
 
bool operator() (LeafT &leaf, size_t idx) const
 

Detailed Description

template<typename TreeT>
struct openvdb::v8_1::tools::SumMergeOp< TreeT >

DynamicNodeManager operator to merge trees using a sum operation.

Note
This class modifies the topology of the tree so is designed to be used from DynamicNodeManager::foreachTopDown().

Member Typedef Documentation

using LeafT = typename TreeT::LeafNodeType
using RootT = typename TreeT::RootNodeType
using ValueT = typename TreeT::ValueType

Constructor & Destructor Documentation

SumMergeOp ( TreeT &  tree,
TagT  tag 
)
inline

Convenience constructor to sum a single non-const tree with another. This constructor takes a Steal or DeepCopy tag dispatch class.

SumMergeOp ( const TreeT &  tree,
DeepCopy  tag 
)
inline

Convenience constructor to sum a single const tree with another. This constructor requires a DeepCopy tag dispatch class.

SumMergeOp ( TreesT &  trees,
TagT  tag 
)
inline

Constructor to sum a container of multiple const or non-const tree pointers. A Steal tag requires a container of non-const trees, a DeepCopy tag will accept either const or non-const trees.

SumMergeOp ( const std::vector< TreeToMerge< TreeT >> &  trees)
inlineexplicit

Constructor to accept a vector of TreeToMerge objects, primarily used when mixing const/non-const trees.

Note
Sum order is preserved.
SumMergeOp ( const std::deque< TreeToMerge< TreeT >> &  trees)
inlineexplicit

Constructor to accept a deque of TreeToMerge objects, primarily used when mixing const/non-const trees.

Note
Sum order is preserved.

Member Function Documentation

bool empty ( ) const
inline

Return true if no trees being merged.

bool operator() ( RootT root,
size_t  idx 
) const
bool operator() ( NodeT &  node,
size_t  idx 
) const
bool operator() ( LeafT leaf,
size_t  idx 
) const
size_t size ( ) const
inline

Return the number of trees being merged.


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