IAnimationAttributeData.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// 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.
// 
//========================================================================================

#ifndef __IAnimationAttributeData__
#define __IAnimationAttributeData__

#include "IPMUnknown.h"

#include "IAnimationData.h"
#include "PMPathPoint.h"

class IAnimationAttributeData : public IPMUnknown
{
public:

 enum {kDefaultIID = IID_IANIMATIONATTRIBUTEDATA};

 virtual bool HasAnimation () const = 0;

 virtual bool AddAnimation (UID presetUID, bool populateData = true) = 0;

 virtual bool RemoveAnimation () = 0;

 virtual IAnimationData* CloneAnimation () const = 0;

 virtual const IAnimationData* QueryAnimation () const = 0;

 virtual bool AnimationHasCustomChanges () const = 0;

 virtual bool SetPresetUID (UID presetUID, bool populateData = true) = 0;

 virtual UID GetPresetUID () const = 0;

 virtual bool SetNumPlays (uint32 numPlays) = 0;
 
 virtual uint32 GetNumPlays () const = 0;

 virtual bool GetPlaysLoop () const = 0;

 virtual bool SetPlaysLoop (bool setToLoop) = 0;

 virtual bool SetDuration (const PMReal& durationInSecond) = 0;

 virtual PMReal GetDuration () const = 0;

 virtual bool SetFrameRate (int32 frameRate) = 0;
 
 virtual int32 GetFrameRate () const = 0;

 virtual AnimationOptions GetAnimateOption () const = 0;
 
 virtual bool SetAnimateOption (const AnimationOptions& animateOption) = 0;

 virtual bool GetHideInitially () const = 0;

 virtual bool SetHideInitially (bool setHideInitially) = 0;

 virtual bool GetHideAfter() const = 0;

 virtual bool SetHideAfter (bool setHideAfter) = 0;

 virtual AnimationEaseType GetSimpleEaseType () const = 0;
 
 virtual bool SetSimpleEaseType (const AnimationEaseType& easeType) = 0;

 virtual bool SetTransformOffsetPoint (const PMPoint& offsetPoint) = 0;
 
 virtual PMPoint GetTransformOffsetPoint () const = 0;
 
 virtual bool HasRovingPath () const = 0;

 virtual bool Get2DKeyFramePath (AnimationPathDataList& pathFrames) const = 0;
 
 virtual bool Get2DPathPoints (PMPathPointList& path, bool& pathIsRoving) const = 0;
 
 virtual bool Set2DKeyFramePath (const AnimationPathDataList& path) = 0;
 
 virtual bool Set2DPathPoints (const PMPathPointList& path, bool pathIsRoving) = 0;

 virtual uint32 GetOpacityKeyFrameCount () const = 0;

 virtual bool GetOpacityKeyFrame (uint32 whichKeyframe, uint32& keyframe, PMReal& value) const = 0;
 virtual bool GetOpacityKeyFrame (uint32 keyframe, PMReal& value) const = 0;
 
 virtual bool SetOpacityKeyFrame (uint32 keyframe, const PMReal& value) = 0;
 virtual bool RemoveOpacityKeyFrame (uint32 keyframe) = 0;

 virtual uint32 GetRotationKeyFrameCount () const = 0;
 virtual bool GetRotationKeyFrame (uint32 whichKeyframe, uint32& keyframe, PMReal& value) const = 0;
 virtual bool GetRotationKeyFrame (uint32 keyframe, PMReal& value) const = 0;
 virtual bool SetRotationKeyFrame (uint32 keyframe, const PMReal& value) = 0;
 virtual bool RemoveRotationKeyFrame (uint32 keyframe) = 0;

 virtual uint32 GetScaleXKeyFrameCount () const = 0;
 virtual bool GetScaleXKeyFrame (uint32 whichKeyframe, uint32& keyframe, PMReal& value) const = 0;
 virtual bool GetScaleXKeyFrame (uint32 keyframe, PMReal& value) const = 0;
 virtual bool SetScaleXKeyFrame (uint32 keyframe, const PMReal& value) = 0;
 virtual bool RemoveScaleXKeyFrame (uint32 keyframe) = 0;

 virtual uint32 GetScaleYKeyFrameCount () const = 0;
 virtual bool GetScaleYKeyFrame (uint32 whichKeyframe, uint32& keyframe, PMReal& value) const = 0;
 virtual bool GetScaleYKeyFrame (uint32 keyframe, PMReal& value) const = 0;
 virtual bool SetScaleYKeyFrame (uint32 keyframe, const PMReal& value) = 0;
 virtual bool RemoveScaleYKeyFrame (uint32 keyframe) = 0;

 virtual void CopyAnimation (const IAnimationData* iOther) = 0;
 virtual void Copy (const IAnimationAttributeData* iOtherAtr) = 0;

 virtual bool Equals (const IAnimationAttributeData* iOtherAtr) const = 0;

 virtual void SetCustomData (const bool16 customData) = 0;
};

#endif // __IAnimationAttributeData__