1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkInteractorStyleUser
* @brief provides customizable interaction routines
*
*
* The most common way to customize user interaction is to write a subclass
* of vtkInteractorStyle: vtkInteractorStyleUser allows you to customize
* the interaction to without subclassing vtkInteractorStyle. This is
* particularly useful for setting up custom interaction modes in
* scripting languages such as Python. This class allows you
* to hook into the MouseMove, ButtonPress/Release, KeyPress/Release,
* etc. events. If you want to hook into just a single mouse button,
* but leave the interaction modes for the others unchanged, you
* must use e.g. SetMiddleButtonPressMethod() instead of the more
* general SetButtonPressMethod().
*/
#ifndef vtkInteractorStyleUser_h
#define vtkInteractorStyleUser_h
#include "vtkInteractionStyleModule.h" // For export macro
#include "vtkInteractorStyle.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
// new motion flag
#define VTKIS_USERINTERACTION 8
VTK_ABI_NAMESPACE_BEGIN
class VTKINTERACTIONSTYLE_EXPORT VTK_MARSHALAUTO vtkInteractorStyleUser : public vtkInteractorStyle
{
public:
static vtkInteractorStyleUser* New();
vtkTypeMacro(vtkInteractorStyleUser, vtkInteractorStyle);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get the most recent mouse position during mouse motion.
* In your user interaction method, you must use this to track
* the mouse movement. Do not use GetEventPosition(), which records
* the last position where a mouse button was pressed.
*/
vtkGetVector2Macro(LastPos, int);
///@}
///@{
/**
* Get the previous mouse position during mouse motion, or after
* a key press. This can be used to calculate the relative
* displacement of the mouse.
*/
vtkGetVector2Macro(OldPos, int);
///@}
///@{
/**
* Test whether modifiers were held down when mouse button or key
* was pressed.
*/
vtkGetMacro(ShiftKey, int);
vtkGetMacro(CtrlKey, int);
///@}
///@{
/**
* Get the character for a Char event.
*/
vtkGetMacro(Char, int);
///@}
///@{
/**
* Get the KeySym (in the same format as vtkRenderWindowInteractor KeySyms)
* for a KeyPress or KeyRelease method.
*/
vtkGetStringMacro(KeySym);
///@}
///@{
/**
* Get the mouse button that was last pressed inside the window
* (returns zero when the button is released).
*/
vtkGetMacro(Button, int);
///@}
///@{
/**
* Generic event bindings
*/
void OnMouseMove() override;
void OnLeftButtonDown() override;
void OnLeftButtonUp() override;
void OnMiddleButtonDown() override;
void OnMiddleButtonUp() override;
void OnRightButtonDown() override;
void OnRightButtonUp() override;
void OnMouseWheelForward() override;
void OnMouseWheelBackward() override;
///@}
///@{
/**
* Keyboard functions
*/
void OnChar() override;
void OnKeyPress() override;
void OnKeyRelease() override;
///@}
///@{
/**
* These are more esoteric events, but are useful in some cases.
*/
void OnExpose() override;
void OnConfigure() override;
void OnEnter() override;
void OnLeave() override;
///@}
void OnTimer() override;
protected:
vtkInteractorStyleUser();
~vtkInteractorStyleUser() override;
int LastPos[2];
int OldPos[2];
int ShiftKey;
int CtrlKey;
int Char;
char* KeySym;
int Button;
private:
vtkInteractorStyleUser(const vtkInteractorStyleUser&) = delete;
void operator=(const vtkInteractorStyleUser&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|