VTK
vtkDistanceWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDistanceWidget.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 =========================================================================*/
75 #ifndef vtkDistanceWidget_h
76 #define vtkDistanceWidget_h
77 
78 #include "vtkInteractionWidgetsModule.h" // For export macro
79 #include "vtkAbstractWidget.h"
80 
82 class vtkHandleWidget;
83 class vtkDistanceWidgetCallback;
84 
85 
86 class VTKINTERACTIONWIDGETS_EXPORT vtkDistanceWidget : public vtkAbstractWidget
87 {
88 public:
93 
95 
99  void PrintSelf(ostream& os, vtkIndent indent) override;
101 
107  void SetEnabled(int) override;
108 
115  {this->Superclass::SetWidgetRepresentation(
116  reinterpret_cast<vtkWidgetRepresentation*>(r));}
117 
122  {return reinterpret_cast<vtkDistanceRepresentation*>(this->WidgetRep);}
123 
128 
134 
142  enum {Start=0,Define,Manipulate};
143 
145 
155  virtual void SetWidgetStateToStart();
158 
162  virtual int GetWidgetState()
163  {return this->WidgetState;}
164 
165 protected:
167  ~vtkDistanceWidget() override;
168 
169  // The state of the widget
172 
173  // Callback interface to capture events when
174  // placing the widget.
181 
182  // The positioning handle widgets
185  vtkDistanceWidgetCallback *DistanceWidgetCallback1;
186  vtkDistanceWidgetCallback *DistanceWidgetCallback2;
187 
188  // Methods invoked when the handles at the
189  // end points of the widget are manipulated
190  void StartDistanceInteraction(int handleNum);
191  void DistanceInteraction(int handleNum);
192  void EndDistanceInteraction(int handleNum);
193 
194  friend class vtkDistanceWidgetCallback;
195 
196 private:
197  vtkDistanceWidget(const vtkDistanceWidget&) = delete;
198  void operator=(const vtkDistanceWidget&) = delete;
199 };
200 
201 #endif
vtkDistanceWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkDistanceWidget
measure the distance between two points
Definition: vtkDistanceWidget.h:87
vtkHandleWidget
a general widget for moving handles
Definition: vtkHandleWidget.h:77
vtkAbstractWidget.h
vtkDistanceWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:61
vtkDistanceWidget::SetRepresentation
void SetRepresentation(vtkDistanceRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkDistanceWidget.h:114
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition: vtkAbstractWidget.h:174
vtkDistanceWidget::EndSelectAction3D
static void EndSelectAction3D(vtkAbstractWidget *)
vtkDistanceWidget::Point1Widget
vtkHandleWidget * Point1Widget
Definition: vtkDistanceWidget.h:183
vtkDistanceWidget::MoveAction3D
static void MoveAction3D(vtkAbstractWidget *)
vtkDistanceWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkDistanceWidget::SetProcessEvents
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
vtkDistanceWidget::AddPointAction
static void AddPointAction(vtkAbstractWidget *)
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:64
vtkDistanceWidget::WidgetState
int WidgetState
Definition: vtkDistanceWidget.h:170
vtkDistanceRepresentation
represent the vtkDistanceWidget
Definition: vtkDistanceRepresentation.h:37
vtkDistanceWidget::GetDistanceRepresentation
vtkDistanceRepresentation * GetDistanceRepresentation()
Return the representation as a vtkDistanceRepresentation.
Definition: vtkDistanceWidget.h:121
vtkDistanceWidget::GetWidgetState
virtual int GetWidgetState()
Return the current widget state.
Definition: vtkDistanceWidget.h:162
vtkDistanceWidget::Point2Widget
vtkHandleWidget * Point2Widget
Definition: vtkDistanceWidget.h:184
vtkDistanceWidget::StartDistanceInteraction
void StartDistanceInteraction(int handleNum)
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkDistanceWidget::SetWidgetStateToManipulate
virtual void SetWidgetStateToManipulate()
vtkDistanceWidget::EndDistanceInteraction
void EndDistanceInteraction(int handleNum)
vtkDistanceWidget::DistanceWidgetCallback1
vtkDistanceWidgetCallback * DistanceWidgetCallback1
Definition: vtkDistanceWidget.h:185
vtkDistanceWidget::AddPointAction3D
static void AddPointAction3D(vtkAbstractWidget *)
vtkDistanceWidget::CurrentHandle
int CurrentHandle
Definition: vtkDistanceWidget.h:171
vtkDistanceWidget::SetWidgetStateToStart
virtual void SetWidgetStateToStart()
Set the state of the widget.
vtkDistanceWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDistanceWidget::vtkDistanceWidget
vtkDistanceWidget()
vtkDistanceWidget::EndSelectAction
static void EndSelectAction(vtkAbstractWidget *)
vtkDistanceWidget::New
static vtkDistanceWidget * New()
Instantiate this class.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkDistanceWidget::DistanceWidgetCallback2
vtkDistanceWidgetCallback * DistanceWidgetCallback2
Definition: vtkDistanceWidget.h:186
vtkDistanceWidget::~vtkDistanceWidget
~vtkDistanceWidget() override
vtkDistanceWidget::DistanceInteraction
void DistanceInteraction(int handleNum)