1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SALOME VTKViewer : build VTK viewer into Salome desktop
24 // File : SVTK_InteractorStyle.h
25 // Author : Christophe ATTANASIO
27 #ifndef __SVTK_InteractorStyle_h
28 #define __SVTK_InteractorStyle_h
32 #include "SVTK_SelectionEvent.h"
34 #include <boost/shared_ptr.hpp>
36 #include <vtkInteractorStyle.h>
37 #include <vtkSmartPointer.h>
40 #include <QtxRubberBand.h>
44 #include <vtkObject.h>
47 #pragma warning ( disable:4251 )
51 //! Control the value of increment in arithmetic progression mode.
53 This class controls of value of increment,
54 for pan/rotate/zoom operations in arithmetic progression mode
56 class SVTK_EXPORT SVTK_ControllerIncrement : public vtkObject{
58 vtkTypeMacro(SVTK_ControllerIncrement, vtkObject);
59 static SVTK_ControllerIncrement* New();
61 //! Set start value of increment
62 void SetStartValue(const int );
64 //! Get current value of increment
67 //! Increace the increment value by add 1
68 virtual int Increase();
70 //! Decreace the increment value by subtract 1
71 virtual int Decrease();
73 SVTK_ControllerIncrement();
74 virtual ~SVTK_ControllerIncrement();
78 SVTK_ControllerIncrement(const SVTK_ControllerIncrement&);//Not implemented
79 void operator=(const SVTK_ControllerIncrement&); //Not implemented
83 //! Control the value of increment in geometric progression mode.
85 This class controls of value of increment,
86 for pan/rotate/zoom operations in geometric progression mode.
88 class SVTK_EXPORT SVTK_GeomControllerIncrement : public SVTK_ControllerIncrement{
90 vtkTypeMacro(SVTK_GeomControllerIncrement, SVTK_ControllerIncrement);
91 static SVTK_GeomControllerIncrement* New();
93 //! Increace the increment value by add 1
94 virtual int Increase();
96 //! Decreace the increment value by subtract 1
97 virtual int Decrease();
99 SVTK_GeomControllerIncrement();
100 virtual ~SVTK_GeomControllerIncrement();
102 SVTK_GeomControllerIncrement(const SVTK_GeomControllerIncrement&);//Not implemented
103 void operator=(const SVTK_GeomControllerIncrement&); //Not implemented
106 //! Control the behaviour of KeyDown event in SALOME way.
108 This class controls the behaviour of KeyDown event
111 class SVTK_EXPORT SVTK_ControllerOnKeyDown : public vtkObject{
113 vtkTypeMacro(SVTK_ControllerOnKeyDown, vtkObject);
114 static SVTK_ControllerOnKeyDown* New();
116 //! Provides the action on event
117 virtual bool OnKeyDown(vtkInteractorStyle* );
120 SVTK_ControllerOnKeyDown();
121 virtual ~SVTK_ControllerOnKeyDown();
124 SVTK_ControllerOnKeyDown(const SVTK_ControllerOnKeyDown&);//Not implemented
125 void operator=(const SVTK_ControllerOnKeyDown&); //Not implemented
128 class vtkPointPicker;
129 class vtkTDxInteractorStyle;
134 class SVTK_GenericRenderWindowInteractor;
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
149 enum PolygonState { Disable, Start, InProcess, Finished, Closed, NotValid };
151 //! Introduce SALOME way of user interaction
153 This class defines SALOME way of user interaction for VTK viewer, as well,
154 as introduce a new selection mechanism
156 class SVTK_EXPORT SVTK_InteractorStyle: public vtkInteractorStyle
159 static SVTK_InteractorStyle *New();
160 vtkTypeMacro(SVTK_InteractorStyle, vtkInteractorStyle);
162 typedef boost::shared_ptr<SVTK_SelectionEvent> PSelectionEvent;
164 void SetTDxStyle(vtkTDxInteractorStyle*){}
166 //! Generate special #SVTK_SelectionEvent
167 virtual SVTK_SelectionEvent* GetSelectionEvent();
169 //! Generate special #SVTK_SelectionEvent with flipped Y coordinate
170 virtual SVTK_SelectionEvent* GetSelectionEventFlipY();
172 //! Redefined in order to add an observer (callback) for custom event (space mouse event)
173 virtual void SetInteractor( vtkRenderWindowInteractor* );
175 //! To invoke #vtkRenderWindowInteractor::CreateTimer
176 virtual void Render();
178 //! To implement cached rendering
179 virtual void OnTimer();
181 //! To reset reset view
182 virtual void OnConfigure();
184 //! To handle mouse move event
185 virtual void OnMouseMove();
187 //! To handle left mouse button down event (reimplemented from #vtkInteractorStyle)
188 virtual void OnLeftButtonDown();
190 //! To handle left mouse button up event (reimplemented from #vtkInteractorStyle)
191 virtual void OnLeftButtonUp();
193 //! To handle middle mouse button down event (reimplemented from #vtkInteractorStyle)
194 virtual void OnMiddleButtonDown();
196 //! To handle middle mouse button up event (reimplemented from #vtkInteractorStyle)
197 virtual void OnMiddleButtonUp();
199 //! To handle right mouse button down event (reimplemented from #vtkInteractorStyle)
200 virtual void OnRightButtonDown();
202 //! To handle right mouse button up event (reimplemented from #vtkInteractorStyle)
203 virtual void OnRightButtonUp();
205 //! To handle mouse wheel forward event (reimplemented from #vtkInteractorStyle)
206 virtual void OnMouseWheelForward();
208 //! To handle mouse wheel backward event (reimplemented from #vtkInteractorStyle)
209 virtual void OnMouseWheelBackward();
211 //! To handle mouse button double click event
212 virtual void OnMouseButtonDoubleClick();
214 //! To handle keyboard event (reimplemented from #vtkInteractorStyle)
215 virtual void OnChar();
217 //! To set current increment controller
218 void SetControllerIncrement(SVTK_ControllerIncrement*);
220 //! To modify current increment controller
221 void SetIncrementSpeed(const int, const int = 0);
223 //! To get current increment controller
224 SVTK_ControllerIncrement* ControllerIncrement();
226 //! Redefine vtkInteractorStyle::OnKeyDown
227 virtual void OnKeyDown();
229 //! Provide instructions for Picking
230 void ActionPicking();
232 //! To set current OnKeyDown controller
233 void SetControllerOnKeyDown(SVTK_ControllerOnKeyDown*);
235 //! To get current OnKeyDown controller
236 SVTK_ControllerOnKeyDown* ControllerOnKeyDown();
238 SVTK_Selector* GetSelector();
240 int CurrentState() const { return State; }
241 PolygonState GetPolygonState() const { return myPoligonState; }
242 void SetPolygonState( const PolygonState& thePolygonState )
243 { myPoligonState = thePolygonState; }
245 void SetAdvancedZoomingEnabled( const bool theState ) { myIsAdvancedZoomingEnabled = theState; }
246 bool IsAdvancedZoomingEnabled() const { return myIsAdvancedZoomingEnabled; }
249 SVTK_InteractorStyle();
250 ~SVTK_InteractorStyle();
255 // Generic event bindings must be overridden in subclasses
256 virtual void OnMouseMove (int ctrl, int shift, int x, int y);
257 virtual void OnLeftButtonDown(int ctrl, int shift, int x, int y);
258 virtual void OnLeftButtonUp (int ctrl, int shift, int x, int y);
259 virtual void OnMiddleButtonDown(int ctrl, int shift, int x, int y);
260 virtual void OnMiddleButtonUp (int ctrl, int shift, int x, int y);
261 virtual void OnRightButtonDown(int ctrl, int shift, int x, int y);
262 virtual void OnRightButtonUp (int ctrl, int shift, int x, int y);
264 void RotateXY(int dx, int dy);
265 void PanXY(int x, int y, int oldX, int oldY);
266 void DollyXY(int dx, int dy);
267 void SpinXY(int dx, int dy, int oldX, int oldY);
268 void fitRect(const int left, const int top, const int right, const int bottom);
269 void Place(const int theX, const int theY);
270 void TranslateView(int toX, int toY, int fromX, int fromY);
273 IncrementalPan( const int incrX, const int incrY );
276 IncrementalZoom( const int incr );
279 IncrementalRotate( const int incrX, const int incrY );
281 // Main process event method (reimplemented from #vtkInteractorStyle)
284 ProcessEvents(vtkObject* object,
290 float RadianToDegree; // constant: for conv from deg to rad
296 void startGlobalPan();
301 void startPointSelection();
302 void startFocalPointSelection();
306 void startOperation(int operation);
307 void onStartOperation();
308 virtual void onFinishOperation();
309 void onOperation(QPoint mousePos);
310 void onCursorMove(QPoint mousePos);
311 void setCursor(const int operation);
313 void onSpaceMouseMove( double* data );
314 virtual void onSpaceMouseButton( int button );
316 void DominantCombinedSwitch();
321 void endDrawPolygon();
326 QCursor myZoomCursor;
327 QCursor myRotateCursor;
328 QCursor mySpinCursor;
329 QCursor myHandCursor;
330 QCursor myGlobalPanCursor;
337 vtkSmartPointer<SALOME_Actor> myLastHighlitedActor;
338 vtkSmartPointer<SALOME_Actor> myLastPreHighlitedActor;
340 //! "Increment" controller for pan/rotate/zoom operations
341 vtkSmartPointer<SVTK_ControllerIncrement> myControllerIncrement;
343 //!controls the behaviour of KeyDown event in SALOME way
344 vtkSmartPointer<SVTK_ControllerOnKeyDown> myControllerOnKeyDown;
346 // SpaceMouse short cuts
347 int mySMDecreaseSpeedBtn;
348 int mySMIncreaseSpeedBtn;
349 int mySMDominantCombinedSwitchBtn;
351 vtkSmartPointer<SVTK_GenericRenderWindowInteractor> myInteractor;
353 PSelectionEvent mySelectionEvent;
355 unsigned long myCurrRotationPointType;
356 unsigned long myPrevRotationPointType;
358 unsigned long myCurrFocalPointType;
359 unsigned long myPrevFocalPointType;
361 double myRotationPointX;
362 double myRotationPointY;
363 double myRotationPointZ;
365 vtkSmartPointer<SVTK_Actor> myHighlightSelectionPointActor;
366 vtkSmartPointer<vtkPointPicker> myPointPicker;
368 double myBBCenter[3];
371 QRubberBand* myRectBand; //!< selection rectangle rubber band
372 QtxPolyRubberBand* myPolygonBand; //!< polygonal selection
373 QVector<QPoint> myPolygonPoints;
374 PolygonState myPoligonState;
376 bool myIsAdvancedZoomingEnabled;
380 #pragma warning ( default:4251 )