vtkCategoryLegend.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 vtkCategoryLegend_h
#define vtkCategoryLegend_h

#include "vtkChartLegend.h"
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkNew.h"              // For vtkNew ivars
#include "vtkStdString.h"        // For vtkStdString ivars
#include "vtkVector.h"           // For vtkRectf
#include "vtkWrappingHints.h"    // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkScalarsToColors;
class vtkTextProperty;
class vtkVariantArray;

class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkCategoryLegend : public vtkChartLegend
{
public:
  vtkTypeMacro(vtkCategoryLegend, vtkChartLegend);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCategoryLegend* New();

  enum
  {
    VERTICAL = 0,
    HORIZONTAL
  };

  bool Paint(vtkContext2D* painter) override;

  vtkRectf GetBoundingRect(vtkContext2D* painter) override;


  vtkGetObjectMacro(ScalarsToColors, vtkScalarsToColors);
  virtual void SetScalarsToColors(vtkScalarsToColors*);


  vtkGetObjectMacro(Values, vtkVariantArray);
  virtual void SetValues(vtkVariantArray*);


  virtual void SetTitle(const vtkStdString& title);
  virtual vtkStdString GetTitle();


  vtkGetMacro(OutlierLabel, vtkStdString);
  vtkSetMacro(OutlierLabel, vtkStdString);

protected:
  vtkCategoryLegend();
  ~vtkCategoryLegend() override;

  bool HasOutliers;
  float TitleWidthOffset;
  vtkScalarsToColors* ScalarsToColors;
  vtkStdString OutlierLabel;
  vtkStdString Title;
  vtkNew<vtkTextProperty> TitleProperties;
  vtkVariantArray* Values;

private:
  vtkCategoryLegend(const vtkCategoryLegend&) = delete;
  void operator=(const vtkCategoryLegend&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif