IAnimationAttributeSuite.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 __IAnimationAttributeSuite__
#define __IAnimationAttributeSuite__

#include "ISelectionMessages.h"
#include "AnimationTypes.h"

#include "DynamicDocumentsID.h"

class IAnimationAttributeSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IANIMATIONATTRIBUTESUITE };
 
 //________________________________________________________________________________________
 // Data Types
 //________________________________________________________________________________________
 enum PropertyType {
 kAnimationOpacity = 0,
 kAnimationRotation,
 kAnimationScaleX,
 kAnimationScaleY,
 };

public:

 virtual bool HasMultipleSelections () const = 0;

 virtual ErrorCode ApplyMotionPreset (const UIDRef& presetRef) = 0;
 
 virtual bool CanApplyMotionPreset (void) const = 0;

 virtual bool GetMotionPresetApplied (UID& presetUID) const = 0;

 virtual bool CanApplyAnimation (void) const = 0;

 virtual bool GetBaseMotionPresetNameApplied (PMString& presetName) const = 0;

 virtual bool HasMSOAsTimingParent (bool* pMixed = nil) const = 0;

 virtual bool HasAnimationApplied (bool* pMixed = nil) const = 0;

 virtual bool HasCustomAnimationSettings (bool* pMixed = nil) const = 0;

 virtual void SetShowAnimationProxy (bool turnOn) = 0;

 virtual bool GetShowAnimationProxy () const = 0;

 virtual bool GetName (PMString& name) const = 0;

 virtual bool SetName (const PMString& newName) = 0;

 virtual bool GetAnimationHideInitially (bool& hideInitially) const = 0;

 virtual bool SetAnimationHideInitially (bool hiddenUntilAnimated) = 0;

 virtual bool GetAnimationHideAfter (bool& hideAfter) const = 0;

 virtual bool SetAnimationHideAfter (bool hideAfter) = 0;

 virtual bool GetAnimationDuration (PMReal& duration) const = 0;

 virtual bool SetAnimationDuration (const PMReal& duration) = 0;

 virtual bool SetAnimationPlays (const uint32& numPlays) = 0;

 virtual bool GetAnimationPlays (uint32& numPlays) const = 0;

 virtual bool GetAnimationPlaysLoop (bool& playsLoop) const = 0;

 virtual bool SetAnimationPlaysLoop (bool setToLoop) = 0;

 virtual bool GetApplicableTriggerEvents (std::vector<EventTriggerType>& applicableList) const = 0;

 virtual bool GetNumAnimationTriggerEvents (uint32& numTriggers) const = 0;

 virtual bool GetNthAnimationTriggerEvent (uint32 which, EventTriggerType& trigger) const = 0;

 virtual bool AddAnimationTriggerEvent (const EventTriggerType& triggerEvent) = 0;

 virtual bool RemoveAnimationTriggerEvent (const EventTriggerType& triggerEvent) = 0;

 virtual bool CanReverseAnimationForEvent (const EventTriggerType& triggerEvent) const = 0;

 virtual bool GetReverseAnimationForEvent (const EventTriggerType& trigger, bool& canbeReversed) const = 0;

 virtual bool SetReverseAnimationForEvent (const EventTriggerType& triggerEvent, bool setToReverse) = 0;

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

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

 virtual bool GetAnimationTranformOffsetPoint (PMPoint& offsetPoint) const = 0;

 virtual bool SetAnimationTranformOffsetPoint (const PMPoint& offsetPoint) = 0;

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

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

 virtual bool GetAnimationMotionPath (PMPathPointList& path) const = 0;

 virtual bool SetAnimationMotionPath (const PMPathPointList& path) = 0;

 virtual bool CanSetAnimationMotionPathFromSelection () const = 0;

 virtual bool SetAnimationMotionPathFromSelection () = 0;

 virtual bool CanUpdateAnimationMotionPathFromSelection () const = 0;

 virtual bool UpdateAnimationMotionPathFromSelection () = 0;

 enum {
 kFirstKeyFrame = 0,
 kLastKeyFrame = 0xffffffff
 };

 virtual bool GetTotalNumFrames (uint32& numFrames) const = 0;

 virtual bool GetNumKeyFrames (const PropertyType& propType, uint32& numKeyFrames) const = 0;

 virtual bool GetKeyFrame (const PropertyType& propType, int32 which, uint32& keyframe, PMReal& value) const = 0;

 virtual bool GetValueAtKeyFrame (const PropertyType& propType, uint32 keyframe, PMReal& value) const = 0;
 
 virtual bool SetKeyFrame (const PropertyType& propType, uint32 keyframe, const PMReal& value = 0) = 0;

 virtual bool RemoveKeyFrame (const PropertyType& propType, uint32 keyframe) = 0;

 virtual bool RemoveAllKeyFrames (const PropertyType& propType) = 0;

 virtual bool CanSaveAnimationSettings () const = 0;

 virtual bool SaveAnimationSettings (const PMString& newPresetName) = 0;
 
 virtual bool CanSaveACopyAnimationSettings () const = 0;

 virtual bool SaveACopyAnimationSettings (const IDFile& newPresetFile) = 0;

 virtual bool CanRemoveAnimationPreset () const = 0;

 virtual bool RemoveAnimationPreset () = 0;
};



#endif // __IAnimationAttributeSuite__