makVrv::DtTemporaryAgentManager Class Reference

The temporary agent manager. More...

Classes
struct	AgentParameters

Public Member Functions
	DtTemporaryAgentManager (double currentTime)
	CTOR. More...
virtual	~DtTemporaryAgentManager ()
	DTOR. More...
virtual void	takeAgent (DtAgent *agent, double lifeTime, double deleteDelay=0.0)
	Add an agent to the scene. More...
void	clearAll ()
	Deletes all effects. More...
virtual void	tick (double currentTime)
	Tick the manager, updating any agents as necessary. More...

Public Attributes
boost::signalslib::signal < void(DtAgent *)>	signal_agentTimedOut
	Emitted when a temporary agent times out. More...

Protected Types
typedef std::list < AgentParameters >	AgentCollection
typedef AgentCollection::iterator	iterator
typedef AgentCollection::const_iterator	const_iterator

Protected Member Functions
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const

Protected Attributes
AgentCollection	myAgents
double	myLastTime

Detailed Description

The temporary agent manager.

This manager is used to add timed DtAgents to the scene, such as detonation effects.

DtTemporaryAgentManager emits the signal_agentTimedOut signal when an agent is about to be deleted.

Member Typedef Documentation

typedef std::list<AgentParameters> makVrv::DtTemporaryAgentManager::AgentCollection

protected

typedef AgentCollection::iterator makVrv::DtTemporaryAgentManager::iterator

protected

typedef AgentCollection::const_iterator makVrv::DtTemporaryAgentManager::const_iterator

protected

Constructor & Destructor Documentation

makVrv::DtTemporaryAgentManager::DtTemporaryAgentManager

(

double

currentTime

)

CTOR.

virtual makVrv::DtTemporaryAgentManager::~DtTemporaryAgentManager ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtTemporaryAgentManager::takeAgent ( DtAgent *  agent, double  lifeTime, double  deleteDelay = 0.0  )

virtual

Add an agent to the scene.

The Manager now owns the agent.

Parameters

Input
agent	a valid pointer to an agent the manager will own.
lifeTime	the duration that the agent should live.
deleteDelay	the delay after the lifeTime when the agent will be deleted.

void makVrv::DtTemporaryAgentManager::clearAll

(

)

Deletes all effects.

virtual void makVrv::DtTemporaryAgentManager::tick ( double  currentTime )

virtual

Tick the manager, updating any agents as necessary.

iterator makVrv::DtTemporaryAgentManager::begin ( )

inlineprotected

const_iterator makVrv::DtTemporaryAgentManager::begin ( ) const

inlineprotected

iterator makVrv::DtTemporaryAgentManager::end ( )

inlineprotected

const_iterator makVrv::DtTemporaryAgentManager::end ( ) const

inlineprotected

Member Data Documentation

boost::signalslib::signal<void (DtAgent*)> makVrv::DtTemporaryAgentManager::signal_agentTimedOut

Emitted when a temporary agent times out.

AgentCollection makVrv::DtTemporaryAgentManager::myAgents

protected

double makVrv::DtTemporaryAgentManager::myLastTime

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtTemporaryAgentManager.h