#include <IAnimationFacade.h>

Inheritance diagram for Facade::IAnimationFacade:

Public Types
enum	{ kDefaultIID = IID_IANIMATIONFACADE }

Public Member Functions
virtual bool	PageItemHasAnimation (const UIDRef &pageItemRef) const =0

virtual bool	PageItemHasCustomAnimationSettings (const UIDRef &pageItemRef) const =0

virtual bool	PageItemAndChildrenHaveAnimation (const UIDRef &pageItemRef, UIDList *pAnimationList=nil) const =0

virtual ErrorCode	SetPageItemMotionPreset (const UIDRef &pageItemRef, const UIDRef &presetRef, bool skipTargeting=false, bool doForceCreateNew=false)=0

virtual UIDRef	GetPageItemMotionPreset (const UIDRef &pageItemRef) const =0

virtual PMReal	GetPageItemAnimationDuration (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationDuration (const UIDRef &pageItemRef, const PMReal &duration)=0

virtual PMPoint	GetPageItemAnimationTransformOffsetPoint (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationTransformOffsetPoint (const UIDRef &pageItemRef, const PMPoint &offsetPoint)=0

virtual AnimationOptions	GetPageItemAnimationOption (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationOption (const UIDRef &pageItemRef, const AnimationOptions &animateOption)=0

virtual bool	GetPageItemAnimationHideInitially (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationHideInitially (const UIDRef &pageItemRef, bool setHiddenTillAnimated)=0

virtual bool	GetPageItemAnimationHideAfter (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationHideAfter (const UIDRef &pageItemRef, bool setHiddenAfterAnimated)=0

virtual uint32	GetPageItemAnimationPlays (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationPlays (const UIDRef &pageItemRef, uint32 numPlays)=0

virtual bool	GetPageItemAnimationPlaysLoop (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationPlaysLoop (const UIDRef &pageItemRef, bool setToLoop)=0

virtual AnimationEaseType	GetPageItemAnimationSimpleEaseType (const UIDRef &pageItemRef) const =0

virtual bool	SetPageItemAnimationSimpleEaseType (const UIDRef &pageItemRef, const AnimationEaseType &easeType)=0

virtual bool	GetPageItemAnimationMotionPath (const UIDRef &pageItemRef, AnimationPathDataList &path) const =0

virtual bool	SetPageItemAnimationMotionPath (const UIDRef &pageItemRef, const AnimationPathDataList &path)=0

virtual bool	GetPageItemAnimationMotionPath (const UIDRef &pageItemRef, PMPathPointList &path) const =0

virtual bool	SetPageItemAnimationMotionPath (const UIDRef &pageItemRef, const PMPathPointList &path)=0

virtual bool	SetPageItemAnimationMotionPath (const UIDRef &pageItemRef, const UIDRef &sourcePageItemRef, bool bDeleteItem)=0

virtual UIDRef	CreateAnimationMotionPathPageItem (const UIDRef &pageItemRef)=0

virtual ErrorCode	DeleteAnimationMotionPathPageItemData (IDocument *document, bool16 bDeleteItem)=0

virtual bool	SyncPageItemWithMotionPath (const UIDRef &pageItemRef, const UIDRef &motionPathPageItemRef)=0

virtual bool	IsPageItemMotionPathPageItem (const UIDRef &pageItemRef) const =0

virtual uint32	GetPageItemAnimationOpacityKeyFrameCount (const UIDRef &pageItemRef) const =0

virtual bool	GetPageItemAnimationOpacityKeyFrame (const UIDRef &pageItemRef, int32 which, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetPageItemAnimationOpacityValueAtKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, PMReal &value) const =0

virtual bool	SetPageItemAnimationOpacityKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, const PMReal &value=0)=0

virtual bool	RemovePageItemAnimationOpacityKeyFrame (const UIDRef &pageItemRef, uint32 keyframe)=0

virtual bool	RemovePageItemAnimationOpacityAllKeyFrames (const UIDRef &pageItemRef)=0

virtual uint32	GetPageItemAnimationRotationKeyFrameCount (const UIDRef &pageItemRef) const =0

virtual bool	GetPageItemAnimationRotationKeyFrame (const UIDRef &pageItemRef, int32 which, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetPageItemAnimationRotationValueAtKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, PMReal &value) const =0

virtual bool	SetPageItemAnimationRotationKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, const PMReal &value=0)=0

virtual bool	RemovePageItemAnimationRotationKeyFrame (const UIDRef &pageItemRef, uint32 keyframe)=0

virtual bool	RemovePageItemAnimationRotationAllKeyFrames (const UIDRef &pageItemRef)=0

virtual uint32	GetPageItemAnimationScaleXKeyFrameCount (const UIDRef &pageItemRef) const =0

virtual bool	GetPageItemAnimationScaleXKeyFrame (const UIDRef &pageItemRef, int32 which, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetPageItemAnimationScaleXValueAtKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, PMReal &value) const =0

virtual bool	SetPageItemAnimationScaleXKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, const PMReal &value=0)=0

virtual bool	RemovePageItemAnimationScaleXKeyFrame (const UIDRef &pageItemRef, uint32 keyframe)=0

virtual bool	RemovePageItemAnimationScaleXAllKeyFrames (const UIDRef &pageItemRef)=0

virtual uint32	GetPageItemAnimationScaleYKeyFrameCount (const UIDRef &pageItemRef) const =0

virtual bool	GetPageItemAnimationScaleYKeyFrame (const UIDRef &pageItemRef, int32 which, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetPageItemAnimationScaleYValueAtKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, PMReal &value) const =0

virtual bool	SetPageItemAnimationScaleYKeyFrame (const UIDRef &pageItemRef, uint32 keyframe, const PMReal &value=0)=0

virtual bool	RemovePageItemAnimationScaleYKeyFrame (const UIDRef &pageItemRef, uint32 keyframe)=0

virtual bool	RemovePageItemAnimationScaleYAllKeyFrames (const UIDRef &pageItemRef)=0

virtual ErrorCode	UpdatePageItemAnimationData (const UIDRef &pageItemRef, const IAnimationData *iNewAnimaData, const uint32 &dataSetFlags, bool skipTargeting=false)=0

virtual ErrorCode	AddPageItemAnimation (const UIDRef &pageItemRef, const IAnimationData *iNewAnimaData, const uint32 &dataSetFlags, bool skipTargeting=false)=0

virtual ErrorCode	RemovePageItemAnimation (const UIDRef &pageItemRef)=0

virtual ErrorCode	RemovePageItemAndChildrenAnimation (const UIDRef &pageItemRef)=0

virtual ErrorCode	SavePageItemAnimation (const UIDRef &pageItemRef, const PMString &newPresetName, UIDRef &newCustomRef, bool doApply=true)=0

virtual ErrorCode	SaveACopyPageItemAnimation (const UIDRef &pageItemRef, const IDFile &newPresetFile)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This facade provides services for obtaining and modifying the animation setting for the page items. For CS5, only one animation per page item is supported. The main data interface is IAnimationAttributeData.

See Also: IAnimationAttributeData.h

The animation settings include the followings:

motion preset - this is a flash motion preset.
See Also
IMotionPresetMgr.h
IMotionPresetData.h
animation duration
number of time the animation plays
transform offset point
motion path
opacity
rotation
scale x and y

This facade doesn't attempt to cover everything related to animation. For services related to motion preset, there's a IMotionFacade.

See Also: IMotionFacade.h

Member Function Documentation

virtual ErrorCode Facade::IAnimationFacade::AddPageItemAnimation	(	const UIDRef &	pageItemRef,
		const IAnimationData *	iNewAnimaData,
		const uint32 &	dataSetFlags,
		bool	skipTargeting = `false`
	)

pure virtual

Add a new animation to the page item.

Parameters

pageItemRef	is the page item.
iNewAnimaData	is the new animation data to add.
flags	is the data flags indicating set to set.
skipTargeting	is true if not to add this object to its default triggering event.

Returns: kSuccess otherwise an error code.

virtual UIDRef Facade::IAnimationFacade::CreateAnimationMotionPathPageItem ( const UIDRef & pageItemRef )

pure virtual

Given an interface for an item with a motion path, create a new page item from the motion path points and select it.

Parameters

pageItemRef is the UIDRef of the page item to created a motion path item from.

Returns: the UIDRef of the created item.

See Also: SetPageItemAnimationMotionPath

virtual ErrorCode Facade::IAnimationFacade::DeleteAnimationMotionPathPageItemData	(	IDocument *	document,
		bool16	bDeleteItem
	)

pure virtual

Given an interface for an item with a motion path (uses IID_ISPLINESTATEMOTIONPAGEITEMDATA), delete the page item (optionally) and remove data reference for it from the document.

Parameters

IDocument,the	document to delete the motion page item from.
bDeleteItem,kTrue	to delete the motion path item. kFalse will just remove the reference for it from the document (IID_ISPLINESTATEMOTIONPAGEITEMDATA)

Returns: kSuccess otherwise an error code.

See Also: CreateAnimationMotionPathPageItem

virtual PMReal Facade::IAnimationFacade::GetPageItemAnimationDuration ( const UIDRef & pageItemRef ) const

pure virtual

Gets animation duration from the page item.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: animation duration.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationHideAfter ( const UIDRef & pageItemRef ) const

pure virtual

Returns true if page item is hidden after animated.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: true if page item is hidden after animated.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationHideInitially ( const UIDRef & pageItemRef ) const

pure virtual

Returns true if page item is hidden until animated.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: true if page item is hidden until animated.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationMotionPath	(	const UIDRef &	pageItemRef,
		AnimationPathDataList &	path
	)		const

pure virtual

Gets animation motion path from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
path	is the motion path.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::GetPageItemAnimationMotionPath	(	const UIDRef &	pageItemRef,
		PMPathPointList &	path
	)		const

pure virtual

Gets animation motion path point list without the keyframes from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
path	is the motion path.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::GetPageItemAnimationOpacityKeyFrame	(	const UIDRef &	pageItemRef,
		int32	which,
		uint32 &	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property nth keyframe and value from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
which	is the nth keyframe.
keyframe	is the keyframe returned.
value	is the value at keyframe.

Returns: true if successful otherwise returns false,

virtual uint32 Facade::IAnimationFacade::GetPageItemAnimationOpacityKeyFrameCount ( const UIDRef & pageItemRef ) const

pure virtual

Gets number of keyframes for the animation's property.

Parameters

pageItemRef	is the UIDRef of the page item.
propType	is the property to get

Returns: number of keyframes.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationOpacityValueAtKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe.

virtual AnimationOptions Facade::IAnimationFacade::GetPageItemAnimationOption ( const UIDRef & pageItemRef ) const

pure virtual

Gets the animation option from the page item.

Returns: the animation option.

virtual uint32 Facade::IAnimationFacade::GetPageItemAnimationPlays ( const UIDRef & pageItemRef ) const

pure virtual

Gets number of times animation plays from the page item.

Returns: number of times the animation plays.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationPlaysLoop ( const UIDRef & pageItemRef ) const

pure virtual

Returns: true if page item animation is set to loop.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationRotationKeyFrame	(	const UIDRef &	pageItemRef,
		int32	which,
		uint32 &	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property nth keyframe and value from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
which	is the nth keyframe.
keyframe	is the keyframe returned.
value	is the value at keyframe.

Returns: true if successful otherwise returns false,

virtual uint32 Facade::IAnimationFacade::GetPageItemAnimationRotationKeyFrameCount ( const UIDRef & pageItemRef ) const

pure virtual

Gets number of keyframes for the animation's property.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: number of keyframes.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationRotationValueAtKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationScaleXKeyFrame	(	const UIDRef &	pageItemRef,
		int32	which,
		uint32 &	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property nth keyframe and value from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
which	is the nth keyframe.
keyframe	is the keyframe returned.
value	is the value at keyframe.

virtual uint32 Facade::IAnimationFacade::GetPageItemAnimationScaleXKeyFrameCount ( const UIDRef & pageItemRef ) const

pure virtual

Gets number of keyframes for the animation's property.

Parameters

propType is the property to get

Returns: number of keyframes.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationScaleXValueAtKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::GetPageItemAnimationScaleYKeyFrame	(	const UIDRef &	pageItemRef,
		int32	which,
		uint32 &	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property nth keyframe and value from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
which	is the nth keyframe.
keyframe	is the keyframe returned.
value	is the value at keyframe.

virtual uint32 Facade::IAnimationFacade::GetPageItemAnimationScaleYKeyFrameCount ( const UIDRef & pageItemRef ) const

pure virtual

Gets number of keyframes for the animation's property.

Parameters

pageItemRef is the UIDRef of the page item to get.

Returns: number of keyframes.

virtual bool Facade::IAnimationFacade::GetPageItemAnimationScaleYValueAtKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe.

Returns: true if successful otherwise returns false,

virtual AnimationEaseType Facade::IAnimationFacade::GetPageItemAnimationSimpleEaseType ( const UIDRef & pageItemRef ) const

pure virtual

Gets the simple animation ease type from the page item.

Returns: simple ease type.

virtual PMPoint Facade::IAnimationFacade::GetPageItemAnimationTransformOffsetPoint ( const UIDRef & pageItemRef ) const

pure virtual

Gets animation transform offset point.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: animation transform offset point.

virtual UIDRef Facade::IAnimationFacade::GetPageItemMotionPreset ( const UIDRef & pageItemRef ) const

pure virtual

Gets the motion preset applied to page item's animation.

Parameters

pageItemRef is the page item.

Returns: UIDRef of the motion preset applied..

virtual bool Facade::IAnimationFacade::IsPageItemMotionPathPageItem ( const UIDRef & pageItemRef ) const

pure virtual

Return true if page item is a special animation motion path page item. This object is used to manimupate page item's motion path only and cannot be edited otherwise.

Parameters

pageItemRef is the UIDRef of the animation motion path page item.

Returns: true if page item is a special animation motion path page item.

virtual bool Facade::IAnimationFacade::PageItemAndChildrenHaveAnimation	(	const UIDRef &	pageItemRef,
		UIDList *	pAnimationList = `nil`
	)		const

pure virtual

Return true if this page item or one of its children has animation.

Parameters

pageItemRef	is the page item.
pAnimationList,a	list of animation items is returned in pAnimationList if it is not nil.

Returns: true if at least one item has animation; otherwise false.

virtual bool Facade::IAnimationFacade::PageItemHasAnimation ( const UIDRef & pageItemRef ) const

pure virtual

Return true if this page item has animation.

Parameters

pageItemRef is the page item.

Returns: true if page item has animation; otherwise false.

virtual bool Facade::IAnimationFacade::PageItemHasCustomAnimationSettings ( const UIDRef & pageItemRef ) const

pure virtual

Return true if this page item has custom animation settings.

Parameters

pageItemRef is the page item.

Returns: true if page item has custon animation; otherwise false.

virtual ErrorCode Facade::IAnimationFacade::RemovePageItemAndChildrenAnimation ( const UIDRef & pageItemRef )

pure virtual

Remove page item's and its children's animation.

Parameters

pageItemRef is the page item.

Returns: kSuccess otherwise an error code.

virtual ErrorCode Facade::IAnimationFacade::RemovePageItemAnimation ( const UIDRef & pageItemRef )

pure virtual

Remove page item's animation.

Parameters

pageItemRef is the page item.

Returns: kSuccess otherwise an error code.

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationOpacityAllKeyFrames ( const UIDRef & pageItemRef )

pure virtual

Removes all animation property keyframes from the page item.

Parameters

pageItemRef is the UIDRef of the page item.

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationOpacityKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe
	)

pure virtual

Removes animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe to remove.

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationRotationAllKeyFrames ( const UIDRef & pageItemRef )

pure virtual

Removes all animation property keyframes from the page item.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationRotationKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe
	)

pure virtual

Removes animation property value at the specified keyframe ifrom the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe to remove.

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationScaleXAllKeyFrames ( const UIDRef & pageItemRef )

pure virtual

Removes all animation property keyframes from the page item.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationScaleXKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe
	)

pure virtual

Removes animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe to remove.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationScaleYAllKeyFrames ( const UIDRef & pageItemRef )

pure virtual

Removes all animation property keyframes from the page item.

Parameters

pageItemRef is the UIDRef of the page item.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::RemovePageItemAnimationScaleYKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe
	)

pure virtual

Removes animation property value at the specified keyframe from the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe to remove.

Returns: true if successful otherwise returns false,

virtual ErrorCode Facade::IAnimationFacade::SaveACopyPageItemAnimation	(	const UIDRef &	pageItemRef,
		const IDFile &	newPresetFile
	)

pure virtual

Save page item's animation as a copy of motion preset file.

Parameters

pageItemRef	is the page item.
newPresetFile	is the new preset file name.

Returns: kSuccess otherwise an error code.

virtual ErrorCode Facade::IAnimationFacade::SavePageItemAnimation	(	const UIDRef &	pageItemRef,
		const PMString &	newPresetName,
		UIDRef &	newCustomRef,
		bool	doApply = `true`
	)

pure virtual

Save page item's animation as custom preset.

Parameters

pageItemRef	is the page item.
newPresetName	is the new custom preset name.
newCustomRef	contains the new custom preset UIDRef.
doApply	if true will apply the new custom preset to the page item.

Returns: kSuccess otherwise an error code.

virtual bool Facade::IAnimationFacade::SetPageItemAnimationDuration	(	const UIDRef &	pageItemRef,
		const PMReal &	duration
	)

pure virtual

Sets animation duration for the page item..

Parameters

pageItemRef	is the UIDRef of the page item.
duration	is the new duration to apply to the selection.

virtual bool Facade::IAnimationFacade::SetPageItemAnimationHideAfter	(	const UIDRef &	pageItemRef,
		bool	setHiddenAfterAnimated
	)

pure virtual

Sets the page item's run-time visibility to be hidden after animated.

Parameters

pageItemRef	is the UIDRef of the page item.
setHiddenAfterAnimated	is true if to set object to be hidden after animated.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationHideInitially	(	const UIDRef &	pageItemRef,
		bool	setHiddenTillAnimated
	)

pure virtual

Sets the page item's run-time visibility to be hidden until animated.

Parameters

pageItemRef	is the UIDRef of the page item.
setHiddenTillAnimated	is true if to set object to be hidden till animated.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationMotionPath	(	const UIDRef &	pageItemRef,
		const AnimationPathDataList &	path
	)

pure virtual

Sets animation path for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
path	is the animation path to apply.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationMotionPath	(	const UIDRef &	pageItemRef,
		const PMPathPointList &	path
	)

pure virtual

Sets animation path for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
path	is the animation path to apply. Path is applied evenly over the duration. If the page item has an old path, it is removed first.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationMotionPath	(	const UIDRef &	pageItemRef,
		const UIDRef &	sourcePageItemRef,
		bool	bDeleteItem
	)

pure virtual

Sets animation path for the page item from another page item.

Parameters

pageItemRef	is the UIDRef of the page item to apply to.
sourcePageItemRef	is the UIDRef of the source page item from which to extract the 0th path. Then sourcePageItemRef will be deleted if specified, see next parameter.
bDeleteItem	if kTrue the sourcePageItemRef is deleted, if kFalse it is not.

Returns: true if successful otherwise returns false

See Also: CreateAnimationMotionPathPageItem

virtual bool Facade::IAnimationFacade::SetPageItemAnimationOpacityKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		const PMReal &	value = `0`
	)

pure virtual

Sets animation property value at the specified keyframe for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe to set.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationOption	(	const UIDRef &	pageItemRef,
		const AnimationOptions &	animateOption
	)

pure virtual

Sets the animation option for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
animateOption	the animation option to set.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationPlays	(	const UIDRef &	pageItemRef,
		uint32	numPlays
	)

pure virtual

Sets number of times animation plays for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
numPlays	the number to time the animation should play.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationPlaysLoop	(	const UIDRef &	pageItemRef,
		bool	setToLoop
	)

pure virtual

Sets page item animation to loop.

Parameters

pageItemRef	is the UIDRef of the page item.
setToLooop	is true if animation is set to loop.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationRotationKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		const PMReal &	value = `0`
	)

pure virtual

Sets animation property value at the specified keyframe for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe to set.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationScaleXKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		const PMReal &	value = `0`
	)

