VTK  9.0.3
vtkBrokenLineWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBrokenLineWidget.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 =========================================================================*/
82 #ifndef vtkBrokenLineWidget_h
83 #define vtkBrokenLineWidget_h
84 
85 #include "vtk3DWidget.h"
86 #include "vtkInteractionWidgetsModule.h" // For export macro
87 
88 class vtkActor;
89 class vtkCellPicker;
90 class vtkLineSource;
91 class vtkPlaneSource;
92 class vtkPoints;
93 class vtkPolyData;
94 class vtkPolyDataMapper;
95 class vtkProp;
96 class vtkProperty;
97 class vtkSphereSource;
98 class vtkTransform;
99 
100 #define VTK_PROJECTION_YZ 0
101 #define VTK_PROJECTION_XZ 1
102 #define VTK_PROJECTION_XY 2
103 #define VTK_PROJECTION_OBLIQUE 3
104 
105 class VTKINTERACTIONWIDGETS_EXPORT vtkBrokenLineWidget : public vtk3DWidget
106 {
107 public:
112 
114  void PrintSelf(ostream& os, vtkIndent indent) override;
115 
117 
120  void SetEnabled(int) override;
121  void PlaceWidget(double bounds[6]) override;
122  void PlaceWidget() override { this->Superclass::PlaceWidget(); }
124  double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
125  {
126  this->Superclass::PlaceWidget(xmin, xmax, ymin, ymax, zmin, zmax);
127  }
129 
131 
139  vtkSetMacro(ProjectToPlane, vtkTypeBool);
140  vtkGetMacro(ProjectToPlane, vtkTypeBool);
141  vtkBooleanMacro(ProjectToPlane, vtkTypeBool);
143 
149 
150  vtkSetClampMacro(ProjectionNormal, int, VTK_PROJECTION_YZ, VTK_PROJECTION_OBLIQUE);
151  vtkGetMacro(ProjectionNormal, int);
152  void SetProjectionNormalToXAxes() { this->SetProjectionNormal(0); }
153  void SetProjectionNormalToYAxes() { this->SetProjectionNormal(1); }
154  void SetProjectionNormalToZAxes() { this->SetProjectionNormal(2); }
155  void SetProjectionNormalToOblique() { this->SetProjectionNormal(3); }
156 
158 
166  vtkGetMacro(ProjectionPosition, double);
168 
177 
179 
184  vtkGetObjectMacro(HandleProperty, vtkProperty);
186  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
188 
190 
194  virtual void SetLineProperty(vtkProperty*);
195  vtkGetObjectMacro(LineProperty, vtkProperty);
197  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);
199 
201 
204  virtual void SetNumberOfHandles(int npts);
205  vtkGetMacro(NumberOfHandles, int);
207 
209 
213  void SetHandlePosition(int handle, double x, double y, double z);
214  void SetHandlePosition(int handle, double xyz[3]);
215  void GetHandlePosition(int handle, double xyz[3]);
216  double* GetHandlePosition(int handle);
218 
222  double GetSummedLength();
223 
229 
231 
235  vtkSetClampMacro(ProcessEvents, vtkTypeBool, 0, 1);
236  vtkGetMacro(ProcessEvents, vtkTypeBool);
237  vtkBooleanMacro(ProcessEvents, vtkTypeBool);
239 
241 
245  vtkSetClampMacro(HandleSizeFactor, double, 0., 100.);
246  vtkGetMacro(HandleSizeFactor, double);
248 
249 protected:
252 
253  // Manage the state of the widget
254  int State;
256  {
257  Start = 0,
263  Outside
264  };
265 
266  // handles the events
267  static void ProcessEventsHandler(
268  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
269 
270  // ProcessEventsHandler() dispatches to these methods.
277  void OnMouseMove();
278 
279  // Controlling vars
284 
285  // Projection capabilities
289 
290  // The broken line
294  void HighlightLine(int highlight);
297 
298  // Glyphs representing hot spots (e.g., handles)
301  void Initialize();
302  int HighlightHandle(vtkProp* prop); // returns handle index or -1 on fail
303  void SizeHandles() override;
304  void InsertHandleOnLine(double* pos);
305  void EraseHandle(const int&);
306 
307  // Do the picking
312 
313  // Register internal Pickers within PickingManager
314  void RegisterPickers() override;
315 
316  // Methods to manipulate the broken line.
317  void MovePoint(double* p1, double* p2);
318  void Scale(double* p1, double* p2, int X, int Y);
319  void Translate(double* p1, double* p2);
320  void Spin(double* p1, double* p2, double* vpn);
321 
322  // Transform the control points (used for spinning)
324 
325  // Properties used to control the appearance of selected objects and
326  // the manipulator in general.
332 
333  // For efficient spinning
334  double Centroid[3];
337 
338  // Handle sizing factor
340 
341 private:
342  vtkBrokenLineWidget(const vtkBrokenLineWidget&) = delete;
343  void operator=(const vtkBrokenLineWidget&) = delete;
344 };
345 
346 #endif
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:68
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:46
3D widget for manipulating a broken line
double GetSummedLength()
Get the summed lengths of the individual straight line segments.
void EraseHandle(const int &)
void InsertHandleOnLine(double *pos)
int HighlightHandle(vtkProp *prop)
vtkProperty * SelectedLineProperty
double * GetHandlePosition(int handle)
vtkProperty * HandleProperty
static void ProcessEventsHandler(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkPolyDataMapper * LineMapper
vtkSphereSource ** HandleGeometry
virtual void SetSelectedLineProperty(vtkProperty *)
virtual void SetHandleProperty(vtkProperty *)
Set/Get the handle properties (the spheres are the handles).
void SetHandlePosition(int handle, double x, double y, double z)
Set/Get the position of the broken line handles.
void InitializeHandles(vtkPoints *points)
Convenience method to allocate and set the handles from a vtkPoints instance.
vtkPlaneSource * PlaneSource
void ProjectPointsToObliquePlane()
~vtkBrokenLineWidget() override
void SetPlaneSource(vtkPlaneSource *plane)
Set up a reference to a vtkPlaneSource that could be from another widget object, e....
void SetProjectionPosition(double position)
Set the position of broken line handles and points in terms of a plane's position.
void GetPolyData(vtkPolyData *pd)
Grab the polydata (including points) that defines the broken line.
void GetHandlePosition(int handle, double xyz[3])
virtual void SetSelectedHandleProperty(vtkProperty *)
void Spin(double *p1, double *p2, double *vpn)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetEnabled(int) override
Methods that satisfy the superclass' API.
void Translate(double *p1, double *p2)
vtkLineSource * LineSource
void CreateDefaultProperties()
void SetHandlePosition(int handle, double xyz[3])
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
void HighlightLine(int highlight)
void PlaceWidget(double bounds[6]) override
This method is used to initially place the widget.
virtual void SetNumberOfHandles(int npts)
Set/Get the number of handles for this widget.
void Scale(double *p1, double *p2, int X, int Y)
void ProjectPointsToOrthoPlane()
void PlaceWidget() override
vtkCellPicker * HandlePicker
virtual void SetLineProperty(vtkProperty *)
Set/Get the line properties.
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
void MovePoint(double *p1, double *p2)
void SizeHandles() override
vtkCellPicker * LinePicker
static vtkBrokenLineWidget * New()
Instantiate the object.
vtkProperty * SelectedHandleProperty
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:67
a simple class to control print indentation
Definition: vtkIndent.h:34
create a line defined by two end points
Definition: vtkLineSource.h:61
abstract base class for most VTK objects
Definition: vtkObject.h:54
create an array of quadrilaterals located in a plane
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
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:48
represent surface properties of a geometric object
Definition: vtkProperty.h:62
create a polygonal sphere centered at the origin
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:55
@ points
Definition: vtkX3D.h:452
@ position
Definition: vtkX3D.h:267
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_PROJECTION_YZ
#define VTK_PROJECTION_OBLIQUE