#include <IDynamicEventTimingFacade.h>

Inheritance diagram for Facade::IDynamicEventTimingFacade:

Public Types
enum	{ kDefaultIID = IID_IDYNAMICEVENTTIMINGFACADE }

Public Member Functions
virtual IDynamicEventTimingMgr::DynamicTargetPtr	CreateDynamicTarget (const UIDRef &ownerRef, const UIDRef &targetRef, uint32 role=kTimingTargetRoleDefault, uint32 action=kTimingTargetVerbPlay)=0

virtual IDynamicEventTimingMgr::DynamicTargetPtr	CreateDynamicTarget (const UIDRef &targetRef, uint32 role=kTimingTargetRoleDefault, uint32 action=kTimingTargetVerbPlay)=0

virtual IDynamicEventTimingMgr::DynamicTargetPtr	CreateDynamicTarget (const UIDRef &targetOrOwnerRef, const IDynamicEventTimingMgr::DynamicTargetPtr &targetPtr)=0

virtual int32	FindDynamicTarget (const UIDRef &ownerRef, const IDynamicEventTimingMgr::DynamicTargetList &targetlist, IDynamicEventTimingMgr::DynamicTargetPtr &target) const =0

virtual bool	DynamicTargetTriggeredByPageEvents (const UIDRef &itemRef, std::vector< EventTriggerType > *eventList=nil) const =0

virtual int32	FindDynamicEvent (const UIDRef &ownerRef, const EventTriggerType &trigger) const =0

virtual bool	RemoveDynamicEvent (const UIDRef &ownerRef, const EventTriggerType &trigger) const =0

virtual uint32	GetNumDynamicEvents (const UIDRef &ownerRef) const =0

virtual EventTriggerType	GetNthDynamicEvent (const UIDRef &ownerRef, uint32 which) const =0

virtual uint32	GetNumGroupsInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger) const =0

virtual bool	GetNthGroupItemsInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, uint32 which, IDynamicEventTimingMgr::DynamicTargetList &itemList) const =0

virtual uint32	GetNthGroupNumPlaysInEvent (const UIDRef &ownerRef, const EventTriggerType &whichTrigger, uint32 which) const =0

virtual bool	SetNthGroupNumPlaysInEvent (const UIDRef &ownerRef, const EventTriggerType &whichTrigger, uint32 which, uint32 newNumPlays)=0

virtual bool	GetNthGroupPlaysLoopInEvent (const UIDRef &ownerRef, const EventTriggerType &whichTrigger, uint32 which) const =0

virtual bool	SetNthGroupPlaysLoopInEvent (const UIDRef &ownerRef, const EventTriggerType &whichTrigger, uint32 which, bool playsLoop)=0

virtual bool	MoveNthGroupInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, uint32 which, int32 newPosition) const =0

virtual bool	RemoveNthGroupInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, uint32 which) const =0

virtual bool	UnlinkNthGroupInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, uint32 which) const =0

virtual bool	AddTargetInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, int32 at=-1) const =0

virtual bool	ReplaceTargetInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &targetToReplace, const IDynamicEventTimingMgr::DynamicTargetPtr &newTarget, uint32 whichGroup) const =0

virtual bool	RemoveTargetInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 which) const =0

virtual bool	RemoveTargetInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, const UIDRef &targetRef) const =0

virtual bool	MoveTargetBeforeNthGroupInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 oldGroup, uint32 beforeGroup) const =0

virtual bool	MoveTargetAfterNthGroupInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 oldGroup, uint32 afterGroup) const =0

virtual bool	MoveTargetIntoNthGroupAt (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 oldGroup, uint32 atGroup, int32 at=-1) const =0

virtual bool	SetTargetDelayInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 which, const PMReal &delay) const =0

virtual PMReal	GetTargetDelayInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 which) const =0

virtual IDynamicEventTimingMgr::DynamicTargetPtr	GetTargetDataInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 which) const =0

