VTK  9.0.1
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 =========================================================================*/
94 #ifndef vtkBiDimensionalWidget_h
95 #define vtkBiDimensionalWidget_h
96 
97 #include "vtkAbstractWidget.h"
98 #include "vtkInteractionWidgetsModule.h" // For export macro
99 
101 class vtkHandleWidget;
102 class vtkBiDimensionalWidgetCallback;
103 
104 class VTKINTERACTIONWIDGETS_EXPORT vtkBiDimensionalWidget : public vtkAbstractWidget
105 {
106 public:
111 
113 
117  void PrintSelf(ostream& os, vtkIndent indent) override;
119 
125  void SetEnabled(int) override;
126 
133  {
134  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
135  }
136 
141  {
142  return reinterpret_cast<vtkBiDimensionalRepresentation*>(this->WidgetRep);
143  }
144 
149 
155 
159  enum
160  {
161  EndWidgetSelectEvent = 10050
162  };
163 
169 
176  enum
177  {
178  Start = 0,
180  Manipulate
181  };
182 
184 
194  virtual void SetWidgetStateToStart();
197 
201  virtual int GetWidgetState() { return this->WidgetState; }
202 
203 protected:
206 
207  // The state of the widget
217 
218  // Callback interface to capture events when
219  // placing the widget.
223 
224  // The positioning handle widgets
229  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback1;
230  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback2;
231  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback3;
232  vtkBiDimensionalWidgetCallback* BiDimensionalWidgetCallback4;
233 
234  // Methods invoked when the handles at the
235  // end points of the widget are manipulated
238 
239  friend class vtkBiDimensionalWidgetCallback;
240 
241 private:
243  void operator=(const vtkBiDimensionalWidget&) = delete;
244 };
245 
246 #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
Methods invoked by print to print information about the object including superclasses.
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()
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:34
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69