HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros 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...
 
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
 
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, GUI/GUI_PrimVolumeVelField.C, RAY/RAY_DemoSprite.C, RAY/RAY_DemoSprite.h, and standalone/geo2voxel.C.

Definition at line 873 of file GA_Handle.h.

Constructor & Destructor Documentation

GA_ROHandleS::GA_ROHandleS ( )
inline

Definition at line 876 of file GA_Handle.h.

GA_ROHandleS::GA_ROHandleS ( const GA_Attribute attrib)
inline

Definition at line 880 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 893 of file GA_Handle.h.

void GA_ROHandleS::clear ( )
inline

Clear the handle.

Examples:
RAY/RAY_DemoSprite.C.

Definition at line 908 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 917 of file GA_Handle.h.

const GA_Attribute* GA_ROHandleS::getAttribute ( ) const
inline

Access to attribute.

Definition at line 903 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 925 of file GA_Handle.h.

int GA_ROHandleS::getTupleSize ( ) const
inline

Tuple size of the attribute.

Definition at line 905 of file GA_Handle.h.

SYS_FORCE_INLINE bool GA_ROHandleS::isInvalid ( ) const
inline

Validity checks

Definition at line 913 of file GA_Handle.h.

SYS_FORCE_INLINE bool GA_ROHandleS::isValid ( ) const
inline

Validity checks

Examples:
RAY/RAY_DemoSprite.C.

Definition at line 912 of file GA_Handle.h.

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

Definition at line 932 of file GA_Handle.h.

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

Definition at line 886 of file GA_Handle.h.

Member Data Documentation

const GA_ATIString* GA_ROHandleS::myAttrib
protected

Definition at line 938 of file GA_Handle.h.


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