DtBallisticGunDescriptor; a descriptor for the DtBallisticGun component. More...

Inheritance diagram for DtBallisticGunDescriptor:

Public Member Functions
	DtBallisticGunDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBallisticGunDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunDescriptor (const DtBallisticGunDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBallisticGunDescriptor &	operator= (const DtBallisticGunDescriptor &orig)
	assignment
virtual	~DtBallisticGunDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtReal	muzzleSpeed () const
	Accessor/mutator for myMuzzleSpeed.
virtual void	setMuzzleSpeed (DtReal muzzleSpeed)
	Accessor/mutator for myMuzzleSpeed.

virtual int	roundsPerMagazine () const
	Accessor/mutator for myRoundsPerMagazine.
virtual void	setRoundsPerMagazine (int roundsPerMagazine)
	Accessor/mutator for myRoundsPerMagazine.

virtual int	roundsPerMinute () const
	Accessor/mutator for myRoundsPerMinute.
virtual void	setRoundsPerMinute (const int roundsPerMinute)
	Accessor/mutator for myRoundsPerMinute.

virtual DtReal	extraTimeBetweenBursts () const
	Accessor/mutator for myExtraTimeBetweenBursts.
virtual void	setExtraTimeBetweenBursts (const DtReal extraTimeBetweenBursts)
	Accessor/mutator for myExtraTimeBetweenBursts.

virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.

virtual DtReal	elevationRate () const
	Accessor/mutator for myElevationRate.
virtual void	setElevationRate (DtReal pElevationRate)
	Accessor/mutator for myElevationRate.

virtual DtReal	maxElevationRange () const
	Accessor/mutator for myMaxElevationRange.
virtual void	setMaxElevationRange (DtReal pElevationRange)
	Accessor/mutator for myMaxElevationRange.

virtual DtReal	minElevationRange () const
	Accessor/mutator for myMinElevationRange.
virtual void	setMinElevationRange (DtReal pElevationRange)
	Accessor/mutator for myMinElevationRange.

virtual DtReal	neutralElevation () const
	Accessor/mutator for myNeutralElevation.
virtual void	setNeutralElevation (DtReal elevation)
	Accessor/mutator for myNeutralElevation.

virtual const DtVector &	muzzleOffset () const
	Accessor/mutator for myMuzzleOffset.
virtual void	setMuzzleOffset (const DtVector &muzzleOffset)
	Accessor/mutator for myMuzzleOffset.

virtual bool	velocityCheck () const
	Accessor/mutator for myVelocityCheck.
virtual void	setVelocityCheck (bool check)
	Accessor/mutator for myVelocityCheck.

virtual const DtString &	hitProbabilityFilename ()
	Accessor/mutator for myHitProbabilityFile.
virtual void	setHitProbabilityFilename (const DtString &filename)
	Accessor/mutator for myHitProbabilityFile.

virtual const DtRangeProbabilityTable &	hitProbabilityTable () const
	Accessor/mutator for myHitProbabilityTable.
virtual void	setHitProbabilityTable (const DtRangeProbabilityTable &table)
	Accessor/mutator for myHitProbabilityTable.
Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtBallisticGunDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myElevationRate
	Parameter Name: max-elevation-rate Parameter Description: The elevation rate for the gun.
DtRwReal	myMaxElevationRange
	Parameter Name: max-elevation-range Parameter Description: The maximum elevation angle for the gun.
DtRwReal	myMinElevationRange
	Parameter Name: min-elevation-range Parameter Description: The minimum elevation angle for the gun.
DtRwReal	myNeutralElevation
	Parameter Name: neutral-elevation Parameter Description: The elevation that the gun starts at, and returns to when there are no targets.
DtRwReal	myMuzzleSpeed
	Parameter Name: muzzle-speed Parameter Description: This is used to find the muzzle velocity vector for the fire pdu and determine flyout time.
DtRwInt	myRoundsPerMagazine
	Parameter Name: rounds-per-magazine Parameter Description: This parameter allows modeling magazines that permit multiple shots/bursts before becoming unloaded.
DtRwInt	myRoundsPerMinute
	Parameter Name: rounds-per-minute Parameter Description: This parameter determines the gun cyclic rate when firing a burst.
DtRwReal	myExtraTimeBetweenBursts
	Parameter Name: extra-time-between-bursts Parameter Description: This parameter defines the extra time required between bursts before the gun is ready to fire again.
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 gun is fired.
DtRwBoolean	myVelocityCheck
	Parameter Name: velocity-affects-hit-chance Parameter Description: This parameter determines whether or not the relative velocity between the shooter and the target will affect the chance of hitting the target.
DtReaderWriterFile	myHitProbabilityFile
	Parameter Name: hit-probability-file Parameter Description: The file name of the hit probability table used to determine if a target was hit.
DtRangeProbabilityTable	myHitProbabilityTable
	Parameter Name: hit-probability-table Parameter Description: Table containing entries for probability of a hit versus target entity type and range.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.

Detailed Description

DtBallisticGunDescriptor; a descriptor for the DtBallisticGun component.

A DtComponentDescriptor that has additional information needed for providing parameters to the ballistic gun model -- hit probabilities, muzzle offset, and muzzle velocity.

The muzzleSpeed() and setMuzzleSpeed() member functions are used for the muzzle velocity specified in VR-Link fire interactions.

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtBallisticGunDescriptor::~DtBallisticGunDescriptor ( ) [virtual]

destructor

DtBallisticGunDescriptor::DtBallisticGunDescriptor ( ) [protected]

default constructor; not implemented

Member Function Documentation

DtBallisticGunDescriptor& DtBallisticGunDescriptor::operator= ( const DtBallisticGunDescriptor & orig )

assignment

virtual DtString DtBallisticGunDescriptor::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:: DtBallisticGunDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtBallisticGunDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtBallisticGunDescriptor::muzzleSpeed ( ) const [virtual]

Accessor/mutator for myMuzzleSpeed.

virtual void DtBallisticGunDescriptor::setMuzzleSpeed ( DtReal muzzleSpeed ) [virtual]

Accessor/mutator for myMuzzleSpeed.

virtual int DtBallisticGunDescriptor::roundsPerMagazine ( ) const [virtual]

Accessor/mutator for myRoundsPerMagazine.

virtual void DtBallisticGunDescriptor::setRoundsPerMagazine ( int roundsPerMagazine ) [virtual]

Accessor/mutator for myRoundsPerMagazine.

virtual int DtBallisticGunDescriptor::roundsPerMinute ( ) const [virtual]

Accessor/mutator for myRoundsPerMinute.

virtual void DtBallisticGunDescriptor::setRoundsPerMinute ( const int roundsPerMinute ) [virtual]

Accessor/mutator for myRoundsPerMinute.

virtual DtReal DtBallisticGunDescriptor::extraTimeBetweenBursts ( ) const [virtual]

Accessor/mutator for myExtraTimeBetweenBursts.

virtual void DtBallisticGunDescriptor::setExtraTimeBetweenBursts ( const DtReal extraTimeBetweenBursts ) [virtual]

Accessor/mutator for myExtraTimeBetweenBursts.

virtual const DtString& DtBallisticGunDescriptor::rangeName ( ) const [virtual]

Accessor/mutator for myRangeName.

virtual void DtBallisticGunDescriptor::setRangeName ( const DtString & rangeName ) [virtual]

Accessor/mutator for myRangeName.

virtual DtReal DtBallisticGunDescriptor::elevationRate ( ) const [virtual]

Accessor/mutator for myElevationRate.

virtual void DtBallisticGunDescriptor::setElevationRate ( DtReal pElevationRate ) [virtual]

Accessor/mutator for myElevationRate.

virtual DtReal DtBallisticGunDescriptor::maxElevationRange ( ) const [virtual]

Accessor/mutator for myMaxElevationRange.

virtual void DtBallisticGunDescriptor::setMaxElevationRange ( DtReal pElevationRange ) [virtual]

Accessor/mutator for myMaxElevationRange.

virtual DtReal DtBallisticGunDescriptor::minElevationRange ( ) const [virtual]

Accessor/mutator for myMinElevationRange.

virtual void DtBallisticGunDescriptor::setMinElevationRange ( DtReal pElevationRange ) [virtual]

Accessor/mutator for myMinElevationRange.

virtual DtReal DtBallisticGunDescriptor::neutralElevation ( ) const [virtual]

Accessor/mutator for myNeutralElevation.

virtual void DtBallisticGunDescriptor::setNeutralElevation ( DtReal elevation ) [virtual]

Accessor/mutator for myNeutralElevation.

virtual const DtVector& DtBallisticGunDescriptor::muzzleOffset ( ) const [virtual]

Accessor/mutator for myMuzzleOffset.

virtual void DtBallisticGunDescriptor::setMuzzleOffset ( const DtVector & muzzleOffset ) [virtual]

Accessor/mutator for myMuzzleOffset.

virtual bool DtBallisticGunDescriptor::velocityCheck ( ) const [virtual]

Accessor/mutator for myVelocityCheck.

virtual void DtBallisticGunDescriptor::setVelocityCheck ( bool check ) [virtual]

Accessor/mutator for myVelocityCheck.

virtual const DtString& DtBallisticGunDescriptor::hitProbabilityFilename ( ) [virtual]

Accessor/mutator for myHitProbabilityFile.

virtual void DtBallisticGunDescriptor::setHitProbabilityFilename ( const DtString & filename ) [virtual]

Accessor/mutator for myHitProbabilityFile.

virtual const DtRangeProbabilityTable& DtBallisticGunDescriptor::hitProbabilityTable ( ) const [virtual]

Accessor/mutator for myHitProbabilityTable.

virtual void DtBallisticGunDescriptor::setHitProbabilityTable ( const DtRangeProbabilityTable & table ) [virtual]

Accessor/mutator for myHitProbabilityTable.

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

DtRwReal DtBallisticGunDescriptor::myElevationRate [protected]

Parameter Name: max-elevation-rate
Parameter Description: The elevation rate for the gun.

Parameter Default Value: 0.0
Parameter Units: radians/second

DtRwReal DtBallisticGunDescriptor::myMaxElevationRange [protected]

Parameter Name: max-elevation-range
Parameter Description: The maximum elevation angle for the gun.

Assumed to be between 0.0 and +pi/2.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtBallisticGunDescriptor::myMinElevationRange [protected]

Parameter Name: min-elevation-range
Parameter Description: The minimum elevation angle for the gun.

Assumed to be between 0.0 and -pi/2.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtBallisticGunDescriptor::myNeutralElevation [protected]

Parameter Name: neutral-elevation
Parameter Description: The elevation that the gun starts at, and returns to when there are no targets.

Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtBallisticGunDescriptor::myMuzzleSpeed [protected]

Parameter Name: muzzle-speed
Parameter Description: This is used to find the muzzle velocity vector for the fire pdu and determine flyout time.

In body coordinates of the gun (may be an articulated part, or the entity itself).
Parameter Default Value: 0.0
Parameter Units: meters/second

DtRwInt DtBallisticGunDescriptor::myRoundsPerMagazine [protected]

Parameter Name: rounds-per-magazine
Parameter Description: This parameter allows modeling magazines that permit multiple shots/bursts before becoming unloaded.

The gun system only pays the reloading time cost when the magazine is empty.
Parameter default value: 1
Parameter unit: Rounds per magazine

DtRwInt DtBallisticGunDescriptor::myRoundsPerMinute [protected]

Parameter Name: rounds-per-minute
Parameter Description: This parameter determines the gun cyclic rate when firing a burst.

It is used to determine the length (time) of a burst.
Parameter default value: 500
Parameter unit: Rounds per minute.

DtRwReal DtBallisticGunDescriptor::myExtraTimeBetweenBursts [protected]

Parameter Name: extra-time-between-bursts
Parameter Description: This parameter defines the extra time required between bursts before the gun is ready to fire again.

This can be used, for example, to define a cooling off period to prevent the gun from overheating. Most semi-auto and single-shot weapons should leave this 0.
Parameter default value: 0
Parameter unit: seconds

DtRwVector DtBallisticGunDescriptor::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 gun is fired.

If an articulated part has been specified to represent the gun, 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

DtRwBoolean DtBallisticGunDescriptor::myVelocityCheck [protected]

Parameter Name: velocity-affects-hit-chance
Parameter Description: This parameter determines whether or not the relative velocity between the shooter and the target will affect the chance of hitting the target.

Parameter Default Value: false

DtReaderWriterFile DtBallisticGunDescriptor::myHitProbabilityFile [protected]

Parameter Name: hit-probability-file
Parameter Description: The file name of the hit probability table used to determine if a target was hit.

Parameter Default Value: ""

DtRangeProbabilityTable DtBallisticGunDescriptor::myHitProbabilityTable [protected]

Parameter Name: hit-probability-table
Parameter Description: Table containing entries for probability of a hit versus target entity type and range.

Parameter Default Value:

DtRwString DtBallisticGunDescriptor::myRangeName [protected]

Name given to any range item associated with this descriptor.

Parameter Default Value:

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