GB_AttributeRef Class Reference

This class provides a way to lookup attribute data for an element. More...

#include <GB_AttributeRef.h>

List of all members.

Public Member Functions
	GB_AttributeRef ()
	Default constructor.
	GB_AttributeRef (const GB_AttributeRef &)
	Copy constructor.
	~GB_AttributeRef ()
	Destructor.
GB_AttributeRef &	operator= (const GB_AttributeRef &src)
	Assignment operator.
bool	operator== (const GB_AttributeRef &src) const
	Comparison operator.
bool	operator!= (const GB_AttributeRef &src) const
	Comparison operator.
bool	isValid () const
	Test to see if the attribute reference refers to a valid attribute.
bool	isInvalid () const
	Test to see if the attribute reference refers to a valid attribute.
void	clear ()
	Method to clear the handle (so that it is no longer valid).
Friends
class	GB_AttributeData
class	GB_AttributeElem
class	GB_AttributeDict
class	GB_AttributeDictOffsetIterator
class	GB_ConstAttributeDictOffsetIterator
class	GB_AttributeTable
class	GEO_AttribDict
class	GEO_AttributeHandleList
class	GEO_PointAttribDict
class	GEO_PrimAttribDict
class	GEO_VertexAttribDict
class	GU_CurveCache
class	GU_PrimTriBezierCache
class	GU_TPSurfCache
class	POP_AttribMap

---

Detailed Description

This class provides a way to lookup attribute data for an element.

Each GB_AttributeElem stores attribute data. The GB_AttributeRef class stores the information needed to extract the data from the attribute element.

This class provides an opaque interface to how the element stores the data.

     GB_AttributeRef          Nref;
     UT_Vector3              *N;
     Nref = gdp.findNormalAttribute(GEO_POINT_DICT);
     if (Nref.isValid())
     {
         FOR_ALL_GPOINTS(gdp, ppt)
         {
             N = ppt->castAttribData<UT_Vector3>(Nref);
             N->normalize();
         }
     }

See also:

GEO_Detail::findPointAttrib()

Examples:

POP/POP_LocalForce.C, POP/POP_LocalForce.h, SIM/SIM_ForceOrbit.C, SIM/SIM_SolverHair.C, SOP/SOP_BrushHairLen.C, SOP/SOP_BrushHairLen.h, SOP/SOP_CopRaster.C, SOP/SOP_CustomBrush.C, SOP/SOP_DetailAttrib.C, SOP/SOP_IKSample.C, SOP/SOP_SParticle.h, VRAY/VRAY_DemoSprite.C, and VRAY/VRAY_DemoSprite.h.

Definition at line 47 of file GB_AttributeRef.h.

---

Constructor & Destructor Documentation

GB_AttributeRef::GB_AttributeRef

(

)

Default constructor.

GB_AttributeRef::GB_AttributeRef

(

const GB_AttributeRef &

)

Copy constructor.

GB_AttributeRef::~GB_AttributeRef

(

)

Destructor.

---

Member Function Documentation

void GB_AttributeRef::clear

(

)

[inline]

Method to clear the handle (so that it is no longer valid).

Examples:

POP/POP_LocalForce.C, and VRAY/VRAY_DemoSprite.C.

Definition at line 73 of file GB_AttributeRef.h.

bool GB_AttributeRef::isInvalid

(

)

const [inline]

Test to see if the attribute reference refers to a valid attribute.

Examples:

POP/POP_LocalForce.C, SOP/SOP_BrushHairLen.C, SOP/SOP_CustomBrush.C, and VRAY/VRAY_DemoSprite.C.

Definition at line 70 of file GB_AttributeRef.h.

bool GB_AttributeRef::isValid

(

)

const [inline]

Test to see if the attribute reference refers to a valid attribute.

Examples:

POP/POP_LocalForce.C, SIM/SIM_ForceOrbit.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, and VRAY/VRAY_DemoSprite.C.

Definition at line 67 of file GB_AttributeRef.h.

bool GB_AttributeRef::operator!=

(

const GB_AttributeRef &

src

)

const [inline]

Comparison operator.

Definition at line 63 of file GB_AttributeRef.h.

GB_AttributeRef& GB_AttributeRef::operator=

(

const GB_AttributeRef &

src

)

Assignment operator.

bool GB_AttributeRef::operator==

(

const GB_AttributeRef &

src

)

const [inline]

Comparison operator.

Definition at line 60 of file GB_AttributeRef.h.

---

Friends And Related Function Documentation

friend class GB_AttributeData [friend]

Definition at line 101 of file GB_AttributeRef.h.

friend class GB_AttributeDict [friend]

Definition at line 103 of file GB_AttributeRef.h.

friend class GB_AttributeDictOffsetIterator [friend]

Definition at line 104 of file GB_AttributeRef.h.

friend class GB_AttributeElem [friend]

Definition at line 102 of file GB_AttributeRef.h.

friend class GB_AttributeTable [friend]

Definition at line 106 of file GB_AttributeRef.h.

friend class GB_ConstAttributeDictOffsetIterator [friend]

Definition at line 105 of file GB_AttributeRef.h.

friend class GEO_AttribDict [friend]

Definition at line 108 of file GB_AttributeRef.h.

friend class GEO_AttributeHandleList [friend]

Definition at line 109 of file GB_AttributeRef.h.

friend class GEO_PointAttribDict [friend]

Definition at line 110 of file GB_AttributeRef.h.

friend class GEO_PrimAttribDict [friend]

Definition at line 111 of file GB_AttributeRef.h.

friend class GEO_VertexAttribDict [friend]

Definition at line 112 of file GB_AttributeRef.h.

friend class GU_CurveCache [friend]

Definition at line 115 of file GB_AttributeRef.h.

friend class GU_PrimTriBezierCache [friend]

Definition at line 116 of file GB_AttributeRef.h.

friend class GU_TPSurfCache [friend]

Definition at line 117 of file GB_AttributeRef.h.

friend class POP_AttribMap [friend]

Definition at line 118 of file GB_AttributeRef.h.

---

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

• GB/GB_AttributeRef.h