vtkOrientationRepresentation.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 vtkOrientationRepresentation_h
#define vtkOrientationRepresentation_h

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

#include <map>

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkArrowSource;
class vtkBox;
class vtkCellPicker;
class vtkOrientationWidget;
class vtkPolyDataNormals;
class vtkProperty;
class vtkSuperquadricSource;
class vtkTransform;

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


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


  vtkTransform* GetTransform();


  virtual void SetOrientation(double values[3]);
  virtual void SetOrientationX(double value);
  virtual void SetOrientationY(double value);
  virtual void SetOrientationZ(double value);
  double* GetOrientation();
  double GetOrientationX();
  double GetOrientationY();
  double GetOrientationZ();


  void SetProperty(int axis, bool selected, vtkProperty* property);
  void SetPropertyX(bool selected, vtkProperty* property)
  {
    this->SetProperty(Axis::X_AXIS, selected, property);
  }
  void SetPropertyY(bool selected, vtkProperty* property)
  {
    this->SetProperty(Axis::Y_AXIS, selected, property);
  }
  void SetPropertyZ(bool selected, vtkProperty* property)
  {
    this->SetProperty(Axis::Z_AXIS, selected, property);
  }
  vtkProperty* GetProperty(int axis, bool selected);
  vtkProperty* GetPropertyX(bool selected) { return this->GetProperty(Axis::X_AXIS, selected); }
  vtkProperty* GetPropertyY(bool selected) { return this->GetProperty(Axis::Y_AXIS, selected); }
  vtkProperty* GetPropertyZ(bool selected) { return this->GetProperty(Axis::Z_AXIS, selected); }


  vtkSetClampMacro(TorusLength, double, MINIMUM_TORUS_LENGTH, MAXIMUM_TORUS_LENGTH);
  vtkGetMacro(TorusLength, double);


  vtkSetClampMacro(TorusThickness, double, MINIMUM_TORUS_THICKNESS, MAXIMUM_TORUS_THICKNESS);
  vtkGetMacro(TorusThickness, double);


  vtkSetMacro(ShowArrows, bool);
  vtkGetMacro(ShowArrows, bool);
  vtkBooleanMacro(ShowArrows, bool);


  vtkSetClampMacro(ArrowDistance, double, MINIMUM_ARROW_DISTANCE, MAXIMUM_ARROW_DISTANCE);
  vtkGetMacro(ArrowDistance, double);


  vtkSetClampMacro(ArrowLength, double, MINIMUM_ARROW_LENGTH, MAXIMUM_ARROW_LENGTH);
  vtkGetMacro(ArrowLength, double);


  vtkSetMacro(ArrowTipLength, double);
  vtkGetMacro(ArrowTipLength, double);


  vtkSetClampMacro(ArrowTipRadius, double, MINIMUM_ARROW_TIP_RADIUS, MAXIMUM_ARROW_TIP_RADIUS);
  vtkGetMacro(ArrowTipRadius, double);


  vtkSetClampMacro(
    ArrowShaftRadius, double, MINIMUM_ARROW_SHAFT_RADIUS, MAXIMUM_ARROW_SHAFT_RADIUS);
  vtkGetMacro(ArrowShaftRadius, double);


  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 ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  void SetInteractionState(int state);

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

  void GetActors(vtkPropCollection*) override;

  // Used to manage the state of the widget
  enum
  {
    Outside = 0,
    RotatingX,
    RotatingY,
    RotatingZ
  };

  // Used to select properties axis dependent
  enum Axis : int
  {
    X_AXIS = 0,
    Y_AXIS,
    Z_AXIS
  };

protected:
  vtkOrientationRepresentation();
  ~vtkOrientationRepresentation() override;

  virtual void CreateDefaultProperties();
  void UpdateGeometry();
  void HighlightHandle();

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

  void InitSources();
  void InitTransforms();

  void Rotate(const double p1[4], const double p2[4], const double baseVector[3]);

  vtkSmartPointer<vtkPolyDataNormals> GetArrowsOutput(int axisIndex);

  // Manage how the representation appears
  double LastEventPosition[3] = { 0.0 };

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

  // Do the picking
  vtkNew<vtkCellPicker> HandlePicker;
  vtkSmartPointer<vtkProp> CurrentHandle;
  vtkSmartPointer<vtkProp> LastHandle;

  // Transform information
  vtkNew<vtkTransform> BaseTransform;
  vtkNew<vtkTransform> OrientationTransform;

  // Actors and geometry
  vtkNew<vtkTransform> ArrowPosTransform;
  vtkNew<vtkTransform> ArrowPosInvTransform;
  vtkNew<vtkTransform> ArrowScaleTransform;
  std::vector<vtkSmartPointer<vtkArrowSource>> ArrowSources;
  std::vector<vtkSmartPointer<vtkSuperquadricSource>> TorusSources;
  std::map<Axis, vtkNew<vtkActor>> TorusActors;
  std::map<Axis, vtkNew<vtkActor>> ArrowsActors;
  // Parameters used to control the appearance of selected objects and
  // the manipulator in general.
  std::map<Axis, vtkSmartPointer<vtkProperty>> Properties;
  std::map<Axis, vtkSmartPointer<vtkProperty>> SelectedProperties;
  // ... torus specific
  double TorusLength = 7.5;
  double TorusThickness = 0.005;
  // ... arrow specific
  bool ShowArrows = false;
  double ArrowDistance = 0.0;
  double ArrowLength = 0.05;
  double ArrowTipLength = 1.0;
  double ArrowTipRadius = 0.03;
  double ArrowShaftRadius = 0.001;

  // Minima/maxima to clamp values
  static constexpr double MINIMUM_TORUS_THICKNESS = 0.001;
  static constexpr double MAXIMUM_TORUS_THICKNESS = 0.1;
  static constexpr double MINIMUM_TORUS_LENGTH = 0.01;
  static constexpr double MAXIMUM_TORUS_LENGTH = 100.0;

  static constexpr double MINIMUM_ARROW_DISTANCE = 0.0;
  static constexpr double MAXIMUM_ARROW_DISTANCE = 0.5;
  static constexpr double MINIMUM_ARROW_LENGTH = 0.01;
  static constexpr double MAXIMUM_ARROW_LENGTH = 0.5;
  static constexpr double MINIMUM_ARROW_TIP_RADIUS = 0.001;
  static constexpr double MAXIMUM_ARROW_TIP_RADIUS = 0.5;
  static constexpr double MINIMUM_ARROW_SHAFT_RADIUS = 0.001;
  static constexpr double MAXIMUM_ARROW_SHAFT_RADIUS = 0.5;
};

VTK_ABI_NAMESPACE_END
#endif