CSLTrack Class Reference

This class represents an XSI_Track template. More...

#include <Track.h>

Inheritance diagram for CSLTrack:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLTrack (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
SI_Error  Synchronize ()
CSLTemplate::ETemplateType  Type ()
SI_Bool  GetMute ()
SI_Void  SetMute (SI_Bool in_bNew)
SI_Bool  GetRipple ()
SI_Void  SetRipple (SI_Bool in_bNew)
SI_Bool  GetSolo ()
SI_Void  SetSolo (SI_Bool in_bNew)
SI_Error  RemoveActionClip (SI_Int in_nIndex)
SI_Error  RemoveActionClip (CSLActionClip *io_pToRemove)
CSLActionClip **  GetActionClipList ()
SI_Int  GetActionClipCount ()
CSLActionClip *  AddActionClip ()
CSLActionClipContainer *  AddActionClipContainer ()
SI_Error  ClearActionClips ()
CSLActionClip *  ConnectActionClip (CSLActionClip *in_pNewActionClip)

Detailed Description

This class represents an XSI_Track template.

Tracks are containers of action clips (CSLActionClip--see the XSI_Track template reference). They can be added to an animation mixer using the CSLMixer::AddTrack method.

Note:
CSLTrack is not supported by SI3D
See also:
CSLAction

CSLActionClip

CSLActionClipContainer

CSLMixer

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the CSLTrack
[in]  in_pModel  Pointer to the model containing the CSLTrack
[in]  in_pTemplate  Pointer to the CdotXSITemplate defining the CSLTrack data

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

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

Returns:
Error code

Reimplemented from CSLTemplate.

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

Returns the type of this template

Return values:
CSLTemplate::XSI_TRACK  The type of this template

Implements CSLTemplate.

SI_Bool GetMute (  ) 

Returns the value of the mute flag

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

SI_Void SetMute ( SI_Bool  in_bNew  ) 

Sets the value of the mute flag

Note:
When set to False, the track contributes to the animation.
Parameters:
[in]  in_bNew  New value

SI_Bool GetRipple (  ) 

Returns the value of the ripple flag

Note:
Adding new tracks will always ripple existing clips if necessary.
Return values:
true  A moved clip will push the next or previous clips along the track if necessary so that clips do not overlap on the same track.
false  Clips cannot be moved past the position of the next or previous clip.

SI_Void SetRipple ( SI_Bool  in_bNew  ) 

Sets the value of the ripple flag

Parameters:
[in]  in_bNew  New value
Note:
When set to True, moved clips will push the next or previous clips along the track if necessary so that clips do not overlap on the same track.
Note:
A False value can be used so clips cannot be moved past the position of the next or previous clip.

SI_Bool GetSolo (  ) 

Returns the value of the solo flag

Return values:
true  Only this track contributes to the animation.
false  Other tracks might contribute to the animation.

SI_Void SetSolo ( SI_Bool  in_bNew  ) 

Sets the value of the solo flag

Parameters:
[in]  in_bNew  New value for the flat
Note:
Set this flag to True if you want this track to be the sole contributor to the animation.

SI_Error RemoveActionClip ( SI_Int  in_nIndex  ) 

Removes an action clip

Parameters:
[in]  in_nIndex  Index of the action clip to remove
Return values:
SI_Error::SI_SUCCESS  The element was removed
SI_Error::SI_ERR_BAD_ARGUMENT  Invalid index

SI_Error RemoveActionClip ( CSLActionClip *  io_pToRemove  ) 

Removes an action clip

Parameters:
[in,out]  io_pToRemove  Pointer to the action clip to remove
Return values:
SI_Error::SI_SUCCESS  The element was removed
SI_Error::SI_ERR_BAD_ARGUMENT  The element could not be found

CSLActionClip** GetActionClipList (  ) 

Returns the list of all action clips

Returns:
Pointer to the list of pointer of all action clips

SI_Int GetActionClipCount (  ) 

Returns the total number of action clips

Returns:
The number of action clips

CSLActionClip* AddActionClip (  ) 

Adds a new ActionClip

Returns:
Pointer to the newly added action clip

CSLActionClipContainer* AddActionClipContainer (  ) 

Adds a new ActionClipContainer

Returns:
Pointer to the newly added action clip container

SI_Error ClearActionClips (  ) 

Removes all action clips

Returns:
SI_Error::SI_SUCCESS

CSLActionClip* ConnectActionClip ( CSLActionClip *  in_pNewActionClip  ) 

Adds a preallocated ActionClip to the action clip list

Parameters:
[in]  in_pNewActionClip  Pointer to the action clip to add
Returns:
The newly added action clip or null if it was already added

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