DtWarheadDetonationActuatorDescriptor Class Reference

DtWarheadDetonationActuatorDescriptor; descriptor for the DtWarheadDetonationActuator component. More...

Inheritance diagram for DtWarheadDetonationActuatorDescriptor:

List of all members.

Public Member Functions
	DtWarheadDetonationActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtWarheadDetonationActuatorDescriptor (const DtWarheadDetonationActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtWarheadDetonationActuatorDescriptor &	operator= (const DtWarheadDetonationActuatorDescriptor &orig)
	assignment
virtual	~DtWarheadDetonationActuatorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	groundImpactDetonate () const
	Accessor/mutator for myGroundImpactDetonate.
virtual void	setGroundImpactDetonate (bool d)
	Accessor/mutator for myGroundImpactDetonate.
virtual bool	waterImpactDetonate () const
	Accessor/mutator for myWaterImpactDetonate.
virtual void	setWaterImpactDetonate (bool d)
	Accessor/mutator for myWaterImpactDetonate.
virtual bool	entityImpactDetonate () const
	Accessor/mutator for myEntityImpactDetonate.
virtual void	setEntityImpactDetonate (bool d)
	Accessor/mutator for myEntityImpactDetonate.
virtual bool	removeEntityUponDetonation () const
	Accessor/mutator for myRemoveOnDetonation.
virtual void	setRemoveEntityUponDetonation (bool b)
	Accessor/mutator for myRemoveOnDetonation.
virtual bool	allowDirectHit () const
virtual void	setAllowDirectHit (bool b)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myGroundImpactDetonate
	Parameter Name: detonate-on-ground-impact Parameter Description: True if warhead will detonate upon contact with a dry terrain surface.
DtRwBoolean	myWaterImpactDetonate
	Parameter Name: detonate-on-water-impact Parameter Description: True if warhead will detonate upon contact with a wet terrain surface.
DtRwBoolean	myEntityImpactDetonate
	Parameter Name: detonate-on-entity-impact Parameter Description: True if this warhead will detonate upon contact with another entity's bounding volume.
DtRwBoolean	myRemoveOnDetonation
	Parameter Name: remove-on-detonation Parameter Description: True if you want to have the entity removed once it detonates Parameter Default Value: True.
DtRwBoolean	myAllowDirectHit
	Parameter Name: allow-direct-hit Parameter Description: If true, then the warhead will produce a direct hit detonation PDU if it impacts a specific entity.
Private Member Functions
	DtWarheadDetonationActuatorDescriptor ()
	default constructor -- not implemented.

---

Detailed Description

DtWarheadDetonationActuatorDescriptor; descriptor for the DtWarheadDetonationActuator component.

Parameters for the DtWarheadDetonationActuator. Determines under what circumstances the warhead will detonate.

---

Constructor & Destructor Documentation

DtWarheadDetonationActuatorDescriptor::DtWarheadDetonationActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtWarheadDetonationActuatorDescriptor::DtWarheadDetonationActuatorDescriptor	(	const DtWarheadDetonationActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtWarheadDetonationActuatorDescriptor::~DtWarheadDetonationActuatorDescriptor

(

)

[virtual]

destructor

DtWarheadDetonationActuatorDescriptor::DtWarheadDetonationActuatorDescriptor

(

)

[private]

default constructor -- not implemented.

---

Member Function Documentation

DtWarheadDetonationActuatorDescriptor& DtWarheadDetonationActuatorDescriptor::operator=

(

const DtWarheadDetonationActuatorDescriptor &

orig

)

assignment

virtual DtString DtWarheadDetonationActuatorDescriptor::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:

DtWarheadDetonationActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtWarheadDetonationActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual bool DtWarheadDetonationActuatorDescriptor::groundImpactDetonate

(

)

const [virtual]

Accessor/mutator for myGroundImpactDetonate.

virtual void DtWarheadDetonationActuatorDescriptor::setGroundImpactDetonate

(

bool

d

)

[virtual]

Accessor/mutator for myGroundImpactDetonate.

virtual bool DtWarheadDetonationActuatorDescriptor::waterImpactDetonate

(

)

const [virtual]

Accessor/mutator for myWaterImpactDetonate.

virtual void DtWarheadDetonationActuatorDescriptor::setWaterImpactDetonate

(

bool

d

)

[virtual]

Accessor/mutator for myWaterImpactDetonate.

virtual bool DtWarheadDetonationActuatorDescriptor::entityImpactDetonate

(

)

const [virtual]

Accessor/mutator for myEntityImpactDetonate.

virtual void DtWarheadDetonationActuatorDescriptor::setEntityImpactDetonate

(

bool

d

)

[virtual]

Accessor/mutator for myEntityImpactDetonate.

virtual bool DtWarheadDetonationActuatorDescriptor::removeEntityUponDetonation

(

)

const [virtual]

Accessor/mutator for myRemoveOnDetonation.

virtual void DtWarheadDetonationActuatorDescriptor::setRemoveEntityUponDetonation

(

bool

b

)

[virtual]

Accessor/mutator for myRemoveOnDetonation.

virtual bool DtWarheadDetonationActuatorDescriptor::allowDirectHit

(

)

const [virtual]

See also:

myAllowDirectHit

virtual void DtWarheadDetonationActuatorDescriptor::setAllowDirectHit

(

bool

b

)

[virtual]

See also:

myAllowDirectHit

static DtComponentDescriptor* DtWarheadDetonationActuatorDescriptor::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

DtRwBoolean DtWarheadDetonationActuatorDescriptor::myGroundImpactDetonate [protected]

Parameter Name: detonate-on-ground-impact
Parameter Description: True if warhead will detonate upon contact with a dry terrain surface.

Parameter Default Value: True

DtRwBoolean DtWarheadDetonationActuatorDescriptor::myWaterImpactDetonate [protected]

Parameter Name: detonate-on-water-impact
Parameter Description: True if warhead will detonate upon contact with a wet terrain surface.

Parameter Default Value: True

DtRwBoolean DtWarheadDetonationActuatorDescriptor::myEntityImpactDetonate [protected]

Parameter Name: detonate-on-entity-impact
Parameter Description: True if this warhead will detonate upon contact with another entity's bounding volume.

Parameter Default Value: True

DtRwBoolean DtWarheadDetonationActuatorDescriptor::myRemoveOnDetonation [protected]

Parameter Name: remove-on-detonation
Parameter Description: True if you want to have the entity removed once it detonates
Parameter Default Value: True.

DtRwBoolean DtWarheadDetonationActuatorDescriptor::myAllowDirectHit [protected]

Parameter Name: allow-direct-hit
Parameter Description: If true, then the warhead will produce a direct hit detonation PDU if it impacts a specific entity.

If false, it will always result in a indirect fire detonation capable of hurting multiple entities, even if it directly impacts on a single entity. Parameter Default Value: True

---

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

• include/vrfobjparam/warheadDetActDesc.h