virtual bool	SetTargetDataInNthGroup (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 which) const =0

virtual bool	GroupTargetsInEvent (const UIDRef &ownerRef, const EventTriggerType &trigger, const IDynamicEventTimingMgr::DynamicTargetList &targetList, int32 newGroup) const =0

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

virtual int32	FindTargetInEvent (const UIDRef &ownerRef, const EventTriggerType &whichTrigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, IDynamicEventTimingMgr::DynamicTargetList &itemList, uint32 *pItemPosition=nil) const =0

virtual int32	FindTargetInNthGroup (const UIDRef &ownerRef, const EventTriggerType &whichTrigger, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget, uint32 which) const =0

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

virtual bool	DynamicTargetIsSelfTriggered (const UIDRef &itemRef) const =0

virtual EventTriggerType	GetSelfClickRolloverItemDynamicEvent (const UIDRef &itemRef) const =0

virtual bool	AddSelfClickRolloverDynamicEventToItem (const UIDRef &itemRef, const EventTriggerType &trigger) const =0

virtual bool	RemoveSelfClickRolloverDynamicEventFromItem (const UIDRef &itemRef, const EventTriggerType &trigger) const =0

virtual bool	SetSelfClickRolloverItemDelay (const UIDRef &itemRef, const PMReal &delay) const =0

virtual PMReal	GetSelfClickRolloverItemDelay (const UIDRef &itemRef) const =0

virtual bool	SetSelfClickRolloverItemTargetData (const UIDRef &itemRef, const IDynamicEventTimingMgr::DynamicTargetPtr &dynamicTarget) const =0

virtual IDynamicEventTimingMgr::DynamicTargetPtr	GetSelfClickRolloverItemTargetData (const UIDRef &itemRef) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This facade provides services for managing one or more timing lists. A timing list is a play list consists of targets (page items) triggered by an animation, page event, a MSO object, or button action event. Targets can be animated objects, videos, and sounds. Targets can be grouped to play simultaneous or play sequential.

See Also: IDynamicEventTimingMgr.h for more detail.

NOTE: Do not call dynamic event timing related commands directly. All manipulation on the timing manager should be called either through this facade or other related facades and utility interfaces. For selection related access, use IDynamicEventTimingSuite.h

See Also: IDynamicEventTimingSuite.h

Member Function Documentation

virtual bool Facade::IDynamicEventTimingFacade::AddSelfClickRolloverDynamicEventToItem	(	const UIDRef &	itemRef,
		const EventTriggerType &	trigger
	)		const

pure virtual

Add self click or rollover to item. These two events are mutually exclusive. If self click is already added, then adding self rollover will replace self click. If self rollover is already added, then adding self click will replace self rollover.

Parameters

itemRef	is the item to add.
trigger	is the event to add item to.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::AddTargetInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		int32	at = `-1`
	)		const

pure virtual

Add target item to the owner's dynamic event. This target item is added at the end of the list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the event to add target item to.
dynamicTarget	is the item to add. If target's delay or data is set, they will be copied.
at	is the group (position) to add the item into. Default is -1 which mean to add the item as a new group at the end.

Returns: true if successful otherwise return false.

virtual IDynamicEventTimingMgr::DynamicTargetPtr Facade::IDynamicEventTimingFacade::CreateDynamicTarget	(	const UIDRef &	ownerRef,
		const UIDRef &	targetRef,
		uint32	role = `kTimingTargetRoleDefault`,
		uint32	action = `kTimingTargetVerbPlay`
	)

pure virtual

Dynamic target data methods.Construct a DynamicTargetPtr based on the specified UID, role, and action.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
targetUID	is the targetUID. For button targets, this UID is action UID.
role	is the target's role.
action	is the target's action.

Returns: DynamicTargetPtr for this target.

