DtBallisticGunDescriptor Class Reference

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.

Inheritance diagram for DtBallisticGunDescriptor:

Public Member Functions
	DtBallisticGunDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunDescriptor (const DtBallisticGunDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtBallisticGunDescriptor &	operator= (const DtBallisticGunDescriptor &orig)
virtual	~DtBallisticGunDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual DtReal	muzzleSpeed () const
virtual void	setMuzzleSpeed (DtReal muzzleSpeed)
virtual int	roundsPerMagazine () const
virtual void	setRoundsPerMagazine (int roundsPerMagazine)
virtual int	roundsPerMinute () const
virtual void	setRoundsPerMinute (const int roundsPerMinute)
virtual DtReal	extraTimeBetweenBursts () const
virtual void	setExtraTimeBetweenBursts (const DtReal extraTimeBetweenBursts)
virtual bool	startWithTracers () const
virtual void	setStartWithTracers (const bool)
virtual const DtString &	rangeName () const
virtual void	setRangeName (const DtString &rangeName)
virtual int	rangeId () const
virtual void	setRangeId (int rangeId)
virtual bool	rangeIdIsSpecified () const
virtual DtReal	elevationRate () const
virtual void	setElevationRate (DtReal pElevationRate)
virtual bool	isElevationRateSpecified () const
virtual DtReal	maxElevationRange () const
virtual void	setMaxElevationRange (DtReal pElevationRange)
virtual bool	isMaxElevationRangeSpecified () const
virtual DtReal	minElevationRange () const
virtual void	setMinElevationRange (DtReal pElevationRange)
virtual bool	isMinElevationRangeSpecified () const
virtual DtReal	neutralElevation () const
virtual void	setNeutralElevation (DtReal elevation)
virtual bool	isNeutralElevationSpecified () const
virtual const DtVector &	muzzleOffset () const
virtual void	setMuzzleOffset (const DtVector &muzzleOffset)
virtual bool	isMuzzleOffsetSpecified () const
virtual bool	velocityCheck () const
virtual void	setVelocityCheck (bool check)
virtual const DtString &	hitProbabilityFilename ()
virtual void	setHitProbabilityFilename (const DtString &filename)
virtual const DtRangeProbabilityTable &	hitProbabilityTable () const
virtual void	setHitProbabilityTable (const DtRangeProbabilityTable &table)
virtual bool	detonateOnMiss () const
virtual void	setDetonateOnMiss (bool detonateOnMiss)
virtual bool	hitOwnForce () const
virtual void	setHitOwnForce (bool hitOwnForce)
virtual int	roundsPerDetonation () const
virtual void	setRoundsPerDetonation (const int rpd)
virtual double	maxSkillLevelEffect () const
virtual void	setMaxSkillLevelEffect (const double teffect)
virtual double	burstCep () const
virtual void	setBurstCep (const double radius)
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
virtual	~DtActuatorComponentDescriptor ()
virtual void	postGetSelf ()
virtual void	setDefaultArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
virtual const DtSimArtPartDescriptorList &	defaultArtPartDescriptorList () const
virtual DtSimArtPartDescriptorList &	defaultArtPartDescriptorList ()
virtual void	setArtPartTypes (const ArtPartTypeSet &partTypes)
virtual const ArtPartTypeSet &	artPartTypes () const
virtual DtArtPartType	firstArtPartType () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtActuatorComponentDescriptor
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
	DtBallisticGunDescriptor ()
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myElevationRate
DtRwReal	myMaxElevationRange
DtRwReal	myMinElevationRange
DtRwReal	myNeutralElevation
DtRwReal	myMuzzleSpeed
DtRwInt	myRoundsPerMagazine
DtRwInt	myRoundsPerMinute
DtRwReal	myExtraTimeBetweenBursts
DtRwBoolean	myStartWithTracers
DtRwOffsetVector	myMuzzleOffset
DtRwBoolean	myVelocityCheck
DtReaderWriterFile	myHitProbabilityFile
DtRangeProbabilityTable	myHitProbabilityTable
DtRwString	myRangeName
DtRwInt	myRangeId
DtRwBoolean	myDetonateOnMiss
DtRwBoolean	myHitOwnForce
DtRwInt	myRoundsPerDetonation
DtRwReal	myBurstCep
DtRwReal	myMaxSkillLevelEffect
Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myTickPeriodUsesRealTime
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtActuatorComponentDescriptor
typedef std::set< DtArtPartType >	ArtPartTypeSet
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

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.

Reimplemented in DtHumanGunActuatorDescriptor.

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

virtual

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtHumanGunActuatorDescriptor.

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 bool DtBallisticGunDescriptor::startWithTracers ( ) const

virtual

Accessor/mutator for myStartWithTracers.

virtual void DtBallisticGunDescriptor::setStartWithTracers ( const bool  )

virtual

Accessor/mutator for myStartWithTracers.

virtual const DtString& DtBallisticGunDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName. Deprecated.

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

virtual

Accessor/mutator for myRangeName. Deprecated.

virtual int DtBallisticGunDescriptor::rangeId ( ) const

virtual

Accessor/mutator for myRangeId.

virtual void DtBallisticGunDescriptor::setRangeId ( int  rangeId )

virtual

Accessor/mutator for myRangeId.

virtual bool DtBallisticGunDescriptor::rangeIdIsSpecified ( ) const

virtual

Accessor/mutator for myRangeId.

virtual DtReal DtBallisticGunDescriptor::elevationRate ( ) const

virtual

Accessor/mutator for myElevationRate.

virtual void DtBallisticGunDescriptor::setElevationRate ( DtReal  pElevationRate )

virtual

Accessor/mutator for myElevationRate.

virtual bool DtBallisticGunDescriptor::isElevationRateSpecified ( ) const

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 bool DtBallisticGunDescriptor::isMaxElevationRangeSpecified ( ) const

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 bool DtBallisticGunDescriptor::isMinElevationRangeSpecified ( ) const

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 bool DtBallisticGunDescriptor::isNeutralElevationSpecified ( ) const

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::isMuzzleOffsetSpecified ( ) const

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.

virtual bool DtBallisticGunDescriptor::detonateOnMiss ( ) const

virtual

Accessor/mutator for myDetonateOnMiss.

virtual void DtBallisticGunDescriptor::setDetonateOnMiss ( bool  detonateOnMiss )

virtual

Accessor/mutator for myDetonateOnMiss.

virtual bool DtBallisticGunDescriptor::hitOwnForce ( ) const

virtual

Accessor/mutator for myHitOwnForce.

virtual void DtBallisticGunDescriptor::setHitOwnForce ( bool  hitOwnForce )

virtual

Accessor/mutator for myHitOwnForce.

virtual int DtBallisticGunDescriptor::roundsPerDetonation ( ) const

virtual

Accessor/mutator for myRoundsPerDetonation.

virtual void DtBallisticGunDescriptor::setRoundsPerDetonation ( const int  rpd )

virtual

Accessor/mutator for myRoundsPerDetonation.

virtual double DtBallisticGunDescriptor::maxSkillLevelEffect ( ) const

virtual

Accessor/mutator for myMaxSkillLevelEffect.

virtual void DtBallisticGunDescriptor::setMaxSkillLevelEffect ( const double  teffect )

virtual

Accessor/mutator for myMaxSkillLevelEffect.

virtual double DtBallisticGunDescriptor::burstCep ( ) const

virtual

Accessor/mutator for myBurstCep. The radius of a circle within which 50% of the rounds of a burst will pass, at 1m range.

virtual void DtBallisticGunDescriptor::setBurstCep ( const double  radius )

virtual

Accessor/mutator for myBurstCep. The radius of a circle within which 50% of the rounds of a burst will pass, at 1m range.

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.

virtual void DtBallisticGunDescriptor::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Determines whether or not to save the hit table or hit file out.

Reimplemented from DtReaderWriter.

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.

DtRwBoolean DtBallisticGunDescriptor::myStartWithTracers

protected

Parameter Name: start-with-tracers
Parameter Description: This parameter determines whether the gun will use tracers when the gun is first created. That is, when a munition is selected in the ammunition selection table, the tracer-type, if specified in that table, will be entered in the fire and detonation interactions instead of the munition-type. After the gun is created, the use of tracers can be turned on and off with the set-tracer-use command.
Parameter Default Value: false
Parameter Unit:

DtRwOffsetVector 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

Parameter Name: range-name Parameter Description: Deprecated Name given to any range item associated with this descriptor. Parameter Default Value:
.

DtRwInt DtBallisticGunDescriptor::myRangeId

protected

Parameter Name: range-id
Parameter Description: The identifying value for this range ring. Can be converted to a string based on configured enumeration values.
Parameter Default Value: 0
.

DtRwBoolean DtBallisticGunDescriptor::myDetonateOnMiss

protected

Parameter Name: detonate-on-miss
Parameter Description: This parameter determines whether or not a detonation interaction should be created when a shot misses.
Parameter Default Value: true
.

DtRwBoolean DtBallisticGunDescriptor::myHitOwnForce

protected

Parameter Name: hit-own-force
Parameter Description: This parameter determines whether or not an entity of own force will be hit when a shot misses.
Parameter Default Value: true
.

DtRwInt DtBallisticGunDescriptor::myRoundsPerDetonation

protected

Parameter Name: rounds-per-detonation
Parameter Description: This parameter determines how many rounds can be in one detonation interaction/PDU. If the burst size is greater than this, then more than one detonation is created.
Parameter Default Value: 100.

DtRwReal DtBallisticGunDescriptor::myBurstCep

protected

Parameter Name: burst-cep
Parameter Description: This parameter (CEP) defines the radius of the circle at a range of 1 meter that will contain 50% of the rounds of the burst. Burst detonations beyond the first detonation will be randomly placed according to this error parameter.
Parameter Default Value: 0.01.

DtRwReal DtBallisticGunDescriptor::myMaxSkillLevelEffect

protected

Parameter Name: max-skill-level-effect
Parameter Description: This parameter describes the maximum effect on the hit probability based on the skill level of the entity. No training will have the maximum effect on the hit probablity
Parameter Default Value: 0.25 a 25% reduction on the hit probability.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/ballisticGunDescriptor.h