#include <IAnimationData.h>

Inheritance diagram for IAnimationData:

Public Types
enum	{ kDefaultIID = IID_IANIMATIONDATA }

Public Member Functions
virtual UID	GetPresetUID () const =0

virtual bool	SetPresetUID (UID presetUID)=0

virtual uint32	GetNumPlays () const =0

virtual bool	SetNumPlays (uint32 numPlays)=0

virtual bool	GetPlaysLoop () const =0

virtual bool	SetPlaysLoop (bool setToLoop)=0

virtual bool	GetHideInitially () const =0

virtual bool	SetHideInitially (bool setHideInitially)=0

virtual bool	GetHideAfter () const =0

virtual bool	SetHideAfter (bool setHideAfter)=0

virtual AnimationOptions	GetAnimateOption () const =0

virtual bool	SetAnimateOption (const AnimationOptions &animateOption)=0

virtual bool	SetDuration (const PMReal &durationInSecond)=0

virtual PMReal	GetDuration () const =0

virtual bool	SetFrameRate (int32 frameRatePerSecond)=0

virtual int32	GetFrameRate () const =0

virtual AnimationEaseType	GetSimpleEaseType () const =0

virtual bool	SetSimpleEaseType (const AnimationEaseType &easeType)=0

virtual bool	SetTransformOffsetPoint (const PMPoint &offsetPoint)=0

virtual PMPoint	GetTransformOffsetPoint () const =0

virtual bool	Get2DKeyFramePath (AnimationPathDataList &pathFrames) const =0

virtual bool	Get2DPathPoints (PMPathPointList &path, bool &isRoving) const =0

virtual bool	Set2DKeyFramePath (const AnimationPathDataList &path)=0

virtual bool	Set2DPathPoints (const PMPathPointList &path, bool isRoving)=0

virtual uint32	GetOpacityKeyFrameCount () const =0

