This interface represents a builder for a timeline. ITimelineBuilder2 contains all the methods inherited from ITimelineBuilder and the new methods mentioned in this file that are invoked by the FrameCommandGenerator service (implemented in 'Adobe Animate CC') to add frame commands for a timeline. More...

#include <ITimelineBuilder2.h>

Inheritance diagram for Exporter::Service::ITimelineBuilder2:

Public Member Functions
virtual FCM::Result _FCMCALL	UpdateMask (FCM::U_Int32 maskObjectId, FCM::U_Int32 lowestMaskedObjectId)=0
	This function is invoked while updating the masking behavior of an object. More...

Public Member Functions inherited from Exporter::Service::ITimelineBuilder
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. ITimelineBuilder2 contains all the methods inherited from ITimelineBuilder and the new methods mentioned in this file that are invoked by the FrameCommandGenerator service (implemented in 'Adobe Animate CC') to add frame commands for a timeline.

Note: This interface is available in version 1.1.0 of the SDK and above.

Member Function Documentation

virtual FCM::Result _FCMCALL Exporter::Service::ITimelineBuilder2::UpdateMask	(	FCM::U_Int32	maskObjectId,
		FCM::U_Int32	lowestMaskedObjectId
	)

pure virtual

This function is invoked while updating the masking behavior of an object.

Parameters

maskObjectId	(IN) Object Identifier of the mask object
lowestMaskedObjectId	(IN) Object Id of the lowest object that is masked by the mask object. The mask will have effect on all the objects after the mask object till the object with the id lowestMaskedObjectId. If lowestMaskedObjectId is same as maskObjectId, then the mask has no effect.

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/ITimelineBuilder2.h

Public Member Functions

Detailed Description

Member Function Documentation