VTK  9.2.6
vtkLineWidget2.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLineWidget2.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
85#ifndef vtkLineWidget2_h
86#define vtkLineWidget2_h
87
88#include "vtkAbstractWidget.h"
89#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
90#include "vtkInteractionWidgetsModule.h" // For export macro
91
93class vtkHandleWidget;
94
95class VTKINTERACTIONWIDGETS_EXPORT vtkLineWidget2 : public vtkAbstractWidget
96{
97public:
102
104
108 void PrintSelf(ostream& os, vtkIndent indent) override;
110
115 void SetEnabled(int enabling) override;
116
123 {
124 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
125 }
126
131 {
132 return reinterpret_cast<vtkLineRepresentation*>(this->WidgetRep);
133 }
134
139
145
146protected:
148 ~vtkLineWidget2() override;
149
150 // Manage the state of the widget
153 {
154 Start = 0,
155 Active
156 };
157#if !defined(VTK_LEGACY_REMOVE)
158 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
160#endif
161
163
164 // These methods handle events
170
171 // The positioning handle widgets
172 vtkHandleWidget* Point1Widget; // first end point
173 vtkHandleWidget* Point2Widget; // second end point
174 vtkHandleWidget* LineHandle; // used when selecting the line
175
177 static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
178
179private:
180 vtkLineWidget2(const vtkLineWidget2&) = delete;
181 void operator=(const vtkLineWidget2&) = delete;
182};
183
184#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:34
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:57
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_DEPRECATED_IN_9_2_0(reason)