CSLXSIClusterInfo Class Reference

#include <XSIClusterInfo.h>

Inheritance diagram for CSLXSIClusterInfo:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EClusterType
  Defines the various types of clusters.

Public Member Functions
  CSLXSIClusterInfo (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, EClusterType in_DefaultEClusterType=SI_VERTEX)
  Constructor.
virtual  ~CSLXSIClusterInfo ()
  Destructor.
void  SetClusterType (EClusterType in_Type)
  Set the cluster type.
EClusterType  GetClusterType ()
  Get the cluster type.
virtual CSLTemplate::ETemplateType  Type ()
virtual SI_Error  Synchronize ()

Detailed Description

Base class to store the cluster type information for dotXSI 5.0+ (see the XSI_ClusterInfo template reference).

Constructor & Destructor Documentation

CSLXSIClusterInfo ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate,
EClusterType  in_DefaultEClusterType = SI_VERTEX  
)

Constructor.

Parameters:
in_pScene  Pointer to the scene
in_pModel  Pointer to the model
in_pTemplate  Pointer to the parent template
in_DefaultEClusterType  Cluster type to use

Member Function Documentation

void SetClusterType ( EClusterType  in_Type  )  [inline]

Set the cluster type.

Parameters:
in_Type  New cluster type

EClusterType GetClusterType (  ) 

Get the cluster type.

Returns:
Current cluster type

virtual CSLTemplate::ETemplateType Type (  )  [virtual]

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

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

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

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