Inheritance diagram for Facade::IMotionFacade:

Public Types
enum	{ kDefaultIID = IID_IMOTIONFACADE }

Public Member Functions
virtual ErrorCode	ApplyMotionPresetToPageItems (const UIDRef &presetRef, const UIDList &itemList, bool skipTargeting=false, bool doForceCreateNew=false)=0

virtual ErrorCode	NewMotionPreset (IDataBase *iDB, const PMString &newName, const PMString &newDescription, UID &newPresetUID)=0

virtual ErrorCode	DeleteMotionPreset (const UIDRef &presetRef, bool doShowAlert=true)=0

virtual ErrorCode	DuplicateMotionPreset (const UIDRef &presetRef, const PMString &newPresetName, UID &newPresetUID)=0

virtual ErrorCode	SetMotionPresetMotionData (const UIDRef &presetRef, const WideString &newData)=0

virtual ErrorCode	LoadPresetFromFile (const std::vector< IDFile > &sourceFileList, UID &newPresetUID, bool showAlert=true) const =0

virtual ErrorCode	SavePresetToFile (const UIDRef &presetRef, const IDFile &exportFile) const =0

virtual bool	PresetIsEditLocked (const UIDRef &presetRef) const =0

virtual bool	PresetIsDeleteLocked (const UIDRef &presetRef) 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 ErrorCode Facade::IMotionFacade::ApplyMotionPresetToPageItems	(	const UIDRef &	presetRef,
		const UIDList &	itemList,
		bool	skipTargeting = `false`,
		bool	doForceCreateNew = `false`
	)

pure virtual

Apply specified motion preset to the list of page items.

Parameters

presetRef	is the motion preset to apply
itemList	is the list of page items
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 ErrorCode Facade::IMotionFacade::DeleteMotionPreset	(	const UIDRef &	presetRef,
		bool	doShowAlert = `true`
	)

pure virtual

Delete the specified motion preset from the database's preset list. If it is the application preset list, the corresponding file will be deleted from disk.

Parameters

presetRef	is the preset to update
doShowAlert	is true if to show an alert dialog warning about the deletion.

Returns: the error code.

virtual ErrorCode Facade::IMotionFacade::DuplicateMotionPreset	(	const UIDRef &	presetRef,
		const PMString &	newPresetName,
		UID &	newPresetUID
	)

pure virtual

Duplicate the specified motion preset. A new motion preset xml file will be created for the newly duplicated motion preset in the same folder as the original preset.

Parameters

presetRef	is the preset to duplicate
newPresetName	is the new preset name for the duplicated preset. If empty string is passed in as name, a preset name will be generated using the name of the preset being duplicated with " Copy n" appended at end.
newPresetUID	is the newly duplicated preset UID.

Returns: the error code.

virtual ErrorCode Facade::IMotionFacade::LoadPresetFromFile	(	const std::vector< IDFile > &	sourceFileList,
		UID &	newPresetUID,
		bool	showAlert = `true`
	)		const

pure virtual

Load motion preset from specifiec preset file.

Parameters

sourceFileList	is a list of files to import
showAlert	is true if alert dialog can be shown in case of errors.

Returns: the resulting motion preset object.

virtual ErrorCode Facade::IMotionFacade::NewMotionPreset	(	IDataBase *	iDB,
		const PMString &	newName,
		const PMString &	newDescription,
		UID &	newPresetUID
	)

pure virtual

Returs the animation object for the specified motion preset.

Parameters

iDB	is the data base in which to create the new preset.
newName	is name for the new preset.
newDescription	is description for the new preset.
newPreset	is the preset UID for the newly create preset.

Returns: the error code.

virtual bool Facade::IMotionFacade::PresetIsDeleteLocked ( const UIDRef & presetRef ) const

pure virtual

Returns true if motion preset is delete locked. Default app presets can not be deleted.

Parameters

presetRef is the preset UIDRef

Returns: true if motion preset can be deleted.

virtual bool Facade::IMotionFacade::PresetIsEditLocked ( const UIDRef & presetRef ) const

pure virtual

Returns true if motion preset can be edited. Default app presets are not editable. Custom presets will be editable.

Parameters

presetRef is the preset UIDRef

Returns: true if motion preset can be edited.

virtual ErrorCode Facade::IMotionFacade::SavePresetToFile	(	const UIDRef &	presetRef,
		const IDFile &	exportFile
	)		const

pure virtual

Save the motion preset to a preset file.

Parameters

presetRef	is the motion preset to save.
exportFile	is the preset file to save to.

Returns: kSuccess otherwise an error code.

virtual ErrorCode Facade::IMotionFacade::SetMotionPresetMotionData	(	const UIDRef &	presetRef,
		const WideString &	newData
	)

pure virtual

Update specified motion preset with new motion data.

Parameters

presetRef	is the preset to update
newData	is the new motion data to update from.

Returns: the error code.

Public Types

Public Member Functions

Member Function Documentation