DtWeaponActuatorDescriptor Class Reference

DtWeaponActuatorDescriptor; descriptor for the DtWeaponActuator component. More...

Inheritance diagram for DtWeaponActuatorDescriptor:

List of all members.

Public Member Functions
	DtWeaponActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtWeaponActuatorDescriptor (const DtWeaponActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtWeaponActuatorDescriptor &	operator= (const DtWeaponActuatorDescriptor &orig)
	assignment
virtual	~DtWeaponActuatorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	projectileStartSpeed () const
	Accessor/mutator for myProjectileStartSpeed.
virtual void	setProjectileStartSpeed (DtReal startSpeed)
	Accessor/mutator for myProjectileStartSpeed.
virtual const DtVector &	muzzleOffset () const
	Accessor/mutator for myMuzzleOffset.
virtual void	setMuzzleOffset (const DtVector &muzzleOffset)
	Accessor/mutator for myMuzzleOffset.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtWeaponActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myProjectileStartSpeed
	Parameter Name: projectile-start-speed Parameter Description: Used in calculating the projectile velocity vector for the fire PDU and in determining flyout time.
DtRwVector	myMuzzleOffset
	Parameter Name: muzzle-offset Parameter Description: This vector is an offset used to set the position of a fire PDU/interaction when the weapon is fired.

---

Detailed Description

DtWeaponActuatorDescriptor; descriptor for the DtWeaponActuator component.

DtWeaponActuatorDescriptor is a DtComponentDescriptor that has additional information needed for providing parameters to any weapon model -- muzzle offset and muzzle velocity.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtWeaponActuatorDescriptor::~DtWeaponActuatorDescriptor

(

)

[virtual]

destructor

DtWeaponActuatorDescriptor::DtWeaponActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtWeaponActuatorDescriptor& DtWeaponActuatorDescriptor::operator=

(

const DtWeaponActuatorDescriptor &

orig

)

assignment

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

DtWeaponActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtIndirectFireActuatorDescriptor.

virtual DtComponentDescriptor* DtWeaponActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtIndirectFireActuatorDescriptor.

virtual DtReal DtWeaponActuatorDescriptor::projectileStartSpeed

(

)

const [virtual]

Accessor/mutator for myProjectileStartSpeed.

virtual void DtWeaponActuatorDescriptor::setProjectileStartSpeed

(

DtReal

startSpeed

)

[virtual]

Accessor/mutator for myProjectileStartSpeed.

virtual const DtVector& DtWeaponActuatorDescriptor::muzzleOffset

(

)

const [virtual]

Accessor/mutator for myMuzzleOffset.

virtual void DtWeaponActuatorDescriptor::setMuzzleOffset

(

const DtVector &

muzzleOffset

)

[virtual]

Accessor/mutator for myMuzzleOffset.

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

Reimplemented in DtIndirectFireActuatorDescriptor.

---

Member Data Documentation

DtRwReal DtWeaponActuatorDescriptor::myProjectileStartSpeed [protected]

Parameter Name: projectile-start-speed
Parameter Description: Used in calculating the projectile velocity vector for the fire PDU and in determining flyout time.

Parameter Default Value: 0.
Parameter Units: meters/second

DtRwVector DtWeaponActuatorDescriptor::myMuzzleOffset [protected]

Parameter Name: muzzle-offset Parameter Description: This vector is an offset used to set the position of a fire PDU/interaction when the weapon is fired.

If an articulated part has been specified to represent the weapon, then this offset is in the body coordinate system of the gun articulated part. If no articulated part is specified to represent the gun, then this offset is in the body coordinate system of the entity. In a body coordinate system, the axes are specified as follows:

• x-axis points out of the 'front' of the object
  
• y-axis points out of the 'side' of the object
  
• z-axis points out of the 'bottom' of the object Parameter Default Value: 0.0
  Parameter Units: meters

---

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

• include/vrfobjparam/weaponDesc.h