HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::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::OPENVDB_VERSION_NAME::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().

Definition at line 310 of file Merge.h.

Member Typedef Documentation

template<typename TreeT>
using openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::LeafT = typename TreeT::LeafNodeType

Definition at line 314 of file Merge.h.

template<typename TreeT>
using openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::RootT = typename TreeT::RootNodeType

Definition at line 313 of file Merge.h.

template<typename TreeT>
using openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::ValueT = typename TreeT::ValueType

Definition at line 312 of file Merge.h.

Constructor & Destructor Documentation

template<typename TreeT>
template<typename TagT >
openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::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.

Definition at line 319 of file Merge.h.

template<typename TreeT>
openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::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.

Definition at line 323 of file Merge.h.

template<typename TreeT>
template<typename TreesT , typename TagT >
openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::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.

Definition at line 329 of file Merge.h.

template<typename TreeT>
openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::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.

Definition at line 341 of file Merge.h.

template<typename TreeT>
openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::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.

Definition at line 347 of file Merge.h.

Member Function Documentation

template<typename TreeT>
bool openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::empty ( void  ) const
inline

Return true if no trees being merged.

Definition at line 351 of file Merge.h.

template<typename TreeT >
bool openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::operator() ( RootT root,
size_t  idx 
) const

Definition at line 1193 of file Merge.h.

template<typename TreeT >
template<typename NodeT >
bool openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::operator() ( NodeT &  node,
size_t  idx 
) const

Definition at line 1325 of file Merge.h.

template<typename TreeT >
bool openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::operator() ( LeafT leaf,
size_t  idx 
) const

Definition at line 1375 of file Merge.h.

template<typename TreeT>
size_t openvdb::OPENVDB_VERSION_NAME::tools::SumMergeOp< TreeT >::size ( void  ) const
inline

Return the number of trees being merged.

Definition at line 354 of file Merge.h.


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