VTK  9.3.20240418
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
95 #ifndef vtkLineWidget2_h
96 #define vtkLineWidget2_h
97 
98 #include "vtkAbstractWidget.h"
99 #include "vtkInteractionWidgetsModule.h" // For export macro
100 #include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
101 
102 VTK_ABI_NAMESPACE_BEGIN
104 class vtkHandleWidget;
105 
106 class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkLineWidget2 : public vtkAbstractWidget
107 {
108 public:
112  static vtkLineWidget2* New();
113 
115 
119  void PrintSelf(ostream& os, vtkIndent indent) override;
121 
126  void SetEnabled(int enabling) override;
127 
134  {
135  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
136  }
137 
142  {
143  return reinterpret_cast<vtkLineRepresentation*>(this->WidgetRep);
144  }
145 
150 
156 
157 protected:
159  ~vtkLineWidget2() override;
160 
161  // Manage the state of the widget
164  {
165  Start = 0,
166  Active
167  };
168 
170 
171  // These methods handle events
177 
178  // The positioning handle widgets
179  vtkHandleWidget* Point1Widget; // first end point
180  vtkHandleWidget* Point2Widget; // second end point
181  vtkHandleWidget* LineHandle; // used when selecting the line
182 
184  static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
185 
186 private:
187  vtkLineWidget2(const vtkLineWidget2&) = delete;
188  void operator=(const vtkLineWidget2&) = delete;
189 };
190 
191 VTK_ABI_NAMESPACE_END
192 #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:108
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 *)
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static vtkLineWidget2 * New()
Instantiate the object.
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 *)
vtkLineRepresentation * GetLineRepresentation()
Return the representation as a vtkLineRepresentation.
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:162
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_MARSHALAUTO