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 =========================================================================*/
113 #ifndef vtkBiDimensionalWidget_h
114 #define vtkBiDimensionalWidget_h
115 
116 #include "vtkAbstractWidget.h"
117 #include "vtkInteractionWidgetsModule.h" // For export macro
118 
120 class vtkHandleWidget;
121 class vtkBiDimensionalWidgetCallback;
122 
123 class VTKINTERACTIONWIDGETS_EXPORT vtkBiDimensionalWidget : public vtkAbstractWidget
124 {
125 public:
130 
132 
136  void PrintSelf(ostream& os, vtkIndent indent) override;
138 
144  void SetEnabled(int) override;
145 
152  {
153  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
154  }
155 
160  {
161  return reinterpret_cast<vtkBiDimensionalRepresentation*>(this->WidgetRep);
162  }
163 
168 
174 
178  enum
179  {
180  EndWidgetSelectEvent = 10050
181  };
182 
188 
195  enum
196  {
197  Start = 0,
199  Manipulate
200  };
201 
203 
213  virtual void SetWidgetStateToStart();
216 
220  virtual int GetWidgetState() { return this->WidgetState; }
221 
222 protected:
225 
226  // The state of the widget
236 
237  // Callback interface to capture events when
238  // placing the widget.
242 
243  // The positioning handle widgets
248  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback1;
249  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback2;
250  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback3;
251  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback4;
252 
253  // Methods invoked when the handles at the
254  // end points of the widget are manipulated
257 
258  friend class vtkBiDimensionalWidgetCallback;
259 
260 private:
262  void operator=(const vtkBiDimensionalWidget&) = delete;
263 };
264 
265 #endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
represent the vtkBiDimensionalWidget
measure the bi-dimensional lengths of an object
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
virtual int GetWidgetState()
Return the current widget state.
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback1
vtkBiDimensionalRepresentation * GetBiDimensionalRepresentation()
Return the representation as a vtkBiDimensionalRepresentation.
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 vtkBiDimensionalWidget * New()
Instantiate this class.
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