VTK  9.0.1
vtkContextMouseEvent.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkContextMouseEvent.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 =========================================================================*/
15 
25 #ifndef vtkContextMouseEvent_h
26 #define vtkContextMouseEvent_h
27 
28 #include "vtkRenderingContext2DModule.h" // For export macro
29 #include "vtkVector.h" // Needed for vtkVector2f and vtkVector2i
30 #include "vtkWin32Header.h" // For export macros.
31 
33 
34 class VTKRENDERINGCONTEXT2D_EXPORT vtkContextMouseEvent
35 {
36 public:
40  enum
41  {
42  NO_BUTTON = 0,
43  LEFT_BUTTON = 1,
44  MIDDLE_BUTTON = 2,
45  RIGHT_BUTTON = 4
46  };
47 
51  enum
52  {
53  NO_MODIFIER = 0,
54  ALT_MODIFIER = 1,
55  SHIFT_MODIFIER = 2,
56  CONTROL_MODIFIER = 4
57  };
58 
60 
64  void SetInteractor(vtkRenderWindowInteractor* interactor) { this->Interactor = interactor; }
65 
70  vtkRenderWindowInteractor* GetInteractor() const { return this->Interactor; }
71 
75  void SetPos(const vtkVector2f& pos) { this->Pos = pos; }
76  vtkVector2f GetPos() const { return this->Pos; }
77 
81  void SetScenePos(const vtkVector2f& pos) { this->ScenePos = pos; }
82  vtkVector2f GetScenePos() const { return this->ScenePos; }
83 
87  void SetScreenPos(const vtkVector2i& pos) { this->ScreenPos = pos; }
88  vtkVector2i GetScreenPos() const { return this->ScreenPos; }
89 
93  void SetLastPos(const vtkVector2f& pos) { this->LastPos = pos; }
94  vtkVector2f GetLastPos() const { return this->LastPos; }
95 
99  void SetLastScenePos(const vtkVector2f& pos) { this->LastScenePos = pos; }
100  vtkVector2f GetLastScenePos() const { return this->LastScenePos; }
101 
105  void SetLastScreenPos(const vtkVector2i& pos) { this->LastScreenPos = pos; }
106  vtkVector2i GetLastScreenPos() const { return this->LastScreenPos; }
107 
112  void SetButton(int button) { this->Button = button; }
113  int GetButton() const { return this->Button; }
114 
119  int GetModifiers() const;
120 
121 protected:
126 
131 
136 
141 
146 
151 
155  int Button;
156 
157 protected:
159 };
160 
161 #endif // vtkContextMouseEvent_h
162 // VTK-HeaderTest-Exclude: vtkContextMouseEvent.h
vtkContextMouseEvent
data structure to represent mouse events.
Definition: vtkContextMouseEvent.h:34
vtkContextMouseEvent::ScreenPos
vtkVector2i ScreenPos
Position of the mouse in screen coordinates.
Definition: vtkContextMouseEvent.h:135
vtkContextMouseEvent::Pos
vtkVector2f Pos
Position of the mouse in item coordinate system.
Definition: vtkContextMouseEvent.h:125
vtkContextMouseEvent::SetLastScenePos
void SetLastScenePos(const vtkVector2f &pos)
Set/get the position of the mouse in scene coordinates.
Definition: vtkContextMouseEvent.h:99
vtkVector.h
vtkContextMouseEvent::SetLastScreenPos
void SetLastScreenPos(const vtkVector2i &pos)
Set/get the position of the mouse in screen coordinates.
Definition: vtkContextMouseEvent.h:105
vtkContextMouseEvent::GetButton
int GetButton() const
Definition: vtkContextMouseEvent.h:113
vtkContextMouseEvent::SetScreenPos
void SetScreenPos(const vtkVector2i &pos)
Set/get the position of the mouse in screen coordinates.
Definition: vtkContextMouseEvent.h:87
vtkContextMouseEvent::LastScreenPos
vtkVector2i LastScreenPos
‘ScreenPos’ at the previous mouse event.
Definition: vtkContextMouseEvent.h:150
vtkContextMouseEvent::GetScreenPos
vtkVector2i GetScreenPos() const
Definition: vtkContextMouseEvent.h:88
vtkContextMouseEvent::LastScenePos
vtkVector2f LastScenePos
`ScenePos'at the previous mouse event.
Definition: vtkContextMouseEvent.h:145
vtkContextMouseEvent::SetLastPos
void SetLastPos(const vtkVector2f &pos)
Set/get the position of the mouse in the item's coordinates.
Definition: vtkContextMouseEvent.h:93
vtkContextMouseEvent::SetPos
void SetPos(const vtkVector2f &pos)
Set/get the position of the mouse in the item's coordinates.
Definition: vtkContextMouseEvent.h:75
vtkContextMouseEvent::GetScenePos
vtkVector2f GetScenePos() const
Definition: vtkContextMouseEvent.h:82
vtkContextMouseEvent::SetInteractor
void SetInteractor(vtkRenderWindowInteractor *interactor)
Set the interactor for the mouse event.
Definition: vtkContextMouseEvent.h:64
vtkContextMouseEvent::GetPos
vtkVector2f GetPos() const
Definition: vtkContextMouseEvent.h:76
vtkContextMouseEvent::SetButton
void SetButton(int button)
Set/get the mouse button that caused the event, with possible values being NO_BUTTON,...
Definition: vtkContextMouseEvent.h:112
vtkContextMouseEvent::GetLastPos
vtkVector2f GetLastPos() const
Definition: vtkContextMouseEvent.h:94
vtkRenderWindowInteractor
platform-independent render window interaction including picking and frame rate control.
Definition: vtkRenderWindowInteractor.h:82
vtkContextMouseEvent::ScenePos
vtkVector2f ScenePos
Position of the mouse the scene coordinate system.
Definition: vtkContextMouseEvent.h:130
vtkContextMouseEvent::GetLastScenePos
vtkVector2f GetLastScenePos() const
Definition: vtkContextMouseEvent.h:100
vtkContextMouseEvent::vtkContextMouseEvent
vtkContextMouseEvent()
Definition: vtkContextMouseEvent.h:59
vtkWin32Header.h
vtkContextMouseEvent::GetInteractor
vtkRenderWindowInteractor * GetInteractor() const
Get the interactor for the mouse event.
Definition: vtkContextMouseEvent.h:70
vtkContextMouseEvent::GetLastScreenPos
vtkVector2i GetLastScreenPos() const
Definition: vtkContextMouseEvent.h:106
vtkContextMouseEvent::Button
int Button
Mouse button that caused the event, using the anonymous enumeration.
Definition: vtkContextMouseEvent.h:155
vtkVector2i
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:419
vtkContextMouseEvent::LastPos
vtkVector2f LastPos
‘Pos’ at the previous mouse event.
Definition: vtkContextMouseEvent.h:140
vtkVector2f
Definition: vtkVector.h:432
vtkContextMouseEvent::SetScenePos
void SetScenePos(const vtkVector2f &pos)
Set/get the position of the mouse in scene coordinates.
Definition: vtkContextMouseEvent.h:81
vtkContextMouseEvent::Interactor
vtkRenderWindowInteractor * Interactor
Definition: vtkContextMouseEvent.h:158