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

#include <GU_AgentDefinition.h>

+ Inheritance diagram for GU_AgentDefinition:

Public Member Functions

 GU_AgentDefinition (const GU_AgentRigConstPtr &rig, const GU_AgentShapeLibConstPtr &shapelib)
 
 GU_AgentDefinition (const GU_AgentDefinition &src_defn, const GU_AgentShapeLibConstPtr &new_shapelib)
 
int64 getMemoryUsage (bool inclusive) const
 
const GU_AgentRigConstPtrrig () const
 
const GU_AgentShapeLibConstPtrshapeLibrary () const
 
void addLayer (const GU_AgentLayerConstPtr &layer)
 
const UT_Array
< GU_AgentLayerConstPtr > & 
layers () const
 Return the list of layers. More...
 
const GU_AgentLayerlayer (const UT_StringRef &name) const
 Get a pointer to a specfic layer. This may be a NULL pointer. More...
 
const GU_AgentLayerlayer (exint i) const
 Get a reference to the ith layer. More...
 
exint numLayers () const
 Return the layer count. More...
 
void addClip (const GU_AgentClipConstPtr &clip)
 
const UT_Array
< GU_AgentClipConstPtr > & 
clips () const
 Return the list of clips. More...
 
const GU_AgentClipclip (const UT_StringRef &name) const
 Get a pointer to a specfic clip. This may be a NULL pointer. More...
 
const GU_AgentClipclip (exint i) const
 Get a reference to the ith clip. More...
 
exint numClips () const
 Return the clip count. More...
 
void addTransformGroup (const GU_AgentTransformGroupConstPtr &group)
 
const UT_Array
< GU_AgentTransformGroupConstPtr > & 
transformGroups () const
 Return the list of groups. More...
 
const GU_AgentTransformGrouptransformGroup (const UT_StringRef &name) const
 Get a pointer to a specfic group. This may be a NULL pointer. More...
 
exint transformGroupIndex (const UT_StringRef &name) const
 Get the index of a transform group, or -1 if it does not exist. More...
 
const GU_AgentTransformGroupdefaultTransformGroup () const
 
const GU_AgentTransformGrouptransformGroup (exint i) const
 Get a reference to the ith group. More...
 
exint numTransformGroups () const
 Return the transform group count. More...
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< GU_AgentDefinition >
SYS_FORCE_INLINE UT_IntrusiveRefCounter ()
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &)
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &)
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const
 Return current counter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UT_IntrusiveRefCounter< GU_AgentDefinition >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Detailed Description

An agent definition contains a rig, a shape library, a set of available clips, a set of available layers, and a set of transform groups.

Examples:
SOP/SOP_BouncyAgent.C.

Definition at line 30 of file GU_AgentDefinition.h.

Constructor & Destructor Documentation

GU_AgentDefinition::GU_AgentDefinition ( const GU_AgentRigConstPtr rig,
const GU_AgentShapeLibConstPtr shapelib 
)
GU_AgentDefinition::GU_AgentDefinition ( const GU_AgentDefinition src_defn,
const GU_AgentShapeLibConstPtr new_shapelib 
)

Create a copy of the given agent definition, but referencing a new version of the shape library.

Member Function Documentation

void GU_AgentDefinition::addClip ( const GU_AgentClipConstPtr clip)

Add a clip to the agent definition. Replaces any pre-existing clip of the same name.

void GU_AgentDefinition::addLayer ( const GU_AgentLayerConstPtr layer)

Add a layer to the agent definition. Replaces any pre-existing layer of the same name.

void GU_AgentDefinition::addTransformGroup ( const GU_AgentTransformGroupConstPtr group)

Add a transform group to the agent definition. Replaces any pre-existing group of the same name.

const GU_AgentClip* GU_AgentDefinition::clip ( const UT_StringRef name) const

Get a pointer to a specfic clip. This may be a NULL pointer.

const GU_AgentClip& GU_AgentDefinition::clip ( exint  i) const
inline

Get a reference to the ith clip.

Definition at line 76 of file GU_AgentDefinition.h.

const UT_Array<GU_AgentClipConstPtr>& GU_AgentDefinition::clips ( ) const
inline

Return the list of clips.

Definition at line 69 of file GU_AgentDefinition.h.

const GU_AgentTransformGroup& GU_AgentDefinition::defaultTransformGroup ( ) const
inline

Get the default transform group, which contains all transforms in the rig.

Definition at line 98 of file GU_AgentDefinition.h.

int64 GU_AgentDefinition::getMemoryUsage ( bool  inclusive) const
const GU_AgentLayer* GU_AgentDefinition::layer ( const UT_StringRef name) const

Get a pointer to a specfic layer. This may be a NULL pointer.

const GU_AgentLayer& GU_AgentDefinition::layer ( exint  i) const
inline

Get a reference to the ith layer.

Definition at line 58 of file GU_AgentDefinition.h.

const UT_Array<GU_AgentLayerConstPtr>& GU_AgentDefinition::layers ( ) const
inline

Return the list of layers.

Definition at line 51 of file GU_AgentDefinition.h.

exint GU_AgentDefinition::numClips ( ) const
inline

Return the clip count.

Definition at line 80 of file GU_AgentDefinition.h.

exint GU_AgentDefinition::numLayers ( ) const
inline

Return the layer count.

Definition at line 62 of file GU_AgentDefinition.h.

exint GU_AgentDefinition::numTransformGroups ( ) const
inline

Return the transform group count.

Definition at line 106 of file GU_AgentDefinition.h.

const GU_AgentRigConstPtr& GU_AgentDefinition::rig ( ) const
inline

Definition at line 43 of file GU_AgentDefinition.h.

const GU_AgentShapeLibConstPtr& GU_AgentDefinition::shapeLibrary ( ) const
inline

Definition at line 44 of file GU_AgentDefinition.h.

const GU_AgentTransformGroup* GU_AgentDefinition::transformGroup ( const UT_StringRef name) const

Get a pointer to a specfic group. This may be a NULL pointer.

const GU_AgentTransformGroup& GU_AgentDefinition::transformGroup ( exint  i) const
inline

Get a reference to the ith group.

Definition at line 102 of file GU_AgentDefinition.h.

exint GU_AgentDefinition::transformGroupIndex ( const UT_StringRef name) const

Get the index of a transform group, or -1 if it does not exist.

const UT_Array<GU_AgentTransformGroupConstPtr>& GU_AgentDefinition::transformGroups ( ) const
inline

Return the list of groups.

Definition at line 87 of file GU_AgentDefinition.h.


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