Instances of DtDynamicTerrainMunitionDamageControllerDescriptor are used to specify the parameters for a DtDynamicTerrainMunitionDamageController object.

Inheritance diagram for DtDynamicTerrainMunitionDamageControllerDescriptor:

[legend]

Public Member Functions
	DtDynamicTerrainMunitionDamageControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtDynamicTerrainMunitionDamageControllerDescriptor ()

	DtDynamicTerrainMunitionDamageControllerDescriptor (const DtDynamicTerrainMunitionDamageControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)

DtDynamicTerrainMunitionDamageControllerDescriptor &	operator= (const DtDynamicTerrainMunitionDamageControllerDescriptor &orig)

virtual DtString	type () const

virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const

bool	isDamageType (const DtString &changeType) const


virtual const DtString &	standardTerrainDamageType () const

virtual void	setStandardTerrainDamageType (const DtString &dmgType)


virtual DtString	standardPowerType () const

virtual void	setStandardPowerType (const DtString &pwrType)


virtual const std::map < DtRwReal, DtRwString > &	standardTerrainDamageTable () const

virtual void	setStandardTerrainDamageTable (const std::map< DtRwReal, DtRwString > &table)


virtual bool	cratersEnabled () const

virtual void	setCratersEnabled (bool areEnabled)


virtual int	craterMaxLimit () const

virtual void	setCraterMaxLimit (int maxLimit)


virtual const DtHighFidelityTerrainDamageConfigList &	highFidelityTerrainDamageConfigList () const

Public Member Functions inherited from DtDynamicTerrainControllerDescriptor
	DtDynamicTerrainControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtDynamicTerrainControllerDescriptor ()

	DtDynamicTerrainControllerDescriptor (const DtDynamicTerrainControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)

DtDynamicTerrainControllerDescriptor &	operator= (const DtDynamicTerrainControllerDescriptor &orig)

virtual bool	onlyInArea () const

virtual void	setOnlyInArea (bool v)

virtual int	changesPerPublishedObject () const

virtual void	setChangesPerPublishedObject (int v)

virtual DtRwStringList &	typesForIndividualSwitches ()

virtual const DtRwStringList &	typesForIndividualSwitches () const

virtual void	setTypesForIndividualSwitches (const DtRwStringList &list)

virtual bool	isTypeForIndividualSwitch (const DtString &t) const

virtual DtRwStringList &	ignoredTypes ()

virtual const DtRwStringList &	ignoredTypes () const

virtual void	setIgnoredTypes (const DtRwStringList &list)

virtual bool	isIgnoredType (const DtString &t) const

virtual double	publishedSwitchRadius () const

virtual void	setPublishedSwitchRadius (double v)

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	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	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 DtDynamicTerrainControllerDescriptor
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 Attributes
DtRwInt32	myMaximumCraters

std::set< DtString >	myMutableDamageTypeSet

parameters
These parameters are available for setting in the OPD files.
DtRwString	myStandardTerrainDamageType

DtRwString	myStandardPowerType

DtTerrainDamageTable	myStandardTerrainDamageTable

DtHighFidelityTerrainDamageConfigList	myHighFidelityTerrainDamageTable

DtRwBoolean	myAreCraterersEnabled

Protected Attributes inherited from DtDynamicTerrainControllerDescriptor
DtRwBoolean	myOnlyInArea

DtRwInt	myChangesPerPublishedObject

DtRwStringList	myTypesForIndividualSwitches

DtRwStringList	myIgnoredTypes

DtRwReal	myPublishedSwitchRadius

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 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 Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()

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

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

DtDynamicTerrainMunitionDamageControllerDescriptor::DtDynamicTerrainMunitionDamageControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

virtual DtDynamicTerrainMunitionDamageControllerDescriptor::~DtDynamicTerrainMunitionDamageControllerDescriptor ( )

virtual

destructor