pure virtual

Sets animation property value at the specified keyframe for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe to set.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationScaleYKeyFrame	(	const UIDRef &	pageItemRef,
		uint32	keyframe,
		const PMReal &	value = `0`
	)

pure virtual

Sets animation property value at the specified keyframe for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
keyframe	is the keyframe.
value	is the value at keyframe to set.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationSimpleEaseType	(	const UIDRef &	pageItemRef,
		const AnimationEaseType &	easeType
	)

pure virtual

Sets the simple animation ease type for the page item.

Parameters

pageItemRef	is the UIDRef of the page item.
easeType	the simple ease type to set.

Returns: true if successful otherwise returns false,

virtual bool Facade::IAnimationFacade::SetPageItemAnimationTransformOffsetPoint	(	const UIDRef &	pageItemRef,
		const PMPoint &	offsetPoint
	)

pure virtual

Sets the animation transform offset point.

Parameters

pageItemRef	is the UIDRef of the page item.
animation	transform offset point to apply to the selection.

virtual ErrorCode Facade::IAnimationFacade::SetPageItemMotionPreset	(	const UIDRef &	pageItemRef,
		const UIDRef &	presetRef,
		bool	skipTargeting = `false`,
		bool	doForceCreateNew = `false`
	)

pure virtual

