VR-Forces 4.0.4 Class Documentation
Classes | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes
makVrv::DtTemporaryAgentManager Class Reference

The temporary agent manager. More...

List of all members.

Classes

struct  AgentParameters

Public Member Functions

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

Public Attributes

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

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 AgentCollection::iterator makVrv::DtTemporaryAgentManager::iterator [protected]
typedef AgentCollection::const_iterator makVrv::DtTemporaryAgentManager::const_iterator [protected]

Constructor & Destructor Documentation

CTOR.

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
agenta valid pointer to an agent the manager will own.
lifeTimethe duration that the agent should live.
deleteDelaythe delay after the lifeTime when the agent will be deleted.

Deletes all effects.

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

Tick the manager, updating any agents as necessary.


Member Data Documentation

Emitted when a temporary agent times out.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)