DtMultipleHitDamageActuator Class Reference

A damage actuator that keeps track of "Hit Points" for an entity.

This subclass of DtDamageAdjudicationActuator adds a concept of Hit Points to the damage system, instead of an entity being destroyed by a single detonation. The same probability tables from DtDamageAdjudicationActuator are used to process a detonation, and determine if it hits the entity, however in this class, if the detonation causes damage to the entity, a hit point is removed. The damaged state of the entity changes at particular levels of hit \ points remaining.

The DtMultipleHitDamageActuatorDescriptor that is used with this class specifies the starting number of hit points. When the current hit points reach 0, the entity becomes destroyed. The descriptor also specified the firepower kill points and mobility kill points. When the remaining number of hit points is equal to or below these numbers, these partial kill states are entered.

Uses Descriptor Type: DtMultipleHitDamageActuatorDescriptor

Inheritance diagram for DtMultipleHitDamageActuator:

Public Member Functions
	DtMultipleHitDamageActuator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtMultipleHitDamageActuator () override
virtual bool	init () override
virtual bool	createPSR () override
virtual void	preFirstTickInit () override
virtual void	tick () override
virtual bool	adjudicateDirectDamage (const DtDetonationContext &detonationContext) override
virtual bool	adjudicateCollateralDamage (const DtDetonationContext &detonationContext) override
virtual const char *	type () const override
Public Member Functions inherited from DtDamageAdjudicationActuator
	DtDamageAdjudicationActuator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtDamageAdjudicationActuator () override
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent () override
virtual DtSimRadio *	radio ()
virtual bool	tickWhileDestroyed () const override
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent () override
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual bool	postAddComponentsInit ()
virtual void	registerAttributeFunctions ()
virtual void	postTick ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)
virtual void	setupFirstTickTime ()
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual void	isClutterChanged ()
virtual bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
virtual void	onRestore ()
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual void	updateImgui ()
virtual bool	debugActive () const
virtual void	enable ()
virtual void	disable ()
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const
virtual int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
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) const
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
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	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 DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
Static Public Member Functions inherited from DtDamageAdjudicationActuator
static bool	processDirectDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
static bool	processCollateralDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
static void	setDestroyedCallback (DtSimMessage *msg, void *usrData)
static void	setRestoredCallback (DtSimMessage *msg, void *usrData)
static void	setInvulnerableCallback (DtSimMessage *msg, void *usrData)
static void	setFunctionDamageStatusCallback (DtSimMessage *msg, void *usrData)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
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
virtual void	checkDamageType (const DtDetonationContext &detonationContext, bool isDirectDamage=true)
virtual bool	getProbabilities (const DtDetonationContext &detonationContext, DtPrbValueList &probabilities, bool isDirectDamage=true)
virtual void	getImpactZoneFromDirectFire (DtDetonationContext &detonationContext) override
virtual void	getImpactZoneFromIndirectFire (DtDetonationContext &detonationContext) override
virtual bool	assessDamagePoints (const DtDetonationContext &detContext)
virtual bool	getDamagePoints (const DtDetonationContext &detContext, DtPrbValueList &damagePointsEntry)
virtual DtSymbolString	getSurface (DtBoundingVolumeFace impactSurface)
virtual bool	isFirepowerKilled (DtPrbValueList &probabilities, DtSymbolString firepowerKillString) const
virtual bool	isMobilityKilled (DtPrbValueList &probabilities, DtSymbolString mobilityKillString) const
virtual bool	isSensorsKilled (DtPrbValueList &probabilities, DtSymbolString sensorsKillString) const
virtual double	getPossibleDamagePoints (DtPrbValueList &damagePointsList, DtSymbolString damageString) const
virtual DtSymbolString	maximumDamageString () const
virtual DtSymbolString	minimumDamageString () const
virtual void	setRestored () override
virtual void	setDamagePoints (double current)
Protected Member Functions inherited from DtDamageAdjudicationActuator
virtual bool	isCatastrophicallyKilled () const
virtual bool	isFirepowerKilled () const
virtual bool	isMobilityKilled () const
virtual bool	isSensorsKilled () const
virtual DtSymbolString	catastrophicKillString () const
virtual DtSymbolString	mobilityKillString () const
virtual DtSymbolString	firepowerKillString () const
virtual DtSymbolString	sensorsKillString () const
virtual bool	protectedFromCollateralDamageByEmbarkation () const
virtual void	determineDestroyedStatus ()
virtual void	determineDamageIfEmbarked ()
virtual void	setDestroyed ()
virtual void	processSetInvulnerable (DtSimMessage *msg)
virtual void	processSetFunctionDamageStatus (DtSimMessage *msg)
virtual bool	registerForDetonations ()
virtual bool	unregisterForDetonations ()
virtual void	setMobilityKilled (bool consoleWarn=true)
virtual void	setFirepowerKilled (bool consoleWarn=true)
virtual void	setSensorsKilled (bool consoleWarn=true)
virtual void	setRadio (DtSimRadio *radio) override
virtual void	triggerDestructionExplosions ()
virtual void	updateDestructionExplosions ()
virtual void	sendDetonation (const DtRwExplosionEntry &explosionEntry)
virtual DtVector	positionOnEntity (const DtVector &percentOffset)
virtual bool	isRegisteredForDetonations () const
virtual void	setIsRegisteredForDetonations (bool yesOrNo)
Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	DtActuatorComponent ()
Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)
virtual double	computeCurrentTime ()
bool	testInvariant () const
virtual bool	createPortGroups ()
virtual bool	createPorts ()
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	updateTaskVisualizations ()
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const
template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
const DtMultipleHitDamageActuatorDescriptor *	myMultipleHitDamageComponentDescriptor
double	myTotalDamagePoints
DtMultipleHitDamagePSR *	myMHDProcessState
DtString	myCurrentId
Protected Attributes inherited from DtDamageAdjudicationActuator
DtDamageAdjudicationComponentDescriptor *	myDamageComponentDescriptor
DtDamageAdjudicationPSR *	myProcessState
bool	myIsRegisteredForDetonations
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
DtHumanLocalObjectFacade	myHumanLocalObjectFacade
std::set< DtString >	myProcessedEvents
Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myLastTickSimTime
std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager *	myPredicateCallbackManager
boost::signals2::scoped_connection	myIsClutterChangedConnection
bool	myLocalDebug
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

