VTK  9.3.1
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
76#ifndef vtkLineWidget2_h
77#define vtkLineWidget2_h
78
79#include "vtkAbstractWidget.h"
80#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
81#include "vtkInteractionWidgetsModule.h" // For export macro
82#include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
83
84VTK_ABI_NAMESPACE_BEGIN
86class vtkHandleWidget;
87
88class VTKINTERACTIONWIDGETS_EXPORT vtkLineWidget2 : public vtkAbstractWidget
89{
90public:
95
97
101 void PrintSelf(ostream& os, vtkIndent indent) override;
103
108 void SetEnabled(int enabling) override;
109
116 {
117 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
118 }
119
124 {
125 return reinterpret_cast<vtkLineRepresentation*>(this->WidgetRep);
126 }
127
132
138
139protected:
141 ~vtkLineWidget2() override;
142
143 // Manage the state of the widget
146 {
147 Start = 0,
148 Active
149 };
150#if !defined(VTK_LEGACY_REMOVE)
151 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
153#endif
154
156
157 // These methods handle events
163
164 // The positioning handle widgets
165 vtkHandleWidget* Point1Widget; // first end point
166 vtkHandleWidget* Point2Widget; // second end point
167 vtkHandleWidget* LineHandle; // used when selecting the line
168
170 static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
171
172private:
173 vtkLineWidget2(const vtkLineWidget2&) = delete;
174 void operator=(const vtkLineWidget2&) = delete;
175};
176
177VTK_ABI_NAMESPACE_END
178#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:52
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)