makVrv::DtTickableManager Class Reference

A base class for managers of DtTickable objects. More...

Inheritance diagram for makVrv::DtTickableManager:

Public Member Functions
	DtTickableManager ()
	CTOR.
virtual	~DtTickableManager ()
	DTOR.
virtual bool	addTickableObject (DtTickable *ticObj)
	Add a DtTickable object to this manager.
virtual void	removeTickableObject (DtTickable *ticObj)
	Remove a DtTickable object from this manager.
virtual void	tick (DtTime tNow=0.0)
	Function to update each tick-able object.
Public Member Functions inherited from makVrv::DtTickableManagerInterface
virtual	~DtTickableManagerInterface ()
	Virtual DTOR.

Protected Types
typedef std::vector< DtTickable * >	TickableList

Protected Attributes
TickableList	myTickables
bool	myOnTickFlag

Additional Inherited Members
Public Attributes inherited from makVrv::DtTickableManagerInterface
boost::signal< void()>	signal_aboutToBeDeleted

Detailed Description

A base class for managers of DtTickable objects.

Member Typedef Documentation

typedef std::vector<DtTickable*> makVrv::DtTickableManager::TickableList

protected

Constructor & Destructor Documentation

makVrv::DtTickableManager::DtTickableManager

(

)

CTOR.

virtual makVrv::DtTickableManager::~DtTickableManager ( )

virtual

DTOR.

Member Function Documentation

virtual bool makVrv::DtTickableManager::addTickableObject ( DtTickable *  ticObj )

virtual

Add a DtTickable object to this manager.

Parameters

[in]

ticObj

is a pointer to a tick-able object to add.

Return values

true	if the pointer was successfully added.
false	otherwise.

Note

Objects added to this manager are not destroyed at destruction time of this manager.

Exceptions

DtCorruptedState

if called during tick-update.

Implements makVrv::DtTickableManagerInterface.

virtual void makVrv::DtTickableManager::removeTickableObject ( DtTickable *  ticObj )

virtual

Remove a DtTickable object from this manager.

Parameters

[in]

ticObj

is a pointer to a tick-able object to remove.

Exceptions

DtCorruptedState

if called during tick-update.

Implements makVrv::DtTickableManagerInterface.

virtual void makVrv::DtTickableManager::tick ( DtTime  tNow = 0.0 )

virtual

Function to update each tick-able object.

Each tick-able object receives a call to its update() function if its needsUpdate() function returns true.

Parameters

[in]

tNow

is a time-stamp to pass to each object.

Note

The order objects are updated is not guaranteed.

Implements makVrv::DtTickableManagerInterface.

Member Data Documentation

TickableList makVrv::DtTickableManager::myTickables

protected

bool makVrv::DtTickableManager::myOnTickFlag

protected

---

The documentation for this class was generated from the following file:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtTickableManager.h