vrfObjectManipulationEventProcessor.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>


#include <boost/optional.hpp>

#include <vrvCore/DtIntervisibilityEditingEventProcessor.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtMouseEvent.h>
#include <vrvCore/DtKeyEvent.h>

#include <matrix/vlVector.h>
#include <matrix/vlQuaternion.h>
#include <matrix/vlTaitBryan.h>
#include <matrix/coordTransform.h>
#include <matrix/topoCoord.h>

#include <vlutil/vlPerformanceStats.h>

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtVrfObjectManipulationEventProcessor : 
      public makVrv::DtBasicEditingEventProcessor
   {
   public:
      DtVrfObjectManipulationEventProcessor( makVrv::DtDe&, const std::string& driverName = "DtVrfObjectManipulationEventProcessor" );
      
       virtual ~DtVrfObjectManipulationEventProcessor();

      virtual void setCurrentHeading( double heading );

      virtual void setCurrentPitch( double pitch );

      virtual void setHeadingAllowed(bool);
      virtual bool headingAllowed() const;

      virtual void setPitchAllowed(bool);
      virtual bool pitchAllowed() const;

      virtual void setAltitudeAllowed(bool);
      virtual bool altitudeAllowed() const;

      virtual double currentHeading() const;

      virtual double currentPitch() const;

      virtual const std::string& className();

      virtual void setEnabled(bool);

      virtual void setEditing(bool);

      virtual void setCreating(bool);

      virtual void setAllowEventDefer(bool);
      bool allowEventDefer() const
      {
         return myAllowEventDefer;
      }

      virtual void setIgnoreNextLeftButtonRelease(bool b);
      virtual void setEditStartedByDoubleClick(bool b);

      virtual void setDragTolerance(int);
      virtual int dragTolerance() const;

      virtual void setFreehand(bool);
      virtual bool freehand() const;

      void setDragToleranceTime(double);
      double dragToleranceTime() const;

      virtual void setIgnoreList(const std::vector<makVrv::DtElementID>&);
      const std::vector<makVrv::DtElementID>& ignoreList() const;

      virtual void setEmbarkationAllowed(bool);
      virtual bool embarkationAllowed() const;

      boost::signals2::signal<void ( double )> signal_headingChanged;

      boost::signals2::signal<void ( double )> signal_pitchChanged;

      boost::signals2::signal<void (bool)> signal_cancel;

      virtual bool isShiftKeyDown() const;
      virtual bool isControlKeyDown() const;
      virtual bool isFunctionKeyDown() const;
      virtual bool isAltKeyDown() const;
      virtual bool isLeftMouseButtonDown() const;
      virtual bool isRightMouseButtonDown() const;
      virtual bool isMiddleMouseButtonDown() const;

   protected:
      virtual bool checkModifiersReleased(const makVrv::DtKeyState::KeyModifier& ev, makVrv::DtChannel& channel, bool mouseDown);
      virtual bool checkModifiersEnabled(const makVrv::DtMouseEvent& ev, makVrv::DtChannel& channel);

      virtual makVrv::DtIntersector::IntersectProperties intersectorPickMask() const;

      virtual bool processMouseEvent(const makVrv::DtMouseEvent& ev, makVrv::DtChannel& channel);

      virtual bool processKeyboardEvent(const makVrv::DtKeyEvent& ev, 
         makVrv::DtChannel& channel);
  
      virtual void changeHeading( double mouseX, double mouseY, bool snapToGrid = false  );
      virtual void changePitch( double mouseX, double mouseY, bool snapToGrid = false );
      virtual void changeAltitude( double mouseX, double mouseY, bool snapToGrid = false );
      virtual void processMouseMove(makVrv::DtChannel& channel, const makVrv::DtMouseEvent& ev) override;

      virtual bool pick(makVrv::DtChannel& channel, double x, double y, makVrv::DtIntersectorResult& result, 
         makVrv::DtIntersector::IntersectProperties props) const;

      virtual void cleanupTerrainDraggingVaraibles();

      virtual bool placePoint(makVrv::DtChannel& channel, const makVrv::DtMouseEvent&);
      
      virtual void changeAltitudeWithWheel( int wheelSteps );

      virtual void changeHeadingWithWheel( int wheelSteps );

      virtual void changePitchWithWheel( int wheelSteps );

      virtual void cancel(bool escPressed);
      virtual void cancel();

      virtual void startHeadingDrag(const makVrv::DtMouseEvent&, makVrv::DtChannel& channel);
      virtual void startPitchDrag(const makVrv::DtMouseEvent&, makVrv::DtChannel& channel);
      virtual void startAltitudeDrag(const makVrv::DtMouseEvent&, makVrv::DtChannel& channel);
      virtual void setupLastSnapData();
      virtual void setupSnapTransforms();

      virtual void tick();

      virtual void executeDeferredMouseMoveEvent();
   
      virtual DtTaitBryan worldOrientation() const;

   protected:
      DtTaitBryan myCurrentOrientation;
      bool myHeadingAllowed;
      bool myPitchAllowed;
      bool myAltitudeAllowed;
      bool myIsHeadingDragging;
      bool myIsPitchDragging;
      bool myMouseDragging;
      makVrv::DtSignalConnectionManager myConnections;
      DtVector myStartPoint;
      int myDragTolerance;
      double myDragToleranceTime;
      double myDragTime;
      DtTimedSection myDragTimer;
      bool myAllowEditing;
      bool myFreehand;
      std::vector<makVrv::DtElementID> myIgnoreList;
      DtVector myStartingMousePosition;
      bool myEmbarkationAllowed;
      bool myIgnoreNextLeftButtonRelease;
      bool myIgnoreLeftMouseDown;
      bool myObserverEventProcessorWasEnabled;
      bool myEditStartedByDoubleClick;
      bool myIsLastEventProcessing;
      DtVector myObserverLocation;
      makVrv::DtMouseEvent myLastMouseEvent;
      bool mySetAtLeastOneEvent;
      bool myAllowEventDefer;

      
      boost::optional<makVrv::DtMouseEvent> mySavedMouseMoveEvent;
      bool myDeferMouseMoveEvents;
      bool myRightMouseButtonDown;
      int myAltitudeDragCounter = 0;

      typedef struct _SnapData
      {
         bool needsInitialization = true;
         DtTaitBryan checkOrientation;
         DtTaitBryan currentOrientation;

         double checkAltitude = 0.;
         double currentAltitude = 0.;

         DtVector currentGroundLocation;
         DtCoordTransform geocToTopoTransform;
         DtCoordTransform topoToGeocTransform;

      } SnapData;

      SnapData myLastSnap;
   };
   
   class DT_DLL_VRFGUICORE DtVrfObjectManipulationEventProcessorCreator : 
      public makVrv::DtVirtualBaseClass
   {

   public:
      static DtVrfObjectManipulationEventProcessorCreator& instance( makVrv::DtDe& de );

      static void registerInstance( makVrv::DtDe& de, 
         DtVrfObjectManipulationEventProcessorCreator* instance);     
      
      virtual DtVrfObjectManipulationEventProcessor* create( makVrv::DtDe& de );
   };

   class DT_DLL_VRFGUICORE DtVrfIntervisibilityEditingEventProcessor : public makVrv::DtIntervisibilityEditingEventProcessor
   {
   public:
      DtVrfIntervisibilityEditingEventProcessor(makVrv::DtInputDriver& inputDriver, makVrv::DtDe& de, const std::string& className);

      virtual ~DtVrfIntervisibilityEditingEventProcessor();
      
      virtual void changeAltitudeWithWheel( int wheelSteps );
      virtual void startAltitudeDrag(const makVrv::DtMouseEvent&, makVrv::DtChannel& channel);
      virtual void cancel();

   protected:
      virtual bool processMouseEvent( const makVrv::DtMouseEvent& ev, makVrv::DtChannel& channel);
      virtual bool pick(makVrv::DtChannel& channel, double x, double y, makVrv::DtIntersectorResult& result, 
         makVrv::DtIntersector::IntersectProperties props) const;
      virtual void changeAltitude( double mouseX, double mouseY );
      virtual bool processKeyboardEvent(const makVrv::DtKeyEvent& ev, makVrv::DtChannel& channel);
      virtual bool isAltKeyDown() const;
      virtual bool isLeftMouseButtonDown() const;
      virtual bool isRightMouseButtonDown() const;
      virtual bool isMiddleMouseButtonDown() const;

   protected:
      int myAltitudePositionX;
      int myAltitudePositionY;
      bool myObserverEventProcessorWasEnabled;
      bool myIgnoreNextMouseMove;
   };

   class DT_DLL_VRFGUICORE DtVrfIntervisibilityEditingEventProcessorCreator : public makVrv::DtIntervisibilityEditingEventProcessorCreator
   {
   public:
      virtual makVrv::DtBasicEditingEventProcessor* create(makVrv::DtDe&);
   };
}