Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLTrack Class Reference

#include <Track.h>

Inheritance diagram for CSLTrack::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Track are containers of action clips (CSLActionClip). They can be added to an animation mixer using the CSLMixer::AddTrack method.

Note:
CSLTrack is not supported by SI3D
See also:
CSLAction , CSLActionClip , CSLMixer


Constructor & Destructor Documentation

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

Constructor

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


Member Function Documentation

CSLActionClip * CSLTrack::AddActionClip  
 

Adds a new ActionClip

Returns:
CSLActionClip Pointer to the newly added action clip

SI_Error CSLTrack::ClearActionClips  
 

Removes all action clips

Returns:
SI_SUCCESS

CSLActionClip * CSLTrack::ConnectActionClip CSLActionClip   in_pNewActionClip
 

Adds a preallocated ActionClip to the action clip list

Parameters:
CSLActionClip  Pointer to the action clip to add
Returns:
CSLActionClip The newly added action clip or null if it was already added

SI_Int CSLTrack::GetActionClipCount  
 

Get the total number of action clips

Returns:
SI_Int The number of action clips

CSLActionClip ** CSLTrack::GetActionClipList  
 

Gets the list of all action clips

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

SI_Bool CSLTrack::GetMute  
 

Gets 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_Bool CSLTrack::GetRipple  
 

Gets the value of the ripple flag

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.
Note:
Adding new tracks will always ripple existing clips if necessary.

SI_Bool CSLTrack::GetSolo  
 

Gets 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_Error CSLTrack::RemoveActionClip CSLActionClip   io_pToRemove
 

Removes an action clip

Parameters:
in_pToRemove  Pointer to the action clip to remove
Return values:
SI_SUCCESS  The element was removed
SI_ERR_BAD_ARGUMENT  The element could not be found

SI_Error CSLTrack::RemoveActionClip SI_Int    in_nIndex
 

Removes an action clip

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

SI_Void CSLTrack::SetMute SI_Bool    in_bNew
 

Sets the value of the mute flag

Returns:
in_bNew New value
Note:
When set to False, the track contributes to the animation.

SI_Void CSLTrack::SetRipple SI_Bool    in_bNew
 

Sets the value of the ripple flag

Parameters:
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.
A False value can be used so clips cannot be moved past the position of the next or previous clip.

SI_Void CSLTrack::SetSolo SI_Bool    in_bNew
 

Sets the value of the solo flag

Parameters:
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 CSLTrack::Synchronize   [virtual]
 

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

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

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

Returns the type of this template

Returns:
CSLTemplate::ETemplateType The type of this template: XSI_TRACK

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.