VTK  9.2.20230603
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 =========================================================================*/
88 #ifndef vtkSphereWidget_h
89 #define vtkSphereWidget_h
90 
91 #include "vtk3DWidget.h"
92 #include "vtkInteractionWidgetsModule.h" // For export macro
93 #include "vtkSphereSource.h" // Needed for faster access to the sphere source
94 
95 VTK_ABI_NAMESPACE_BEGIN
96 class vtkActor;
97 class vtkPolyDataMapper;
98 class vtkPoints;
99 class vtkPolyData;
100 class vtkSphereSource;
101 class vtkSphere;
102 class vtkCellPicker;
103 class vtkProperty;
104 
105 #define VTK_SPHERE_OFF 0
106 #define VTK_SPHERE_WIREFRAME 1
107 #define VTK_SPHERE_SURFACE 2
108 
109 class VTKINTERACTIONWIDGETS_EXPORT vtkSphereWidget : public vtk3DWidget
110 {
111 public:
115  static vtkSphereWidget* New();
116 
117  vtkTypeMacro(vtkSphereWidget, vtk3DWidget);
118  void PrintSelf(ostream& os, vtkIndent indent) override;
119 
121 
124  void SetEnabled(int) override;
125  void PlaceWidget(double bounds[6]) override;
126  void PlaceWidget() override { this->Superclass::PlaceWidget(); }
128  double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
129  {
130  this->Superclass::PlaceWidget(xmin, xmax, ymin, ymax, zmin, zmax);
131  }
133 
135 
140  vtkSetClampMacro(Representation, int, VTK_SPHERE_OFF, VTK_SPHERE_SURFACE);
141  vtkGetMacro(Representation, int);
142  void SetRepresentationToOff() { this->SetRepresentation(VTK_SPHERE_OFF); }
143  void SetRepresentationToWireframe() { this->SetRepresentation(VTK_SPHERE_WIREFRAME); }
144  void SetRepresentationToSurface() { this->SetRepresentation(VTK_SPHERE_SURFACE); }
146 
151  void SetThetaResolution(int r) { this->SphereSource->SetThetaResolution(r); }
152  int GetThetaResolution() { return this->SphereSource->GetThetaResolution(); }
153 
158  void SetPhiResolution(int r) { this->SphereSource->SetPhiResolution(r); }
159  int GetPhiResolution() { return this->SphereSource->GetPhiResolution(); }
160 
162 
165  void SetRadius(double r)
166  {
167  if (r <= 0)
168  {
169  r = .00001;
170  }
171  this->SphereSource->SetRadius(r);
172  }
173  double GetRadius() { return this->SphereSource->GetRadius(); }
175 
177 
180  void SetCenter(double x, double y, double z) { this->SphereSource->SetCenter(x, y, z); }
181  void SetCenter(double x[3]) { this->SetCenter(x[0], x[1], x[2]); }
182  double* GetCenter() VTK_SIZEHINT(3) { return this->SphereSource->GetCenter(); }
183  void GetCenter(double xyz[3]) { this->SphereSource->GetCenter(xyz); }
185 
187 
191  vtkSetMacro(Translation, vtkTypeBool);
192  vtkGetMacro(Translation, vtkTypeBool);
193  vtkBooleanMacro(Translation, vtkTypeBool);
194  vtkSetMacro(Scale, vtkTypeBool);
195  vtkGetMacro(Scale, vtkTypeBool);
196  vtkBooleanMacro(Scale, vtkTypeBool);
198 
200 
206  vtkSetMacro(HandleVisibility, vtkTypeBool);
207  vtkGetMacro(HandleVisibility, vtkTypeBool);
208  vtkBooleanMacro(HandleVisibility, vtkTypeBool);
210 
212 
217  vtkSetVector3Macro(HandleDirection, double);
218  vtkGetVector3Macro(HandleDirection, double);
220 
222 
225  vtkGetVector3Macro(HandlePosition, double);
227 
236 
243  void GetSphere(vtkSphere* sphere);
244 
246 
250  vtkGetObjectMacro(SphereProperty, vtkProperty);
251  vtkGetObjectMacro(SelectedSphereProperty, vtkProperty);
253 
255 
260  vtkGetObjectMacro(HandleProperty, vtkProperty);
261  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
263 
264 protected:
266  ~vtkSphereWidget() override;
267 
268  // Manage the state of the widget
269  int State;
271  {
272  Start = 0,
276  Outside
277  };
278 
279  // handles the events
280  static void ProcessEvents(
281  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
282 
283  // ProcessEvents() dispatches to these methods.
288  void OnMouseMove();
289 
290  // the sphere
294  void HighlightSphere(int highlight);
296 
297  // The representation of the sphere
299 
300  // Do the picking
302 
303  // Register internal Pickers within PickingManager
304  void RegisterPickers() override;
305 
306  // Methods to manipulate the sphere widget
309  void Translate(double* p1, double* p2);
310  void ScaleSphere(double* p1, double* p2, int X, int Y);
311  void MoveHandle(double* p1, double* p2, int X, int Y);
312  void PlaceHandle(double* center, double radius);
313 
314  // Properties used to control the appearance of selected objects and
315  // the manipulator in general.
321 
322  // Managing the handle
326  void HighlightHandle(int);
328  double HandleDirection[3];
329  double HandlePosition[3];
330  void SizeHandles() override;
331 
332 private:
333  vtkSphereWidget(const vtkSphereWidget&) = delete;
334  void operator=(const vtkSphereWidget&) = delete;
335 };
336 
337 VTK_ABI_NAMESPACE_END
338 #endif
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:72
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:162
ray-cast cell picker for all kinds of Prop3Ds
a simple class to control print indentation
Definition: vtkIndent.h:120
abstract base class for most VTK objects
Definition: vtkObject.h:83
represent and manipulate 3D points
Definition: vtkPoints.h:150
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:201
represent surface properties of a geometric object
Definition: vtkProperty.h:178
create a polygonal sphere centered at the origin
3D widget for manipulating a sphere
vtkCellPicker * Picker
void GetCenter(double xyz[3])
Set/Get the center of the sphere.
~vtkSphereWidget() override
void OnRightButtonUp()
vtkProperty * SelectedSphereProperty
vtkTypeBool Scale
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Methods that satisfy the superclass' API.
void SizeHandles() override
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
void SelectRepresentation()
vtkPolyDataMapper * HandleMapper
void SetCenter(double x[3])
Set/Get the center of the sphere.
double GetRadius()
Set/Get the radius of sphere.
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
Methods that satisfy the superclass' API.
double * GetCenter()
Set/Get the center of the sphere.
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()
Set the representation of the sphere.
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()
Set the representation of the sphere.
vtkSphereSource * SphereSource
void SetRepresentationToOff()
Set the representation of the sphere.
void OnRightButtonDown()
void PlaceWidget() override
Methods that satisfy the superclass' API.
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:145
@ center
Definition: vtkX3D.h:242
@ radius
Definition: vtkX3D.h:264
int vtkTypeBool
Definition: vtkABI.h:71
#define VTK_SPHERE_SURFACE
#define VTK_SPHERE_OFF
#define VTK_SPHERE_WIREFRAME
#define VTK_SIZEHINT(...)