VTK  9.2.5
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=========================================================================*/
88#ifndef vtkLineWidget2_h
89#define vtkLineWidget2_h
90
91#include "vtkAbstractWidget.h"
92#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
93#include "vtkInteractionWidgetsModule.h" // For export macro
94
96class vtkHandleWidget;
97
98class VTKINTERACTIONWIDGETS_EXPORT vtkLineWidget2 : public vtkAbstractWidget
99{
100public:
105
107
111 void PrintSelf(ostream& os, vtkIndent indent) override;
113
118 void SetEnabled(int enabling) override;
119
126 {
127 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
128 }
129
134 {
135 return reinterpret_cast<vtkLineRepresentation*>(this->WidgetRep);
136 }
137
142
148
149protected:
151 ~vtkLineWidget2() override;
152
153 // Manage the state of the widget
156 {
157 Start = 0,
158 Active
159 };
160#if !defined(VTK_LEGACY_REMOVE)
161 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
163#endif
164
166
167 // These methods handle events
173
174 // The positioning handle widgets
175 vtkHandleWidget* Point1Widget; // first end point
176 vtkHandleWidget* Point2Widget; // second end point
177 vtkHandleWidget* LineHandle; // used when selecting the line
178
180 static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
181
182private:
183 vtkLineWidget2(const vtkLineWidget2&) = delete;
184 void operator=(const vtkLineWidget2&) = delete;
185};
186
187#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:40
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:63
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)