 |
VR-Forces 4.1 Class Documentation
|
|
VR-Forces 4.1 Class Documentation
|
DtTargetSelectionCriteria. More...
Public Member Functions | |
| DtTargetSelectionCriteria (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtTargetSelectionCriteria (const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtTargetSelectionCriteria & | operator= (const DtTargetSelectionCriteria &orig) |
| assignment | |
| virtual | ~DtTargetSelectionCriteria () |
| destructor | |
| virtual DtTargetPriorityList & | priorityList () |
| Accessor/mutator for myTargetPriorityList. | |
| virtual const DtTargetPriorityList & | priorityList () const |
| Accessor/mutator for myTargetPriorityList. | |
| virtual int | maxTargets () const |
| Accessor/mutator for myMaxTargets. | |
| virtual void | setMaxTargets (int num) |
| Accessor/mutator for myMaxTargets. | |
| virtual DtRwSpatialFilterContainer * | targetRegion () |
| Accessor/mutator for myTargetRegion. | |
| virtual const DtRwSpatialFilterContainer * | targetRegion () const |
| Accessor/mutator for myTargetRegion. | |
| virtual bool | fireWithSpotReportOnly () const |
| virtual void | setFireWithSpotReportOnly (bool value) |
 Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | writeSelf (FILE *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. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| 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. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtTargetPriorityList | myTargetPriorityList |
| Parameter Name: target-priorities Parameter Description: List of object types provides acceptable types of objects to use as targets, and well as what types should be considered higher priority than other types. | |
| DtRwInt | myMaxTargets |
| Parameter Name: max-targets Parameter Description: Maximum number of targets to output to this weapon system simultaneously. | |
| DtRwSpatialFilterContainer | myTargetRegion |
| Parameter Name: target-region Parameter Description: Region (in relation to the host entity) in which this weapon should attempt target objects. | |
| DtRwBoolean | myFireWithSpotReportOnly |
| Parameter Name: fire-with-spot-report-only Parameter Description: If true, the entity will use this weapon to fire on targets that it has received data on only though spot reports. | |
| Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
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::pair < DtSymbolString, DtString > | DtVariableNameType |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (FILE *fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static DtReaderWriterFactory * | factory () |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| 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. | |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| Static Protected Attributes inherited from DtReaderWriter | |
| static DtString | theUnspecifiedValue |
| static DtGetSelfCallbackInfo | thePostGetSelfCallback |
| static DtPutSelfCallbackInfo | thePrePutSelfCallback |
| static const DtVariableBindingsList | theEmptyVariableBindingsList |
| static DtReaderWriterFactory | theFactory |
Defines a criteria for choosing targets for a single weapon system. This class stores all the information about what targets should be considered valid for a particular weapon, and a prioritizing order for those targets.
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtTargetSelectionCriteria & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| DtTargetSelectionCriteria& DtTargetSelectionCriteria::operator= | ( | const DtTargetSelectionCriteria & | orig | ) |
assignment
|
virtual |
Accessor/mutator for myTargetPriorityList.
|
virtual |
Accessor/mutator for myTargetPriorityList.
|
virtual |
Accessor/mutator for myMaxTargets.
|
virtual |
Accessor/mutator for myMaxTargets.
|
virtual |
Accessor/mutator for myTargetRegion.
|
virtual |
Accessor/mutator for myTargetRegion.
|
virtual |
|
virtual |
|
protected |
Parameter Name: target-priorities
Parameter Description: List of object types provides acceptable types of objects to use as targets, and well as what types should be considered higher priority than other types.
Parameter Default Value: Empty list.
|
protected |
Parameter Name: max-targets
Parameter Description: Maximum number of targets to output to this weapon system simultaneously.
Value of -1 indicates no limit.
Parameter Default Value: -1
|
protected |
Parameter Name: target-region
Parameter Description: Region (in relation to the host entity) in which this weapon should attempt target objects.
Only objects within the defined region are valid. If no region is defined, all targets are valid. Spatial filters can be combined with logical and/or/not operators as well.
Example 1: Every entity within 4000 meters of this entity.
(in-range
(range 4000.000000)
)
Example 2: Every entity within 4000 meters of this entity, and within the defined frustum of the facing direction of the entity.
(and
(in-range
(range 4000.000000)
)
(in-frustum
(az-max 1.0472)
(az-min -1.0472)
(el-max 1.5708)
(el-min -1.5708)
)
)
Custom geometry filters can be created though the toolkit.
See documentation for DtRwSpatialFilter for more information.
Parameter Default Value:
|
protected |
Parameter Name: fire-with-spot-report-only
Parameter Description: If true, the entity will use this weapon to fire on targets that it has received data on only though spot reports.
Otherwise, a sensor located on the entity is required to see the target before selecting it as a valid target for this weapon. Parameter Default Value: false.