vtkChartLegend.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 vtkChartLegend_h
#define vtkChartLegend_h
 
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkContextItem.h"
#include "vtkNew.h"           // For vtkNew
#include "vtkRect.h"          // For vtkRectf return value
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkChart;
class vtkPen;
class vtkBrush;
class vtkTextProperty;
 
class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkChartLegend : public vtkContextItem
{
public:
  vtkTypeMacro(vtkChartLegend, vtkContextItem);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkChartLegend* New();
 
 
  vtkSetVector2Macro(Point, float);
 
 
  vtkGetVector2Macro(Point, float);
 
  enum
  {
    LEFT = 0,
    CENTER,
    RIGHT,
    TOP,
    BOTTOM,
    CUSTOM
  };
 
  void SetPoint(const vtkVector2f& point);
 
  const vtkVector2f& GetPointVector();
 
 
  vtkSetMacro(PointIsNormalized, bool);
  vtkGetMacro(PointIsNormalized, bool);
  vtkBooleanMacro(PointIsNormalized, bool);
 
 
  vtkSetMacro(HorizontalAlignment, int);
 
 
  vtkGetMacro(HorizontalAlignment, int);
 
 
  vtkSetMacro(VerticalAlignment, int);
 
 
  vtkGetMacro(VerticalAlignment, int);
 
 
  vtkSetMacro(Padding, int);
 
 
  vtkGetMacro(Padding, int);
 
 
  vtkSetMacro(SymbolWidth, int);
 
 
  vtkGetMacro(SymbolWidth, int);
 
  virtual void SetLabelSize(int size);
 
  virtual int GetLabelSize();
 
 
  vtkSetMacro(Inline, bool);
  vtkGetMacro(Inline, bool);
 
 
  vtkSetMacro(DragEnabled, bool);
  vtkGetMacro(DragEnabled, bool);
 
  void SetChart(vtkChart* chart);
 
  vtkChart* GetChart();
 
  void Update() override;
 
  bool Paint(vtkContext2D* painter) override;
 
  virtual vtkRectf GetBoundingRect(vtkContext2D* painter);
 
  vtkPen* GetPen();
 
  vtkBrush* GetBrush();
 
  vtkTextProperty* GetLabelProperties();
 
 
  vtkSetMacro(CacheBounds, bool);
  vtkGetMacro(CacheBounds, bool);
  vtkBooleanMacro(CacheBounds, bool);
 
  bool Hit(const vtkContextMouseEvent& mouse) override;
 
  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
 
  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
 
  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
 
protected:
  vtkChartLegend();
  ~vtkChartLegend() override;
 
  float* Point;            // The point the legend is anchored to.
  int HorizontalAlignment; // Alignment of the legend to the point it is anchored to.
  int VerticalAlignment;   // Alignment of the legend to the point it is anchored to.
  bool PointIsNormalized;  // Allow specifying the point in normalized coordinates
 
  vtkNew<vtkPen> Pen;
 
  vtkNew<vtkBrush> Brush;
 
  vtkNew<vtkTextProperty> LabelProperties;
 
  bool DragEnabled;
 
  bool CacheBounds;
 
  int Button;
 
  vtkTimeStamp PlotTime;
  vtkTimeStamp RectTime;
 
  vtkRectf Rect;
 
  int Padding;
 
  int SymbolWidth;
 
  bool Inline;
 
  // Private storage class
  class Private;
  Private* Storage;
 
private:
  vtkChartLegend(const vtkChartLegend&) = delete;
  void operator=(const vtkChartLegend&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkChartLegend_h