virtual IDynamicEventTimingMgr::DynamicTargetPtr Facade::IDynamicEventTimingFacade::CreateDynamicTarget	(	const UIDRef &	targetRef,
		uint32	role = `kTimingTargetRoleDefault`,
		uint32	action = `kTimingTargetVerbPlay`
	)

pure virtual

Construct a DynamicTargetPtr based on another DynamicTarget object.

Parameters

targetRef	is the UIDRef of the target. For button targets, this is the button action UIDRef.
role	is the target's role.
action	is the target's action.

Returns: DynamicTargetPtr for this target.

virtual IDynamicEventTimingMgr::DynamicTargetPtr Facade::IDynamicEventTimingFacade::CreateDynamicTarget	(	const UIDRef &	targetOrOwnerRef,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	targetPtr
	)

pure virtual

Construct a DynamicTargetPtr from another DynamicTarget

Parameters

targetOrOwnerRef	is a targetRef or ownerRef.
targetPtr	is a dynamic target to create from.

Returns: DynamicTargetPtr for this target.

virtual bool Facade::IDynamicEventTimingFacade::DynamicTargetIsSelfTriggered ( const UIDRef & itemRef ) const

pure virtual

Self-click and rolloverReturns true if specified object is self-tirggered.

Parameters

itemRef is the object's UIDRef.

Returns: true is item is self-triggered.

virtual bool Facade::IDynamicEventTimingFacade::DynamicTargetTriggeredByPageEvents	(	const UIDRef &	itemRef,
		std::vector< EventTriggerType > *	eventList = `nil`
	)		const

pure virtual

Spread, MSO, or button events:Return true if specified target is triggered by page load or page click or both page trigger events.

Parameters

itemRef	is the UIDRef of the target.
eventList	is the optional list of page trigger events the item is in.

Returns: true if target is triggered by page events.

virtual int32 Facade::IDynamicEventTimingFacade::FindDynamicEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger
	)		const

pure virtual

Returns the owner's dynamic event index.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the event to find.

Returns: the event trigger index or -1 if this event trigger is not found.

virtual int32 Facade::IDynamicEventTimingFacade::FindDynamicTarget	(	const UIDRef &	ownerRef,
		const IDynamicEventTimingMgr::DynamicTargetList &	targetlist,
		IDynamicEventTimingMgr::DynamicTargetPtr &	target
	)		const

pure virtual

Find the specified dynamic target in the list. The target is considered equal if target's UID, role, and action are equal.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
targetlist	is the list of DynamicTarget objects to search.
target	is the DynamicTarget object to find. If found, the content of the dynamic target from the list is copied.

Returns: the index of the dynamic target in the list. If not found, index is set to -1.

virtual int32 Facade::IDynamicEventTimingFacade::FindTargetInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	whichTrigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		IDynamicEventTimingMgr::DynamicTargetList &	itemList,
		uint32 *	pItemPosition = `nil`
	)		const

pure virtual

Find the target in the specified event triggered timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
whichTrigger	is the event trigger.
dynamicTarget	is the target item to find in this triggering event.
itemList	is the entire item list at this position. dynamicTarget must be a member of this list. The list reflects the sequence of items for their group.
pItemPosition,if	not nil, contains the position of the dynamicTarget in the itemList.

Returns: the position or the nth group in which the dynamicTarget is found. Returns -1 if dynamicTarget is not found in the list.

virtual int32 Facade::IDynamicEventTimingFacade::FindTargetInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	whichTrigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which
	)		const

pure virtual

Find the target in the nth group of the specified event triggered timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
whichTrigger	is the event trigger.
dynamicTarget	is the target item to find in this triggering event.
which	is the group to search.

Returns: the position or the item whithin the specified group. Returns -1 if itemUID is not found in this group.

virtual EventTriggerType Facade::IDynamicEventTimingFacade::GetNthDynamicEvent	(	const UIDRef &	ownerRef,
		uint32	which
	)		const

pure virtual

Get nth dynamic events for the specified owning ref.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
which	is the nth dynamic event to get.

