This struct collects both input and output arguments to "grid combiner" functors used with the tree::TypedGrid::combineExtended() and combine2Extended() methods. AValueType and BValueType are the value types of the two grids being combined.
More...
#include <openvdb/Types.h>
template<typename AValueType, typename BValueType = AValueType>
class openvdb::v12_0::CombineArgs< AValueType, BValueType >
This struct collects both input and output arguments to "grid combiner" functors used with the tree::TypedGrid::combineExtended() and combine2Extended() methods. AValueType and BValueType are the value types of the two grids being combined.
- See also
- openvdb/tree/Tree.h for usage information.
Setter methods return references to this object, to facilitate the following usage:
CombineArgs & setARef(const AValueType &a)
Redirect the A value to a new external source.
Definition Types.h:621
CombineArgs & setBIsActive(bool b)
Set the active state of the B value.
Definition Types.h:637
CombineArgs & setBRef(const BValueType &b)
Redirect the B value to a new external source.
Definition Types.h:623
CombineArgs()
Definition Types.h:574
CombineArgs & setAIsActive(bool b)
Set the active state of the A value.
Definition Types.h:635
◆ AValueT
template<typename AValueType, typename BValueType = AValueType>
◆ BValueT
template<typename AValueType, typename BValueType = AValueType>
◆ CombineArgs() [1/3]
template<typename AValueType, typename BValueType = AValueType>
◆ CombineArgs() [2/3]
template<typename AValueType, typename BValueType = AValueType>
CombineArgs |
( |
const AValueType & | a, |
|
|
const BValueType & | b, |
|
|
AValueType & | result, |
|
|
bool | aOn = false, |
|
|
bool | bOn = false ) |
|
inline |
Use this constructor when the result value is stored externally.
◆ CombineArgs() [3/3]
template<typename AValueType, typename BValueType = AValueType>
CombineArgs |
( |
const AValueType & | a, |
|
|
const BValueType & | b, |
|
|
bool | aOn = false, |
|
|
bool | bOn = false ) |
|
inline |
Use this constructor when the result value should be stored in this struct.
◆ a()
template<typename AValueType, typename BValueType = AValueType>
const AValueType & a |
( |
| ) |
const |
|
inline |
◆ aIsActive()
template<typename AValueType, typename BValueType = AValueType>
- Returns
- true if the A value is active
◆ b()
template<typename AValueType, typename BValueType = AValueType>
const BValueType & b |
( |
| ) |
const |
|
inline |
◆ bIsActive()
template<typename AValueType, typename BValueType = AValueType>
- Returns
- true if the B value is active
◆ result() [1/2]
template<typename AValueType, typename BValueType = AValueType>
◆ result() [2/2]
template<typename AValueType, typename BValueType = AValueType>
const AValueType & result |
( |
| ) |
const |
|
inline |
◆ resultIsActive()
template<typename AValueType, typename BValueType = AValueType>
bool resultIsActive |
( |
| ) |
const |
|
inline |
- Returns
- true if the output value is active
◆ setAIsActive()
template<typename AValueType, typename BValueType = AValueType>
Set the active state of the A value.
◆ setARef()
template<typename AValueType, typename BValueType = AValueType>
Redirect the A value to a new external source.
◆ setBIsActive()
template<typename AValueType, typename BValueType = AValueType>
Set the active state of the B value.
◆ setBRef()
template<typename AValueType, typename BValueType = AValueType>
Redirect the B value to a new external source.
◆ setResult()
template<typename AValueType, typename BValueType = AValueType>
◆ setResultIsActive()
template<typename AValueType, typename BValueType = AValueType>
Set the active state of the output value.
◆ setResultRef()
template<typename AValueType, typename BValueType = AValueType>
Redirect the result value to a new external destination.
◆ updateResultActive()
template<typename AValueType, typename BValueType = AValueType>
void updateResultActive |
( |
| ) |
|
|
inlineprotected |
By default, the result value is active if either of the input values is active, but this behavior can be overridden by calling setResultIsActive().
◆ mAIsActive
template<typename AValueType, typename BValueType = AValueType>
◆ mAValPtr
template<typename AValueType, typename BValueType = AValueType>
const AValueType* mAValPtr |
|
protected |
◆ mBIsActive
template<typename AValueType, typename BValueType = AValueType>
◆ mBValPtr
template<typename AValueType, typename BValueType = AValueType>
const BValueType* mBValPtr |
|
protected |
◆ mResultIsActive
template<typename AValueType, typename BValueType = AValueType>
◆ mResultVal
template<typename AValueType, typename BValueType = AValueType>
◆ mResultValPtr
template<typename AValueType, typename BValueType = AValueType>
AValueType* mResultValPtr |
|
protected |