Private Member Functions
	DtMultipleHitDamageActuator ()=delete
	DtMultipleHitDamageActuator (const DtMultipleHitDamageActuator &orig)=delete
DtMultipleHitDamageActuator &	operator= (const DtMultipleHitDamageActuator &orig)=delete

Additional Inherited Members
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 )()
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	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

DtMultipleHitDamageActuator::DtMultipleHitDamageActuator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = nullptr,
		DtReaderWriterRegistry *	parentRegistry = nullptr
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

virtual DtMultipleHitDamageActuator::~DtMultipleHitDamageActuator ( )

overridevirtual

destructor Unregisters with the detonation manager.

DtMultipleHitDamageActuator::DtMultipleHitDamageActuator ( )

privatedelete

Default constructor; not implemented.

DtMultipleHitDamageActuator::DtMultipleHitDamageActuator ( const DtMultipleHitDamageActuator &  orig )

privatedelete

copy constructor; not implemented

Member Function Documentation

virtual bool DtMultipleHitDamageActuator::init ( )

overridevirtual

Overridden from the base class to call createPSR().

Reimplemented from DtDamageAdjudicationActuator.

virtual bool DtMultipleHitDamageActuator::createPSR ( )

overridevirtual

Create a process state repository, or a different type if it is specified in the OPD.

Reimplemented from DtDamageAdjudicationActuator.

virtual void DtMultipleHitDamageActuator::preFirstTickInit ( )

overridevirtual

Overridden to set up from PSR - if the current hit points in the PSR is less than zero, sets myCurrentHitPoints and the current hitpoints in the PSR to to the full health points from the descriptor. Otherwise it simply initialized myCurrentHitPoints to the value in the PSR.

Reimplemented from DtSimComponent.

virtual void DtMultipleHitDamageActuator::tick ( )

overridevirtual

override parent class, making sure to call it but we need to check if object was set to destroyed by user and thus update damage points value

Reimplemented from DtDamageAdjudicationActuator.

virtual bool DtMultipleHitDamageActuator::adjudicateDirectDamage ( const DtDetonationContext &  detonationContext )

overridevirtual

Processes a detonation for this entity, and decrements the hit points on the entity if appropriate. Determines damage from a direct impact on the entity.

Implements DtDamageAdjudicationActuator.

virtual bool DtMultipleHitDamageActuator::adjudicateCollateralDamage ( const DtDetonationContext &  detonationContext )

overridevirtual

Processes a detonation for this entity, and decrements the hit points on the entity if appropriate. Determines collateral damage from an impact near the entity.

Implements DtDamageAdjudicationActuator.

virtual const char* DtMultipleHitDamageActuator::type ( ) const

overridevirtual

Returns a string identifies the class type of component. Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns

DtMultipleHitDamageActuatorType

Implements DtDamageAdjudicationActuator.

static DtSimComponent* DtMultipleHitDamageActuator::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = nullptr, DtReaderWriterRegistry *  parentRegistry = nullptr  )

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

Returns

New instance of this class.

virtual void DtMultipleHitDamageActuator::checkDamageType ( const DtDetonationContext &  detonationContext, bool  isDirectDamage = true  )

protectedvirtual

Calls getProbabilities to determine if we have take any specifc kind of damage like mobiillty kill, firepower kill, etc... from adjudicateDirectDamage and adjudicateCollateralDamage.

virtual bool DtMultipleHitDamageActuator::getProbabilities ( const DtDetonationContext &  detonationContext, DtPrbValueList &  probabilities, bool  isDirectDamage = true  )

protectedvirtual

Gets the list of probabilities from the damage component descriptor's damage tables.

Returns

a boolean signifying whether or not it was able to get the appropriate probability list..

Parameters

detonationContext	Contains all relevant information for finding the proper probability list.
probabilities	The list of probabilities to be filled in correctly if found.

