vtkImageTracerWidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkImageTracerWidget_h
#define vtkImageTracerWidget_h
 
#include "vtk3DWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractPropPicker;
class vtkActor;
class vtkCellArray;
class vtkCellPicker;
class vtkFloatArray;
class vtkGlyphSource2D;
class vtkPoints;
class vtkPolyData;
class vtkProp;
class vtkProperty;
class vtkPropPicker;
class vtkTransform;
class vtkTransformPolyDataFilter;
 
#define VTK_ITW_PROJECTION_YZ 0
#define VTK_ITW_PROJECTION_XZ 1
#define VTK_ITW_PROJECTION_XY 2
#define VTK_ITW_SNAP_CELLS 0
#define VTK_ITW_SNAP_POINTS 1
 
class VTKINTERACTIONWIDGETS_EXPORT vtkImageTracerWidget : public vtk3DWidget
{
public:
  static vtkImageTracerWidget* New();
 
  vtkTypeMacro(vtkImageTracerWidget, vtk3DWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetEnabled(int) override;
  void PlaceWidget(double bounds[6]) override;
  void PlaceWidget() override { this->Superclass::PlaceWidget(); }
  void PlaceWidget(
    double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
  {
    this->Superclass::PlaceWidget(xmin, xmax, ymin, ymax, zmin, zmax);
  }



  virtual void SetHandleProperty(vtkProperty*);
  vtkGetObjectMacro(HandleProperty, vtkProperty);
  virtual void SetSelectedHandleProperty(vtkProperty*);
  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);


  virtual void SetLineProperty(vtkProperty*);
  vtkGetObjectMacro(LineProperty, vtkProperty);
  virtual void SetSelectedLineProperty(vtkProperty*);
  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);

  void SetViewProp(vtkProp* prop);


  vtkSetMacro(ProjectToPlane, vtkTypeBool);
  vtkGetMacro(ProjectToPlane, vtkTypeBool);
  vtkBooleanMacro(ProjectToPlane, vtkTypeBool);


  vtkSetClampMacro(ProjectionNormal, int, VTK_ITW_PROJECTION_YZ, VTK_ITW_PROJECTION_XY);
  vtkGetMacro(ProjectionNormal, int);
  void SetProjectionNormalToXAxes() { this->SetProjectionNormal(0); }
  void SetProjectionNormalToYAxes() { this->SetProjectionNormal(1); }
  void SetProjectionNormalToZAxes() { this->SetProjectionNormal(2); }


  void SetProjectionPosition(double position);
  vtkGetMacro(ProjectionPosition, double);


  void SetSnapToImage(vtkTypeBool snap);
  vtkGetMacro(SnapToImage, vtkTypeBool);
  vtkBooleanMacro(SnapToImage, vtkTypeBool);


  vtkSetMacro(AutoClose, vtkTypeBool);
  vtkGetMacro(AutoClose, vtkTypeBool);
  vtkBooleanMacro(AutoClose, vtkTypeBool);


  vtkSetMacro(CaptureRadius, double);
  vtkGetMacro(CaptureRadius, double);

  void GetPath(vtkPolyData* pd);

  vtkGlyphSource2D* GetGlyphSource() { return this->HandleGenerator; }


  vtkSetClampMacro(ImageSnapType, int, VTK_ITW_SNAP_CELLS, VTK_ITW_SNAP_POINTS);
  vtkGetMacro(ImageSnapType, int);


  void SetHandlePosition(int handle, double xyz[3]);
  void SetHandlePosition(int handle, double x, double y, double z);
  void GetHandlePosition(int handle, double xyz[3]);
  double* GetHandlePosition(int handle) VTK_SIZEHINT(3);


  vtkGetMacro(NumberOfHandles, int);


  void SetInteraction(vtkTypeBool interact);
  vtkGetMacro(Interaction, vtkTypeBool);
  vtkBooleanMacro(Interaction, vtkTypeBool);

  void InitializeHandles(vtkPoints*);

  int IsClosed();


