HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_ROHandleS Class Reference

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

#include <GA_Handle.h>

+ Inheritance diagram for GA_ROHandleS:

Public Member Functions

 GA_ROHandleS ()
 
 GA_ROHandleS (const GA_Attribute *attrib)
 
 GA_ROHandleS (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_AttributegetAttribute () 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
UT_StringHolder
get (GA_Offset off, int comp=0) const
 Get the string at the given offset. More...
 
SYS_FORCE_INLINE GA_StringIndexType getIndex (GA_Offset off, int comp=0) const
 Get the string index at the given offset. More...
 
const GA_ATIStringoperator-> () const
 
void getIndexBlock (GA_Offset startoff, GA_Size nelements, GA_StringIndexType *dest, int deststride=1, int component=0) const
 
void getIndexBlockFromIndices (GA_Index startidx, GA_Size nelements, GA_StringIndexType *dest, int deststride=1, int component=0) const
 
SYS_FORCE_INLINE bool isValid () const
 
SYS_FORCE_INLINE bool isInvalid () const
 

Protected Attributes

const GA_ATIStringmyAttrib
 

Detailed Description

Read-only handle for string attribute data.

Examples:
field3d/f3d_io.C, GEO/GEO_VoxelTranslator.C, RAY/RAY_DemoSprite.C, RAY/RAY_DemoSprite.h, and standalone/geo2voxel.C.

Definition at line 770 of file GA_Handle.h.

Constructor & Destructor Documentation

GA_ROHandleS::GA_ROHandleS ( )
inline

Definition at line 773 of file GA_Handle.h.

GA_ROHandleS::GA_ROHandleS ( const GA_Attribute attrib)
inline

Definition at line 777 of file GA_Handle.h.

GA_ROHandleS::GA_ROHandleS ( const GA_Detail gdp,
GA_AttributeOwner  owner,
const UT_StringRef name,
int  minsize = 1 
)

Member Function Documentation

void GA_ROHandleS::bind ( const GA_Detail gdp,
GA_AttributeOwner  owner,
const UT_StringRef name,
int  minsize = 1 
)
void GA_ROHandleS::bind ( const GA_Attribute attrib,
int  minsize = 1 
)
inline

Bind the handle to the given attribute.

Definition at line 790 of file GA_Handle.h.

void GA_ROHandleS::clear ( )
inline

Clear the handle.

Examples:
RAY/RAY_DemoSprite.C.

Definition at line 813 of file GA_Handle.h.

SYS_FORCE_INLINE const UT_StringHolder& GA_ROHandleS::get ( GA_Offset  off,
int  comp = 0 
) const
inline

Get the string at the given offset.

Examples:
RAY/RAY_DemoSprite.C.

Definition at line 822 of file GA_Handle.h.

const GA_Attribute* GA_ROHandleS::getAttribute ( ) const
inline

Access to attribute.

Definition at line 800 of file GA_Handle.h.

GA_DataId GA_ROHandleS::getDataId ( ) const
inline

Definition at line 804 of file GA_Handle.h.

SYS_FORCE_INLINE GA_StringIndexType GA_ROHandleS::getIndex ( GA_Offset  off,
int  comp = 0 
) const
inline

Get the string index at the given offset.

Definition at line 830 of file GA_Handle.h.

void GA_ROHandleS::getIndexBlock ( GA_Offset  startoff,
GA_Size  nelements,
GA_StringIndexType 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.

void GA_ROHandleS::getIndexBlockFromIndices ( GA_Index  startidx,
GA_Size  nelements,
GA_StringIndexType 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.

int GA_ROHandleS::getTupleSize ( ) const
inline

Tuple size of the attribute.

Definition at line 802 of file GA_Handle.h.

SYS_FORCE_INLINE bool GA_ROHandleS::isInvalid ( ) const
inline

Validity checks

Definition at line 818 of file GA_Handle.h.

SYS_FORCE_INLINE bool GA_ROHandleS::isValid ( ) const
inline

Validity checks

Examples:
RAY/RAY_DemoSprite.C.

Definition at line 817 of file GA_Handle.h.

const GA_ATIString* GA_ROHandleS::operator-> ( ) const
inline

Definition at line 837 of file GA_Handle.h.

void GA_ROHandleS::operator= ( const GA_Attribute attrib)
inline

Definition at line 783 of file GA_Handle.h.

Member Data Documentation

const GA_ATIString* GA_ROHandleS::myAttrib
protected

Definition at line 857 of file GA_Handle.h.


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