HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
GA_ROHandleT< T, typename SCALAR(T) > Class Template Reference

#include <GA_Handle.h>

Public Types

typedef T(* GAprobeAttribGetter )(const GA_Attribute *atr, GA_Offset, int)
 
typedef T BASETYPE
 

Public Member Functions

 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_ATINumeric * getAttribute () const
 
int getTupleSize () 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 T get (GA_Offset off, int comp=0) const
 
SYS_FORCE_INLINE void getV (GA_Offset off, T *data, int size) 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, int comp=0) 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_ATINumeric * operator-> () const
 

Protected Attributes

GA_ATINumeric * myAttrib
 
GA_PageArray< BASETYPE, 1 > * myExactMatch
 
GA_PageArray< BASETYPE > * myAlmostMatch
 

Detailed Description

template<typename T>
class GA_ROHandleT< T, typename SCALAR(T) >

Read-only handle for scalar attribute data.

Template Parameters
TReturn type for get methods

Definition at line 518 of file GA_Handle.h.

Member Typedef Documentation

template<typename T >
typedef T GA_ROHandleT< T, typename SCALAR(T) >::BASETYPE

Definition at line 522 of file GA_Handle.h.

template<typename T >
typedef T(* GA_ROHandleT< T, typename SCALAR(T) >::GAprobeAttribGetter)(const GA_Attribute *atr, GA_Offset, int)

Definition at line 521 of file GA_Handle.h.

Constructor & Destructor Documentation

template<typename T >
GA_ROHandleT< T, typename SCALAR(T) >::GA_ROHandleT ( )
inline

Definition at line 524 of file GA_Handle.h.

template<typename T >
GA_ROHandleT< T, typename SCALAR(T) >::GA_ROHandleT ( const GA_Attribute *  attrib)
inline

Definition at line 528 of file GA_Handle.h.

template<typename T >
GA_ROHandleT< T, typename SCALAR(T) >::GA_ROHandleT ( const GA_Detail *  gdp,
GA_AttributeOwner  owner,
const UT_StringRef &  name,
int  minsize = 1 
)

Member Function Documentation

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

Definition at line 542 of file GA_Handle.h.

template<typename T >
void GA_ROHandleT< T, typename SCALAR(T) >::bind ( const GA_ATINumeric *  attrib,
int  minsize = 1 
)
inline

Definition at line 546 of file GA_Handle.h.

template<typename T >
void GA_ROHandleT< T, typename SCALAR(T) >::clear ( )
inline

Definition at line 585 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE T GA_ROHandleT< T, typename SCALAR(T) >::get ( GA_Offset  off,
int  comp = 0 
) const
inline

Definition at line 601 of file GA_Handle.h.

template<typename T >
const GA_ATINumeric* GA_ROHandleT< T, typename SCALAR(T) >::getAttribute ( ) const
inline

Definition at line 571 of file GA_Handle.h.

template<typename T >
void GA_ROHandleT< T, typename SCALAR(T) >::getBlock ( GA_Offset  startoff,
GA_Size  nelements,
T *  dest,
int  deststride = 1,
int  component = 0 
) const

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

template<typename T >
void GA_ROHandleT< T, typename SCALAR(T) >::getBlockFromIndices ( GA_Index  startidx,
GA_Size  nelements,
T *  dest,
int  deststride = 1,
int  component = 0 
) const

Copies attribute values from a contiguous block of indices into the dest array. This allows there to be holes in the geometry.

template<typename T >
GA_DataId GA_ROHandleT< T, typename SCALAR(T) >::getDataId ( ) const
inline

Definition at line 574 of file GA_Handle.h.

template<typename T >
int GA_ROHandleT< T, typename SCALAR(T) >::getTupleSize ( ) const
inline

Definition at line 572 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE void GA_ROHandleT< T, typename SCALAR(T) >::getV ( GA_Offset  off,
T *  data,
int  size 
) const
inline

Definition at line 625 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE bool GA_ROHandleT< T, typename SCALAR(T) >::isInvalid ( ) const
inline

Definition at line 596 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE bool GA_ROHandleT< T, typename SCALAR(T) >::isPageConstant ( GA_PageNum  pagenum) const
inline

Returns true iff the specified page is constant-compressed, where a single value is stored to represent GA_PAGE_SIZE values in the page, (or possibly fewer if only one page).

Definition at line 671 of file GA_Handle.h.

template<typename T >
bool GA_ROHandleT< T, typename SCALAR(T) >::isRational ( ) const
inline

Definition at line 582 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE bool GA_ROHandleT< T, typename SCALAR(T) >::isValid ( ) const
inline

Definition at line 592 of file GA_Handle.h.

template<typename T >
bool GA_ROHandleT< T, typename SCALAR(T) >::operator!= ( const GA_ROHandleT< T > &  handle) const
inline

Definition at line 679 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE T GA_ROHandleT< T, typename SCALAR(T) >::operator() ( GA_Offset  off,
int  comp = 0 
) const
inline

Definition at line 660 of file GA_Handle.h.

template<typename T >
const GA_ATINumeric* GA_ROHandleT< T, typename SCALAR(T) >::operator-> ( ) const
inline

Definition at line 683 of file GA_Handle.h.

template<typename T >
void GA_ROHandleT< T, typename SCALAR(T) >::operator= ( const GA_Attribute *  attrib)
inline

Definition at line 534 of file GA_Handle.h.

template<typename T >
bool GA_ROHandleT< T, typename SCALAR(T) >::operator== ( const GA_ROHandleT< T > &  handle) const
inline

Definition at line 675 of file GA_Handle.h.

template<typename T >
SYS_FORCE_INLINE T GA_ROHandleT< T, typename SCALAR(T) >::operator[] ( GA_Offset  off) const
inline

Definition at line 664 of file GA_Handle.h.

Member Data Documentation

template<typename T >
GA_PageArray<BASETYPE>* GA_ROHandleT< T, typename SCALAR(T) >::myAlmostMatch
protected

Definition at line 691 of file GA_Handle.h.

template<typename T >
GA_ATINumeric* GA_ROHandleT< T, typename SCALAR(T) >::myAttrib
protected

Definition at line 689 of file GA_Handle.h.

template<typename T >
GA_PageArray<BASETYPE,1>* GA_ROHandleT< T, typename SCALAR(T) >::myExactMatch
protected

Definition at line 690 of file GA_Handle.h.

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