Inheritance diagram for IMotionPresetUtils:

Public Types
enum	{ kDefaultIID = IID_IMOTIONPRESETUTILS }

Public Member Functions
virtual IMotionPresetMgr *	QueryMotionPresetManager (IDataBase *iDB=nil) const =0

virtual ErrorCode	CopyMotionPresetData (const IMotionPresetData iSrcPreset, IMotionPresetData iDstPreset) const =0

virtual IMotionPresetData *	QueryPageItemPresetData (const UIDRef &pageItemRef, int32 whichAnimation)=0

virtual IPMUnknown *	QueryPageItemAnimationData (const UIDRef &pageItemRef)=0

virtual UID	GetPageItemAnimationPresetUID (const UIDRef &pageItemRef) const =0

virtual IAnimationCore *	CreateAnimationCore (const UIDRef &presetRef=UIDRef::gNull)=0

virtual ErrorCode	SetMotionPresetSettings (const UIDRef &presetRef, bool doSetName, const PMString &newName, bool doSetDescription, const PMString &newDescription)=0

virtual ErrorCode	ConstructMotionXMLDataFromMotionData (const WideString &rawString, boost::shared_ptr< uint8 > &xmlBuffer, size_t &size)=0

virtual ErrorCode	ValidatePresetName (IMotionPresetMgr *iPresetMgr, const PMString &presetName) const =0

virtual ISubject *	QueryPresetWorkspaceSubject (IDataBase *iDB) const =0

virtual IMotionPresetMgr *	QueryMotionPresetManagerFromScript (const IScriptRequestData data, IScript script) const =0

virtual void	GetMotionPathPoints (const UIDRef &pageItemRef, PMPathPointList &motionPath, PMPathPointList &easingPath)=0

virtual PMMatrix	FlashToInnerMatrix (const UIDRef &pageItemRef)=0

virtual void	DrawMotionPaths (GraphicsData *gd, const UIDRef &pageItemRef)=0

virtual void	CreateMotionPath (GraphicsData *gd, const PMPathPointList &motionPath)=0

virtual void	CreateEasingPath (GraphicsData *gd, const PMPathPointList &easingPath)=0

virtual bool	GetPresetGroupName (const PMString &presetName, PMString &presetGroupName)=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 ErrorCode IMotionPresetUtils::ConstructMotionXMLDataFromMotionData	(	const WideString &	rawString,
		boost::shared_ptr< uint8 > &	xmlBuffer,
		size_t &	size
	)

pure virtual

Construct the motion xml data from the specified motion preset data.

Parameters

rawString	is the motion preset data. It's the preset's xml description.
xmlBuffer	is the shared buffer containing the motion xml data.
size	is the size of the buffer

Returns: kSuccess or an error code.

virtual ErrorCode IMotionPresetUtils::CopyMotionPresetData	(	const IMotionPresetData *	iSrcPreset,
		IMotionPresetData *	iDstPreset
	)		const

pure virtual

Copy motion preset data.

Parameters

iSrcPreset	is the source preset data to copy from.
iDstPreset	is the preset to which the data is to be copied. If iDstPreset does not have edit privilege, then nothing is copied.

virtual IAnimationCore* IMotionPresetUtils::CreateAnimationCore ( const UIDRef & presetRef = UIDRef::gNull )

pure virtual

Returs the animation object for the specified motion preset.

Parameters

presetRef is the motion preset. If it is null, then an empty animation object is created.

Returns: the animation object for the specified motion preset.

virtual void IMotionPresetUtils::CreateEasingPath	(	GraphicsData *	gd,
		const PMPathPointList &	easingPath
	)

pure virtual

Given a list of path points for the easing path, create the path using the graphics data. Caller must still call gPort->stroke()

Parameters

gd	[IN] The graphics data to draw to
easingPath	[IN] A list of PMPathPoints for the easing path

virtual void IMotionPresetUtils::CreateMotionPath	(	GraphicsData *	gd,
		const PMPathPointList &	motionPath
	)

pure virtual

Given a list of path points for the motion path, create the path using the graphics data. Caller must still call gPort->stroke()

Parameters

gd	[IN] The graphics data to draw to
motionPath	[IN] A list of PMPathPoints for the easing path

virtual void IMotionPresetUtils::DrawMotionPaths	(	GraphicsData *	gd,
		const UIDRef &	pageItemRef
	)

pure virtual

Given an item interface, draw its motion paths for "motion" and "easing".

Parameters

gd	[IN] The graphics data to draw to
pageItemRef	[IN] is the UIDRef of the page item with motion data.

virtual PMMatrix IMotionPresetUtils::FlashToInnerMatrix ( const UIDRef & pageItemRef )

