Optimize the flushing: this improvement speed ups the unit test for 3-4 times

[modules/shaper.git] / src / ModuleBase / ModuleBase_IViewer.h

diff --git a/src/ModuleBase/ModuleBase_IViewer.h b/src/ModuleBase/ModuleBase_IViewer.h
index 3e573d22379843ca8c1c6cd5c46f9030dc1b3f10..7547d6c1f33ddb89ba67c065e9585ba3540af8e2 100644 (file)
--- a/src/ModuleBase/ModuleBase_IViewer.h
+++ b/src/ModuleBase/ModuleBase_IViewer.h
@@ -1,16 +1,21 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 #ifndef ModuleBase_IViewer_H
 #define ModuleBase_IViewer_H
 
 #include "ModuleBase.h"
 #include <QObject>
+#include <QMap>
 #include <AIS_InteractiveContext.hxx>
 #include <V3d_View.hxx>
 
 class QMouseEvent;
 class QKeyEvent;
 class QContextMenuEvent;
+class ModuleBase_IViewWindow;
 
 /**
+ * \ingroup GUI
  * A Base object for definition of connector object to
  * Salome Viewer. Reimplemented in NewGeom_SalomeViewer class
  */
@@ -18,10 +23,9 @@ class MODULEBASE_EXPORT ModuleBase_IViewer : public QObject
 {
 Q_OBJECT
  public:
-  ModuleBase_IViewer(QObject* theParent)
-      : QObject(theParent)
-  {
-  }
+   /// Constructor
+   /// \param theParent a parent object
+  ModuleBase_IViewer(QObject* theParent);
 
   //! Returns AIS_InteractiveContext from current OCCViewer
   virtual Handle(AIS_InteractiveContext) AISContext() const = 0;
@@ -33,12 +37,14 @@ Q_OBJECT
   virtual Handle(V3d_View) activeView() const = 0;
 
   //! Enable or disable selection in the viewer
+  //! \param isEnabled is enable or disable flag
   virtual void enableSelection(bool isEnabled) = 0;
 
   //! Returns true if selection is enabled
   virtual bool isSelectionEnabled() const = 0;
 
   //! Enable or disable multiselection in the viewer
+  //! \param isEnable is enable or disable flag
   virtual void enableMultiselection(bool isEnable) = 0;
 
   //! Returns true if multiselection is enabled
@@ -51,32 +57,96 @@ Q_OBJECT
   /// \param theX the X projection value
   /// \param theY the Y projection value
   /// \param theZ the Z projection value
-  virtual void setViewProjection(double theX, double theY, double theZ) = 0;
+  /// \param theTwist the twist angle in radians
+  virtual void setViewProjection( double theX, double theY, double theZ,
+                                  double theTwist ) = 0;
 
   /// Add selection filter to the viewer
+  /// \param theFilter a selection filter
   virtual void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter) = 0;
 
   /// Remove selection filter from the viewer
+  /// \param theFilter a selection filter
   virtual void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter) = 0;
 
+  /// Returns true if the selection filter is set to the viewer
+  /// \param theFilter a selection filter
+  virtual bool hasSelectionFilter(const Handle(SelectMgr_Filter)& theFilter) = 0;
+
   /// Remove all selection filters from the viewer
   virtual void clearSelectionFilters() = 0;
 
+  /// Update current viewer
+  virtual void update() = 0;
+
+  /// Returns a scale factor of the given view
+  /// \param theView a view object
+  const double Scale(const Handle(V3d_View)& theView)
+  {
+    if (!myWindowScale.contains(theView))
+      myWindowScale.insert(theView, theView->Camera()->Scale());
+    return myWindowScale[theView];
+  }
+
+  /// Remember a scale factor for the view object
+  /// \param theView a view object
+  /// \param theVal a scale factor
+  void SetScale(const Handle(V3d_View)& theView, const double theVal) { myWindowScale[theView] = theVal; }
+
+  /// Method returns True if the viewer can process editing objects 
+  /// by mouse drugging. If this is impossible thet it has to return False.
+  virtual bool canDragByMouse() const { return true; }
+
+  /// Fit all along Z (perpendicular to display)
+  virtual void Zfitall() = 0;
+
 signals:
+  /// Signal emited when last view window is closed
   void lastViewClosed();
-  void tryCloseView();
-  void deleteView();
-  void viewCreated();
-  void mousePress(QMouseEvent* theEvent);
-  void mouseRelease(QMouseEvent* theEvent);
-  void mouseDoubleClick(QMouseEvent* theEvent);
-  void mouseMove(QMouseEvent* theEvent);
-  void keyPress(QKeyEvent* theEvent);
-  void keyRelease(QKeyEvent* theEvent);
-  void activated();
 
+  /// Signal emited before view window is closed
+  void tryCloseView(ModuleBase_IViewWindow* theWnd);
+
+  /// Signal emited on delete view window
+  void deleteView(ModuleBase_IViewWindow* theWnd);
+
+  /// Signal emited on creation of view window
+  void viewCreated(ModuleBase_IViewWindow* theWnd);
+
+  /// Signal emited on key release
+  void activated(ModuleBase_IViewWindow* theWnd);
+
+  /// Signal emited on mouse press
+  void mousePress(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
+
+  /// Signal emited on mouse release
+  void mouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
+
+  /// Signal emited on mouse double click
+  void mouseDoubleClick(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
+
+  /// Signal emited on mouse move
+  void mouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
+
+  /// Signal emited on key press
+  void keyPress(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
+
+  /// Signal emited on key release
+  void keyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
+
+  /// Signal emited on selection changed
   void selectionChanged();
+
+  /// Signal emited on selection changed
   void contextMenuRequested(QContextMenuEvent*);
+
+  /// Signal emitted on transformation of view point in view window
+  /// \param theTransformation type of transformation (see AppElements_ViewWindow::OperationType)
+  void viewTransformed(int theTransformation);
+
+  protected:
+    /// A map for storing a scale factors dependent on view object
+    QMap<Handle(V3d_View), double> myWindowScale;
 };
 
 #endif