Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
DOM::ITimeline Class Referenceabstract

Defines the interface that represents the timeline. More...

#include <ITimeline.h>

Inheritance diagram for DOM::ITimeline:

Public Member Functions

virtual FCM::Result _FCMCALL GetName (FCM::StringRep16 *ppName)=0
 This function returns the name of the current timeline. For main timeline, it returns the name of the scene and for movie-clips the name of the movie-clip is returned. More...
 
virtual FCM::Result _FCMCALL GetLayers (FCM::PIFCMList &pLayerList)=0
 This function returns a list of layers (ILayer) for the timeline. More...
 
virtual FCM::Result _FCMCALL GetMaxFrameCount (FCM::U_Int32 &frameCount)=0
 This function returns number of frames in the timelines longest layer. More...
 

Detailed Description

Defines the interface that represents the timeline.

Member Function Documentation

virtual FCM::Result _FCMCALL DOM::ITimeline::GetLayers ( FCM::PIFCMList &  pLayerList)
pure virtual

This function returns a list of layers (ILayer) for the timeline.

Parameters
pLayerList(OUT) List of layers. The objects in the layer lists can be queried for ILayer along with one of the following interfaces: ILayerFolder, ILayerNormal, ILayerMask and ILayerGuide.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
See also
DOM::ILayer
DOM::Layer::ILayerFolder
DOM::Layer::ILayerNormal
DOM::Layer::ILayerMask
DOM::Layer::ILayerGuide
virtual FCM::Result _FCMCALL DOM::ITimeline::GetMaxFrameCount ( FCM::U_Int32 &  frameCount)
pure virtual

This function returns number of frames in the timelines longest layer.

Parameters
frameCount(OUT) Number of frames in the timelines longest layer
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL DOM::ITimeline::GetName ( FCM::StringRep16 *  ppName)
pure virtual

This function returns the name of the current timeline. For main timeline, it returns the name of the scene and for movie-clips the name of the movie-clip is returned.

Parameters
ppName(OUT) Name of the current timeline.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned and "ppName" is set to NULL.
Note
The memory allocated for 'ppName' in this function must be freed by the caller using IFCMCalloc::Free().
The documentation for this class was generated from the following file: