VTK
vtkImageTracerWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageTracerWidget.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 =========================================================================*/
60 #ifndef vtkImageTracerWidget_h
61 #define vtkImageTracerWidget_h
62 
63 #include "vtkInteractionWidgetsModule.h" // For export macro
64 #include "vtk3DWidget.h"
65 
67 class vtkActor;
68 class vtkCellArray;
69 class vtkCellPicker;
70 class vtkFloatArray;
71 class vtkGlyphSource2D;
72 class vtkPoints;
73 class vtkPolyData;
74 class vtkProp;
75 class vtkProperty;
76 class vtkPropPicker;
77 class vtkTransform;
79 
80 #define VTK_ITW_PROJECTION_YZ 0
81 #define VTK_ITW_PROJECTION_XZ 1
82 #define VTK_ITW_PROJECTION_XY 2
83 #define VTK_ITW_SNAP_CELLS 0
84 #define VTK_ITW_SNAP_POINTS 1
85 
86 class VTKINTERACTIONWIDGETS_EXPORT vtkImageTracerWidget : public vtk3DWidget
87 {
88 public:
93 
95  void PrintSelf(ostream& os, vtkIndent indent) override;
96 
98 
101  void SetEnabled(int) override;
102  void PlaceWidget(double bounds[6]) override;
103  void PlaceWidget() override
104  {this->Superclass::PlaceWidget();}
105  void PlaceWidget(double xmin, double xmax, double ymin, double ymax,
106  double zmin, double zmax) override
107  {this->Superclass::PlaceWidget(xmin,xmax,ymin,ymax,zmin,zmax);}
109 
111 
116  vtkGetObjectMacro(HandleProperty, vtkProperty);
118  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
120 
122 
126  virtual void SetLineProperty(vtkProperty*);
127  vtkGetObjectMacro(LineProperty, vtkProperty);
129  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);
131 
135  void SetViewProp(vtkProp* prop);
136 
138 
141  vtkSetMacro(ProjectToPlane,vtkTypeBool);
142  vtkGetMacro(ProjectToPlane,vtkTypeBool);
143  vtkBooleanMacro(ProjectToPlane,vtkTypeBool);
145 
147 
153  vtkSetClampMacro(ProjectionNormal,int,VTK_ITW_PROJECTION_YZ,VTK_ITW_PROJECTION_XY);
154  vtkGetMacro(ProjectionNormal,int);
156  { this->SetProjectionNormal(0); }
158  { this->SetProjectionNormal(1); }
160  { this->SetProjectionNormal(2); }
162 
164 
172  vtkGetMacro(ProjectionPosition,double);
174 
176 
180  vtkGetMacro(SnapToImage,vtkTypeBool);
181  vtkBooleanMacro(SnapToImage,vtkTypeBool);
183 
185 
190  vtkSetMacro(AutoClose,vtkTypeBool);
191  vtkGetMacro(AutoClose,vtkTypeBool);
192  vtkBooleanMacro(AutoClose,vtkTypeBool);
194 
196 
202  vtkSetMacro(CaptureRadius,double);
203  vtkGetMacro(CaptureRadius,double);
205 
212  void GetPath(vtkPolyData *pd);
213 
217  vtkGlyphSource2D* GetGlyphSource() { return this->HandleGenerator; }
218 
220 
224  vtkSetClampMacro(ImageSnapType,int,VTK_ITW_SNAP_CELLS,VTK_ITW_SNAP_POINTS);
225  vtkGetMacro(ImageSnapType,int);
227 
229 
232  void SetHandlePosition(int handle, double xyz[3]);
233  void SetHandlePosition(int handle, double x, double y, double z);
234  void GetHandlePosition(int handle, double xyz[3]);
235  double* GetHandlePosition(int handle) VTK_SIZEHINT(3);
237 
239 
242  vtkGetMacro(NumberOfHandles,int);
244 
246 
249  void SetInteraction(vtkTypeBool interact);
250  vtkGetMacro(Interaction,vtkTypeBool);
251  vtkBooleanMacro(Interaction,vtkTypeBool);
253 
260 
264  int IsClosed();
265 
267 
270  vtkSetMacro(HandleLeftMouseButton,vtkTypeBool);
271  vtkGetMacro(HandleLeftMouseButton,vtkTypeBool);
272  vtkBooleanMacro(HandleLeftMouseButton,vtkTypeBool);
273  vtkSetMacro(HandleMiddleMouseButton,vtkTypeBool);
274  vtkGetMacro(HandleMiddleMouseButton,vtkTypeBool);
275  vtkBooleanMacro(HandleMiddleMouseButton,vtkTypeBool);
276  vtkSetMacro(HandleRightMouseButton,vtkTypeBool);
277  vtkGetMacro(HandleRightMouseButton,vtkTypeBool);
278  vtkBooleanMacro(HandleRightMouseButton,vtkTypeBool);
280 
281 protected:
284 
285  // Manage the state of the widget
286  int State;
288  {
289  Start=0,
296  Outside
297  };
298 
299  //handles the events
300  static void ProcessEvents(vtkObject* object,
301  unsigned long event,
302  void* clientdata,
303  void* calldata);
304 
305  // ProcessEvents() dispatches to these methods.
312  void OnMouseMove();
313 
314  void AddObservers();
315 
316  // Controlling ivars
323  double CaptureRadius; // tolerance for auto path close
326  int LastX;
327  int LastY;
328 
329  void Trace(int , int );
330  void Snap(double* );
331  void MovePoint(const double* , const double* );
332  void Translate(const double* , const double* );
333  void ClosePath();
334 
335  // 2D glyphs representing hot spots (e.g., handles)
339 
340  // Transforms required as 2D glyphs are generated in the x-y plane
344 
345  void AppendHandles(double*);
346  void ResetHandles();
347  void AllocateHandles(const int& );
348  void AdjustHandlePosition(const int& , double*);
349  int HighlightHandle(vtkProp* ); // returns handle index or -1 on fail
350  void EraseHandle(const int& );
351  void SizeHandles() override;
352  void InsertHandleOnLine(double* );
353 
357 
358  vtkProp *ViewProp; // the prop we want to pick on
359  vtkPropPicker *PropPicker; // the prop's picker
360 
361  // Representation of the line
366  vtkIdType CurrentPoints[2];
367 
368  void HighlightLine(const int& );
370  void ResetLine(double* );
371  void AppendLine(double* );
373 
374  // Do the picking of the handles and the lines
378 
379  // Register internal Pickers within PickingManager
380  void RegisterPickers() override;
381 
382  // Properties used to control the appearance of selected objects and
383  // the manipulator in general.
389 
390  // Enable/Disable mouse button events
394 
395 private:
397  void operator=(const vtkImageTracerWidget&) = delete;
398 };
399 
400 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkImageTracerWidget::LinePicker
vtkCellPicker * LinePicker
Definition: vtkImageTracerWidget.h:376
vtkImageTracerWidget::GetPath
void GetPath(vtkPolyData *pd)
Grab the points and lines that define the traced path.
vtkImageTracerWidget::SetProjectionNormalToYAxes
void SetProjectionNormalToYAxes()
Definition: vtkImageTracerWidget.h:157
vtkImageTracerWidget::ProjectToPlane
vtkTypeBool ProjectToPlane
Definition: vtkImageTracerWidget.h:320
vtkGlyphSource2D
create 2D glyphs represented by vtkPolyData
Definition: vtkGlyphSource2D.h:63
VTK_ITW_PROJECTION_YZ
#define VTK_ITW_PROJECTION_YZ
Definition: vtkImageTracerWidget.h:80
vtkImageTracerWidget::SetInteraction
void SetInteraction(vtkTypeBool interact)
Enable/disable mouse interaction when the widget is visible.
vtkImageTracerWidget::Snap
void Snap(double *)
vtkImageTracerWidget::ProcessEvents
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkImageTracerWidget::SelectedLineProperty
vtkProperty * SelectedLineProperty
Definition: vtkImageTracerWidget.h:387
vtkImageTracerWidget::Moving
@ Moving
Definition: vtkImageTracerWidget.h:294
vtkImageTracerWidget::ProjectionPosition
double ProjectionPosition
Definition: vtkImageTracerWidget.h:319
vtkImageTracerWidget::Inserting
@ Inserting
Definition: vtkImageTracerWidget.h:293
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:42
vtkImageTracerWidget::PickCount
int PickCount
Definition: vtkImageTracerWidget.h:372
vtkImageTracerWidget::InsertHandleOnLine
void InsertHandleOnLine(double *)
vtkImageTracerWidget::SizeHandles
void SizeHandles() override
vtkImageTracerWidget::AutoClose
vtkTypeBool AutoClose
Definition: vtkImageTracerWidget.h:324
vtkImageTracerWidget::Transform
vtkTransform * Transform
Definition: vtkImageTracerWidget.h:342
vtkImageTracerWidget::NumberOfHandles
int NumberOfHandles
Definition: vtkImageTracerWidget.h:354
vtkImageTracerWidget::LineProperty
vtkProperty * LineProperty
Definition: vtkImageTracerWidget.h:386
vtkImageTracerWidget::HandleGenerator
vtkGlyphSource2D * HandleGenerator
Definition: vtkImageTracerWidget.h:338
vtkImageTracerWidget::Erasing
@ Erasing
Definition: vtkImageTracerWidget.h:292
vtkImageTracerWidget::SetSelectedHandleProperty
virtual void SetSelectedHandleProperty(vtkProperty *)
vtkImageTracerWidget::BuildLinesFromHandles
void BuildLinesFromHandles()
vtkImageTracerWidget::CreateDefaultProperties
void CreateDefaultProperties()
vtkImageTracerWidget::WidgetState
WidgetState
Definition: vtkImageTracerWidget.h:288
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
VTK_ITW_SNAP_POINTS
#define VTK_ITW_SNAP_POINTS
Definition: vtkImageTracerWidget.h:84
vtkImageTracerWidget::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkImageTracerWidget.h:385
vtkImageTracerWidget::TemporaryHandlePoints
vtkFloatArray * TemporaryHandlePoints
Definition: vtkImageTracerWidget.h:343
vtkImageTracerWidget::SetProjectionNormalToZAxes
void SetProjectionNormalToZAxes()
Definition: vtkImageTracerWidget.h:159
vtkImageTracerWidget::OnMiddleButtonUp
void OnMiddleButtonUp()
vtkImageTracerWidget::HandleRightMouseButton
vtkTypeBool HandleRightMouseButton
Definition: vtkImageTracerWidget.h:393
vtkImageTracerWidget::TransformFilter
vtkTransformPolyDataFilter * TransformFilter
Definition: vtkImageTracerWidget.h:341
vtkImageTracerWidget::Snapping
@ Snapping
Definition: vtkImageTracerWidget.h:291
vtkImageTracerWidget::OnRightButtonUp
void OnRightButtonUp()
vtkImageTracerWidget::AddObservers
void AddObservers()
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:61
vtkImageTracerWidget::SetSelectedLineProperty
virtual void SetSelectedLineProperty(vtkProperty *)
vtkImageTracerWidget::AdjustHandlePosition
void AdjustHandlePosition(const int &, double *)
vtkImageTracerWidget::HandleLeftMouseButton
vtkTypeBool HandleLeftMouseButton
Definition: vtkImageTracerWidget.h:391
vtkImageTracerWidget::ViewProp
vtkProp * ViewProp
Definition: vtkImageTracerWidget.h:358
vtkImageTracerWidget::ProjectionNormal
int ProjectionNormal
Definition: vtkImageTracerWidget.h:318
vtkImageTracerWidget::PlaceWidget
void PlaceWidget() override
Definition: vtkImageTracerWidget.h:103
vtkImageTracerWidget::SetLineProperty
virtual void SetLineProperty(vtkProperty *)
Set/Get the line properties.
vtkImageTracerWidget::LinePoints
vtkPoints * LinePoints
Definition: vtkImageTracerWidget.h:362
vtkImageTracerWidget::LineCells
vtkCellArray * LineCells
Definition: vtkImageTracerWidget.h:363
vtkImageTracerWidget::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkImageTracerWidget.h:375
vtkX3D::position
@ position
Definition: vtkX3D.h:261
vtkImageTracerWidget::Translating
@ Translating
Definition: vtkImageTracerWidget.h:295
vtkImageTracerWidget::SetProjectionNormalToXAxes
void SetProjectionNormalToXAxes()
Definition: vtkImageTracerWidget.h:155
vtkImageTracerWidget::AllocateHandles
void AllocateHandles(const int &)
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkImageTracerWidget::OnMouseMove
void OnMouseMove()
vtkImageTracerWidget::RegisterPickers
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
vtkImageTracerWidget::Handle
vtkActor ** Handle
Definition: vtkImageTracerWidget.h:336
vtkImageTracerWidget::SetHandleProperty
virtual void SetHandleProperty(vtkProperty *)
Set/Get the handle properties (the 2D glyphs are the handles).
VTK_ITW_PROJECTION_XY
#define VTK_ITW_PROJECTION_XY
Definition: vtkImageTracerWidget.h:82
vtkImageTracerWidget::CurrentHandle
vtkActor * CurrentHandle
Definition: vtkImageTracerWidget.h:355
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
vtkImageTracerWidget::AppendLine
void AppendLine(double *)
vtkImageTracerWidget::IsSnapping
int IsSnapping
Definition: vtkImageTracerWidget.h:325
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
vtkImageTracerWidget::CurrentHandleIndex
int CurrentHandleIndex
Definition: vtkImageTracerWidget.h:356
vtkImageTracerWidget::SnapToImage
vtkTypeBool SnapToImage
Definition: vtkImageTracerWidget.h:322
vtkImageTracerWidget::~vtkImageTracerWidget
~vtkImageTracerWidget() override
vtkImageTracerWidget::SetEnabled
void SetEnabled(int) override
Methods that satisfy the superclass' API.
vtk3DWidget
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:68
vtkImageTracerWidget::SetViewProp
void SetViewProp(vtkProp *prop)
Set the prop, usually a vtkImageActor, to trace over.
vtkImageTracerWidget::OnLeftButtonUp
void OnLeftButtonUp()
vtkImageTracerWidget::MovePoint
void MovePoint(const double *, const double *)
vtkPropPicker
pick an actor/prop using graphics hardware
Definition: vtkPropPicker.h:43
vtkImageTracerWidget::PlaceWidget
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Definition: vtkImageTracerWidget.h:105
vtkImageTracerWidget::LineActor
vtkActor * LineActor
Definition: vtkImageTracerWidget.h:364
vtkTransformPolyDataFilter
transform points and associated normals and vectors for polygonal dataset
Definition: vtkTransformPolyDataFilter.h:52
vtkAbstractPropPicker
abstract API for pickers that can pick an instance of vtkProp
Definition: vtkAbstractPropPicker.h:80
vtkImageTracerWidget::HighlightLine
void HighlightLine(const int &)
vtkImageTracerWidget::SetProjectionPosition
void SetProjectionPosition(double position)
Set the position of the widgets' handles in terms of a plane's position.
vtkImageTracerWidget::SetHandlePosition
void SetHandlePosition(int handle, double xyz[3])
Set/Get the handle position in terms of a zero-based array of handles.
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkImageTracerWidget::PlaceWidget
void PlaceWidget(double bounds[6]) override
This method is used to initially place the widget.
vtkImageTracerWidget::CaptureRadius
double CaptureRadius
Definition: vtkImageTracerWidget.h:323
vtkImageTracerWidget::HandleProperty
vtkProperty * HandleProperty
Definition: vtkImageTracerWidget.h:384
vtkImageTracerWidget::GetHandlePosition
void GetHandlePosition(int handle, double xyz[3])
vtkImageTracerWidget::ImageSnapType
int ImageSnapType
Definition: vtkImageTracerWidget.h:321
vtkImageTracerWidget::CurrentPicker
vtkAbstractPropPicker * CurrentPicker
Definition: vtkImageTracerWidget.h:377
vtkImageTracerWidget::SetHandlePosition
void SetHandlePosition(int handle, double x, double y, double z)
vtkImageTracerWidget::InitializeHandles
void InitializeHandles(vtkPoints *)
Initialize the widget with a set of points and generate lines between them.
vtkImageTracerWidget::PropPicker
vtkPropPicker * PropPicker
Definition: vtkImageTracerWidget.h:359
vtkImageTracerWidget::IsClosed
int IsClosed()
Is the path closed or open?
vtkImageTracerWidget::LastY
int LastY
Definition: vtkImageTracerWidget.h:327
vtkImageTracerWidget::OnRightButtonDown
void OnRightButtonDown()
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkImageTracerWidget::AppendHandles
void AppendHandles(double *)
vtkImageTracerWidget::State
int State
Definition: vtkImageTracerWidget.h:286
vtkImageTracerWidget::OnMiddleButtonDown
void OnMiddleButtonDown()
vtkImageTracerWidget::HighlightHandle
int HighlightHandle(vtkProp *)
vtkImageTracerWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageTracerWidget
3D widget for tracing on planar props.
Definition: vtkImageTracerWidget.h:87
vtk3DWidget.h
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:67
vtkImageTracerWidget::Trace
void Trace(int, int)
vtkImageTracerWidget::Translate
void Translate(const double *, const double *)
vtkImageTracerWidget::GetHandlePosition
double * GetHandlePosition(int handle)
vtkImageTracerWidget::New
static vtkImageTracerWidget * New()
Instantiate the object.
vtkImageTracerWidget::Interaction
vtkTypeBool Interaction
Definition: vtkImageTracerWidget.h:317
vtkImageTracerWidget::ClosePath
void ClosePath()
vtkImageTracerWidget::Tracing
@ Tracing
Definition: vtkImageTracerWidget.h:290
vtkImageTracerWidget::ResetHandles
void ResetHandles()
vtkImageTracerWidget::LineData
vtkPolyData * LineData
Definition: vtkImageTracerWidget.h:365
vtkImageTracerWidget::ResetLine
void ResetLine(double *)
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:70
vtkImageTracerWidget::LastX
int LastX
Definition: vtkImageTracerWidget.h:326
vtkImageTracerWidget::OnLeftButtonDown
void OnLeftButtonDown()
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
VTK_ITW_SNAP_CELLS
#define VTK_ITW_SNAP_CELLS
Definition: vtkImageTracerWidget.h:83
vtkImageTracerWidget::HandleGeometry
vtkPolyData ** HandleGeometry
Definition: vtkImageTracerWidget.h:337
vtkImageTracerWidget::EraseHandle
void EraseHandle(const int &)
vtkImageTracerWidget::vtkImageTracerWidget
vtkImageTracerWidget()
vtkImageTracerWidget::GetGlyphSource
vtkGlyphSource2D * GetGlyphSource()
Get the handles' geometric representation via vtkGlyphSource2D.
Definition: vtkImageTracerWidget.h:217
vtkImageTracerWidget::HandleMiddleMouseButton
vtkTypeBool HandleMiddleMouseButton
Definition: vtkImageTracerWidget.h:392
vtkImageTracerWidget::SetSnapToImage
void SetSnapToImage(vtkTypeBool snap)
Force snapping to image data while tracing.