VTK  9.7.1
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 
16 #ifndef vtkPlotBox_h
17 #define vtkPlotBox_h
18 
19 #include "vtkChartsCoreModule.h" // For export macro
20 #include "vtkPlot.h"
21 #include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
22 
23 VTK_ABI_NAMESPACE_BEGIN
24 class vtkBrush;
25 class vtkTextProperty;
26 class vtkTable;
27 class vtkStdString;
28 class vtkScalarsToColors;
29 
30 class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlotBox : public vtkPlot
31 {
32 public:
33  vtkTypeMacro(vtkPlotBox, vtkPlot);
34  void PrintSelf(ostream& os, vtkIndent indent) override;
35 
39  static vtkPlotBox* New();
40 
44  bool Paint(vtkContext2D* painter) override;
45 
52  bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
53 
55 
58  void SetInputData(vtkTable* table) override;
59  void SetInputData(vtkTable* table, const vtkStdString&, const vtkStdString&) override
60  {
61  this->SetInputData(table);
62  }
64 
69  vtkStringArray* GetLabels() override;
70 
76  vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
77  vtkVector2f* location, vtkIdType* segmentId) override;
79 
81 
84  void SetLookupTable(vtkScalarsToColors* lut);
85  vtkScalarsToColors* GetLookupTable();
87 
91  void SetColumnColor(const vtkStdString& colName, double* rgb);
92 
97  virtual void CreateDefaultLookupTable();
98 
100 
103  vtkGetMacro(BoxWidth, float);
104  vtkSetMacro(BoxWidth, float);
106 
108 
111  vtkGetObjectMacro(TitleProperties, vtkTextProperty);
113 
120  bool UpdateCache() override;
121 
122 protected:
123  vtkPlotBox();
124  ~vtkPlotBox() override;
125 
126  void DrawBoxPlot(int, unsigned char*, double, vtkContext2D*);
127 
129 
132  class Private;
133  Private* Storage;
135 
139  float BoxWidth;
140 
145 
150 
151 private:
152  vtkPlotBox(const vtkPlotBox&) = delete;
153  void operator=(const vtkPlotBox&) = delete;
154 };
155 
156 VTK_ABI_NAMESPACE_END
157 #endif // vtkPlotBox_h
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:27
void SetInputData(vtkTable *table, const vtkStdString &, const vtkStdString &) override
This is a convenience function to set the input table.
Definition: vtkPlotBox.h:59
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:139
a vtkAbstractArray subclass for strings
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.
int vtkIdType
Definition: vtkType.h:363
vtkTextProperty * TitleProperties
Text properties for the plot title.
Definition: vtkPlotBox.h:149
Superclass for mapping scalar values to colors.
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:49
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:30
a simple class to control print indentation
Definition: vtkIndent.h:28
virtual vtkStringArray * GetLabels()
Get the plot labels.
virtual bool UpdateCache()
Update the internal cache.
Definition: vtkPlot.h:455
Abstract class for 2D plots.
Definition: vtkPlot.h:43
Class for drawing box plots.
Definition: vtkPlotBox.h:30
represent text properties.
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:59
virtual void SetInputData(vtkTable *table)
This is a convenience function to set the input table and the x, y column for the plot...
#define VTK_MARSHALAUTO
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:144
Private * Storage
Definition: vtkPlotBox.h:132