Returns: the event trigger.

virtual bool Facade::IDynamicEventTimingFacade::GetNthGroupItemsInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		uint32	which,
		IDynamicEventTimingMgr::DynamicTargetList &	itemList
	)		const

pure virtual

Get timing item list the nth position for the owner's dynamic event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the item is in.
which	is the nth item in teh dynamic event timing list to get.
itemList	is the list containing one or more target items in nth position of the timing list.

Returns: true if successful otherwise return false.

virtual uint32 Facade::IDynamicEventTimingFacade::GetNthGroupNumPlaysInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	whichTrigger,
		uint32	which
	)		const

pure virtual

Gets the specified event trigger's nth item's number of plays.

Note: : For items that are targets of button actions, they are referenced directly by the buttons.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
whichTrigger	is the event trigger to remove.
which	is the group item.
numPlays	is the number of times this group plays.

Returns: true if successful; other retruns false.

virtual bool Facade::IDynamicEventTimingFacade::GetNthGroupPlaysLoopInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	whichTrigger,
		uint32	which
	)		const

pure virtual

Gets whether or not the specified event trigger's nth item is looping.

Note: : For items that are targets of button actions, they are referenced directly by the buttons.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
whichTrigger	is the event trigger to remove.
which	is the group item.
playsLoop	is true if group loops.

Returns: true if successful; other retruns false.

virtual uint32 Facade::IDynamicEventTimingFacade::GetNumDynamicEvents ( const UIDRef & ownerRef ) const

pure virtual

Get number of dynamic events for the specified owning ref.

Parameters

ownerRef is the UIDRef of spread, button, or MSO.

Returns: the number of event triggers

virtual uint32 Facade::IDynamicEventTimingFacade::GetNumGroupsInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger
	)		const

pure virtual

Get number of items in the owner's dynamic event timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the item is in.

Returns: the number of items

virtual PMReal Facade::IDynamicEventTimingFacade::GetSelfClickRolloverItemDelay ( const UIDRef & itemRef ) const

pure virtual

Get item delay for the self triggered item.

Parameters

itemRef is the item to set.

Returns: the time delay.

virtual EventTriggerType Facade::IDynamicEventTimingFacade::GetSelfClickRolloverItemDynamicEvent ( const UIDRef & itemRef ) const

pure virtual

Get ths item's dynamic event if any. This should be one of kOnSelfClcik or kOnSelfRollover. These two events are mutually exclusive.

Parameters

itemRef is the item's UIDRef.

Returns: the item's dynamic event if any. If none, then kNoTriggerEvent is returned.

virtual IDynamicEventTimingMgr::DynamicTargetPtr Facade::IDynamicEventTimingFacade::GetSelfClickRolloverItemTargetData ( const UIDRef & itemRef ) const

pure virtual

Get item traget data for the self triggered item.

Parameters

itemRef is the item to set.

Returns: the target data.

virtual IDynamicEventTimingMgr::DynamicTargetPtr Facade::IDynamicEventTimingFacade::GetTargetDataInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which
	)		const

pure virtual

Get target item data for the nth item (which group) in the owner's dynamic event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the item is in.
dynamicTarget	is the target item within the group in the which position. Dynamic target data is copied here if exists. Item at which could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
which	is the position of the timing item. At this position, target could be just a single item or a group.

Returns: bool if successful.

virtual PMReal Facade::IDynamicEventTimingFacade::GetTargetDelayInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which
	)		const

pure virtual

Get target item delay for the nth item (which group) in the owner's dynamic event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the item is in.
dynamicTarget	is the target item within the group in the which groupposition. Item at which could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
which	is the position of the timing item. At this position could be just a single item or a group.

Returns: the time delay for this target item.

virtual bool Facade::IDynamicEventTimingFacade::GroupTargetsInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetList &	targetList,
		int32	newGroup
	)		const

pure virtual

