VTK  9.3.0
vtkBiDimensionalWidget.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
88#ifndef vtkBiDimensionalWidget_h
89#define vtkBiDimensionalWidget_h
90
91#include "vtkAbstractWidget.h"
92#include "vtkInteractionWidgetsModule.h" // For export macro
93
94VTK_ABI_NAMESPACE_BEGIN
96class vtkHandleWidget;
97class vtkBiDimensionalWidgetCallback;
98
99class VTKINTERACTIONWIDGETS_EXPORT vtkBiDimensionalWidget : public vtkAbstractWidget
100{
101public:
106
108
112 void PrintSelf(ostream& os, vtkIndent indent) override;
114
120 void SetEnabled(int) override;
121
128 {
129 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
130 }
131
139
144
150
154 enum
155 {
156 EndWidgetSelectEvent = 10050
157 };
158
164
171 enum
172 {
173 Start = 0,
175 Manipulate
176 };
177
179
189 virtual void SetWidgetStateToStart();
192
196 virtual int GetWidgetState() { return this->WidgetState; }
197
198protected:
201
202 // The state of the widget
212
213 // Callback interface to capture events when
214 // placing the widget.
218
219 // The positioning handle widgets
224 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback1;
225 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback2;
226 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback3;
227 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback4;
228
229 // Methods invoked when the handles at the
230 // end points of the widget are manipulated
233
234 friend class vtkBiDimensionalWidgetCallback;
235
236private:
238 void operator=(const vtkBiDimensionalWidget&) = delete;
239};
240
241VTK_ABI_NAMESPACE_END
242#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
represent the vtkBiDimensionalWidget
measure the bi-dimensional lengths of an object
vtkBiDimensionalRepresentation * GetBiDimensionalRepresentation()
Return the representation as a vtkBiDimensionalRepresentation.
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
virtual int GetWidgetState()
Return the current widget state.
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback1
static vtkBiDimensionalWidget * New()
Instantiate this class.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback3
static void EndSelectAction(vtkAbstractWidget *)
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback4
virtual void EndBiDimensionalInteraction()
virtual void SetWidgetStateToStart()
Set the state of the widget.
~vtkBiDimensionalWidget() override
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback2
int IsMeasureValid()
A flag indicates whether the bi-dimensional measure is valid.
void SetRepresentation(vtkBiDimensionalRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void SetEnabled(int) override
The method for activating and deactivating this widget.
static void MoveAction(vtkAbstractWidget *)
virtual void SetWidgetStateToManipulate()
Set the state of the widget.
static void AddPointAction(vtkAbstractWidget *)
void StartBiDimensionalInteraction()
a general widget for moving handles
a simple class to control print indentation
Definition vtkIndent.h:29
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition vtkABI.h:64