vtkLineWidget.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkLineWidget.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkLineWidget_h
#define vtkLineWidget_h

#include "vtk3DWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkLineSource.h"               // For passing calls to it

class vtkActor;
class vtkPolyDataMapper;
class vtkPoints;
class vtkPolyData;
class vtkProp;
class vtkProperty;
class vtkSphereSource;
class vtkCellPicker;
class vtkPointWidget;
class vtkPWCallback;
class vtkPW1Callback;
class vtkPW2Callback;

class VTKINTERACTIONWIDGETS_EXPORT vtkLineWidget : public vtk3DWidget
{
public:
  static vtkLineWidget* New();

  vtkTypeMacro(vtkLineWidget, 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);
  }

  void SetResolution(int r) { this->LineSource->SetResolution(r); }
  int GetResolution() { return this->LineSource->GetResolution(); }

  void SetPoint1(double x, double y, double z);
  void SetPoint1(double x[3]) { this->SetPoint1(x[0], x[1], x[2]); }
  double* GetPoint1() VTK_SIZEHINT(3) { return this->LineSource->GetPoint1(); }
  void GetPoint1(double xyz[3]) { this->LineSource->GetPoint1(xyz); }

  void SetPoint2(double x, double y, double z);
  void SetPoint2(double x[3]) { this->SetPoint2(x[0], x[1], x[2]); }
  double* GetPoint2() VTK_SIZEHINT(3) { return this->LineSource->GetPoint2(); }
  void GetPoint2(double xyz[3]) { this->LineSource->GetPoint2(xyz); }


  vtkSetClampMacro(Align, int, XAxis, None);
  vtkGetMacro(Align, int);
  void SetAlignToXAxis() { this->SetAlign(XAxis); }
  void SetAlignToYAxis() { this->SetAlign(YAxis); }
  void SetAlignToZAxis() { this->SetAlign(ZAxis); }
  void SetAlignToNone() { this->SetAlign(None); }


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

  void GetPolyData(vtkPolyData* pd);


  vtkGetObjectMacro(HandleProperty, vtkProperty);
  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);


  vtkGetObjectMacro(LineProperty, vtkProperty);
  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);

protected:
  vtkLineWidget();
  ~vtkLineWidget() override;

  // Manage the state of the widget
  friend class vtkPWCallback;

  int State;
  enum WidgetState
  {
    Start = 0,
    MovingHandle,
    MovingLine,
    Scaling,
    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();
  virtual void OnMouseMove();

  // controlling ivars
  int Align;

  enum AlignmentState
  {
    XAxis,
    YAxis,
    ZAxis,
    None
  };

  // the line
  vtkActor* LineActor;
  vtkPolyDataMapper* LineMapper;
  vtkLineSource* LineSource;
  void HighlightLine(int highlight);

  // glyphs representing hot spots (e.g., handles)
  vtkActor** Handle;
  vtkPolyDataMapper** HandleMapper;
  vtkSphereSource** HandleGeometry;

  void BuildRepresentation();
  void SizeHandles() override;
  void HandlesOn(double length);
  void HandlesOff();
  int HighlightHandle(vtkProp* prop); // returns cell id
  void HighlightHandles(int highlight);

  // Do the picking
  vtkCellPicker* HandlePicker;
  vtkCellPicker* LinePicker;
  vtkActor* CurrentHandle;
  double LastPosition[3];
  void SetLinePosition(double x[3]);

  // Register internal Pickers within PickingManager
  void RegisterPickers() override;

  // Methods to manipulate the hexahedron.
  void Scale(double* p1, double* p2, int X, int Y);

  // Initial bounds
  vtkTypeBool ClampToBounds;
  void ClampPosition(double x[3]);
  int InBounds(double x[3]);

  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkProperty* HandleProperty;
  vtkProperty* SelectedHandleProperty;
  vtkProperty* LineProperty;
  vtkProperty* SelectedLineProperty;
  void CreateDefaultProperties();

  void GenerateLine();

  // Methods for managing the point widgets used to control the endpoints
  vtkPointWidget* PointWidget;
  vtkPointWidget* PointWidget1;
  vtkPointWidget* PointWidget2;
  vtkPWCallback* PWCallback;
  vtkPW1Callback* PW1Callback;
  vtkPW2Callback* PW2Callback;
  vtkPointWidget* CurrentPointWidget;
  void EnablePointWidget();
  void DisablePointWidget();
  int ForwardEvent(unsigned long event);

private:
  vtkLineWidget(const vtkLineWidget&) = delete;
  void operator=(const vtkLineWidget&) = delete;
};

#endif