CSLXSIClusterInfo Class Reference

This class represents an XSI_ClusterInfo template. More...

#include <XSIClusterInfo.h>

Inheritance diagram for CSLXSIClusterInfo:

CSLTemplate CSIBCNode List of all members.

Public Types

enum   EClusterType {
  SI_POLYGON,
  SI_FACE,
  SI_SURFACE_CURVE,
  SI_KNOT_CURVE_U,
  SI_KNOT_CURVE_V,
  SI_BOUNDARY,
  SI_VERTEX,
  SI_EDGE,
  SI_POLYGON_NODE,
  SI_SAMPLED_POINT,
  SI_KNOT,
  SI_TRIM_CURVE,
  SI_ISO_LINE_U,
  SI_ISO_LINE_V,
  SI_ISO_POINT,
  SI_ISO_LINE,
  SI_SUB_SURFACE,
  SI_SUB_CURVE
}
  Defines the various types of clusters. More...

Public Member Functions

  CSLXSIClusterInfo (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, EClusterType in_DefaultEClusterType=SI_VERTEX)
virtual  ~CSLXSIClusterInfo ()
  Destructor.
void  SetClusterType (EClusterType in_Type)
EClusterType  GetClusterType ()
virtual CSLTemplate::ETemplateType  Type ()
virtual SI_Error  Synchronize ()

Detailed Description

This class represents an XSI_ClusterInfo template.

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


Member Enumeration Documentation

enum EClusterType

Defines the various types of clusters.

Enumerator:
SI_POLYGON  Polygon type
SI_FACE  Face type
SI_SURFACE_CURVE  Surface Curve type
SI_KNOT_CURVE_U  Knot Curve U type
SI_KNOT_CURVE_V  Knot Curve V type
SI_BOUNDARY  Boundary type
SI_VERTEX  Vertex type
SI_EDGE  Edge type
SI_POLYGON_NODE  Polygon Node type
SI_SAMPLED_POINT  Sampled Point type
SI_KNOT  Knot type
SI_TRIM_CURVE  Trim curVE type
SI_ISO_LINE_U  ISO Line U type
SI_ISO_LINE_V  ISO Line V type
SI_ISO_POINT  ISO Point type
SI_ISO_LINE  ISO Line type
SI_SUB_SURFACE  SUB Surface type
SI_SUB_CURVE  SUB Curve type


Constructor & Destructor Documentation

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

Constructor

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


Member Function Documentation

void SetClusterType ( EClusterType  in_Type  )  [inline]

Sets the cluster type

Parameters:
[in]  in_Type  New cluster type

EClusterType GetClusterType (  ) 

Returns the cluster type

Returns:
Current cluster type

virtual CSLTemplate::ETemplateType Type (  )  [virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_CLUSTER_INFO  Template type

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes to ensure that the animated parameter is up to date.

Returns:
Error code

Reimplemented from CSLTemplate.


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