vtkCubeAxesActor.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 vtkCubeAxesActor_h
#define vtkCubeAxesActor_h
 
#include "vtkActor.h"
#include "vtkDeprecation.h"               // For deprecation macro
#include "vtkNew.h"                       // For vtkNew
#include "vtkRenderingAnnotationModule.h" // For export macro
#include "vtkSmartPointer.h"              // For vtkSmartPointer
#include "vtkWrappingHints.h"             // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAxisActor;
class vtkCamera;
class vtkTextProperty;
class vtkStringArray;
 
class VTKRENDERINGANNOTATION_EXPORT VTK_MARSHALAUTO vtkCubeAxesActor : public vtkActor
{
public:
  vtkTypeMacro(vtkCubeAxesActor, vtkActor);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCubeAxesActor* New();


  int RenderOpaqueGeometry(vtkViewport*) override;
  virtual int RenderTranslucentGeometry(vtkViewport*);
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
  int RenderOverlay(vtkViewport*) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;


  vtkSetMacro(RebuildAxes, bool);
  vtkGetMacro(RebuildAxes, bool);


  vtkSetVector6Macro(Bounds, double);
  using Superclass::GetBounds;
  double* GetBounds() VTK_SIZEHINT(6) override { return this->Bounds; }


  virtual void GetRenderedBounds(double rBounds[6]);
  virtual double* GetRenderedBounds();


  vtkSetVector2Macro(XAxisRange, double);
  vtkSetVector2Macro(YAxisRange, double);
  vtkSetVector2Macro(ZAxisRange, double);
  vtkGetVector2Macro(XAxisRange, double);
  vtkGetVector2Macro(YAxisRange, double);

  vtkStringArray* GetAxisLabels(int axis);
  void SetAxisLabels(int axis, vtkStringArray* value);
 
  vtkGetVector2Macro(ZAxisRange, double);


  void SetScreenSize(double screenSize);
  vtkGetMacro(ScreenSize, double);


  void SetLabelOffset(double offset);
  vtkGetMacro(LabelOffset, double);


  VTK_DEPRECATED_IN_9_3_0("Use the new setters as it's now a 2d vector")
  void SetTitleOffset(double titleOffsetY);
  VTK_DEPRECATED_IN_9_3_0("Use the new getter as it's now a 2d vector")
  double GetTitleOffset();
  void SetTitleOffset(double titleOffset[2]);
  // TODO: Replace getter with macro once deprecated one is removed
  void GetTitleOffset(double& titleOffsetX, double& titleOffsetY);


  virtual void SetCamera(vtkCamera*);
  vtkCamera* GetCamera();
 
  enum FlyMode
  {
    VTK_FLY_OUTER_EDGES = 0,
    VTK_FLY_CLOSEST_TRIAD = 1,
    VTK_FLY_FURTHEST_TRIAD = 2,
    VTK_FLY_STATIC_TRIAD = 3,
    VTK_FLY_STATIC_EDGES = 4
  };


  vtkSetClampMacro(FlyMode, int, VTK_FLY_OUTER_EDGES, VTK_FLY_STATIC_EDGES);
  vtkGetMacro(FlyMode, int);
  void SetFlyModeToOuterEdges() { this->SetFlyMode(VTK_FLY_OUTER_EDGES); }
  void SetFlyModeToClosestTriad() { this->SetFlyMode(VTK_FLY_CLOSEST_TRIAD); }
  void SetFlyModeToFurthestTriad() { this->SetFlyMode(VTK_FLY_FURTHEST_TRIAD); }
  void SetFlyModeToStaticTriad() { this->SetFlyMode(VTK_FLY_STATIC_TRIAD); }
  void SetFlyModeToStaticEdges() { this->SetFlyMode(VTK_FLY_STATIC_EDGES); }


