src/ModuleBase/ModuleBase_IViewer.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 #ifndef ModuleBase_IViewer_H
   4 #define ModuleBase_IViewer_H
   5
   6 #include "ModuleBase.h"
   7 #include <QObject>
   8 #include <QMap>
   9 #include <AIS_InteractiveContext.hxx>
  10 #include <V3d_View.hxx>
  11
  12 class QMouseEvent;
  13 class QKeyEvent;
  14 class QContextMenuEvent;
  15 class ModuleBase_IViewWindow;
  16
  17 /**
  18  * \ingroup GUI
  19  * A Base object for definition of connector object to
  20  * Salome Viewer. Reimplemented in NewGeom_SalomeViewer class
  21  */
  22 class MODULEBASE_EXPORT ModuleBase_IViewer : public QObject
  23 {
  24 Q_OBJECT
  25  public:
  26    /// Constructor
  27    /// \param theParent a parent object
  28   ModuleBase_IViewer(QObject* theParent)
  29       : QObject(theParent)
  30   {
  31   }
  32
  33   //! Returns AIS_InteractiveContext from current OCCViewer
  34   virtual Handle(AIS_InteractiveContext) AISContext() const = 0;
  35
  36   //! Retrurns V3d_Vioewer from current viewer
  37   virtual Handle(V3d_Viewer) v3dViewer() const = 0;
  38
  39   //! Returns Vsd_View object from currently active view window
  40   virtual Handle(V3d_View) activeView() const = 0;
  41
  42   //! Enable or disable selection in the viewer
  43   //! \param isEnabled is enable or disable flag
  44   virtual void enableSelection(bool isEnabled) = 0;
  45
  46   //! Returns true if selection is enabled
  47   virtual bool isSelectionEnabled() const = 0;
  48
  49   //! Enable or disable multiselection in the viewer
  50   //! \param isEnable is enable or disable flag
  51   virtual void enableMultiselection(bool isEnable) = 0;
  52
  53   //! Returns true if multiselection is enabled
  54   virtual bool isMultiSelectionEnabled() const = 0;
  55
  56   //! Perfroms the fit all for the active view
  57   virtual void fitAll() = 0;
  58
  59   //! Sets the view projection
  60   /// \param theX the X projection value
  61   /// \param theY the Y projection value
  62   /// \param theZ the Z projection value
  63   virtual void setViewProjection(double theX, double theY, double theZ) = 0;
  64
  65   /// Add selection filter to the viewer
  66   /// \param theFilter a selection filter
  67   virtual void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter) = 0;
  68
  69   /// Remove selection filter from the viewer
  70   /// \param theFilter a selection filter
  71   virtual void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter) = 0;
  72
  73   /// Remove all selection filters from the viewer
  74   virtual void clearSelectionFilters() = 0;
  75
  76   /// Update current viewer
  77   virtual void update() = 0;
  78
  79   const double Scale(const Handle(V3d_View)& theView)
  80   {
  81     if (!myWindowScale.contains(theView))
  82       myWindowScale.insert(theView, theView->Camera()->Scale());
  83     return myWindowScale[theView];
  84   }
  85
  86   void SetScale(const Handle(V3d_View)& theView, const double theVal) { myWindowScale[theView] = theVal; }
  87
  88   /// Method returns True if the viewer can process editing objects
  89   /// by mouse drugging. If this is impossible thet it has to return False.
  90   virtual bool canDragByMouse() const { return true; }
  91
  92 signals:
  93   /// Signal emited when last view window is closed
  94   void lastViewClosed();
  95
  96   /// Signal emited before view window is closed
  97   void tryCloseView(ModuleBase_IViewWindow* theWnd);
  98
  99   /// Signal emited on delete view window
 100   void deleteView(ModuleBase_IViewWindow* theWnd);
 101
 102   /// Signal emited on creation of view window
 103   void viewCreated(ModuleBase_IViewWindow* theWnd);
 104
 105   /// Signal emited on key release
 106   void activated(ModuleBase_IViewWindow* theWnd);
 107
 108   /// Signal emited on mouse press
 109   void mousePress(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
 110
 111   /// Signal emited on mouse release
 112   void mouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
 113
 114   /// Signal emited on mouse double click
 115   void mouseDoubleClick(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
 116
 117   /// Signal emited on mouse move
 118   void mouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
 119
 120   /// Signal emited on key press
 121   void keyPress(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 122
 123   /// Signal emited on key release
 124   void keyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
 125
 126   /// Signal emited on selection changed
 127   void selectionChanged();
 128
 129   /// Signal emited on selection changed
 130   void contextMenuRequested(QContextMenuEvent*);
 131
 132   /// Signal emitted on transformation of view point in view window
 133   /// \param theTransformation type of transformation (see AppElements_ViewWindow::OperationType)
 134   void viewTransformed(int theTransformation);
 135
 136   protected:
 137     QMap<Handle(V3d_View), double> myWindowScale;
 138 };
 139
 140 #endif