CSLInstance Class Reference

This class represents an SI_Instance template. More...

#include <Instance.h>

Inheritance diagram for CSLInstance:

CSLPrimitive CSLTemplate CSIBCNode CSLCOLLADAInstance List of all members.

Public Member Functions
  CSLInstance (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLInstance ()
CSLModel *  GetReference ()
SI_Void  SetReference (CSLModel *in_pModel)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

This class represents an SI_Instance template.

Describes an instance primitive (see the SI_Instance template reference).

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the instance
[in]  in_pModel  Pointer to the model containing the instance
[in]  in_pTemplate  Pointer to the CdotXSITemplate containing the instance
Returns:
an instance of CSLInstance

virtual ~CSLInstance (  )  [virtual]

Destructor

Member Function Documentation

CSLModel* GetReference (  ) 

Returns the reference model of the instance.

Returns:
Pointer to the reference model.

SI_Void SetReference ( CSLModel *  in_pModel  ) 

Changes the reference model object of the instance.

Parameters:
[in]  in_pModel  New reference model object.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this instance with its IO layer representation

Return values:
SI_Error::SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADAInstance.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the template type of the instance

Return values:
CSLTemplate::SI_INSTANCE  the template type

Implements CSLTemplate.

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