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

Read-Write string handle. More...

#include <GA_Handle.h>

+ Inheritance diagram for GA_RWHandleS:

Public Member Functions

 GA_RWHandleS ()
 
 GA_RWHandleS (GA_Attribute *attrib)
 
 GA_RWHandleS (const GA_Detail *gdp, GA_AttributeOwner owner, const UT_StringRef &name, int minsize=1)
 
void operator= (GA_Attribute *attrib)
 
GA_AttributegetAttribute () const
 
void bumpDataId () const
 
SYS_FORCE_INLINE void set (GA_Offset off, const UT_StringHolder &str) const
 Store the str at the given offset. More...
 
SYS_FORCE_INLINE void set (GA_Offset off, int comp, const UT_StringHolder &str) const
 
SYS_FORCE_INLINE void set (GA_Offset off, GA_StringIndexType idx) const
 Store the string indexed by the idx at the given offset. More...
 
SYS_FORCE_INLINE void set (GA_Offset off, int comp, GA_StringIndexType idx) const
 
GA_ATIStringoperator-> () const
 
- Public Member Functions inherited from GA_ROHandleS
 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 Member Functions

GA_ATIStringrwAttrib () const
 

Additional Inherited Members

- Protected Attributes inherited from GA_ROHandleS
const GA_ATIStringmyAttrib
 

Detailed Description

Read-Write string handle.

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

Definition at line 942 of file GA_Handle.h.

Constructor & Destructor Documentation

GA_RWHandleS::GA_RWHandleS ( )
inline

Definition at line 945 of file GA_Handle.h.

GA_RWHandleS::GA_RWHandleS ( GA_Attribute attrib)
inline

Definition at line 949 of file GA_Handle.h.

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

Definition at line 953 of file GA_Handle.h.

Member Function Documentation

void GA_RWHandleS::bumpDataId ( ) const
inline

Definition at line 965 of file GA_Handle.h.

GA_Attribute* GA_RWHandleS::getAttribute ( ) const
inline

Definition at line 963 of file GA_Handle.h.

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

Definition at line 995 of file GA_Handle.h.

void GA_RWHandleS::operator= ( GA_Attribute attrib)
inline

Definition at line 958 of file GA_Handle.h.

GA_ATIString* GA_RWHandleS::rwAttrib ( ) const
inlineprotected

Definition at line 1000 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWHandleS::set ( GA_Offset  off,
const UT_StringHolder str 
) const
inline

Store the str at the given offset.

Examples:
RAY/RAY_DemoSprite.C.

Definition at line 972 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWHandleS::set ( GA_Offset  off,
int  comp,
const UT_StringHolder str 
) const
inline

Definition at line 976 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWHandleS::set ( GA_Offset  off,
GA_StringIndexType  idx 
) const
inline

Store the string indexed by the idx at the given offset.

Definition at line 984 of file GA_Handle.h.

SYS_FORCE_INLINE void GA_RWHandleS::set ( GA_Offset  off,
int  comp,
GA_StringIndexType  idx 
) const
inline

Definition at line 988 of file GA_Handle.h.


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