VTK  9.1.0
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
34#ifndef vtkContextMouseEvent_h
35#define vtkContextMouseEvent_h
36
37#include "vtkRenderingContext2DModule.h" // For export macro
38#include "vtkVector.h" // Needed for vtkVector2f and vtkVector2i
39#include "vtkWin32Header.h" // For export macros.
40
42
43class VTKRENDERINGCONTEXT2D_EXPORT vtkContextMouseEvent
44{
45public:
49 enum
50 {
51 NO_BUTTON = 0,
52 LEFT_BUTTON = 1,
53 MIDDLE_BUTTON = 2,
54 RIGHT_BUTTON = 4
55 };
56
60 enum
61 {
62 NO_MODIFIER = 0,
63 ALT_MODIFIER = 1,
64 SHIFT_MODIFIER = 2,
65 CONTROL_MODIFIER = 4
66 };
67
69
73 void SetInteractor(vtkRenderWindowInteractor* interactor) { this->Interactor = interactor; }
74
79 vtkRenderWindowInteractor* GetInteractor() const { return this->Interactor; }
80
84 void SetPos(const vtkVector2f& pos) { this->Pos = pos; }
85 vtkVector2f GetPos() const { return this->Pos; }
86
90 void SetScenePos(const vtkVector2f& pos) { this->ScenePos = pos; }
91 vtkVector2f GetScenePos() const { return this->ScenePos; }
92
96 void SetScreenPos(const vtkVector2i& pos) { this->ScreenPos = pos; }
97 vtkVector2i GetScreenPos() const { return this->ScreenPos; }
98
102 void SetLastPos(const vtkVector2f& pos) { this->LastPos = pos; }
103 vtkVector2f GetLastPos() const { return this->LastPos; }
104
108 void SetLastScenePos(const vtkVector2f& pos) { this->LastScenePos = pos; }
109 vtkVector2f GetLastScenePos() const { return this->LastScenePos; }
110
114 void SetLastScreenPos(const vtkVector2i& pos) { this->LastScreenPos = pos; }
115 vtkVector2i GetLastScreenPos() const { return this->LastScreenPos; }
116
121 void SetButton(int button) { this->Button = button; }
122 int GetButton() const { return this->Button; }
123
128 int GetModifiers() const;
129
130protected:
135
140
145
150
155
160
165
166protected:
168};
169
170#endif // vtkContextMouseEvent_h
171// VTK-HeaderTest-Exclude: vtkContextMouseEvent.h
data structure to represent mouse events.
vtkVector2f LastPos
‘Pos’ at the previous mouse event.
vtkVector2f GetLastScenePos() const
int Button
Mouse button that caused the event, using the anonymous enumeration.
void SetButton(int button)
Set/get the mouse button that caused the event, with possible values being NO_BUTTON,...
void SetLastPos(const vtkVector2f &pos)
Set/get the position of the mouse in the item's coordinates.
vtkVector2f GetLastPos() const
void SetScenePos(const vtkVector2f &pos)
Set/get the position of the mouse in scene coordinates.
vtkVector2i GetLastScreenPos() const
vtkVector2f Pos
Position of the mouse in item coordinate system.
vtkRenderWindowInteractor * GetInteractor() const
Get the interactor for the mouse event.
vtkRenderWindowInteractor * Interactor
int GetModifiers() const
Return the modifier keys, if any, ORed together.
void SetLastScreenPos(const vtkVector2i &pos)
Set/get the position of the mouse in screen coordinates.
vtkVector2f GetScenePos() const
void SetPos(const vtkVector2f &pos)
Set/get the position of the mouse in the item's coordinates.
void SetLastScenePos(const vtkVector2f &pos)
Set/get the position of the mouse in scene coordinates.
void SetInteractor(vtkRenderWindowInteractor *interactor)
Set the interactor for the mouse event.
vtkVector2f ScenePos
Position of the mouse the scene coordinate system.
vtkContextMouseEvent()=default
void SetScreenPos(const vtkVector2i &pos)
Set/get the position of the mouse in screen coordinates.
vtkVector2i ScreenPos
Position of the mouse in screen coordinates.
vtkVector2i GetScreenPos() const
vtkVector2f GetPos() const
vtkVector2f LastScenePos
`ScenePos'at the previous mouse event.
vtkVector2i LastScreenPos
‘ScreenPos’ at the previous mouse event.
platform-independent render window interaction including picking and frame rate control.
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:428