SVTK_ViewWindow.h

Go to the documentation of this file.

// Copyright (C) 2007-2025  CEA, EDF, 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, 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
// 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
 
#ifdef WIN32
#pragma warning( disable:4251 )
#endif
 
#include "SVTK.h"
#include "SVTK_Selection.h"
#include "Qtx.h"
#include "SUIT_ViewWindow.h"
 
#include "SALOME_InteractiveObject.hxx"
#include "SALOME_ListIO.hxx"
 
#include <QImage>
#include <vtkSmartPointer.h>
 
class SUIT_Desktop;
class SUIT_ResourceMgr;
 
class VTKViewer_Actor;
class VTKViewer_Trihedron;
 
class SVTK_ViewModelBase;
class SVTK_Selector;
class SVTK_View;
 
class SVTK_CubeAxesActor2D;
 
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 );
}
 
class SVTK_EXPORT SVTK_ViewWindow : public SUIT_ViewWindow
{
  Q_OBJECT
 
 public:
  SVTK_ViewWindow(SUIT_Desktop* theDesktop);
 
  virtual ~SVTK_ViewWindow();
  
  virtual QImage dumpView();
 
  virtual void Initialize(SVTK_ViewModelBase* theModel);
 
  SVTK_View* getView();
 
  vtkRenderWindow* getRenderWindow();
 
  vtkRenderWindowInteractor* getInteractor() const;
 
  SVTK_RenderWindowInteractor*  GetInteractor() const;
 
  vtkInteractorStyle* GetInteractorStyle() const;
 
  void PushInteractorStyle(vtkInteractorStyle* theStyle);
 
  void PopInteractorStyle();
 
  vtkRenderer* getRenderer() const;
  
  SVTK_Renderer* GetRenderer() const;
 
  SVTK_Selector* GetSelector() const;
  
  Selection_Mode SelectionMode() const;
  
  virtual void SetSelectionMode(Selection_Mode theMode);
 
  virtual void setBackgroundColor( const QColor& );
 
  QColor backgroundColor() const;
 
  virtual void setBackground( const Qtx::BackgroundData& );
 
  Qtx::BackgroundData background() const;
 
  bool isTrihedronDisplayed();
 
  bool isCubeAxesDisplayed();
 
  /*  interactive object management */
  virtual void highlight(const Handle(SALOME_InteractiveObject)& theIO, 
                         bool theIsHighlight = true, 
                         bool theIsUpdate = true);
 
  virtual void unHighlightAll();
 
  bool isInViewer(const Handle(SALOME_InteractiveObject)& theIObject);
 
  bool isVisible(const Handle(SALOME_InteractiveObject)& theIObject);
 
  //----------------------------------------------------------------------------
  Handle(SALOME_InteractiveObject) FindIObject(const char* theEntry);
  
  /* display */         
  //----------------------------------------------------------------------------
  virtual void Display(const Handle(SALOME_InteractiveObject)& theIObject,
                       bool theImmediatly = true);
 
  virtual void DisplayOnly(const Handle(SALOME_InteractiveObject)& theIObject);
 
  virtual void Erase(const Handle(SALOME_InteractiveObject)& theIObject,
                     bool theImmediatly = true);
 
  virtual void DisplayAll();
 
  virtual void EraseAll();
 
  virtual void Repaint(bool theUpdateTrihedron = true);
 
  //----------------------------------------------------------------------------
  virtual void SetScale( double theScale[3] );
 
  virtual void GetScale( double theScale[3] );
 
  virtual void AddActor(VTKViewer_Actor* theActor,
                        bool theIsUpdate = false,
                        bool theIsAdjustActors = true);
 
  virtual void RemoveActor(VTKViewer_Actor* theActor,
                           bool theIsUpdate = false,
                           bool theIsAdjustActors = true);
 
  //----------------------------------------------------------------------------
  virtual void AdjustTrihedrons(const bool theIsForced);
 
  VTKViewer_Trihedron* GetTrihedron();
 
  SVTK_CubeAxesActor2D* GetCubeAxes();
 
  double GetTrihedronSize() const;
 
  virtual void SetTrihedronSize( const double, const bool = true );
 
  virtual void SetIncrementalSpeed( const int, const int = 0 );
 
  virtual void SetProjectionMode( const int );
 
  virtual void SetStereoType( const int );
 
  virtual void SetAnaglyphFilter( const int );
 
  virtual void SetQuadBufferSupport( const bool );
 
  virtual void SetInteractionStyle( const int );
 
  virtual void SetZoomingStyle( const int );
 
  virtual void SetPreSelectionMode( Preselection_Mode );
 
  virtual void SetSelectionEnabled( bool );
 
  virtual void SetSpacemouseButtons( const int, const int, const int );
 
  virtual void SetSelectionProp(const double& theRed = 1, 
                                const double& theGreen = 1,
                                const double& theBlue = 0, 
                                const int& theWidth = 5);
 
  virtual void SetPreselectionProp(const double& theRed = 0, 
                                   const double& theGreen = 1,
                                   const double& theBlue = 1, 
                                   const int& theWidth = 5);
 
  virtual void SetSelectionTolerance(const double& theTolNodes = 0.025, 
                                     const double& theTolCell = 0.001,
                                     const double& theTolObjects = 0.025);
 
  bool IsStaticTrihedronVisible() const;
 
  virtual void SetStaticTrihedronVisible( const bool );
 
  virtual void setStaticTrihedronTextColor();
 
  virtual QString getVisualParameters();
  
  virtual void setVisualParameters( const QString& parameters );
 
  virtual bool eventFilter( QObject*, QEvent* );
 
  virtual void RefreshDumpImage();
 
  void emitTransformed();
 
  void InvokeEvent(unsigned long theEvent, void* theCallData);
  
  virtual SUIT_CameraProperties cameraProperties();
  
 signals:
  void Show( QShowEvent * );
  void Hide( QHideEvent * );
 
public slots:
  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 activateInteractiveSelection();
  void deactivateCurrectOperation();
 
  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:
  virtual void onFrontView(); 
 
  virtual void onBackView(); 
 
  virtual void onTopView();
 
  virtual void onBottomView();
 
  virtual void onRightView(); 
 
  virtual void onLeftView();     
 
  virtual void onClockWiseView();
 
  virtual void onAntiClockWiseView();
 
  virtual void onResetView();     
 
  virtual void onFitAll();
 
  virtual void onFitSelection();
 
  virtual void onFitIObjects(const SALOME_ListIO&);
 
  virtual void onViewTrihedron(bool); 
 
  virtual void onViewCubeAxes();
 
  virtual void onAdjustTrihedron();
 
  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);
  void onMouseDoubleClicked(QMouseEvent* event);
  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 resizeEvent( QResizeEvent* );
  
  virtual void Initialize(SVTK_View* theView,
                          SVTK_ViewModelBase* theModel);
 
  // Main process event method
  static void ProcessEvents(vtkObject* object,
                            unsigned long event,
                            void* clientdata,
                            void* calldata);
 
  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_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
#pragma warning( default:4251 )
#endif
 
#endif