  vtkSetStringMacro(XTitle);
  vtkGetStringMacro(XTitle);
  vtkSetStringMacro(XUnits);
  vtkGetStringMacro(XUnits);
  vtkSetStringMacro(YTitle);
  vtkGetStringMacro(YTitle);
  vtkSetStringMacro(YUnits);
  vtkGetStringMacro(YUnits);
  vtkSetStringMacro(ZTitle);
  vtkGetStringMacro(ZTitle);
  vtkSetStringMacro(ZUnits);
  vtkGetStringMacro(ZUnits);


  vtkSetStringMacro(XLabelFormat);
  vtkGetStringMacro(XLabelFormat);
  vtkSetStringMacro(YLabelFormat);
  vtkGetStringMacro(YLabelFormat);
  vtkSetStringMacro(ZLabelFormat);
  vtkGetStringMacro(ZLabelFormat);


  vtkSetClampMacro(Inertia, int, 1, VTK_INT_MAX);
  vtkGetMacro(Inertia, int);


  vtkSetMacro(CornerOffset, double);
  vtkGetMacro(CornerOffset, double);

  void ReleaseGraphicsResources(vtkWindow*) override;


  vtkSetMacro(EnableDistanceLOD, bool);
  vtkGetMacro(EnableDistanceLOD, bool);


  vtkSetClampMacro(DistanceLODThreshold, double, 0.0, 1.0);
  vtkGetMacro(DistanceLODThreshold, double);


  vtkSetMacro(EnableViewAngleLOD, bool);
  vtkGetMacro(EnableViewAngleLOD, bool);


  vtkSetClampMacro(ViewAngleLODThreshold, double, 0., 1.);
  vtkGetMacro(ViewAngleLODThreshold, double);


  vtkSetMacro(XAxisVisibility, bool);
  vtkGetMacro(XAxisVisibility, bool);
  vtkBooleanMacro(XAxisVisibility, bool);
 
  vtkSetMacro(YAxisVisibility, bool);
  vtkGetMacro(YAxisVisibility, bool);
  vtkBooleanMacro(YAxisVisibility, bool);
 
  vtkSetMacro(ZAxisVisibility, bool);
  vtkGetMacro(ZAxisVisibility, bool);
  vtkBooleanMacro(ZAxisVisibility, bool);


  vtkSetMacro(XAxisLabelVisibility, bool);
  vtkGetMacro(XAxisLabelVisibility, bool);
  vtkBooleanMacro(XAxisLabelVisibility, bool);
 
  vtkSetMacro(YAxisLabelVisibility, bool);
  vtkGetMacro(YAxisLabelVisibility, bool);
  vtkBooleanMacro(YAxisLabelVisibility, bool);
 
  vtkSetMacro(ZAxisLabelVisibility, bool);
  vtkGetMacro(ZAxisLabelVisibility, bool);
  vtkBooleanMacro(ZAxisLabelVisibility, bool);


  vtkSetMacro(XAxisTickVisibility, bool);
  vtkGetMacro(XAxisTickVisibility, bool);
  vtkBooleanMacro(XAxisTickVisibility, bool);
 
  vtkSetMacro(YAxisTickVisibility, bool);
  vtkGetMacro(YAxisTickVisibility, bool);
  vtkBooleanMacro(YAxisTickVisibility, bool);
 
  vtkSetMacro(ZAxisTickVisibility, bool);
  vtkGetMacro(ZAxisTickVisibility, bool);
  vtkBooleanMacro(ZAxisTickVisibility, bool);


  vtkSetMacro(XAxisMinorTickVisibility, bool);
  vtkGetMacro(XAxisMinorTickVisibility, bool);
  vtkBooleanMacro(XAxisMinorTickVisibility, bool);
 
  vtkSetMacro(YAxisMinorTickVisibility, bool);
  vtkGetMacro(YAxisMinorTickVisibility, bool);
  vtkBooleanMacro(YAxisMinorTickVisibility, bool);
 
  vtkSetMacro(ZAxisMinorTickVisibility, bool);
  vtkGetMacro(ZAxisMinorTickVisibility, bool);
  vtkBooleanMacro(ZAxisMinorTickVisibility, bool);


  vtkSetMacro(DrawXGridlines, bool);
  vtkGetMacro(DrawXGridlines, bool);
  vtkBooleanMacro(DrawXGridlines, bool);
 
