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>

Public Types
using	AValueT = AValueType
using	BValueT = BValueType

Public Member Functions
	CombineArgs ()
	CombineArgs (const AValueType &a, const BValueType &b, AValueType &result, bool aOn=false, bool bOn=false)
	Use this constructor when the result value is stored externally.
	CombineArgs (const AValueType &a, const BValueType &b, bool aOn=false, bool bOn=false)
	Use this constructor when the result value should be stored in this struct.
const AValueType &	a () const
	Get the A input value.
const BValueType &	b () const
	Get the B input value.
const AValueType &	result () const
	Get the output value.
AValueType &	result ()
CombineArgs &	setResult (const AValueType &val)
	Set the output value.
CombineArgs &	setARef (const AValueType &a)
	Redirect the A value to a new external source.
CombineArgs &	setBRef (const BValueType &b)
	Redirect the B value to a new external source.
CombineArgs &	setResultRef (AValueType &val)
	Redirect the result value to a new external destination.
bool	aIsActive () const
bool	bIsActive () const
bool	resultIsActive () const
CombineArgs &	setAIsActive (bool b)
	Set the active state of the A value.
CombineArgs &	setBIsActive (bool b)
	Set the active state of the B value.
CombineArgs &	setResultIsActive (bool b)
	Set the active state of the output value.

Protected Member Functions
void	updateResultActive ()

Protected Attributes
const AValueType *	mAValPtr
const BValueType *	mBValPtr
AValueType	mResultVal
AValueType *	mResultValPtr
bool	mAIsActive
bool	mBIsActive
bool	mResultIsActive

Detailed Description

template<typename AValueType, typename BValueType = AValueType>
class openvdb::v13_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<float> args;

myCombineOp(args.setARef(aVal).setBRef(bVal).setAIsActive(true).setBIsActive(false));

openvdb::v13_0::CombineArgs::setARef

CombineArgs & setARef(const AValueType &a)

Redirect the A value to a new external source.

Definition Types.h:688

openvdb::v13_0::CombineArgs::setBIsActive

CombineArgs & setBIsActive(bool b)

Set the active state of the B value.

Definition Types.h:704

openvdb::v13_0::CombineArgs::setBRef

CombineArgs & setBRef(const BValueType &b)

Redirect the B value to a new external source.

Definition Types.h:690

openvdb::v13_0::CombineArgs::CombineArgs

CombineArgs()

Definition Types.h:641

openvdb::v13_0::CombineArgs::setAIsActive

CombineArgs & setAIsActive(bool b)

Set the active state of the A value.

Definition Types.h:702