VTK
vtkSphereRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSphereRepresentation.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 =========================================================================*/
49 #ifndef vtkSphereRepresentation_h
50 #define vtkSphereRepresentation_h
51 
52 #include "vtkInteractionWidgetsModule.h" // For export macro
54 #include "vtkSphereSource.h" // Needed for fast access to the sphere source
55 
56 class vtkActor;
57 class vtkPolyDataMapper;
58 class vtkSphere;
59 class vtkSphereSource;
60 class vtkCellPicker;
61 class vtkProperty;
62 class vtkPolyData;
63 class vtkPoints;
65 class vtkTransform;
66 class vtkDoubleArray;
67 class vtkMatrix4x4;
68 class vtkTextMapper;
69 class vtkActor2D;
70 class vtkTextProperty;
71 class vtkLineSource;
72 class vtkCursor3D;
73 
74 #define VTK_SPHERE_OFF 0
75 #define VTK_SPHERE_WIREFRAME 1
76 #define VTK_SPHERE_SURFACE 2
77 
78 class VTKINTERACTIONWIDGETS_EXPORT vtkSphereRepresentation : public vtkWidgetRepresentation
79 {
80 public:
84  static vtkSphereRepresentation *New();
85 
87 
91  void PrintSelf(ostream& os, vtkIndent indent) override;
93 
94  // Used to manage the state of the widget
95  enum {Outside=0,MovingHandle,OnSphere,Translating,Scaling};
96 
98 
102  vtkSetClampMacro(Representation,int,VTK_SPHERE_OFF,VTK_SPHERE_SURFACE);
103  vtkGetMacro(Representation,int);
105  { this->SetRepresentation(VTK_SPHERE_OFF);}
107  { this->SetRepresentation(VTK_SPHERE_WIREFRAME);}
109  { this->SetRepresentation(VTK_SPHERE_SURFACE);}
111 
115  void SetThetaResolution(int r)
116  { this->SphereSource->SetThetaResolution(r); }
118  { return this->SphereSource->GetThetaResolution(); }
119 
123  void SetPhiResolution(int r)
124  { this->SphereSource->SetPhiResolution(r); }
126  { return this->SphereSource->GetPhiResolution(); }
127 
133  void SetCenter(double c[3]);
134  void SetCenter(double x, double y, double z)
135  {double c[3]; c[0]=x; c[1]=y; c[2]=z; this->SetCenter(c);}
136  double* GetCenter() VTK_SIZEHINT(3)
137  {return this->SphereSource->GetCenter();}
138  void GetCenter(double xyz[3])
139  {this->SphereSource->GetCenter(xyz);}
140 
145  void SetRadius(double r);
146  double GetRadius()
147  { return this->SphereSource->GetRadius(); }
148 
150 
156  vtkSetMacro(HandleVisibility,vtkTypeBool);
157  vtkGetMacro(HandleVisibility,vtkTypeBool);
158  vtkBooleanMacro(HandleVisibility,vtkTypeBool);
160 
162 
166  void SetHandlePosition(double handle[3]);
167  void SetHandlePosition(double x, double y, double z)
168  {double p[3]; p[0]=x; p[1]=y; p[2]=z; this->SetHandlePosition(p);}
169  vtkGetVector3Macro(HandlePosition,double);
171 
173 
178  void SetHandleDirection(double dir[3]);
179  void SetHandleDirection(double dx, double dy, double dz)
180  {double d[3]; d[0]=dx; d[1]=dy; d[2]=dz; this->SetHandleDirection(d);}
181  vtkGetVector3Macro(HandleDirection,double);
183 
185 
192  vtkSetMacro(HandleText,vtkTypeBool);
193  vtkGetMacro(HandleText,vtkTypeBool);
194  vtkBooleanMacro(HandleText,vtkTypeBool);
196 
198 
202  vtkSetMacro(RadialLine,vtkTypeBool);
203  vtkGetMacro(RadialLine,vtkTypeBool);
204  vtkBooleanMacro(RadialLine,vtkTypeBool);
206 
208 
212  vtkSetMacro(CenterCursor, bool);
213  vtkGetMacro(CenterCursor, bool);
214  vtkBooleanMacro(CenterCursor, bool);
216 
224  void GetPolyData(vtkPolyData *pd);
225 
232  void GetSphere(vtkSphere *sphere);
233 
235 
239  vtkGetObjectMacro(SphereProperty,vtkProperty);
240  vtkGetObjectMacro(SelectedSphereProperty,vtkProperty);
242 
244 
249  vtkGetObjectMacro(HandleProperty,vtkProperty);
250  vtkGetObjectMacro(SelectedHandleProperty,vtkProperty);
252 
254 
258  vtkGetObjectMacro(HandleTextProperty,vtkTextProperty);
260 
262 
266  vtkGetObjectMacro(RadialLineProperty,vtkProperty);
268 
278  void SetInteractionState(int state);
279 
281 
286  void PlaceWidget(double bounds[6]) override;
287  virtual void PlaceWidget(double center[3], double handlePosition[3]);
288  void BuildRepresentation() override;
289  int ComputeInteractionState(int X, int Y, int modify=0) override;
290  void StartWidgetInteraction(double e[2]) override;
291  void WidgetInteraction(double e[2]) override;
292  double *GetBounds() override;
294 
296 
299  void ReleaseGraphicsResources(vtkWindow*) override;
300  int RenderOpaqueGeometry(vtkViewport*) override;
302  int RenderOverlay(vtkViewport*) override;
305 
306  /*
307  * Register internal Pickers within PickingManager
308  */
309  void RegisterPickers() override;
310 
311 protected:
313  ~vtkSphereRepresentation() override;
314 
315  // Manage how the representation appears
316  double LastEventPosition[3];
317 
318  // the sphere
322  void HighlightSphere(int highlight);
323 
324  // The representation of the sphere
326 
327  // Do the picking
330  double LastPickPosition[3];
331 
332  // Methods to manipulate the sphere widget
333  void Translate(double *p1, double *p2);
334  void Scale(double *p1, double *p2, int X, int Y);
335  void PlaceHandle(double *center, double radius);
336  virtual void SizeHandles();
337 
338  // Method to adapt the center cursor bounds
339  // so it always have the same pixel size on screen
340  virtual void AdaptCenterCursorBounds();
341 
342  // Properties used to control the appearance of selected objects and
343  // the manipulator in general.
348  void CreateDefaultProperties();
349 
350  // Managing the handle
354  void HighlightHandle(int);
356  double HandleDirection[3];
357  double HandlePosition[3];
358 
359  // Manage the handle label
364 
365  // Manage the radial line segment
371 
372  // Managing the center cursor
377 
378 private:
380  void operator=(const vtkSphereRepresentation&) = delete;
381 };
382 
383 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:42
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
vtkSphereRepresentation::SetHandleDirection
void SetHandleDirection(double dx, double dy, double dz)
Definition: vtkSphereRepresentation.h:179
vtkWidgetRepresentation::StartWidgetInteraction
virtual void StartWidgetInteraction(double eventPos[2])
Definition: vtkWidgetRepresentation.h:136
vtkWidgetRepresentation.h
vtkSphereRepresentation::SetCenter
void SetCenter(double x, double y, double z)
Definition: vtkSphereRepresentation.h:134
vtkSphereRepresentation::CenterMapper
vtkPolyDataMapper * CenterMapper
Definition: vtkSphereRepresentation.h:374
vtkSphereRepresentation::SetRepresentationToOff
void SetRepresentationToOff()
Definition: vtkSphereRepresentation.h:104
vtkSphereRepresentation::GetCenter
void GetCenter(double xyz[3])
Definition: vtkSphereRepresentation.h:138
vtkSphereRepresentation::Translating
Definition: vtkSphereRepresentation.h:95
vtkSphereRepresentation::RadialLineProperty
vtkProperty * RadialLineProperty
Definition: vtkSphereRepresentation.h:367
vtkSphereRepresentation::GetCenter
double * GetCenter()
Definition: vtkSphereRepresentation.h:136
vtkCursor3D
generate a 3D cursor representation
Definition: vtkCursor3D.h:39
VTK_SPHERE_WIREFRAME
#define VTK_SPHERE_WIREFRAME
Definition: vtkSphereRepresentation.h:75
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkSphereRepresentation::HandleText
vtkTypeBool HandleText
Definition: vtkSphereRepresentation.h:360
vtkSphereRepresentation::SphereActor
vtkActor * SphereActor
Definition: vtkSphereRepresentation.h:319
vtkSphereRepresentation::HandleTextActor
vtkActor2D * HandleTextActor
Definition: vtkSphereRepresentation.h:363
vtkSphereRepresentation
a class defining the representation for the vtkSphereWidget2
Definition: vtkSphereRepresentation.h:78
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:60
vtkSphereRepresentation::RadialLineActor
vtkActor * RadialLineActor
Definition: vtkSphereRepresentation.h:370
vtkX3D::dir
Definition: vtkX3D.h:324
VTK_SPHERE_SURFACE
#define VTK_SPHERE_SURFACE
Definition: vtkSphereRepresentation.h:76
vtkSphereRepresentation::SphereSource
vtkSphereSource * SphereSource
Definition: vtkSphereRepresentation.h:321
vtkSphereRepresentation::CenterCursor
bool CenterCursor
Definition: vtkSphereRepresentation.h:376
vtkX3D::center
Definition: vtkX3D.h:230
vtkSphere
implicit function for a sphere
Definition: vtkSphere.h:37
vtkWidgetRepresentation::BuildRepresentation
virtual void BuildRepresentation()=0
vtkSphereRepresentation::CenterCursorSource
vtkCursor3D * CenterCursorSource
Definition: vtkSphereRepresentation.h:375
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:60
vtkSphereRepresentation::Representation
int Representation
Definition: vtkSphereRepresentation.h:325
vtkSphereRepresentation::SetThetaResolution
void SetThetaResolution(int r)
Set/Get the resolution of the sphere in the theta direction.
Definition: vtkSphereRepresentation.h:115
vtkSphereRepresentation::HandleTextMapper
vtkTextMapper * HandleTextMapper
Definition: vtkSphereRepresentation.h:362
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkSphereRepresentation::HandleSource
vtkSphereSource * HandleSource
Definition: vtkSphereRepresentation.h:353
vtkSphereRepresentation::SetHandlePosition
void SetHandlePosition(double x, double y, double z)
Definition: vtkSphereRepresentation.h:167
vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:223
vtkSphereRepresentation::SetPhiResolution
void SetPhiResolution(int r)
Set/Get the resolution of the sphere in the phi direction.
Definition: vtkSphereRepresentation.h:123
vtkWidgetRepresentation::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition: vtkWidgetRepresentation.h:220
vtkSphereRepresentation::GetRadius
double GetRadius()
Definition: vtkSphereRepresentation.h:146
vtkSphereRepresentation::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkSphereRepresentation.h:328
vtkWidgetRepresentation::WidgetInteraction
virtual void WidgetInteraction(double newEventPos[2])
Definition: vtkWidgetRepresentation.h:137
vtkWidgetRepresentation::GetBounds
double * GetBounds() override
Methods to make this class behave as a vtkProp.
Definition: vtkWidgetRepresentation.h:215
vtkTextMapper
2D text annotation
Definition: vtkTextMapper.h:53
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkSphereRepresentation::RadialLineSource
vtkLineSource * RadialLineSource
Definition: vtkSphereRepresentation.h:368
vtkSphereRepresentation::HandleVisibility
vtkTypeBool HandleVisibility
Definition: vtkSphereRepresentation.h:355
vtkSphereSource
create a polygonal sphere centered at the origin
Definition: vtkSphereSource.h:46
VTK_SPHERE_OFF
#define VTK_SPHERE_OFF
Definition: vtkSphereRepresentation.h:74
vtkSphereRepresentation::HandleActor
vtkActor * HandleActor
Definition: vtkSphereRepresentation.h:351
vtkSphereRepresentation::SetRepresentationToWireframe
void SetRepresentationToWireframe()
Definition: vtkSphereRepresentation.h:106
vtkSphereRepresentation::HandleTextProperty
vtkTextProperty * HandleTextProperty
Definition: vtkSphereRepresentation.h:361
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:51
vtkSphereRepresentation::RadialLineMapper
vtkPolyDataMapper * RadialLineMapper
Definition: vtkSphereRepresentation.h:369
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkMatrix4x4
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:41
vtkWidgetRepresentation::RegisterPickers
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
vtkSphereSource.h
vtkLineSource
create a line defined by two end points
Definition: vtkLineSource.h:42
vtkSphereRepresentation::RadialLine
vtkTypeBool RadialLine
Definition: vtkSphereRepresentation.h:366
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:47
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:39
vtkWidgetRepresentation::PlaceWidget
virtual void PlaceWidget(double *vtkNotUsed(bounds[6]))
The following is a suggested API for widget representations.
Definition: vtkWidgetRepresentation.h:135
vtkSphereRepresentation::SetRepresentationToSurface
void SetRepresentationToSurface()
Definition: vtkSphereRepresentation.h:108
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:45
vtkSphereRepresentation::SphereProperty
vtkProperty * SphereProperty
Definition: vtkSphereRepresentation.h:344
vtkWidgetRepresentation::RenderOverlay
int RenderOverlay(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:221
vtkWidgetRepresentation::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:222
vtkSphereRepresentation::HandleProperty
vtkProperty * HandleProperty
Definition: vtkSphereRepresentation.h:346
vtkSphereRepresentation::CenterActor
vtkActor * CenterActor
Definition: vtkSphereRepresentation.h:373
vtkSphereRepresentation::HandleMapper
vtkPolyDataMapper * HandleMapper
Definition: vtkSphereRepresentation.h:352
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:41
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:66
vtkSphereRepresentation::GetThetaResolution
int GetThetaResolution()
Definition: vtkSphereRepresentation.h:117
vtkSphereRepresentation::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkSphereRepresentation.h:347
vtkWidgetRepresentation::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition: vtkWidgetRepresentation.h:225
vtkSphereRepresentation::SpherePicker
vtkCellPicker * SpherePicker
Definition: vtkSphereRepresentation.h:329
vtkX3D::radius
Definition: vtkX3D.h:252
vtkSphereRepresentation::GetPhiResolution
int GetPhiResolution()
Definition: vtkSphereRepresentation.h:125
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:69
vtkSphereRepresentation::SphereMapper
vtkPolyDataMapper * SphereMapper
Definition: vtkSphereRepresentation.h:320
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkWidgetRepresentation::ComputeInteractionState
virtual int ComputeInteractionState(int X, int Y, int modify=0)
vtkWidgetRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSphereRepresentation::SelectedSphereProperty
vtkProperty * SelectedSphereProperty
Definition: vtkSphereRepresentation.h:345
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44