  vtkSetMacro(DrawYGridlines, bool);
  vtkGetMacro(DrawYGridlines, bool);
  vtkBooleanMacro(DrawYGridlines, bool);
 
  vtkSetMacro(DrawZGridlines, bool);
  vtkGetMacro(DrawZGridlines, bool);
  vtkBooleanMacro(DrawZGridlines, bool);


  vtkSetMacro(DrawXInnerGridlines, bool);
  vtkGetMacro(DrawXInnerGridlines, bool);
  vtkBooleanMacro(DrawXInnerGridlines, bool);
 
  vtkSetMacro(DrawYInnerGridlines, bool);
  vtkGetMacro(DrawYInnerGridlines, bool);
  vtkBooleanMacro(DrawYInnerGridlines, bool);
 
  vtkSetMacro(DrawZInnerGridlines, bool);
  vtkGetMacro(DrawZInnerGridlines, bool);
  vtkBooleanMacro(DrawZInnerGridlines, bool);


  vtkSetMacro(DrawXGridpolys, bool);
  vtkGetMacro(DrawXGridpolys, bool);
  vtkBooleanMacro(DrawXGridpolys, bool);
 
  vtkSetMacro(DrawYGridpolys, bool);
  vtkGetMacro(DrawYGridpolys, bool);
  vtkBooleanMacro(DrawYGridpolys, bool);
 
  vtkSetMacro(DrawZGridpolys, bool);
  vtkGetMacro(DrawZGridpolys, bool);
  vtkBooleanMacro(DrawZGridpolys, bool);


  vtkTextProperty* GetTitleTextProperty(int);
  void SetXAxesTitleProperty(vtkTextProperty*);
  vtkTextProperty* GetXAxesTitleProperty();
  void SetYAxesTitleProperty(vtkTextProperty*);
  vtkTextProperty* GetYAxesTitleProperty();
  void SetZAxesTitleProperty(vtkTextProperty*);
  vtkTextProperty* GetZAxesTitleProperty();


  vtkTextProperty* GetLabelTextProperty(int);
  void SetXAxesLabelProperty(vtkTextProperty*);
  vtkTextProperty* GetXAxesLabelProperty();
  void SetYAxesLabelProperty(vtkTextProperty*);
  vtkTextProperty* GetYAxesLabelProperty();
  void SetZAxesLabelProperty(vtkTextProperty*);
  vtkTextProperty* GetZAxesLabelProperty();


  void SetXAxesLinesProperty(vtkProperty*);
  vtkProperty* GetXAxesLinesProperty();
  void SetYAxesLinesProperty(vtkProperty*);
  vtkProperty* GetYAxesLinesProperty();
  void SetZAxesLinesProperty(vtkProperty*);
  vtkProperty* GetZAxesLinesProperty();


  void SetXAxesGridlinesProperty(vtkProperty*);
  vtkProperty* GetXAxesGridlinesProperty();
  void SetYAxesGridlinesProperty(vtkProperty*);
  vtkProperty* GetYAxesGridlinesProperty();
  void SetZAxesGridlinesProperty(vtkProperty*);
  vtkProperty* GetZAxesGridlinesProperty();


  void SetXAxesInnerGridlinesProperty(vtkProperty*);
  vtkProperty* GetXAxesInnerGridlinesProperty();
  void SetYAxesInnerGridlinesProperty(vtkProperty*);
  vtkProperty* GetYAxesInnerGridlinesProperty();
  void SetZAxesInnerGridlinesProperty(vtkProperty*);
  vtkProperty* GetZAxesInnerGridlinesProperty();


  void SetXAxesGridpolysProperty(vtkProperty*);
  vtkProperty* GetXAxesGridpolysProperty();
  void SetYAxesGridpolysProperty(vtkProperty*);
  vtkProperty* GetYAxesGridpolysProperty();
  void SetZAxesGridpolysProperty(vtkProperty*);
  vtkProperty* GetZAxesGridpolysProperty();
 
