vtkGridAxesActor3D.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkGridAxesActor3D_h
#define vtkGridAxesActor3D_h

#include "vtkProp3D.h"
#include "vtkRenderingGridAxesModule.h" //needed for exports

#include "vtkGridAxesHelper.h" //  needed for vtkGridAxesHelper.
#include "vtkNew.h"            // needed for vtkNew.
#include "vtkWrappingHints.h"

#include <functional> // for std::function

VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkGridAxesActor2D;
class vtkProperty;
class vtkTextProperty;

class VTKRENDERINGGRIDAXES_EXPORT VTK_MARSHALAUTO vtkGridAxesActor3D : public vtkProp3D
{
public:
  static vtkGridAxesActor3D* New();
  vtkTypeMacro(vtkGridAxesActor3D, vtkProp3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ShallowCopy(vtkProp* prop) override;


  vtkSetVector6Macro(GridBounds, double);
  vtkGetVector6Macro(GridBounds, double);


  virtual void SetFaceMask(unsigned int mask);
  vtkGetMacro(FaceMask, unsigned int);


  virtual void SetLabelMask(unsigned int mask);
  unsigned int GetLabelMask();

  void GetActors(vtkPropCollection*) override;

  void UpdateGeometry(vtkViewport* vp);


  vtkSetMacro(LabelUniqueEdgesOnly, bool);
  vtkGetMacro(LabelUniqueEdgesOnly, bool);


  void SetGenerateGrid(bool val);
  bool GetGenerateGrid();
  vtkBooleanMacro(GenerateGrid, bool);


  void SetGenerateEdges(bool val);
  bool GetGenerateEdges();
  vtkBooleanMacro(GenerateEdges, bool);


  void SetGenerateTicks(bool val);
  bool GetGenerateTicks();
  vtkBooleanMacro(GenerateTicks, bool);


  void SetProperty(vtkProperty*);
  vtkProperty* GetProperty();

  //---------------------------------------------------------------------------
  // *** Properties to control the axis titles ***


  void SetTitleTextProperty(int axis, vtkTextProperty*);
  void SetXTitleTextProperty(vtkTextProperty* prop) { this->SetTitleTextProperty(0, prop); }
  void SetYTitleTextProperty(vtkTextProperty* prop) { this->SetTitleTextProperty(1, prop); }
  void SetZTitleTextProperty(vtkTextProperty* prop) { this->SetTitleTextProperty(2, prop); }
  vtkTextProperty* GetTitleTextProperty(int axis);
  vtkTextProperty* GetXTitleTextProperty() { return this->GetTitleTextProperty(0); }
  vtkTextProperty* GetYTitleTextProperty() { return this->GetTitleTextProperty(1); }
  vtkTextProperty* GetZTitleTextProperty() { return this->GetTitleTextProperty(2); }


  void SetTitle(int axis, const std::string& title);
  void SetXTitle(const std::string& title) { this->SetTitle(0, title); }
  void SetYTitle(const std::string& title) { this->SetTitle(1, title); }
  void SetZTitle(const std::string& title) { this->SetTitle(2, title); }
  const std::string& GetTitle(int axis);
  const std::string& GetXTitle() { return this->GetTitle(0); }
  const std::string& GetYTitle() { return this->GetTitle(1); }
  const std::string& GetZTitle() { return this->GetTitle(2); }


  void SetUseCustomLabels(int axis, bool val);
  void SetXUseCustomLabels(bool val) { this->SetUseCustomLabels(0, val); }
  void SetYUseCustomLabels(bool val) { this->SetUseCustomLabels(1, val); }
  void SetZUseCustomLabels(bool val) { this->SetUseCustomLabels(2, val); }
  bool GetUseCustomLabels(int axis);
  bool GetXUseCustomLabels() { return this->GetUseCustomLabels(0); }
  bool GetYUseCustomLabels() { return this->GetUseCustomLabels(1); }
  bool GetZUseCustomLabels() { return this->GetUseCustomLabels(2); }

  void SetNumberOfLabels(int axis, vtkIdType val);
  void SetNumberOfXLabels(vtkIdType val) { this->SetNumberOfLabels(0, val); }
  void SetNumberOfYLabels(vtkIdType val) { this->SetNumberOfLabels(1, val); }
  void SetNumberOfZLabels(vtkIdType val) { this->SetNumberOfLabels(2, val); }
  vtkIdType GetNumberOfLabels(int axis);
  vtkIdType GetNumberOfXLabels() { return this->GetNumberOfLabels(0); }
  vtkIdType GetNumberOfYLabels() { return this->GetNumberOfLabels(1); }
  vtkIdType GetNumberOfZLabels() { return this->GetNumberOfLabels(2); }

  void SetLabel(int axis, vtkIdType index, double value);
  void SetXLabel(vtkIdType index, double value) { this->SetLabel(0, index, value); }
  void SetYLabel(vtkIdType index, double value) { this->SetLabel(1, index, value); }
  void SetZLabel(vtkIdType index, double value) { this->SetLabel(2, index, value); }
  double GetLabel(int axis, vtkIdType index);
  double GetXLabel(vtkIdType index) { return this->GetLabel(0, index); }
  double GetYLabel(vtkIdType index) { return this->GetLabel(1, index); }
  double GetZLabel(vtkIdType index) { return this->GetLabel(2, index); }

  //---------------------------------------------------------------------------
  // *** Properties to control the axis data labels ***


  void SetLabelTextProperty(int axis, vtkTextProperty*);
  void SetXLabelTextProperty(vtkTextProperty* prop) { this->SetLabelTextProperty(0, prop); }
  void SetYLabelTextProperty(vtkTextProperty* prop) { this->SetLabelTextProperty(1, prop); }
  void SetZLabelTextProperty(vtkTextProperty* prop) { this->SetLabelTextProperty(2, prop); }
  vtkTextProperty* GetLabelTextProperty(int axis);
  vtkTextProperty* GetXLabelTextProperty() { return this->GetLabelTextProperty(0); }
  vtkTextProperty* GetYLabelTextProperty() { return this->GetLabelTextProperty(1); }
  vtkTextProperty* GetZLabelTextProperty() { return this->GetLabelTextProperty(2); }


  void SetNotation(int axis, int notation);
  void SetXNotation(int notation) { this->SetNotation(0, notation); }
  void SetYNotation(int notation) { this->SetNotation(1, notation); }
  void SetZNotation(int notation) { this->SetNotation(2, notation); }
  int GetNotation(int axis);
  int GetXNotation() { return this->GetNotation(0); }
  int GetYNotation() { return this->GetNotation(1); }
  int GetZNotation() { return this->GetNotation(2); }


  void SetPrecision(int axis, int val);
  void SetXPrecision(int val) { this->SetPrecision(0, val); }
  void SetYPrecision(int val) { this->SetPrecision(1, val); }
  void SetZPrecision(int val) { this->SetPrecision(2, val); }
  int GetPrecision(int axis);
  int GetXPrecision() { return this->GetPrecision(0); }
  int GetYPrecision() { return this->GetPrecision(1); }
  int GetZPrecision() { return this->GetPrecision(2); }


  void SetTickLabelFunction(int axis, std::function<double(double)> func);
  std::function<double(double)> GetTickLabelFunction(int axis);

  //--------------------------------------------------------------------------
  // Methods for vtkProp3D API.
  //--------------------------------------------------------------------------


  double* GetBounds() override;
  using Superclass::GetBounds;

  virtual void GetRenderedBounds(double bounds[6]);


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


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

  void ReleaseGraphicsResources(vtkWindow*) override;


  virtual void SetLabelDisplayOffset(int xoffset, int yoffset);
  virtual void SetLabelDisplayOffset(const int offset[2]);
  virtual int* GetLabelDisplayOffset() VTK_SIZEHINT(2);
  VTK_WRAPEXCLUDE virtual void GetLabelDisplayOffset(int& xoffset, int& yoffset);
  VTK_WRAPEXCLUDE virtual void GetLabelDisplayOffset(int offset[2]);

protected:
  vtkGridAxesActor3D();
  ~vtkGridAxesActor3D() override;

  virtual void Update(vtkViewport* viewport);

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

  vtkMTimeType GetBoundsMTime = 0;
  double GridBounds[6] = { -1.0, 1.0, -1.0, 1.0, -1.0, 1.0 };
  unsigned int FaceMask = 0;
  bool LabelUniqueEdgesOnly = true;
  vtkTuple<bool, 3> UseCustomLabels;
  vtkTuple<vtkNew<vtkDoubleArray>, 3> CustomLabels;
  vtkMTimeType CustomLabelsMTime = 0;

  vtkTuple<vtkNew<vtkGridAxesActor2D>, 6> GridAxes2DActors;

  bool ForceOpaque = false;
};

VTK_ABI_NAMESPACE_END
#endif