Defines the interface that represents a frame in a layer in the timeline. More...

#include <IFrame.h>

Inheritance diagram for DOM::IFrame:

Public Member Functions
virtual FCM::Result _FCMCALL	GetDuration (FCM::U_Int32 &duration)=0
	This function gets the number of frames in a frame sequence. More...

virtual FCM::Result _FCMCALL	GetFrameElements (PIFCMList &pFrameElementsList)=0
	This function returns an array of FrameElements. This will contain the Sound and the FrameDisplayElements, which are items on stage. The order of FrameDisplayElements is the order from the topChild to bottomChild in the frame. If there are multiple shapes on the Stage, and each is ungrouped, they are treated as one FrameDisplayElement. If each shape is grouped, so there are multiple groups on the Stage, they are treated as separate FrameDisplayElements. In other words, raw, ungrouped shapes are treated as a single FrameDisplayElement, regardless of how many separate shapes are on the Stage. For example, if a frame contains three raw, ungrouped shapes, then the number of FrameDisplayElements in the list will be 1. More...

virtual FCM::Result _FCMCALL	GetFrameElementsByType (ConstFCMIID &iid, PIFCMList &pFrameElementsList)=0
	This function returns an array of FrameElements of type IID_ISound, and IID_IFrameDisplayElements. More...

virtual FCM::Result _FCMCALL	GetStartFrameIndex (FCM::U_Int32 &frameIndex)=0
	This function gets the start frame index of the frame span. More...

virtual FCM::Result _FCMCALL	GetLabel (FCM::StringRep16 *ppLabel)=0
	This function returns the label for the frame. More...

virtual FCM::Result _FCMCALL	GetLabelType (KeyFrameLabelType &labelType)=0
	This function gets the type of label on the frame. More...

virtual FCM::Result _FCMCALL	GetScript (FCM::StringRep16 *ppScript)=0
	This function gets a string that represents the frame script associated with this frame. More...

virtual FCM::Result _FCMCALL	GetTween (PITween &pTween)=0
	The function returns a tween object associated with this frame span. More...

Detailed Description

Defines the interface that represents a frame in a layer in the timeline.

Member Function Documentation

virtual FCM::Result _FCMCALL DOM::IFrame::GetDuration ( FCM::U_Int32 & duration )

pure virtual

This function gets the number of frames in a frame sequence.

Parameters

duration (OUT) Number of frames in a frame sequence.

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

virtual FCM::Result _FCMCALL DOM::IFrame::GetFrameElements ( PIFCMList & pFrameElementsList )

pure virtual

This function returns an array of FrameElements. This will contain the Sound and the FrameDisplayElements, which are items on stage. The order of FrameDisplayElements is the order from the topChild to bottomChild in the frame. If there are multiple shapes on the Stage, and each is ungrouped, they are treated as one FrameDisplayElement. If each shape is grouped, so there are multiple groups on the Stage, they are treated as separate FrameDisplayElements. In other words, raw, ungrouped shapes are treated as a single FrameDisplayElement, regardless of how many separate shapes are on the Stage. For example, if a frame contains three raw, ungrouped shapes, then the number of FrameDisplayElements in the list will be 1.

Parameters

pFrameElementsList (OUT) List of Frame elements. Each object in the list can be queried depending on its type: Sound - ISound Shape - IFrameDisplayElement, IShape Group - IFrameDisplayElement, IGroup Text - IFrameDisplayElement, IClassicText Bitmap - IFrameDisplayElement, IBitmapInstance Graphic - IFrameDisplayElement, IInstance, ISymbolInstance, IGraphic Movie Clip - IFrameDisplayElement, IInstance, ISymbolInstance, IMovieClip

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

See also: DOM::FrameElement::IFrameDisplayElement; DOM::FrameElement::ISound; DOM::FrameElement::IShape; DOM::FrameElement::IGroup; DOM::FrameElement::IClassicText; DOM::FrameElement::IBitmapInstance; DOM::FrameElement::IInstance; DOM::FrameElement::ISymbolInstance; DOM::FrameElement::IGraphic; DOM::FrameElement::IMovieClip

virtual FCM::Result _FCMCALL DOM::IFrame::GetFrameElementsByType	(	ConstFCMIID &	iid,
		PIFCMList &	pFrameElementsList
	)

pure virtual

This function returns an array of FrameElements of type IID_ISound, and IID_IFrameDisplayElements.

Parameters

iid (IN) Interface ID, will work with IID_ISound, and IID_IFrameDisplayElements.

pFrameElementsList (OUT) List of Frame elements. Each object in the list can be queried depending on its type: Sound - ISound Shape - IFrameDisplayElement, IShape Group - IFrameDisplayElement, IGroup Text - IFrameDisplayElement, IClassicText Bitmap - IFrameDisplayElement, IBitmapInstance Graphic - IFrameDisplayElement, IInstance, ISymbolInstance, IGraphic Movie Clip - IFrameDisplayElement, IInstance, ISymbolInstance, IMovieClip

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

virtual FCM::Result _FCMCALL DOM::IFrame::GetLabel ( FCM::StringRep16 * ppLabel )

pure virtual

This function returns the label for the frame.

Parameters

ppLabel (OUT) Label of the frame.

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

Note: The memory allocated for 'ppLabel' in this function must be freed by the caller using IFCMCalloc::Free().

virtual FCM::Result _FCMCALL DOM::IFrame::GetLabelType ( KeyFrameLabelType & labelType )

pure virtual

This function gets the type of label on the frame.

Parameters

labelType (OUT) Type of label.

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

virtual FCM::Result _FCMCALL DOM::IFrame::GetScript ( FCM::StringRep16 * ppScript )

pure virtual

This function gets a string that represents the frame script associated with this frame.

Parameters

ppScript (OUT) Frame script

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

Note: The memory allocated for 'ppScript' in this function must be freed by the caller using IFCMCalloc::Free().

virtual FCM::Result _FCMCALL DOM::IFrame::GetStartFrameIndex ( FCM::U_Int32 & frameIndex )

pure virtual

This function gets the start frame index of the frame span.

Parameters

frameIndex (OUT) Start frame index of the frame span.

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

Note: For example, let a frame, span from frame number 6 to 10 and this function will return 6 for any frame within this span.

virtual FCM::Result _FCMCALL DOM::IFrame::GetTween ( PITween & pTween )

pure virtual

The function returns a tween object associated with this frame span.

Parameters

pTween (OUT) ITween 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/DOM/IFrame.h

Public Member Functions

Detailed Description

Member Function Documentation