from checkDamageType Passes in boolean to determine which damage table to use for the look up Default is to lookup in the direct damage file. Set to false for collateral damage file.

virtual void DtMultipleHitDamageActuator::getImpactZoneFromDirectFire ( DtDetonationContext &  detonationContext )

overrideprotectedvirtual

Determines the impact zone in this case the bounding volume surface of the entity that is hit and the angle of incidence of the detonation from a direct hit and puts them in the specified detonation context.

Implements DtDamageAdjudicationActuator.

virtual void DtMultipleHitDamageActuator::getImpactZoneFromIndirectFire ( DtDetonationContext &  detonationContext )

overrideprotectedvirtual

Determines the impact zone in this case the bounding volume surface of the entity that is hit and the angle of incidence of the nearby detonation and puts them in the specified detonation context.

Implements DtDamageAdjudicationActuator.

virtual bool DtMultipleHitDamageActuator::assessDamagePoints ( const DtDetonationContext &  detContext )

protectedvirtual

Returns

a boolean signifying whether or not the entity took damage. Finds the maximum and minimum possible damage and takes a random amount of damage between those. Damage is accumulative and stored as damage points in entity's state proprerty "damage-points" defined in the multihit damage actuator's descriptor

from adjudicateDirectDamage and adjudicateCollateralDamage

virtual bool DtMultipleHitDamageActuator::getDamagePoints ( const DtDetonationContext &  detContext, DtPrbValueList &  damagePointsEntry  )

protectedvirtual

virtual DtSymbolString DtMultipleHitDamageActuator::getSurface ( DtBoundingVolumeFace  impactSurface )

protectedvirtual

Returns

the appropriate symbol string from the specified impact surface.

virtual bool DtMultipleHitDamageActuator::isFirepowerKilled ( DtPrbValueList &  probabilities, DtSymbolString  firepowerKillString  ) const

protectedvirtual

Determines if the entity is firepower killed by the detonation with the specified list of probabilities.

Returns

a boolean signifying whether or not it the entity was firepower killed.

Parameters

probabilities	The probability list used to determine the outcome.
firepowerKillString	Used to look up the probability in the probability list.

See Also

adjudicateDamage

virtual bool DtMultipleHitDamageActuator::isMobilityKilled ( DtPrbValueList &  probabilities, DtSymbolString  mobilityKillString  ) const

protectedvirtual

Determines if the entity is mobility killed by the detonation with the specified list of probabilities.

Returns

a boolean signifying whether or not it the entity was mobility killed.

Parameters

probabilities	The probability list used to determine the outcome.
mobilityKillString	Used to look up the probability in the probability list.

See Also

adjudicateDamage

virtual bool DtMultipleHitDamageActuator::isSensorsKilled ( DtPrbValueList &  probabilities, DtSymbolString  sensorsKillString  ) const

protectedvirtual

Determines if the entity has its sensors killed by the detonation with the specified list of probabilities.

Returns

a boolean signifying whether or not it the entity was sensors killed.

Parameters

probabilities	The probability list used to determine the outcome.
sensorsKillString	Used to look up the probability in the probability list.

See Also

adjudicateDamage

virtual double DtMultipleHitDamageActuator::getPossibleDamagePoints ( DtPrbValueList &  damagePointsList, DtSymbolString  damageString  ) const

protectedvirtual

Get damage points value for specified damgage string. Currently just has "maximum-damage" and "minimum-damage".

Returns

a double representing number of damage point for that entry.

Parameters

damagePointsList	The damage points list used to define damage points range
damageString	Used to look up the value for that entry in the damage points list.

See Also

adjudicateDamage

virtual DtSymbolString DtMultipleHitDamageActuator::maximumDamageString ( ) const

protectedvirtual

Returns

The DtSymbolString for "maximum-damage"

virtual DtSymbolString DtMultipleHitDamageActuator::minimumDamageString ( ) const

protectedvirtual

Returns

The DtSymbolString for "minimum-damage"

virtual void DtMultipleHitDamageActuator::setRestored ( )

overrideprotectedvirtual

Re-registers the entity to receive detonations since it is now restored.

See Also

registerForDetonations

Reimplemented from DtDamageAdjudicationActuator.

virtual void DtMultipleHitDamageActuator::setDamagePoints ( double  current )

protectedvirtual

Sets the damage points in the state data.

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

privatedelete

assignment operator; not implemented

Member Data Documentation

const DtMultipleHitDamageActuatorDescriptor* DtMultipleHitDamageActuator::myMultipleHitDamageComponentDescriptor

protected

The descriptor that initializes this actuator. It reads in the initial number of hit points this entity has for full health.

double DtMultipleHitDamageActuator::myTotalDamagePoints

protected

The total damage entity can take before it's destroyed.

DtMultipleHitDamagePSR* DtMultipleHitDamageActuator::myMHDProcessState

protected

DtString DtMultipleHitDamageActuator::myCurrentId

protected

This is set in adjudicate direct damage to make sure a hit isn't counted twice in a collateral damage.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/multipleHitDamageActuator.h