IDynamicEventTimingMgr::DynamicTarget Class Reference

Inheritance diagram for IDynamicEventTimingMgr::DynamicTarget:

Public Member Functions
virtual UID	GetTargetUID () const =0
virtual uint32	GetRole () const =0
virtual uint32	GetAction () const =0
virtual void	SetAction (uint32 targetAction)=0
virtual PMReal	GetDelay () const =0
virtual void	SetDelay (const PMReal &targetDelay)=0
virtual bool	HasData (std::vector< uint32 > *pDataIDList=nil) const =0
virtual bool	GetData (uint32 dataID, TargetDataType &data) const =0
virtual bool	AddData (uint32 dataID, const TargetDataType &data)=0
virtual bool	RemoveData (uint32 dataID)=0

Friends
class	DynamicTargetImpl
void	intrusive_ptr_add_ref (DynamicTarget *t)
void	intrusive_ptr_release (DynamicTarget *t)

Member Function Documentation

virtual bool IDynamicEventTimingMgr::DynamicTarget::AddData ( uint32  dataID, const TargetDataType &  data  )

pure virtual

Add data for the specified data ID.

Parameters

dataID	is the data ID to add.
data	is the value for this data ID.

Returns

true if successful.

virtual uint32 IDynamicEventTimingMgr::DynamicTarget::GetAction ( ) const

pure virtual

Returns

the target's action. Current values are: kTimingTargetVerbPlay kTimingTargetVerbStop kTimingTargetVerbPause kTimingTargetVerbResume

See Also

DynamicDocumentsID.h

virtual bool IDynamicEventTimingMgr::DynamicTarget::GetData ( uint32  dataID, TargetDataType &  data  ) const

pure virtual

Get the data value for the specified data ID.

Parameters

dataID	is the data ID to get.
data	is the value for this data ID.

Returns

true if target has this data.

virtual PMReal IDynamicEventTimingMgr::DynamicTarget::GetDelay ( ) const

pure virtual

Returns

the target's delay.

virtual uint32 IDynamicEventTimingMgr::DynamicTarget::GetRole ( ) const

pure virtual

Returns

the target's role. Current values are: kTimingTargetRoleVideo kTimingTargetRoleAnimation kTimingTargetRoleSound

See Also

DynamicDocumentsID.h

virtual UID IDynamicEventTimingMgr::DynamicTarget::GetTargetUID ( ) const

pure virtual

Returns

the target's UID. For button, this UID is the action UID.

virtual bool IDynamicEventTimingMgr::DynamicTarget::HasData ( std::vector< uint32 > *  pDataIDList = nil ) const

pure virtual

Return true if target has additional data.

Parameters

pDataIDList

contains the data IDs if set.

Returns

true if target has additional data.

virtual bool IDynamicEventTimingMgr::DynamicTarget::RemoveData ( uint32  dataID )

pure virtual

Remove the data value associated with specified data ID.

Parameters

dataID

is the data ID to remove.

Returns

true if successful.

virtual void IDynamicEventTimingMgr::DynamicTarget::SetAction ( uint32  targetAction )

pure virtual

Set target's action.

Parameters

targetAction

is one of these values: kTimingTargetVerbPlay kTimingTargetVerbStop kTimingTargetVerbPause kTimingTargetVerbResume

See Also

DynamicDocumentsID.h

virtual void IDynamicEventTimingMgr::DynamicTarget::SetDelay ( const PMReal &  targetDelay )

pure virtual

Set target's delay.

Parameters

targetDelay

is target delay to set.