Inheritance diagram for IAnimationUtils:

Public Types
enum	{ kDefaultIID = IID_IANIMATIONUTILS }

Public Member Functions
virtual PMString	GetTargetName (const UIDRef &targetRef) const =0

virtual void	GetApplicableTriggerEvents (const UIDRef &ownerRef, std::vector< EventTriggerType > &triggerList) const =0

virtual void	GetApplicableTriggerEventsForTarget (const UIDRef &ownerRef, const UIDRef &targetRef, std::vector< EventTriggerType > &triggerList) const =0

virtual EventTriggerType	GetEventTriggerFromString (const PMString &triggerString) const =0

virtual PMString	GetStringFromEventTrigger (const EventTriggerType &trigger, const ISpreadDynamicContentMgr::DynamicContentType &type=ISpreadDynamicContentMgr::kAnimationItemType, bool consolidateButtonEvet=false) const =0

virtual bool	GetPageItemAnimationFirstLastKeyframeValues (const UIDRef &pageItemRef, std::vector< PMPoint > &position, std::vector< PMPoint > &scale, std::vector< PMReal > &rotationAngle, std::vector< PMReal > &opacity) const =0

virtual bool	AnimationAllowedForPageItem (const UIDRef &targetRef) const =0

virtual UID	GetParentSpreadUID (const UIDRef &targetRef) const =0

virtual UID	GetTimingParentUID (const UIDRef &targetRef) 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

Member Function Documentation

virtual bool IAnimationUtils::AnimationAllowedForPageItem ( const UIDRef & targetRef ) const

pure virtual

Returns true if animation is allowed for the specified page item.

Parameters

targetRef is the target page item's UIDRef.

Returns: true is animation is allowed.

virtual void IAnimationUtils::GetApplicableTriggerEvents	(	const UIDRef &	ownerRef,
		std::vector< EventTriggerType > &	triggerList
	)		const

pure virtual

Returns the applicable trigger event list for the specified triggering object

Parameters

ownerRef	is the triggering object.
triggerList	is list of applicable triggers.

virtual void IAnimationUtils::GetApplicableTriggerEventsForTarget	(	const UIDRef &	ownerRef,
		const UIDRef &	targetRef,
		std::vector< EventTriggerType > &	triggerList
	)		const

pure virtual

Returns the other applicable trigger events for the specified target in the current event trigger.

Parameters

ownerRef	is the triggering object.
targetRef	is the target.
triggerList	is list of applicable triggers.

virtual EventTriggerType IAnimationUtils::GetEventTriggerFromString ( const PMString & triggerString ) const

pure virtual

Returns the event trigger associated with the event trigger string.

Parameters

triggerString is the trigger string.

Returns: the event trigger type.

virtual bool IAnimationUtils::GetPageItemAnimationFirstLastKeyframeValues	(	const UIDRef &	pageItemRef,
		std::vector< PMPoint > &	position,
		std::vector< PMPoint > &	scale,
		std::vector< PMReal > &	rotationAngle,
		std::vector< PMReal > &	opacity
	)		const

pure virtual

Returns the page item animation's first and last keyframe values.

Parameters

position	the first and last keyframe position of the page item at run-time. The coordinate is the flash coordinate. The default is the (0,0). If there no motion path for this animation, the position vector is empty.
scale	is the first and last keyframe value for scale x and scale y percentages at run-time. The defaullt is 100%
rotationAngle	is the first and last keyframe value for the rotation angle in degree at run-time. The default is 0 degree.
opacity	is the first and last keyframe value for the opacity property at run-time. The default is 100%.

Returns: true if successfully.

virtual UID IAnimationUtils::GetParentSpreadUID ( const UIDRef & targetRef ) const

pure virtual

Returns the spread UID the target page item is on.

Parameters

targetRef is the target page item's UIDRef.

Returns: the spread UID the target page item is on.

virtual PMString IAnimationUtils::GetStringFromEventTrigger	(	const EventTriggerType &	trigger,
		const ISpreadDynamicContentMgr::DynamicContentType &	type = `ISpreadDynamicContentMgr::kAnimationItemType`,
		bool	consolidateButtonEvet = `false`
	)		const

pure virtual

Returns the event trigger string for the specified trigger event

Parameters

trigger	is the event trigger.
type	is the dynamic content type. The default is kAnimationItemType. If type is set to kMultiStateItemType, then kOnPageLoad is reaturned as kOnStateLoad string.
consolidateButtonEvent	is true if to ignore specific button events and return as a generic button event string.

Returns: the corresponding event trigger string.

virtual PMString IAnimationUtils::GetTargetName ( const UIDRef & targetRef ) const

pure virtual

Returns the specified target's name. If target is part of MSO, the fully qualified name is returned.

Parameters

targetRef is the target UIDRef.

Returns: target name.

virtual UID IAnimationUtils::GetTimingParentUID ( const UIDRef & targetRef ) const

pure virtual

Returns the timing parent UID that is the also the ancestor for this target page item. Timing parent UID could be the spread or a MSO state.

Parameters

targetRef is the target page item's UIDRef.

Returns: the timing parent UID for this target page item.

Public Types

Public Member Functions

Member Function Documentation