DtTacticalSmokeActuator Class Reference

This actuator is controls the movement and dispersion of a smoke object which is composed of a number of puff clouds. More...

Inheritance diagram for DtTacticalSmokeActuator:

List of all members.

Public Member Functions
	DtTacticalSmokeActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtTacticalSmokeActuator ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Calculate new kinematic state.
virtual DtTacticalSmokeActuatorDescriptor *	desc () const
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
	DtTacticalSmokeActuator ()
	default constructor; not implemented
	DtTacticalSmokeActuator (const DtTacticalSmokeActuator &orig)
	copy constructor; not implemented
const DtTacticalSmokeActuator &	operator= (const DtTacticalSmokeActuator &orig)
	assignment operator; not implemented
virtual DtVector	calculateWindVelocity () const
	Calculates our wind velocity based on the environmental wind speed and heading Returns a direction in entity body coordinates.

---

Detailed Description

This actuator is controls the movement and dispersion of a smoke object which is composed of a number of puff clouds.

The puffs move based on the current wind conditions, expand radius, and decrease density. This actuator also causes the entity to which it is attached to be deleted after the cloud has dispersed enough. Changes are controlled by parameters in the DtTacticalSmokeActuatorDescriptor.

Note:

This actuator requires its host object to have the DtTacticalSmokeStateRepository (or subclass) as its state repository.

Uses Descriptor Type: DtTacticalSmokeActuatorDescriptor

---

Constructor & Destructor Documentation

DtTacticalSmokeActuator::DtTacticalSmokeActuator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtTacticalSmokeActuator::~DtTacticalSmokeActuator

(

)

[virtual]

destructor

DtTacticalSmokeActuator::DtTacticalSmokeActuator

(

)

[protected]

default constructor; not implemented

DtTacticalSmokeActuator::DtTacticalSmokeActuator

(

const DtTacticalSmokeActuator &

orig

)

[protected]

copy constructor; not implemented

---

Member Function Documentation

virtual DtString DtTacticalSmokeActuator::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtTacticalSmokeActuatorType

Reimplemented from DtSimComponent.

virtual void DtTacticalSmokeActuator::tick

(

)

[virtual]

Calculate new kinematic state.

Reimplemented from DtSimComponent.

static DtSimComponent* DtTacticalSmokeActuator::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

virtual DtTacticalSmokeActuatorDescriptor* DtTacticalSmokeActuator::desc

(

)

const [virtual]

const DtTacticalSmokeActuator& DtTacticalSmokeActuator::operator=

(

const DtTacticalSmokeActuator &

orig

)

[protected]

assignment operator; not implemented

virtual DtVector DtTacticalSmokeActuator::calculateWindVelocity

(

)

const [protected, virtual]

Calculates our wind velocity based on the environmental wind speed and heading Returns a direction in entity body coordinates.

---

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

• include/vrfmodel/tacticalSmokeAct.h