  enum TickLocation
  {
    VTK_TICKS_INSIDE = 0,
    VTK_TICKS_OUTSIDE = 1,
    VTK_TICKS_BOTH = 2
  };


  vtkSetClampMacro(TickLocation, int, VTK_TICKS_INSIDE, VTK_TICKS_BOTH);
  vtkGetMacro(TickLocation, int);
 
  void SetTickLocationToInside() { this->SetTickLocation(VTK_TICKS_INSIDE); }
  void SetTickLocationToOutside() { this->SetTickLocation(VTK_TICKS_OUTSIDE); }
  void SetTickLocationToBoth() { this->SetTickLocation(VTK_TICKS_BOTH); }
 
  void SetLabelScaling(bool, int, int, int);


  void SetUseTextActor3D(bool enable);
  bool GetUseTextActor3D();


  void SetUse2DMode(bool enable);
  bool GetUse2DMode();

  void SetSaveTitlePosition(int val);


  vtkSetVector6Macro(OrientedBounds, double);
  vtkGetVector6Macro(OrientedBounds, double);


  vtkSetMacro(UseOrientedBounds, bool);
  vtkGetMacro(UseOrientedBounds, bool);


  vtkSetVector3Macro(AxisBaseForX, double);
  vtkGetVector3Macro(AxisBaseForX, double);


  vtkSetVector3Macro(AxisBaseForY, double);
  vtkGetVector3Macro(AxisBaseForY, double);


  vtkSetVector3Macro(AxisBaseForZ, double);
  vtkGetVector3Macro(AxisBaseForZ, double);


  vtkSetVector3Macro(AxisOrigin, double);
  vtkGetVector3Macro(AxisOrigin, double);


  vtkSetMacro(UseAxisOrigin, bool);
  vtkGetMacro(UseAxisOrigin, bool);


  vtkSetMacro(GridLineLocation, int);
  vtkGetMacro(GridLineLocation, int);


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


  vtkSetMacro(CenterStickyAxes, bool);
  vtkGetMacro(CenterStickyAxes, bool);
  vtkBooleanMacro(CenterStickyAxes, bool);
 
  enum GridVisibility
  {
    VTK_GRID_LINES_ALL = 0,
    VTK_GRID_LINES_CLOSEST = 1,
    VTK_GRID_LINES_FURTHEST = 2
  };
 
protected:
  vtkCubeAxesActor();
  ~vtkCubeAxesActor() override;

  void ComputeStickyAxesBoundingSphere(
    vtkViewport* viewport, const double bounds[6], double sphereCenter[3], double& sphereRadius);

  void GetViewportLimitedBounds(vtkViewport* viewport, double bounds[6]);

  static void GetBoundsPointBits(
    unsigned int pointIndex, unsigned int& xBit, unsigned int& yBit, unsigned int& zBit);

  static void GetBoundsPoint(unsigned int pointIndex, const double bounds[6], double point[3]);
 
  int LabelExponent(double min, double max);
 
  int Digits(double min, double max);
 
  double MaxOf(double, double);
  double MaxOf(double, double, double, double);
 
  double FFix(double);
  double FSign(double, double);
  int FRound(double fnt);
  int GetNumTicks(double range, double fxt);
 
  void UpdateLabels(vtkAxisActor** axis, int index);
 
  vtkSmartPointer<vtkCamera> Camera;
 
  int FlyMode = VTK_FLY_CLOSEST_TRIAD;
 
  // Expose internally closest axis index computation
  int FindClosestAxisIndex(double pts[8][3]);
 
  // Expose internally furthest axis index computation
  int FindFurtherstAxisIndex(double pts[8][3]);
 
  // Expose internally the boundary edge fly mode axis index computation
  void FindBoundaryEdge(int& indexOfAxisX, int& indexOfAxisY, int& indexOfAxisZ, double pts[8][3]);

  void UpdateGridLineVisibility(int axisIndex);
 