  vtkSetMacro(HandleLeftMouseButton, vtkTypeBool);
  vtkGetMacro(HandleLeftMouseButton, vtkTypeBool);
  vtkBooleanMacro(HandleLeftMouseButton, vtkTypeBool);
  vtkSetMacro(HandleMiddleMouseButton, vtkTypeBool);
  vtkGetMacro(HandleMiddleMouseButton, vtkTypeBool);
  vtkBooleanMacro(HandleMiddleMouseButton, vtkTypeBool);
  vtkSetMacro(HandleRightMouseButton, vtkTypeBool);
  vtkGetMacro(HandleRightMouseButton, vtkTypeBool);
  vtkBooleanMacro(HandleRightMouseButton, vtkTypeBool);
 
protected:
  vtkImageTracerWidget();
  ~vtkImageTracerWidget() override;
 
  // Manage the state of the widget
  int State;
  enum WidgetState
  {
    Start = 0,
    Tracing,
    Snapping,
    Erasing,
    Inserting,
    Moving,
    Translating,
    Outside
  };
 
  // handles the events
  static void ProcessEvents(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);
 
  // ProcessEvents() dispatches to these methods.
  void OnLeftButtonDown();
  void OnLeftButtonUp();
  void OnMiddleButtonDown();
  void OnMiddleButtonUp();
  void OnRightButtonDown();
  void OnRightButtonUp();
  void OnMouseMove();
 
  void AddObservers();
 
  // Controlling ivars
  vtkTypeBool Interaction;
  int ProjectionNormal;
  double ProjectionPosition;
  vtkTypeBool ProjectToPlane;
  int ImageSnapType;
  vtkTypeBool SnapToImage;
  double CaptureRadius; // tolerance for auto path close
  vtkTypeBool AutoClose;
  int IsSnapping;
  int LastX;
  int LastY;
 
  void Trace(int, int);
  void Snap(double*);
  void MovePoint(const double*, const double*);
  void Translate(const double*, const double*);
  void ClosePath();
 
  // 2D glyphs representing hot spots (e.g., handles)
  vtkActor** Handle;
  vtkPolyData** HandleGeometry;
  vtkGlyphSource2D* HandleGenerator;
 
  // Transforms required as 2D glyphs are generated in the x-y plane
  vtkTransformPolyDataFilter* TransformFilter;
  vtkTransform* Transform;
  vtkFloatArray* TemporaryHandlePoints;
 
  void AppendHandles(double*);
  void ResetHandles();
  void AllocateHandles(const int&);
  void AdjustHandlePosition(const int&, double*);
  int HighlightHandle(vtkProp*); // returns handle index or -1 on fail
  void EraseHandle(const int&);
  void SizeHandles() override;
  void InsertHandleOnLine(double*);
 
  int NumberOfHandles;
  vtkActor* CurrentHandle;
  int CurrentHandleIndex;
 
  vtkProp* ViewProp;         // the prop we want to pick on
  vtkPropPicker* PropPicker; // the prop's picker
 
  // Representation of the line
  vtkPoints* LinePoints;
  vtkCellArray* LineCells;
  vtkActor* LineActor;
  vtkPolyData* LineData;
  vtkIdType CurrentPoints[2];
 
  void HighlightLine(const int&);
  void BuildLinesFromHandles();
  void ResetLine(double*);
  void AppendLine(double*);
  int PickCount;
 
  // Do the picking of the handles and the lines
  vtkCellPicker* HandlePicker;
  vtkCellPicker* LinePicker;
  vtkAbstractPropPicker* CurrentPicker;
 
  // Register internal Pickers within PickingManager
  void RegisterPickers() override;
 
  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkProperty* HandleProperty;
  vtkProperty* SelectedHandleProperty;
  vtkProperty* LineProperty;
  vtkProperty* SelectedLineProperty;
  void CreateDefaultProperties();
 
  // Enable/Disable mouse button events
  vtkTypeBool HandleLeftMouseButton;
  vtkTypeBool HandleMiddleMouseButton;
  vtkTypeBool HandleRightMouseButton;
 
private:
  vtkImageTracerWidget(const vtkImageTracerWidget&) = delete;
  void operator=(const vtkImageTracerWidget&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif