Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLShapeAnimation Class Reference

#include <ShapeAnimation.h>

Inheritance diagram for CSLShapeAnimation::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describes a mesh, surface or curve shape animation
See also:
CSLAction


Constructor & Destructor Documentation

CSLShapeAnimation::CSLShapeAnimation CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate,
EFCurveInterpolationType    in_Type
 

Constructor

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


Member Function Documentation

CSLBaseShape * CSLShapeAnimation::AddShape  
 

Add a new shape at the end of the animation.

Returns:
CSLBaseShape* Pointer to the newly created shape.

CSLFCurve * CSLShapeAnimation::Animation  
 

Return the fcurve containing the animation of the shape.

Returns:
CSLFCurve* Pointer to a fcurve object.

SI_Error CSLShapeAnimation::ClearShapes  
 

Remove all shapes from the shape animation.

Returns:
SI_SUCCESS

SI_Error CSLShapeAnimation::Fix   [virtual]
 

Clean invalid data from the template.

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

SI_Int CSLShapeAnimation::GetShapeCount  
 

Return the number of shapes in the animation.

Returns:
SI_Int Number of shapes.

CSLBaseShape * CSLShapeAnimation::InsertShape SI_Int    in_nIndex
 

Insert a new shape into the animation.

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

SI_Error CSLShapeAnimation::RemoveShape CSLBaseShape   in_pObject
 

Remove a single shape from the animation.

Parameters:
CSLBaseShape  * Pointer to the shape to remove.
Return values:
SI_SUCCESS  The animation was removed
SI_ERR_BAD_ARGUMENT  Shape was not found

SI_Error CSLShapeAnimation::RemoveShape SI_Int    in_nIndex
 

Remove a single shape from the animation.

Parameters:
SI_Int  Index of the shape to remove.
Return values:
SI_SUCCESS  The animation was removed
SI_ERR_BAD_ARGUMENT  Invalid index

CSLBaseShape ** CSLShapeAnimation::Shapes  
 

Return an array of all shapes in the animation.

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

SI_Error CSLShapeAnimation::Synchronize   [virtual]
 

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

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

virtual ETemplateType CSLShapeAnimation::Type   [inline, virtual]
 

Returns the type of this template

Return values:
CSLTemplate::SI_SHAPE_ANIMATION 

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.