openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType > Class Template Reference

Write-able version of AttributeHandle. More...

#include <AttributeArray.h>

Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >:

Public Types
using	Handle = AttributeWriteHandle< ValueType, CodecType >
using	Ptr = std::shared_ptr< Handle >
using	ScopedPtr = std::unique_ptr< Handle >
Public Types inherited from openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >
using	Handle = AttributeHandle< ValueType, CodecType >
using	Ptr = std::shared_ptr< Handle >
using	UniquePtr = std::unique_ptr< Handle >

Public Member Functions
	AttributeWriteHandle (AttributeArray &array, const bool expand=true)
virtual	~AttributeWriteHandle ()=default
void	expand (bool fill=true)
	If this array is uniform, replace it with an array of length size(). More...
void	collapse ()
	Replace the existing array with a uniform value (zero if none provided). More...
void	collapse (const ValueType &uniformValue)
bool	compact ()
	Compact the existing array to become uniform if all values are identical. More...
void	fill (const ValueType &value)
	Fill the existing array with the given value. More...
void	set (Index n, const ValueType &value)
void	set (Index n, Index m, const ValueType &value)
AttributeArray &	array ()
Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >
	AttributeHandle (const AttributeArray &array, const bool collapseOnDestruction=true)
	AttributeHandle (const AttributeHandle &)=default
AttributeHandle &	operator= (const AttributeHandle &)=default
virtual	~AttributeHandle ()
Index	stride () const
Index	size () const
bool	isUniform () const
bool	hasConstantStride () const
ValueType	get (Index n, Index m=0) const
const AttributeArray &	array () const

Static Public Member Functions
static Ptr	create (AttributeArray &array, const bool expand=true)
Static Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >
static Ptr	create (const AttributeArray &array, const bool collapseOnDestruction=true)

Friends
class	::TestAttributeArray

Additional Inherited Members
Protected Types inherited from openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >
using	GetterPtr = ValueType(*)(const AttributeArray *array, const Index n)
using	SetterPtr = void(*)(AttributeArray *array, const Index n, const ValueType &value)
using	ValuePtr = void(*)(AttributeArray *array, const ValueType &value)
Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >
Index	index (Index n, Index m) const
Protected Attributes inherited from openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >
const AttributeArray *	mArray
GetterPtr	mGetter
SetterPtr	mSetter
ValuePtr	mCollapser
ValuePtr	mFiller

Detailed Description

template<typename ValueType, typename CodecType = UnknownCodec>
class openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >

Write-able version of AttributeHandle.

Definition at line 905 of file AttributeArray.h.

Member Typedef Documentation

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::Handle = AttributeWriteHandle<ValueType, CodecType>

Definition at line 908 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::Ptr = std::shared_ptr<Handle>

Definition at line 909 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::ScopedPtr = std::unique_ptr<Handle>

Definition at line 910 of file AttributeArray.h.

Constructor & Destructor Documentation

template<typename ValueType , typename CodecType >

openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::AttributeWriteHandle	(	AttributeArray &	array,
		const bool	expand = true
	)

Definition at line 2237 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

virtual openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::~AttributeWriteHandle ( )

virtualdefault

Member Function Documentation

template<typename ValueType , typename CodecType >

AttributeArray & openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::array

(

)

Definition at line 2306 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

void openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::collapse

(

)

Replace the existing array with a uniform value (zero if none provided).

Definition at line 2262 of file AttributeArray.h.

template<typename ValueType, typename CodecType >

void openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::collapse

(

const ValueType &

uniformValue

)

Definition at line 2274 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

bool openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::compact

(

)

Compact the existing array to become uniform if all values are identical.

Definition at line 2268 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

AttributeWriteHandle< ValueType, CodecType >::Ptr openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::create ( AttributeArray &  array, const bool  expand = true  )

static

Definition at line 2230 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

void openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::expand

(

bool

fill = true

)

If this array is uniform, replace it with an array of length size().

Parameters

fill	if true, assign the uniform value to each element of the array.

Definition at line 2256 of file AttributeArray.h.

template<typename ValueType, typename CodecType >

void openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::fill

(

const ValueType &

value

)

Fill the existing array with the given value.

Note

Identical to collapse() except a non-uniform array will not become uniform.

Definition at line 2280 of file AttributeArray.h.

template<typename ValueType, typename CodecType >

void openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::set	(	Index	n,
		const ValueType &	value
	)

Definition at line 2244 of file AttributeArray.h.

template<typename ValueType, typename CodecType >

void openvdb::OPENVDB_VERSION_NAME::points::AttributeWriteHandle< ValueType, CodecType >::set	(	Index	n,
		Index	m,
		const ValueType &	value
	)

Definition at line 2250 of file AttributeArray.h.

Friends And Related Function Documentation

template<typename ValueType, typename CodecType = UnknownCodec>

friend class ::TestAttributeArray

friend

Definition at line 939 of file AttributeArray.h.

---

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

• openvdb/points/AttributeArray.h