symbolTracker.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvUtil/signalslib.h>
#include <vrfGuiCore/vrfStateViewCollectionManager.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vlutil/vlPerformanceStats.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <boost/signal.hpp>

#include <matrix/vlVector.h>
#include <vector>

namespace makVrv
{
   class DtDe;
   class DtSimObjectEntry;
   class DtModel;
   class DtCoordinateSystem;
}

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtSymbolTracker
   {
   protected:
      class MyTimeStatistic : public DtTimeStatistic
      {
      public:
         MyTimeStatistic() {};

         inline double sum() const { return mySum; };
      };

   protected:
      struct TrackingData
      {
         TrackingData(makVrv::DtModel* m = 0,
            const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>* sv = 0,
            const DtVector& pos = DtVector::zero()) : model(m), stateView(sv), lastSetPosition(pos) {};
         TrackingData(const TrackingData& orig) : model(orig.model), lastSetPosition(orig.lastSetPosition),
            stateView(orig.stateView) {};

         makVrv::DtModel* model;
         DtVector lastSetPosition;
         const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>* stateView;
      };

      typedef std::map<makVrv::DtElementID, TrackingData> TrackingMap;

      struct TrackData
      {
         DtTimedSection myTimer;
         MyTimeStatistic myTotalTime;
         double   myTimeoutPeriod;
         TrackingMap myMap;
      };

   public:
      DtSymbolTracker(makVrv::DtDe&);
      virtual ~DtSymbolTracker();

      virtual void setLinePoints(const std::vector<DtVector>&);

      virtual void setShowObjectsWithinRange(double);

      virtual void findAllInRange();

      virtual void setSuspendForMovement(bool);
      virtual bool suspendForMovement() const;

      virtual void setDistanceMoveTolerance(double);
      virtual double distanceMoveTolerance() const;

      virtual void setAlwaysTrack(makVrv::DtUniqueID);
      makVrv::DtUniqueID alwaysTrack() const
      {
         return myAlwaysTrack;
      }

      virtual bool canTrack(makVrv::DtModel* model, double& range,
         DtVector* retPosition = 0);

      virtual bool withinRange(const DtVector&, double& range) const;

      virtual void suspend();

      virtual void resume();

      virtual bool isSuspended() const;

      virtual DtVector geocentricPosition(makVrv::DtModel*) const;

      virtual void modelAboutToBeDestroyed(makVrv::DtModel*);

      virtual void tickTrackedItems();


      boost::signal<void (DtVector geocentricPosition,
         const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>*)> signal_trackingEntity;

      boost::signal<void (DtVector geocentricPosition,
         const makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>*)> signal_trackingEntityUpdated;

      boost::signal<void (makVrv::DtElementID)> signal_stoppedTrackingEntity;

      boost::signal<void ()> signal_suspended;

   protected:
      virtual void checkTracked();

      virtual void slot_simObjectEntryAboutToBeRemoved(makVrv::DtSimObjectEntry& e);
      virtual void removeTrackedItem(makVrv::DtElementID);

      virtual bool watchModel(makVrv::DtModel*);

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

      virtual void reset(TrackingMap&);

      virtual void updateRateForRange(makVrv::DtModel*, double range);

      virtual bool checkAndRemove(makVrv::DtElementID id, TrackingMap& map) const;

      virtual void tick();

      virtual makVrv::DtModel* findModelFor(makVrv::DtElementID) const;

      virtual void updateData(TrackData& data, bool tracked = false, bool force = false);

      virtual void checkWaiting();

      virtual makVrv::DtElementID simIdFromModel(makVrv::DtModel*) const;

   protected:
      makVrv::DtDe&           myDe;
      std::vector<DtVector>   myLinePoints;
      double                  myRange;
      makVrv::DtSignalConnectionManager myConnectionManager;

      TrackData myTrackingMap;
      TrackData myAt4s;
      TrackData myAt8s;
      TrackData myWaiting;

      DtTimedSection myLastMovement;
      int myLastMovementTime;

      bool mySuspended;
      bool mySuspendedByMovement;
      bool mySuspendForMovement;

      makVrv::DtCoordinateSystem& myCoordinateSystem;

      std::map<makVrv::DtElementID, makVrv::DtSignalConnectionManager*> myMadeConnection;
      std::map<makVrv::DtModel*, makVrv::DtElementID>     myModelToSimIdMap;
      double myDistanceMoveTolerance;
      makVrv::DtUniqueID myAlwaysTrack;
   };

   class DT_DLL_VRFGUICORE DtSymbolTrackerCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtSymbolTrackerCreator();
      virtual ~DtSymbolTrackerCreator();

      static DtSymbolTrackerCreator& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe&, DtSymbolTrackerCreator*);

      virtual DtSymbolTracker* create(makVrv::DtDe&);
   };

}