VTK
9.1.0
|
data structure to represent mouse events. More...
#include <vtkContextMouseEvent.h>
Public Types | |
enum | { NO_BUTTON = 0 , LEFT_BUTTON = 1 , MIDDLE_BUTTON = 2 , RIGHT_BUTTON = 4 } |
Enumeration of mouse buttons. More... | |
enum | { NO_MODIFIER = 0 , ALT_MODIFIER = 1 , SHIFT_MODIFIER = 2 , CONTROL_MODIFIER = 4 } |
Enumeration of modifier keys. More... | |
Public Member Functions | |
vtkContextMouseEvent ()=default | |
void | SetInteractor (vtkRenderWindowInteractor *interactor) |
Set the interactor for the mouse event. | |
vtkRenderWindowInteractor * | GetInteractor () const |
Get the interactor for the mouse event. | |
void | SetPos (const vtkVector2f &pos) |
Set/get the position of the mouse in the item's coordinates. | |
vtkVector2f | GetPos () const |
void | SetScenePos (const vtkVector2f &pos) |
Set/get the position of the mouse in scene coordinates. | |
vtkVector2f | GetScenePos () const |
void | SetScreenPos (const vtkVector2i &pos) |
Set/get the position of the mouse in screen coordinates. | |
vtkVector2i | GetScreenPos () const |
void | SetLastPos (const vtkVector2f &pos) |
Set/get the position of the mouse in the item's coordinates. | |
vtkVector2f | GetLastPos () const |
void | SetLastScenePos (const vtkVector2f &pos) |
Set/get the position of the mouse in scene coordinates. | |
vtkVector2f | GetLastScenePos () const |
void | SetLastScreenPos (const vtkVector2i &pos) |
Set/get the position of the mouse in screen coordinates. | |
vtkVector2i | GetLastScreenPos () const |
void | SetButton (int button) |
Set/get the mouse button that caused the event, with possible values being NO_BUTTON, LEFT_BUTTON, MIDDLE_BUTTON and RIGHT_BUTTON. | |
int | GetButton () const |
int | GetModifiers () const |
Return the modifier keys, if any, ORed together. | |
Protected Attributes | |
vtkVector2f | Pos |
Position of the mouse in item coordinate system. | |
vtkVector2f | ScenePos |
Position of the mouse the scene coordinate system. | |
vtkVector2i | ScreenPos |
Position of the mouse in screen coordinates. | |
vtkVector2f | LastPos |
‘Pos’ at the previous mouse event. | |
vtkVector2f | LastScenePos |
`ScenePos'at the previous mouse event. | |
vtkVector2i | LastScreenPos |
‘ScreenPos’ at the previous mouse event. | |
int | Button |
Mouse button that caused the event, using the anonymous enumeration. | |
vtkRenderWindowInteractor * | Interactor |
data structure to represent mouse events.
Provides a convenient data structure to represent mouse events in the vtkContextScene. Passed to vtkAbstractContextItem objects.
Definition at line 53 of file vtkContextMouseEvent.h.
anonymous enum |
Enumeration of mouse buttons.
Enumerator | |
---|---|
NO_BUTTON | |
LEFT_BUTTON | |
MIDDLE_BUTTON | |
RIGHT_BUTTON |
Definition at line 59 of file vtkContextMouseEvent.h.
anonymous enum |
Enumeration of modifier keys.
Enumerator | |
---|---|
NO_MODIFIER | |
ALT_MODIFIER | |
SHIFT_MODIFIER | |
CONTROL_MODIFIER |
Definition at line 70 of file vtkContextMouseEvent.h.
|
default |
|
inline |
Set the interactor for the mouse event.
Definition at line 83 of file vtkContextMouseEvent.h.
|
inline |
Get the interactor for the mouse event.
This can be null, and is provided only for convenience.
Definition at line 89 of file vtkContextMouseEvent.h.
|
inline |
Set/get the position of the mouse in the item's coordinates.
Definition at line 94 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 95 of file vtkContextMouseEvent.h.
|
inline |
Set/get the position of the mouse in scene coordinates.
Definition at line 100 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 101 of file vtkContextMouseEvent.h.
|
inline |
Set/get the position of the mouse in screen coordinates.
Definition at line 106 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 107 of file vtkContextMouseEvent.h.
|
inline |
Set/get the position of the mouse in the item's coordinates.
Definition at line 112 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 113 of file vtkContextMouseEvent.h.
|
inline |
Set/get the position of the mouse in scene coordinates.
Definition at line 118 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 119 of file vtkContextMouseEvent.h.
|
inline |
Set/get the position of the mouse in screen coordinates.
Definition at line 124 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 125 of file vtkContextMouseEvent.h.
|
inline |
Set/get the mouse button that caused the event, with possible values being NO_BUTTON, LEFT_BUTTON, MIDDLE_BUTTON and RIGHT_BUTTON.
Definition at line 131 of file vtkContextMouseEvent.h.
|
inline |
Definition at line 132 of file vtkContextMouseEvent.h.
int vtkContextMouseEvent::GetModifiers | ( | ) | const |
Return the modifier keys, if any, ORed together.
Valid modifier enum values are NO_MODIFIER, ALT_MODIFIER, SHIFT_MODIFIER and/or CONTROL_MODIFIER.
|
protected |
Position of the mouse in item coordinate system.
Definition at line 144 of file vtkContextMouseEvent.h.
|
protected |
Position of the mouse the scene coordinate system.
Definition at line 149 of file vtkContextMouseEvent.h.
|
protected |
Position of the mouse in screen coordinates.
Definition at line 154 of file vtkContextMouseEvent.h.
|
protected |
‘Pos’ at the previous mouse event.
Definition at line 159 of file vtkContextMouseEvent.h.
|
protected |
`ScenePos'at the previous mouse event.
Definition at line 164 of file vtkContextMouseEvent.h.
|
protected |
‘ScreenPos’ at the previous mouse event.
Definition at line 169 of file vtkContextMouseEvent.h.
|
protected |
Mouse button that caused the event, using the anonymous enumeration.
Definition at line 174 of file vtkContextMouseEvent.h.
|
protected |
Definition at line 177 of file vtkContextMouseEvent.h.