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=========================================================================*/
103#ifndef vtkBiDimensionalWidget_h
104#define vtkBiDimensionalWidget_h
105
106#include "vtkAbstractWidget.h"
107#include "vtkInteractionWidgetsModule.h" // For export macro
108
110class vtkHandleWidget;
111class vtkBiDimensionalWidgetCallback;
112
113class VTKINTERACTIONWIDGETS_EXPORT vtkBiDimensionalWidget : public vtkAbstractWidget
114{
115public:
120
122
126 void PrintSelf(ostream& os, vtkIndent indent) override;
128
134 void SetEnabled(int) override;
135
142 {
143 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
144 }
145
150 {
151 return reinterpret_cast<vtkBiDimensionalRepresentation*>(this->WidgetRep);
152 }
153
158
164
168 enum
169 {
170 EndWidgetSelectEvent = 10050
171 };
172
178
185 enum
186 {
187 Start = 0,
189 Manipulate
190 };
191
193
203 virtual void SetWidgetStateToStart();
206
210 virtual int GetWidgetState() { return this->WidgetState; }
211
212protected:
215
216 // The state of the widget
226
227 // Callback interface to capture events when
228 // placing the widget.
232
233 // The positioning handle widgets
238 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback1;
239 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback2;
240 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback3;
241 vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback4;
242
243 // Methods invoked when the handles at the
244 // end points of the widget are manipulated
247
248 friend class vtkBiDimensionalWidgetCallback;
249
250private:
252 void operator=(const vtkBiDimensionalWidget&) = delete;
253};
254
255#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:43
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69