vtkLegendScaleActor.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkLegendScaleActor.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkLegendScaleActor_h
#define vtkLegendScaleActor_h
 
#include "vtkCoordinate.h" // For vtkViewportCoordinateMacro
#include "vtkProp.h"
#include "vtkRenderingAnnotationModule.h" // For export macro
 
class vtkAxisActor2D;
class vtkTextProperty;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkActor2D;
class vtkTextMapper;
class vtkPoints;
class vtkCoordinate;
 
class VTKRENDERINGANNOTATION_EXPORT vtkLegendScaleActor : public vtkProp
{
public:
  static vtkLegendScaleActor* New();
 
 
  vtkTypeMacro(vtkLegendScaleActor, vtkProp);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum AttributeLocation
  {
    DISTANCE = 0,
    XY_COORDINATES = 1
  };
 
 
  vtkSetClampMacro(LabelMode, int, DISTANCE, XY_COORDINATES);
  vtkGetMacro(LabelMode, int);
  void SetLabelModeToDistance() { this->SetLabelMode(DISTANCE); }
  void SetLabelModeToXYCoordinates() { this->SetLabelMode(XY_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();
 
 
  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);
 
 
  vtkGetObjectMacro(LegendTitleProperty, vtkTextProperty);
  vtkGetObjectMacro(LegendLabelProperty, vtkTextProperty);
 
 
  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;
  int RightBorderOffset;
  int TopBorderOffset;
  int LeftBorderOffset;
  int BottomBorderOffset;
  double CornerOffsetFactor;
 
  // The four axes around the borders of the renderer
  vtkAxisActor2D* RightAxis;
  vtkAxisActor2D* TopAxis;
  vtkAxisActor2D* LeftAxis;
  vtkAxisActor2D* BottomAxis;
 
  // Control the display of the axes
  vtkTypeBool RightAxisVisibility;
  vtkTypeBool TopAxisVisibility;
  vtkTypeBool LeftAxisVisibility;
  vtkTypeBool BottomAxisVisibility;
 
  // Support for the legend.
  vtkTypeBool LegendVisibility;
  vtkPolyData* Legend;
  vtkPoints* LegendPoints;
  vtkPolyDataMapper2D* LegendMapper;
  vtkActor2D* LegendActor;
  vtkTextMapper* LabelMappers[6];
  vtkActor2D* LabelActors[6];
  vtkTextProperty* LegendTitleProperty;
  vtkTextProperty* LegendLabelProperty;
  vtkCoordinate* Coordinate;
 
  vtkTimeStamp BuildTime;
 
private:
  vtkLegendScaleActor(const vtkLegendScaleActor&) = delete;
  void operator=(const vtkLegendScaleActor&) = delete;
};
 
#endif