CSLActionClip Class Reference

#include <ActionClip.h>

Inheritance diagram for CSLActionClip:

CSLTemplate CSIBCNode CSLActionClipContainer List of all members.

Public Member Functions
  CSLActionClip (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLActionClip ()
SI_Error  Synchronize ()
CSLTemplate::ETemplateType  Type ()
SI_Bool  GetActive ()
SI_Void  SetActive (SI_Bool in_bNew)
SI_Float  GetDuration ()
SI_Void  SetDuration (SI_Float in_fNew)
SI_Bool  GetFillAction ()
SI_Void  SetFillAction (SI_Bool in_bNew)
SI_Int  GetFillPriority ()
SI_Void  SetFillPriority (SI_Int in_nNew)
SI_Float  GetStartTime ()
SI_Void  SetStartTime (SI_Float in_fNew)
SI_Float  GetWeight ()
SI_Void  SetWeight (SI_Float in_fNew)
CSLAction *  GetReference ()
SI_Void  SetReference (CSLAction *in_pAction)
CSLTimeControl *  AddTimeControl ()
CSLTimeControl *  ConnectTimeControl (CSLTimeControl *in_pTimeControl)
SI_Error  RemoveTimeControl (SI_Int in_nIndex)
SI_Error  RemoveTimeControl (CSLTimeControl *in_pTimeControl)
CSLTimeControl **  GetTimeControlList ()
SI_Int  GetTimeControlCount ()
SI_Error  ClearTimeControls ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)

Detailed Description

An action clip is an instance of an action source (CSLAction) that can be used in an animation mixer (CSLMixer) track (CSLTrack). You can create an action clip with the CSLTrack::AddActionClip method.

Note:
CSLActionClip is not supported by SI3D.
See also:
CSLAction

CSLMixer

CSLTimeControl

CSLTrack

Constructor & Destructor Documentation

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

Constructor

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

virtual ~CSLActionClip (  )  [virtual]

Destructor

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

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

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

Reimplemented in CSLActionClipContainer.

CSLTemplate::ETemplateType Type (  )  [inline, virtual]

Gets the type of this template

Returns:
CSLTemplate::XSI_ACTIONCLIP

Implements CSLTemplate.

Reimplemented in CSLActionClipContainer.

SI_Bool GetActive (  ) 

Gets the active flag that determines whether the clip contributes to the animation or not.

Return values:
true  The clip contributes to the animation
false  The clip does not contribute to the animation

SI_Void SetActive ( SI_Bool  in_bNew  ) 

Sets whether the clip contributes to the animation or not

Parameters:
in_bew  true to contribute, false otherwise

SI_Float GetDuration (  ) 

Gets the length of the clip

Returns:
SI_Float Duration

SI_Void SetDuration ( SI_Float  in_fNew  ) 

Sets the the length of the clip

Parameters:
in_fNew  New Duration

SI_Bool GetFillAction (  ) 

Gets the fill action flag

Return values:
true  The clip is a fill action
false  The clip is not a fill action
Note:
Fill actions determine parameter values only when there is no non-fill action driving particular parameters. They can be used to set parameters to reference values between action clips. Fill actions are not mixed with other clips.

SI_Void SetFillAction ( SI_Bool  in_bNew  ) 

Sets the fill action flag

Parameters:
in_bew  True to enable fill action, false otherwise
Note:
Fill actions determine parameter values only when there is no non-fill action driving particular parameters. They can be used to set parameters to reference values between action clips. Fill actions are not mixed with other clips.

SI_Int GetFillPriority (  ) 

Gets the priority of the fill action

Returns:
SI_Int Fill priority value
Note:
If two fill actions drive the same parameter at a given frame, the one with the higher priority is used.

SI_Void SetFillPriority ( SI_Int  in_nNew  ) 

Sets the priority of the fill action

Parameters:
in_nNew  New fill priority value
Note:
If two fill actions drive the same parameter at a given frame, the one with the higher priority is used.

SI_Float GetStartTime (  ) 

Gets the start time of the clip

Returns:
SI_Float Start time

SI_Void SetStartTime ( SI_Float  in_fNew  ) 

Sets the start time of the clip

Parameters:
in_fNew  New start time

SI_Float GetWeight (  ) 

Gets the relative weight of the action clip when it is mixed with other clips that affect the same parameters or clusters at the same frames.

Returns:
SI_Float Weight

SI_Void SetWeight ( SI_Float  in_fNew  ) 

Sets the relative weight of the action clip when it is mixed with other clips that affect the same parameters or clusters at the same frames.

Returns:
in_fNew New weight

CSLAction* GetReference (  ) 

Gets the action source

Return values:
Pointer  to the action source
NULL  No action source was set, this should never happen unless it was ovverriden by mistake by CSLActionClip::SetReference.

SI_Void SetReference ( CSLAction *  in_pAction  ) 

Sets the action source

Parameters:
in_pAction  Pointer to the new Referred action
Note:
The internal action source pointer will be replaced by the one provided. This is perfectly normal because there can/will be other CSLActionClips instanciating it.

CSLTimeControl* AddTimeControl (  ) 

Add a new time control

Returns:
CSLTimeControl Pointer to the newly allocated time control

CSLTimeControl* ConnectTimeControl ( CSLTimeControl *  in_pTimeControl  ) 

Add a previously allocated time control

Parameters:
in_pTimeControl  Pointer to the time control to add
Returns:
CSLTimeControl Pointer to added time control or null if already present

SI_Error RemoveTimeControl ( SI_Int  in_nIndex  ) 

Removes a specific time control

Parameters:
SI_Index  Index of the control to remove
Return values:
SI_SUCCESS  The element was removed
SI_ERR_BAD_ARGUMENT  Invalid index

SI_Error RemoveTimeControl ( CSLTimeControl *  in_pTimeControl  ) 

Removes a specific time control

Parameters:
in_pTimeControl  Pointer of the control to remove
Return values:
SI_SUCCESS  The element was removed
SI_ERR_BAD_ARGUMENT  Could not find the element to remove

CSLTimeControl** GetTimeControlList (  ) 

Gets the list of all time controls

Returns:
CSLTimeControl Pointer to the list of time control pointers

SI_Int GetTimeControlCount (  ) 

Gets the time control count

Returns:
SI_Int Number of time control in the list

SI_Error ClearTimeControls (  ) 

Frees all time controls

Return values:
SI_SUCCESS 

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

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szParameterName  
) [virtual]

Return a proxy to the specified parameter.

Parameters:
in_Type  Type of parameter
in_szParameterName  Name of the parameter if the type is SI_PARAMETER
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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