Base class for an implementation of an algorithm that produces high fidelity dynamic terrain damage at specific locations. More...

Inheritance diagram for DtDynamicTerrainMunitionDamageAlgorithm:

Public Member Functions
	DtDynamicTerrainMunitionDamageAlgorithm ()
	~DtDynamicTerrainMunitionDamageAlgorithm ()
virtual void	generateDamage (const DtVector &localPosition, const DtVector &localDetonationPosition, const DtPowerRangeDeterminantList &detonationPower, const DtHighFidelityTerrainDamageConfig &damageConfig, DtDynamicTerrainMunitionDamageController &controller)=0
	Generates damage to the terrain.
virtual double	estimateDetonationPower (const DtVector &localPosition, const DtString &damageValue, const DtHighFidelityTerrainDamageConfig &damageConfig, DtDynamicTerrainMunitionDamageController &controller)=0
	Estimates the approximate detonation power it would take to generate the specified damage value at the given location.

Protected Member Functions
virtual DtString	currentDamage (const DtVector &localPosition, const DtString &terrainDamageType, DtDynamicTerrainMunitionDamageController &controller)
	Convenience function to look up the current damage value to the terrain at this location.
virtual void	damageTerrain (const DtVector &localPosition, const DtString &terrainDamageType, const DtString &damageValue, DtDynamicTerrainMunitionDamageController &controller, unsigned priority=UseDefaultPriority, double delay=0.0)
	Convenience function to perform specific damage to the terrain.

Static Protected Attributes
static const unsigned	UseDefaultPriority

Detailed Description

Base class for an implementation of an algorithm that produces high fidelity dynamic terrain damage at specific locations.

Constructor & Destructor Documentation

DtDynamicTerrainMunitionDamageAlgorithm::DtDynamicTerrainMunitionDamageAlgorithm ( )

inline

DtDynamicTerrainMunitionDamageAlgorithm::~DtDynamicTerrainMunitionDamageAlgorithm ( )

inline

virtual void DtDynamicTerrainMunitionDamageAlgorithm::generateDamage	(	const DtVector &	localPosition,
		const DtVector &	localDetonationPosition,
		const DtPowerRangeDeterminantList &	detonationPower,
		const DtHighFidelityTerrainDamageConfig &	damageConfig,
		DtDynamicTerrainMunitionDamageController &	controller
	)

pure virtual

Generates damage to the terrain.

Parameters

localPosition	Position, in local coordinates, of the terrain being potentially affected by this detonation.
localDetonationPosition	Position, in local coordinates, of the detonation.
detonationPower	Specifies the power of the detonation for different types of effects (e.g. explosive, kinetic) and ranges.
damageConfig	Indicates the configuration options for this algorithm.
controller	The controller that performs and manages the actual terrain changes. Any implementation of this function can call damageTerrain() as a convenience to perform any changes to the terrain, or the controller can be accessed directly.

virtual double DtDynamicTerrainMunitionDamageAlgorithm::estimateDetonationPower	(	const DtVector &	localPosition,
		const DtString &	damageValue,
		const DtHighFidelityTerrainDamageConfig &	damageConfig,
		DtDynamicTerrainMunitionDamageController &	controller
	)

pure virtual

Estimates the approximate detonation power it would take to generate the specified damage value at the given location.

Returns -1 if power could not be estimated.

virtual DtString DtDynamicTerrainMunitionDamageAlgorithm::currentDamage	(	const DtVector &	localPosition,
		const DtString &	terrainDamageType,
		DtDynamicTerrainMunitionDamageController &	controller
	)

protectedvirtual

Convenience function to look up the current damage value to the terrain at this location.

virtual void DtDynamicTerrainMunitionDamageAlgorithm::damageTerrain	(	const DtVector &	localPosition,
		const DtString &	terrainDamageType,
		const DtString &	damageValue,
		DtDynamicTerrainMunitionDamageController &	controller,
		unsigned	priority = `UseDefaultPriority`,
		double	delay = `0.0`
	)

protectedvirtual

Convenience function to perform specific damage to the terrain.

Calls controller.processDynamicTerrainSwitch() to perform the actual change.

const unsigned DtDynamicTerrainMunitionDamageAlgorithm::UseDefaultPriority

staticprotected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/dynamicTerrainMunitionDamageAlgorithm.h