VTK  9.1.0
vtkBiDimensionalWidget.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkBiDimensionalWidget.h,v
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=========================================================================*/
119#ifndef vtkBiDimensionalWidget_h
120#define vtkBiDimensionalWidget_h
121
122#include "vtkAbstractWidget.h"
123#include "vtkInteractionWidgetsModule.h" // For export macro
124
126class vtkHandleWidget;
127class vtkBiDimensionalWidgetCallback;
128
129class VTKINTERACTIONWIDGETS_EXPORT vtkBiDimensionalWidget : public vtkAbstractWidget
130{
131public:
136
138
142 void PrintSelf(ostream& os, vtkIndent indent) override;
144
150 void SetEnabled(int) override;
151
158 {
159 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
160 }
161
166 {
167 return reinterpret_cast<vtkBiDimensionalRepresentation*>(this->WidgetRep);
168 }
169
174
180
184 enum
185 {
186 EndWidgetSelectEvent = 10050
187 };
188
194
201 enum
202 {
203 Start = 0,
205 Manipulate
206 };
207
209
219 virtual void SetWidgetStateToStart();
222
226 virtual int GetWidgetState() { return this->WidgetState; }
227
228protected:
231
232 // The state of the widget
242
243 // Callback interface to capture events when
244 // placing the widget.
248
249 // The positioning handle widgets
254 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback1;
255 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback2;
256 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback3;
257 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback4;
258
259 // Methods invoked when the handles at the
260 // end points of the widget are manipulated
263
264 friend class vtkBiDimensionalWidgetCallback;
265
266private:
268 void operator=(const vtkBiDimensionalWidget&) = delete;
269};
270
271#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:113
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69