objectFilterManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

//\file objectFilterManager.h

#pragma once

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtStateView.h>
#include <vrvCore/DtEntityState.h>

#include <map>

namespace makVrf
{
   class DtVrfSelectionFilter;
}

namespace makVrv
{
   class DtDe;
   class DtSimObjectEntry;
}

//This class will be responsible for keeping track of filters that are used
//to show/hide objects in the system.  It will make connections for new object
//additions as well as updates to those objects.  When an object is added or
//updated it will be passed through the set of filters for visibility.
class DtObjectFilterManager : public makVrv::DtVirtualBaseClass
{
public:
   //CTOR
   DtObjectFilterManager(makVrv::DtDe& de);

   //DTOR
   virtual ~DtObjectFilterManager();

   //Method that will be used to return the singleton of this manager that is registered with the DE.
   //If not registered will create and register a singleton
   static DtObjectFilterManager& instance(makVrv::DtDe&);

   //Activate/deactive a filter for modifying visibility.  If filter is active and already exists will
   //not process.  Same with deactivating and not having a filter exist
   virtual void activateFilter(bool, const makVrf::DtVrfSelectionFilter&);

   //Returns whether or not this filter is currently active
   virtual bool filterActive(const makVrf::DtVrfSelectionFilter&) const;

protected:
   virtual void slot_simObjectEntryAboutToBeRemoved(makVrv::DtSimObjectEntry& e);

   virtual void slot_simStateAdded(makVrv::DtSimObjectEntry& e);

   virtual void slot_tick();

   virtual void slot_stateViewUpdated(makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*);

   virtual void deactivateFilter(const makVrf::DtVrfSelectionFilter&);
   virtual void deactivateFilter(const makVrf::DtVrfSelectionFilter&, makVrv::DtElementID);

   virtual void activateFilter(const makVrf::DtVrfSelectionFilter&);
   virtual void activateFilter(const makVrf::DtVrfSelectionFilter&, makVrv::DtElementID);

   virtual int showHideContext(const std::string& filter);

   virtual void show(makVrv::DtElementID, int context, bool makeVisible);

protected:
   makVrv::DtDe& myDe;

   typedef std::map<std::string, makVrf::DtVrfSelectionFilter*> FilterMap;
   FilterMap myFilters;

   makVrv::DtSignalConnectionManager myConnectionManager;


   typedef std::map<std::string, bool>   FilterContextMap;
   struct FilterContext
   {
      makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* mySimulatedBaseState;
      FilterContextMap myFilterContextMap;
   };

   typedef std::map<makVrv::DtElementID, FilterContext> ElementContextMap;

   ElementContextMap myElementContextMap;

   // Items that are waiting for vrlink context to show up for
   std::map<makVrv::DtElementID, bool> myWaiting;

   typedef std::map<std::string, int> ShowHideContextMap;
   ShowHideContextMap myShowHideContextMap;
};