Inheritance diagram for IDynamicEventAndTimingCmdData:

Public Types
enum	{ kDefaultIID = IID_IEVENTTRIGGERANDTIMINGCMDDATA }

enum	MoveType { kMoveNone, kMoveBefore, kMoveTo, kMoveAfter }

enum	RemoveTargetOptions { kNoAction, kDisableAction, kRemoveAction, kClearTarget }

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

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

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

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Enumeration Documentation

enum IDynamicEventAndTimingCmdData::MoveType

This enum specifies how to move the item(s) in the timing list for the specified trigger.
Enumerator
kMoveNone
Specifies no move.
kMoveBefore
Specifies the item(s) are moved before the specified posiiton.
kMoveTo
Specifies the item(s) are moved to the specified posiiton.
kMoveAfter
Specifies the item(s) are moved after the specified posiiton.

enum IDynamicEventAndTimingCmdData::RemoveTargetOptions

For targets triggered by buttonsThis enum specifies what to do when removing target from a button trigger event.
Enumerator
kNoAction
Specifies no remove action should be applied to the button action.
kDisableAction
Specifies action to be disabled but leave target in action. This is the default option.
kRemoveAction
Specifies remove action from trigger event and reliquished button action from behavior list.
kClearTarget
Specifies target to be cleared but leave action in the behavior list.

Member Function Documentation

virtual RemoveTargetOptions IDynamicEventAndTimingCmdData::GetButtonTargetRemoveOption ( ) const

pure virtual

Get new time delay

Returns: the new time delay.

virtual EventTriggerType IDynamicEventAndTimingCmdData::GetEventTrigger ( ) const

pure virtual

Get the event trigger

Returns: an event trigger.

See Also: AnimationTypes.h

virtual MoveType IDynamicEventAndTimingCmdData::GetMoveType ( ) const

pure virtual

Returns: the move type.

virtual const IDynamicEventTimingMgr::DynamicTargetPtr& IDynamicEventAndTimingCmdData::GetNewTargetItem ( ) const

pure virtual

Returns: the new target item.

virtual UID IDynamicEventAndTimingCmdData::GetNewTargetItemUID ( ) const

pure virtual

Returns: the new target item UID.

virtual int32 IDynamicEventAndTimingCmdData::GetNewTimingPosition ( ) const

pure virtual

Returns: the move position. If set to -1, the new position is at the end.

virtual int32 IDynamicEventAndTimingCmdData::GetNewTimingPositionInGroup ( ) const

pure virtual

Returns: the move position within group If set to -1, the new position is at the end.

virtual bool IDynamicEventAndTimingCmdData::GetNumPlays ( uint32 & numPlays ) const

pure virtual

Get the new number of times the specified group should play.

Parameters

numPlays is the new number of time to play.

Returns: true if new number of times to play is set.

virtual UIDRef IDynamicEventAndTimingCmdData::GetOwnerUIDRef ( ) const

pure virtual

Get the spread UIDRef that we are affecting.

Returns: UIDRef of the spread.

virtual bool IDynamicEventAndTimingCmdData::GetPlaysLoop ( bool & playsLoop ) const

pure virtual

Get the looping flag for the specified group.

Parameters

playsLoop is true if group should loop.

Returns: true if loop flag is set.

virtual const IDynamicEventTimingMgr::DynamicTargetList& IDynamicEventAndTimingCmdData::GetTargetItemList ( ) const

pure virtual

Returns: the new target item.

virtual int32 IDynamicEventAndTimingCmdData::GetTargetPosition ( ) const

pure virtual

Returns: the position of the timing target item.

virtual PMReal IDynamicEventAndTimingCmdData::GetTimeDelay ( ) const

pure virtual

Get new time delay

Returns: the new time delay.

virtual bool IDynamicEventAndTimingCmdData::GetTimeDelayIsSet ( ) const

pure virtual

Returns: true if to set new time delay.

