DtDamageComponentDescriptor Class Reference

DtDamageComponentDescriptor is used to specify the parameters for a DtDamageActuator object. More...

Inheritance diagram for DtDamageComponentDescriptor:

List of all members.

Public Member Functions
	DtDamageComponentDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtDamageComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDamageComponentDescriptor (const DtDamageComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor.
DtDamageComponentDescriptor &	operator= (const DtDamageComponentDescriptor &orig)
	assignment. See note above.
virtual	~DtDamageComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	init ()
	allocate the damage table
virtual void	setDamageModel (const DtDmgMunitionTable *model)
	This can be used to set the damage model to some other damage table.
virtual const DtDmgMunitionTable *	damageModel () const
	Accessor for myDamageModel.
virtual bool	getKillProbabilities (const DtSimMunition &munition, const DtString &surface, DtReal angleOfIncidence, DtReal range, DtPrbRangeTableEntry *rangeEntry) const
	Returns a DtPrbRangeTableEntry based on munition, surface, angle of incidence, and range.
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to add myDamageModel to myRegistry temporarily if we don't own the damage table (we just have a copy), so that it will get written out.
virtual DtReal	smokeTime () const
	Accessor/mutator for mySmokeTime.
virtual void	setSmokeTime (DtReal smokeTime)
	Accessor/mutator for mySmokeTime.
virtual DtTime	flameTime () const
	Accessor/mutator for myFlameTime.
virtual void	setFlameTime (DtTime flameTime)
	Accessor/mutator for myFlameTime.
virtual bool	terminateOnDestroy () const
	Accessor/mutator for myTerminateOnDestroy.
virtual void	setTerminateOnDestroy (bool yesNo)
	Accessor/mutator for myTerminateOnDestroy.
virtual void	setUnderFireTime (DtTime underFireTime)
	Accessor/mutator for myUnderFireTime.
virtual DtTime	underFireTime () const
	Accessor/mutator for myUnderFireTime.
virtual DtReal	underFireDistance () const
	Accessor/mutator for myUnderFireDistance.
virtual void	setUnderFireDistance (DtReal underFireDistance)
	Accessor/mutator for myUnderFireDistance.
virtual bool	underFireFromFriendly () const
	Accessor/mutator for myUnderFireFromFriendly.
virtual void	setUnderFireFromFriendly (bool b)
	Accessor/mutator for myUnderFireFromFriendly.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtDamageComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
bool	myOwnDamageModel
parameters
These parameters are available for setting in the OPD files.
DtRwTime	mySmokeTime
	Parameter Name: smoke-time Parameter Description: The time the smoking appearance indicator will be true after any entity is destroyed.
DtRwTime	myFlameTime
	Parameter Name: flame-time Parameter Description: The time the flaming appearance indicator will be true after any entity is destroyed.
DtRwBoolean	myTerminateOnDestroy
	Parameter Name: terminate-on-destroy Parameter Description: The flag that determines whether the entity will be terminated when it is destroyed.
DtRwTime	myUnderFireTime
	Parameter Name: under-fire-time Parameter Description: The time after which an entity is no longer considered to be under fire.
DtRwReal	myUnderFireDistance
	Parameter Name: under-fire-distance Parameter Description: The distance from a detonation at which an entity is considered to be under fire.
DtRwBoolean	myUnderFireFromFriendly
	Parameter Name: under-fire-from-friendly Parameter Description: Determines if friendly fire should set the under fire condition.
const DtDmgMunitionTable *	myDamageModel
	Parameter Name: damage-model Parameter Description: Damage model for the entity (optional).

---

Detailed Description

DtDamageComponentDescriptor is used to specify the parameters for a DtDamageActuator object.

---

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor.

Note that this does not do a deep copy of the damage table; it only copies the pointer. If you want your own copy of the table, clone the one pointed to in this copy and then call setDamageModel

virtual DtDamageComponentDescriptor::~DtDamageComponentDescriptor

(

)

[virtual]

destructor

DtDamageComponentDescriptor::DtDamageComponentDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtDamageComponentDescriptor& DtDamageComponentDescriptor::operator=

(

const DtDamageComponentDescriptor &

orig

)

assignment. See note above.

virtual DtString DtDamageComponentDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtDamageComponentDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtDamageComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual bool DtDamageComponentDescriptor::init

(

)

[virtual]

allocate the damage table

Reimplemented from DtComponentDescriptor.

virtual void DtDamageComponentDescriptor::setDamageModel

(

const DtDmgMunitionTable *

model

)

[virtual]

This can be used to set the damage model to some other damage table.

If you need to have a copy of the damage table that you can modify, you can clone the damage table returned by damageModel() and then call setDamageModel with the result. It is then your responsibility to delete that cloned table. Mutator for myDamageModel

virtual const DtDmgMunitionTable* DtDamageComponentDescriptor::damageModel

(

)

const [virtual]

Accessor for myDamageModel.

virtual DtReal DtDamageComponentDescriptor::smokeTime

(

)

const [virtual]

Accessor/mutator for mySmokeTime.

virtual void DtDamageComponentDescriptor::setSmokeTime

(

DtReal

smokeTime

)

[virtual]

Accessor/mutator for mySmokeTime.

virtual DtTime DtDamageComponentDescriptor::flameTime

(

)

const [virtual]

Accessor/mutator for myFlameTime.

virtual void DtDamageComponentDescriptor::setFlameTime

(

DtTime

flameTime

)

[virtual]

Accessor/mutator for myFlameTime.

virtual bool DtDamageComponentDescriptor::terminateOnDestroy

(

)

const [virtual]

Accessor/mutator for myTerminateOnDestroy.

virtual void DtDamageComponentDescriptor::setTerminateOnDestroy

(

bool

yesNo

)

[virtual]

Accessor/mutator for myTerminateOnDestroy.

virtual bool DtDamageComponentDescriptor::getKillProbabilities	(	const DtSimMunition &	munition,
		const DtString &	surface,
		DtReal	angleOfIncidence,
		DtReal	range,
		DtPrbRangeTableEntry *	rangeEntry
	)		const [virtual]

Returns a DtPrbRangeTableEntry based on munition, surface, angle of incidence, and range.

Returns false if the information requested can't be found.

virtual void DtDamageComponentDescriptor::setUnderFireTime

(

DtTime

underFireTime

)

[virtual]

Accessor/mutator for myUnderFireTime.

virtual DtTime DtDamageComponentDescriptor::underFireTime

(

)

const [virtual]

Accessor/mutator for myUnderFireTime.

virtual DtReal DtDamageComponentDescriptor::underFireDistance

(

)

const [virtual]

Accessor/mutator for myUnderFireDistance.

virtual void DtDamageComponentDescriptor::setUnderFireDistance

(

DtReal

underFireDistance

)

[virtual]

Accessor/mutator for myUnderFireDistance.

virtual bool DtDamageComponentDescriptor::underFireFromFriendly

(

)

const [virtual]

Accessor/mutator for myUnderFireFromFriendly.

virtual void DtDamageComponentDescriptor::setUnderFireFromFriendly

(

bool

b

)

[virtual]

Accessor/mutator for myUnderFireFromFriendly.

virtual void DtDamageComponentDescriptor::putSelf	(	FILE *	fp,
		int	indentLevel = 0,
		bool	writeUnspecified = false,
		const DtFilename &	path = DtReaderWriter::appPath()
	)		[virtual]

Override to add myDamageModel to myRegistry temporarily if we don't own the damage table (we just have a copy), so that it will get written out.

Reimplemented from DtReaderWriter.

static DtComponentDescriptor* DtDamageComponentDescriptor::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 DtActuatorComponentDescriptor.

---

Member Data Documentation

DtRwTime DtDamageComponentDescriptor::mySmokeTime [protected]

Parameter Name: smoke-time
Parameter Description: The time the smoking appearance indicator will be true after any entity is destroyed.

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwTime DtDamageComponentDescriptor::myFlameTime [protected]

Parameter Name: flame-time
Parameter Description: The time the flaming appearance indicator will be true after any entity is destroyed.

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwBoolean DtDamageComponentDescriptor::myTerminateOnDestroy [protected]

Parameter Name: terminate-on-destroy
Parameter Description: The flag that determines whether the entity will be terminated when it is destroyed.

Parameter Default Value: False

DtRwTime DtDamageComponentDescriptor::myUnderFireTime [protected]

Parameter Name: under-fire-time
Parameter Description: The time after which an entity is no longer considered to be under fire.

Parameter Default Value: 120.0
Parameter Units: seconds

DtRwReal DtDamageComponentDescriptor::myUnderFireDistance [protected]

Parameter Name: under-fire-distance
Parameter Description: The distance from a detonation at which an entity is considered to be under fire.

Parameter Default Value: 1000.0
Parameter Units: meters

DtRwBoolean DtDamageComponentDescriptor::myUnderFireFromFriendly [protected]

Parameter Name: under-fire-from-friendly
Parameter Description: Determines if friendly fire should set the under fire condition.

Parameter Default Value: True

const DtDmgMunitionTable* DtDamageComponentDescriptor::myDamageModel [protected]

Parameter Name: damage-model
Parameter Description: Damage model for the entity (optional).

Parameter Default Value:

bool DtDamageComponentDescriptor::myOwnDamageModel [protected]

---

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

• include/vrfobjparam/dmgCompDesc.h