VTK  9.3.0
vtkPlotBox.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
3
16#ifndef vtkPlotBox_h
17#define vtkPlotBox_h
18
19#include "vtkChartsCoreModule.h" // For export macro
20#include "vtkPlot.h"
21
22VTK_ABI_NAMESPACE_BEGIN
23class vtkBrush;
24class vtkTextProperty;
25class vtkTable;
26class vtkStdString;
28
29class VTKCHARTSCORE_EXPORT vtkPlotBox : public vtkPlot
30{
31public:
32 vtkTypeMacro(vtkPlotBox, vtkPlot);
33 void PrintSelf(ostream& os, vtkIndent indent) override;
34
38 static vtkPlotBox* New();
39
43 bool Paint(vtkContext2D* painter) override;
44
51 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
52
54
57 void SetInputData(vtkTable* table) override;
58 void SetInputData(vtkTable* table, const vtkStdString&, const vtkStdString&) override
59 {
60 this->SetInputData(table);
61 }
63
69
75 vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
76 vtkVector2f* location, vtkIdType* segmentId) override;
78
80
86
90 void SetColumnColor(const vtkStdString& colName, double* rgb);
91
97
99
102 vtkGetMacro(BoxWidth, float);
103 vtkSetMacro(BoxWidth, float);
105
107
110 vtkGetObjectMacro(TitleProperties, vtkTextProperty);
112
119 bool UpdateCache() override;
120
121protected:
123 ~vtkPlotBox() override;
124
125 void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
126
128
131 class Private;
132 Private* Storage;
134
138 float BoxWidth;
139
144
149
150private:
151 vtkPlotBox(const vtkPlotBox&) = delete;
152 void operator=(const vtkPlotBox&) = delete;
153};
154
155VTK_ABI_NAMESPACE_END
156#endif // vtkPlotBox_h
provides a brush that fills shapes drawn by vtkContext2D.
Definition vtkBrush.h:30
Class for drawing 2D primitives to a graphical context.
a simple class to control print indentation
Definition vtkIndent.h:29
Class for drawing box plots.
Definition vtkPlotBox.h:30
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Definition vtkPlotBox.h:143
vtkStringArray * GetLabels() override
Get the plot labels.
float BoxWidth
Width of boxes.
Definition vtkPlotBox.h:138
void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
bool UpdateCache() override
Update the internal cache.
void DrawBoxPlot(int, unsigned char *, double, vtkContext2D *)
vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
void SetColumnColor(const vtkStdString &colName, double *rgb)
Helper function to set the color of a given column.
virtual void CreateDefaultLookupTable()
Create default lookup table.
vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId) override
Function to query a plot for the nearest point to the specified coordinate.
vtkTextProperty * TitleProperties
Text properties for the plot title.
Definition vtkPlotBox.h:148
Private * Storage
Definition vtkPlotBox.h:132
~vtkPlotBox() override
bool Paint(vtkContext2D *painter) override
Paint event for the plot, called whenever the chart needs to be drawn.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetInputData(vtkTable *table, const vtkStdString &, const vtkStdString &) override
This is a convenience function to set the input table.
Definition vtkPlotBox.h:58
void SetInputData(vtkTable *table) override
This is a convenience function to set the input table.
static vtkPlotBox * New()
Creates a box plot.
bool PaintLegend(vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line dra...
Abstract class for 2D plots.
Definition vtkPlot.h:44
virtual void SetInputData(vtkTable *table)
This is a convenience function to set the input table and the x, y column for the plot.
virtual vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
Function to query a plot for the nearest point to the specified coordinate.
Superclass for mapping scalar values to colors.
Wrapper around std::string to keep symbols short.
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition vtkTable.h:59
represent text properties.
int vtkIdType
Definition vtkType.h:315