virtual int32 IDynamicEventAndTimingCmdData::GetTimingPosition ( ) const

pure virtual

Returns: the position of the timing group item.

virtual void IDynamicEventAndTimingCmdData::SetButtonTargetRemoveOption ( const RemoveTargetOptions & removeOption )

pure virtual

Set the new time delay for the specified item

Parameters

delay is the new time delay.

virtual void IDynamicEventAndTimingCmdData::SetEventTrigger ( const EventTriggerType & trigger )

pure virtual

Set the affecting event trigger.

Parameters

trigger is the affected event trigger.

See Also: AnimationTypes.h

virtual void IDynamicEventAndTimingCmdData::SetGroupPlayData	(	bool	setNumPlay,
		const uint32 &	numPlays,
		bool	setLooping,
		bool	playsLoop
	)

pure virtual

The following methods for setting group's play data. This includes number of times to play and the looping flag.Set the specified linked group's play data.

Parameters

setNumPlay	is true if numPlays is set.
numPlays	is the new number of times to play.
setLooping	is true if playsLoop is set.
playsLoop	is true if group is set to loop.

virtual void IDynamicEventAndTimingCmdData::SetMove	(	const MoveType &	moveType,
		uint32	newPosition,
		int32	newPositionInGroup = `-1`
	)

pure virtual

Sets the move for this command.

Parameters

moveType	specifes how to move.
newPosition	is the position to move before, to, or after.
newPositionInGroup	is the new position within group. This is relevant only if move is set to kMoveTo. The default is -1 which means to move to the end of the specified group.

virtual void IDynamicEventAndTimingCmdData::SetNewTargetItem ( const IDynamicEventTimingMgr::DynamicTargetPtr & newTarget )

pure virtual

Set the new target item.

virtual void IDynamicEventAndTimingCmdData::SetNewTargetItemUID ( UID newItemUID )

pure virtual

Set the new target item UID.

virtual void IDynamicEventAndTimingCmdData::SetOwnerUIDRef ( const UIDRef & ownerRef )

pure virtual

Set the owner UIDRef that we are affecting. If we are affecting the page events (page load and page click) then this ownerRef is a spread UIDRef. If these are button events, then the ownerRef is the button UIDRef.

Parameters

ownerRef is the UIDRef of the spread

virtual void IDynamicEventAndTimingCmdData::SetTargetItemList ( const IDynamicEventTimingMgr::DynamicTargetList & targetList )

pure virtual

Set the target item list. NOTE: either the target position or the target list must be specified.

Parameters

targetList is the list of targets.

virtual void IDynamicEventAndTimingCmdData::SetTargetPosition ( int32 targetPosition )

pure virtual

Set the timing target item we want to update. If itemPosition is -1, then all instances of the item are affected. NOTE: either the target position or the target list must be specified.

Parameters

targetPosition is the position of the timing item we want to update.

virtual void IDynamicEventAndTimingCmdData::SetTimeDelay ( const PMReal & delay )

pure virtual

Set the new time delay for the specified item

Parameters

delay is the new time delay.

virtual void IDynamicEventAndTimingCmdData::SetTimingPosition ( int32 groupPosition )

pure virtual

Set the timing group position we want to update. If groupPosition is -1, then all instances of the item are affected.

Parameters

groupPosition is the position of the timing item we want to update.

Enumerator
kMoveNone	Specifies no move.
kMoveBefore	Specifies the item(s) are moved before the specified posiiton.
kMoveTo	Specifies the item(s) are moved to the specified posiiton.
kMoveAfter	Specifies the item(s) are moved after the specified posiiton.

Enumerator
kNoAction	Specifies no remove action should be applied to the button action.
kDisableAction	Specifies action to be disabled but leave target in action. This is the default option.
kRemoveAction	Specifies remove action from trigger event and reliquished button action from behavior list.
kClearTarget	Specifies target to be cleared but leave action in the behavior list.

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation