VTK  9.2.6
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=========================================================================*/
78#ifndef vtkDistanceWidget_h
79#define vtkDistanceWidget_h
80
81#include "vtkAbstractWidget.h"
82#include "vtkInteractionWidgetsModule.h" // For export macro
83
85class vtkHandleWidget;
86class vtkDistanceWidgetCallback;
87
88class VTKINTERACTIONWIDGETS_EXPORT vtkDistanceWidget : public vtkAbstractWidget
89{
90public:
95
97
101 void PrintSelf(ostream& os, vtkIndent indent) override;
103
109 void SetEnabled(int) override;
110
117 {
118 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
119 }
120
128
133
139
147 enum
148 {
149 Start = 0,
151 Manipulate
152 };
153
155
165 virtual void SetWidgetStateToStart();
168
172 virtual int GetWidgetState() { return this->WidgetState; }
173
174protected:
177
178 // The state of the widget
181
182 // Callback interface to capture events when
183 // placing the widget.
190
191 // The positioning handle widgets
194 vtkDistanceWidgetCallback* DistanceWidgetCallback1;
195 vtkDistanceWidgetCallback* DistanceWidgetCallback2;
196
197 // Methods invoked when the handles at the
198 // end points of the widget are manipulated
199 void StartDistanceInteraction(int handleNum);
200 void DistanceInteraction(int handleNum);
201 void EndDistanceInteraction(int handleNum);
202
203 friend class vtkDistanceWidgetCallback;
204
205private:
206 vtkDistanceWidget(const vtkDistanceWidget&) = delete;
207 void operator=(const vtkDistanceWidget&) = delete;
208};
209
210#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
represent the vtkDistanceWidget
measure the distance between two points
virtual void SetWidgetStateToStart()
Set the state of the widget.
virtual int GetWidgetState()
Return the current widget state.
static void MoveAction3D(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
virtual void SetWidgetStateToManipulate()
Set the state of the widget.
vtkDistanceRepresentation * GetDistanceRepresentation()
Return the representation as a vtkDistanceRepresentation.
static void EndSelectAction(vtkAbstractWidget *)
void SetRepresentation(vtkDistanceRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void EndDistanceInteraction(int handleNum)
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void AddPointAction3D(vtkAbstractWidget *)
~vtkDistanceWidget() override
vtkHandleWidget * Point2Widget
void StartDistanceInteraction(int handleNum)
vtkHandleWidget * Point1Widget
vtkDistanceWidgetCallback * DistanceWidgetCallback1
void DistanceInteraction(int handleNum)
vtkDistanceWidgetCallback * DistanceWidgetCallback2
static vtkDistanceWidget * New()
Instantiate this class.
static void MoveAction(vtkAbstractWidget *)
void SetEnabled(int) override
The method for activating and deactivating this widget.
void SetProcessEvents(vtkTypeBool) override
Methods to change the whether the widget responds to interaction.
static void AddPointAction(vtkAbstractWidget *)
static void EndSelectAction3D(vtkAbstractWidget *)
a general widget for moving handles
a simple class to control print indentation
Definition vtkIndent.h:40
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition vtkABI.h:69