vtkLegendScaleActor.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 vtkLegendScaleActor_h
#define vtkLegendScaleActor_h
 
#include "vtkDeprecation.h" // for deprecation
#include "vtkProp.h"
#include "vtkRenderingAnnotationModule.h" // For export macro
#include "vtkWrappingHints.h"             // For VTK_MARSHALAUTO
 
#include "vtkNew.h" // for vtkNew
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAxisActor2D;
class vtkProperty2D;
class vtkTextProperty;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkActor2D;
class vtkTextMapper;
class vtkPoints;
class vtkCoordinate;
class vtkAxisGridActorInternal;
 
class VTKRENDERINGANNOTATION_EXPORT VTK_MARSHALAUTO vtkLegendScaleActor : public vtkProp
{
public:
  static vtkLegendScaleActor* New();


  vtkTypeMacro(vtkLegendScaleActor, vtkProp);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum AttributeLocation
  {
    DISTANCE = 0,
    COORDINATES = 1,
    XY_COORDINATES = COORDINATES
  };


  vtkSetClampMacro(LabelMode, int, DISTANCE, COORDINATES);
  vtkGetMacro(LabelMode, int);
  void SetLabelModeToDistance() { this->SetLabelMode(DISTANCE); }
  VTK_DEPRECATED_IN_9_4_0("This class can now determine current plane. Please use the generic "
                          "SetLabelModeToCoordinates instead.")
  void SetLabelModeToXYCoordinates() { this->SetLabelMode(XY_COORDINATES); }
  void SetLabelModeToCoordinates() { this->SetLabelMode(COORDINATES); }


  vtkSetMacro(RightAxisVisibility, vtkTypeBool);
  vtkGetMacro(RightAxisVisibility, vtkTypeBool);
  vtkBooleanMacro(RightAxisVisibility, vtkTypeBool);
  vtkSetMacro(TopAxisVisibility, vtkTypeBool);
  vtkGetMacro(TopAxisVisibility, vtkTypeBool);
  vtkBooleanMacro(TopAxisVisibility, vtkTypeBool);
  vtkSetMacro(LeftAxisVisibility, vtkTypeBool);
  vtkGetMacro(LeftAxisVisibility, vtkTypeBool);
  vtkBooleanMacro(LeftAxisVisibility, vtkTypeBool);
  vtkSetMacro(BottomAxisVisibility, vtkTypeBool);
  vtkGetMacro(BottomAxisVisibility, vtkTypeBool);
  vtkBooleanMacro(BottomAxisVisibility, vtkTypeBool);


  vtkSetMacro(LegendVisibility, vtkTypeBool);
  vtkGetMacro(LegendVisibility, vtkTypeBool);
  vtkBooleanMacro(LegendVisibility, vtkTypeBool);


  void AllAxesOn();
  void AllAxesOff();


  void AllAnnotationsOn();
  void AllAnnotationsOff();


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


  vtkSetClampMacro(RightBorderOffset, int, 5, VTK_INT_MAX);
  vtkGetMacro(RightBorderOffset, int);


  vtkSetClampMacro(TopBorderOffset, int, 5, VTK_INT_MAX);
  vtkGetMacro(TopBorderOffset, int);


  vtkSetClampMacro(LeftBorderOffset, int, 5, VTK_INT_MAX);
  vtkGetMacro(LeftBorderOffset, int);


  vtkSetClampMacro(BottomBorderOffset, int, 5, VTK_INT_MAX);
  vtkGetMacro(BottomBorderOffset, int);


  vtkSetClampMacro(CornerOffsetFactor, double, 1.0, 10.0);
  vtkGetMacro(CornerOffsetFactor, double);


  void SetNotation(int notation);
  int GetNotation();


  void SetPrecision(int val);
  int GetPrecision();


  void SetNumberOfHorizontalLabels(int val);
  int GetNumberOfHorizontalLabels();


  void SetNumberOfVerticalLabels(int val);
  int GetNumberOfVerticalLabels();


  vtkSetVector3Macro(Origin, double);
  vtkGetVector3Macro(Origin, double);


  vtkGetObjectMacro(LegendTitleProperty, vtkTextProperty);
  vtkGetObjectMacro(LegendLabelProperty, vtkTextProperty);

  void SetAxesTextProperty(vtkTextProperty* property);

  void SetAxesProperty(vtkProperty2D* property);

  vtkProperty2D* GetAxesProperty();

  void SetUseFontSizeFromProperty(bool sizeFromProp);

  VTK_DEPRECATED_IN_9_4_0(
    "This does not respect the number of labels. Please use SetSnapToGrid instead.")
  void SetAdjustLabels(bool adjust);

  void SetSnapToGrid(bool snap);


  vtkGetObjectMacro(RightAxis, vtkAxisActor2D);
  vtkGetObjectMacro(TopAxis, vtkAxisActor2D);
  vtkGetObjectMacro(LeftAxis, vtkAxisActor2D);
  vtkGetObjectMacro(BottomAxis, vtkAxisActor2D);


  virtual void BuildRepresentation(vtkViewport* viewport);
  void GetActors2D(vtkPropCollection*) override;
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOverlay(vtkViewport*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
 
protected:
  vtkLegendScaleActor();
  ~vtkLegendScaleActor() override;
 
  int LabelMode = DISTANCE;
  int RightBorderOffset = 50;
  int TopBorderOffset = 30;
  int LeftBorderOffset = 50;
  int BottomBorderOffset = 30;
  double CornerOffsetFactor = 2.;
 
  // The four axes around the borders of the renderer
  vtkNew<vtkAxisActor2D> RightAxis;
  vtkNew<vtkAxisActor2D> TopAxis;
  vtkNew<vtkAxisActor2D> LeftAxis;
  vtkNew<vtkAxisActor2D> BottomAxis;
 
  // Support for grid
  vtkNew<vtkAxisGridActorInternal> GridActor;
  vtkNew<vtkPolyDataMapper2D> GridMapper;
  bool GridVisibility = false;
 
  // Control the display of the axes
  vtkTypeBool RightAxisVisibility = 1;
  vtkTypeBool TopAxisVisibility = 1;
  vtkTypeBool LeftAxisVisibility = 1;
  vtkTypeBool BottomAxisVisibility = 1;
 
  // Support for the legend.
  vtkTypeBool LegendVisibility = 1;
  vtkNew<vtkPolyData> Legend;
  vtkNew<vtkPoints> LegendPoints;
  vtkNew<vtkPolyDataMapper2D> LegendMapper;
  vtkNew<vtkActor2D> LegendActor;
  vtkNew<vtkTextMapper> LabelMappers[6];
  vtkNew<vtkActor2D> LabelActors[6];
  vtkNew<vtkTextProperty> LegendTitleProperty;
  vtkNew<vtkTextProperty> LegendLabelProperty;
  vtkNew<vtkCoordinate> Coordinate;
 
  vtkTimeStamp BuildTime;
 
private:
  vtkLegendScaleActor(const vtkLegendScaleActor&) = delete;
  void operator=(const vtkLegendScaleActor&) = delete;

  void UpdateAxisRange(vtkAxisActor2D* axis, vtkViewport* viewport, bool invert = false);
 
  double Origin[3] = { 0, 0, 0 };
};
 
VTK_ABI_NAMESPACE_END
#endif