vtkRadialGridActor2D.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 vtkRadialGridActor2D_h
#define vtkRadialGridActor2D_h

#include "vtkActor2D.h"
#include "vtkRenderingAnnotationModule.h" // For export macro

#include "vtkSetGet.h"       // for macros
#include "vtkSmartPointer.h" // for smart pointer

#include <vector>

VTK_ABI_NAMESPACE_BEGIN

class vtkAxisActor2D;
class vtkPoints;
class vtkTextProperty;

class VTKRENDERINGANNOTATION_EXPORT vtkRadialGridActor2D : public vtkActor2D
{
public:
  static vtkRadialGridActor2D* New();
  vtkTypeMacro(vtkRadialGridActor2D, vtkActor2D);

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

  int RenderOverlay(vtkViewport* viewport) override;

  int RenderOpaqueGeometry(vtkViewport*) override { return 1; }

  vtkTypeBool HasOpaqueGeometry() override { return 0; }

  vtkTypeBool HasTranslucentPolygonalGeometry() override { return 0; }

  void GetActors2D(vtkPropCollection* pc) override;


  void SetTextProperty(vtkTextProperty* property);
  vtkTextProperty* GetTextProperty();


  vtkSetClampMacro(NumberOfAxes, int, 0, VTK_INT_MAX);
  vtkGetMacro(NumberOfAxes, int);


  vtkSetMacro(StartAngle, double);
  vtkGetMacro(StartAngle, double);


  vtkSetMacro(EndAngle, double);
  vtkGetMacro(EndAngle, double);


  vtkSetVector2Macro(Origin, double);
  vtkGetVector2Macro(Origin, double);


  vtkSetClampMacro(NumberOfTicks, int, 2, VTK_INT_MAX);
  vtkGetMacro(NumberOfTicks, int);


  vtkSetClampMacro(AxesViewportLength, double, 2, VTK_DOUBLE_MAX);
  vtkGetMacro(AxesViewportLength, double);


  vtkPoints* GetFirstAxesPoints();
  vtkPoints* GetLastAxesPoints();

protected:
  vtkRadialGridActor2D();
  ~vtkRadialGridActor2D() override;

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

  void ComputeAxisRelativeEndPosition(int index, double position[2]);

  double GetAxisAngle(int index);

  void ComputeAxisWorldRange(vtkViewport* viewport, vtkAxisActor2D* axis, double range[2]);

  void UpdateAxisTitle(vtkAxisActor2D* axis, double angle);

  void SetupAxes(vtkViewport* viewport);

  std::vector<vtkSmartPointer<vtkAxisActor2D>> Axes;

  int NumberOfAxes = 6;
  int NumberOfTicks = 6;
  double StartAngle = 0.;
  double EndAngle = 90.;
  // relative display coordinates
  double Origin[2] = { 0.5, 0.5 };
  // display coordinantes
  double AxesViewportLength = 100;

  vtkSmartPointer<vtkTextProperty> TextProperty;
};

VTK_ABI_NAMESPACE_END

#endif