IAnimationCore.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.
// 
//========================================================================================

#ifndef __IAnimationCore_h__
#define __IAnimationCore_h__

#include "IPMUnknown.h"
#include "DynamicDocumentsID.h"
#include "IAnimationData.h"

class IAnimationCore : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IANIMATIONCORE };

 virtual bool SetXMLDescription (const WideString &xmlIn, bool useTimescaleFromXml = false) = 0;
 
 enum MotionXMLOptions
 {
 kDefaultOptions = 0x00,
 
 kStrip3DParameters = 0x01,
 kStripFilters = 0x02,

 kDisableFilters = 0x04
 };

 virtual bool GetXMLDescription (WideString &xmlOut, uint32 options = kDefaultOptions) const = 0;
 
 virtual boost::shared_ptr<uint8> GetMotionXML(size_t &size, uint32 options = kDefaultOptions) const = 0;

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

 virtual PMReal GetDuration () const = 0;

 virtual bool SetFrameRate (int32 frameRatePerSecond) = 0;

 virtual int32 GetFrameRate () const = 0;

 virtual uint32 GetKeyframeForTime (const PMReal& time) const = 0;

 virtual bool PropertiesUsingFancyEase () const = 0;

 virtual bool RemoveAllEase () = 0;

 virtual bool ApplySimpleEaseToAll (const AnimationEaseType& easeType) = 0;
 
 virtual void SetTransformOffsetPoint (const PMPoint& offsetPoint) = 0;

 virtual PMPoint GetTransformOffsetPoint () const = 0;
 
 virtual bool Set2DPath (const AnimationPathDataList& path) = 0;
 
 virtual bool Get2DPath (PMPathPointList& path, bool* pHasRovingPathPoints = nil) const = 0;

 virtual bool Get2DPath (AnimationPathDataList& path) const = 0;

 virtual void SetNew2DBezierPath (const PMPathPointList &path) = 0;

 virtual void RemovePath () = 0;

 virtual void OffsetPath () = 0;

 virtual bool GetPathOffset (double& offsetX, double& offsetY) const = 0;

 virtual void GetMotionPath (std::vector<double>& xValues, std::vector<double>& yValues) const = 0;

 virtual void GetOpacityValues (std::vector<double>& alphaValues) const = 0;

 virtual uint32 GetOpacityKeyFrameCount () const = 0;

 virtual bool GetOpacityKeyFrame (uint32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetOpacityValueAtKeyFrame (uint32 keyframe, PMReal& value) const = 0;

 virtual bool RemoveOpacityValueAtKeyFrame (uint32 keyframe) = 0;

 virtual void RemoveAllOpacityKeyFrames () = 0;

 virtual bool SetOpacityValueAtKeyFrame (uint32 keyframe, const PMReal& value) = 0;

 virtual void GetRotationValues (std::vector<double>& rValues) const = 0;

 virtual uint32 GetRotationKeyFrameCount () const = 0;

 virtual bool GetRotationKeyFrame (uint32 which, uint32& keyframe, PMReal& value) const = 0;
 
 virtual bool GetRotationValueAtKeyFrame (uint32 keyframe, PMReal& value) const = 0;
 virtual bool RemoveRotationValueAtKeyFrame (uint32 keyframe) = 0;

 virtual void RemoveAllRotationKeyFrames () = 0;

 virtual bool SetRotationValueAtKeyFrame (uint32 keyframe, const PMReal& value) = 0;

 virtual void GetScaleValues (std::vector<double>& xValues, std::vector<double>& yValues) const = 0;

 virtual uint32 GetScaleXKeyFrameCount () const = 0;

 virtual bool GetScaleXKeyFrame (uint32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetScaleXValueAtKeyFrame (uint32 keyframe, PMReal& value) const = 0;

 virtual bool RemoveScaleXValueAtKeyFrame (uint32 keyframe) = 0;

 virtual void RemoveAllScaleXKeyFrames () = 0;

 virtual bool SetScaleXValueAtKeyFrame (uint32 keyframe, const PMReal& value) = 0;

 virtual uint32 GetScaleYKeyFrameCount () const = 0;

 virtual bool GetScaleYKeyFrame (uint32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetScaleYValueAtKeyFrame (uint32 keyframe, PMReal& value) const = 0;
 virtual bool RemoveScaleYValueAtKeyFrame (uint32 keyframe) = 0;

 virtual void RemoveAllScaleYKeyFrames () = 0;

 virtual bool SetScaleYValueAtKeyFrame (uint32 keyframe, const PMReal& value) = 0;

 virtual void ReverseAllProperties () = 0;

 virtual void Initialize () = 0;
};


#endif