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 
31 #ifndef vtkCategoryLegend_h
32 #define vtkCategoryLegend_h
33 
34 #include "vtkChartsCoreModule.h" // For export macro
35 #include "vtkChartLegend.h"
36 #include "vtkNew.h" // For vtkNew ivars
37 #include "vtkStdString.h" // For vtkStdString ivars
38 #include "vtkVector.h" // For vtkRectf
39 
40 class vtkScalarsToColors;
41 class vtkTextProperty;
42 class vtkVariantArray;
43 
44 class VTKCHARTSCORE_EXPORT vtkCategoryLegend: public vtkChartLegend
45 {
46 public:
48  static vtkCategoryLegend* New();
49 
53  enum {
54  VERTICAL = 0,
55  HORIZONTAL
56  };
57 
61  bool Paint(vtkContext2D *painter) override;
62 
67  vtkRectf GetBoundingRect(vtkContext2D* painter) override;
68 
70 
75  virtual void SetScalarsToColors(vtkScalarsToColors* stc);
76  virtual vtkScalarsToColors * GetScalarsToColors();
78 
80 
86  vtkGetMacro(Values, vtkVariantArray*);
87  vtkSetMacro(Values, vtkVariantArray*);
89 
91 
94  virtual void SetTitle(const vtkStdString &title);
95  virtual vtkStdString GetTitle();
97 
99 
102  vtkGetMacro(OutlierLabel, vtkStdString);
103  vtkSetMacro(OutlierLabel, vtkStdString);
105 
106 protected:
108  ~vtkCategoryLegend() override;
109 
117 
118 private:
119  vtkCategoryLegend(const vtkCategoryLegend &) = delete;
120  void operator=(const vtkCategoryLegend &) = delete;
121 };
122 
123 #endif
vtkStdString.h
vtkChartLegend::New
static vtkChartLegend * New()
Creates a 2D Chart object.
vtkCategoryLegend::HasOutliers
bool HasOutliers
Definition: vtkCategoryLegend.h:110
vtkChartLegend
draw the chart legend
Definition: vtkChartLegend.h:42
vtkVector.h
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:46
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:58
vtkCategoryLegend::Values
vtkVariantArray * Values
Definition: vtkCategoryLegend.h:116
vtkChartLegend::GetBoundingRect
virtual vtkRectf GetBoundingRect(vtkContext2D *painter)
Request the space the legend requires to be drawn.
vtkCategoryLegend::ScalarsToColors
vtkScalarsToColors * ScalarsToColors
Definition: vtkCategoryLegend.h:112
vtkX3D::title
Definition: vtkX3D.h:500
vtkCategoryLegend::TitleWidthOffset
float TitleWidthOffset
Definition: vtkCategoryLegend.h:111
vtkNew< vtkTextProperty >
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:66
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:39
vtkNew.h
vtkCategoryLegend::TitleProperties
vtkNew< vtkTextProperty > TitleProperties
Definition: vtkCategoryLegend.h:115
vtkChartLegend.h
vtkCategoryLegend
Legend item to display categorical data.
Definition: vtkCategoryLegend.h:44
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:40
vtkChartLegend::Paint
bool Paint(vtkContext2D *painter) override
Paint event for the axis, called whenever the axis needs to be drawn.
vtkRectf
Definition: vtkRect.h:332
vtkCategoryLegend::Title
vtkStdString Title
Definition: vtkCategoryLegend.h:114
vtkCategoryLegend::OutlierLabel
vtkStdString OutlierLabel
Definition: vtkCategoryLegend.h:113