pure virtual

Given an item interface that has motion applied, return a matrix that will map to inner coordinates for the item. The offset point (GetPageItemAnimationTransformOffsetPoint) is taken into account.

Parameters

pageItemRef [IN] is the UIDRef of the page item with motion data.

Returns: PMMatrix a matrix that will map to inner coordinates for the item.

See Also: FlashToInnerMatrix to convert from "flash" coordinates to inner coordinates for the page item.; GetMotionPathPoints, typically this matrix could be applied to the points in order to draw, hittest, etc.

virtual void IMotionPresetUtils::GetMotionPathPoints	(	const UIDRef &	pageItemRef,
		PMPathPointList &	motionPath,
		PMPathPointList &	easingPath
	)

pure virtual

Given an item interface, fill in a list of PMPathPoints for its easing path and motion path. The points are returned in "flash" coordinate space. This means aligned with the spread, with the 0, 0 point at the upper left of the page item, and 72dpi. The animation offset has not yet been applied. Will return empty lists of item doesn't have motion data associated with it.

Parameters

pageItemRef	[IN] is the UIDRef of the page item with motion data.
motionPath	[OUT] A list of PMPathPoints representing the motion path
easingPath	[OUT] A list of PMPathPoints representing the easing path

See Also: FlashToInnerMatrix to convert from "flash" coordinates to inner coordinates for the page item.

virtual UID IMotionPresetUtils::GetPageItemAnimationPresetUID ( const UIDRef & pageItemRef ) const

pure virtual

Returns the motion preset UID for the specified pageitem's which animation.

Parameters

pageItemRef is the page item.

Returns: the motion preset UID.

virtual bool IMotionPresetUtils::GetPresetGroupName	(	const PMString &	presetName,
		PMString &	presetGroupName
	)

pure virtual

Given a preset name, return the group name that it resides. The group name may be empty indicating the preset does not belong to a group or that it was not found in the current list of presets.

Parameters

presetName	[IN] is the preset name.
presetGroupName	[OUT] is the preset's group name.

Returns: bool whether or not the preset name was found.

virtual IMotionPresetMgr* IMotionPresetUtils::QueryMotionPresetManager ( IDataBase * iDB = nil ) const

pure virtual

Returs the motion preset manager for the specified database.

Parameters

iDB	is the data base

Returns: IMotionPresetMgr for the specified database.

virtual IMotionPresetMgr* IMotionPresetUtils::QueryMotionPresetManagerFromScript	(	const IScriptRequestData *	data,
		IScript *	script
	)		const

pure virtual

Query for the preset manager from the specified IScript.

Parameters

data	is the script reset data. This is need to establish the request context.
script	is the script interface interested.

Returns: the pointer to IMotionPresetMgr.

virtual IPMUnknown* IMotionPresetUtils::QueryPageItemAnimationData ( const UIDRef & pageItemRef )

pure virtual

Returns the animation data for the given page item.

Parameters

pageItemRef	is the page item.
whichAnimation	is the nth animation attached to the page item.

Returns: the animation attribute data for this page item.

virtual IMotionPresetData* IMotionPresetUtils::QueryPageItemPresetData	(	const UIDRef &	pageItemRef,
		int32	whichAnimation
	)

pure virtual

Returns the motion preset data for the given page item's which animation.

Parameters

pageItemRef	is the page item.
whichAnimation	is the nth animation attached to the page item.

Returns: the motion preset data interface for this page item.

virtual ISubject* IMotionPresetUtils::QueryPresetWorkspaceSubject ( IDataBase * iDB ) const

pure virtual

Query the preset manager's workspace subject

Parameters

iDB	is the workspace database.

Returns: the pointer to ISubject for the preset manager subject

virtual ErrorCode IMotionPresetUtils::SetMotionPresetSettings	(	const UIDRef &	presetRef,
		bool	doSetName,
		const PMString &	newName,
		bool	doSetDescription,
		const PMString &	newDescription
	)

pure virtual

Sets the motion preset's name and description

Parameters

presetRef	is UIDRef of the preset to change.
doSetName	is true is setting a new name
newName	is new name for the preset.
doSetDescription	is true is setting a new description
newDescription	is new description for the preset.

Returns: the error code.

virtual ErrorCode IMotionPresetUtils::ValidatePresetName	(	IMotionPresetMgr *	iPresetMgr,
		const PMString &	presetName
	)		const

pure virtual

Validate the given preset name

Parameters

iPresetMgr	is the motion preset manager to validate against.
presetName	is the preset name to validate.

Returns: kSuccess otherwise an error code.

Public Types

Public Member Functions

Member Function Documentation