vtkLineRepresentation.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 vtkLineRepresentation_h
#define vtkLineRepresentation_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkConeSource;
class vtkPolyDataMapper;
class vtkLineSource;
class vtkProperty;
class vtkPolyData;
class vtkPolyDataAlgorithm;
class vtkPointHandleRepresentation3D;
class vtkBox;
class vtkFollower;
class vtkVectorText;
class vtkPolyDataMapper;
class vtkCellPicker;

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


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


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


  void SetHandleRepresentation(vtkPointHandleRepresentation3D* handle);
  void InstantiateHandleRepresentation();


  vtkGetObjectMacro(Point1Representation, vtkPointHandleRepresentation3D);
  vtkGetObjectMacro(Point2Representation, vtkPointHandleRepresentation3D);
  vtkGetObjectMacro(LineHandleRepresentation, vtkPointHandleRepresentation3D);


  vtkGetObjectMacro(EndPointProperty, vtkProperty);
  vtkGetObjectMacro(SelectedEndPointProperty, vtkProperty);
  void SetEndPointProperty(vtkProperty* property);
  void SetSelectedEndPointProperty(vtkProperty* property);


  vtkGetObjectMacro(EndPoint2Property, vtkProperty);
  vtkGetObjectMacro(SelectedEndPoint2Property, vtkProperty);
  void SetEndPoint2Property(vtkProperty* property);
  void SetSelectedEndPoint2Property(vtkProperty* property);


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


  vtkSetClampMacro(Tolerance, int, 1, 100);
  vtkGetMacro(Tolerance, int);


  void SetResolution(int res);
  int GetResolution();

  void GetPolyData(vtkPolyData* pd);


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


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

  // Manage the state of the widget
  enum
  {
    Outside = 0,
    OnP1,
    OnP2,
    TranslatingP1,
    TranslatingP2,
    OnLine,
    Scaling
  };


  vtkSetClampMacro(InteractionState, int, Outside, Scaling);


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


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

  vtkMTimeType GetMTime() override;

  void SetRenderer(vtkRenderer* ren) override;


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


  vtkSetStringMacro(DistanceAnnotationFormat);
  vtkGetStringMacro(DistanceAnnotationFormat);


  void SetDistanceAnnotationScale(double x, double y, double z)
  {
    double scale[3];
    scale[0] = x;
    scale[1] = y;
    scale[2] = z;
    this->SetDistanceAnnotationScale(scale);
  }
  virtual void SetDistanceAnnotationScale(double scale[3]);
  virtual double* GetDistanceAnnotationScale() VTK_SIZEHINT(3);

  double GetDistance();

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

  virtual vtkProperty* GetDistanceAnnotationProperty();


  vtkGetObjectMacro(TextActor, vtkFollower);

  enum
  {
    RestrictNone = 0,
    RestrictToX,
    RestrictToY,
    RestrictToZ
  };

protected:
  vtkLineRepresentation();
  ~vtkLineRepresentation() override;

  // The handle and the rep used to close the handles
  vtkPointHandleRepresentation3D* HandleRepresentation;
  vtkPointHandleRepresentation3D* Point1Representation;
  vtkPointHandleRepresentation3D* Point2Representation;
  vtkPointHandleRepresentation3D* LineHandleRepresentation;

  // Manage how the representation appears
  int RepresentationState;
  bool DirectionalLine;

  // the line
  vtkActor* LineActor;
  vtkPolyDataMapper* LineMapper;
  vtkLineSource* LineSource;

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

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

  // Selection tolerance for the handles and the line
  int Tolerance;

  // Helper members
  int ClampToBounds;
  void ClampPosition(double x[3]);


  void HighlightPoint(int ptId, int highlight);
  void HighlightLine(int highlight);

  int InBounds(double x[3]);
  void SizeHandles();

  // Ivars used during widget interaction to hold initial positions
  double StartP1[3];
  double StartP2[3];
  double StartLineHandle[3];
  double Length;
  double LastEventPosition[3];

  // Support GetBounds() method
  vtkBox* BoundingBox;

  // Need to keep track if we have successfully initialized the display position.
  // The widget tends to do stuff in world coordinates, put if the renderer has
  // not been assigned, then certain operations do not properly update the display
  // position.
  int InitializedDisplayPosition;

  // Format for the label
  vtkTypeBool DistanceAnnotationVisibility;
  char* DistanceAnnotationFormat;

  vtkFollower* TextActor;
  vtkPolyDataMapper* TextMapper;
  vtkVectorText* TextInput;
  double Distance;
  bool AnnotationTextScaleInitialized;

  vtkCellPicker* LinePicker;

private:
  void UpdatePointAndLineProperties();

  vtkLineRepresentation(const vtkLineRepresentation&) = delete;
  void operator=(const vtkLineRepresentation&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif