VTK  9.3.0
vtkLineWidget2.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
73#ifndef vtkLineWidget2_h
74#define vtkLineWidget2_h
75
76#include "vtkAbstractWidget.h"
77#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
78#include "vtkInteractionWidgetsModule.h" // For export macro
79#include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
80
81VTK_ABI_NAMESPACE_BEGIN
83class vtkHandleWidget;
84
85class VTKINTERACTIONWIDGETS_EXPORT vtkLineWidget2 : public vtkAbstractWidget
86{
87public:
92
94
98 void PrintSelf(ostream& os, vtkIndent indent) override;
100
105 void SetEnabled(int enabling) override;
106
113 {
114 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
115 }
116
121 {
122 return reinterpret_cast<vtkLineRepresentation*>(this->WidgetRep);
123 }
124
129
135
136protected:
138 ~vtkLineWidget2() override;
139
140 // Manage the state of the widget
143 {
144 Start = 0,
145 Active
146 };
147#if !defined(VTK_LEGACY_REMOVE)
148 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
150#endif
151
153
154 // These methods handle events
160
161 // The positioning handle widgets
162 vtkHandleWidget* Point1Widget; // first end point
163 vtkHandleWidget* Point2Widget; // second end point
164 vtkHandleWidget* LineHandle; // used when selecting the line
165
167 static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
168
169private:
170 vtkLineWidget2(const vtkLineWidget2&) = delete;
171 void operator=(const vtkLineWidget2&) = delete;
172};
173
174VTK_ABI_NAMESPACE_END
175#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
supports function callbacks
a general widget for moving handles
a simple class to control print indentation
Definition vtkIndent.h:29
a class defining the representation for a vtkLineWidget2
3D widget for manipulating a finite, straight line
~vtkLineWidget2() override
vtkHandleWidget * Point1Widget
static void ProcessKeyEvents(vtkObject *, unsigned long, void *, void *)
vtkHandleWidget * Point2Widget
void SetRepresentation(vtkLineRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
vtkCallbackCommand * KeyEventCallbackCommand
static void EndSelectAction(vtkAbstractWidget *)
vtkLineRepresentation * GetLineRepresentation()
Return the representation as a vtkLineRepresentation.
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void MoveAction(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard vtkObject methods.
static void ScaleAction(vtkAbstractWidget *)
void SetEnabled(int enabling) override
Override superclasses' SetEnabled() method because the line widget must enable its internal handle wi...
static void TranslateAction(vtkAbstractWidget *)
static vtkLineWidget2 * New()
Instantiate the object.
vtkHandleWidget * LineHandle
static void SelectAction(vtkAbstractWidget *)
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
abstract base class for most VTK objects
Definition vtkObject.h:49
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_DEPRECATED_IN_9_2_0(reason)