forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkHandleWidget.h
198 lines (170 loc) · 6.28 KB
/
vtkHandleWidget.h
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/*=========================================================================
Program: Visualization Toolkit
Module: vtkHandleWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkHandleWidget
* @brief a general widget for moving handles
*
* The vtkHandleWidget is used to position a handle. A handle is a widget
* with a position (in display and world space). Various appearances are
* available depending on its associated representation. The widget provides
* methods for translation, including constrained translation along
* coordinate axes. To use this widget, create and associate a representation
* with the widget.
*
* @par Event Bindings:
* By default, the widget responds to the following VTK events (i.e., it
* watches the vtkRenderWindowInteractor for these events):
* <pre>
* LeftButtonPressEvent - select focal point of widget
* LeftButtonReleaseEvent - end selection
* MiddleButtonPressEvent - translate widget
* MiddleButtonReleaseEvent - end translation
* RightButtonPressEvent - scale widget
* RightButtonReleaseEvent - end scaling
* MouseMoveEvent - interactive movement across widget
* </pre>
*
* @par Event Bindings:
* Note that the event bindings described above can be changed using this
* class's vtkWidgetEventTranslator. This class translates VTK events
* into the vtkHandleWidget's widget events:
* <pre>
* vtkWidgetEvent::Select -- focal point is being selected
* vtkWidgetEvent::EndSelect -- the selection process has completed
* vtkWidgetEvent::Translate -- translate the widget
* vtkWidgetEvent::EndTranslate -- end widget translation
* vtkWidgetEvent::Scale -- scale the widget
* vtkWidgetEvent::EndScale -- end scaling the widget
* vtkWidgetEvent::Move -- a request for widget motion
* </pre>
*
* @par Event Bindings:
* In turn, when these widget events are processed, the vtkHandleWidget
* invokes the following VTK events on itself (which observers can listen for):
* <pre>
* vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
* vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
* vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
* </pre>
*
*/
#ifndef vtkHandleWidget_h
#define vtkHandleWidget_h
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkAbstractWidget.h"
class vtkHandleRepresentation;
class VTKINTERACTIONWIDGETS_EXPORT vtkHandleWidget : public vtkAbstractWidget
{
public:
/**
* Instantiate this class.
*/
static vtkHandleWidget *New();
//@{
/**
* Standard VTK class macros.
*/
vtkTypeMacro(vtkHandleWidget,vtkAbstractWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
//@}
/**
* Specify an instance of vtkWidgetRepresentation used to represent this
* widget in the scene. Note that the representation is a subclass of vtkProp
* so it can be added to the renderer independent of the widget.
*/
void SetRepresentation(vtkHandleRepresentation *r)
{this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}
/**
* Return the representation as a vtkHandleRepresentation.
*/
vtkHandleRepresentation *GetHandleRepresentation()
{return reinterpret_cast<vtkHandleRepresentation*>(this->WidgetRep);}
/**
* Create the default widget representation if one is not set. By default
* an instance of vtkPointHandleRepresentation3D is created.
*/
void CreateDefaultRepresentation() override;
//@{
/**
* Enable / disable axis constrained motion of the handles. By default the
* widget responds to the shift modifier to constrain the handle along the
* axis closest aligned with the motion vector.
*/
vtkSetMacro( EnableAxisConstraint, vtkTypeBool );
vtkGetMacro( EnableAxisConstraint, vtkTypeBool );
vtkBooleanMacro( EnableAxisConstraint, vtkTypeBool );
//@}
//@{
/**
* Enable moving of handles. By default, the handle can be moved.
*/
vtkSetMacro(EnableTranslation, vtkTypeBool);
vtkGetMacro(EnableTranslation, vtkTypeBool);
vtkBooleanMacro(EnableTranslation, vtkTypeBool);
//@}
//@{
/**
* Allow resizing of handles ? By default the right mouse button scales
* the handle size.
*/
vtkSetMacro( AllowHandleResize, vtkTypeBool );
vtkGetMacro( AllowHandleResize, vtkTypeBool );
vtkBooleanMacro( AllowHandleResize, vtkTypeBool );
//@}
//@{
/**
* Get the widget state.
*/
vtkGetMacro( WidgetState, int );
//@}
//@{
/**
* Allow the widget to be visible as an inactive representation when disabled.
* By default, this is false i.e. the representation is not visible when the
* widget is disabled.
*/
vtkSetMacro( ShowInactive, vtkTypeBool );
vtkGetMacro( ShowInactive, vtkTypeBool );
vtkBooleanMacro( ShowInactive, vtkTypeBool );
//@}
// Manage the state of the widget
enum _WidgetState {Start=0,Active,Inactive};
/**
* Enable/disable widget.
* Custom override for the SetEnabled method to allow for the inactive state.
**/
void SetEnabled(int enabling) override;
protected:
vtkHandleWidget();
~vtkHandleWidget() override;
// These are the callbacks for this widget
static void GenericAction(vtkHandleWidget*);
static void SelectAction(vtkAbstractWidget*);
static void EndSelectAction(vtkAbstractWidget*);
static void TranslateAction(vtkAbstractWidget*);
static void ScaleAction(vtkAbstractWidget*);
static void MoveAction(vtkAbstractWidget*);
static void SelectAction3D(vtkAbstractWidget*);
static void MoveAction3D(vtkAbstractWidget*);
// helper methods for cursor management
void SetCursor(int state) override;
int WidgetState;
vtkTypeBool EnableAxisConstraint;
vtkTypeBool EnableTranslation;
// Allow resizing of handles.
vtkTypeBool AllowHandleResize;
// Keep representation visible when disabled
vtkTypeBool ShowInactive;
private:
vtkHandleWidget(const vtkHandleWidget&) = delete;
void operator=(const vtkHandleWidget&) = delete;
};
#endif