VTK  9.3.0
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
66#ifndef vtkDistanceWidget_h
67#define vtkDistanceWidget_h
68
69#include "vtkAbstractWidget.h"
70#include "vtkInteractionWidgetsModule.h" // For export macro
71
72VTK_ABI_NAMESPACE_BEGIN
74class vtkHandleWidget;
75class vtkDistanceWidgetCallback;
76
77class VTKINTERACTIONWIDGETS_EXPORT vtkDistanceWidget : public vtkAbstractWidget
78{
79public:
84
86
90 void PrintSelf(ostream& os, vtkIndent indent) override;
92
98 void SetEnabled(int) override;
99
106 {
107 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
108 }
109
117
122
128
136 enum
137 {
138 Start = 0,
140 Manipulate
141 };
142
144
154 virtual void SetWidgetStateToStart();
157
161 virtual int GetWidgetState() { return this->WidgetState; }
162
163protected:
166
167 // The state of the widget
170
171 // Callback interface to capture events when
172 // placing the widget.
179
180 // The positioning handle widgets
183 vtkDistanceWidgetCallback* DistanceWidgetCallback1;
184 vtkDistanceWidgetCallback* DistanceWidgetCallback2;
185
186 // Methods invoked when the handles at the
187 // end points of the widget are manipulated
188 void StartDistanceInteraction(int handleNum);
189 void DistanceInteraction(int handleNum);
190 void EndDistanceInteraction(int handleNum);
191
192 friend class vtkDistanceWidgetCallback;
193
194private:
195 vtkDistanceWidget(const vtkDistanceWidget&) = delete;
196 void operator=(const vtkDistanceWidget&) = delete;
197};
198
199VTK_ABI_NAMESPACE_END
200#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
represent the vtkDistanceWidget
measure the distance between two points
virtual void SetWidgetStateToStart()
Set the state of the widget.
virtual int GetWidgetState()
Return the current widget state.
static void MoveAction3D(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
virtual void SetWidgetStateToManipulate()
Set the state of the widget.
vtkDistanceRepresentation * GetDistanceRepresentation()
Return the representation as a vtkDistanceRepresentation.
static void EndSelectAction(vtkAbstractWidget *)
void SetRepresentation(vtkDistanceRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void EndDistanceInteraction(int handleNum)
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void AddPointAction3D(vtkAbstractWidget *)
~vtkDistanceWidget() override
vtkHandleWidget * Point2Widget
void StartDistanceInteraction(int handleNum)
vtkHandleWidget * Point1Widget
vtkDistanceWidgetCallback * DistanceWidgetCallback1
void DistanceInteraction(int handleNum)
vtkDistanceWidgetCallback * DistanceWidgetCallback2
static vtkDistanceWidget * New()
Instantiate this class.
static void MoveAction(vtkAbstractWidget *)
void SetEnabled(int) override
The method for activating and deactivating this widget.
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
static void AddPointAction(vtkAbstractWidget *)
static void EndSelectAction3D(vtkAbstractWidget *)
a general widget for moving handles
a simple class to control print indentation
Definition vtkIndent.h:29
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition vtkABI.h:64