Apply a motion preset to page item's animation.

Parameters

pageItemRef	is the page item.
presetRef	is the motion preset to apply.
skipTargeting	is true if not to add this object to its default triggering event.
doForceCreateNew	is true if to create new preset in the document even if a preset with the same name one already exist. The default is false.

Returns: kSuccess otherwise an error code.

virtual bool Facade::IAnimationFacade::SyncPageItemWithMotionPath	(	const UIDRef &	pageItemRef,
		const UIDRef &	motionPathPageItemRef
	)

pure virtual

Given a page item ref and a motion path page item ref, translate the page item (pageItemRef) to be aligned with the motion path page item. Used after the motion path item is edited (e.g. moved, resized, path points altered) so the page item is "synced" up to the upper left of the motion path page item (taking into account the offset point).

Parameters

pageItemRef	is the UIDRef of the page item with animation applied.
motionPathPageItemRef	is the UIDRef of the motion path.

Returns: true if successful otherwise returns false

virtual ErrorCode Facade::IAnimationFacade::UpdatePageItemAnimationData	(	const UIDRef &	pageItemRef,
		const IAnimationData *	iNewAnimaData,
		const uint32 &	dataSetFlags,
		bool	skipTargeting = `false`
	)

pure virtual

Update page item's which animation data from the which animation data of iNewAnimaData.

Parameters

pageItemRef	is the page item.
iNewAnimaData	is the new animation data.
flags	is the data flags indicating set to set.
skipTargeting	is true if not to add this object to its default triggering event.

Returns: kSuccess otherwise an error code.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation