Salome HOME
Migration to OpenCASCADE CMake configuration
[modules/gui.git] / src / SVTK / SVTK_ViewWindow.h
index 7a592578b531c2f06c2ef223213537d2a812fb3e..d43e7678376e82f04da6bab8c9e336dda19ef865 100755 (executable)
@@ -1,21 +1,25 @@
-// Copyright (C) 2005  OPEN CASCADE, CEA/DEN, EDF R&D, PRINCIPIA R&D
-// 
+// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
-// License as published by the Free Software Foundation; either 
-// version 2.1 of the License.
-// 
-// This library is distributed in the hope that it will be useful 
-// but WITHOUT ANY WARRANTY; without even the implied warranty of 
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Lesser General Public License for more details.
 //
-// You should have received a copy of the GNU Lesser General Public  
-// License along with this library; if not, write to the Free Software 
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
+
 #ifndef SVTK_VIEWWINDOW_H
 #define SVTK_VIEWWINDOW_H
 
 
 #include "SVTK.h"
 #include "SVTK_Selection.h"
+#include "Qtx.h"
 #include "SUIT_ViewWindow.h"
+
 #include "SALOME_InteractiveObject.hxx"
 
+#include <QImage>
+#include <vtkSmartPointer.h>
+
 class SUIT_Desktop;
+class SUIT_ResourceMgr;
 
 class VTKViewer_Actor;
 class VTKViewer_Trihedron;
 
 class SVTK_ViewModelBase;
-class SVTK_MainWindow;
 class SVTK_Selector;
 class SVTK_View;
 
-class SVTK_InteractorStyle;
 class SVTK_CubeAxesActor2D;
 
-class SVTK_RenderWindow;
-class SVTK_RenderWindowInteractor;
-
 class vtkRenderer;
 class vtkRenderWindow;
 class vtkRenderWindowInteractor;
+class vtkInteractorStyle;
+class vtkCallbackCommand;
+
+class SVTK_RenderWindowInteractor;
+class SVTK_Renderer;
+class SVTK_NonIsometricDlg;
+class SVTK_UpdateRateDlg;
+class SVTK_CubeAxesDlg;
+class SVTK_SetRotationPointDlg;
+class SVTK_InteractorStyle;
+class SVTK_KeyFreeInteractorStyle;
+class SVTK_ViewParameterDlg;
+class SVTK_Recorder;
+
+namespace salomevtk
+{
+  class vtkPVAxesWidget;
+}
+
+class vtkObject;
+class QtxAction;
+
+namespace SVTK
+{
+  SVTK_EXPORT
+    int convertAction( const int );
+}
 
 //! Define a container for SALOME VTK view window
 class SVTK_EXPORT SVTK_ViewWindow : public SUIT_ViewWindow
@@ -57,275 +89,314 @@ class SVTK_EXPORT SVTK_ViewWindow : public SUIT_ViewWindow
   //! To construct #SVTK_ViewWindow instance
   SVTK_ViewWindow(SUIT_Desktop* theDesktop);
 
-  virtual
-  ~SVTK_ViewWindow();
+  virtual ~SVTK_ViewWindow();
   
+  virtual QImage dumpView();
+
   //! To initialize #SVTK_ViewWindow instance
-  virtual
-  void
-  Initialize(SVTK_ViewModelBase* theModel);
+  virtual void Initialize(SVTK_ViewModelBase* theModel);
 
   //! Get #SVTK_View
-  SVTK_View* 
-  getView();
+  SVTK_View* getView();
+
+  //! Get render window
+  vtkRenderWindow* getRenderWindow();
+
+  //! Get interactor
+  vtkRenderWindowInteractor* getInteractor() const;
 
-  //! Get #SVTK_MainWindow
-  SVTK_MainWindow* 
-  getMainWindow();
+  //! Get SVTK interactor
+  SVTK_RenderWindowInteractor*  GetInteractor() const;
 
