This interface represents a builder for a timeline. Timeline builder contains methods that are invoked by FrameCommandGenerator service (implemented in 'Adobe Animate CC') to add frame commands for a timeline. More...

#include <ITimelineBuilder.h>

Inheritance diagram for Exporter::Service::ITimelineBuilder:

Public Member Functions
virtual FCM::Result _FCMCALL	AddShape (FCM::U_Int32 objectId, SHAPE_INFO *pShapeInfo)=0
	This function is invoked to add a shape to the timeline. More...

virtual FCM::Result _FCMCALL	AddClassicText (FCM::U_Int32 objectId, CLASSIC_TEXT_INFO *pClassicTextInfo)=0
	This function is invoked to add a text element to the timeline. More...

virtual FCM::Result _FCMCALL	AddBitmap (FCM::U_Int32 objectId, BITMAP_INFO *pBitmapInfo)=0
	This function is invoked to add a bitmap element to the timeline. More...

virtual FCM::Result _FCMCALL	AddMovieClip (FCM::U_Int32 objectId, MOVIE_CLIP_INFO *pMovieClipInfo, DOM::FrameElement::PIMovieClip pMovieClip)=0
	This function is invoked to add a movie-clip element to the timeline. More...

virtual FCM::Result _FCMCALL	AddGraphic (FCM::U_Int32 objectId, GRAPHIC_INFO *pGraphicInfo)=0
	This function is invoked to add a graphic element to the timeline. More...

virtual FCM::Result _FCMCALL	AddSound (FCM::U_Int32 objectId, SOUND_INFO *pSoundInfo, DOM::FrameElement::PISound pSound)=0
	This function is invoked to add a sound element to the timeline. More...

virtual FCM::Result _FCMCALL	UpdateZOrder (FCM::U_Int32 objectId, FCM::U_Int32 placeAfterObjectId)=0
	This function is invoked when depth of object changes in any frame as we traverse the frames in the timeline. More...

virtual FCM::Result _FCMCALL	Remove (FCM::U_Int32 objectId)=0
	This function is invoked when the object is removed from a frame. More...

virtual FCM::Result _FCMCALL	UpdateBlendMode (FCM::U_Int32 objectId, DOM::FrameElement::BlendMode blendMode)=0
	This function is invoked when the blend mode of the object changes in any frame. More...

virtual FCM::Result _FCMCALL	UpdateVisibility (FCM::U_Int32 objectId, FCM::Boolean visible)=0
	This function is invoked when visibility of the object changes in any frame. More...

virtual FCM::Result _FCMCALL	UpdateGraphicFilter (FCM::U_Int32 objectId, PIFCMList pFilterable)=0
	This function is invoked when the filter is applied or already applied filter for the object changes in any frame. More...

virtual FCM::Result _FCMCALL	UpdateDisplayTransform (FCM::U_Int32 objectId, const DOM::Utils::MATRIX2D &matrix)=0
	This function is invoked when transform matrix of the object changes in any frame. More...

virtual FCM::Result _FCMCALL	UpdateColorTransform (FCM::U_Int32 objectId, const DOM::Utils::COLOR_MATRIX &colorMatrix)=0
	This function is invoked when color transform matrix of the object changes in any frame. More...

virtual FCM::Result _FCMCALL	ShowFrame ()=0
	This function is invoked for every frame when all the associated frame commands for the frame are executed. This "ShowFrame" command indicates that a frame is complete and can now be rendered during playback. More...

virtual FCM::Result _FCMCALL	AddFrameScript (FCM::CStringRep16 pScript, FCM::U_Int32 layerNum)=0
	This function is invoked for a frame that has frame script associated with it. This function can be called multiple times between two consecutive calls to ShowFrame(). Number of times this function is called depends on the number of layers that has frame scripts. More...

virtual FCM::Result _FCMCALL	RemoveFrameScript (FCM::U_Int32 layerNum)=0
	This function is invoked to remove frame script associated with a frame. More...

virtual FCM::Result _FCMCALL	SetFrameLabel (FCM::StringRep16 pLabel, DOM::KeyFrameLabelType labelType)=0
	This function is invoked for a frame that has frame label associated with it. This function can be called multiple times between two consecutive calls to ShowFrame(). More...

Detailed Description

This interface represents a builder for a timeline. Timeline builder contains methods that are invoked by FrameCommandGenerator service (implemented in 'Adobe Animate CC') to add frame commands for a timeline.

Member Function Documentation

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddBitmap	(	FCM::U_Int32	objectId,
		BITMAP_INFO *	pBitmapInfo
	)

pure virtual

This function is invoked to add a bitmap element to the timeline.

Parameters

objectId	(IN) Object Identifier of the bitmap.
pBitmapInfo	(IN) Bitmap placement information.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddClassicText	(	FCM::U_Int32	objectId,
		CLASSIC_TEXT_INFO *	pClassicTextInfo
	)

pure virtual

This function is invoked to add a text element to the timeline.

Parameters

objectId	(IN) Object Identifier of the text instance.
pClassicTextInfo	(IN) Text placement information.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddFrameScript	(	FCM::CStringRep16	pScript,
		FCM::U_Int32	layerNum
	)

pure virtual