  // VTK_ALL_GRID_LINES      0
  // VTK_CLOSEST_GRID_LINES  1
  // VTK_FURTHEST_GRID_LINES 2
  int GridLineLocation = VTK_GRID_LINES_ALL;

  bool StickyAxes = false;

  bool CenterStickyAxes = true;

  bool EnableDistanceLOD = true;

  double DistanceLODThreshold = 0.8;

  bool EnableViewAngleLOD = true;

  double ViewAngleLODThreshold = 0.2;
 
  enum NumberOfAlignedAxis
  {
    NUMBER_OF_ALIGNED_AXIS = 4
  };


  vtkAxisActor* XAxes[NUMBER_OF_ALIGNED_AXIS];
  vtkAxisActor* YAxes[NUMBER_OF_ALIGNED_AXIS];
  vtkAxisActor* ZAxes[NUMBER_OF_ALIGNED_AXIS];
 
  bool RebuildAxes = true;
 
  char* XTitle = nullptr;
  char* XUnits = nullptr;
  char* YTitle = nullptr;
  char* YUnits = nullptr;
  char* ZTitle = nullptr;
  char* ZUnits = nullptr;
 
  char* ActualXLabel = nullptr;
  char* ActualYLabel = nullptr;
  char* ActualZLabel = nullptr;
 
  int TickLocation = VTK_TICKS_INSIDE;
 
  bool XAxisVisibility = true;
  bool YAxisVisibility = true;
  bool ZAxisVisibility = true;
 
  bool XAxisTickVisibility = true;
  bool YAxisTickVisibility = true;
  bool ZAxisTickVisibility = true;
 
  bool XAxisMinorTickVisibility = true;
  bool YAxisMinorTickVisibility = true;
  bool ZAxisMinorTickVisibility = true;
 
  bool XAxisLabelVisibility = true;
  bool YAxisLabelVisibility = true;
  bool ZAxisLabelVisibility = true;
 
  bool DrawXGridlines = false;
  bool DrawYGridlines = false;
  bool DrawZGridlines = false;
 
  bool DrawXInnerGridlines = false;
  bool DrawYInnerGridlines = false;
  bool DrawZInnerGridlines = false;
 
  bool DrawXGridpolys = false;
  bool DrawYGridpolys = false;
  bool DrawZGridpolys = false;
 
  char* XLabelFormat = nullptr;
  char* YLabelFormat = nullptr;
  char* ZLabelFormat = nullptr;
 
  double CornerOffset = 0.0;
 
  int Inertia = 1;
 
  int RenderCount = 0;
 
  int InertiaLocs[3] = { -1, -1, -1 };
 
  bool RenderSomething = false;
 
  vtkNew<vtkTextProperty> TitleTextProperty[3];
  vtkSmartPointer<vtkStringArray> AxisLabels[3];
  vtkNew<vtkTextProperty> LabelTextProperty[3];
 
  vtkNew<vtkProperty> XAxesLinesProperty;
  vtkNew<vtkProperty> YAxesLinesProperty;
  vtkNew<vtkProperty> ZAxesLinesProperty;
  vtkNew<vtkProperty> XAxesGridlinesProperty;
  vtkNew<vtkProperty> YAxesGridlinesProperty;
  vtkNew<vtkProperty> ZAxesGridlinesProperty;
  vtkNew<vtkProperty> XAxesInnerGridlinesProperty;
  vtkNew<vtkProperty> YAxesInnerGridlinesProperty;
  vtkNew<vtkProperty> ZAxesInnerGridlinesProperty;
  vtkNew<vtkProperty> XAxesGridpolysProperty;
  vtkNew<vtkProperty> YAxesGridpolysProperty;
  vtkNew<vtkProperty> ZAxesGridpolysProperty;
 
  double RenderedBounds[6] = { -1.0, 1.0, -1.0, 1.0, -1.0, 1.0 };
  double OrientedBounds[6] = { -1.0, 1.0, -1.0, 1.0, -1.0, 1.0 };
  bool UseOrientedBounds = false;
 
  double AxisOrigin[3] = { 0.0, 0.0, 0.0 };
  bool UseAxisOrigin = false;
 
