VTK  9.2.20220703
vtkInteractorStyle.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInteractorStyle.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
160 #ifndef vtkInteractorStyle_h
161 #define vtkInteractorStyle_h
162 
163 #include "vtkInteractorObserver.h"
164 #include "vtkRenderingCoreModule.h" // For export macro
165 
166 // Motion flags
167 
168 #define VTKIS_START 0
169 #define VTKIS_NONE 0
170 
171 #define VTKIS_ROTATE 1
172 #define VTKIS_PAN 2
173 #define VTKIS_SPIN 3
174 #define VTKIS_DOLLY 4
175 #define VTKIS_ZOOM 5
176 #define VTKIS_USCALE 6
177 #define VTKIS_TIMER 7
178 #define VTKIS_FORWARDFLY 8
179 #define VTKIS_REVERSEFLY 9
180 #define VTKIS_TWO_POINTER 10
181 #define VTKIS_CLIP 11
182 #define VTKIS_PICK 12 // perform a pick at the last location
183 #define VTKIS_LOAD_CAMERA_POSE 13 // iterate through saved camera poses
184 #define VTKIS_POSITION_PROP 14 // adjust the position, orientation of a prop
185 #define VTKIS_EXIT 15 // call exit callback
186 #define VTKIS_TOGGLE_DRAW_CONTROLS 16 // draw device controls helpers
187 #define VTKIS_MENU 17 // invoke an application menu
188 #define VTKIS_GESTURE 18 // touch interaction in progress
189 #define VTKIS_ENV_ROTATE 19 // rotate the renderer environment texture
190 #define VTKIS_GROUNDMOVEMENT 20 // horizontal movement according to the 4 directions
191 #define VTKIS_ELEVATION 21 // vertical movement (up and down)
192 
193 #define VTKIS_ANIM_OFF 0
194 #define VTKIS_ANIM_ON 1
195 
196 class vtkActor2D;
197 class vtkActor;
198 class vtkCallbackCommand;
199 class vtkEventData;
201 class vtkOutlineSource;
202 class vtkPolyDataMapper;
203 class vtkProp3D;
204 class vtkProp;
205 class vtkStringArray;
207 
208 class VTKRENDERINGCORE_EXPORT vtkInteractorStyle : public vtkInteractorObserver
209 {
210 public:
217 
219  void PrintSelf(ostream& os, vtkIndent indent) override;
220 
225  void SetInteractor(vtkRenderWindowInteractor* interactor) override;
226 
234  void SetEnabled(int) override;
235 
237 
245  vtkSetClampMacro(AutoAdjustCameraClippingRange, vtkTypeBool, 0, 1);
246  vtkGetMacro(AutoAdjustCameraClippingRange, vtkTypeBool);
247  vtkBooleanMacro(AutoAdjustCameraClippingRange, vtkTypeBool);
249 
255  void FindPokedRenderer(int, int);
256 
258 
261  vtkGetMacro(State, int);
263 
265 
268  vtkGetMacro(UseTimers, vtkTypeBool);
269  vtkSetMacro(UseTimers, vtkTypeBool);
270  vtkBooleanMacro(UseTimers, vtkTypeBool);
272 
274 
280  vtkSetClampMacro(TimerDuration, unsigned long, 1, 100000);
281  vtkGetMacro(TimerDuration, unsigned long);
283 
285 
288  vtkSetMacro(HandleObservers, vtkTypeBool);
289  vtkGetMacro(HandleObservers, vtkTypeBool);
290  vtkBooleanMacro(HandleObservers, vtkTypeBool);
292 
296  virtual void OnMouseMove() {}
297  virtual void OnLeftButtonDown() {}
298  virtual void OnLeftButtonUp() {}
299  virtual void OnMiddleButtonDown() {}
300  virtual void OnMiddleButtonUp() {}
301  virtual void OnRightButtonDown() {}
302  virtual void OnRightButtonUp() {}
303  virtual void OnLeftButtonDoubleClick() {}
304  virtual void OnMiddleButtonDoubleClick() {}
305  virtual void OnRightButtonDoubleClick() {}
306  virtual void OnMouseWheelForward() {}
307  virtual void OnMouseWheelBackward() {}
308  virtual void OnMouseWheelLeft() {}
309  virtual void OnMouseWheelRight() {}
310  virtual void OnFourthButtonDown() {}
311  virtual void OnFourthButtonUp() {}
312  virtual void OnFifthButtonDown() {}
313  virtual void OnFifthButtonUp() {}
314 
318  virtual void OnMove3D(vtkEventData*) {}
319  virtual void OnButton3D(vtkEventData*) {}
320  virtual void OnPick3D(vtkEventData*) {}
321  virtual void OnClip3D(vtkEventData*) {}
322  virtual void OnSelect3D(vtkEventData*) {}
323  virtual void OnMenu3D(vtkEventData*) {}
324  virtual void OnNextPose3D(vtkEventData*) {}
325  virtual void OnPositionProp3D(vtkEventData*) {}
327  virtual void OnElevation3D(vtkEventData*) {}
328 
333  void OnChar() override;
334 
335  // OnKeyDown is triggered by pressing any key (identical to OnKeyPress()).
336  // An empty implementation is provided. The behavior of this function should
337  // be specified in the subclass.
338  virtual void OnKeyDown() {}
339 
340  // OnKeyUp is triggered by releaseing any key (identical to OnKeyRelease()).
341  // An empty implementation is provided. The behavior of this function should
342  // be specified in the subclass.
343  virtual void OnKeyUp() {}
344 
345  // OnKeyPress is triggered by pressing any key (identical to OnKeyDown()).
346  // An empty implementation is provided. The behavior of this function should
347  // be specified in the subclass.
348  virtual void OnKeyPress() {}
349 
350  // OnKeyRelease is triggered by pressing any key (identical to OnKeyUp()).
351  // An empty implementation is provided. The behavior of this function should
352  // be specified in the subclass.
353  virtual void OnKeyRelease() {}
354 
358  virtual void OnExpose() {}
359  virtual void OnConfigure() {}
360  virtual void OnEnter() {}
361  virtual void OnLeave() {}
362 
367  virtual void OnTimer();
368 
375  virtual void Rotate() {}
376  virtual void Spin() {}
377  virtual void Pan() {}
378  virtual void Dolly() {}
379  virtual void Zoom() {}
380  virtual void UniformScale() {}
381  virtual void EnvironmentRotate() {}
382 
386  virtual void OnStartSwipe() {}
387  virtual void OnSwipe() {}
388  virtual void OnEndSwipe() {}
389  virtual void OnStartPinch() {}
390  virtual void OnPinch() {}
391  virtual void OnEndPinch() {}
392  virtual void OnStartRotate() {}
393  virtual void OnRotate() {}
394  virtual void OnEndRotate() {}
395  virtual void OnStartPan() {}
396  virtual void OnPan() {}
397  virtual void OnEndPan() {}
398  virtual void OnTap() {}
399  virtual void OnLongTap() {}
400 
402 
405  virtual void StartState(int newstate);
406  virtual void StopState();
408 
410 
413  virtual void StartAnimate();
414  virtual void StopAnimate();
415  virtual void StartRotate();
416  virtual void EndRotate();
417  virtual void StartZoom();
418  virtual void EndZoom();
419  virtual void StartPan();
420  virtual void EndPan();
421  virtual void StartSpin();
422  virtual void EndSpin();
423  virtual void StartDolly();
424  virtual void EndDolly();
425  virtual void StartUniformScale();
426  virtual void EndUniformScale();
427  virtual void StartTimer();
428  virtual void EndTimer();
429  virtual void StartTwoPointer();
430  virtual void EndTwoPointer();
431  virtual void StartGesture();
432  virtual void EndGesture();
433  virtual void StartEnvRotate();
434  virtual void EndEnvRotate();
436 
443  virtual void OnDropLocation(double* vtkNotUsed(position)) {}
444 
450  virtual void OnDropFiles(vtkStringArray* vtkNotUsed(filePaths)) {}
451 
453 
459  virtual void HighlightProp(vtkProp* prop);
460  virtual void HighlightActor2D(vtkActor2D* actor2D);
461  virtual void HighlightProp3D(vtkProp3D* prop3D);
463 
465 
469  vtkSetVector3Macro(PickColor, double);
470  vtkGetVectorMacro(PickColor, double, 3);
472 
474 
479  vtkSetMacro(MouseWheelMotionFactor, double);
480  vtkGetMacro(MouseWheelMotionFactor, double);
482 
484 
488  vtkGetObjectMacro(TDxStyle, vtkTDxInteractorStyle);
489  virtual void SetTDxStyle(vtkTDxInteractorStyle* tdxStyle);
491 
495  void DelegateTDxEvent(unsigned long event, void* calldata);
496 
497 protected:
500 
504  static void ProcessEvents(
505  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
506 
507  // Keep track of current state
508  int State;
510 
511  // Should observers be handled here, should we fire timers
514  int TimerId; // keep track of the timers that are created/destroyed
515 
517 
518  // For picking and highlighting props
525  int PropPicked; // bool: prop picked?
526  double PickColor[3]; // support 2D picking
528 
529  // Control the timer duration
530  unsigned long TimerDuration; // in milliseconds
531 
532  // Forward events to the RenderWindowInteractor
534 
536 
537 private:
538  vtkInteractorStyle(const vtkInteractorStyle&) = delete;
539  void operator=(const vtkInteractorStyle&) = delete;
540 };
541 
542 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:155
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:161
supports function callbacks
a simple event forwarder command
a simple class to control print indentation
Definition: vtkIndent.h:119
an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor
provide event-driven interface to the rendering window (defines trackball mode)
virtual void StopAnimate()
Interaction mode entry points used internally.
vtkPolyDataMapper * OutlineMapper
virtual void OnFifthButtonUp()
virtual void OnMove3D(vtkEventData *)
Generic 3D event bindings can be overridden in subclasses.
virtual void OnMouseWheelBackward()
virtual void OnLeftButtonDoubleClick()
virtual void OnMiddleButtonDown()
virtual void OnLongTap()
virtual void OnEnter()
void SetEnabled(int) override
Turn on/off this interactor.
virtual void StartEnvRotate()
Interaction mode entry points used internally.
virtual void HighlightProp(vtkProp *prop)
When picking successfully selects an actor, this method highlights the picked prop appropriately.
virtual void EndUniformScale()
Interaction mode entry points used internally.
virtual void OnStartSwipe()
gesture based events
virtual void StartPan()
Interaction mode entry points used internally.
vtkEventForwarderCommand * EventForwarder
virtual void StartTimer()
Interaction mode entry points used internally.
virtual void OnRightButtonDown()
virtual void OnDropLocation(double *vtkNotUsed(position))
When the mouse location is updated while dragging files.
virtual void Rotate()
These methods for the different interactions in different modes are overridden in subclasses to perfo...
void DelegateTDxEvent(unsigned long event, void *calldata)
Called by the callback to process 3DConnexion device events.
virtual void EndDolly()
Interaction mode entry points used internally.
virtual void OnKeyPress()
virtual void OnEndPan()
virtual void HighlightProp3D(vtkProp3D *prop3D)
When picking successfully selects an actor, this method highlights the picked prop appropriately.
virtual void UniformScale()
virtual void OnExpose()
These are more esoteric events, but are useful in some cases.
virtual void OnRightButtonUp()
virtual void OnStartPinch()
virtual void StartGesture()
Interaction mode entry points used internally.
virtual void OnKeyUp()
virtual void OnEndPinch()
virtual void OnKeyDown()
virtual void OnStartRotate()
virtual void OnMouseWheelRight()
virtual void OnConfigure()
virtual void OnPinch()
virtual void OnLeftButtonDown()
virtual void EndPan()
Interaction mode entry points used internally.
unsigned long TimerDuration
virtual void OnRotate()
virtual void OnMouseWheelForward()
virtual void OnDropFiles(vtkStringArray *vtkNotUsed(filePaths))
When files are dropped on the render window.
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Main process event method.
virtual void OnFourthButtonUp()
virtual void HighlightActor2D(vtkActor2D *actor2D)
When picking successfully selects an actor, this method highlights the picked prop appropriately.
virtual void OnMiddleButtonUp()
virtual void EndGesture()
Interaction mode entry points used internally.
void SetInteractor(vtkRenderWindowInteractor *interactor) override
Set/Get the Interactor wrapper being controlled by this object.
virtual void OnMenu3D(vtkEventData *)
virtual void StartState(int newstate)
utility routines used by state changes
virtual void OnPick3D(vtkEventData *)
virtual void EnvironmentRotate()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void OnElevation3D(vtkEventData *)
virtual void OnRightButtonDoubleClick()
virtual void OnFifthButtonDown()
virtual void EndTwoPointer()
Interaction mode entry points used internally.
virtual void OnTimer()
OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses.
virtual void OnLeave()
virtual void OnPositionProp3D(vtkEventData *)
virtual void StartUniformScale()
Interaction mode entry points used internally.
static vtkInteractorStyle * New()
This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.
virtual void OnStartPan()
vtkOutlineSource * Outline
virtual void SetTDxStyle(vtkTDxInteractorStyle *tdxStyle)
3Dconnexion device interactor style.
virtual void OnEndSwipe()
virtual void OnViewerMovement3D(vtkEventData *)
vtkRenderer * PickedRenderer
virtual void OnEndRotate()
virtual void OnClip3D(vtkEventData *)
virtual void StartZoom()
Interaction mode entry points used internally.
virtual void OnMouseWheelLeft()
virtual void StartSpin()
Interaction mode entry points used internally.
virtual void OnMouseMove()
Generic event bindings can be overridden in subclasses.
virtual void EndEnvRotate()
Interaction mode entry points used internally.
virtual void OnKeyRelease()
void FindPokedRenderer(int, int)
When an event occurs, we must determine which Renderer the event occurred within, since one RenderWin...
virtual void StopState()
utility routines used by state changes
virtual void EndSpin()
Interaction mode entry points used internally.
virtual void EndTimer()
Interaction mode entry points used internally.
virtual void EndZoom()
Interaction mode entry points used internally.
virtual void OnLeftButtonUp()
virtual void OnNextPose3D(vtkEventData *)
virtual void StartTwoPointer()
Interaction mode entry points used internally.
virtual void OnButton3D(vtkEventData *)
vtkActor2D * PickedActor2D
virtual void StartDolly()
Interaction mode entry points used internally.
~vtkInteractorStyle() override
virtual void OnSwipe()
virtual void StartRotate()
Interaction mode entry points used internally.
virtual void StartAnimate()
Interaction mode entry points used internally.
virtual void OnMiddleButtonDoubleClick()
virtual void OnSelect3D(vtkEventData *)
vtkTDxInteractorStyle * TDxStyle
virtual void OnFourthButtonDown()
void OnChar() override
OnChar is triggered when an ASCII key is pressed.
virtual void EndRotate()
Interaction mode entry points used internally.
vtkTypeBool AutoAdjustCameraClippingRange
abstract base class for most VTK objects
Definition: vtkObject.h:82
create wireframe outline around bounding box
map vtkPolyData to graphics primitives
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:99
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:76
platform-independent render window interaction including picking and frame rate control.
abstract specification for renderers
Definition: vtkRenderer.h:182
a vtkAbstractArray subclass for strings
provide 3DConnexion device event-driven interface to the rendering window
@ position
Definition: vtkX3D.h:267
int vtkTypeBool
Definition: vtkABI.h:69