CSLShapeAnimation Class Reference

This class represents an SI_ShapeAnimation template. More...

#include <ShapeAnimation.h>

Inheritance diagram for CSLShapeAnimation:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLShapeAnimation (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, EFCurveInterpolationType in_Type)
CSLBaseShape *  AddShape ()
CSLBaseShape *  InsertShape (SI_Int in_nIndex)
SI_Int  GetShapeCount ()
CSLBaseShape **  Shapes ()
SI_Error  RemoveShape (SI_Int in_nIndex)
SI_Error  RemoveShape (CSLBaseShape *in_pObject)
SI_Error  ClearShapes ()
CSLFCurve *  Animation ()
virtual SI_Error  Fix ()
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

This class represents an SI_ShapeAnimation template.

Describes a mesh, surface or curve shape animation (see the SI_ShapeAnimation template reference).

See also:
CSLAction

Constructor & Destructor Documentation

CSLShapeAnimation ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate,
EFCurveInterpolationType  in_Type  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  referred template
[in]  in_Type  Default interpolation type

Member Function Documentation

CSLBaseShape* AddShape (  ) 

Adds a new shape at the end of the animation.

Returns:
Pointer to the newly created shape.

CSLBaseShape* InsertShape ( SI_Int  in_nIndex  ) 

Inserts a new shape into the animation.

Note:
Animation is inserted at the end of the list if the index is out of bounds
Parameters:
[in]  in_nIndex  Index of insertion of the new shape.
Returns:
Pointer to the newly created shape.

SI_Int GetShapeCount (  ) 

Returns the number of shapes in the animation.

Returns:
Number of shapes.

CSLBaseShape** Shapes (  ) 

Returns an array of all shapes in the animation.

Returns:
Pointer to the array of pointers to shape objects.

SI_Error RemoveShape ( SI_Int  in_nIndex  ) 

Removes a single shape from the animation.

Parameters:
[in]  in_nIndex  Index of the shape to remove.
Return values:
SI_Error::SI_SUCCESS  The animation was removed
SI_Error::SI_ERR_BAD_ARGUMENT  Invalid index

SI_Error RemoveShape ( CSLBaseShape *  in_pObject  ) 

Removes a single shape from the animation.

Parameters:
[in]  in_pObject  Pointer to the shape to remove.
Return values:
SI_Error::SI_SUCCESS  The animation was removed
SI_Error::SI_ERR_BAD_ARGUMENT  Shape was not found

SI_Error ClearShapes (  ) 

Removes all shapes from the shape animation.

Return values:
SI_Error::SI_SUCCESS 

CSLFCurve* Animation (  ) 

Returns the fcurve containing the animation of the shape.

Returns:
Pointer to a fcurve object.

virtual SI_Error Fix (  )  [virtual]

Cleans invalid data from the template.

Returns:
Error code

Reimplemented from CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

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

Returns:
Error code

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_SHAPE_ANIMATION  Template type

Implements CSLTemplate.

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