VTK  9.1.0
vtkPlotBox.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPlotBox.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
44#ifndef vtkPlotBox_h
45#define vtkPlotBox_h
46
47#include "vtkChartsCoreModule.h" // For export macro
48#include "vtkPlot.h"
49#include "vtkStdString.h" // For vtkStdString ivars
50
51class vtkBrush;
52class vtkTextProperty;
53class vtkTable;
54class vtkStdString;
56
57class VTKCHARTSCORE_EXPORT vtkPlotBox : public vtkPlot
58{
59public:
60 vtkTypeMacro(vtkPlotBox, vtkPlot);
61 void PrintSelf(ostream& os, vtkIndent indent) override;
62
66 static vtkPlotBox* New();
67
73 void Update() override;
74
78 bool Paint(vtkContext2D* painter) override;
79
86 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
87
89
92 void SetInputData(vtkTable* table) override;
93 void SetInputData(vtkTable* table, const vtkStdString&, const vtkStdString&) override
94 {
95 this->SetInputData(table);
96 }
98
104
110 vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
111 vtkVector2f* location, vtkIdType* segmentId) override;
113
115
121
125 void SetColumnColor(const vtkStdString& colName, double* rgb);
126
132
134
137 vtkGetMacro(BoxWidth, float);
138 vtkSetMacro(BoxWidth, float);
140
142
145 vtkGetObjectMacro(TitleProperties, vtkTextProperty);
147
148protected:
150 ~vtkPlotBox() override;
151
152 void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
153
158
160
163 class Private;
164 Private* Storage;
166
171
175 float BoxWidth;
176
181
186
187private:
188 vtkPlotBox(const vtkPlotBox&) = delete;
189 void operator=(const vtkPlotBox&) = delete;
190};
191
192#endif // vtkPlotBox_h
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:97
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:73
a simple class to control print indentation
Definition: vtkIndent.h:113
Class for drawing box plots.
Definition: vtkPlotBox.h:58
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Definition: vtkPlotBox.h:180
vtkStringArray * GetLabels() override
Get the plot labels.
float BoxWidth
Width of boxes.
Definition: vtkPlotBox.h:175
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
Definition: vtkPlotBox.h:170
void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
void Update() override
Perform any updates to the item that may be necessary before rendering.
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:185
Private * Storage
Definition: vtkPlotBox.h:164
~vtkPlotBox() override
bool UpdateTableCache(vtkTable *table)
Update the table cache.
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:93
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:157
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.
Definition: vtkStdString.h:105
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:172
represent text properties.
record modification and/or execution time
Definition: vtkTimeStamp.h:52
int vtkIdType
Definition: vtkType.h:332