IAnimationFacade.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 "IAnimationCmdData.h"
#include "WideString.h"
#include "Utils.h"

class IAnimationAttributeData;
class IAnimationData;
class ISubject;
class IDocument;

namespace Facade
{
class IAnimationFacade : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IANIMATIONFACADE };
 
 virtual bool PageItemHasAnimation (const UIDRef& pageItemRef) const = 0;

 virtual bool PageItemHasCustomAnimationSettings (const UIDRef& pageItemRef) const = 0;
 
 virtual bool PageItemAndChildrenHaveAnimation (const UIDRef& pageItemRef, UIDList* pAnimationList = nil) const = 0;

 virtual ErrorCode SetPageItemMotionPreset (const UIDRef& pageItemRef, const UIDRef& presetRef, bool skipTargeting = false, bool doForceCreateNew = false) = 0;
 
 virtual UIDRef GetPageItemMotionPreset (const UIDRef& pageItemRef) const = 0;

 virtual PMReal GetPageItemAnimationDuration (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationDuration (const UIDRef& pageItemRef, const PMReal& duration) = 0;

 virtual PMPoint GetPageItemAnimationTransformOffsetPoint (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationTransformOffsetPoint (const UIDRef& pageItemRef, const PMPoint& offsetPoint) = 0;

 virtual AnimationOptions GetPageItemAnimationOption (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationOption (const UIDRef& pageItemRef, const AnimationOptions& animateOption) = 0;

 virtual bool GetPageItemAnimationHideInitially(const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationHideInitially (const UIDRef& pageItemRef, bool setHiddenTillAnimated) = 0;

 virtual bool GetPageItemAnimationHideAfter (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationHideAfter (const UIDRef& pageItemRef, bool setHiddenAfterAnimated) = 0;

 virtual uint32 GetPageItemAnimationPlays (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationPlays (const UIDRef& pageItemRef, uint32 numPlays) = 0;

 virtual bool GetPageItemAnimationPlaysLoop (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationPlaysLoop (const UIDRef& pageItemRef, bool setToLoop) = 0;

 virtual AnimationEaseType GetPageItemAnimationSimpleEaseType (const UIDRef& pageItemRef) const = 0;

 virtual bool SetPageItemAnimationSimpleEaseType (const UIDRef& pageItemRef, const AnimationEaseType& easeType) = 0;

 virtual bool GetPageItemAnimationMotionPath (const UIDRef& pageItemRef, AnimationPathDataList& path) const = 0;

 virtual bool SetPageItemAnimationMotionPath (const UIDRef& pageItemRef, const AnimationPathDataList& path) = 0;

 virtual bool GetPageItemAnimationMotionPath (const UIDRef& pageItemRef, PMPathPointList& path) const = 0;

 virtual bool SetPageItemAnimationMotionPath (const UIDRef& pageItemRef, const PMPathPointList& path) = 0;

 virtual bool SetPageItemAnimationMotionPath (const UIDRef& pageItemRef, const UIDRef& sourcePageItemRef, bool bDeleteItem) = 0;

 virtual UIDRef CreateAnimationMotionPathPageItem(const UIDRef& pageItemRef) = 0;

 virtual ErrorCode DeleteAnimationMotionPathPageItemData(IDocument* document, bool16 bDeleteItem) = 0;

 virtual bool SyncPageItemWithMotionPath(const UIDRef& pageItemRef, const UIDRef& motionPathPageItemRef) = 0;
 
 virtual bool IsPageItemMotionPathPageItem (const UIDRef& pageItemRef) const = 0;

 virtual uint32 GetPageItemAnimationOpacityKeyFrameCount (const UIDRef& pageItemRef) const = 0;

 virtual bool GetPageItemAnimationOpacityKeyFrame (const UIDRef& pageItemRef, int32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetPageItemAnimationOpacityValueAtKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, PMReal& value) const = 0;
 
 virtual bool SetPageItemAnimationOpacityKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, const PMReal& value = 0) = 0;

 virtual bool RemovePageItemAnimationOpacityKeyFrame (const UIDRef& pageItemRef, uint32 keyframe) = 0;

 virtual bool RemovePageItemAnimationOpacityAllKeyFrames (const UIDRef& pageItemRef) = 0;
 
 virtual uint32 GetPageItemAnimationRotationKeyFrameCount (const UIDRef& pageItemRef) const = 0;

 virtual bool GetPageItemAnimationRotationKeyFrame (const UIDRef& pageItemRef, int32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetPageItemAnimationRotationValueAtKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, PMReal& value) const = 0;
 
 virtual bool SetPageItemAnimationRotationKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, const PMReal& value = 0) = 0;

 virtual bool RemovePageItemAnimationRotationKeyFrame (const UIDRef& pageItemRef, uint32 keyframe) = 0;

 virtual bool RemovePageItemAnimationRotationAllKeyFrames (const UIDRef& pageItemRef) = 0;

 virtual uint32 GetPageItemAnimationScaleXKeyFrameCount (const UIDRef& pageItemRef) const = 0;

 virtual bool GetPageItemAnimationScaleXKeyFrame (const UIDRef& pageItemRef, int32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetPageItemAnimationScaleXValueAtKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, PMReal& value) const = 0;
 
 virtual bool SetPageItemAnimationScaleXKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, const PMReal& value = 0) = 0;

 virtual bool RemovePageItemAnimationScaleXKeyFrame (const UIDRef& pageItemRef, uint32 keyframe) = 0;

 virtual bool RemovePageItemAnimationScaleXAllKeyFrames (const UIDRef& pageItemRef) = 0;

 virtual uint32 GetPageItemAnimationScaleYKeyFrameCount (const UIDRef& pageItemRef) const = 0;

 virtual bool GetPageItemAnimationScaleYKeyFrame (const UIDRef& pageItemRef, int32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetPageItemAnimationScaleYValueAtKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, PMReal& value) const = 0;
 
 virtual bool SetPageItemAnimationScaleYKeyFrame (const UIDRef& pageItemRef, uint32 keyframe, const PMReal& value = 0) = 0;

 virtual bool RemovePageItemAnimationScaleYKeyFrame (const UIDRef& pageItemRef, uint32 keyframe) = 0;

 virtual bool RemovePageItemAnimationScaleYAllKeyFrames (const UIDRef& pageItemRef) = 0;

 virtual ErrorCode UpdatePageItemAnimationData (const UIDRef& pageItemRef, const IAnimationData* iNewAnimaData, const uint32& dataSetFlags, bool skipTargeting = false) = 0;
 
 virtual ErrorCode AddPageItemAnimation (const UIDRef& pageItemRef, const IAnimationData* iNewAnimaData, const uint32& dataSetFlags, bool skipTargeting = false) = 0;
 
 virtual ErrorCode RemovePageItemAnimation (const UIDRef& pageItemRef) = 0;

 virtual ErrorCode RemovePageItemAndChildrenAnimation (const UIDRef& pageItemRef) = 0;

 virtual ErrorCode SavePageItemAnimation (const UIDRef& pageItemRef, const PMString& newPresetName, UIDRef& newCustomRef, bool doApply = true) = 0;

 virtual ErrorCode SaveACopyPageItemAnimation (const UIDRef& pageItemRef, const IDFile& newPresetFile) = 0;
};

}; // namespace