HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_RWHandleT< T, ENABLE > Class Template Reference

#include <GA_Handle.h>

+ Inheritance diagram for GA_RWHandleT< T, ENABLE >:

Public Types

typedef void(* GAprobeAttribSetter )(GA_Attribute *atr, GA_Offset, const T &)
 
typedef GA_ROHandleT< TBase
 
typedef T::value_type BASETYPE
 
using ALTBASETYPE = typename UT_StorageNum< BASETYPE >::SecondGuess
 
using ALTTYPE = UT_FixedVector< ALTBASETYPE, theTupleSize >
 
- Public Types inherited from GA_ROHandleT< T, ENABLE >
typedef void(* GAprobeAttribGetter )(T &result, const GA_Attribute *atr, GA_Offset)
 
typedef T::value_type BASETYPE
 
using ALTBASETYPE = typename UT_StorageNum< BASETYPE >::SecondGuess
 
using ALTTYPE = UT_FixedVector< ALTBASETYPE, theTupleSize >
 

Public Member Functions

 GA_RWHandleT ()
 
 GA_RWHandleT (GA_Attribute *attrib)
 
 GA_RWHandleT (GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
void operator= (GA_Attribute *attrib)
 
void bind (GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
SYS_FORCE_INLINE void bind (GA_Attribute *attrib, int minsize=1)
 
SYS_FORCE_INLINE void bind (GA_ATINumeric *attrib, int minsize=1)
 
GA_ATINumericgetAttribute () const
 
void bumpDataId () const
 
GA_DataId getDataId () const
 
SYS_FORCE_INLINE void set (GA_Offset off, const T &val) const
 
SYS_FORCE_INLINE void setAlt (GA_Offset off, const ALTTYPE &val) const
 
SYS_FORCE_INLINE void set (GA_Offset off, int comp, const T &val) const
 
SYS_FORCE_INLINE void setAlt (GA_Offset off, int comp, const ALTTYPE &val) const
 
SYS_FORCE_INLINE void add (GA_Offset off, const T &val) const
 
SYS_FORCE_INLINE void addAlt (GA_Offset off, const ALTTYPE &val) const
 
SYS_FORCE_INLINE void add (GA_Offset off, int comp, const T &val) const
 
SYS_FORCE_INLINE void addAlt (GA_Offset off, int comp, const ALTTYPE &val) const
 
void setBlock (GA_Offset startoff, GA_Size nelements, const T *source, int sourcestride=1, int component=0) const
 
void setBlockFromIndices (GA_Index startidx, GA_Size nelements, const T *source, int sourcestride=1, int component=0) const
 
void makeConstant (const T &cval) const
 
void setPageConstant (GA_PageNum pagenum, const BASETYPE *values) const
 
GA_ATINumericoperator-> () const
 
- Public Member Functions inherited from GA_ROHandleT< T, ENABLE >
 GA_ROHandleT ()
 
 GA_ROHandleT (const GA_Attribute *attrib)
 
 GA_ROHandleT (const GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
void operator= (const GA_Attribute *attrib)
 
void bind (const GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
SYS_FORCE_INLINE void bind (const GA_Attribute *attrib, int minsize=1)
 
void bind (const GA_ATINumeric *attrib, int minsize=1)
 
const GA_ATINumericgetAttribute () const
 
GA_DataId getDataId () const
 
bool isRational () const
 
void clear ()
 
SYS_FORCE_INLINE bool isValid () const
 
SYS_FORCE_INLINE bool isInvalid () const
 
SYS_FORCE_INLINE bool isAltBound () const
 
SYS_FORCE_INLINE T get (GA_Offset off, int comp=0) const
 
SYS_FORCE_INLINE ALTTYPE getAlt (GA_Offset off, int comp=0) const
 
void getBlock (GA_Offset startoff, GA_Size nelements, T *dest, int deststride=1, int component=0) const
 
void getBlockFromIndices (GA_Index startidx, GA_Size nelements, T *dest, int deststride=1, int component=0) const
 
SYS_FORCE_INLINE T operator() (GA_Offset off) const
 
SYS_FORCE_INLINE T operator[] (GA_Offset off) const
 
SYS_FORCE_INLINE bool isPageConstant (GA_PageNum pagenum) const
 
bool operator== (const GA_ROHandleT< T > &handle) const
 
bool operator!= (const GA_ROHandleT< T > &handle) const
 
const GA_ATINumericoperator-> () const
 

Additional Inherited Members

- Static Public Attributes inherited from GA_ROHandleT< T, ENABLE >
static const exint theTupleSize = UT_FixedVectorTraits<T>::TupleSize
 
- Protected Attributes inherited from GA_ROHandleT< T, ENABLE >
GA_ATINumericmyAttrib
 
GA_PageArray< BASETYPE,
theTupleSize > * 
myExactMatch
 
GA_PageArray< typename
UT_StorageNum< BASETYPE >
::SecondGuess, theTupleSize > * 
myAlmostMatch
 

Detailed Description

template<typename T, typename ENABLE = void>
class GA_RWHandleT< T, ENABLE >

Read-write handle for vector attribute data.

Template Parameters
TReturn vector type for get methods. Requires T::value_type to describe the underlying element type of the vector.
Examples:
mocapstream/MocapStreamRokokoHDK.C, and SOP/SOP_PrimVOP.C.

Definition at line 293 of file GA_Handle.h.

Member Typedef Documentation

template<typename T, typename ENABLE = void>
using GA_RWHandleT< T, ENABLE >::ALTBASETYPE = typename UT_StorageNum<BASETYPE>::SecondGuess

Definition at line 305 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
using GA_RWHandleT< T, ENABLE >::ALTTYPE = UT_FixedVector<ALTBASETYPE, theTupleSize>

Definition at line 306 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
typedef GA_ROHandleT<T> GA_RWHandleT< T, ENABLE >::Base

Definition at line 297 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
typedef T::value_type GA_RWHandleT< T, ENABLE >::BASETYPE

Definition at line 298 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
typedef void(* GA_RWHandleT< T, ENABLE >::GAprobeAttribSetter)(GA_Attribute *atr, GA_Offset, const T &)

Definition at line 296 of file GA_Handle.h.

Constructor & Destructor Documentation

template<typename T, typename ENABLE = void>
GA_RWHandleT< T, ENABLE >::GA_RWHandleT ( )
inline

Definition at line 308 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
GA_RWHandleT< T, ENABLE >::GA_RWHandleT ( GA_Attribute attrib)
inline

Definition at line 312 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
GA_RWHandleT< T, ENABLE >::GA_RWHandleT ( GA_Detail gdp,
GA_AttributeOwner  owner,
const UT_StringRef name,
int  minsize = 1 
)

Member Function Documentation

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::add ( GA_Offset  off,
const T val 
) const
inline

Definition at line 407 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::add ( GA_Offset  off,
int  comp,
const T val 
) const
inline

Definition at line 433 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::addAlt ( GA_Offset  off,
const ALTTYPE val 
) const
inline

Definition at line 420 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::addAlt ( GA_Offset  off,
int  comp,
const ALTTYPE val 
) const
inline

Definition at line 447 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::bind ( GA_Detail gdp,
GA_AttributeOwner  owner,
const UT_StringRef name,
int  minsize = 1 
)
template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::bind ( GA_Attribute attrib,
int  minsize = 1 
)
inline

Definition at line 326 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::bind ( GA_ATINumeric attrib,
int  minsize = 1 
)
inline

Definition at line 331 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::bumpDataId ( ) const
inline

Definition at line 340 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
GA_ATINumeric* GA_RWHandleT< T, ENABLE >::getAttribute ( ) const
inline

Definition at line 338 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
GA_DataId GA_RWHandleT< T, ENABLE >::getDataId ( ) const
inline

Definition at line 346 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::makeConstant ( const T cval) const
inline

Definition at line 470 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
GA_ATINumeric* GA_RWHandleT< T, ENABLE >::operator-> ( ) const
inline

Definition at line 489 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::operator= ( GA_Attribute attrib)
inline

Definition at line 318 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::set ( GA_Offset  off,
const T val 
) const
inline

Definition at line 353 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::set ( GA_Offset  off,
int  comp,
const T val 
) const
inline

Definition at line 379 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::setAlt ( GA_Offset  off,
const ALTTYPE val 
) const
inline

Definition at line 366 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
SYS_FORCE_INLINE void GA_RWHandleT< T, ENABLE >::setAlt ( GA_Offset  off,
int  comp,
const ALTTYPE val 
) const
inline

Definition at line 393 of file GA_Handle.h.

template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::setBlock ( GA_Offset  startoff,
GA_Size  nelements,
const T source,
int  sourcestride = 1,
int  component = 0 
) const

Copies attribute values from the source array into a contiguous block of offsets. NOTE: The block of offsets is assumed to have no holes, else data could be written to offsets that don't have corresponding elements.

template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::setBlockFromIndices ( GA_Index  startidx,
GA_Size  nelements,
const T source,
int  sourcestride = 1,
int  component = 0 
) const
template<typename T, typename ENABLE = void>
void GA_RWHandleT< T, ENABLE >::setPageConstant ( GA_PageNum  pagenum,
const BASETYPE values 
) const
inline

Sets all components of all elements of the specified page to the given values. NOTE: The length of values must be equal to the tuple size.

Definition at line 479 of file GA_Handle.h.


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