IMotionPresetUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#include "DynamicDocumentsID.h"
#include "InstStrokeFillID.h"

#include "WideString.h"
#include "Utils.h"
#include "PMPathPoint.h"

class IMotionPresetMgr;
class IMotionPresetData;
class IAnimationCore;
class ISubject;
class IScriptRequestData;
class IScript;
class GraphicsData;

const PMReal kMotionPathLineWeight = 1.0;
const PMReal kMotionPathDotsWeight = 1.5;
const ClassID kMotionPathArrowHeadBoss = kBarbedArrowHeadBoss;
const ClassID kMotionPathCircleBoss = kCircleSolidArrowHeadBoss;

class IMotionPresetUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IMOTIONPRESETUTILS };
 
 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;
};