#include <IDynamicEventTimingSuite.h>

Inheritance diagram for IDynamicEventTimingSuite:

Public Types
enum	{ kDefaultIID = IID_IDYNAMICEVENTTIMINGSUITE }

Public Member Functions
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

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 is the high level dynamic event timing suite for the current selection. Dynamic events are event triggers that cause one or more items to do something in some ordering. The supported event triggers are:

For the spread: kOnPageLoad kOnPageClick

For the MSO: kOnPageLoad (is the same as on state load)

For normal page items with animation applied: kOnSelfClick kOnSelfRollover

For buttons: kOnClick kOnRelease kOnRollover kOnRolloff

Member Function Documentation

virtual bool IDynamicEventTimingSuite::AddTargetInEvent	(	const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget
	)

pure virtual

Add item to the current seleciton dynamic event. If there's no selection, spread's dynamic events are used.

Parameters

trigger	is the event to add item to.
dynamicTarget	is the target item to add.

Returns: true if successful otherwise return false.

virtual bool IDynamicEventTimingSuite::CanApply ( ) const

pure virtual

Returns true if we can apply event and timing to the current selection. We can only show or apply if the current selection is a single selection and that it is a button.

Returns: true if we can apply event and timing to current selection.

virtual bool IDynamicEventTimingSuite::CanMoveTargetInEvent ( const EventTriggerType & trigger ) const

pure virtual

Returns true if we can re-order items in the list.

Parameters

trigger is the trigger event to move item from.

Returns: true if successful otherwise return false.

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

pure virtual

Find the target in the specified trigger event. Returns the group index the target is in and the relative position of the target in the group. If it's a single target group, then the target position is 0.

Parameters

trigger	is the trigger event the item is in.
dynamicTarget	is the target item to find.
position	is the relative position the target is in the group.

Returns: the group index. If target is not found, group index is -1.

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

pure virtual

Get applicable dynamic events for the selection.

Parameters

trigger	is the trigger event.
eventTriggerTypeList,:	[OUT] the list of other event triggers that is applicable for the selection that is different from trigger.

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

pure virtual

Get applicable dynamic events for the target selection.

Parameters

trigger	is the trigger event.
itemRef	is target.
eventTriggerTypeList,:	[OUT] the list of other event triggers that is applicable for the target selection that is different from trigger.

virtual EventTriggerType IDynamicEventTimingSuite::GetNthDynamicEvent ( uint32 which ) const

pure virtual

Get nth dynamic events for the selection.

Parameters

which is the nth dynamic event to get.

Returns: the event trigger.

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

pure virtual

Get the nth timing position's item list from the selection's dynamic event.

Parameters

trigger	is the trigger event the item is in.
which	is the nth item in the dynamic event timing list to get.
itemList	is the list containing one or more items in nth position of the timing list.

Returns: true if successful otherwise return false.

virtual uint32 IDynamicEventTimingSuite::GetNthGroupNumPlaysInEvent	(	const EventTriggerType &	trigger,
		uint32	which
	)		const

pure virtual

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

Parameters

trigger	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 IDynamicEventTimingSuite::GetNthGroupPlaysLoopInEvent	(	const EventTriggerType &	trigger,
		uint32	which
	)		const

pure virtual

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

Parameters

trigger	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 IDynamicEventTimingSuite::GetNumDynamicEvents ( ) const

pure virtual

Get number of dynamic events for the selection.

Returns: the number of event triggers

virtual uint32 IDynamicEventTimingSuite::GetNumGroupsInEvent ( const EventTriggerType & trigger ) const

pure virtual

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

Parameters

trigger is the trigger event the item is in.

Returns: the number of items

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

pure virtual

Get item delay for the nth item in the selection's dynamic event.

Parameters

trigger	is the trigger event the item is in.
dynamicTarget	is the target item to move.
which	is the position of the item to set.

Returns: the time delay for this item.

virtual ClassID IDynamicEventTimingSuite::GetTimingParentClassID ( ) const

pure virtual

Returns: the class ID of the current timing parent. Possible types are spread boss, MSO, and button.

virtual bool IDynamicEventTimingSuite::GetUnassignedTargets ( std::vector< UID > & unassignedTargetList ) const

pure virtual

Return a list of unassigned targets for the selection.

Parameters

unassignedTargetList contains a list of unassigned targets.

Returns: true if there are unassigned targets.

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

pure virtual

Group targets for the specified dynamic event.

Parameters

trigger	is the trigger event the items are in.
targetList	contains a list of targets to be grouped.
newGroup	is the new group position.

Returns: true if successful

virtual bool IDynamicEventTimingSuite::HasMultipleSelections ( ) const

pure virtual

Returns true if current selection contains multiple selections. This will not be available for multiple selections.

virtual bool IDynamicEventTimingSuite::MoveNthGroupInEvent	(	const EventTriggerType &	trigger,
		uint32	which,
		int32	newGroup = `-1`
	)