DtDynamicTerrainMunitionDamageControllerDescriptor::DtDynamicTerrainMunitionDamageControllerDescriptor	(	const DtDynamicTerrainMunitionDamageControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

Member Function Documentation

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

assignment operator

virtual DtString DtDynamicTerrainMunitionDamageControllerDescriptor::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: DtDynamicTerrainMunitionDamageControllerDescriptorType

Reimplemented from DtDynamicTerrainControllerDescriptor.

virtual DtComponentDescriptor* DtDynamicTerrainMunitionDamageControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

virtual

Reimplemented from DtDynamicTerrainControllerDescriptor.

virtual const DtString& DtDynamicTerrainMunitionDamageControllerDescriptor::standardTerrainDamageType ( ) const

virtual

See Also: myStandardTerrainDamageType

virtual void DtDynamicTerrainMunitionDamageControllerDescriptor::setStandardTerrainDamageType ( const DtString & dmgType )

virtual

See Also: myStandardTerrainDamageType

virtual DtString DtDynamicTerrainMunitionDamageControllerDescriptor::standardPowerType ( ) const

virtual

See Also: myStandardPowerType

virtual void DtDynamicTerrainMunitionDamageControllerDescriptor::setStandardPowerType ( const DtString & pwrType )

virtual

See Also: myStandardPowerType

virtual const std::map<DtRwReal, DtRwString>& DtDynamicTerrainMunitionDamageControllerDescriptor::standardTerrainDamageTable ( ) const

virtual

See Also: myStandardTerrainDamageTable

virtual void DtDynamicTerrainMunitionDamageControllerDescriptor::setStandardTerrainDamageTable ( const std::map< DtRwReal, DtRwString > & table )

virtual

See Also: myStandardTerrainDamageTable

virtual bool DtDynamicTerrainMunitionDamageControllerDescriptor::cratersEnabled ( ) const

virtual

See Also: #myAreCratersEnabled

virtual void DtDynamicTerrainMunitionDamageControllerDescriptor::setCratersEnabled ( bool areEnabled )

virtual

See Also: #myAreCratersEnabled

virtual int DtDynamicTerrainMunitionDamageControllerDescriptor::craterMaxLimit ( ) const

virtual

See Also: myMaximumCraters

virtual void DtDynamicTerrainMunitionDamageControllerDescriptor::setCraterMaxLimit ( int maxLimit )

virtual

See Also: myMaximumCraters

virtual const DtHighFidelityTerrainDamageConfigList& DtDynamicTerrainMunitionDamageControllerDescriptor::highFidelityTerrainDamageConfigList ( ) const

virtual

See Also: myHighFidelityTerrainDamageTable

bool DtDynamicTerrainMunitionDamageControllerDescriptor::isDamageType ( const DtString & changeType ) const

Returns true if the specified type is a standard or high fidelity terrain damage type.

static DtComponentDescriptor* DtDynamicTerrainMunitionDamageControllerDescriptor::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.

Member Data Documentation

DtRwString DtDynamicTerrainMunitionDamageControllerDescriptor::myStandardTerrainDamageType

protected

Parameter Name: standard-terrain-damage-type
Parameter Description: The dynamic terrain change type that represents standard terrain damage.
Parameter Default Value: "damage".

DtRwString DtDynamicTerrainMunitionDamageControllerDescriptor::myStandardPowerType

protected

Parameter Name: standard-power-type
Parameter Description: String identifying the type of detonation power that causes standard damage.
Parameter Default Value: "explosive".

DtTerrainDamageTable DtDynamicTerrainMunitionDamageControllerDescriptor::myStandardTerrainDamageTable

protected

Parameter Name: standard-terrain-damage-table
Parameter Description: Table that indicates the damaged caused by detonations of various powers.
.

DtHighFidelityTerrainDamageConfigList DtDynamicTerrainMunitionDamageControllerDescriptor::myHighFidelityTerrainDamageTable

protected

Parameter Name: high-fidelity-terrain-damage-table
Parameter Description: Table that indicates how terrain should be damaged based on the type of munition detonation.
.

DtRwBoolean DtDynamicTerrainMunitionDamageControllerDescriptor::myAreCraterersEnabled

protected

Parameter Name: craters-enabled
Parameter Description: Boolean to indicate whether craters should be formed as the result of supported munitions
.

DtRwInt32 DtDynamicTerrainMunitionDamageControllerDescriptor::myMaximumCraters

protected

Parameter Name: crater-max-limit
Parameter Description: Integer to indicate the maximum number of craters to be formed as the result of supported munitions
.

std::set<DtString> DtDynamicTerrainMunitionDamageControllerDescriptor::myMutableDamageTypeSet

mutableprotected

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation