DtDamageImpactZone Class Reference

DtDamageImpactZone.

Instances of DtDamageImpactZone are used by the DtMultiHitDamageActuator to track damage to a particular part of the entity.

Inheritance diagram for DtDamageImpactZone:

Public Member Functions
	DtDamageImpactZone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDamageImpactZone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtDamageImpactZone () override
	DtDamageImpactZone (const DtString &name, const DtDamageImpactZone &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDamageImpactZone (const DtSymbolString &name, const DtDamageImpactZone &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDamageImpactZone (const DtDamageImpactZone &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDamageImpactZone &	operator= (const DtDamageImpactZone &orig)
virtual DtDamageImpactZone *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual const char *	readerWriterType () const override
virtual DtDamageImpactZone *	clone () const
virtual const char *	xmlType () const override
const DtVector &	zoneCenter () const
void	setZoneCenter (const DtVector &)
const DtVector &	zoneOffset () const
void	setZoneOffset (const DtVector &)
const bool	zoneArticulates () const
void	setZoneArticulates (const bool)
const DtRwTaitBryan	zoneOrientation () const
void	setZoneOrientation (const DtTaitBryan &)
unsigned int	zoneId () const
void	setZoneId (unsigned int)
const DtString &	zoneName () const
void	setZoneName (const DtString &)
unsigned int	numberOfHits () const
void	setNumberOfHits (unsigned int)
double	damageTaken () const
void	setDamageTaken (double)
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 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	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 const char *	theXmlType ()
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
parameters
These parameters are available for setting in the OPD files.
DtRwVector	myZoneCenter
DtRwVector	myZoneOffset
DtRwBoolean	myZoneArticulates
DtRwTaitBryan	myZoneOrientation
DtRwInt	myZoneId
DtRwString	myZoneName
DtRwInt	myNumberHits
DtRwReal	myDamageTaken
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
	DtDamageImpactZone ()

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 DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

DtDamageImpactZone::DtDamageImpactZone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

reader-writer constructor

DtDamageImpactZone::DtDamageImpactZone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtDamageImpactZone::~DtDamageImpactZone ( )

overridevirtual

destructor

DtDamageImpactZone::DtDamageImpactZone	(	const DtString &	name,
		const DtDamageImpactZone &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtDamageImpactZone::DtDamageImpactZone	(	const DtSymbolString &	name,
		const DtDamageImpactZone &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtDamageImpactZone::DtDamageImpactZone	(	const DtDamageImpactZone &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtDamageImpactZone::DtDamageImpactZone ( )

private

default constructor

Member Function Documentation

DtDamageImpactZone& DtDamageImpactZone::operator=

(

const DtDamageImpactZone &

orig

)

assignment operator

virtual DtDamageImpactZone* DtDamageImpactZone::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

const DtVector & DtDamageImpactZone::zoneCenter ( ) const

inline

Accessor/mutator for myZoneCenter.

References myZoneCenter.

void DtDamageImpactZone::setZoneCenter ( const DtVector &  v )

inline

Accessor/mutator for myZoneCenter.

References myZoneCenter.

const DtVector & DtDamageImpactZone::zoneOffset ( ) const

inline

Accessor/mutator for myZoneOffset.

References myZoneOffset.

void DtDamageImpactZone::setZoneOffset ( const DtVector &  v )

inline

Accessor/mutator for myZoneOffset.

References myZoneOffset.

const bool DtDamageImpactZone::zoneArticulates ( ) const

inline

Accessor/mutator for myZoneArticulates.

References myZoneArticulates.

void DtDamageImpactZone::setZoneArticulates ( const bool  b )

inline

Accessor/mutator for myZoneArticulates.

References myZoneArticulates.

const DtRwTaitBryan DtDamageImpactZone::zoneOrientation ( ) const

inline

Accessor/mutator for myZoneOrientation.

References myZoneOrientation.

void DtDamageImpactZone::setZoneOrientation ( const DtTaitBryan &  o )

inline

Accessor/mutator for myZoneOrientation.

References myZoneOrientation.

unsigned int DtDamageImpactZone::zoneId ( ) const

inline

Accessor/mutator for myZoneId.

References myZoneId.

void DtDamageImpactZone::setZoneId ( unsigned int  a )

inline

Accessor/mutator for myZoneId.

References myZoneId.

const DtString & DtDamageImpactZone::zoneName ( ) const

inline

Accessor/mutator for myZoneName.

References myZoneName.

void DtDamageImpactZone::setZoneName ( const DtString &  s )

inline

Accessor/mutator for myZoneName.

References myZoneName.

unsigned int DtDamageImpactZone::numberOfHits ( ) const

inline

Accessor/mutator for myNumberHits.

References myNumberHits.

void DtDamageImpactZone::setNumberOfHits ( unsigned int  a )

inline

Accessor/mutator for myNumberHits.

References myNumberHits.

double DtDamageImpactZone::damageTaken ( ) const

inline

Accessor/mutator for #myDamagetaken.

References myDamageTaken.

void DtDamageImpactZone::setDamageTaken ( double  a )

inline

Accessor/mutator for #myDamagetaken.

References myDamageTaken.

virtual const char* DtDamageImpactZone::readerWriterType ( ) const

overridevirtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

virtual DtDamageImpactZone* DtDamageImpactZone::clone ( ) const

virtual

static const char* DtDamageImpactZone::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtDamageImpactZone::xmlType ( ) const

inlineoverridevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtRwVector DtDamageImpactZone::myZoneCenter

protected

Parameter Name: zone-center
Parameter Description: center in entity's body coordinates
Parameter Default Value:
.

Referenced by setZoneCenter(), and zoneCenter().

DtRwVector DtDamageImpactZone::myZoneOffset

protected

Parameter Name: zone-offset
Parameter Description: offset from center deteriming extents of the zone
Parameter Default Value:
.

Referenced by setZoneOffset(), and zoneOffset().

DtRwBoolean DtDamageImpactZone::myZoneArticulates

protected

Parameter Name: zone-articulates
Parameter Description: Whether or not zone represents an articulating part.
Parameter Default Value: false
.

Referenced by setZoneArticulates(), and zoneArticulates().

DtRwTaitBryan DtDamageImpactZone::myZoneOrientation

protected

Parameter Name: zone-orientation
Parameter Description: Used in cases where a zone encases an articulated part
Parameter Default Value:
.

Referenced by setZoneOrientation(), and zoneOrientation().

DtRwInt DtDamageImpactZone::myZoneId

protected

Parameter Name: zone-id
Parameter Description: A simple int id assigned to the zone
Parameter Default Value: 1
.

Referenced by setZoneId(), and zoneId().

DtRwString DtDamageImpactZone::myZoneName

protected

Parameter Name: zone-name
Parameter Description: Free form string that will give the name of this zone.
Parameter Default Value:
.

Referenced by setZoneName(), and zoneName().

DtRwInt DtDamageImpactZone::myNumberHits

protected

Parameter Name: number-of-hits
Parameter Description: number of times this zone was hit
Parameter Default Value: 1
.

Referenced by numberOfHits(), and setNumberOfHits().

DtRwReal DtDamageImpactZone::myDamageTaken

protected

Parameter Name: damage-points-taken
Parameter Description: how much damage this zone has incurred
Parameter Default Value: 0.0
.

Referenced by damageTaken(), and setDamageTaken().

---

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

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