VTK
9.5.20251215
Interaction
Widgets
vtkDistanceWidget.h
Go to the documentation of this file.
1
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2
// SPDX-License-Identifier: BSD-3-Clause
84
85
#ifndef vtkDistanceWidget_h
86
#define vtkDistanceWidget_h
87
88
#include "
vtkAbstractWidget.h
"
89
#include "vtkInteractionWidgetsModule.h"
// For export macro
90
#include "
vtkWrappingHints.h
"
// For VTK_MARSHALAUTO
91
92
VTK_ABI_NAMESPACE_BEGIN
93
class
vtkDistanceRepresentation
;
94
class
vtkHandleWidget
;
95
class
vtkDistanceWidgetCallback;
96
97
class
VTKINTERACTIONWIDGETS_EXPORT
VTK_MARSHALAUTO
vtkDistanceWidget
:
public
vtkAbstractWidget
98
{
99
public
:
103
static
vtkDistanceWidget
*
New
();
104
106
109
vtkTypeMacro(
vtkDistanceWidget
,
vtkAbstractWidget
);
110
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
112
118
void
SetEnabled
(
int
)
override
;
119
125
void
SetRepresentation
(
vtkDistanceRepresentation
* r)
126
{
127
this->
Superclass::SetWidgetRepresentation
(
reinterpret_cast<
vtkWidgetRepresentation
*
>
(r));
128
}
129
133
vtkDistanceRepresentation
*
GetDistanceRepresentation
()
134
{
135
return
reinterpret_cast<
vtkDistanceRepresentation
*
>
(this->
WidgetRep
);
136
}
137
141
void
CreateDefaultRepresentation
()
override
;
142
147
void
SetProcessEvents
(
vtkTypeBool
)
override
;
148
155
156
enum
157
{
158
Start
= 0,
159
Define
,
160
Manipulate
161
};
162
164
174
virtual
void
SetWidgetStateToStart
();
175
virtual
void
SetWidgetStateToManipulate
();
177
181
virtual
int
GetWidgetState
() {
return
this->
WidgetState
; }
182
183
protected
:
184
vtkDistanceWidget
();
185
~vtkDistanceWidget
()
override
;
186
187
// The state of the widget
188
int
WidgetState
;
189
int
CurrentHandle
;
190
191
// Callback interface to capture events when
192
// placing the widget.
193
static
void
AddPointAction
(
vtkAbstractWidget
*);
194
static
void
MoveAction
(
vtkAbstractWidget
*);
195
static
void
EndSelectAction
(
vtkAbstractWidget
*);
196
static
void
AddPointAction3D
(
vtkAbstractWidget
*);
197
static
void
MoveAction3D
(
vtkAbstractWidget
*);
198
static
void
EndSelectAction3D
(
vtkAbstractWidget
*);
199
200
// The positioning handle widgets
201
vtkHandleWidget
*
Point1Widget
;
202
vtkHandleWidget
*
Point2Widget
;
203
vtkDistanceWidgetCallback
*
DistanceWidgetCallback1
;
204
vtkDistanceWidgetCallback
*
DistanceWidgetCallback2
;
205
206
// Methods invoked when the handles at the
207
// end points of the widget are manipulated
208
void
StartDistanceInteraction
(
int
handleNum);
209
void
DistanceInteraction
(
int
handleNum);
210
void
EndDistanceInteraction
(
int
handleNum);
211
212
friend
class
vtkDistanceWidgetCallback
;
213
214
private
:
215
vtkDistanceWidget
(
const
vtkDistanceWidget
&) =
delete
;
216
void
operator=(
const
vtkDistanceWidget
&) =
delete
;
217
};
218
219
VTK_ABI_NAMESPACE_END
220
#endif
vtkAbstractWidget::vtkAbstractWidget
vtkAbstractWidget()
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition
vtkAbstractWidget.h:200
vtkDistanceRepresentation
represent the vtkDistanceWidget
Definition
vtkDistanceRepresentation.h:46
vtkDistanceWidget::vtkDistanceWidgetCallback
friend class vtkDistanceWidgetCallback
Definition
vtkDistanceWidget.h:212
vtkDistanceWidget::SetWidgetStateToStart
virtual void SetWidgetStateToStart()
Set the state of the widget.
vtkDistanceWidget::GetWidgetState
virtual int GetWidgetState()
Return the current widget state.
Definition
vtkDistanceWidget.h:181
vtkDistanceWidget::MoveAction3D
static void MoveAction3D(vtkAbstractWidget *)
vtkDistanceWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
vtkDistanceWidget::CurrentHandle
int CurrentHandle
Definition
vtkDistanceWidget.h:189
vtkDistanceWidget::SetWidgetStateToManipulate
virtual void SetWidgetStateToManipulate()
Set the state of the widget.
vtkDistanceWidget::GetDistanceRepresentation
vtkDistanceRepresentation * GetDistanceRepresentation()
Return the representation as a vtkDistanceRepresentation.
Definition
vtkDistanceWidget.h:133
vtkDistanceWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkDistanceWidget::SetRepresentation
void SetRepresentation(vtkDistanceRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition
vtkDistanceWidget.h:125
vtkDistanceWidget::EndDistanceInteraction
void EndDistanceInteraction(int handleNum)
vtkDistanceWidget::vtkDistanceWidget
vtkDistanceWidget()
vtkDistanceWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkDistanceWidget::Start
@ Start
Definition
vtkDistanceWidget.h:158
vtkDistanceWidget::Define
@ Define
Definition
vtkDistanceWidget.h:159
vtkDistanceWidget::Manipulate
@ Manipulate
Definition
vtkDistanceWidget.h:160
vtkDistanceWidget::AddPointAction3D
static void AddPointAction3D(vtkAbstractWidget *)
vtkDistanceWidget::~vtkDistanceWidget
~vtkDistanceWidget() override
vtkDistanceWidget::Point2Widget
vtkHandleWidget * Point2Widget
Definition
vtkDistanceWidget.h:202
vtkDistanceWidget::StartDistanceInteraction
void StartDistanceInteraction(int handleNum)
vtkDistanceWidget::Point1Widget
vtkHandleWidget * Point1Widget
Definition
vtkDistanceWidget.h:201
vtkDistanceWidget::DistanceWidgetCallback1
vtkDistanceWidgetCallback * DistanceWidgetCallback1
Definition
vtkDistanceWidget.h:203
vtkDistanceWidget::DistanceInteraction
void DistanceInteraction(int handleNum)
vtkDistanceWidget::DistanceWidgetCallback2
vtkDistanceWidgetCallback * DistanceWidgetCallback2
Definition
vtkDistanceWidget.h:204
vtkDistanceWidget::New
static vtkDistanceWidget * New()
Instantiate this class.
vtkDistanceWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkDistanceWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkDistanceWidget::SetProcessEvents
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
vtkDistanceWidget::AddPointAction
static void AddPointAction(vtkAbstractWidget *)
vtkDistanceWidget::WidgetState
int WidgetState
Definition
vtkDistanceWidget.h:188
vtkDistanceWidget::EndSelectAction3D
static void EndSelectAction3D(vtkAbstractWidget *)
vtkHandleWidget
a general widget for moving handles
Definition
vtkHandleWidget.h:69
vtkIndent
a simple class to control print indentation
Definition
vtkIndent.h:108
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition
vtkWidgetRepresentation.h:68
vtkTypeBool
int vtkTypeBool
Definition
vtkABI.h:64
vtkAbstractWidget.h
vtkWrappingHints.h
VTK_MARSHALAUTO
#define VTK_MARSHALAUTO
Definition
vtkWrappingHints.h:60
Generated on Mon Dec 15 2025 07:51:17 for VTK by
1.13.2