DtDetonationContext Class Reference

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.

Public Types
typedef std::map< DtString, double >	DetonationPowerMap

Public Member Functions
	DtDetonationContext ()
	DtDetonationContext (const makVrfEvents::DtDetonationEvent &detonationInteraction)
DtDetonationContext &	operator= (const DtDetonationContext &orig)
virtual	~DtDetonationContext ()
virtual const makVrfEvents::DtDetonationEvent &	detonationInter () const
virtual void	setIsDirectFire (bool isDirect)
virtual bool	isDirectFire () const
virtual void	setRange (double range)
virtual double	range () const
virtual void	setEventId (const DtString &id)
virtual const DtString &	eventId () const
virtual void	setSurface (const DtSymbolString &surface)
virtual DtSymbolString	surface () const
virtual void	setAngleOfIncidence (double angleOfIncidence)
virtual double	angleOfIncidence () const
virtual void	setMunition (const DtSimMunition &munition)
virtual const DtSimMunition &	munition () const
virtual void	setDetonationPowers (const DetonationPowerMap &powers)
virtual void	setDetonationPower (const DtString &powerType, double power)
virtual void	clearDetonationPowers ()
virtual const DetonationPowerMap &	detonationPowers () const
virtual double	detonationPower (const DtString &powerType) const

Protected Attributes
makVrfEvents::DtDetonationEvent	myDetonationInteraction
DtSimMunition	myMunition
bool	myIsDirectFire
DtSymbolString	mySurface
double	myAngleOfIncidence
double	myRange
DetonationPowerMap	myPowers
DtString	myEventId

Member Typedef Documentation

typedef std::map<DtString, double> DtDetonationContext::DetonationPowerMap

Constructor & Destructor Documentation

DtDetonationContext::DtDetonationContext

(

)

DtDetonationContext::DtDetonationContext

(

const makVrfEvents::DtDetonationEvent &

detonationInteraction

)

virtual DtDetonationContext::~DtDetonationContext ( )

virtual

Member Function Documentation

DtDetonationContext& DtDetonationContext::operator=

(

const DtDetonationContext &

orig

)

virtual const makVrfEvents::DtDetonationEvent& 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::setEventId ( const DtString &  id )

virtual

Set the EventId of the incoming detonation interaction This can be useful in places where you want to make sure the detonation isn't counted twice.

virtual const DtString& DtDetonationContext::eventId ( ) 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

virtual void DtDetonationContext::setDetonationPowers ( const DetonationPowerMap &  powers )

virtual

The power of the detonation at the target's location for each relevant type of power.

virtual void DtDetonationContext::setDetonationPower ( const DtString &  powerType, double  power  )

virtual

virtual void DtDetonationContext::clearDetonationPowers ( )

virtual

virtual const DetonationPowerMap& DtDetonationContext::detonationPowers ( ) const

virtual

virtual double DtDetonationContext::detonationPower ( const DtString &  powerType ) const

virtual

Member Data Documentation

makVrfEvents::DtDetonationEvent DtDetonationContext::myDetonationInteraction

protected

DtSimMunition DtDetonationContext::myMunition

protected

! Default values:

bool DtDetonationContext::myIsDirectFire

protected

!

DtSymbolString DtDetonationContext::mySurface

protected

! false

double DtDetonationContext::myAngleOfIncidence

protected

! "front"

double DtDetonationContext::myRange

protected

! 0.0

DetonationPowerMap DtDetonationContext::myPowers

protected

! 4000.0

DtString DtDetonationContext::myEventId

protected

---

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

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