-  //! Redirect the request to #SVTK_MainWindow::getRenderWindow
-  vtkRenderWindow* 
-  getRenderWindow();
+  //! Get current interactor style
+  vtkInteractorStyle* GetInteractorStyle() const;
 
-  //! Redirect the request to #SVTK_MainWindow::getInteractor
-  vtkRenderWindowInteractor*
-  getInteractor();
+  //! Add interactor style to the stack of styles
+  void PushInteractorStyle(vtkInteractorStyle* theStyle);
 
-  //! Redirect the request to #SVTK_MainWindow::getRenderer 
-  vtkRenderer* 
-  getRenderer();
+  //! Remove last interactor style from the stack of styles
+  void PopInteractorStyle();
 
-  //! Redirect the request to #SVTK_MainWindow::GetSelector 
-  SVTK_Selector* 
-  GetSelector();
+  //! Get renderer
+  vtkRenderer* getRenderer() const;
   
-  //! Redirect the request to #SVTK_Selector::SelectionMode
-  Selection_Mode
-  SelectionMode() const;
+  //! Get SVTK renderer
+  SVTK_Renderer* GetRenderer() const;
+
+  //! Get selector
+  SVTK_Selector* GetSelector() const;
+  
+  //! Set selection mode
+  Selection_Mode SelectionMode() const;
   
   //! Change selection mode
-  virtual
-  void
-  SetSelectionMode(Selection_Mode theMode);
-
-  //! Redirect the request to #SVTK_MainWindow::SetBackgroundColor 
-  virtual
-  void
-  setBackgroundColor( const QColor& );
-
-  //! Redirect the request to #SVTK_MainWindow::SetBackgroundColor 
-  QColor
-  backgroundColor() const;
-
-  //! Redirect the request to #SVTK_Renderer::IsTrihedronDisplayed
-  bool
-  isTrihedronDisplayed();
-
-  //! Redirect the request to #SVTK_Renderer::IsCubeAxesDisplayed
-  bool
-  isCubeAxesDisplayed();
+  virtual void SetSelectionMode(Selection_Mode theMode);
+
+  //! Set background color [obsolete] 
+  virtual void setBackgroundColor( const QColor& );
+
+  //! Get background color [obsolete]
+  QColor backgroundColor() const;
+
+  //! Set background
+  virtual void setBackground( const Qtx::BackgroundData& );
+
+  //! Get background
+  Qtx::BackgroundData background() const;
+
+  //! Return \c true if "display trihedron" flag is set
+  bool isTrihedronDisplayed();
+
+  //! Return \c true if "show graduated axes" flag is set
+  bool isCubeAxesDisplayed();
  
   /*  interactive object management */
   //! Redirect the request to #SVTK_View::highlight (to support old code)
-  virtual
-  void
-  highlight(const Handle(SALOME_InteractiveObject)& theIO, 
-           bool theIsHighlight = true, 
-           bool theIsUpdate = true);
+  virtual void highlight(const Handle(SALOME_InteractiveObject)& theIO, 
+                         bool theIsHighlight = true, 
+                         bool theIsUpdate = true);
 
   //! Redirect the request to #SVTK_View::unHighlightAll (to support old code)
-  virtual
-  void
-  unHighlightAll();
+  virtual void unHighlightAll();
 
   //! Redirect the request to #SVTK_View::isInViewer (to support old code)
-  bool
-  isInViewer(const Handle(SALOME_InteractiveObject)& theIObject);
+  bool isInViewer(const Handle(SALOME_InteractiveObject)& theIObject);
 
   //! Redirect the request to #SVTK_View::isVisible (to support old code)
-  bool
-  isVisible(const Handle(SALOME_InteractiveObject)& theIObject);
+  bool isVisible(const Handle(SALOME_InteractiveObject)& theIObject);
 
   //! Redirect the request to #SVTK_View::FindIObject (to support old code)
   //----------------------------------------------------------------------------
