IDynamicEventAndTimingCmdData.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 __IDynamicEventAndTimingCmdData__
#define __IDynamicEventAndTimingCmdData__

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


class IDynamicEventAndTimingCmdData : public IPMUnknown
{
public:

 enum {kDefaultIID = IID_IEVENTTRIGGERANDTIMINGCMDDATA};

 virtual void SetOwnerUIDRef (const UIDRef& ownerRef) = 0;
 
 virtual UIDRef GetOwnerUIDRef () const = 0;

 virtual void SetEventTrigger (const EventTriggerType& trigger) = 0;
 
 virtual EventTriggerType GetEventTrigger () const = 0;

 virtual void SetTargetItemList (const IDynamicEventTimingMgr::DynamicTargetList& targetList) = 0;
 
 virtual const IDynamicEventTimingMgr::DynamicTargetList& GetTargetItemList () const = 0;

 virtual void SetTimingPosition (int32 groupPosition) = 0;
 
 virtual int32 GetTimingPosition () const = 0;

 virtual void SetTargetPosition (int32 targetPosition) = 0;
 
 virtual int32 GetTargetPosition () const = 0;

 enum MoveType {
 kMoveNone,

 kMoveBefore, 

 kMoveTo, 

 kMoveAfter
 };

 virtual void SetMove (const MoveType& moveType, uint32 newPosition, int32 newPositionInGroup = -1) = 0;

 virtual MoveType GetMoveType () const = 0;;

 virtual int32 GetNewTimingPosition () const = 0;

 virtual int32 GetNewTimingPositionInGroup () const = 0;

 virtual void SetNewTargetItem (const IDynamicEventTimingMgr::DynamicTargetPtr& newTarget) = 0;
 
 virtual const IDynamicEventTimingMgr::DynamicTargetPtr& GetNewTargetItem () const = 0;

 virtual void SetNewTargetItemUID (UID newItemUID) = 0;
 
 virtual UID GetNewTargetItemUID () const = 0;

 virtual void SetTimeDelay (const PMReal& delay) = 0;
 
 virtual PMReal GetTimeDelay () const = 0;

 virtual bool GetTimeDelayIsSet () const = 0;

 enum RemoveTargetOptions {
 kNoAction, 
 kDisableAction, 

 kRemoveAction,

 kClearTarget
 };

 virtual void SetButtonTargetRemoveOption (const RemoveTargetOptions& removeOption) = 0;
 
 virtual RemoveTargetOptions GetButtonTargetRemoveOption () const = 0;


 virtual void SetGroupPlayData (bool setNumPlay, const uint32& numPlays, bool setLooping, bool playsLoop) = 0;
 
 virtual bool GetNumPlays (uint32& numPlays) const = 0;

 virtual bool GetPlaysLoop (bool& playsLoop) const = 0;
};

#endif // __IDynamicEventAndTimingCmdData__