Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLAction Class Reference

#include <Action.h>

Inheritance diagram for CSLAction::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Actions, also known as action sources, are reusable animation segments. They can be created with the CSLMixer::AddAction method and instanciated in the mixer's tracks (CSLTrack) as action clips (CSLActionClip).

Note:
Actions are not supported by SI3D
See also:
CSLActionClip , CSLActionFCurve , CSLMixer , CSLShapeAnimation , CSLStaticValue


Member Enumeration Documentation

enum CSLAction::EActionType
 

Enumeration of all possible action types.

Enumeration values:
SI_AT_FCURVE  Fcurve action source item
SI_AT_STATICVALUE  Static value source
SI_AT_EXPRESSION  Expression source
SI_AT_CLUSTERKEY  Cluster key source
SI_AT_CONSTRAINT  Constraint source
SI_AT_COMPOUND  Compound Action item source.
SI_AT_SHAPECOMPOUND  Shape compound Action item source.
SI_AT_NONE  No flagged source


Constructor & Destructor Documentation

CSLAction::CSLAction CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Pointer to the scene containing the CSLAction
in_pModel  Pointer to the model containing the CSLAction
in_pTemplate  Pointer to the CdotXSITemplate defining the CSLAction data

CSLAction::~CSLAction   [virtual]
 

Destructor


Member Function Documentation

CSLActionFCurve * CSLAction::AddAnimation EFCurveInterpolationType    in_InterpolationType
 

Adds a new animation

Parameters:
in_InterpolationType  FCurve interpolation type
Returns:
Pointer to the newly added Animation

CSLActionFCurve * CSLAction::AddAnimation  
 

Adds a new animation with default interpolation ( constant interpolation )

Returns:
Pointer to the newly added Animation

CSLShapeAnimation * CSLAction::AddShapeAnimation EFCurveInterpolationType    in_Type
 

Adds a new shape animation

Parameters:
in_Type  Interpolation type to use
Returns:
Pointer to the newly added shape animation

CSLStaticValue * CSLAction::AddStaticValue  
 

Adds a new static value

Returns:
Pointer to the newly added static value

SI_Error CSLAction::ClearAnimations  
 

Removes all animations

Return values:
SI_SUCCESS 

SI_Error CSLAction::ClearShapeAnimations  
 

Removes all shape animations

Return values:
SI_SUCCESS 

SI_Error CSLAction::ClearStaticValues  
 

Removes all static values

Return values:
SI_SUCCESS 

CSLActionFCurve * CSLAction::ConnectAnimation CSLActionFCurve   in_pNewAnimation
 

Adds a preallocated animation to the animation list

Parameters:
CSLActionFCurve  Pointer to the animation to add
Returns:
The newly added Animation or null if it was already added

CSLShapeAnimation * CSLAction::ConnectShapeAnimation CSLShapeAnimation   in_pNewShapeAnimation
 

Adds a preallocated shape animation to the shape animation list

Parameters:
CSLShapeAnimation  Pointer to the shape animation to add
Returns:
The newly added shape animation or null if it was already added

CSLStaticValue * CSLAction::ConnectStaticValue CSLStaticValue   in_pNewStaticValue
 

Adds a preallocated static value to the static value list

Parameters:
CSLStaticValue  Pointer to the static value to add
Returns:
The newly added static value or null if it was already added

CSLAction::EActionType CSLAction::GetActionType  
 

Gets the action type

Returns:
The action type

SI_Int CSLAction::GetAnimationCount  
 

Get the total number of Animations

Returns:
The number of Animations

CSLActionFCurve ** CSLAction::GetAnimationList  
 

Gets the list of all animations

Returns:
Pointer to the list of pointer of all animations

SI_Float CSLAction::GetEndTime  
 

Gets the end time

Returns:
The end time

SI_Int CSLAction::GetShapeAnimationCount  
 

Get the total number of shape animations

Returns:
The number of shape animations

CSLShapeAnimation ** CSLAction::GetShapeAnimationList  
 

Gets the list of all shape animations

Returns:
Pointer to the list of pointer of all shape animations

SI_Float CSLAction::GetStartTime  
 

Gets the start time of the action

Returns:
The start time

SI_Int CSLAction::GetStaticValueCount  
 

Get the total number of static values

Returns:
The number of static values

CSLStaticValue ** CSLAction::GetStaticValueList  
 

Gets the list of all static values

Returns:
Pointer to the list of pointer of all static values

SI_Error CSLAction::RemoveAnimation CSLActionFCurve   io_pToRemove
 

Removes an animation

Parameters:
in_pToRemove  Pointer to the animation to remove
Return values:
SI_SUCCESS  The animation was removed
SI_ERR_BAD_ARGUMENT  Animation was not found

SI_Error CSLAction::RemoveAnimation SI_Int    in_nIndex
 

Removes an animation

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

SI_Error CSLAction::RemoveShapeAnimation CSLShapeAnimation   io_pToRemove
 

Removes a shape animation

Parameters:
in_pToRemove  Pointer to the shape animation to remove
Return values:
SI_SUCCESS  The shape animation was removed
SI_ERR_BAD_ARGUMENT  Could not find the shape animation

SI_Error CSLAction::RemoveShapeAnimation SI_Int    in_nIndex
 

Removes a shape animation

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

SI_Error CSLAction::RemoveStaticValue CSLStaticValue   io_pToRemove
 

Removes a static value

Parameters:
in_pToRemove  Pointer to the static value to remove
Return values:
SI_SUCCESS  The static value was removed
SI_ERR_BAD_ARGUMENT  static value was not found

SI_Error CSLAction::RemoveStaticValue SI_Int    in_nIndex
 

Removes a static value

Parameters:
in_nIndex  Index of the static value to remove
Return values:
SI_SUCCESS  The static value was removed
SI_ERR_BAD_ARGUMENT  Invalid index

SI_Void CSLAction::SetActionType CSLAction::EActionType    in_Type
 

Sets the action type

Parameters:
in_Type  The action type

SI_Void CSLAction::SetEndTime SI_Float    in_fTime
 

Sets the end time of the action

Parameters:
in_fTime  The end time

SI_Void CSLAction::SetStartTime SI_Float    in_fTime
 

Sets the start time of the action

Parameters:
in_fTime  The new start time

SI_Error CSLAction::Synchronize   [virtual]
 

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

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLAction::Type   [inline, virtual]
 

Returns the type of this template

Returns:
CSLTemplate::XSI_ACTION

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.