CSLXSIGeometry Class Reference

This class represents an XSI_Geometry template. More...

#include <XSIGeometry.h>

Inheritance diagram for CSLXSIGeometry:

CSLPrimitive CSLTemplate CSIBCNode CSLXSIMesh CSLCOLLADAMesh List of all members.

Public Member Functions
  CSLXSIGeometry (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSIGeometry ()
virtual CSLXSIShapeAnimation *  CreateXSIShapeAnimation (EFCurveInterpolationType in_Type)
virtual CSLXSIShapeAnimation *  XSIShapeAnimation ()
virtual SI_Error  DestroyXSIShapeAnimation ()
virtual CSLXSIShapeAnimation *  ConnectXSIShapeAnimation (CSLXSIShapeAnimation *in_pNewXSIShapeAnim)
virtual SI_Error  Synchronize ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)

Detailed Description

This class represents an XSI_Geometry template.

Base class to handle geometry data for dotXSI 5.0+ (see the XSI_Geometry template reference).

Constructor & Destructor Documentation

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

Constructor

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

virtual ~CSLXSIGeometry (  )  [virtual]

Destructor

Member Function Documentation

virtual CSLXSIShapeAnimation* CreateXSIShapeAnimation ( EFCurveInterpolationType  in_Type  )  [virtual]

Creates a new shape animation for the geometry.

Parameters:
[in]  in_Type  Type of interpolation for the new shape animation.
Returns:
Pointer to the newly created shape animation.

Reimplemented in CSLCOLLADAMesh.

virtual CSLXSIShapeAnimation* XSIShapeAnimation (  )  [virtual]

Returns the shape animation of the geometry.

Returns:
Pointer to the shape animation.

virtual SI_Error DestroyXSIShapeAnimation (  )  [virtual]

Destroys an existing shape animation on the geometry.

Returns:
Error code.

virtual CSLXSIShapeAnimation* ConnectXSIShapeAnimation ( CSLXSIShapeAnimation *  in_pNewXSIShapeAnim  )  [virtual]

Connects a shape animation

Parameters:
[in]  in_pNewXSIShapeAnim  the shape animation to connect
Returns:
The connected shape animation

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this geometry instance with its IO layer representation

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

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADAMesh, and CSLXSIMesh.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns a handle on one of this geometry's parameters by using its name

Parameters:
[in]  in_szName  the name of the parameter to get the handle from
Returns:
the handle to the parameter

Reimplemented from CSLTemplate.

Reimplemented in CSLXSIMesh.

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