vtkAngleRepresentation.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 vtkAngleRepresentation_h
#define vtkAngleRepresentation_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkHandleRepresentation;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkAngleRepresentation
  : public vtkWidgetRepresentation
{
public:

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

  virtual double GetAngle() = 0;


  virtual void GetPoint1WorldPosition(double pos[3]) VTK_FUTURE_CONST = 0;
  virtual void GetCenterWorldPosition(double pos[3]) VTK_FUTURE_CONST = 0;
  virtual void GetPoint2WorldPosition(double pos[3]) VTK_FUTURE_CONST = 0;
  virtual void SetPoint1DisplayPosition(double pos[3]) = 0;
  virtual void SetCenterDisplayPosition(double pos[3]) = 0;
  virtual void SetPoint2DisplayPosition(double pos[3]) = 0;
  virtual void GetPoint1DisplayPosition(double pos[3]) VTK_FUTURE_CONST = 0;
  virtual void GetCenterDisplayPosition(double pos[3]) VTK_FUTURE_CONST = 0;
  virtual void GetPoint2DisplayPosition(double pos[3]) VTK_FUTURE_CONST = 0;


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


  vtkGetObjectMacro(Point1Representation, vtkHandleRepresentation);
  vtkGetObjectMacro(CenterRepresentation, vtkHandleRepresentation);
  vtkGetObjectMacro(Point2Representation, vtkHandleRepresentation);


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


  vtkSetStringMacro(LabelFormat);
  vtkGetStringMacro(LabelFormat);


  vtkSetMacro(Scale, double);
  vtkGetMacro(Scale, double);


  vtkSetMacro(Ray1Visibility, vtkTypeBool);
  vtkGetMacro(Ray1Visibility, vtkTypeBool);
  vtkBooleanMacro(Ray1Visibility, vtkTypeBool);
  vtkSetMacro(Ray2Visibility, vtkTypeBool);
  vtkGetMacro(Ray2Visibility, vtkTypeBool);
  vtkBooleanMacro(Ray2Visibility, vtkTypeBool);
  vtkSetMacro(ArcVisibility, vtkTypeBool);
  vtkGetMacro(ArcVisibility, vtkTypeBool);
  vtkBooleanMacro(ArcVisibility, vtkTypeBool);

  // Used to communicate about the state of the representation
  enum
  {
    Outside = 0,
    NearP1,
    NearCenter,
    NearP2
  };


  void BuildRepresentation() override;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  void StartWidgetInteraction(double e[2]) override;
  virtual void CenterWidgetInteraction(double e[2]);
  void WidgetInteraction(double e[2]) override;
  void SetRenderer(vtkRenderer* ren) override;

protected:
  vtkAngleRepresentation();
  ~vtkAngleRepresentation() override;

  // The handle and the rep used to close the handles
  vtkHandleRepresentation* HandleRepresentation;
  vtkHandleRepresentation* Point1Representation;
  vtkHandleRepresentation* CenterRepresentation;
  vtkHandleRepresentation* Point2Representation;

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

  // Visibility of the various pieces of the representation
  vtkTypeBool Ray1Visibility;
  vtkTypeBool Ray2Visibility;
  vtkTypeBool ArcVisibility;

  // Format for the label
  char* LabelFormat;

  // Scale to change from degrees to the desired unit system (radians, fractions of pi) for
  // displaying the angle
  double Scale = 1.0;

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

VTK_ABI_NAMESPACE_END
#endif