VTK  9.4.20250201
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
35#ifndef vtkPlotBox_h
36#define vtkPlotBox_h
37
38#include "vtkChartsCoreModule.h" // For export macro
39#include "vtkPlot.h"
40#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
41
42VTK_ABI_NAMESPACE_BEGIN
43class vtkBrush;
44class vtkTextProperty;
45class vtkTable;
46class vtkStdString;
48
49class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlotBox : public vtkPlot
50{
51public:
52 vtkTypeMacro(vtkPlotBox, vtkPlot);
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
58 static vtkPlotBox* New();
59
63 bool Paint(vtkContext2D* painter) override;
64
71 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
72
74
77 void SetInputData(vtkTable* table) override;
78 void SetInputData(vtkTable* table, const vtkStdString&, const vtkStdString&) override
79 {
80 this->SetInputData(table);
81 }
83
89
95 vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
96 vtkVector2f* location, vtkIdType* segmentId) override;
98
100
106
110 void SetColumnColor(const vtkStdString& colName, double* rgb);
111
117
119
122 vtkGetMacro(BoxWidth, float);
123 vtkSetMacro(BoxWidth, float);
125
127
130 vtkGetObjectMacro(TitleProperties, vtkTextProperty);
132
139 bool UpdateCache() override;
140
141protected:
143 ~vtkPlotBox() override;
144
145 void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
146
148
151 class Private;
152 Private* Storage;
154
158 float BoxWidth;
159
164
169
170private:
171 vtkPlotBox(const vtkPlotBox&) = delete;
172 void operator=(const vtkPlotBox&) = delete;
173};
174
175VTK_ABI_NAMESPACE_END
176#endif // vtkPlotBox_h
provides a brush that fills shapes drawn by vtkContext2D.
Definition vtkBrush.h:90
Class for drawing 2D primitives to a graphical context.
a simple class to control print indentation
Definition vtkIndent.h:108
Class for drawing box plots.
Definition vtkPlotBox.h:50
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Definition vtkPlotBox.h:163
vtkStringArray * GetLabels() override
Get the plot labels.
float BoxWidth
Width of boxes.
Definition vtkPlotBox.h:158
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:168
Private * Storage
Definition vtkPlotBox.h:152
~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:78
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:153
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:169
represent text properties.
int vtkIdType
Definition vtkType.h:315
#define VTK_MARSHALAUTO