vtkCategoryLegend.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkCategoryLegend.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 vtkCategoryLegend_h
#define vtkCategoryLegend_h

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

class vtkScalarsToColors;
class vtkTextProperty;
class vtkVariantArray;

class VTKCHARTSCORE_EXPORT vtkCategoryLegend: public vtkChartLegend
{
public:
  vtkTypeMacro(vtkCategoryLegend, vtkChartLegend);
  static vtkCategoryLegend* New();

  enum {
    VERTICAL = 0,
    HORIZONTAL
  };

  bool Paint(vtkContext2D *painter) override;

  vtkRectf GetBoundingRect(vtkContext2D* painter) override;


  virtual void SetScalarsToColors(vtkScalarsToColors* stc);
  virtual vtkScalarsToColors * GetScalarsToColors();


  vtkGetMacro(Values, vtkVariantArray*);
  vtkSetMacro(Values, 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;
};

#endif