CSLXSIShapeReference Class Reference

#include <XSIShapeReference.h>

Inheritance diagram for CSLXSIShapeReference:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLXSIShapeReference (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSIShapeReference ()
SI_Error  Synchronize ()
CSLTemplate::ETemplateType  Type ()
CSLXSIShape *  GetReference ()
SI_Void  SetReference (CSLXSIShape *in_ReferenceShape)
SI_Char *  GetReferenceXSIPath ()
SI_Void  SetReferenceXSIPath (SI_Char *in_szPath)
CSLStringProxy *  GetReferencePathProxy ()

Detailed Description

An shape reference is a pointer to an existing shape defined else where in the file. This is used in shape key actions (CSLAction) so that the associated shape key (CSLXSIShape) can be identified.

See also:
CSLAction

CSLMixer

CSLTimeControl

CSLTrack

CSLXSIShape

CSLXSIShape

CSLXSIShapeAnimation

Constructor & Destructor Documentation

CSLXSIShapeReference ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
in_pScene  Pointer to the scene containing the ActionClip
in_pModel  Pointer to the model containing the ActionClip
in_pTemplate  Pointer to the CdotXSITemplate defining the ActionClip

virtual ~CSLXSIShapeReference (  )  [virtual]

Destructor

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

Synchronize will ensure that the animated parameter is up to date.

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType Type (  )  [inline, virtual]

Gets the type of this template

Returns:
CSLTemplate::XSI_SHAPEREFERENCE

Implements CSLTemplate.

CSLXSIShape* GetReference (  ) 

Gets the referenced shape

Return values:
Pointer  to the referenced shape
NULL  The referenced shape corresponding to the current XSI path was not found in the file.

SI_Void SetReference ( CSLXSIShape *  in_ReferenceShape  ) 

Sets the referenced shape. Note, the XSI Path is not set automatically, you also need to use SetReferenceXSIPath.

Parameters:
in_ReferenceShape  The the referenced shape

SI_Char* GetReferenceXSIPath (  ) 

Gets the XSI path of the referenced shape

Returns:
SI_Char The XSI Path of the referenced shape

SI_Void SetReferenceXSIPath ( SI_Char *  in_szPath  ) 

Sets the XSI path of the referenced shape

Parameters:
in_szPath  The XSI Path of the referenced shape

CSLStringProxy* GetReferencePathProxy (  )  [inline]

Gets the referenced shape XSI path proxy

Returns:
CSLStringProxy* Pointer to the referenced shape XSI path proxy

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