CSLActionClipContainer Class Reference

This class represents an XSI_ActionClipContainer template. More...

#include <ActionClipContainer.h>

Inheritance diagram for CSLActionClipContainer:

CSLActionClip CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLActionClipContainer (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual SI_Error  Synchronize ()
CSLTemplate::ETemplateType  Type ()
SI_Error  RemoveTrack (SI_Int in_nIndex)
SI_Error  RemoveTrack (CSLTrack *io_pToRemove)
CSLTrack **  GetTrackList ()
SI_Int  GetTrackCount ()
CSLTrack *  AddTrack ()
SI_Error  ClearTracks ()
CSLTrack *  ConnectTrack (CSLTrack *in_pNewTrack)

Detailed Description

This class represents an XSI_ActionClipContainer template.

An action clip container is a specialisation of the action clip (CSLActionClip) (see the XSI_ActionClipContainer template reference). It's an action clip that can contain a list of tracks (CSLTrack). You can create an action clip with the CSLTrack::AddActionClip method.

See also:
CSLActionClip

CSLAction

CSLMixer

CSLTimeControl

CSLTrack

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the mixer
[in]  in_pModel  Pointer to the model containing the mixer
[in]  in_pTemplate  Pointer to the CdotXSITemplate containing the mixer

Member Function Documentation

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes internal data to be coherent with the IO layer

Returns:
success or failure

Reimplemented from CSLActionClip.

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

Returns the type of this template

Return values:
CSLTemplate::XSI_ACTIONCLIPCONTAINER  Template type

Reimplemented from CSLActionClip.

SI_Error RemoveTrack ( SI_Int  in_nIndex  ) 

Removes a track

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

SI_Error RemoveTrack ( CSLTrack *  io_pToRemove  ) 

Removes a track

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

CSLTrack** GetTrackList (  ) 

Returns the list of all tracks

Returns:
Pointer to the list of pointer of all tracks

SI_Int GetTrackCount (  ) 

Get the total number of tracks

Returns:
The number of tracks

CSLTrack* AddTrack (  ) 

Adds a new track

Returns:
Pointer to the newly added track

SI_Error ClearTracks (  ) 

Removes all Tracks

Returns:
Whether or not removal was successful

CSLTrack* ConnectTrack ( CSLTrack *  in_pNewTrack  ) 

Adds a preallocated Track to the Track list

Parameters:
[in]  in_pNewTrack  Pointer to the Track to add
Returns:
The newly added Track or null if it was already added

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