-  Handle(SALOME_InteractiveObject) 
-  FindIObject(const char* theEntry);
+  Handle(SALOME_InteractiveObject) FindIObject(const char* theEntry);
   
-  /* display */                
+  /* display */         
   //----------------------------------------------------------------------------
   //! Redirect the request to #SVTK_View::Display (to support old code)
-  virtual
-  void
-  Display(const Handle(SALOME_InteractiveObject)& theIObject,
-         bool theImmediatly = true);
+  virtual void Display(const Handle(SALOME_InteractiveObject)& theIObject,
+                       bool theImmediatly = true);
 
   //! Redirect the request to #SVTK_View::DisplayOnly (to support old code)
-  virtual
-  void
-  DisplayOnly(const Handle(SALOME_InteractiveObject)& theIObject);
+  virtual void DisplayOnly(const Handle(SALOME_InteractiveObject)& theIObject);
 
   //! Redirect the request to #SVTK_View::Erase (to support old code)
-  virtual
-  void
-  Erase(const Handle(SALOME_InteractiveObject)& theIObject,
-       bool theImmediatly = true);
+  virtual void Erase(const Handle(SALOME_InteractiveObject)& theIObject,
+                     bool theImmediatly = true);
 
   //! Redirect the request to #SVTK_View::DisplayAll (to support old code)
-  virtual
-  void 
-  DisplayAll();
+  virtual void DisplayAll();
 
   //! Redirect the request to #SVTK_View::EraseAll (to support old code)
-  virtual
-  void 
-  EraseAll();
+  virtual void EraseAll();
 
   //! To repaint the viewer
-  virtual
-  void
-  Repaint(bool theUpdateTrihedron = true);
+  virtual void Repaint(bool theUpdateTrihedron = true);
 
   //----------------------------------------------------------------------------
   //! Redirect the request to #SVTK_Renderer::SetScale
-  virtual
-  void 
-  SetScale( double theScale[3] );
+  virtual void SetScale( double theScale[3] );
 
   //! Redirect the request to #SVTK_Renderer::GetScale
-  virtual
-  void
-  GetScale( double theScale[3] );
+  virtual void GetScale( double theScale[3] );
 
   //! Redirect the request to #SVTK_Renderer::AddActor
-  virtual
-  void
-  AddActor(VTKViewer_Actor* theActor,
-          bool theIsUpdate = false);
+  virtual void AddActor(VTKViewer_Actor* theActor,
+                        bool theIsUpdate = false,
+                        bool theIsAdjustActors = true);
 
   //! Redirect the request to #SVTK_Renderer::RemoveActor
-  virtual
-  void
-  RemoveActor(VTKViewer_Actor* theActor,
-             bool theIsUpdate = false);
+  virtual void RemoveActor(VTKViewer_Actor* theActor,
+                           bool theIsUpdate = false,
+                           bool theIsAdjustActors = true);
 
   //----------------------------------------------------------------------------
   //! Redirect the request to #SVTK_Renderer::AdjustActors
-  virtual
-  void
-  AdjustTrihedrons(const bool theIsForced);
+  virtual void AdjustTrihedrons(const bool theIsForced);
 
   //! Redirect the request to #SVTK_Renderer::GetTrihedron
-  VTKViewer_Trihedron*  
-  GetTrihedron();
+  VTKViewer_Trihedron* GetTrihedron();
 
   //! Redirect the request to #SVTK_Renderer::GetCubeAxes
-  SVTK_CubeAxesActor2D* 
-  GetCubeAxes();
+  SVTK_CubeAxesActor2D* GetCubeAxes();
 
   //! Redirect the request to #SVTK_Renderer::GetTrihedronSize
-  int  
-  GetTrihedronSize() const;
+  double GetTrihedronSize() const;
 
   //! Redirect the request to #SVTK_Renderer::SetTrihedronSize
