Selection Filters

Selection filters (makVrf::DtVrfSelectionFilter) are used to show to the user items in the simulation that pass a test to see whether or not the data contained in that object is valid (see VRF GUI Sim Object Manager).

The selection filters are what are used to filter the selection in task and set dialogs as well as fog of war. The selection filters can use used in a makVrf::DtVrfFilteredListView in order to present the user with a list of filters to use to select object entries. If you want to create your own filter to be used for filtering in a filtered list view (or for object filtering at system level Object Filtering) you would need to use the appropriate subclass to start your filter from. There are a few basic subclasses that cover most cases:

• makVrf::DtVrfSelectionFilter – Base class for all filters. For this you must implement your own isValid method

     bool DtLaserDesignatorFilter::isValid(const DtSimObjectReference& o) const
     {
        return o->hasStateComponent<DtLaserDesignatorStateComponent>();
     }

• makVrf::DtVrfSelectionObjectFilter - Allows for filtering of selections based on entity type

     bool DtVrfSelectionObjectFilter::isValid(const DtSimObjectReference& o) const
     {
        if (o && myVrfSimulatedOnly)
        {
           if (!o->isVrfSimulatedObject())
           {
              return false;
           }
        }
  
        if (o->entityType().kind() == -1)
        {
           return false;
        }
  
        bool excluded = (myForce == -1)
           && (std::find(myExcludeForces.begin(), myExcludeForces.end(), o->forceType()) != myExcludeForces.end());
        bool forceEq = forceEqual(o->forceType());
        bool keyOk = myKey.matchPattern(o->entityType()) || o->entityType().matchPattern(myKey);
  
        return !excluded && forceEq && keyOk;
     }

     DtWaypointsFilter::DtWaypointsFilter()
     : DtVrfSelectionObjectFilter(DtWaypointsFilterId, DtUnicode::tr("Waypoints"),
           DtEntityType(DtPointObjectKind, -1, -1, DtPointObjectCategoryControlPoint, -1, -1, -1))
     {
     }

• makVrf::DtVrfOrFilter, makVrf::DtVrfDtAndFilter - Filters that will allow for the acceptance if any of the filters are true or if all the filters are true

     void DtAllMunitionsFilter::setupFilters()
     {
        addFilter(DtVrfSelectionObjectFilter(DtEntityType(4,2,-1,1,-1,-1,-1)));
        addFilter(DtVrfSelectionObjectFilter(DtEntityType(8,-1,-1,-1,-1,-1,-1)));
        addFilter(DtVrfSelectionObjectFilter(DtEntityType(2,-1,-1,-1,-1,-1,-1)));
     }

makVrf::DtSelectionFiltersConfiguration contains the collection of filters that are used in the various task or set dialogs.

      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtAllFiltersId));
      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtAllEntitiesFilterId));
      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtVrfAllEntitiesSpotReportFilterId));
      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtAllEntitiesByForceFilterId));
      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtAllAggregatesFilterId));
      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtAllAggregatesByForceFilterId));
      myConfiguration.addSelectionFiltersPath(DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtPointsFilterId));

The task and set filtered list view dialogs use this method to allow configuration of selection filters used for that particular task or set

If you wish to change a filter collection, you can do so via the makVrf::DtSelectionFiltersMasterConfiguration class (Modify Set)

   // Modify the set Fire now to include waypoints (as an example)
   // See vrfGuiConstants/vrfSelectionFilterCollections.h for a list of all the filters available
   makVrf::DtSelectionFiltersMasterConfiguration::instance(*de).configuration().
      addSelectionFiltersPath(makVrf::DtSelectionFiltersPath::filterCollection(DtSetTargetDialogId).filter(DtWaypointsFilterId));

The selection filters that are available to scripted tasks are defined in the makVrf::DtSelectionFiltersAssembler class via the registerCreator method. If there is a selection filter you create that you wish to be available to object selection filters in scripted tasks, you can register your selection filter.