GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI > Class Template Reference

Read-only handle for string attribute data. More...

#include <GA_Handle.h>

Inheritance diagram for GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >:

Public Member Functions
	GA_ROHandleTHolder ()
	GA_ROHandleTHolder (const GA_Attribute *attrib)
	GA_ROHandleTHolder (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)
void	bind (const GA_Attribute *attrib, int minsize=1)
	Bind the handle to the given attribute. More...
const GA_Attribute *	getAttribute () const
	Access to attribute. More...
int	getTupleSize () const
	Tuple size of the attribute. More...
GA_DataId	getDataId () const
void	clear ()
	Clear the handle. More...
SYS_FORCE_INLINE const HOLDER &	get (GA_Offset off, int comp=0) const
	Get the string at the given offset. More...
SYS_FORCE_INLINE INDEXTYPE	getIndex (GA_Offset off, int comp=0) const
	Get the string index at the given offset. More...
const ATI *	operator-> () const
void	getIndexBlock (GA_Offset startoff, GA_Size nelements, INDEXTYPE *dest, int deststride=1, int component=0) const
void	getIndexBlockFromIndices (GA_Index startidx, GA_Size nelements, INDEXTYPE *dest, int deststride=1, int component=0) const
SYS_FORCE_INLINE bool	isValid () const
SYS_FORCE_INLINE bool	isInvalid () const

Protected Attributes
const ATI *	myAttrib

Detailed Description

template<typename HOLDER, typename INDEXTYPE, typename ATI>
class GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >

Read-only handle for string attribute data.

Examples:

mocapstream/MocapStreamRokokoHDK.C, RAY/RAY_DemoSprite.h, and standalone/geo2voxel.C.

Definition at line 858 of file GA_Handle.h.

Constructor & Destructor Documentation

template<typename HOLDER, typename INDEXTYPE, typename ATI>

GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::GA_ROHandleTHolder ( )

inline

Definition at line 861 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::GA_ROHandleTHolder ( const GA_Attribute *  attrib )

inline

Definition at line 865 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::GA_ROHandleTHolder	(	const GA_Detail *	gdp,
		GA_AttributeOwner	owner,
		const UT_StringRef &	name,
		int	minsize = 1
	)

Member Function Documentation

template<typename HOLDER, typename INDEXTYPE, typename ATI>

void GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::bind	(	const GA_Detail *	gdp,
		GA_AttributeOwner	owner,
		const UT_StringRef &	name,
		int	minsize = 1
	)

template<typename HOLDER, typename INDEXTYPE, typename ATI>

void GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::bind ( const GA_Attribute *  attrib, int  minsize = 1  )

inline

Bind the handle to the given attribute.

Definition at line 878 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

void GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::clear ( )

inline

Clear the handle.

Definition at line 901 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

SYS_FORCE_INLINE const HOLDER& GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::get ( GA_Offset  off, int  comp = 0  ) const

inline

Get the string at the given offset.

Definition at line 910 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

const GA_Attribute* GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::getAttribute ( ) const

inline

Access to attribute.

Definition at line 888 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

GA_DataId GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::getDataId ( ) const

inline

Definition at line 892 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

SYS_FORCE_INLINE INDEXTYPE GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::getIndex ( GA_Offset  off, int  comp = 0  ) const

inline

Get the string index at the given offset.

Definition at line 918 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

void GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::getIndexBlock	(	GA_Offset	startoff,
		GA_Size	nelements,
		INDEXTYPE *	dest,
		int	deststride = 1,
		int	component = 0
	)		const

Copies attribute string indices 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 HOLDER, typename INDEXTYPE, typename ATI>

void GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::getIndexBlockFromIndices	(	GA_Index	startidx,
		GA_Size	nelements,
		INDEXTYPE *	dest,
		int	deststride = 1,
		int	component = 0
	)		const

Copies attribute string indices from a contiguous block of indices into the dest array. This allows there to be holes in the geometry. The dest array will be densely filled as per the index mapping.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

int GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::getTupleSize ( ) const

inline

Tuple size of the attribute.

Definition at line 890 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

SYS_FORCE_INLINE bool GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::isInvalid ( ) const

inline

Validity checks

Definition at line 906 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

SYS_FORCE_INLINE bool GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::isValid ( ) const

inline

Validity checks

Definition at line 905 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

const ATI* GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::operator-> ( ) const

inline

Definition at line 925 of file GA_Handle.h.

template<typename HOLDER, typename INDEXTYPE, typename ATI>

void GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::operator= ( const GA_Attribute *  attrib )

inline

Definition at line 871 of file GA_Handle.h.

Member Data Documentation

template<typename HOLDER, typename INDEXTYPE, typename ATI>

const ATI* GA_ROHandleTHolder< HOLDER, INDEXTYPE, ATI >::myAttrib

protected

Definition at line 945 of file GA_Handle.h.

---

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

• GA/GA_Handle.h