-  virtual
-  void 
-  SetTrihedronSize( const int, const bool = true );
-
-  //! Redirect the request to #SVTK_Renderer::SetSelectionProp
-  virtual
-  void
-  SetSelectionProp(const double& theRed = 1, 
-                  const double& theGreen = 1,
-                  const double& theBlue = 0, 
-                  const int& theWidth = 5);
+  virtual void SetTrihedronSize( const double, const bool = true );
+
+  //! Set incremental speed
+  virtual void SetIncrementalSpeed( const int, const int = 0 );
+
+  //! Set current projection mode
+  virtual void SetProjectionMode( const int );
+
+  //! Sets stereo type
+  virtual void SetStereoType( const int );
+
+  //! Sets anaglyph filter
+  virtual void SetAnaglyphFilter( const int );
+
+  //! Set support quad-buffered stereo
+  virtual void SetQuadBufferSupport( const bool );
+
+  //! Set interactive style
+  virtual void SetInteractionStyle( const int );
+
+  //! Set zooming style
+  virtual void SetZoomingStyle( const int );
+
+  //! Set preselection mode
+  virtual void SetPreSelectionMode( Preselection_Mode );
+
+  //! Enable/disable selection
+  virtual void SetSelectionEnabled( bool );
+
+  //! Customize space mouse buttons
+  virtual void SetSpacemouseButtons( const int, const int, const int );
+
+  //! Set selection properties
+  virtual void SetSelectionProp(const double& theRed = 1, 
+                                const double& theGreen = 1,
+                                const double& theBlue = 0, 
+                                const int& theWidth = 5);
 
   //! Redirect the request to #SVTK_Renderer::SetPreselectionProp
-  virtual
-  void
-  SetPreselectionProp(const double& theRed = 0, 
-                     const double& theGreen = 1,
-                     const double& theBlue = 1, 
-                     const int& theWidth = 5);
+  virtual void SetPreselectionProp(const double& theRed = 0, 
+                                   const double& theGreen = 1,
+                                   const double& theBlue = 1, 
+                                   const int& theWidth = 5);
 
   //! Redirect the request to #SVTK_Renderer::SetSelectionTolerance
-  virtual
-  void
-  SetSelectionTolerance(const double& theTolNodes = 0.025, 
-                       const double& theTolCell = 0.001);
+  virtual void SetSelectionTolerance(const double& theTolNodes = 0.025, 
+                                     const double& theTolCell = 0.001,
+                                     const double& theTolObjects = 0.025);
+
+  //! Get visibility status of the static trihedron
+  bool IsStaticTrihedronVisible() const;
+
+  //! Set visibility status of the static trihedron
+  virtual void SetStaticTrihedronVisible( const bool );
 
   //! Methods to save/restore visual parameters of a view (pan, zoom, etc.)
-  virtual 
-  QString   
-  getVisualParameters();
+  virtual QString getVisualParameters();
   
-  virtual
-  void
-  setVisualParameters( const QString& parameters );
+  virtual void setVisualParameters( const QString& parameters );
+
+  virtual bool eventFilter( QObject*, QEvent* );
+
+  virtual void RefreshDumpImage();
 
-  virtual
-  bool
-  eventFilter( QObject*, QEvent* );
+  void emitTransformed();
+
+  //! To invoke a VTK event on #SVTK_RenderWindowInteractor instance
+  void InvokeEvent(unsigned long theEvent, void* theCallData);
+  
+  virtual SUIT_CameraProperties cameraProperties();
   
+ signals:
+  void Show( QShowEvent * );
+  void Hide( QHideEvent * );
+
 public slots:
