vtkCameraOrientationRepresentation.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 vtkCameraOrientationRepresentation_h
#define vtkCameraOrientationRepresentation_h

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

#include <algorithm> // std::min, std::max

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkDiskSource;
class vtkDoubleArray;
class vtkEllipticalButtonSource;
class vtkImageData;
class vtkPoints;
class vtkPolyData;
class vtkPropCollection;
class vtkProperty;
class vtkPropPicker;
class vtkTextProperty;
class vtkTexture;
class vtkTubeFilter;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkCameraOrientationRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtkCameraOrientationRepresentation* New();
  vtkTypeMacro(vtkCameraOrientationRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum class InteractionStateType : int
  {
    Outside = 0, // corresponds to vtkCameraOrientationWidget::Inactive
    Hovering,    // corresponds to vtkCameraOrientationWidget::Hot
    Rotating     // corresponds to vtkCameraOrientationWidget::Active
  };

  void ApplyInteractionState(const InteractionStateType& state);
  void ApplyInteractionState(const int& state);

  InteractionStateType GetInteractionStateAsEnum() noexcept
  {
    // clamp to 0-2
    this->InteractionState = std::min(std::max(this->InteractionState, 0), 2);
    // convert
    return static_cast<InteractionStateType>(this->InteractionState);
  }


  vtkSetVector2Macro(Size, int);
  vtkGetVector2Macro(Size, int);


  vtkSetVector2Macro(Padding, int);
  vtkGetVector2Macro(Padding, int);

  enum class AnchorType : int
  {
    LowerLeft = 0,
    UpperLeft,
    LowerRight,
    UpperRight
  };


  vtkSetEnumMacro(AnchorPosition, AnchorType);
  vtkGetEnumMacro(AnchorPosition, AnchorType);
  void AnchorToLowerLeft()
  {
    this->AnchorPosition = AnchorType::LowerLeft;
    this->Modified();
  }
  void AnchorToUpperLeft()
  {
    this->AnchorPosition = AnchorType::UpperLeft;
    this->Modified();
  }
  void AnchorToLowerRight()
  {
    this->AnchorPosition = AnchorType::LowerRight;
    this->Modified();
  }
  void AnchorToUpperRight()
  {
    this->AnchorPosition = AnchorType::UpperRight;
    this->Modified();
  }


  vtkSetMacro(TotalLength, double);
  vtkGetMacro(TotalLength, double);


  vtkSetMacro(NormalizedHandleDia, double);
  vtkGetMacro(NormalizedHandleDia, double);


  vtkGetMacro(Azimuth, double);
  vtkGetVector3Macro(Back, double);
  vtkGetMacro(Elevation, double);
  vtkGetVector3Macro(Up, double);


  vtkSetClampMacro(ShaftResolution, int, 3, 256);
  vtkGetMacro(ShaftResolution, int);


  vtkSetClampMacro(HandleCircumferentialResolution, int, 3, 256);
  vtkGetMacro(HandleCircumferentialResolution, int);


  vtkSetClampMacro(ContainerCircumferentialResolution, int, 3, 256);
  vtkGetMacro(ContainerCircumferentialResolution, int);


  vtkSetClampMacro(ContainerRadialResolution, int, 3, 256);
  vtkGetMacro(ContainerRadialResolution, int);


  vtkGetMacro(PickedAxis, int);
  vtkGetMacro(PickedDir, int);


  void SetXPlusLabelText(const std::string& label)
  {
    this->AxisLabelsText[0][0] = label;
    this->Modified();
  }
  std::string GetXPlusLabelText() { return this->AxisLabelsText[0][0]; }
  void SetYPlusLabelText(const std::string& label)
  {
    this->AxisLabelsText[1][0] = label;
    this->Modified();
  }
  std::string GetYPlusLabelText() { return this->AxisLabelsText[1][0]; }
  void SetZPlusLabelText(const std::string& label)
  {
    this->AxisLabelsText[2][0] = label;
    this->Modified();
  }
  std::string GetZPlusLabelText() { return this->AxisLabelsText[2][0]; }


  void SetXMinusLabelText(const std::string& label)
  {
    this->AxisLabelsText[0][1] = label;
    this->Modified();
  }
  std::string GetXMinusLabelText() { return this->AxisLabelsText[0][1]; }
  void SetYMinusLabelText(const std::string& label)
  {
    this->AxisLabelsText[1][1] = label;
    this->Modified();
  }
  std::string GetYMinusLabelText() { return this->AxisLabelsText[1][1]; }
  void SetZMinusLabelText(const std::string& label)
  {
    this->AxisLabelsText[2][1] = label;
    this->Modified();
  }
  std::string GetZMinusLabelText() { return this->AxisLabelsText[2][1]; }


  vtkTextProperty* GetXPlusLabelProperty();
  vtkTextProperty* GetYPlusLabelProperty();
  vtkTextProperty* GetZPlusLabelProperty();


  vtkTextProperty* GetXMinusLabelProperty();
  vtkTextProperty* GetYMinusLabelProperty();
  vtkTextProperty* GetZMinusLabelProperty();


  void SetXAxisColor(double color[3]);
  void SetXAxisColor(double, double, double);


  void SetYAxisColor(double color[3]);
  void SetYAxisColor(double, double, double);


  void SetZAxisColor(double color[3]);
  void SetZAxisColor(double, double, double);


  void SetAxisColor(int ax, double color[3]);
  void SetAxisColor(int ax, double, double, double);


  double* GetXAxisColor() VTK_SIZEHINT(3);
  void GetXAxisColor(double color[3]);


  double* GetYAxisColor() VTK_SIZEHINT(3);
  void GetYAxisColor(double color[3]);


  double* GetZAxisColor() VTK_SIZEHINT(3);
  void GetZAxisColor(double color[3]);


  double* GetAxisColor(int ax) VTK_SIZEHINT(3);
  void GetAxisColor(int ax, double color[3]);

  vtkProperty* GetContainerProperty();


  void SetContainerVisibility(bool state);
  vtkBooleanMacro(ContainerVisibility, bool);
  bool GetContainerVisibility();

  void GetActors(vtkPropCollection*) override;

  vtkTransform* GetTransform();


  void PlaceWidget(double*) override {} // this representation is an overlay. Doesn't need this.
  void BuildRepresentation() override;
  void StartWidgetInteraction(double eventPos[2]) override;
  void WidgetInteraction(double newEventPos[2]) override;
  void EndWidgetInteraction(double newEventPos[2]) override;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  double* GetBounds() VTK_SIZEHINT(6) override;


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

  void ShallowCopy(vtkProp* prop) override;

  bool IsAnyHandleSelected() { return (this->PickedAxis != -1) && (this->PickedDir != -1); }

protected:
  vtkCameraOrientationRepresentation();
  ~vtkCameraOrientationRepresentation() override;

  virtual void CreateDefaultGeometry();
  virtual void CreateDefaultProperties();
  virtual void PositionHandles();
  virtual void HighlightHandle();
  virtual void Rotate(double newEventPos[2]);
  void RegisterPickers() override;
  void FinalizeHandlePicks();

  // description of source shapes.
  vtkNew<vtkDiskSource> ContainerSource;
  vtkNew<vtkEllipticalButtonSource> HandleSources[3][2];
  vtkNew<vtkTubeFilter> ShaftGlyphs;

  // geometries of handles and shafts. (position, color info)
  vtkNew<vtkPolyData> Skeleton;
  vtkNew<vtkPoints> Points; // used to store handle positions, also used by shafts

  // defaults are slight variations of r, y, g
  vtkNew<vtkDoubleArray> AxesColors;

  // props
  vtkNew<vtkActor> Container;
  vtkNew<vtkActor> Handles[3][2];
  vtkNew<vtkActor> Shafts;

  // font-sz, font-type, frame color of the labels.
  vtkNew<vtkTextProperty> AxisVectorTextProperties[3][2];
  vtkNew<vtkImageData> LabelImages[3][2];
  vtkNew<vtkTexture> LabelTextures[3][2];

  vtkNew<vtkPropPicker> HandlePicker;

  // Store rotation of gizmo.
  vtkNew<vtkTransform> Transform;

  // Positioning of the representation within a parent renderer.
  AnchorType AnchorPosition = AnchorType::UpperRight;
  int Padding[2] = { 10, 10 }; // In display coords.
  int Size[2] = { 120, 120 };  // In display coords.

  // Geometrical, textual, interaction description of the representation.
  std::string AxisLabelsText[3][2] = { { "X", "-X" }, { "Y", "-Y" }, { "Z", "-Z" } };
  double Azimuth = 0.;
  double Back[3] = { 0., 0., -1. };
  double Bounds[6] = {};
  double Elevation = 0.;
  double MotionFactor = 1.;
  double NormalizedHandleDia = 0.4;
  double TotalLength = 1.;
  double Up[3] = { 0., 1., 0. };
  int ContainerCircumferentialResolution = 32;
  int ContainerRadialResolution = 1;
  int HandleCircumferentialResolution = 32;
  int ShaftResolution = 10;

  // Picking information.
  int PickedAxis = -1;
  int LastPickedAx = -1;
  int PickedDir = -1;
  int LastPickedDir = -1;

  // Event tracking
  double LastEventPosition[3] = {};

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

VTK_ABI_NAMESPACE_END
#endif