IDynamicEventTimingMgr.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 __IDynamicEventTimingMgr__
#define __IDynamicEventTimingMgr__

#include "DynamicDocumentsID.h"
#include "IPMUnknown.h"
#include "AnimationTypes.h"
#include "vector"
#include "ScriptData.h"

class IDynamicEventTimingMgr : public IPMUnknown
{ 
public:
 enum {kDefaultIID = IID_IDYNAMICEVENTTIMINGMGR};

 typedef ScriptData TargetDataType;

 class DynamicTarget : boost::noncopyable
 {
 friend class DynamicTargetImpl;
 
 virtual ~DynamicTarget() {}
 
 virtual void AddRef() const = 0;
 virtual void Release() const = 0;
 
 public:
 virtual UID GetTargetUID () const = 0;
 
 virtual uint32 GetRole () const = 0;

 virtual uint32 GetAction () const = 0;

 virtual void SetAction (uint32 targetAction) = 0;

 virtual PMReal GetDelay () const = 0;

 virtual void SetDelay (const PMReal& targetDelay) = 0;

 virtual bool HasData (std::vector<uint32>* pDataIDList = nil) const = 0;

 virtual bool GetData (uint32 dataID, TargetDataType& data) const = 0;
 virtual bool AddData (uint32 dataID, const TargetDataType& data) = 0;

 virtual bool RemoveData (uint32 dataID) = 0;

 public:
 
 friend void intrusive_ptr_add_ref(DynamicTarget *t)
 {
 t->AddRef();
 }
 
 friend void intrusive_ptr_release(DynamicTarget *t)
 {
 t->Release();
 }
 };
 
 typedef boost::intrusive_ptr<DynamicTarget> DynamicTargetPtr;
 typedef std::vector<DynamicTargetPtr> DynamicTargetList;

 enum {kInvalidTimingPosition = 0xffffffff};

 virtual DynamicTargetPtr CreateDynamicTarget (UID targetUID, uint32 role = kTimingTargetRoleDefault, uint32 action = kTimingTargetVerbPlay) = 0;
 virtual DynamicTargetPtr CreateDynamicTarget (const DynamicTargetPtr& target) = 0;
 virtual int32 FindDynamicTarget (const DynamicTargetList& targetlist, DynamicTargetPtr& target) const = 0;

 virtual int32 FindDynamicTarget (const DynamicTargetList& targetList, UID targetUID, DynamicTargetPtr& target) const = 0;
 
 virtual uint32 GetNumDynamicEvents () const = 0;

 virtual bool AddDynamicEvent (const EventTriggerType& newEventTrigger) = 0;

 virtual bool RemoveDynamicEvent (const EventTriggerType& whichTrigger) = 0;

 virtual EventTriggerType GetNthDynamicEvent (uint32 which) const = 0;

 virtual bool RemoveNthGroup (const EventTriggerType& whichTrigger, uint32 which) = 0;

 virtual bool MoveNthGroup (const EventTriggerType& whichTrigger, uint32 which, int32 newPosition) = 0;

 virtual bool GetNthGroupNumPlays (const EventTriggerType& whichTrigger, uint32 which, uint32& numPlays) const = 0;

 virtual bool SetNthGroupNumPlays (const EventTriggerType& whichTrigger, uint32 which, uint32 newNumPlays) = 0;

 virtual bool GetNthGroupPlaysLoop (const EventTriggerType& whichTrigger, uint32 which, bool& playsLoop) const = 0;

 virtual bool SetNthGroupPlaysLoop (const EventTriggerType& whichTrigger, uint32 which, bool playsLoop) = 0;

 virtual uint32 GetNumGroups (const EventTriggerType& whichTrigger) const = 0;

 virtual bool GetNthGroupItems (const EventTriggerType& whichTrigger, uint32 whichGroup, DynamicTargetList& itemList) const = 0;

 virtual bool AddTargetInNthGroup (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItem, int32 atGroup = -1) = 0;

 virtual int32 FindTargetInEvent (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItem, DynamicTargetList& itemList, uint32* pItemPosition = nil) const = 0; 

 virtual bool RemoveTargetInNthGroup (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItem, uint32 which) = 0;

 virtual bool ReplaceTargetInNthGroup (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItemToReplace, const DynamicTargetPtr& newTargetItem, uint32 which) = 0;

 virtual bool ReplaceNthTargetInNthGroup (const EventTriggerType& whichTrigger, uint32 which, uint32 whichTarget, const DynamicTargetPtr& newTargetItem) = 0;

 virtual bool RemoveTargetInEvent (const EventTriggerType& trigger, const DynamicTargetPtr& targetItem) = 0;

 virtual bool RemoveTargetForAllEvents (UID itemUID) = 0;

 virtual bool MoveTargetBeforeNthGroup (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItem, uint32 oldGroup, uint32 beforeGroup) = 0;

 virtual bool MoveTargetAfterNthGroup (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItem, uint32 oldPosition, uint32 afterGroup) = 0;

 virtual bool MoveTargetIntoNthGroupAt (const EventTriggerType& whichTrigger, const DynamicTargetPtr& targetItem, uint32 oldGroup, uint32 atGroup, int32 atPosition = -1) = 0;

 virtual bool MoveNthTargetIntoNthGroupAt (const EventTriggerType& whichTrigger, uint32 oldGroup, uint32 whichTarget, uint32 atGroup, int32 atPosition = -1) = 0;

 virtual bool SetTargetDelayInNthGroup (const EventTriggerType& trigger, const DynamicTargetPtr& targetItem, uint32 whichGroup, const PMReal& delay) = 0;

 virtual bool SetNthTargetDelayInNthGroup (const EventTriggerType& trigger, uint32 whichGroup, uint32 whichTarget, const PMReal& delay) = 0;

 virtual bool GetTargetDelayInNthGroup (const EventTriggerType& trigger, const DynamicTargetPtr& targetItem, uint32 whichGroup, PMReal& delay) const = 0;

 virtual bool SetTargetDataInNthGroup (const EventTriggerType& trigger, const DynamicTargetPtr& targetItem, uint32 whichGroup) = 0;

 virtual bool SetNthTargetDataInNthGroup (const EventTriggerType& trigger, uint32 whichGroup, uint32 whichTarget,const DynamicTargetPtr& newTargetData) = 0;

 virtual IDynamicEventTimingMgr::DynamicTargetPtr GetTargetDataInNthGroup (const EventTriggerType& trigger, const DynamicTargetPtr& targetItem, uint32 whichGroup) const = 0;

 virtual IDynamicEventTimingMgr::DynamicTargetPtr GetNthTargetDataInNthGroup (const EventTriggerType& trigger, uint32 whichGroup, uint32 whichTarget) const = 0;

 virtual void InvalidateTargets (const UIDList& targetList) = 0;

 virtual EventTriggerType ValidateTriggerType (const EventTriggerType& whichTrigger) const = 0;
};

#endif // __IDynamicEventTimingMgr__