VTK
vtkCategoryLegend.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCategoryLegend.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
28 #ifndef vtkCategoryLegend_h
29 #define vtkCategoryLegend_h
30 
31 #include "vtkChartsCoreModule.h" // For export macro
32 #include "vtkChartLegend.h"
33 #include "vtkNew.h" // For vtkNew ivars
34 #include "vtkStdString.h" // For vtkStdString ivars
35 #include "vtkVector.h" // For vtkRectf
36 
37 class vtkScalarsToColors;
38 class vtkTextProperty;
39 class vtkVariantArray;
40 
41 class VTKCHARTSCORE_EXPORT vtkCategoryLegend: public vtkChartLegend
42 {
43 public:
45  static vtkCategoryLegend* New();
46 
50  enum {
51  VERTICAL = 0,
52  HORIZONTAL
53  };
54 
58  bool Paint(vtkContext2D *painter) override;
59 
64  vtkRectf GetBoundingRect(vtkContext2D* painter) override;
65 
67 
72  virtual void SetScalarsToColors(vtkScalarsToColors* stc);
73  virtual vtkScalarsToColors * GetScalarsToColors();
75 
77 
83  vtkGetMacro(Values, vtkVariantArray*);
84  vtkSetMacro(Values, vtkVariantArray*);
86 
88 
91  virtual void SetTitle(const vtkStdString &title);
92  virtual vtkStdString GetTitle();
94 
96 
99  vtkGetMacro(OutlierLabel, vtkStdString);
100  vtkSetMacro(OutlierLabel, vtkStdString);
102 
103 protected:
105  ~vtkCategoryLegend() override;
106 
114 
115 private:
116  vtkCategoryLegend(const vtkCategoryLegend &) = delete;
117  void operator=(const vtkCategoryLegend &) = delete;
118 };
119 
120 #endif
vtkStdString OutlierLabel
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
An array holding vtkVariants.
virtual vtkRectf GetBoundingRect(vtkContext2D *painter)
Request the space the legend requires to be drawn.
vtkScalarsToColors * ScalarsToColors
Superclass for mapping scalar values to colors.
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:52
vtkVariantArray * Values
static vtkChartLegend * New()
Creates a 2D Chart object.
represent text properties.
Legend item to display categorical data.
draw the chart legend
bool Paint(vtkContext2D *painter) override
Paint event for the axis, called whenever the axis needs to be drawn.
vtkNew< vtkTextProperty > TitleProperties