VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Private Attributes
DtDetonationContext Class Reference

The DtDetonationContext contains all the information necessary for processing a Detonation Interaction for damage adjudication or other information. More...

Public Member Functions

 DtDetonationContext (const DtDetonationInteraction &detonationInteraction)
virtual ~DtDetonationContext ()
virtual const
DtDetonationInteraction
detonationInter () const
 The detonation to which this context refers.
virtual void setIsDirectFire (bool isDirect)
 Indicates whether this detonation is in reference to direct fire or not.
virtual bool isDirectFire () const
virtual void setRange (double range)
 When isDirectFire returns true, this range is between the attacker and target.
virtual double range () const
virtual void setSurface (const DtSymbolString &surface)
 The impacted surface of the target.
virtual DtSymbolString surface () const
virtual void setAngleOfIncidence (double angleOfIncidence)
 The angle of incidence of the impact, in relation to the target.
virtual double angleOfIncidence () const
virtual void setMunition (const DtSimMunition &munition)
 The munition associated with the detonation.
virtual const DtSimMunitionmunition () const

Private Attributes

const DtDetonationInteractionmyDetonationInteraction
DtSimMunition myMunition
 ! Default values:
bool myIsDirectFire
 !
DtSymbolString mySurface
 ! false
double myAngleOfIncidence
 ! "front"
double myRange
 ! 0.0

Detailed Description

The DtDetonationContext contains all the information necessary for processing a Detonation Interaction for damage adjudication or other information.

Note
As of VRF 3.9 shooterObjId() has been removed. To get the same functionallity, call deonationInter().attackerId() when isDirectFire() is true, and deonationInter().munitionId() with isDirectFile() is false.

Constructor & Destructor Documentation

DtDetonationContext::DtDetonationContext ( const DtDetonationInteraction detonationInteraction)
virtual DtDetonationContext::~DtDetonationContext ( )
virtual

Member Function Documentation

virtual const DtDetonationInteraction& DtDetonationContext::detonationInter ( ) const
virtual

The detonation to which this context refers.

virtual void DtDetonationContext::setIsDirectFire ( bool  isDirect)
virtual

Indicates whether this detonation is in reference to direct fire or not.

Direct fire is fire, such as a bullet or tank shell, which must impact on its target to damage it.

virtual bool DtDetonationContext::isDirectFire ( ) const
virtual
virtual void DtDetonationContext::setRange ( double  range)
virtual

When isDirectFire returns true, this range is between the attacker and target.

Otherwise, this is the range from the detonation to the target.

virtual double DtDetonationContext::range ( ) const
virtual
virtual void DtDetonationContext::setSurface ( const DtSymbolString surface)
virtual

The impacted surface of the target.

virtual DtSymbolString DtDetonationContext::surface ( ) const
virtual
virtual void DtDetonationContext::setAngleOfIncidence ( double  angleOfIncidence)
virtual

The angle of incidence of the impact, in relation to the target.

virtual double DtDetonationContext::angleOfIncidence ( ) const
virtual
virtual void DtDetonationContext::setMunition ( const DtSimMunition munition)
virtual

The munition associated with the detonation.

virtual const DtSimMunition& DtDetonationContext::munition ( ) const
virtual

Member Data Documentation

const DtDetonationInteraction& DtDetonationContext::myDetonationInteraction
private
DtSimMunition DtDetonationContext::myMunition
private

! Default values:

bool DtDetonationContext::myIsDirectFire
private

!

DtSymbolString DtDetonationContext::mySurface
private

! false

double DtDetonationContext::myAngleOfIncidence
private

! "front"

double DtDetonationContext::myRange
private

! 0.0


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)