-  virtual
-  void
-  onSelectionChanged();
+  virtual void showEvent( QShowEvent * );
+  virtual void hideEvent( QHideEvent * );
+  virtual void onSelectionChanged();
+
+  void onChangeRotationPoint(bool theIsActivate);
+
+  void activateSetRotationGravity();
+  void activateSetRotationSelected(void* theData);
+  void activateStartPointSelection( Selection_Mode );
+
+  void onUpdateRate(bool theIsActivate);
+  void onNonIsometric(bool theIsActivate);
+  void onGraduatedAxes(bool theIsActivate);
+
+  void activateZoom();
+  void activateWindowFit();
+  void activateRotation();
+  void activatePanning(); 
+  void activateGlobalPanning(); 
+
+  void onProjectionMode( QAction* theAction );
+  void onStereoMode( bool activate );
+  void onProjectionMode();
+
+  void activateProjectionMode(int);
+
+  void activateSetFocalPointGravity();
+  void activateSetFocalPointSelected();
+  void activateStartFocalPointSelection();
+
+  void onViewParameters(bool theIsActivate);
+
+  void onSwitchInteractionStyle(bool theOn);
+  void onSwitchZoomingStyle(bool theOn);
+
+  void onSwitchPreSelectionMode(int theMode);
+  void onEnableSelection(bool theOn);
+
+  void onStartRecording();
+  void onPlayRecording();
+  void onPauseRecording();
+  void onStopRecording();
 
 signals:
  void selectionChanged();
+ void actorAdded(VTKViewer_Actor*);
+ void actorRemoved(VTKViewer_Actor*);
+ void transformed(SVTK_ViewWindow*);
 
 public slots:
   //! Redirect the request to #SVTK_Renderer::OnFrontView
-  virtual
-  void
-  onFrontView(); 
+  virtual void onFrontView(); 
 
   //! Redirect the request to #SVTK_Renderer::OnBackView
-  virtual
-  void
-  onBackView(); 
+  virtual void onBackView(); 
 
   //! Redirect the request to #SVTK_Renderer::OnTopView
-  virtual
-  void
-  onTopView();
+  virtual void onTopView();
 
   //! Redirect the request to #SVTK_Renderer::OnBottomView
-  virtual
-  void
-  onBottomView();
+  virtual void onBottomView();
 
   //! Redirect the request to #SVTK_Renderer::OnRightView
-  virtual
-  void 
-  onRightView(); 
+  virtual void onRightView(); 
 
   //! Redirect the request to #SVTK_Renderer::OnLeftView
-  virtual
-  void 
-  onLeftView();     
+  virtual void onLeftView();     
+
+  //! Redirect the request to #SVTK_Renderer::onClockWiseView
+  virtual void onClockWiseView();
+
+  //! Redirect the request to #SVTK_Renderer::onAntiClockWiseView
+  virtual void onAntiClockWiseView();
 
   //! Redirect the request to #SVTK_Renderer::OnResetView
-  virtual
-  void
-  onResetView();     
+  virtual void onResetView();     
 
   //! Redirect the request to #SVTK_Renderer::OnFitAll
-  virtual
-  void 
-  onFitAll();
+  virtual void onFitAll();
+
+  //! Redirect the request to #SVTK_Renderer::OnFitSelection
+  virtual void onFitSelection();
 
   //! Redirect the request to #SVTK_Renderer::OnViewTrihedron
-  virtual
-  void
-  onViewTrihedron(); 
+  virtual void onViewTrihedron(bool); 
 
   //! Redirect the request to #SVTK_Renderer::OnViewCubeAxes
-  virtual
-  void
-  onViewCubeAxes();
+  virtual void onViewCubeAxes();
 
   //! Redirect the request to #SVTK_Renderer::OnAdjustTrihedron
-  virtual
-  void
-  onAdjustTrihedron();
+  virtual void onAdjustTrihedron();
 
   //! Redirect the request to #SVTK_Renderer::OnAdjustCubeAxes
-  virtual
-  void 
-  onAdjustCubeAxes();
-
+  virtual void onAdjustCubeAxes();
+  
+  virtual void synchronize(SVTK_ViewWindow*);
+    
 protected slots:
+  void synchronize( SUIT_ViewWindow* );
   void onKeyPressed(QKeyEvent* event);
   void onKeyReleased(QKeyEvent* event);
   void onMousePressed(QMouseEvent* event);
