HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType > Class Template Reference

#include <AttributeArray.h>

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

Public Types

using Handle = AttributeHandle< ValueType, CodecType >
 
using Ptr = std::shared_ptr< Handle >
 
using UniquePtr = std::unique_ptr< Handle >
 

Public Member Functions

 AttributeHandle (const AttributeArray &array, const bool preserveCompression=true)
 
 AttributeHandle (const AttributeHandle &)=default
 
AttributeHandleoperator= (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
 

Static Public Member Functions

static Ptr create (const AttributeArray &array, const bool preserveCompression=true)
 

Protected Types

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

Index index (Index n, Index m) const
 

Protected Attributes

const AttributeArraymArray
 
GetterPtr mGetter
 
SetterPtr mSetter
 
ValuePtr mCollapser
 
ValuePtr mFiller
 

Friends

class ::TestAttributeArray
 

Detailed Description

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

AttributeHandles provide access to specific TypedAttributeArray methods without needing to know the compression codec, however these methods also incur the cost of a function pointer

Definition at line 640 of file AttributeArray.h.

Member Typedef Documentation

template<typename ValueType, typename CodecType = UnknownCodec>
using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::GetterPtr = ValueType (*)(const AttributeArray* array, const Index n)
protected

Definition at line 648 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::Handle = AttributeHandle<ValueType, CodecType>

Definition at line 643 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::Ptr = std::shared_ptr<Handle>

Definition at line 644 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::SetterPtr = void (*)(AttributeArray* array, const Index n, const ValueType& value)
protected

Definition at line 649 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::UniquePtr = std::unique_ptr<Handle>

Definition at line 645 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::ValuePtr = void (*)(AttributeArray* array, const ValueType& value)
protected

Definition at line 650 of file AttributeArray.h.

Constructor & Destructor Documentation

template<typename ValueType , typename CodecType >
openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::AttributeHandle ( const AttributeArray array,
const bool  preserveCompression = true 
)

Definition at line 1836 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::AttributeHandle ( const AttributeHandle< ValueType, CodecType > &  )
default
template<typename ValueType , typename CodecType >
openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::~AttributeHandle ( )
virtual

Definition at line 1879 of file AttributeArray.h.

Member Function Documentation

template<typename ValueType , typename CodecType >
AttributeHandle< ValueType, CodecType >::Ptr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::create ( const AttributeArray array,
const bool  preserveCompression = true 
)
static

Definition at line 1829 of file AttributeArray.h.

template<typename ValueType , typename CodecType >
ValueType openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::get ( Index  n,
Index  m = 0 
) const

Definition at line 1914 of file AttributeArray.h.

template<typename ValueType , typename CodecType >
bool openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::hasConstantStride ( ) const

Definition at line 1946 of file AttributeArray.h.

template<typename ValueType , typename CodecType >
Index openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::index ( Index  n,
Index  m 
) const
protected

Definition at line 1906 of file AttributeArray.h.

template<typename ValueType , typename CodecType >
bool openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::isUniform ( ) const

Definition at line 1940 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
AttributeHandle& openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::operator= ( const AttributeHandle< ValueType, CodecType > &  )
default
template<typename ValueType, typename CodecType = UnknownCodec>
Index openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::size ( void  ) const
inline

Definition at line 663 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
Index openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::stride ( ) const
inline

Definition at line 662 of file AttributeArray.h.

Friends And Related Function Documentation

template<typename ValueType, typename CodecType = UnknownCodec>
friend class ::TestAttributeArray
friend

Definition at line 681 of file AttributeArray.h.

Member Data Documentation

template<typename ValueType, typename CodecType = UnknownCodec>
const AttributeArray* openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mArray
protected

Definition at line 673 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
ValuePtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mCollapser
protected

Definition at line 677 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
ValuePtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mFiller
protected

Definition at line 678 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
GetterPtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mGetter
protected

Definition at line 675 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>
SetterPtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mSetter
protected

Definition at line 676 of file AttributeArray.h.


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