VTK  9.0.1
vtkSphereWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSphereWidget.h
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 =========================================================================*/
53 #ifndef vtkSphereWidget_h
54 #define vtkSphereWidget_h
55 
56 #include "vtk3DWidget.h"
57 #include "vtkInteractionWidgetsModule.h" // For export macro
58 #include "vtkSphereSource.h" // Needed for faster access to the sphere source
59 
60 class vtkActor;
61 class vtkPolyDataMapper;
62 class vtkPoints;
63 class vtkPolyData;
64 class vtkSphereSource;
65 class vtkSphere;
66 class vtkCellPicker;
67 class vtkProperty;
68 
69 #define VTK_SPHERE_OFF 0
70 #define VTK_SPHERE_WIREFRAME 1
71 #define VTK_SPHERE_SURFACE 2
72 
73 class VTKINTERACTIONWIDGETS_EXPORT vtkSphereWidget : public vtk3DWidget
74 {
75 public:
79  static vtkSphereWidget* New();
80 
81  vtkTypeMacro(vtkSphereWidget, vtk3DWidget);
82  void PrintSelf(ostream& os, vtkIndent indent) override;
83 
85 
88  void SetEnabled(int) override;
89  void PlaceWidget(double bounds[6]) override;
90  void PlaceWidget() override { this->Superclass::PlaceWidget(); }
92  double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
93  {
94  this->Superclass::PlaceWidget(xmin, xmax, ymin, ymax, zmin, zmax);
95  }
97 
99 
104  vtkSetClampMacro(Representation, int, VTK_SPHERE_OFF, VTK_SPHERE_SURFACE);
105  vtkGetMacro(Representation, int);
106  void SetRepresentationToOff() { this->SetRepresentation(VTK_SPHERE_OFF); }
107  void SetRepresentationToWireframe() { this->SetRepresentation(VTK_SPHERE_WIREFRAME); }
108  void SetRepresentationToSurface() { this->SetRepresentation(VTK_SPHERE_SURFACE); }
110 
115  void SetThetaResolution(int r) { this->SphereSource->SetThetaResolution(r); }
116  int GetThetaResolution() { return this->SphereSource->GetThetaResolution(); }
117 
122  void SetPhiResolution(int r) { this->SphereSource->SetPhiResolution(r); }
123  int GetPhiResolution() { return this->SphereSource->GetPhiResolution(); }
124 
126 
129  void SetRadius(double r)
130  {
131  if (r <= 0)
132  {
133  r = .00001;
134  }
135  this->SphereSource->SetRadius(r);
136  }
137  double GetRadius() { return this->SphereSource->GetRadius(); }
139 
141 
144  void SetCenter(double x, double y, double z) { this->SphereSource->SetCenter(x, y, z); }
145  void SetCenter(double x[3]) { this->SetCenter(x[0], x[1], x[2]); }
146  double* GetCenter() VTK_SIZEHINT(3) { return this->SphereSource->GetCenter(); }
147  void GetCenter(double xyz[3]) { this->SphereSource->GetCenter(xyz); }
149 
151 
155  vtkSetMacro(Translation, vtkTypeBool);
156  vtkGetMacro(Translation, vtkTypeBool);
157  vtkBooleanMacro(Translation, vtkTypeBool);
158  vtkSetMacro(Scale, vtkTypeBool);
159  vtkGetMacro(Scale, vtkTypeBool);
160  vtkBooleanMacro(Scale, vtkTypeBool);
162 
164 
170  vtkSetMacro(HandleVisibility, vtkTypeBool);
171  vtkGetMacro(HandleVisibility, vtkTypeBool);
172  vtkBooleanMacro(HandleVisibility, vtkTypeBool);
174 
176 
181  vtkSetVector3Macro(HandleDirection, double);
182  vtkGetVector3Macro(HandleDirection, double);
184 
186 
189  vtkGetVector3Macro(HandlePosition, double);
191 
200 
207  void GetSphere(vtkSphere* sphere);
208 
210 
214  vtkGetObjectMacro(SphereProperty, vtkProperty);
215  vtkGetObjectMacro(SelectedSphereProperty, vtkProperty);
217 
219 
224  vtkGetObjectMacro(HandleProperty, vtkProperty);
225  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
227 
228 protected:
230  ~vtkSphereWidget() override;
231 
232  // Manage the state of the widget
233  int State;
235  {
236  Start = 0,
240  Outside
241  };
242 
243  // handles the events
244  static void ProcessEvents(
245  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
246 
247  // ProcessEvents() dispatches to these methods.
252  void OnMouseMove();
253 
254  // the sphere
258  void HighlightSphere(int highlight);
260 
261  // The representation of the sphere
263 
264  // Do the picking
266 
267  // Register internal Pickers within PickingManager
268  void RegisterPickers() override;
269 
270  // Methods to manipulate the sphere widget
273  void Translate(double* p1, double* p2);
274  void ScaleSphere(double* p1, double* p2, int X, int Y);
275  void MoveHandle(double* p1, double* p2, int X, int Y);
276  void PlaceHandle(double* center, double radius);
277 
278  // Properties used to control the appearance of selected objects and
279  // the manipulator in general.
285 
286  // Managing the handle
290  void HighlightHandle(int);
292  double HandleDirection[3];
293  double HandlePosition[3];
294  void SizeHandles() override;
295 
296 private:
297  vtkSphereWidget(const vtkSphereWidget&) = delete;
298  void operator=(const vtkSphereWidget&) = delete;
299 };
300 
301 #endif
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:68
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:46
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:67
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:54
represent and manipulate 3D points
Definition: vtkPoints.h:34
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
represent surface properties of a geometric object
Definition: vtkProperty.h:62
create a polygonal sphere centered at the origin
3D widget for manipulating a sphere
vtkCellPicker * Picker
void GetCenter(double xyz[3])
~vtkSphereWidget() override
void OnRightButtonUp()
vtkProperty * SelectedSphereProperty
vtkTypeBool Scale
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
void SizeHandles() override
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
void SelectRepresentation()
vtkPolyDataMapper * HandleMapper
void SetCenter(double x[3])
void HighlightHandle(int)
void SetCenter(double x, double y, double z)
Set/Get the center of the sphere.
void CreateDefaultProperties()
void SetEnabled(int) override
Methods that satisfy the superclass' API.
void GetPolyData(vtkPolyData *pd)
Grab the polydata (including points) that defines the sphere.
void SetRadius(double r)
Set/Get the radius of sphere.
vtkSphereSource * HandleSource
void PlaceWidget(double bounds[6]) override
This method is used to initially place the widget.
double * GetCenter()
vtkTypeBool HandleVisibility
void SetThetaResolution(int r)
Set/Get the resolution of the sphere in the Theta direction.
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
void OnLeftButtonUp()
vtkPolyDataMapper * SphereMapper
vtkProperty * SphereProperty
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void OnLeftButtonDown()
void Translate(double *p1, double *p2)
vtkActor * HandleActor
void HighlightSphere(int highlight)
void MoveHandle(double *p1, double *p2, int X, int Y)
vtkTypeBool Translation
void SetRepresentationToSurface()
void SetPhiResolution(int r)
Set/Get the resolution of the sphere in the Phi direction.
vtkProperty * HandleProperty
void GetSphere(vtkSphere *sphere)
Get the spherical implicit function defined by this widget.
vtkActor * SphereActor
void SetRepresentationToWireframe()
vtkSphereSource * SphereSource
void SetRepresentationToOff()
void OnRightButtonDown()
void PlaceWidget() override
void ScaleSphere(double *p1, double *p2, int X, int Y)
static vtkSphereWidget * New()
Instantiate the object.
vtkProperty * SelectedHandleProperty
void PlaceHandle(double *center, double radius)
implicit function for a sphere
Definition: vtkSphere.h:32
@ center
Definition: vtkX3D.h:236
@ radius
Definition: vtkX3D.h:258
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SPHERE_SURFACE
#define VTK_SPHERE_OFF
#define VTK_SPHERE_WIREFRAME
#define VTK_SIZEHINT(...)