Group targets for the specified dynamic event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the items are in.
targetList	contains a list of targets to be grouped.
newGroup	is position for the resulting new group.

Returns: true if successful

virtual bool Facade::IDynamicEventTimingFacade::MoveNthGroupInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		uint32	which,
		int32	newPosition
	)		const

pure virtual

Move the specified owner's nth item for dynamic event to the new position. This item could be a single target item or a group.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the event trigger.
which	is the nth item in the event's timing list.
newPosition	is the new position to move to. If newPosition is -1, the item is moved to the end.

Returns: true if successful otherwise false.

virtual bool Facade::IDynamicEventTimingFacade::MoveTargetAfterNthGroupInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	oldGroup,
		uint32	afterGroup
	)		const

pure virtual

Move target item from old timing position to after the new timing position for the owner's dynamic event. If the target item is in a linked group at the old timing position, it is unlinked from the group.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then dynamicTarget and button or MSO must be on the same spread.
trigger	is the trigger event to move item from.
dynamicTarget	is the target item within the group at oldGroup. Item at oldGroup could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
old	position is the timing position of the target item to move from.
new	position is the timing position of the target item to move after.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::MoveTargetBeforeNthGroupInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	oldGroup,
		uint32	beforeGroup
	)		const

pure virtual

Move target item from the old timing position to before the new timing position for the specified owner's dynamic event. If the target item is in a linked group at the old timing position, it is unlinked from the group.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the trigger event to move item from.
dynamicTarget	is the target item within the group at oldGroup. Item at oldGroup could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
oldGroup	is the timing position of the target item to move from.
beforeGroup	is the timing position of the target item to move before.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::MoveTargetIntoNthGroupAt	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	oldGroup,
		uint32	atGroup,
		int32	at = `-1`
	)		const

pure virtual

Move target item from old timing position to the new timing position for the owner's dynamic event. If the target item is in a linked group at the old timing position, it is unlinked from the group. If the new position already has a group, then this target item becomes part of the group.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then dynamicTarget and button or MSO must be on the same spread.
trigger	is the trigger event to move item from.
dynamicTarget	is the target item within the group at oldGroup. Item at oldGroup could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
oldGroup	is the timing position of the target item to move from.
atGroup	is the timing position of the target item to move into.
at	is the position within atGroup that the target item is to be moved to. If at is -1, the item is added at the end of the group.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::ReassignEventForTargets	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const EventTriggerType &	newTrigger,
		const IDynamicEventTimingMgr::DynamicTargetList &	targetList
	)		const

pure virtual

Reassign the specified targets to the new timing event. If targets were grouped, then the groups are retained. Otherwise, the targets are append at the end of the new timing list.

Parameters

ownerRef	is the UIDRef of spread or MSO.
trigger	is the event trigger to reassign the targets from. If trigger is kNoTriggerEvent, this means the specified targets were unassigned.
newTrigger	is the event trigger to reassign the targets to.
targetList	is the list of targets to reassign.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::RemoveDynamicEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger
	)		const

pure virtual

Returns the specified owner's dynamic event and all of the items associated with this event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the event to remove.

Returns: true if successful otherwise false.

virtual bool Facade::IDynamicEventTimingFacade::RemoveNthGroupInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		uint32	which
	)		const

pure virtual

Remove nth item from the owner's dynamic event. If nth item is a group (has more than one target items), then the entire group is removed.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the event trigger.
which	is the nth item in the event's timing list to remove.

Returns: true if successful otherwise false.

virtual bool Facade::IDynamicEventTimingFacade::RemoveSelfClickRolloverDynamicEventFromItem	(	const UIDRef &	itemRef,
		const EventTriggerType &	trigger
	)		const

pure virtual

Remove self click or rollover from item.

Parameters

itemRef	is the item to add.
trigger	is the trigger event to remove item from.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::RemoveTargetInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const UIDRef &	targetRef
	)		const

pure virtual

