VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtWeaponComponentInterface Class Reference

Represents the interface between the DtTargetSelectionController and a weapon system. More...

Inheritance diagram for DtWeaponComponentInterface:
Inheritance graph
[legend]

Public Types

typedef DtRwTemplatedMapPtr
< DtRwUUID, DtRwUUID
MunitionToTargetMap
 
- Public Types inherited from DtBaseWeaponComponentInterface
enum  DtWeaponStatus {
  DT_OK_TO_FIRE = 0, DT_WEAPON_DISABLED = 1, DT_NO_AMMUNITION_FOR_TARGET = 2, DT_CANNOT_ACQUIRE_TARGET = 4,
  DT_SUPPRESSED = 8, DT_OUT_OF_AMMUNITION_FOR_WEAPON = 16, DT_WEAPON_BUSY = 32
}
 The status items below are used as bit fields. More...
 
- 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 )()
 

Public Member Functions

 DtWeaponComponentInterface (const DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtWeaponComponentInterface (const DtWeaponComponentInterface &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
const DtWeaponComponentInterfaceoperator= (const DtWeaponComponentInterface &orig)
 
virtual ~DtWeaponComponentInterface ()
 
virtual
DtVrfProcessStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 
virtual DtString type () const
 Returns the string type of the repository, as defined in procSRTypes.h. More...
 
virtual void updateRegionEvaluator ()
 This must be called before calling locationWithinRegion() if the host entity has moved at all since this was last called. More...
 
virtual bool locationWithinRegion (const DtVector &localLocation) const
 
virtual void clearTarget ()
 
virtual bool hasTarget () const
 
virtual void setTargetSelectionCriteria (const DtTargetSelectionCriteria &tsc)
 Accessor/mutator for myTargetSelectionCriteria. More...
 
virtual const
DtTargetSelectionCriteria
targetSelectionCriteria () const
 
virtual void setTarget (const DtEntityTargetInformation &target)
 Accessor/mutator for myTarget. More...
 
virtual const
DtEntityTargetInformation
target () const
 
virtual void addTargetFiringUpon (const DtUUID &target)
 Add, remove, or get contents of myTargetsFiringUpon. More...
 
virtual void removeTargetFiringUpon (const DtUUID &target)
 
virtual const
DtRwTemplatedUUIDList
targetsFiringUpon () const
 
virtual void addMunitionFired (const DtUUID &munition, const DtUUID &target)
 Add, remove, or get contents of #myMunitionsFired. More...
 
virtual void removeMunitionFired (const DtUUID &munition)
 
virtual const MunitionToTargetMapmunitionsFired () const
 
- Public Member Functions inherited from DtBaseWeaponComponentInterface
 DtBaseWeaponComponentInterface (const DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtBaseWeaponComponentInterface (const DtBaseWeaponComponentInterface &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
const
DtBaseWeaponComponentInterface
operator= (const DtBaseWeaponComponentInterface &orig)
 
virtual ~DtBaseWeaponComponentInterface ()
 
virtual void setRoundsFiredUponTarget (const int &roundsFired)
 Accessor/mutator for myRoundsFiredUponTarget. More...
 
virtual const int roundsFiredUponTarget () const
 
virtual void setTotalRoundsToFireUponTarget (const int &totalRoundsToFire)
 Accessor/mutator for myTotalRoundsToFireUponTarget. More...
 
virtual const int totalRoundsToFireUponTarget () const
 
virtual void setIsExplicitlyTasked (const bool &explicitlyTasked)
 Accessor/mutator for myIsExplicitlyTasked. More...
 
virtual const bool isExplicitlyTasked () const
 
virtual void setAllowExplicitTasking (const bool &includeInDialogs)
 Accessor/mutator for myAllowExplicitTasking. More...
 
virtual const bool allowExplicitTasking () const
 
virtual void setDisplayName (const DtString &displayName)
 Accessor/mutator for myDisplayName. More...
 
virtual const DtStringdisplayName () const
 
virtual void setWeaponStatus (const int weaponStatus)
 Accessor/mutator for myWeaponStatus. More...
 
virtual const int weaponStatus () const
 
virtual DtString weaponStatusString () const
 Returns a string describing the weapon status. More...
 
virtual void addWeaponStatus (const DtWeaponStatus weaponStatus)
 Performs a logical OR of the input status with the existing weapon status, to add the given condition to status. More...
 
virtual void removeWeaponStatus (const DtWeaponStatus weaponStatus)
 Removes the given condition from the weapon status by performing a logical AND of the bitwise NOT of the input status with existing weapon status. More...
 
virtual void setIsInFiringCycle (const bool)
 Accessor/mutator for myIsInFiringCycle. More...
 
virtual bool isInFiringCycle () const
 
virtual void setResourceList (const std::list< DtString > &list)
 Accessor/mutator for #myResourceList. More...
 
virtual const std::list
< DtString > & 
resourceList () const
 
virtual std::list< DtString > & resourceList ()
 
virtual void setPriority (const int priority)
 A priority value to determine which weapon on an entity should be used if both have targets. More...
 
virtual int priority () const
 
virtual void createMountPartList (const DtArtPartType partType)
 A list of articulated parts to which this weapon is attached. More...
 
virtual const std::list
< DtArtPartType > & 
mountPartList () const
 Retrieves the list. More...
 
virtual void setSystemTurretNumber (const DtArtPartType num)
 Accessor/mutator for mySystemTurretNumber. More...
 
virtual DtArtPartType systemTurretNumber () const
 
virtual std::set< DtString > & requiredTokens ()
 Accessor/mutator for myRequiredTokens. More...
 
virtual void setRequiredTokens (const std::set< DtString > &tokens)
 
virtual void setTreatSelectedAsTasked (bool t)
 Accessor for myTreatSelectedAsTasked. More...
 
bool treatSelectedAsTasked () const
 
virtual void setControlExternalTurret (bool c)
 Accessor for myControlExternalTurret. More...
 
virtual bool controlExternalTurret () const
 
- Public Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
const DtVrfProcessStateRepositoryoperator= (const DtVrfProcessStateRepository &orig)
 
virtual ~DtVrfProcessStateRepository ()
 
virtual bool init ()
 Used for virtual construction. This base method simply returns true. More...
 
virtual bool loadedFromMTL () const
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Top level to read itself from an input stream. More...
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void putData (std::string &fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data. More...
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
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())
 Gets data from the environment value. More...
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Static Public Member Functions

static
DtVrfProcessStateRepository
creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
 Create an instance of a DtWeaponComponentInterface. More...
 
- Static Public Member Functions inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
factory ()
 a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtVrfProcessStateRepositoryFactory *factory)
 
static void addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
 
static
DtVrfProcessStateRepository
createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
 Creates a new state repository object, using the factory. More...
 
- 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 chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

virtual void setupRegionEvaluator ()
 Uses the current data in myTargetSelectionCriteria and creates the and sets myRegionEvaluator, is applicable. More...
 
- Protected Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository ()
 
const DtVrfObjectconst_vrfObject () const
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Protected Attributes

DtTargetSelectionCriteria myTargetSelectionCriteria
 Target selection data for this weapon. More...
 
DtEntityTargetInformation myTarget
 Information about current target specified by the target selection controller. More...
 
DtRwTemplatedUUIDList myTargetsFiringUpon
 The current targets that have been fired upon. More...
 
MunitionToTargetMap myMunitions
 The current munitions fired, and their targets Used only by missile launchers (as of VRF 4.8); for guns, always empty. More...
 
DtSpatialFilterEvaluatormyRegionEvaluator
 
- Protected Attributes inherited from DtBaseWeaponComponentInterface
DtRwInt myRoundsFiredUponTarget
 Tracks rounds fired upon current target. More...
 
DtRwInt myTotalRoundsToFireUponTarget
 Tracks total rounds to fire upon current target. More...
 
DtRwBoolean myIsInFiringCycle
 Indicates that the weapon is in its firing cycle, which may mean is still firing a burst, or is in a mandatory cool down period after firing. More...
 
DtRwBoolean myIsExplicitlyTasked
 Tracks whether the weapon system has been explicitly tasked as opposed to a target being automatically selected. More...
 
DtRwBoolean myAllowExplicitTasking
 
DtRwString myDisplayName
 Name to be used in the gui to represent this weapon. More...
 
DtRwInt myWeaponStatus
 Current status of the weapon, is it able to fire or not. More...
 
std::list< DtStringmyResources
 List of the available munition resources. More...
 
DtRwInt myPriority
 A priority value to determine which weapon on an entity should be used if both have targets. More...
 
std::list< DtArtPartType > myMountPartList
 A list of articulated parts to which this weapon is attached. More...
 
DtArtPartType mySystemTurretNumber
 The articulated part corresponding to the turret in this gun system (as opposed to an ancestor part). More...
 
DtRwBoolean myControlExternalTurret
 Indicates that this weapon is controlling parent parts outside of the system to turn the gun. More...
 
std::set< DtStringmyRequiredTokens
 List of resources required to operate the weapon; these are tokens that are reserved when the weapon operates, but are not consumed. More...
 
DtRwBoolean myTreatSelectedAsTasked
 Indicates that when a target is auto-selected for this gun, vs. More...
 
- Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObjectmyVrfObject
 
bool myLoadedFromMTL
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 

Private Member Functions

 DtWeaponComponentInterface ()
 default constructor, not implemented More...
 

Additional Inherited Members

- Static Protected Attributes inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
theFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

Represents the interface between the DtTargetSelectionController and a weapon system.

Member Typedef Documentation

Constructor & Destructor Documentation

DtWeaponComponentInterface::DtWeaponComponentInterface ( )
private

default constructor, not implemented

DtWeaponComponentInterface::DtWeaponComponentInterface ( const DtVrfObject vrfObject,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
DtWeaponComponentInterface::DtWeaponComponentInterface ( const DtWeaponComponentInterface orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
virtual DtWeaponComponentInterface::~DtWeaponComponentInterface ( )
virtual

Member Function Documentation

const DtWeaponComponentInterface& DtWeaponComponentInterface::operator= ( const DtWeaponComponentInterface orig)
virtual DtVrfProcessStateRepository* DtWeaponComponentInterface::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual
virtual DtString DtWeaponComponentInterface::type ( ) const
virtual

Returns the string type of the repository, as defined in procSRTypes.h.

Implements DtVrfProcessStateRepository.

virtual void DtWeaponComponentInterface::setTargetSelectionCriteria ( const DtTargetSelectionCriteria tsc)
virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtWeaponComponentInterface::targetSelectionCriteria ( ) const
virtual
virtual void DtWeaponComponentInterface::updateRegionEvaluator ( )
virtual

This must be called before calling locationWithinRegion() if the host entity has moved at all since this was last called.

Implements DtBaseWeaponComponentInterface.

virtual bool DtWeaponComponentInterface::locationWithinRegion ( const DtVector localLocation) const
virtual
Returns
True if localLocation falls within the valid target region.
Note
updateRegionEvaluator() must be called prior to this function if there is a chance that the host entity has moved or reoriented since the last time updateRegionEvaluator() was called.

Implements DtBaseWeaponComponentInterface.

virtual void DtWeaponComponentInterface::setTarget ( const DtEntityTargetInformation target)
virtual

Accessor/mutator for myTarget.

virtual const DtEntityTargetInformation& DtWeaponComponentInterface::target ( ) const
virtual
virtual void DtWeaponComponentInterface::clearTarget ( )
virtual
virtual bool DtWeaponComponentInterface::hasTarget ( ) const
virtual
virtual void DtWeaponComponentInterface::addTargetFiringUpon ( const DtUUID target)
virtual

Add, remove, or get contents of myTargetsFiringUpon.

virtual void DtWeaponComponentInterface::removeTargetFiringUpon ( const DtUUID target)
virtual
virtual const DtRwTemplatedUUIDList& DtWeaponComponentInterface::targetsFiringUpon ( ) const
virtual
virtual void DtWeaponComponentInterface::addMunitionFired ( const DtUUID munition,
const DtUUID target 
)
virtual

Add, remove, or get contents of #myMunitionsFired.

Add and remove calls will also call addTargetFiringUpon() and removeTargetFiringUpon() as appropriate. No need to call both functions.
These functions are used by missile launchers (but not guns) to note when missiles have been fired at targets. This is useful when the missile takes some time to get to the target and the launcher can fire another missile. The target selection controller ignores targets that already have been fired upon when selecting another target for the missile launcher to engage.

virtual void DtWeaponComponentInterface::removeMunitionFired ( const DtUUID munition)
virtual
virtual const MunitionToTargetMap& DtWeaponComponentInterface::munitionsFired ( ) const
virtual
static DtVrfProcessStateRepository* DtWeaponComponentInterface::creator ( const DtString name,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry 
)
static

Create an instance of a DtWeaponComponentInterface.

virtual void DtWeaponComponentInterface::setupRegionEvaluator ( )
protectedvirtual

Uses the current data in myTargetSelectionCriteria and creates the and sets myRegionEvaluator, is applicable.

Member Data Documentation

DtTargetSelectionCriteria DtWeaponComponentInterface::myTargetSelectionCriteria
protected

Target selection data for this weapon.

DtEntityTargetInformation DtWeaponComponentInterface::myTarget
protected

Information about current target specified by the target selection controller.

DtRwTemplatedUUIDList DtWeaponComponentInterface::myTargetsFiringUpon
protected

The current targets that have been fired upon.

Used only by missile launchers (as of VRF 4.8); for guns, always empty.

MunitionToTargetMap DtWeaponComponentInterface::myMunitions
protected

The current munitions fired, and their targets Used only by missile launchers (as of VRF 4.8); for guns, always empty.

DtSpatialFilterEvaluator* DtWeaponComponentInterface::myRegionEvaluator
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)