src/SVTK/SVTK_InteractorStyle.h

   1 // Copyright (C) 2007-2023  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  SALOME VTKViewer : build VTK viewer into Salome desktop
  24 //  File   : SVTK_InteractorStyle.h
  25 //  Author : Christophe ATTANASIO
  26
  27 #ifndef __SVTK_InteractorStyle_h
  28 #define __SVTK_InteractorStyle_h
  29
  30 #include "SVTK.h"
  31
  32 #include "SVTK_SelectionEvent.h"
  33
  34 #include <boost/shared_ptr.hpp>
  35
  36 #include <vtkInteractorStyle.h>
  37 #include <vtkSmartPointer.h>
  38
  39 #include <QCursor>
  40 #include <QtxRubberBand.h>
  41
  42 #include <map>
  43
  44 #include <vtkObject.h>
  45
  46 #ifdef WIN32
  47 #pragma warning ( disable:4251 )
  48 #endif
  49
  50 //
  51 //! Control the value of increment  in arithmetic progression mode.
  52 /*!
  53   This class controls of value of increment,
  54   for pan/rotate/zoom operations in arithmetic progression mode
  55 */
  56 class SVTK_EXPORT SVTK_ControllerIncrement : public vtkObject{
  57  public:
  58   vtkTypeMacro(SVTK_ControllerIncrement, vtkObject)
  59   static SVTK_ControllerIncrement* New();
  60
  61   //! Set start value of increment
  62   void SetStartValue(const int );
  63
  64   //! Get current value of increment
  65   int Current()const;
  66
  67   //! Increace the increment value by add 1
  68   virtual int Increase();
  69
  70   //! Decreace the increment value by subtract 1
  71   virtual int Decrease();
  72  protected:
  73   SVTK_ControllerIncrement();
  74   virtual ~SVTK_ControllerIncrement();
  75  protected:
  76   int  myIncrement;
  77  private:
  78   SVTK_ControllerIncrement(const SVTK_ControllerIncrement&);//Not implemented
  79   void operator=(const SVTK_ControllerIncrement&);          //Not implemented
  80 };
  81
  82 //
  83 //! Control the value of increment  in geometric progression mode.
  84 /*!
  85   This class controls of value of increment,
  86   for pan/rotate/zoom operations in geometric progression mode.
  87 */
  88 class SVTK_EXPORT SVTK_GeomControllerIncrement : public SVTK_ControllerIncrement{
  89  public:
  90   vtkTypeMacro(SVTK_GeomControllerIncrement, SVTK_ControllerIncrement)
  91   static SVTK_GeomControllerIncrement* New();
  92
  93   //! Increace the increment value by add 1
  94   virtual int Increase();
  95
  96   //! Decreace the increment value by subtract 1
  97   virtual int Decrease();
  98  protected:
  99   SVTK_GeomControllerIncrement();
 100   virtual ~SVTK_GeomControllerIncrement();
 101  private:
 102   SVTK_GeomControllerIncrement(const SVTK_GeomControllerIncrement&);//Not implemented
 103   void operator=(const SVTK_GeomControllerIncrement&);              //Not implemented
 104 };
 105 //
 106 //! Control the behaviour of KeyDown event in SALOME way.
 107 /*!
 108   This class controls the behaviour of KeyDown event
 109   in SALOME way
 110 */
 111 class SVTK_EXPORT SVTK_ControllerOnKeyDown : public vtkObject{
 112  public:
 113   vtkTypeMacro(SVTK_ControllerOnKeyDown, vtkObject)
 114   static SVTK_ControllerOnKeyDown* New();
 115
 116   //! Provides the action on event
 117   virtual bool OnKeyDown(vtkInteractorStyle* );
 118
 119  protected:
 120   SVTK_ControllerOnKeyDown();
 121   virtual ~SVTK_ControllerOnKeyDown();
 122
 123  private:
 124   SVTK_ControllerOnKeyDown(const SVTK_ControllerOnKeyDown&);//Not implemented
 125   void operator=(const SVTK_ControllerOnKeyDown&);          //Not implemented
 126 };
 127
 128 class vtkPointPicker;
 129 class vtkTDxInteractorStyle;
 130
 131 class SALOME_Actor;
 132
 133 class SVTK_Selector;
 134 class SVTK_GenericRenderWindowInteractor;
 135 class SVTK_Actor;
 136
 137 class QtxRectRubberBand;
 138
 139 #define VTK_INTERACTOR_STYLE_CAMERA_NONE    0
 140 #define VTK_INTERACTOR_STYLE_CAMERA_ROTATE  1
 141 #define VTK_INTERACTOR_STYLE_CAMERA_PAN     2
 142 #define VTK_INTERACTOR_STYLE_CAMERA_ZOOM    3
 143 #define VTK_INTERACTOR_STYLE_CAMERA_SPIN    4
 144 #define VTK_INTERACTOR_STYLE_CAMERA_FIT        5
 145 #define VTK_INTERACTOR_STYLE_CAMERA_SELECT     6
 146 #define VTK_INTERACTOR_STYLE_CAMERA_GLOBAL_PAN 7
 147 #define VTK_INTERACTOR_STYLE_CAMERA_SELECT_ROTATION_POINT 8
 148 #define VTK_INTERACTOR_STYLE_CAMERA_INTERACTIVE_SELECTION 9
 149
 150 enum PolygonState { Disable, Start, InProcess, Finished, Closed, NotValid };
 151
 152 //! Introduce SALOME way of user interaction
 153 /*!
 154   This class defines SALOME way of user interaction for VTK viewer, as well,
 155   as introduce a new selection mechanism
 156 */
 157 class SVTK_EXPORT SVTK_InteractorStyle: public vtkInteractorStyle
 158 {
 159  public:
 160   static SVTK_InteractorStyle *New();
 161   vtkTypeMacro(SVTK_InteractorStyle, vtkInteractorStyle)
 162
 163   typedef boost::shared_ptr<SVTK_SelectionEvent> PSelectionEvent;
 164
 165   void SetTDxStyle(vtkTDxInteractorStyle*){}
 166
 167   //! Generate special #SVTK_SelectionEvent
 168   virtual SVTK_SelectionEvent* GetSelectionEvent();
 169
 170   //! Generate special #SVTK_SelectionEvent with flipped Y coordinate
 171   virtual SVTK_SelectionEvent* GetSelectionEventFlipY();
 172
 173   //! Redefined in order to add an observer (callback) for custom event (space mouse event)
 174   virtual void SetInteractor( vtkRenderWindowInteractor* );
 175
 176   //! To invoke #vtkRenderWindowInteractor::CreateTimer
 177   virtual void Render();
 178
 179   //! To implement cached rendering
 180   virtual void OnTimer();
 181
 182   //! To reset reset view
 183   virtual void OnConfigure();
 184
 185   //! To handle mouse move event
 186   virtual void OnMouseMove();
 187
 188   //! To handle left mouse button down event (reimplemented from #vtkInteractorStyle)
 189   virtual void OnLeftButtonDown();
 190
 191   //! To handle left mouse button up event (reimplemented from #vtkInteractorStyle)
 192   virtual void OnLeftButtonUp();
 193
 194   //! To handle middle mouse button down event (reimplemented from #vtkInteractorStyle)
 195   virtual void OnMiddleButtonDown();
 196
 197   //! To handle middle mouse button up event (reimplemented from #vtkInteractorStyle)
 198   virtual void OnMiddleButtonUp();
 199
 200   //! To handle right mouse button down event (reimplemented from #vtkInteractorStyle)
 201   virtual void OnRightButtonDown();
 202
 203   //! To handle right mouse button up event (reimplemented from #vtkInteractorStyle)
 204   virtual void OnRightButtonUp();
 205
 206   //! To handle mouse wheel forward event (reimplemented from #vtkInteractorStyle)
 207   virtual void OnMouseWheelForward();
 208
 209   //! To handle mouse wheel backward event (reimplemented from #vtkInteractorStyle)
 210   virtual void OnMouseWheelBackward();
 211
 212   //! To handle mouse button double click event
 213   virtual void OnMouseButtonDoubleClick();
 214
 215   //! To handle keyboard event (reimplemented from #vtkInteractorStyle)
 216   virtual void OnChar();
 217
 218   //! To set current increment controller
 219   void SetControllerIncrement(SVTK_ControllerIncrement*);
 220
 221   //! To modify current increment controller
 222   void SetIncrementSpeed(const int, const int = 0);
 223
 224   //! To get current increment controller
 225   SVTK_ControllerIncrement* ControllerIncrement();
 226
 227   //! Redefine vtkInteractorStyle::OnKeyDown
 228   virtual void OnKeyDown();
 229
 230   //! Provide instructions for Picking
 231   void ActionPicking();
 232
 233   //! To set current OnKeyDown controller
 234   void SetControllerOnKeyDown(SVTK_ControllerOnKeyDown*);
 235
 236   //! To get current OnKeyDown controller
 237   SVTK_ControllerOnKeyDown* ControllerOnKeyDown();
 238
 239   SVTK_Selector* GetSelector();
 240
 241   int          CurrentState() const { return State; }
 242   PolygonState GetPolygonState() const { return myPoligonState; }
 243   void         SetPolygonState( const PolygonState& thePolygonState )
 244                               { myPoligonState = thePolygonState; }
 245
 246   void SetAdvancedZoomingEnabled( const bool theState ) { myIsAdvancedZoomingEnabled = theState; }
 247   bool IsAdvancedZoomingEnabled() const { return myIsAdvancedZoomingEnabled; }
 248
 249   //! releaze myLastHighlitedActor and myLastPreHighlitedActor
 250   void FreeActors();
 251
 252   protected:
 253   SVTK_InteractorStyle();
 254   ~SVTK_InteractorStyle();
 255
 256   QWidget*
 257   GetRenderWidget();
 258
 259   // Generic event bindings must be overridden in subclasses
 260   virtual void OnMouseMove  (int ctrl, int shift, int x, int y);
 261   virtual void OnLeftButtonDown(int ctrl, int shift, int x, int y);
 262   virtual void OnLeftButtonUp  (int ctrl, int shift, int x, int y);
 263   virtual void OnMiddleButtonDown(int ctrl, int shift, int x, int y);
 264   virtual void OnMiddleButtonUp  (int ctrl, int shift, int x, int y);
 265   virtual void OnRightButtonDown(int ctrl, int shift, int x, int y);
 266   virtual void OnRightButtonUp  (int ctrl, int shift, int x, int y);
 267
 268   void RotateXY(int dx, int dy);
 269   void PanXY(int x, int y, int oldX, int oldY);
 270   void DollyXY(int dx, int dy);
 271   void SpinXY(int dx, int dy, int oldX, int oldY);
 272   void fitRect(const int left, const int top, const int right, const int bottom);
 273   void Place(const int theX, const int theY);
 274   void TranslateView(int toX, int toY, int fromX, int fromY);
 275
 276   void
 277   IncrementalPan( const int incrX, const int incrY );
 278
 279   void
 280   IncrementalZoom( const int incr );
 281
 282   void
 283   IncrementalRotate( const int incrX, const int incrY );
 284
 285   void
 286   InteractiveSelection();
 287
 288   // Main process event method (reimplemented from #vtkInteractorStyle)
 289   static
 290   void
 291   ProcessEvents(vtkObject* object,
 292                 unsigned long event,
 293                 void* clientData,
 294                 void* callData );
 295
 296   float MotionFactor;
 297   float RadianToDegree;                 // constant: for conv from deg to rad
 298   double myScale;
 299
 300  protected:
 301   void startZoom();
 302   void startPan();
 303   void startGlobalPan();
 304   void startRotate();
 305   void startFitArea();
 306   void startSpin();
 307
 308   void startPointSelection();
 309   void startFocalPointSelection();
 310   void startInteractiveSelection();
 311
 312  protected:
 313   void loadCursors();
 314   void startOperation(int operation);
 315   void onStartOperation();
 316   virtual void onFinishOperation();
 317   void onOperation(QPoint mousePos);
 318   void onCursorMove(QPoint mousePos);
 319   void setCursor(const int operation);
 320
 321   void onSpaceMouseMove( double* data );
 322   virtual void onSpaceMouseButton( int button );
 323
 324   void DominantCombinedSwitch();
 325
 326   void drawRect();
 327   void endDrawRect();
 328   void drawPolygon();
 329   void endDrawPolygon();
 330
 331  protected:
 332   QCursor                   myDefCursor;
 333   QCursor                   myPanCursor;
 334   QCursor                   myZoomCursor;
 335   QCursor                   myRotateCursor;
 336   QCursor                   mySpinCursor;
 337   QCursor                   myHandCursor;
 338   QCursor                   myGlobalPanCursor;
 339   QPoint                    myPoint;
 340   QPoint                    myOtherPoint;
 341   bool                      myCursorState;
 342   bool                      myShiftState;
 343   int                       ForcedState;
 344
 345   vtkSmartPointer<SALOME_Actor> myLastHighlitedActor;
 346   vtkSmartPointer<SALOME_Actor> myLastPreHighlitedActor;
 347
 348   //! "Increment" controller for pan/rotate/zoom operations
 349   vtkSmartPointer<SVTK_ControllerIncrement> myControllerIncrement;
 350
 351   //!controls the behaviour of KeyDown event in SALOME way
 352   vtkSmartPointer<SVTK_ControllerOnKeyDown> myControllerOnKeyDown;
 353
 354   // SpaceMouse short cuts
 355   int                       mySMDecreaseSpeedBtn;
 356   int                       mySMIncreaseSpeedBtn;
 357   int                       mySMDominantCombinedSwitchBtn;
 358
 359   vtkSmartPointer<SVTK_GenericRenderWindowInteractor> myInteractor;
 360
 361   PSelectionEvent mySelectionEvent;
 362
 363   unsigned long                   myCurrRotationPointType;
 364   unsigned long                   myPrevRotationPointType;
 365
 366   unsigned long                   myCurrFocalPointType;
 367   unsigned long                   myPrevFocalPointType;
 368
 369   double                          myRotationPointX;
 370   double                          myRotationPointY;
 371   double                          myRotationPointZ;
 372
 373   vtkSmartPointer<SVTK_Actor>     myHighlightSelectionPointActor;
 374   vtkSmartPointer<vtkPointPicker> myPointPicker;
 375
 376   double                          myBBCenter[3];
 377   double                          myInteractivePoint[3];
 378   bool                            myBBFirstCheck;
 379
 380   QtxRectRubberBand*              myRectBand; //!< selection rectangle rubber band
 381   QtxPolyRubberBand*              myPolygonBand; //!< polygonal selection
 382   QVector<QPoint>                 myPolygonPoints;
 383   PolygonState                    myPoligonState;
 384
 385   bool                            myIsAdvancedZoomingEnabled;
 386 };
 387
 388 #ifdef WIN32
 389 #pragma warning ( default:4251 )
 390 #endif
 391
 392 #endif