 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 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) |
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. | |
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 DtTargetSelectionCriteria::~DtTargetSelectionCriteria | ( | ) | [virtual] |
destructor
| DtTargetSelectionCriteria& DtTargetSelectionCriteria::operator= | ( | const DtTargetSelectionCriteria & | orig | ) |
assignment
| virtual DtTargetPriorityList& DtTargetSelectionCriteria::priorityList | ( | ) | [virtual] |
Accessor/mutator for myTargetPriorityList.
| virtual const DtTargetPriorityList& DtTargetSelectionCriteria::priorityList | ( | ) | const [virtual] |
Accessor/mutator for myTargetPriorityList.
| virtual int DtTargetSelectionCriteria::maxTargets | ( | ) | const [virtual] |
Accessor/mutator for myMaxTargets.
| virtual void DtTargetSelectionCriteria::setMaxTargets | ( | int | num | ) | [virtual] |
Accessor/mutator for myMaxTargets.
| virtual DtRwSpatialFilterContainer* DtTargetSelectionCriteria::targetRegion | ( | ) | [virtual] |
Accessor/mutator for myTargetRegion.
| virtual const DtRwSpatialFilterContainer* DtTargetSelectionCriteria::targetRegion | ( | ) | const [virtual] |
Accessor/mutator for myTargetRegion.
| virtual bool DtTargetSelectionCriteria::fireWithSpotReportOnly | ( | ) | const [virtual] |
| virtual void DtTargetSelectionCriteria::setFireWithSpotReportOnly | ( | bool | value | ) | [virtual] |
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.
DtRwInt DtTargetSelectionCriteria::myMaxTargets [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
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:
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.