VTK
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 
28 #ifndef vtkPlotBox_h
29 #define vtkPlotBox_h
30 
31 #include "vtkChartsCoreModule.h" // For export macro
32 #include "vtkPlot.h"
33 #include "vtkStdString.h" // For vtkStdString ivars
34 
35 class vtkBrush;
36 class vtkTextProperty;
37 class vtkTable;
38 class vtkStdString;
39 class vtkScalarsToColors;
40 
41 class VTKCHARTSCORE_EXPORT vtkPlotBox : public vtkPlot
42 {
43 public:
44  vtkTypeMacro(vtkPlotBox, vtkPlot);
45  void PrintSelf(ostream &os, vtkIndent indent) override;
46 
50  static vtkPlotBox* New();
51 
57  void Update() override;
58 
62  bool Paint(vtkContext2D *painter) override;
63 
70  bool PaintLegend(vtkContext2D *painter, const vtkRectf& rect,
71  int legendIndex) override;
72 
74 
77  void SetInputData(vtkTable *table) override;
78  void SetInputData(vtkTable *table, const vtkStdString&,
79  const vtkStdString&) override
80  {
81  this->SetInputData(table);
82  }
84 
89  vtkStringArray *GetLabels() override;
90 
97  const vtkVector2f& tolerance,
98  vtkVector2f* location) override;
99 
101 
104  void SetLookupTable(vtkScalarsToColors *lut);
105  vtkScalarsToColors *GetLookupTable();
107 
111  void SetColumnColor(const vtkStdString& colName, double *rgb);
112 
117  virtual void CreateDefaultLookupTable();
118 
120 
123  vtkGetMacro(BoxWidth, float);
124  vtkSetMacro(BoxWidth, float);
126 
128 
131  vtkGetObjectMacro(TitleProperties, vtkTextProperty);
133 
134 protected:
135  vtkPlotBox();
136  ~vtkPlotBox() override;
137 
138  void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
139 
143  bool UpdateTableCache(vtkTable *table);
144 
146 
149  class Private;
150  Private* Storage;
152 
157 
161  float BoxWidth;
162 
167 
172 
173 private:
174  vtkPlotBox(const vtkPlotBox &) = delete;
175  void operator=(const vtkPlotBox &) = delete;
176 
177 };
178 
179 #endif //vtkPlotBox_h
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:40
void SetInputData(vtkTable *table, const vtkStdString &, const vtkStdString &) override
This is a convenience function to set the input table.
Definition: vtkPlotBox.h:78
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual bool PaintLegend(vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line dra...
virtual bool Paint(vtkContext2D *painter)
Paint event for the item, called whenever the item needs to be drawn.
float BoxWidth
Width of boxes.
Definition: vtkPlotBox.h:161
record modification and/or execution time
Definition: vtkTimeStamp.h:35
a vtkAbstractArray subclass for strings
int vtkIdType
Definition: vtkType.h:347
vtkTextProperty * TitleProperties
Text properties for the plot title.
Definition: vtkPlotBox.h:171
Superclass for mapping scalar values to colors.
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:58
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:40
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual vtkStringArray * GetLabels()
Get the plot labels.
Abstract class for 2D plots.
Definition: vtkPlot.h:52
Class for drawing box plots.
Definition: vtkPlotBox.h:41
represent text properties.
virtual vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
Function to query a plot for the nearest point to the specified coordinate.
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:68
virtual void SetInputData(vtkTable *table)
This is a convenience function to set the input table and the x, y column for the plot...
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
vtkScalarsToColors * LookupTable
Lookup Table for coloring points by scalar value.
Definition: vtkPlotBox.h:166
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
Definition: vtkPlotBox.h:156
virtual void Update()
Perform any updates to the item that may be necessary before rendering.
Private * Storage
Definition: vtkPlotBox.h:149