virtual bool	GetOpacityKeyFrame (uint32 nth, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetOpacityKeyFrame (uint32 keyframe, PMReal &value) const =0

virtual bool	SetOpacityKeyFrame (uint32 keyframe, const PMReal &value)=0

virtual bool	RemoveOpacityKeyFrame (uint32 keyframe)=0

virtual uint32	GetRotationKeyFrameCount () const =0

virtual bool	GetRotationKeyFrame (uint32 nth, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetRotationKeyFrame (uint32 keyframe, PMReal &value) const =0

virtual bool	SetRotationKeyFrame (uint32 keyframe, const PMReal &value)=0

virtual bool	RemoveRotationKeyFrame (uint32 keyframe)=0

virtual uint32	GetScaleXKeyFrameCount () const =0

virtual bool	GetScaleXKeyFrame (uint32 nth, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetScaleXKeyFrame (uint32 keyframe, PMReal &value) const =0

virtual bool	SetScaleXKeyFrame (uint32 keyframe, const PMReal &value)=0

virtual bool	RemoveScaleXKeyFrame (uint32 keyframe)=0

virtual uint32	GetScaleYKeyFrameCount () const =0

virtual bool	GetScaleYKeyFrame (uint32 nth, uint32 &keyframe, PMReal &value) const =0

virtual bool	GetScaleYKeyFrame (uint32 keyframe, PMReal &value) const =0

virtual bool	SetScaleYKeyFrame (uint32 keyframe, const PMReal &value)=0

virtual bool	RemoveScaleYKeyFrame (uint32 keyframe)=0

virtual void	Copy (const IAnimationData *iOtherData)=0

virtual bool	Equals (const IAnimationData *iOtherData) const =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 is a transient data interface for one animation data. It is used to represent the memoery-based animation data, e.g. animation script data object. It is also used as command data interface to update page item animation data. It does not provide direct access to the page item's persistent animation data.

See Also: also IAnimationAttributeData.h

Member Function Documentation

virtual void IAnimationData::Copy ( const IAnimationData * iOtherData )

pure virtual

Copy from another animation data.

Parameters

iOtherData is the animation data to copy from.

virtual bool IAnimationData::Equals ( const IAnimationData * iOtherData ) const

pure virtual

Compare with another animation data.

Parameters

iOtherData is the animation data to compare with.

Returns: true if completely equals

virtual bool IAnimationData::Get2DKeyFramePath ( AnimationPathDataList & pathFrames ) const

pure virtual

Gets the 2D motion path and keyframes.

Parameters

pathFrames is the keyframe path to get.

Returns: true if successful.

virtual bool IAnimationData::Get2DPathPoints	(	PMPathPointList &	path,
		bool &	isRoving
	)		const

pure virtual

Gets the 2D motion path.

Parameters

path	is the path to get.
isRoving	is true if path is roving path.

Returns: true if successful.

virtual AnimationOptions IAnimationData::GetAnimateOption ( ) const

pure virtual

Returns: the animate option.

virtual PMReal IAnimationData::GetDuration ( ) const

pure virtual

Gets the duration for whichAnimation.

virtual int32 IAnimationData::GetFrameRate ( ) const

pure virtual

Returns: the frame rate

virtual bool IAnimationData::GetHideAfter ( ) const

pure virtual

Returns: true if object is hidden after animated.

virtual bool IAnimationData::GetHideInitially ( ) const

pure virtual

Returns: true if object is hidden until animated.

virtual uint32 IAnimationData::GetNumPlays ( ) const

pure virtual

Returns: the number ot times the animation plays.

virtual bool IAnimationData::GetOpacityKeyFrame	(	uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets the opacity at specified key frame.

Parameters

keyframe	is the keyframe to get.
value	is the value at keyframe.

Returns: true if successful.

virtual uint32 IAnimationData::GetOpacityKeyFrameCount ( ) const

pure virtual

Gets the total number of key frames.

virtual bool IAnimationData::GetPlaysLoop ( ) const

pure virtual

Returns: true if animation is set to loop

virtual UID IAnimationData::GetPresetUID ( ) const

pure virtual

Returns: the animation preset UID.

virtual bool IAnimationData::GetRotationKeyFrame	(	uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets the rotation at specified key frame.

Parameters

keyframe	is the keyframe to get.
value	is the value at keyframe.

virtual uint32 IAnimationData::GetRotationKeyFrameCount ( ) const

pure virtual

Gets the total number of key frames.

virtual uint32 IAnimationData::GetScaleXKeyFrameCount ( ) const

pure virtual

Gets the total number of key frames.

virtual bool IAnimationData::GetScaleYKeyFrame	(	uint32	nth,
		uint32 &	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets the nth keyframe and scale y value.

Parameters

nth	is the nth keyframe value pair to get.
keyframe	is the keyframe
value	is the value at keyframe.

Returns: true if successful.

virtual bool IAnimationData::GetScaleYKeyFrame	(	uint32	keyframe,
		PMReal &	value
	)		const

pure virtual

Gets the nth keyframe and scale y value.

Parameters

nth	is the nth keyframe value pair to get.
keyframe	is the keyframe
value	is the value at keyframe.

Returns: true if successful.

virtual uint32 IAnimationData::GetScaleYKeyFrameCount ( ) const

pure virtual

Gets the total number of key frames.

virtual AnimationEaseType IAnimationData::GetSimpleEaseType ( ) const

pure virtual

Returns: the simple ease strength.

virtual PMPoint IAnimationData::GetTransformOffsetPoint ( ) const

pure virtual

Returns: the transform offset point.

virtual bool IAnimationData::RemoveRotationKeyFrame ( uint32 keyframe )

pure virtual

Removes the specified rotation key frame

Parameters

keyframe is the keyframe to remove.

Returns: true if successful.

virtual bool IAnimationData::RemoveScaleXKeyFrame ( uint32 keyframe )

pure virtual

Removes the specified scale x key frame

Parameters

keyframe is the keyframe to remove.

Returns: true if successful.

virtual bool IAnimationData::RemoveScaleYKeyFrame ( uint32 keyframe )

pure virtual

Removes the specified scale y key frame

Parameters

keyframe is the keyframe to remove.

Returns: true if successful.

virtual bool IAnimationData::Set2DKeyFramePath ( const AnimationPathDataList & path )

pure virtual

Sets the 2D motion path and keyframes.

Parameters

pathFrames is the keyframe path to get.

Returns: true if successful.

virtual bool IAnimationData::Set2DPathPoints	(	const PMPathPointList &	path,
		bool	isRoving
	)

pure virtual

Sets the 2D motion path. This path replaces the existing path at the already specified keyframes.

Parameters

path	is the path to set.
isRoving	is true if the path to set is roving path.

Returns: true if successful.

virtual bool IAnimationData::SetAnimateOption ( const AnimationOptions & animateOption )

pure virtual

Sets the animate option.

Parameters

animateOption is the animate option to set.

Returns: true if successful.

virtual bool IAnimationData::SetDuration ( const PMReal & durationInSecond )

pure virtual

Sets the duration.

Parameters

durationInSecond is the duration.

Returns: true if successful.

virtual bool IAnimationData::SetFrameRate ( int32 frameRatePerSecond )

pure virtual

Sets the frame rate.

Parameters

frameRatePerSecond is number of frames per second.

virtual bool IAnimationData::SetHideAfter ( bool setHideAfter )

pure virtual

Sets object run-time visibility to hide after animated.

Parameters

setHideAfter is true if to set object to be hidden after animated.

Returns: true if successful.

virtual bool IAnimationData::SetHideInitially ( bool setHideInitially )

pure virtual

Sets object run-time visibility to be hidden until animated.

Parameters

setHidden is true if to set object to be hidden till animated.

Returns: true if successful.

virtual bool IAnimationData::SetNumPlays ( uint32 numPlays )

pure virtual

Sets the number of time the animation plays.

Parameters

numPlays is the number ot times the animation plays. numPlays must be at least 1.

virtual bool IAnimationData::SetOpacityKeyFrame	(	uint32	keyframe,
		const PMReal &	value
	)

pure virtual

Sets the opacity at specified key frame.

Parameters

keyframe	is the keyframe to set.
value	is the value at keyframe.

Returns: true if successful.

virtual bool IAnimationData::SetPlaysLoop ( bool setToLoop )

pure virtual

Sets animation to plays loop.

Parameters

setToLoop is true if to set animation to loop.

Returns: true if successful.

virtual bool IAnimationData::SetPresetUID ( UID presetUID )

pure virtual

Sets the animation preset UID.

Parameters

presetUID is the motion preset UID to set.

Returns: true if successful.

virtual bool IAnimationData::SetRotationKeyFrame	(	uint32	keyframe,
		const PMReal &	value
	)

pure virtual

Sets the rotation at specified key frame.

Parameters

keyframe	is the keyframe to set.
value	is the value at keyframe.

Returns: true if successful.

virtual bool IAnimationData::SetScaleXKeyFrame	(	uint32	keyframe,
		const PMReal &	value
	)

pure virtual

Sets the scale x at specified key frame.

Parameters

keyframe	is the keyframe to set.
value	is the value at keyframe.

Returns: true if successful.

virtual bool IAnimationData::SetScaleYKeyFrame	(	uint32	keyframe,
		const PMReal &	value
	)

pure virtual

Sets the scale y at specified key frame.

Parameters

keyframe	is the keyframe to set.
value	is the value at keyframe.

Returns: true if successful.

virtual bool IAnimationData::SetSimpleEaseType ( const AnimationEaseType & easeType )

pure virtual

Sets the simple ease type.

Parameters

easeType is ease type to set.

virtual bool IAnimationData::SetTransformOffsetPoint ( const PMPoint & offsetPoint )

pure virtual

Sets the transform point. The transform point specified the offset percentage (0.0 to 1.0) relative to the target object the animation path motion starts.

Parameters

offsetPoint is the offset percent point to set.

Returns: true if successful.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation