VTK  9.0.2
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 
25 #ifndef vtkPlotBox_h
26 #define vtkPlotBox_h
27 
28 #include "vtkChartsCoreModule.h" // For export macro
29 #include "vtkPlot.h"
30 #include "vtkStdString.h" // For vtkStdString ivars
31 
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 
54  void Update() override;
55 
59  bool Paint(vtkContext2D* painter) override;
60 
67  bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
68 
70 
73  void SetInputData(vtkTable* table) override;
74  void SetInputData(vtkTable* table, const vtkStdString&, const vtkStdString&) override
75  {
76  this->SetInputData(table);
77  }
79 
85 
93 #ifndef VTK_LEGACY_REMOVE
94  vtkIdType* segmentId) override;
95 #else
96  vtkIdType* segmentId = nullptr) override;
97 #endif // VTK_LEGACY_REMOVE
98 
99 #ifndef VTK_LEGACY_REMOVE
101 #endif // VTK_LEGACY_REMOVE
102 
104 
110 
114  void SetColumnColor(const vtkStdString& colName, double* rgb);
115 
120  virtual void CreateDefaultLookupTable();
121 
123 
126  vtkGetMacro(BoxWidth, float);
127  vtkSetMacro(BoxWidth, float);
129 
131 
134  vtkGetObjectMacro(TitleProperties, vtkTextProperty);
136 
137 protected:
139  ~vtkPlotBox() override;
140 
141  void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
142 
147 
149 
152  class Private;
153  Private* Storage;
155 
160 
164  float BoxWidth;
165 
170 
175 
176 private:
177  vtkPlotBox(const vtkPlotBox&) = delete;
178  void operator=(const vtkPlotBox&) = delete;
179 };
180 
181 #endif // vtkPlotBox_h
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:38
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:53
a simple class to control print indentation
Definition: vtkIndent.h:34
Class for drawing box plots.
Definition: vtkPlotBox.h:39
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Definition: vtkPlotBox.h:169
float BoxWidth
Width of boxes.
Definition: vtkPlotBox.h:164
vtkStringArray * GetLabels() override
Get the plot labels.
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
Definition: vtkPlotBox.h:159
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 *)
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:174
Private * Storage
Definition: vtkPlotBox.h:152
static vtkPlotBox * New()
Creates a box plot.
~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
Definition: vtkPlotBox.h:74
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()
Abstract class for 2D plots.
Definition: vtkPlot.h:47
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:35
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:63
represent text properties.
record modification and/or execution time
Definition: vtkTimeStamp.h:33
@ point
Definition: vtkX3D.h:242
@ location
Definition: vtkX3D.h:412
int vtkIdType
Definition: vtkType.h:338