locationEntryWidget.h

Go to the documentation of this file.

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



#pragma once

#if !defined(Q_MOC_RUN)
#include <vrfGuiDataEntryWidgets/vrfGuiDataEntryWidgets.h>
#include <vrfGuiDataEntryWidgets/taskSetVariableWidget.h>
#include <vrfGuiDataEntryWidgets/locationEntryWidgetInterface.h>
#include <vrfGuiCommonQt/mapFocusHandler.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#endif
#include <boost/signals2.hpp>

#include <matrix/vlVector.h>

#include <QtWidgets/QWidget>
#include <QtGui/QPixmap>

class QGroupBox;
class QToolButton;
class QValidator;
class QVBoxLayout;
class QFrame;
class QLabel;
class QCheckBox;

namespace makVrf
{
   class DtAltitudeSelectionWidget;
   class DtLocationEntryWidgetLogic;
   class DtLocationCSEntryInterface;
   class DtLocationCSEntryCreatorInterface;

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtLocationEntryWidget : public DtTaskSetVariableWidget, 
      public DtLocationEntryWidgetInterface, public DtMapFocusHandlerInterface
   {
      Q_OBJECT

      Q_PROPERTY(bool fixeddisplay READ fixedDisplay WRITE setFixedDisplay)
      Q_PROPERTY(bool initiallyExpand READ initiallyExpand WRITE setInitiallyExpand)

   public:
      DtLocationEntryWidget(makVrv::DtDe& de, 
         QWidget* parent, const Qt::WindowFlags& flags = 0, const CreationFlags& cflags = NormalMode);

      //DTOR
      virtual ~DtLocationEntryWidget() override;

      virtual DtVector location() const override;

      virtual DtVector geocentricLocation() const;

      virtual void setUseInputValidation(bool);
      virtual bool useInputValidation() const;

      virtual QString generatedDescription() const override;

      virtual void setUseHighestLOD(bool);
      virtual bool useHighestLOD() const;

      virtual void blockSignals(bool);
      bool signalsBlocked() const;

      virtual void setLocation(DtVector, bool resetAltitude = true) override;
      virtual void setGeocentricLocation(DtVector, bool resetAltitude = true);
      virtual void setAltitude(const DtVector& localLocation, bool resetAltitude = true) override;

      virtual void setCoordinateSystem(makVrv::DtCoordinateDisplay*) override;

      virtual void setHideAltitude(bool b);

      virtual void setHideLocationZ(bool b) override;

      virtual void setXYValidatorsEnabled(bool enabled) override;
      virtual bool xyValidatorsEnabled() const override;

      virtual void setAdvancedKeyboardHandling(bool);
      virtual bool advancedKeyboardHandling() const;

      virtual void updateLocationLabel();

      virtual void setCompactMode(bool);
      bool compactMode() const { return !fixedDisplay(); };
      virtual bool expanded() const;

      virtual void setFixedDisplay(bool);
      virtual bool fixedDisplay() const;

      virtual void setInitiallyExpand(bool);
      virtual bool initiallyExpand() const;

      virtual void setXLabel(const QString&) override;
      QString xLabel() const;

      virtual void setYLabel(const QString&) override;
      QString yLabel() const;

      virtual void setZLabel(const QString&) override;
      QString zLabel() const;

      virtual void setChangeWithDisplaySettings(bool);

      virtual void setXValue(const QString&) override;
      virtual void setYValue(const QString&) override;
      virtual void setZValue(const QString&) override;
      virtual void clearZValue();

      virtual QString xValue() const override;
      virtual QString yValue() const override;
      virtual QString zValue() const override;

      DtAltitudeSelectionWidget* altitudeWidget()
      {
         return myAltitude;
      }

      virtual const std::set<makVrv::DtUniqueID>& selection() const override;

      virtual void setAltitudeAboveSeaLevelVisible(bool b);
      virtual void setAltitudeAboveGroundLevelVisible(bool b);

      virtual void setCreator(int, DtLocationCSEntryCreatorInterface*);

      virtual void setLostMapFocus(bool);

      virtual void giveMapFocusTo();

      virtual void takeMapFocusFrom();

      virtual DtGeodeticCoord geodeticLocation() const override;

      virtual void setCoordinateSystem(const makArchives::DtDisplayUnitsSettingsRecord::CoordSys& coordSys) override;
      const makArchives::DtDisplayUnitsSettingsRecord::CoordSys& 
         coordinateSystem() const;

      virtual void setCoordinateSystemDecimals(int decimals) override;

      virtual void setAltitudeSelectionEnabled(bool) override;
      virtual bool altitudeSelectionEnabled() const override;
      virtual void setZEnabled(bool) override;
      virtual void changeAltitudeEnabledSettings(bool) override;

      virtual void setCurrentAltitudeTypeSelection(const DtAltitudeClampType& type);

      virtual DtAltitudeClampType currentAltitudeTypeSelection() const;

      virtual double altitudeAboveSeaLevel() const override;

      virtual double altitudeAboveGroundLevel() const override;

      virtual void setAltitudeAboveSeaLevel(double altitude) override;

      virtual void setAltitudeAboveGroundLevel(double altitude);

      virtual void setProcessMouseEvents(bool flag);

      virtual bool processMouseEvents();

      virtual void setAltitudeAboveGroundLevelSelected(bool b);

      virtual void setAltitudeAboveSeaLevelSelected(bool b);

      virtual void setClampToNearestPolygon(bool);
      virtual void setShowSelectedLook(bool);
      bool showSelectedLook() const
      {
         return myShowSelectedLook;
      }

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

      virtual DtReaderWriter* createBoundVariable(const std::string& variableName) override;

      virtual void setupFromBoundVariable(const DtReaderWriter* variableName) override;

      virtual void setupFrom(const std::set<makVrv::DtUniqueID>& data) override;

      static makVrv::DtUnicode codeVariableType()
      {
         return makVrv::DtUnicode::tr("Location3D");
      }

      virtual bool canTakeMapFocus() const override;
      virtual bool hasMapFocus() const override;

      virtual void setMaintainCurrentAltitude(bool);
      virtual bool maintainCurrentAltitude() const;
      
      virtual void setupBasedOnEntityType(const DtEntityType&);

      virtual void setProcessAltitudeMouseClicks(bool b);

      virtual void setSignalLocationSetOnly(bool);
      virtual bool signalLocationSetOnly() const;

      boost::signals2::signal<void ()> signal_invalidLocation;
      boost::signals2::signal<void ()> signal_validLocation;

      virtual bool validateLocation(bool warn = false);

      virtual void setInvalid(bool);
      virtual bool invalid() const override;

      virtual SelectionStatus selectionStatusFor(makVrv::DtUniqueID id, DtMapFocusHandlerInterface::CursorOver) const override;

      virtual void setUseLabelForLocationEntry(bool);
      virtual bool useLabelForLocationEntry() const;

      static std::string designerGroup()
      {
         return tr("VR-Forces Entity Manipulation").toUtf8().constData();
      }

      static std::string headerFile()
      {
         return tr("<vrfGuiDataEntryWidgets/locationEntryWidget.h>").toUtf8().constData();
      }

      static std::string variableName()
      {
         return tr("location").toUtf8().constData();
      }

      virtual makVrv::DtQtCursor cursorForSelectionStatus(
         SelectionStatus, DtMapFocusHandlerInterface::CursorOver) const override;

      virtual void setDefaultValue(const std::string&) override;

      virtual QSize minimumSizeHint() const override;

      virtual void setVariableData(const QString&) override;

      virtual void setSelection(const std::set<makVrv::DtUniqueID>& set) override;

   protected:
      virtual void showAllItems();

      virtual DtTaskSetVariableWidgetExtensionInterface* parameterContents(QWidget* parent, const Qt::WindowFlags& flags = 0) const override;

      virtual void updateLocationLook();

      virtual bool validateDMS(const std::string&, bool northSouth) const;

      virtual bool validateDDM(const std::string&, bool northSouth) const;

      virtual void slot_receivedFocus();

      virtual void setRange(double top, double bottom) override;

   public slots:
      virtual void expand();
      virtual void collapse();
      virtual void setHasMapFocus(bool) override;
      virtual void setCanTakeMapFocus(bool) override;

   signals:
      void expansionStateChanged(bool expanded);

   protected slots:

      virtual void canTakeMapFocusChanged();

      virtual void slot_onPositionChanged();

      virtual void slot_onPositionEdited(bool complete);

      virtual void slot_onAltitudeAboveGroundLevelEdited(double);

      virtual void slot_onAltitudeAboveSeaLevelEdited(double);

      virtual void slot_onAltitudeSelectionTypeChanged(const DtAltitudeClampType& );

      virtual void setupSelectionIcon();

   protected:

      virtual void slot_onClampSelectionChanged(int index);
      virtual void dataEntryWidgetChanged();

      virtual void selectionChanged(const std::set<makVrv::DtUniqueID>&) override;

      virtual void changeEvent(QEvent*) override;

   public:
      DtAltitudeSelectionWidget* myAltitude;
      QToolButton*   myCanTakeMapFocus;
      QVBoxLayout* myMainLayout;
      DtLocationCSEntryInterface* myDataEntryWidget;
      QWidget* myWidget;
      QFrame* myLocationFrame;
      QVBoxLayout* myLocationFrameLayout;
      QToolButton*   myExpandCollapseButton;
      QLabel* myLocationLabel;
      QWidget* myCompactLineWidget;
      QHBoxLayout* myCompactLineWidgetLayout;

   protected:
      QPixmap mySelectionIcon;
      DtLocationEntryWidgetLogic*   myLogic;
      bool myShowSelectedLook = true;
      bool                       myProcessMouseEvents;
      bool                       myLockAltitude;
      bool                       myAltitudeSelectionEnabled;
      DtVector                   myOriginalLocation;
      bool                       myBoundIsZero;
      bool myAdvancedKeyboardHandling;
      bool myHideZLocation;

      makVrv::DtCoordinateDisplay* myCoordinateSystem;
      bool myUseInputValidation;
      bool myInvalid;
      bool myBlockSignals;
      makVrv::DtSignalConnectionManager myConnections;
      bool myTakeMapFocusEnabled;
      bool myUseLabelForLocationEntry;
      bool myInitiallyExpand = false;

      std::map<int, DtLocationCSEntryCreatorInterface*> myCreators;
   };

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtLocationEntryWidgetExtension : public DtTaskSetVariableWidgetExtensionInterface
   {
      Q_OBJECT

   public:
      DtLocationEntryWidgetExtension(makVrv::DtDe&, QWidget* w, const Qt::WindowFlags& f = 0);
      virtual ~DtLocationEntryWidgetExtension() override;

   protected:
      virtual void setTo(DtScriptedTaskVariable& v) const override;
      virtual int setFrom(const DtScriptedTaskVariable& v, QGridLayout* parentLayout, int startRow) override;
      virtual void setReadOnly(bool b) override;

   public:
      QCheckBox* myInitiallyExpand;
   };