  double AxisBaseForX[3] = { 1.0, 0.0, 0.0 };
  double AxisBaseForY[3] = { 0.0, 1.0, 0.0 };
  double AxisBaseForZ[3] = { 0.0, 0.0, 1.0 };
 
private:
  vtkCubeAxesActor(const vtkCubeAxesActor&) = delete;
  void operator=(const vtkCubeAxesActor&) = delete;
 
  vtkSetStringMacro(ActualXLabel);
  vtkSetStringMacro(ActualYLabel);
  vtkSetStringMacro(ActualZLabel);
 
  vtkTimeStamp BuildTime;
  bool LastUseOrientedBounds = false;
  int LastXPow = 0;
  int LastYPow = 0;
  int LastZPow = 0;
 
  int UserXPow = 0;
  int UserYPow = 0;
  int UserZPow = 0;
 
  bool AutoLabelScaling = true;
 
  int LastXAxisDigits = 3;
  int LastYAxisDigits = 3;
  int LastZAxisDigits = 3;
 
  double LastXRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
  double LastYRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
  double LastZRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
  double LastBounds[6] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX, VTK_DOUBLE_MAX, VTK_DOUBLE_MAX,
    VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
 
  int LastFlyMode = -1;
 
  int RenderAxesX[NUMBER_OF_ALIGNED_AXIS] = { 0, 1, 2, 3 };
  int RenderAxesY[NUMBER_OF_ALIGNED_AXIS] = { 0, 1, 2, 3 };
  int RenderAxesZ[NUMBER_OF_ALIGNED_AXIS] = { 0, 1, 2, 3 };
 
  int NumberOfAxesX = 1;
  int NumberOfAxesY = 1;
  int NumberOfAxesZ = 1;
 
  bool MustAdjustXValue = false;
  bool MustAdjustYValue = false;
  bool MustAdjustZValue = false;
 
  bool ForceXLabelReset = false;
  bool ForceYLabelReset = false;
  bool ForceZLabelReset = false;
 
  double XAxisRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
  double YAxisRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
  double ZAxisRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
 
  double LabelScale = -1.0;
  double TitleScale = -1.0;
 
  double ScreenSize = 10.0;
  double LabelOffset = 20.0;
  double TitleOffset[2] = { 20.0, 20.0 };


  double MajorStart[3] = { 0.0, 0.0, 0.0 };
  double DeltaMajor[3] = { 0.0, 0.0, 0.0 };
 
  int RenderGeometry(bool& initialRender, vtkViewport* viewport, bool checkAxisVisibility,
    int (vtkAxisActor::*renderMethod)(vtkViewport*));
 
  void TransformBounds(vtkViewport* viewport, const double bounds[6], double pts[8][3]);
  void AdjustAxes(double bounds[6], double xCoords[NUMBER_OF_ALIGNED_AXIS][6],
    double yCoords[NUMBER_OF_ALIGNED_AXIS][6], double zCoords[NUMBER_OF_ALIGNED_AXIS][6],
    double xRange[2], double yRange[2], double zRange[2]);
 
  bool ComputeTickSize(double bounds[6]);
  void AdjustValues(const double xRange[2], const double yRange[2], const double zRange[2]);
  void AdjustRange(const double bounds[6]);
  void BuildAxes(vtkViewport*);
  void DetermineRenderAxes(vtkViewport*);
  void SetNonDependentAttributes();
  void BuildLabels(vtkAxisActor* axes[NUMBER_OF_ALIGNED_AXIS]);
  void AdjustTicksComputeRange(
    vtkAxisActor* axes[NUMBER_OF_ALIGNED_AXIS], double rangeMin, double rangeMax);
 
  void AutoScale(vtkViewport* viewport);
  void AutoScale(vtkViewport* viewport, vtkAxisActor* axes[NUMBER_OF_ALIGNED_AXIS]);
  double AutoScale(vtkViewport* viewport, double screenSize, double position[3]);
};
 
VTK_ABI_NAMESPACE_END
#endif