forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkSeedWidget.h
223 lines (192 loc) · 6.86 KB
/
vtkSeedWidget.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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*=========================================================================
Program: Visualization Toolkit
Module: vtkSeedWidget.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 vtkSeedWidget
* @brief place multiple seed points
*
* The vtkSeedWidget is used to placed multiple seed points in the scene.
* The seed points can be used for operations like connectivity, segmentation,
* and region growing.
*
* To use this widget, specify an instance of vtkSeedWidget and a
* representation (a subclass of vtkSeedRepresentation). The widget is
* implemented using multiple instances of vtkHandleWidget which can be used
* to position the seed points (after they are initially placed). The
* representations for these handle widgets are provided by the
* vtkSeedRepresentation.
*
* @par Event Bindings:
* By default, the widget responds to the following VTK events (i.e., it
* watches the vtkRenderWindowInteractor for these events):
* <pre>
* LeftButtonPressEvent - add a point or select a handle (i.e., seed)
* RightButtonPressEvent - finish adding the seeds
* MouseMoveEvent - move a handle (i.e., seed)
* LeftButtonReleaseEvent - release the selected handle (seed)
* </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 vtkSeedWidget's widget events:
* <pre>
* vtkWidgetEvent::AddPoint -- add one point; depending on the state
* it may the first or second point added. Or,
* if near handle, select handle.
* vtkWidgetEvent::Completed -- finished adding seeds.
* vtkWidgetEvent::Move -- move the second point or handle depending on the state.
* vtkWidgetEvent::EndSelect -- the handle manipulation process has completed.
* </pre>
*
* @par Event Bindings:
* This widget invokes the following VTK events on itself (which observers
* can listen for):
* <pre>
* vtkCommand::StartInteractionEvent (beginning to interact)
* vtkCommand::EndInteractionEvent (completing interaction)
* vtkCommand::InteractionEvent (moving after selecting something)
* vtkCommand::PlacePointEvent (after point is positioned;
* call data includes handle id (0,1))
* vtkCommand::DeletePointEvent (before point is deleted;
* call data includes handle id (0,1))
* </pre>
*
* @sa
* vtkHandleWidget vtkSeedRepresentation
*/
#ifndef vtkSeedWidget_h
#define vtkSeedWidget_h
#include "vtkAbstractWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
class vtkHandleRepresentation;
class vtkHandleWidget;
class vtkSeedList;
class vtkSeedRepresentation;
class VTKINTERACTIONWIDGETS_EXPORT vtkSeedWidget : public vtkAbstractWidget
{
public:
/**
* Instantiate this class.
*/
static vtkSeedWidget* New();
///@{
/**
* Standard methods for a VTK class.
*/
vtkTypeMacro(vtkSeedWidget, vtkAbstractWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@}
/**
* The method for activating and deactivating this widget. This method
* must be overridden because it is a composite widget and does more than
* its superclasses' vtkAbstractWidget::SetEnabled() method.
*/
void SetEnabled(int) override;
/**
* Set the current renderer. This method also propagates to all the child
* handle widgets, if any exist
*/
void SetCurrentRenderer(vtkRenderer*) override;
/**
* Set the interactor. This method also propagates to all the child
* handle widgets, if any exist
*/
void SetInteractor(vtkRenderWindowInteractor*) 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(vtkSeedRepresentation* rep)
{
this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(rep));
}
/**
* Return the representation as a vtkSeedRepresentation.
*/
vtkSeedRepresentation* GetSeedRepresentation()
{
return reinterpret_cast<vtkSeedRepresentation*>(this->WidgetRep);
}
/**
* Create the default widget representation if one is not set.
*/
void CreateDefaultRepresentation() override;
/**
* Methods to change the whether the widget responds to interaction.
* Overridden to pass the state to component widgets.
*/
void SetProcessEvents(vtkTypeBool) override;
/**
* Method to be called when the seed widget should stop responding to
* the place point interaction. The seed widget, when defined allows you
* place seeds by clicking on the render window. Use this method to
* indicate that you would like to stop placing seeds interactively. If
* you'd like the widget to stop responding to *any* user interaction
* simply disable event processing by the widget by calling
* widget->ProcessEventsOff()
*/
virtual void CompleteInteraction();
/**
* Method to be called when the seed widget should start responding
* to the interaction.
*/
virtual void RestartInteraction();
/**
* Use this method to programmatically create a new handle. In interactive
* mode, (when the widget is in the PlacingSeeds state) this method is
* automatically invoked. The method returns the handle created.
* A valid seed representation must exist for the widget to create a new
* handle.
*/
virtual vtkHandleWidget* CreateNewHandle();
/**
* Delete the nth seed.
*/
void DeleteSeed(int n);
/**
* Get the nth seed
*/
vtkHandleWidget* GetSeed(int n);
///@{
/**
* Get the widget state.
*/
vtkGetMacro(WidgetState, int);
///@}
// The state of the widget
enum
{
Start = 1,
PlacingSeeds = 2,
PlacedSeeds = 4,
MovingSeed = 8
};
protected:
vtkSeedWidget();
~vtkSeedWidget() override;
int WidgetState;
// Callback interface to capture events when
// placing the widget.
static void AddPointAction(vtkAbstractWidget*);
static void CompletedAction(vtkAbstractWidget*);
static void MoveAction(vtkAbstractWidget*);
static void EndSelectAction(vtkAbstractWidget*);
static void DeleteAction(vtkAbstractWidget*);
// The positioning handle widgets
vtkSeedList* Seeds;
// Manipulating or defining ?
int Defining;
private:
vtkSeedWidget(const vtkSeedWidget&) = delete;
void operator=(const vtkSeedWidget&) = delete;
};
#endif