IDynamicEventTimingSuite.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 __IDynamicEventTimingSuite__
#define __IDynamicEventTimingSuite__

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

#include "DynamicDocumentsID.h"
#include "IDynamicEventTimingMgr.h"

class IDynamicEventTimingSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDYNAMICEVENTTIMINGSUITE};
 

public:

 //________________________________________________________________________________
 //________________________________________________________________________________

 virtual bool HasMultipleSelections () const = 0;

 virtual bool CanApply () const = 0;

 virtual ClassID GetTimingParentClassID () const = 0;

 virtual void GetApplicableDynamicEvents(const EventTriggerType& trigger, std::vector<EventTriggerType>& eventTriggerTypeList) const = 0;

 virtual void GetApplicableDynamicEventsForTarget (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, std::vector<EventTriggerType>& eventTriggerTypeList) const = 0;

 virtual uint32 GetNumDynamicEvents () const = 0;

 virtual EventTriggerType GetNthDynamicEvent (uint32 which) const = 0;

 virtual uint32 GetNumGroupsInEvent (const EventTriggerType& trigger) const = 0;

 virtual bool GetNthGroupInEvent (const EventTriggerType& trigger, uint32 which, IDynamicEventTimingMgr::DynamicTargetList& itemList) const = 0;

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

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

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

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

 virtual bool UnlinkNthGroupInEvent (const EventTriggerType& trigger, uint32 which) = 0;
 
 virtual bool MoveNthGroupInEvent (const EventTriggerType& trigger, uint32 which, int32 newGroup = -1) = 0;

 virtual bool MoveNthGroupToInEventAt (const EventTriggerType& trigger, uint32 which, uint32 newGroup, int32 atPosition = -1) = 0;

 virtual bool AddTargetInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget) = 0;

 virtual bool RemoveTargetInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 whichGroup) = 0;

 virtual bool RemoveTargetInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget) = 0;

 virtual bool CanMoveTargetInEvent (const EventTriggerType& trigger) const = 0;

 virtual bool MoveTargetBeforeInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 oldGroup, uint32 beforeGroup) = 0;

 virtual bool MoveTargetAfterInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 oldGroup, uint32 afterGroup) = 0;

 virtual bool MoveTargetToInEventAt (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 oldGroup, uint32 atGroup, int32 at) = 0;

 virtual bool SetTargetDelayInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which, const PMReal& delay) = 0;

 virtual PMReal GetTargetDelayInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) const = 0;

 virtual int32 FindTargetInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32& position) const = 0;

 virtual bool UnlinkTargetInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetPtr& dynamicTarget, uint32 which) = 0;

 virtual bool GroupTargetsInEvent (const EventTriggerType& trigger, const IDynamicEventTimingMgr::DynamicTargetList& targetList, uint32 newGroup) = 0;

 virtual bool GetUnassignedTargets (std::vector<UID>& unassignedTargetList) const = 0;

 virtual bool ReassignEventForTargets (const EventTriggerType& trigger, const EventTriggerType& newTrigger, const IDynamicEventTimingMgr::DynamicTargetList& targetList) const = 0;

};



#endif // __IDynamicEventTimingSuite__