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
41class vtkTextProperty;
42class vtkVariantArray;
43
44class VTKCHARTSCORE_EXPORT vtkCategoryLegend: public vtkChartLegend
45{
46public:
49
53 enum {
54 VERTICAL = 0,
55 HORIZONTAL
56 };
57
61 virtual bool Paint(vtkContext2D *painter);
62
68
70
78
80
86 vtkGetMacro(Values, vtkVariantArray*);
89
91
94 virtual void SetTitle(const vtkStdString &title);
97
99
102 vtkGetMacro(OutlierLabel, vtkStdString);
103 vtkSetMacro(OutlierLabel, vtkStdString);
105
106protected:
109
117
118private:
119 vtkCategoryLegend(const vtkCategoryLegend &) VTK_DELETE_FUNCTION;
120 void operator=(const vtkCategoryLegend &) VTK_DELETE_FUNCTION;
121};
122
123#endif
Legend item to display categorical data.
vtkScalarsToColors * ScalarsToColors
virtual ~vtkCategoryLegend()
virtual vtkStdString GetTitle()
vtkNew< vtkTextProperty > TitleProperties
virtual bool Paint(vtkContext2D *painter)
Paint the legend into a rectangle defined by the bounds.
virtual vtkScalarsToColors * GetScalarsToColors()
static vtkCategoryLegend * New()
vtkVariantArray * Values
virtual vtkRectf GetBoundingRect(vtkContext2D *painter)
Compute and return the lower left corner of this legend, along with its width and height.
vtkStdString OutlierLabel
virtual void SetScalarsToColors(vtkScalarsToColors *stc)
Get/Set the vtkScalarsToColors used to draw this legend.
virtual void SetTitle(const vtkStdString &title)
Get/set the title text of the legend.
draw the chart legend
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:58
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
represent text properties.
An array holding vtkVariants.
@ title
Definition: vtkX3D.h:500
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.