Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Exporter::Service::IFrameCommandGenerator Class Referenceabstract

Defines an interface that generates frame commands for the defined frame range. More...

#include <IFrameCommandGenerator.h>

Inheritance diagram for Exporter::Service::IFrameCommandGenerator:

Public Member Functions

virtual FCM::Result _FCMCALL GenerateFrameCommands (DOM::PITimeline pTimeline, const RANGE &frameRange, const PIFCMDictionary pDictPublishSettings, PIResourcePalette pResourcePalette, PITimelineBuilderFactory pTimelineBuilderFactory, PITimelineBuilder &pTimelineBuilder)=0
 This function generates frame commands for the specified frame range. More...
 

Detailed Description

Defines an interface that generates frame commands for the defined frame range.

Member Function Documentation

virtual FCM::Result _FCMCALL Exporter::Service::IFrameCommandGenerator::GenerateFrameCommands ( DOM::PITimeline  pTimeline,
const RANGE frameRange,
const PIFCMDictionary  pDictPublishSettings,
PIResourcePalette  pResourcePalette,
PITimelineBuilderFactory  pTimelineBuilderFactory,
PITimelineBuilder &  pTimelineBuilder 
)
pure virtual

This function generates frame commands for the specified frame range.

Parameters
pTimeline(IN) Timeline object for which frame commands need to be generated.
frameRange(IN) Range of frames.
pDictPublishSettings(IN) Dictionary containing publish settings. Only setting key that is recognized by this service is Exporter::Service::kPublishSettingsKey_IncludeInvisibleLayer. If this key is not set or an invalid value is set, default value of "true" is used. All other settings in the dictionary are ignored.
pResourcePalette(IN) Resource palette object. Definition of resources are added to the resource palette.
pTimelineBuilderFactory(IN) Factory interface to build timeline for each symbol (movie-clip/graphic). This interface is invoked every time a symbol is encountered during DOM parsing.
pTimelineBuilder(OUT) Root(or main) timeline builder.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.

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