DtLaunchSmokeControllerDescriptor Class Reference

DtLaunchSmokeControllerDescriptor; descriptor for the DtLaunchSmokeComponent component. More...

Inheritance diagram for DtLaunchSmokeControllerDescriptor:

List of all members.

Public Member Functions
	DtLaunchSmokeControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtLaunchSmokeControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtLaunchSmokeControllerDescriptor (const DtLaunchSmokeControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtLaunchSmokeControllerDescriptor &	operator= (const DtLaunchSmokeControllerDescriptor &orig)
	assignment
virtual	~DtLaunchSmokeControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtEntityType &	detonationType () const
virtual void	setDetonationType (const DtEntityType &type)
virtual int	numberOfSmokeClouds () const
virtual void	setNumberOfSmokeClouds (int numClouds)
virtual double	distanceFromEntity () const
virtual void	setDistanceFromEntity (double d)
virtual double	interCloudAngle () const
virtual void	setInterCloudAngle (double angle)
virtual double	cloudElevationAngle () const
virtual void	setCloudElevationAngle (double angle)
virtual const DtString &	resourceName () const
virtual void	setResourceName (const DtString &rName)
virtual bool	simulateSmoke () const
virtual void	setSimulateSmoke (bool b)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtLaunchSmokeControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myDetonationType
	Parameter Name: detonation-type Parameter Description: Specify smoke bomb/grenade munition entity type Parameter Default Value: 2:9:225:2:5:4:0 (US M302A2 smoke bomb) .
DtRwInt	myNumSmokeClouds
	Parameter Name: num-smoke-clouds Parameter Description: The number of smoke clouds associated with the detonation Parameter Default Value: 1 .
DtRwReal	myDistanceFromEntity
	Parameter Name: distance-from-entity Parameter Description: Distance from entity to the first smoke cloud Parameter Default Value: 5 meters .
DtRwReal	myInterCloudAngle
	Parameter Name: inter-cloud-angle Parameter Description: Angle of separation between smoke clouds Parameter Default Value: 10 degrees .
DtRwReal	myCloudElevationAngle
	Parameter Name: cloud-elevation-angle Parameter Description: angle from entity to launch smoke Parameter Default Value: 30 degrees .
DtRwString	myResourceName
	Parameter Name: resource-name Parameter Description: Supply type needed to launch smoke Parameter Default Value: "smoke-bomb" .
DtRwBoolean	mySimulateSmokeClouds
	Parameter Name: simulate-smoke-cloud-objects Parameter Description: Option controls whether or not to simulate resulting smoke clouds in VRF Parameter Default Value: "true" .

---

Detailed Description

DtLaunchSmokeControllerDescriptor; descriptor for the DtLaunchSmokeComponent component.

Class DtLaunchSmokeControllerDescriptor: A DtComponentDescriptor that has parameters that indicate the initial settings for the launch smoke controller

---

Constructor & Destructor Documentation

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor	(	const DtLaunchSmokeControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtLaunchSmokeControllerDescriptor::~DtLaunchSmokeControllerDescriptor

(

)

[virtual]

destructor

DtLaunchSmokeControllerDescriptor::DtLaunchSmokeControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtLaunchSmokeControllerDescriptor& DtLaunchSmokeControllerDescriptor::operator=

(

const DtLaunchSmokeControllerDescriptor &

orig

)

assignment

virtual DtString DtLaunchSmokeControllerDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtLaunchSmokeControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtLaunchSmokeControllerDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

virtual const DtEntityType& DtLaunchSmokeControllerDescriptor::detonationType

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setDetonationType

(

const DtEntityType &

type

)

[virtual]

virtual int DtLaunchSmokeControllerDescriptor::numberOfSmokeClouds

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setNumberOfSmokeClouds

(

int

numClouds

)

[virtual]

virtual double DtLaunchSmokeControllerDescriptor::distanceFromEntity

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setDistanceFromEntity

(

double

d

)

[virtual]

virtual double DtLaunchSmokeControllerDescriptor::interCloudAngle

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setInterCloudAngle

(

double

angle

)

[virtual]

virtual double DtLaunchSmokeControllerDescriptor::cloudElevationAngle

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setCloudElevationAngle

(

double

angle

)

[virtual]

virtual const DtString& DtLaunchSmokeControllerDescriptor::resourceName

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setResourceName

(

const DtString &

rName

)

[virtual]

virtual bool DtLaunchSmokeControllerDescriptor::simulateSmoke

(

)

const [virtual]

virtual void DtLaunchSmokeControllerDescriptor::setSimulateSmoke

(

bool

b

)

[virtual]

---

Member Data Documentation

DtRwEntityType DtLaunchSmokeControllerDescriptor::myDetonationType [protected]

Parameter Name: detonation-type
Parameter Description: Specify smoke bomb/grenade munition entity type
Parameter Default Value: 2:9:225:2:5:4:0 (US M302A2 smoke bomb)
.

DtRwInt DtLaunchSmokeControllerDescriptor::myNumSmokeClouds [protected]

Parameter Name: num-smoke-clouds
Parameter Description: The number of smoke clouds associated with the detonation
Parameter Default Value: 1
.

DtRwReal DtLaunchSmokeControllerDescriptor::myDistanceFromEntity [protected]

Parameter Name: distance-from-entity
Parameter Description: Distance from entity to the first smoke cloud
Parameter Default Value: 5 meters
.

DtRwReal DtLaunchSmokeControllerDescriptor::myInterCloudAngle [protected]

Parameter Name: inter-cloud-angle
Parameter Description: Angle of separation between smoke clouds
Parameter Default Value: 10 degrees
.

DtRwReal DtLaunchSmokeControllerDescriptor::myCloudElevationAngle [protected]

Parameter Name: cloud-elevation-angle
Parameter Description: angle from entity to launch smoke
Parameter Default Value: 30 degrees
.

DtRwString DtLaunchSmokeControllerDescriptor::myResourceName [protected]

Parameter Name: resource-name
Parameter Description: Supply type needed to launch smoke
Parameter Default Value: "smoke-bomb"
.

DtRwBoolean DtLaunchSmokeControllerDescriptor::mySimulateSmokeClouds [protected]

Parameter Name: simulate-smoke-cloud-objects
Parameter Description: Option controls whether or not to simulate resulting smoke clouds in VRF
Parameter Default Value: "true"
.

---

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

• include/vrfobjparam/launchSmokeCtlrDesc.h