pure virtual

Move the nth group from the selection's dynamic event.

Parameters

trigger	is the trigger event the item is in.
which	is the which group in the dynamic event timing list to move.
newGroup	is the new position to move the group to. If newGroup is set to -1, then the group is moved to the end.

Returns: true if successful otherwise return false.

virtual bool IDynamicEventTimingSuite::MoveNthGroupToInEventAt	(	const EventTriggerType &	trigger,
		uint32	which,
		uint32	newGroup,
		int32	atPosition = `-1`
	)

pure virtual

Move all the targets in nth group from the selection's dynamic event to another group at the specified position.

Parameters

trigger	is the trigger event the item is in.
which	is the which group in the dynamic event timing list to move.
newGroup	is the new position to move the group to.
atPosition	is the new position in the group to move the items in the group to. If atPosition is set to -1, then the items in the group is moved to the end of the new group.

Returns: true if successful otherwise return false.

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

pure virtual

Move item from old timing position to after the new timing position for the selection's dynamic event.

Parameters

trigger	is the trigger event to move item from.
dynamicTarget	is the target item to move.
oldGroup	is the timing position of the item to move from.
afterGroup	is the timing position of the item to move after.

Returns: true if successful otherwise return false.

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

pure virtual

Move item from old timing position to before the new timing position for the selection's dynamic event.

Parameters

trigger	is the trigger event to move item from.
dynamicTarget	is the target item to move.
oldGroup	is the timing position of the item to move from.
beforeGroup	is the timing position of the item to move before.

Returns: true if successful otherwise return false.

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

pure virtual

Move item from old timing position to the new timing position for the selection's dynamic event.

Parameters

trigger	is the trigger event to move item from.
dynamicTarget	is the target item to move.
oldGroup	is the timing position of the item to move from.
atGroup	is the timing position of the item to move to.
at	is the position within the atGroup the item is moved to. The item is added to the end of the group if at = -1.

Returns: true if successful otherwise return false.

virtual bool IDynamicEventTimingSuite::ReassignEventForTargets	(	const EventTriggerType &	trigger,
		const EventTriggerType &	newTrigger,
		const IDynamicEventTimingMgr::DynamicTargetList &	targetList
	)		const

pure virtual

Reassign targets to a different events

Parameters

trigger	is the trigger event the items are in. If trigger is kNoTriggerEvent, this means the specified targets were unassigned.
newTrigger	is the new trigger event to reassign to.
targetList	contains a list of targets to be reassigned.

Returns: true if successful

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

pure virtual

Remove item from the selection's dynamic event.

Parameters

trigger	is the trigger event to remove item from.
dynamicTarget	is the target item to add.
whichGroup	is the position of the group item from which to remove from.

Returns: true if successful otherwise return false.

virtual bool IDynamicEventTimingSuite::RemoveTargetInEvent	(	const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget
	)

pure virtual

Remove all instances of item from the selection's dynamic event.

Parameters

trigger	is the trigger event to remove item from.
dynamicTarget	is the target item to remove.

Returns: true if successful otherwise return false.

virtual bool IDynamicEventTimingSuite::SetNthGroupNumPlaysInEvent	(	const EventTriggerType &	trigger,
		uint32	which,
		uint32	newNumPlays
	)

pure virtual

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

Parameters

trigger	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 IDynamicEventTimingSuite::SetNthGroupPlaysLoopInEvent	(	const EventTriggerType &	trigger,
		uint32	which,
		bool	playsLoop
	)

pure virtual

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

Parameters

trigger	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 IDynamicEventTimingSuite::SetTargetDelayInEvent	(	const EventTriggerType &	trigger,
		const IDynamicEventTimingMgr::DynamicTargetPtr &	dynamicTarget,
		uint32	which,
		const PMReal &	delay
	)

pure virtual

Set item delay for the nth item in the selection's dynamic event.

Parameters

trigger	is the trigger event the item is in.
dynamicTarget	is the target item to move.
which	is the position of the item to set.
delay	is the time delay to set.

Returns: true if successful otherwise return false.

virtual bool IDynamicEventTimingSuite::UnlinkNthGroupInEvent	(	const EventTriggerType &	trigger,
		uint32	which
	)

pure virtual

Unlink the nth group from the selection's dynamic event. This puts the targets in the group as individual items in the timing list. If the group only has one item, unlink has no effect.

Parameters

trigger	is the trigger event the item is in.
which	is the nth item in the dynamic event timing list to get.
itemList	is the list containing one or more items in nth position of the timing list.

Returns: true if successful otherwise return false.

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

pure virtual

Unlink the target in group from the selection's dynamic event. This remove the specified target in the group and adds it to the end of the timing list for this event.

Parameters

trigger	is the trigger event the item is in.
dynamicTarget	is the target item to move.
which	is the nth item in teh dynamic event timing list to get.

Returns: true if successful otherwise return false.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation