vtkMultiLineRepresentation.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 vtkMultiLineRepresentation_h
#define vtkMultiLineRepresentation_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkBox;
class vtkDoubleArray;
class vtkLineRepresentation;
class vtkPolyData;
class vtkProperty;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkMultiLineRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtkMultiLineRepresentation* New();

  vtkTypeMacro(vtkMultiLineRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void GetPoint1WorldPosition(int index, double pos[3]) VTK_FUTURE_CONST;
  double* GetPoint1WorldPosition(int index) VTK_SIZEHINT(3);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void GetPoint1DisplayPosition(int index, double pos[3]) VTK_FUTURE_CONST;
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  double* GetPoint1DisplayPosition(int index) VTK_SIZEHINT(3);
  void SetPoint1WorldPosition(int index, double pos[3]);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void SetPoint1DisplayPosition(int index, double pos[3]);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void GetPoint2DisplayPosition(int index, double pos[3]) VTK_FUTURE_CONST;
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  double* GetPoint2DisplayPosition(int index) VTK_SIZEHINT(3);
  void GetPoint2WorldPosition(int index, double pos[3]) VTK_FUTURE_CONST;
  double* GetPoint2WorldPosition(int index) VTK_SIZEHINT(3);
  void SetPoint2WorldPosition(int index, double pos[3]);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  void SetPoint2DisplayPosition(int index, double pos[3]);

  void SetPoint1WorldPosition(int index, double x, double y, double z);
  void SetPoint1DisplayPosition(int index, double x, double y, double z);
  void SetPoint2WorldPosition(int index, double x, double y, double z);
  void SetPoint2DisplayPosition(int index, double x, double y, double z);

  vtkDoubleArray* GetPoint1WorldPositions();
  vtkDoubleArray* GetPoint2WorldPositions();
  vtkDoubleArray* GetPoint1DisplayPositions();
  vtkDoubleArray* GetPoint2DisplayPositions();


  void SetLineCount(int n);
  vtkGetMacro(LineCount, int)


  vtkGetObjectMacro(EndPointProperty, vtkProperty);
  vtkGetObjectMacro(SelectedEndPointProperty, vtkProperty);


  vtkGetObjectMacro(EndPoint2Property, vtkProperty);
  vtkGetObjectMacro(SelectedEndPoint2Property, vtkProperty);


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


  void SetTolerance(int tol);
  vtkGetMacro(Tolerance, int);


  void SetResolution(int res);
  vtkGetMacro(Resolution, int);

  void GetPolyData(int index, vtkPolyData* pd);


  void PlaceWidget(double bounds[6]) override;
  void BuildRepresentation() override;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  double* GetBounds() VTK_SIZEHINT(6) override;

  // Manage the state of the widget (with his correspondent in vtkLineRepresentation next to him)
  enum
  {
    MOUSE_OUTSIDE_LINES = 0, // Outside
    MOUSE_ON_P1,             // OnP1
    MOUSE_ON_P2,             // OnP2
    TRANSLATING_P1,          // TranslatingP1
    TRANSLATING_P2,          // TranslatingP2
    MOUSE_ON_LINE,           // OnLine
    SCALING                  // Scaling
  };


  vtkSetClampMacro(InteractionState, int, MOUSE_OUTSIDE_LINES, MOUSE_ON_LINE);


  virtual void SetRepresentationState(int);
  vtkGetMacro(RepresentationState, int);


  void GetActors(vtkPropCollection* pc) override;
  void ReleaseGraphicsResources(vtkWindow* window) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;


  void SetDirectionalLine(bool val);
  vtkGetMacro(DirectionalLine, bool);
  vtkBooleanMacro(DirectionalLine, bool);

  vtkLineRepresentation* GetLineRepresentation(int index);

  vtkMTimeType GetMTime() override;

  void SetRenderer(vtkRenderer* ren) override;

  double GetDistance(int index);

  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]); }

protected:
  vtkMultiLineRepresentation();
  ~vtkMultiLineRepresentation() override;

private:
  vtkMultiLineRepresentation(const vtkMultiLineRepresentation&) = delete;
  void operator=(const vtkMultiLineRepresentation&) = delete;

  void CreateDefaultProperties();

  // Helper methods
  void AddNewLine(int index);
  void ApplyProperties(int index);
  void UpdatePoint1Positions();
  void UpdatePoint2Positions();

  // Manage how the representation appears
  bool DirectionalLine = false;

  int LineCount = 0;
  std::vector<vtkSmartPointer<vtkLineRepresentation>> LineRepresentationVector;

  vtkNew<vtkDoubleArray> Point1WorldPositions;
  vtkNew<vtkDoubleArray> Point2WorldPositions;

  vtkNew<vtkDoubleArray> Point1DisplayPositions;
  vtkNew<vtkDoubleArray> Point2DisplayPositions;

  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkNew<vtkProperty> EndPointProperty;
  vtkNew<vtkProperty> SelectedEndPointProperty;
  vtkNew<vtkProperty> EndPoint2Property;
  vtkNew<vtkProperty> SelectedEndPoint2Property;
  vtkNew<vtkProperty> LineProperty;
  vtkNew<vtkProperty> SelectedLineProperty;

  // Support GetBounds() method
  vtkNew<vtkBox> BoundingBox;

  // Selection tolerance for the handles and the lines
  int Tolerance = 5;

  int Resolution = 5;

  int RepresentationState = vtkMultiLineRepresentation::MOUSE_OUTSIDE_LINES;
};

VTK_ABI_NAMESPACE_END
#endif