VTK  9.2.6
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
31#ifndef vtkContextMouseEvent_h
32#define vtkContextMouseEvent_h
33
34#include "vtkRenderingContext2DModule.h" // For export macro
35#include "vtkVector.h" // Needed for vtkVector2f and vtkVector2i
36#include "vtkWin32Header.h" // For export macros.
37
39
40class VTKRENDERINGCONTEXT2D_EXPORT vtkContextMouseEvent
41{
42public:
46 enum
47 {
48 NO_BUTTON = 0,
49 LEFT_BUTTON = 1,
50 MIDDLE_BUTTON = 2,
51 RIGHT_BUTTON = 4
52 };
53
57 enum
58 {
59 NO_MODIFIER = 0,
60 ALT_MODIFIER = 1,
61 SHIFT_MODIFIER = 2,
62 CONTROL_MODIFIER = 4
63 };
64
66
70 void SetInteractor(vtkRenderWindowInteractor* interactor) { this->Interactor = interactor; }
71
76 vtkRenderWindowInteractor* GetInteractor() const { return this->Interactor; }
77
81 void SetPos(const vtkVector2f& pos) { this->Pos = pos; }
82 vtkVector2f GetPos() const { return this->Pos; }
83
87 void SetScenePos(const vtkVector2f& pos) { this->ScenePos = pos; }
88 vtkVector2f GetScenePos() const { return this->ScenePos; }
89
93 void SetScreenPos(const vtkVector2i& pos) { this->ScreenPos = pos; }
94 vtkVector2i GetScreenPos() const { return this->ScreenPos; }
95
99 void SetLastPos(const vtkVector2f& pos) { this->LastPos = pos; }
100 vtkVector2f GetLastPos() const { return this->LastPos; }
101
105 void SetLastScenePos(const vtkVector2f& pos) { this->LastScenePos = pos; }
106 vtkVector2f GetLastScenePos() const { return this->LastScenePos; }
107
111 void SetLastScreenPos(const vtkVector2i& pos) { this->LastScreenPos = pos; }
112 vtkVector2i GetLastScreenPos() const { return this->LastScreenPos; }
113
118 void SetButton(int button) { this->Button = button; }
119 int GetButton() const { return this->Button; }
120
125 int GetModifiers() const;
126
127protected:
132
137
142
147
152
157
162
163protected:
165};
166
167#endif // vtkContextMouseEvent_h
168// 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:422