   class DT_DLL_VRFGUIDATAENTRYWIDGETS DtLocationEntryWithoutAltitudeWidget : public DtLocationEntryWidget 
   {
      Q_OBJECT

   public:
      DtLocationEntryWithoutAltitudeWidget(makVrv::DtDe& de, 
         QWidget* parent, const Qt::WindowFlags& flags = 0, const CreationFlags& cflags = NormalMode);

      //DTOR
      virtual ~DtLocationEntryWithoutAltitudeWidget() override;

      static std::string designerGroup()
      {
         return tr("VR-Forces Entity Manipulation").toUtf8().constData();
      }

      static std::string headerFile()
      {
         return tr("<vrfGuiDataEntryWidgets/locationEntryWidget.h>").toUtf8().constData();
      }

      static std::string variableName()
      {
         return tr("locationWithoutAltitude").toUtf8().constData();
      }

      virtual void setCompactMode(bool b) override;

   protected:
      virtual void updateLocationLabel() override;
   };

   typedef DtTaskSetVariableWidgetCreator<DtLocationEntryWidget> DtLocationEntryWidgetCreator;
   typedef DtTaskSetVariableWidgetCreator<DtLocationEntryWithoutAltitudeWidget> DtLocationEntryWithoutAltitudeWidgetCreator;
}