@@ -333,23 +404,86 @@ protected slots:
   void onMouseReleased(QMouseEvent* event);
   void onMouseMoving(QMouseEvent* event);
 
+public:
+  enum ProjectionType { Parallel, Projection, Stereo };
+
+  enum StereoType { CrystalEyes, RedBlue, Interlaced, Left, Right, Dresden, Anaglyph, Checkerboard, SplitViewPortHorizontal };
+
+  enum AnaglyphFilter { RedCyan, YellowBlue, GreenMagenta };
+
 protected:
-  virtual
-  void
-  Initialize(SVTK_View* theView,
-            SVTK_ViewModelBase* theModel);
+  virtual void Initialize(SVTK_View* theView,
+                          SVTK_ViewModelBase* theModel);
 
-  void
-  doSetVisualParameters( const QString& );
+  // Main process event method
+  static void ProcessEvents(vtkObject* object,
+                            unsigned long event,
+                            void* clientdata,
+                            void* calldata);
 
-  QImage dumpView();
+  bool isOpenGlStereoSupport() const;
+
+  void doSetVisualParameters( const QString&, bool = false );
+  void SetEventDispatcher(vtkObject* theDispatcher);
+
+  QImage dumpViewContent();
+
+  virtual QString filter() const;
+  virtual bool dumpViewToFormat( const QImage& img, const QString& fileName, const QString& format );
+  
   virtual bool action( const int );
+  
+  QtxAction* getAction( int ) const;
+  void createToolBar();
+  void createActions(SUIT_ResourceMgr* theResourceMgr);
+
+  enum { DumpId, FitAllId, FitRectId, FitSelectionId, ZoomId, PanId, GlobalPanId,
+         ChangeRotationPointId, RotationId,
+         FrontId, BackId, TopId, BottomId, LeftId, RightId, ClockWiseId, AntiClockWiseId, ResetId,
+         ViewTrihedronId, NonIsometric, GraduatedAxes, UpdateRate,
+         ParallelModeId, ProjectionModeId, StereoModeId, ViewParametersId, SynchronizeId, SwitchInteractionStyleId,
+         SwitchZoomingStyleId, 
+        PreselectionId, StandardPreselectionId, DynamicPreselectionId, DisablePreselectionId, 
+        EnableSelectionId,
+         StartRecordingId, PlayRecordingId, PauseRecordingId, StopRecordingId };
 
   SVTK_View* myView;
-  SVTK_MainWindow* myMainWindow;
   SVTK_ViewModelBase* myModel;
 
+  SVTK_RenderWindowInteractor* myInteractor;
+  vtkSmartPointer<SVTK_InteractorStyle> myDefaultInteractorStyle;
+  vtkSmartPointer<SVTK_KeyFreeInteractorStyle> myKeyFreeInteractorStyle;
+
   QString myVisualParams; // used for delayed setting of view parameters 
+
+  vtkSmartPointer<vtkObject> myEventDispatcher;
+
+  // Used to process events
+  vtkSmartPointer<vtkCallbackCommand> myEventCallbackCommand;
+
+  SVTK_NonIsometricDlg* myNonIsometricDlg;
+  SVTK_UpdateRateDlg* myUpdateRateDlg;
+  SVTK_CubeAxesDlg* myCubeAxesDlg;
+  SVTK_SetRotationPointDlg* mySetRotationPointDlg;
+  SVTK_ViewParameterDlg* myViewParameterDlg;
+
+  QSize myPreRecordingMinSize;
+  QSize myPreRecordingMaxSize;
+
+  SVTK_Recorder* myRecorder;
+  QtxAction* myStartAction;
+  QtxAction* myPlayAction;
+  QtxAction* myPauseAction;
+  QtxAction* myStopAction;
+
+  int myToolBar;
+  int myRecordingToolBar;
+
+  salomevtk::vtkPVAxesWidget* myAxesWidget;
+  Qtx::BackgroundData myBackground;
+
+private:
+  QImage myDumpImage;
 };
 
 #ifdef WIN32