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
vtkBiDimensionalWidget::Point2Widget
vtkHandleWidget * Point2Widget
Definition: vtkBiDimensionalWidget.h:226
vtkBiDimensionalWidget::CenterSelected
int CenterSelected
Definition: vtkBiDimensionalWidget.h:216
vtkBiDimensionalWidget::Line2OuterSelected
int Line2OuterSelected
Definition: vtkBiDimensionalWidget.h:215
vtkBiDimensionalWidget::SetProcessEvents
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
vtkHandleWidget
a general widget for moving handles
Definition: vtkHandleWidget.h:73
vtkBiDimensionalWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkBiDimensionalWidget::Line1InnerSelected
int Line1InnerSelected
Definition: vtkBiDimensionalWidget.h:212
vtkBiDimensionalWidget::Point4Widget
vtkHandleWidget * Point4Widget
Definition: vtkBiDimensionalWidget.h:228
vtkAbstractWidget.h
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:60
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition: vtkAbstractWidget.h:172
vtkBiDimensionalWidget::GetBiDimensionalRepresentation
vtkBiDimensionalRepresentation * GetBiDimensionalRepresentation()
Return the representation as a vtkBiDimensionalRepresentation.
Definition: vtkBiDimensionalWidget.h:140
vtkBiDimensionalWidget::~vtkBiDimensionalWidget
~vtkBiDimensionalWidget() override
vtkBiDimensionalWidget::Define
@ Define
Definition: vtkBiDimensionalWidget.h:179
vtkBiDimensionalWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkBiDimensionalWidget::HandleLine1Selected
int HandleLine1Selected
Definition: vtkBiDimensionalWidget.h:210
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:63
vtkBiDimensionalWidget::Line2InnerSelected
int Line2InnerSelected
Definition: vtkBiDimensionalWidget.h:214
vtkBiDimensionalWidget::vtkBiDimensionalWidget
vtkBiDimensionalWidget()
vtkBiDimensionalWidget::AddPointAction
static void AddPointAction(vtkAbstractWidget *)
vtkBiDimensionalWidget::EndBiDimensionalInteraction
virtual void EndBiDimensionalInteraction()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkBiDimensionalWidget::SetRepresentation
void SetRepresentation(vtkBiDimensionalRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkBiDimensionalWidget.h:132
vtkBiDimensionalWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkBiDimensionalWidget::GetWidgetState
virtual int GetWidgetState()
Return the current widget state.
Definition: vtkBiDimensionalWidget.h:201
vtkBiDimensionalRepresentation
represent the vtkBiDimensionalWidget
Definition: vtkBiDimensionalRepresentation.h:52
vtkBiDimensionalWidget::New
static vtkBiDimensionalWidget * New()
Instantiate this class.
vtkBiDimensionalWidget::IsMeasureValid
int IsMeasureValid()
A flag indicates whether the bi-dimensional measure is valid.
vtkBiDimensionalWidget::Point3Widget
vtkHandleWidget * Point3Widget
Definition: vtkBiDimensionalWidget.h:227
vtkBiDimensionalWidget::BiDimensionalWidgetCallback3
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback3
Definition: vtkBiDimensionalWidget.h:231
vtkBiDimensionalWidget
measure the bi-dimensional lengths of an object
Definition: vtkBiDimensionalWidget.h:105
vtkBiDimensionalWidget::SetWidgetStateToManipulate
virtual void SetWidgetStateToManipulate()
vtkBiDimensionalWidget::WidgetState
int WidgetState
Definition: vtkBiDimensionalWidget.h:208
vtkBiDimensionalWidget::Line1OuterSelected
int Line1OuterSelected
Definition: vtkBiDimensionalWidget.h:213
vtkBiDimensionalWidget::BiDimensionalWidgetCallback2
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback2
Definition: vtkBiDimensionalWidget.h:230
vtkBiDimensionalWidget::HandleLine2Selected
int HandleLine2Selected
Definition: vtkBiDimensionalWidget.h:211
vtkBiDimensionalWidget::SetWidgetStateToStart
virtual void SetWidgetStateToStart()
Set the state of the widget.
vtkBiDimensionalWidget::BiDimensionalWidgetCallback1
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback1
Definition: vtkBiDimensionalWidget.h:229
vtkBiDimensionalWidget::Point1Widget
vtkHandleWidget * Point1Widget
Definition: vtkBiDimensionalWidget.h:225
vtkBiDimensionalWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkBiDimensionalWidget::BiDimensionalWidgetCallback4
vtkBiDimensionalWidgetCallback * BiDimensionalWidgetCallback4
Definition: vtkBiDimensionalWidget.h:232
vtkBiDimensionalWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkBiDimensionalWidget::StartBiDimensionalInteraction
void StartBiDimensionalInteraction()
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkBiDimensionalWidget::CurrentHandle
int CurrentHandle
Definition: vtkBiDimensionalWidget.h:209