vtkCurveRepresentation.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 vtkCurveRepresentation_h
#define vtkCurveRepresentation_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkLegacy.h"                   // for VTK_LEGACY_REMOVE
#include "vtkPolyDataAlgorithm.h"        // needed for vtkPolyDataAlgorithm
#include "vtkWidgetRepresentation.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkCellPicker;
class vtkDoubleArray;
class vtkHandleSource;
class vtkPlaneSource;
class vtkPoints;
class vtkPolyData;
class vtkProp;
class vtkProperty;
class vtkTransform;
 
#define VTK_PROJECTION_YZ 0
#define VTK_PROJECTION_XZ 1
#define VTK_PROJECTION_XY 2
#define VTK_PROJECTION_OBLIQUE 3
class VTKINTERACTIONWIDGETS_EXPORT vtkCurveRepresentation : public vtkWidgetRepresentation
{
public:
  vtkTypeMacro(vtkCurveRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  // Used to manage the InteractionState of the widget
  enum InteractionStateType
  {
    Outside = 0,
    OnHandle,
    OnLine,
    Moving,
    Scaling,
    Spinning,
    Inserting,
    Erasing,
    Pushing
  };
#if !defined(VTK_LEGACY_REMOVE)
  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
  typedef InteractionStateType _InteractionState;
#endif
 
 
  vtkSetMacro(InteractionState, int);
 
 
  vtkSetMacro(ProjectToPlane, vtkTypeBool);
  vtkGetMacro(ProjectToPlane, vtkTypeBool);
  vtkBooleanMacro(ProjectToPlane, vtkTypeBool);
 
  void SetPlaneSource(vtkPlaneSource* plane);
 
  vtkSetClampMacro(ProjectionNormal, int, VTK_PROJECTION_YZ, VTK_PROJECTION_OBLIQUE);
  vtkGetMacro(ProjectionNormal, int);
  void SetProjectionNormalToXAxes() { this->SetProjectionNormal(0); }
  void SetProjectionNormalToYAxes() { this->SetProjectionNormal(1); }
  void SetProjectionNormalToZAxes() { this->SetProjectionNormal(2); }
  void SetProjectionNormalToOblique() { this->SetProjectionNormal(3); }
 
 
  void SetProjectionPosition(double position);
  vtkGetMacro(ProjectionPosition, double);
 
  virtual void GetPolyData(vtkPolyData* pd) = 0;
 
 
  vtkGetObjectMacro(HandleProperty, vtkProperty);
  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
 
 
  vtkGetObjectMacro(LineProperty, vtkProperty);
  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);
 
 
  virtual void SetNumberOfHandles(int npts) = 0;
  vtkGetMacro(NumberOfHandles, int);
 
 
  virtual void SetDirectional(bool val);
  vtkGetMacro(Directional, bool);
  vtkBooleanMacro(Directional, bool);
 
 
  virtual void SetHandlePosition(int handle, double x, double y, double z);
  virtual void SetHandlePosition(int handle, double xyz[3]);
  virtual void GetHandlePosition(int handle, double xyz[3]);
  virtual double* GetHandlePosition(int handle);
  virtual vtkDoubleArray* GetHandlePositions() = 0;
 
 
  void SetClosed(vtkTypeBool closed);
  vtkGetMacro(Closed, vtkTypeBool);
  vtkBooleanMacro(Closed, vtkTypeBool);
 
  vtkTypeBool IsClosed();
 
  virtual double GetSummedLength() = 0;
 
  virtual void InitializeHandles(vtkPoints* points) = 0;
 
 
  void BuildRepresentation() override = 0;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  void StartWidgetInteraction(double e[2]) override;
  void WidgetInteraction(double e[2]) override;
  void EndWidgetInteraction(double e[2]) override;
  double* GetBounds() override;
 
 
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
  int RenderOverlay(vtkViewport*) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;
 
  void SetLineColor(double r, double g, double b);
 
 
  void SetInteractionColor(double, double, double);
  void SetInteractionColor(double c[3]) { this->SetInteractionColor(c[0], c[1], c[2]); }
  void SetForegroundColor(double, double, double);
  void SetForegroundColor(double c[3]) { this->SetForegroundColor(c[0], c[1], c[2]); }
 
  /*
   * Register internal Pickers within PickingManager
   */
  void RegisterPickers() override;
 
 
  void SetCurrentHandleIndex(int index);
  vtkGetMacro(CurrentHandleIndex, int);
 
 
  vtkGetMacro(TranslationAxis, int);
  vtkSetClampMacro(TranslationAxis, int, -1, 2);
 
 
  void SetXTranslationAxisOn() { this->TranslationAxis = Axis::XAxis; }
  void SetYTranslationAxisOn() { this->TranslationAxis = Axis::YAxis; }
  void SetZTranslationAxisOn() { this->TranslationAxis = Axis::ZAxis; }
  void SetTranslationAxisOff() { this->TranslationAxis = Axis::NONE; }
 
 
  bool IsTranslationConstrained() { return this->TranslationAxis != Axis::NONE; }
 
  void GetActors(vtkPropCollection*) override;
 
protected:
  vtkCurveRepresentation();
  ~vtkCurveRepresentation() override;
 
  double LastEventPosition[3];
  double Bounds[6];
 
  // Controlling vars
  int ProjectionNormal;
  double ProjectionPosition;
  vtkTypeBool ProjectToPlane;
  vtkPlaneSource* PlaneSource;
 
  // Projection capabilities
  void ProjectPointsToPlane();
  void ProjectPointsToOrthoPlane();
  void ProjectPointsToObliquePlane();
 
  int NumberOfHandles = 0;
  vtkTypeBool Closed;
 
  // The line segments
  vtkActor* LineActor;
  void HighlightLine(int highlight);
  int HighlightHandle(vtkProp* prop); // returns handle index or -1 on fail
 
  // accessors to glyphs representing hot spots (e.g., handles)
  virtual vtkActor* GetHandleActor(int index) = 0;
  virtual vtkHandleSource* GetHandleSource(int index) = 0;
 
  virtual int GetHandleIndex(vtkProp* prop) = 0;
  virtual void SizeHandles();
 
  virtual int InsertHandleOnLine(double* pos) = 0;
 
  virtual void PushHandle(double* pos);
  virtual void EraseHandle(const int&);
 
  // Do the picking
  vtkCellPicker* HandlePicker;
  vtkCellPicker* LinePicker;
  double LastPickPosition[3];
  vtkActor* CurrentHandle;
  int CurrentHandleIndex;
  bool FirstSelected;
 
  // Methods to manipulate the curve.
  void MovePoint(double* p1, double* p2);
  void Scale(double* p1, double* p2, int X, int Y);
  void Translate(double* p1, double* p2);
  void Spin(double* p1, double* p2, double* vpn);
 
  // Transform the control points (used for spinning)
  vtkTransform* Transform;
 
  // Manage how the representation appears
  bool Directional = false;
 
  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkProperty* HandleProperty;
  vtkProperty* SelectedHandleProperty;
  vtkProperty* LineProperty;
  vtkProperty* SelectedLineProperty;
  void CreateDefaultProperties();
 
  // For efficient spinning
  double Centroid[3];
  void CalculateCentroid();
 
  int TranslationAxis;
 
private:
  vtkCurveRepresentation(const vtkCurveRepresentation&) = delete;
  void operator=(const vtkCurveRepresentation&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif