VTK
vtkLineWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLineWidget.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 =========================================================================*/
73 #ifndef vtkLineWidget_h
74 #define vtkLineWidget_h
75 
76 #include "vtkInteractionWidgetsModule.h" // For export macro
77 #include "vtk3DWidget.h"
78 #include "vtkLineSource.h" // For passing calls to it
79 
80 class vtkActor;
81 class vtkPolyDataMapper;
82 class vtkPoints;
83 class vtkPolyData;
84 class vtkProp;
85 class vtkProperty;
86 class vtkSphereSource;
87 class vtkCellPicker;
88 class vtkPointWidget;
89 class vtkPWCallback;
90 class vtkPW1Callback;
91 class vtkPW2Callback;
92 
93 class VTKINTERACTIONWIDGETS_EXPORT vtkLineWidget : public vtk3DWidget
94 {
95 public:
99  static vtkLineWidget *New();
100 
101  vtkTypeMacro(vtkLineWidget,vtk3DWidget);
102  void PrintSelf(ostream& os, vtkIndent indent) override;
103 
105 
108  void SetEnabled(int) override;
109  void PlaceWidget(double bounds[6]) override;
110  void PlaceWidget() override
111  {this->Superclass::PlaceWidget();}
112  void PlaceWidget(double xmin, double xmax, double ymin, double ymax,
113  double zmin, double zmax) override
114  {this->Superclass::PlaceWidget(xmin,xmax,ymin,ymax,zmin,zmax);}
116 
120  void SetResolution(int r)
121  { this->LineSource->SetResolution(r); }
123  { return this->LineSource->GetResolution(); }
124 
128  void SetPoint1(double x, double y, double z);
129  void SetPoint1(double x[3])
130  {this->SetPoint1(x[0], x[1], x[2]); }
131  double* GetPoint1() VTK_SIZEHINT(3)
132  {return this->LineSource->GetPoint1();}
133  void GetPoint1(double xyz[3])
134  {this->LineSource->GetPoint1(xyz);}
135 
139  void SetPoint2(double x, double y, double z);
140  void SetPoint2(double x[3])
141  {this->SetPoint2(x[0], x[1], x[2]);}
142  double* GetPoint2() VTK_SIZEHINT(3)
143  {return this->LineSource->GetPoint2();}
144  void GetPoint2(double xyz[3])
145  {this->LineSource->GetPoint2(xyz);}
146 
148 
154  vtkSetClampMacro(Align, int, XAxis, None);
155  vtkGetMacro(Align, int);
156  void SetAlignToXAxis() { this->SetAlign(XAxis); }
157  void SetAlignToYAxis() { this->SetAlign(YAxis); }
158  void SetAlignToZAxis() { this->SetAlign(ZAxis); }
159  void SetAlignToNone() { this->SetAlign(None); }
161 
163 
169  vtkSetMacro(ClampToBounds,vtkTypeBool);
170  vtkGetMacro(ClampToBounds,vtkTypeBool);
171  vtkBooleanMacro(ClampToBounds,vtkTypeBool);
173 
182 
184 
189  vtkGetObjectMacro(HandleProperty,vtkProperty);
190  vtkGetObjectMacro(SelectedHandleProperty,vtkProperty);
192 
194 
198  vtkGetObjectMacro(LineProperty,vtkProperty);
199  vtkGetObjectMacro(SelectedLineProperty,vtkProperty);
201 
202 protected:
204  ~vtkLineWidget() override;
205 
206  // Manage the state of the widget
207  friend class vtkPWCallback;
208 
209  int State;
211  {
212  Start=0,
216  Outside
217  };
218 
219  //handles the events
220  static void ProcessEvents(vtkObject* object,
221  unsigned long event,
222  void* clientdata,
223  void* calldata);
224 
225  // ProcessEvents() dispatches to these methods.
232  virtual void OnMouseMove();
233 
234  // controlling ivars
235  int Align;
236 
241  None
242  };
243 
244  // the line
248  void HighlightLine(int highlight);
249 
250  // glyphs representing hot spots (e.g., handles)
254 
256  void SizeHandles() override;
257  void HandlesOn(double length);
258  void HandlesOff();
259  int HighlightHandle(vtkProp *prop); //returns cell id
260  void HighlightHandles(int highlight);
261 
262  // Do the picking
266  double LastPosition[3];
267  void SetLinePosition(double x[3]);
268 
269  // Register internal Pickers within PickingManager
270  void RegisterPickers() override;
271 
272  // Methods to manipulate the hexahedron.
273  void Scale(double *p1, double *p2, int X, int Y);
274 
275  // Initial bounds
277  void ClampPosition(double x[3]);
278  int InBounds(double x[3]);
279 
280  // Properties used to control the appearance of selected objects and
281  // the manipulator in general.
287 
288  void GenerateLine();
289 
290  // Methods for managing the point widgets used to control the endpoints
294  vtkPWCallback *PWCallback;
295  vtkPW1Callback *PW1Callback;
296  vtkPW2Callback *PW2Callback;
300  int ForwardEvent(unsigned long event);
301 
302 private:
303  vtkLineWidget(const vtkLineWidget&) = delete;
304  void operator=(const vtkLineWidget&) = delete;
305 };
306 
307 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:43
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkLineWidget::SetAlignToZAxis
void SetAlignToZAxis()
Definition: vtkLineWidget.h:158
vtkLineWidget::ClampPosition
void ClampPosition(double x[3])
vtkLineWidget::LineSource
vtkLineSource * LineSource
Definition: vtkLineWidget.h:247
vtkLineWidget::LineActor
vtkActor * LineActor
Definition: vtkLineWidget.h:245
vtkLineWidget::GetResolution
int GetResolution()
Definition: vtkLineWidget.h:122
vtkLineWidget::SetAlignToYAxis
void SetAlignToYAxis()
Definition: vtkLineWidget.h:157
vtkLineWidget::RegisterPickers
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
vtkLineWidget::CreateDefaultProperties
void CreateDefaultProperties()
vtkLineWidget::PlaceWidget
void PlaceWidget(double bounds[6]) override
This method is used to initially place the widget.
vtkLineWidget::AlignmentState
AlignmentState
Definition: vtkLineWidget.h:237
vtkLineWidget::GetPolyData
void GetPolyData(vtkPolyData *pd)
Grab the polydata (including points) that defines the line.
vtkLineWidget::SetAlignToNone
void SetAlignToNone()
Definition: vtkLineWidget.h:159
vtkLineWidget::ForwardEvent
int ForwardEvent(unsigned long event)
vtkLineWidget::SetPoint1
void SetPoint1(double x[3])
Definition: vtkLineWidget.h:129
vtkLineWidget::OnRightButtonDown
void OnRightButtonDown()
vtkLineWidget::GetPoint2
double * GetPoint2()
Definition: vtkLineWidget.h:142
vtkLineWidget::PointWidget
vtkPointWidget * PointWidget
Definition: vtkLineWidget.h:291
vtkLineWidget::Handle
vtkActor ** Handle
Definition: vtkLineWidget.h:251
vtkLineWidget::OnMiddleButtonDown
void OnMiddleButtonDown()
vtkLineWidget::CurrentHandle
vtkActor * CurrentHandle
Definition: vtkLineWidget.h:265
vtkLineWidget::HandleGeometry
vtkSphereSource ** HandleGeometry
Definition: vtkLineWidget.h:253
vtkLineWidget::GenerateLine
void GenerateLine()
vtkLineWidget::SetPoint1
void SetPoint1(double x, double y, double z)
Set/Get the position of first end point.
vtkLineWidget::LineMapper
vtkPolyDataMapper * LineMapper
Definition: vtkLineWidget.h:246
vtkLineWidget::New
static vtkLineWidget * New()
Instantiate the object.
vtkLineWidget::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkLineWidget.h:263
vtkLineWidget::EnablePointWidget
void EnablePointWidget()
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkLineWidget::OnLeftButtonUp
void OnLeftButtonUp()
vtkPointWidget
position a point in 3D space
Definition: vtkPointWidget.h:84
vtkX3D::length
@ length
Definition: vtkX3D.h:393
vtkLineWidget::SizeHandles
void SizeHandles() override
vtkLineWidget::HighlightHandles
void HighlightHandles(int highlight)
vtkLineWidget::SetResolution
void SetResolution(int r)
Set/Get the resolution (number of subdivisions) of the line.
Definition: vtkLineWidget.h:120
vtkLineWidget::CurrentPointWidget
vtkPointWidget * CurrentPointWidget
Definition: vtkLineWidget.h:297
vtkLineWidget::vtkLineWidget
vtkLineWidget()
vtkLineWidget::State
int State
Definition: vtkLineWidget.h:209
vtkLineWidget::Align
int Align
Definition: vtkLineWidget.h:235
vtkLineWidget::SetPoint2
void SetPoint2(double x, double y, double z)
Set position of other end point.
vtkLineWidget::SetPoint2
void SetPoint2(double x[3])
Definition: vtkLineWidget.h:140
vtkLineWidget::SetLinePosition
void SetLinePosition(double x[3])
vtkLineWidget::OnRightButtonUp
void OnRightButtonUp()
vtkLineWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLineWidget::GetPoint2
void GetPoint2(double xyz[3])
Definition: vtkLineWidget.h:144
vtkLineWidget::BuildRepresentation
void BuildRepresentation()
vtkLineWidget::OnMouseMove
virtual void OnMouseMove()
vtkLineWidget::SetAlignToXAxis
void SetAlignToXAxis()
Definition: vtkLineWidget.h:156
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkLineWidget
3D widget for manipulating a line
Definition: vtkLineWidget.h:94
vtkLineWidget::ZAxis
@ ZAxis
Definition: vtkLineWidget.h:240
vtkLineWidget::Scale
void Scale(double *p1, double *p2, int X, int Y)
vtkLineWidget::HighlightHandle
int HighlightHandle(vtkProp *prop)
vtkSphereSource
create a polygonal sphere centered at the origin
Definition: vtkSphereSource.h:47
vtkLineWidget::SelectedLineProperty
vtkProperty * SelectedLineProperty
Definition: vtkLineWidget.h:285
vtkLineWidget::LinePicker
vtkCellPicker * LinePicker
Definition: vtkLineWidget.h:264
vtkLineWidget::HandlesOn
void HandlesOn(double length)
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
vtkLineWidget::GetPoint1
double * GetPoint1()
Definition: vtkLineWidget.h:131
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkLineWidget::MovingHandle
@ MovingHandle
Definition: vtkLineWidget.h:213
vtkLineWidget::LineProperty
vtkProperty * LineProperty
Definition: vtkLineWidget.h:284
vtkLineWidget::DisablePointWidget
void DisablePointWidget()
vtkLineWidget::PlaceWidget
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Definition: vtkLineWidget.h:112
vtkLineSource.h
vtk3DWidget
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:68
vtkLineWidget::HandlesOff
void HandlesOff()
vtkLineWidget::~vtkLineWidget
~vtkLineWidget() override
vtkLineWidget::HandleProperty
vtkProperty * HandleProperty
Definition: vtkLineWidget.h:282
vtkLineWidget::ProcessEvents
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkLineSource
create a line defined by two end points
Definition: vtkLineSource.h:43
vtkLineWidget::OnLeftButtonDown
void OnLeftButtonDown()
vtkLineWidget::MovingLine
@ MovingLine
Definition: vtkLineWidget.h:214
vtkLineWidget::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkLineWidget.h:283
vtkLineWidget::YAxis
@ YAxis
Definition: vtkLineWidget.h:239
vtkLineWidget::PW2Callback
vtkPW2Callback * PW2Callback
Definition: vtkLineWidget.h:296
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkLineWidget::OnMiddleButtonUp
void OnMiddleButtonUp()
vtkLineWidget::PlaceWidget
void PlaceWidget() override
Definition: vtkLineWidget.h:110
vtkLineWidget::GetPoint1
void GetPoint1(double xyz[3])
Definition: vtkLineWidget.h:133
vtkLineWidget::PointWidget1
vtkPointWidget * PointWidget1
Definition: vtkLineWidget.h:292
vtkLineWidget::HighlightLine
void HighlightLine(int highlight)
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkLineWidget::SetEnabled
void SetEnabled(int) override
Methods that satisfy the superclass' API.
vtkLineWidget::PW1Callback
vtkPW1Callback * PW1Callback
Definition: vtkLineWidget.h:295
vtkLineWidget::ClampToBounds
vtkTypeBool ClampToBounds
Definition: vtkLineWidget.h:276
vtkLineWidget::Scaling
@ Scaling
Definition: vtkLineWidget.h:215
vtk3DWidget.h
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:67
vtkLineWidget::InBounds
int InBounds(double x[3])
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:70
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkLineWidget::PointWidget2
vtkPointWidget * PointWidget2
Definition: vtkLineWidget.h:293
vtkLineWidget::XAxis
@ XAxis
Definition: vtkLineWidget.h:238
vtkLineWidget::WidgetState
WidgetState
Definition: vtkLineWidget.h:211
vtkLineWidget::HandleMapper
vtkPolyDataMapper ** HandleMapper
Definition: vtkLineWidget.h:252
vtkLineWidget::PWCallback
vtkPWCallback * PWCallback
Definition: vtkLineWidget.h:294