This function is invoked for a frame that has frame script associated with it. This function can be called multiple times between two consecutive calls to ShowFrame(). Number of times this function is called depends on the number of layers that has frame scripts.

Parameters

pScript	(IN) Script associated with the frame in context.
layerNum	(IN) Layer number in which the frame script resides. This will be passed back in RemoveFrameScript().

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

Note: Caller of this function owns "pScript" and is responsible for deleting it.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddGraphic	(	FCM::U_Int32	objectId,
		GRAPHIC_INFO *	pGraphicInfo
	)

pure virtual

This function is invoked to add a graphic element to the timeline.

Parameters

objectId	(IN) Object Identifier of the graphic.
pGraphicInfo	(IN) Graphic placement information.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddMovieClip	(	FCM::U_Int32	objectId,
		MOVIE_CLIP_INFO *	pMovieClipInfo,
		DOM::FrameElement::PIMovieClip	pMovieClip
	)

pure virtual

This function is invoked to add a movie-clip element to the timeline.

Parameters

objectId	(IN) Object Identifier of the movie-clip.
pMovieClipInfo	(IN) Movie-clip placement information.
pMovieClip	(IN) Movie-clip object

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddShape	(	FCM::U_Int32	objectId,
		SHAPE_INFO *	pShapeInfo
	)

pure virtual

This function is invoked to add a shape to the timeline.

Parameters

objectId	(IN) Object Identifier of the shape.
pShapeInfo	(IN) Shape placement information.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::AddSound	(	FCM::U_Int32	objectId,
		SOUND_INFO *	pSoundInfo,
		DOM::FrameElement::PISound	pSound
	)

pure virtual

This function is invoked to add a sound element to the timeline.

Parameters

objectId	(IN) Object Identifier of the sound.
pSoundInfo	(IN) Information about the sound item getting added to timeline.
pSound	(IN) Sound object

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::Remove ( FCM::U_Int32 objectId )

pure virtual

This function is invoked when the object is removed from a frame.

Parameters

objectId (IN) Object Identifier

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::RemoveFrameScript ( FCM::U_Int32 layerNum )

pure virtual

This function is invoked to remove frame script associated with a frame.

Parameters

layerNum (IN) Layer number in which the frame script resided and now needs to be removed.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::SetFrameLabel	(	FCM::StringRep16	pLabel,
		DOM::KeyFrameLabelType	labelType
	)

pure virtual

This function is invoked for a frame that has frame label associated with it. This function can be called multiple times between two consecutive calls to ShowFrame().

Parameters

pLabel	(IN) Name of the label
labelType	(IN) Type of label. This can be either KEY_FRAME_LABEL_NAME or KEY_FRAME_LABEL_ANCHOR.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

Note: Caller of this function owns "pLabel" and is responsible for deleting it.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::ShowFrame ( )

pure virtual

This function is invoked for every frame when all the associated frame commands for the frame are executed. This "ShowFrame" command indicates that a frame is complete and can now be rendered during playback.

Returns: On success, FCM_SUCCESS is returned; otherwise an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::UpdateBlendMode	(	FCM::U_Int32	objectId,
		DOM::FrameElement::BlendMode	blendMode
	)

pure virtual

This function is invoked when the blend mode of the object changes in any frame.

Parameters

objectId	(IN) Object Identifier
blendMode	(IN) Blend mode that needs to be applied to the resource.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::UpdateColorTransform	(	FCM::U_Int32	objectId,
		const DOM::Utils::COLOR_MATRIX &	colorMatrix
	)

pure virtual

This function is invoked when color transform matrix of the object changes in any frame.

Parameters

objectId	(IN) Object Identifier
colorMatrix	(IN) A matrix that defines the color transform to be applied to the object.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::UpdateDisplayTransform	(	FCM::U_Int32	objectId,
		const DOM::Utils::MATRIX2D &	matrix
	)

pure virtual

This function is invoked when transform matrix of the object changes in any frame.

Parameters

objectId	(IN) Object Identifier
matrix	(IN) A 2D matrix that defines the transform to be applied to the object.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::UpdateGraphicFilter	(	FCM::U_Int32	objectId,
		PIFCMList	pFilterable
	)

pure virtual

This function is invoked when the filter is applied or already applied filter for the object changes in any frame.

Parameters

objectId	(IN) Object Identifier
pFilterable	(IN) List of filter/s that needs to be applied to the resource.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::UpdateVisibility	(	FCM::U_Int32	objectId,
		FCM::Boolean	visible
	)

pure virtual

This function is invoked when visibility of the object changes in any frame.

Parameters

objectId	(IN) Object Identifier
visible	(IN) Boolean variable that determines whether or not the object should be visible.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder::UpdateZOrder	(	FCM::U_Int32	objectId,
		FCM::U_Int32	placeAfterObjectId
	)

pure virtual

This function is invoked when depth of object changes in any frame as we traverse the frames in the timeline.

Parameters

objectId	(IN) Object Identifier
placeAfterObjectId	(IN) Object Id of the resource after which the current resource in context to be added for a frame in the timeline. Helps in Z ordering of the object.

Returns: On success, FCM_SUCCESS is returned, else an error code is returned.

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

app/include/interfaces/Exporter/Service/ITimelineBuilder.h

Public Member Functions

Detailed Description

Member Function Documentation