Remove all instances of this target item from the owner's dynamic event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the trigger event to remove item from.
targetRef	is all instances of target item to remove.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::RemoveTargetInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which
	)		const

pure virtual

Remove target item from the owner's dynamic event. If removing from a position where there are more than one target item in the group, then this target item is unlinked from the group.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the trigger event to remove item from.
dynamicTarget	is the target item within the group at which position. Item at which position could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
which	is the position in the timing list to remove from.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::ReplaceTargetInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	targetToReplace,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	newTarget,
		uint32	whichGroup
	)		const

pure virtual

Replace target item in the owner's dynamic event.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the event to add target item to.
targetToReplace	is the target item to replace.
newTarget	is the target item to replace with. newTarget's delay and data are copied.
whichGroup	is the group in which the targetRef should be replaced.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::SetNthGroupNumPlaysInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	whichTrigger,
		uint32	which,
		uint32	newNumPlays
	)

pure virtual

Gets the specified event trigger's nth item's number of plays.

Note: : For items that are targets of button actions, they are referenced directly by the buttons.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
whichTrigger	is the event trigger to remove.
which	is the group item.
newNumPlays	is the new number of times this group should play.

Returns: true if successful; other retruns false.

virtual bool Facade::IDynamicEventTimingFacade::SetNthGroupPlaysLoopInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	whichTrigger,
		uint32	which,
		bool	playsLoop
	)

pure virtual

Sets whether or not the specified event trigger's nth item should loop.

Note: : For items that are targets of button actions, they are referenced directly by the buttons.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
whichTrigger	is the event trigger to remove.
which	is the group item.
playsLoop	is true if group loops.

Returns: true if successful; other retruns false.

virtual bool Facade::IDynamicEventTimingFacade::SetSelfClickRolloverItemDelay	(	const UIDRef &	itemRef,
		const PMReal &	delay
	)		const

pure virtual

Set item delay for the self triggered item.

Parameters

itemRef	is the item to set.
delay	is the time delay to set.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::SetSelfClickRolloverItemTargetData	(	const UIDRef &	itemRef,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget
	)		const

pure virtual

Set item target data for the self triggered item.

Parameters

itemRef	is the item to set.
dynamicTarget	is the target data to set.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::SetTargetDataInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which
	)		const

pure virtual

Set target item delay for the nth item (which group) in the owner's dynamic event timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then itemRef and button or MSO must be on the same spread.
trigger	is the trigger event the item is in.
dynamicTarget	is the target item within the group in the which group position. Item at which could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
which	is the position of the timing item. At this position could be just a single item or a group.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::SetTargetDelayInNthGroup	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which,
		const PMReal &	delay
	)		const

pure virtual

Set target item delay for the nth item (which group) in the owner's dynamic event timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO. If ownerRef is a spread, itemRef must be on this spread. If ownerRef is a button or MSO, then dynamicTarget and button or MSO must be on the same spread.
trigger	is the trigger event the item is in.
dynamicTarget	is the target item within the group in the which group position. Item at which could be a group or a single item. If a group, dynamicTarget specifies a target item in the group.
which	is the position of the timing item. At this position could be just a single item or a group.
delay	is the time delay to set.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::UnlinkNthGroupInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		uint32	which
	)		const

pure virtual

Unlink nth group item in the specified event. The targets in the group are placed as separate items in teh event's timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the item is in.
which	is the group to unlink.

Returns: true if successful otherwise return false.

virtual bool Facade::IDynamicEventTimingFacade::UnlinkTargetInEvent	(	const UIDRef &	ownerRef,
		const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which
	)		const

pure virtual

Unlink the target in nth group item in the specified event. The target is removed from the group and placed as separate items at the end of the timing list.

Parameters

ownerRef	is the UIDRef of spread, button, or MSO.
trigger	is the trigger event the item is in.
dynamicTarget	is the target item within the group in the nth item position.
which	is the group to unlink from.

Returns: true if successful otherwise return false.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation