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 
25 #ifndef vtkPlotBox_h
26 #define vtkPlotBox_h
27 
28 #include "vtkChartsCoreModule.h" // For export macro
29 #include "vtkPlot.h"
30 
31 VTK_ABI_NAMESPACE_BEGIN
32 class vtkBrush;
33 class vtkTextProperty;
34 class vtkTable;
35 class vtkStdString;
36 class vtkScalarsToColors;
37 
38 class VTKCHARTSCORE_EXPORT vtkPlotBox : public vtkPlot
39 {
40 public:
41  vtkTypeMacro(vtkPlotBox, vtkPlot);
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
47  static vtkPlotBox* New();
48 
52  bool Paint(vtkContext2D* painter) override;
53 
60  bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
61 
63 
66  void SetInputData(vtkTable* table) override;
67  void SetInputData(vtkTable* table, const vtkStdString&, const vtkStdString&) override
68  {
69  this->SetInputData(table);
70  }
72 
78 
85  vtkVector2f* location, vtkIdType* segmentId) override;
87 
89 
95 
99  void SetColumnColor(const vtkStdString& colName, double* rgb);
100 
105  virtual void CreateDefaultLookupTable();
106 
108 
111  vtkGetMacro(BoxWidth, float);
112  vtkSetMacro(BoxWidth, float);
114 
116 
119  vtkGetObjectMacro(TitleProperties, vtkTextProperty);
121 
128  bool UpdateCache() override;
129 
130 protected:
132  ~vtkPlotBox() override;
133 
134  void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
135 
137 
140  class Private;
141  Private* Storage;
143 
147  float BoxWidth;
148 
153 
158 
159 private:
160  vtkPlotBox(const vtkPlotBox&) = delete;
161  void operator=(const vtkPlotBox&) = delete;
162 };
163 
164 VTK_ABI_NAMESPACE_END
165 #endif // vtkPlotBox_h
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:39
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:59
a simple class to control print indentation
Definition: vtkIndent.h:38
Class for drawing box plots.
Definition: vtkPlotBox.h:39
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Definition: vtkPlotBox.h:152
float BoxWidth
Width of boxes.
Definition: vtkPlotBox.h:147
vtkStringArray * GetLabels() override
Get the plot labels.
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 *)
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:157
Private * Storage
Definition: vtkPlotBox.h:140
static vtkPlotBox * New()
Creates a box plot.
~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:67
void SetInputData(vtkTable *table) override
This is a convenience function to set the input table.
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...
vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
Abstract class for 2D plots.
Definition: vtkPlot.h:53
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:38
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:68
represent text properties.
@ point
Definition: vtkX3D.h:236
@ location
Definition: vtkX3D.h:406
int vtkIdType
Definition: vtkType.h:315