VTK  9.4.20251007
vtkPlotStacked.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
15
16#ifndef vtkPlotStacked_h
17#define vtkPlotStacked_h
18
19#include "vtkChartsCoreModule.h" // For export macro
20#include "vtkPlot.h"
21#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
22
23VTK_ABI_NAMESPACE_BEGIN
24class vtkChartXY;
25class vtkContext2D;
26class vtkTable;
27class vtkPoints2D;
28class vtkStdString;
29class vtkImageData;
30class vtkColorSeries;
31
32class vtkPlotStackedPrivate;
33
34class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlotStacked : public vtkPlot
35{
36public:
37 vtkTypeMacro(vtkPlotStacked, vtkPlot);
38 void PrintSelf(ostream& os, vtkIndent indent) override;
39
44
48 void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a) override;
49
51
54 void SetColorF(double r, double g, double b, double a) override;
55 void SetColorF(double r, double g, double b) override;
56
57 VTK_DEPRECATED_IN_9_3_0("Please use unambiguous SetColorF method instead.")
58 void SetColor(double r, double g, double b) override { this->SetColorF(r, g, b); }
60
62
65 void GetColorF(double rgb[3]) override;
66
67 VTK_DEPRECATED_IN_9_3_0("Please use unambiguous GetColorF method instead.")
68 void GetColor(double rgb[3]) override { this->GetColorF(rgb); }
70
74 bool Paint(vtkContext2D* painter) override;
75
82 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
83
87 void GetBounds(double bounds[4]) override;
88
93 void GetUnscaledInputBounds(double bounds[4]) override;
94
98 void SetInputArray(int index, const vtkStdString& name) override;
99
103 void SetColorSeries(vtkColorSeries* colorSeries);
104
109
114
120 vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
121 vtkVector2f* location, vtkIdType* segmentId) override;
123
127 bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;
128
135 bool UpdateCache() override;
136
137protected:
139 ~vtkPlotStacked() override;
140
144 bool CacheRequiresUpdate() override;
145
146 // Descript:
147 // For stacked plots the Extent data must be greater than (or equal to) the
148 // base data. Ensure that this is true
149 void FixExtent();
150
156
162
168
169 bool LogX, LogY;
170
175
176private:
177 vtkPlotStacked(const vtkPlotStacked&) = delete;
178 void operator=(const vtkPlotStacked&) = delete;
179
180 vtkPlotStackedPrivate* Private;
181};
182
183VTK_ABI_NAMESPACE_END
184#endif // vtkPlotStacked_h
Factory class for drawing XY charts.
Definition vtkChartXY.h:49
stores a list of colors.
Class for drawing 2D primitives to a graphical context.
dynamic, self-adjusting array of vtkIdType
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:29
vtkIdTypeArray * ExtentBadPoints
An array containing the indices of all the "bad extent points", meaning any x, y pair that has an inf...
void GetColorF(double rgb[3]) override
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
vtkStringArray * GetLabels() override
Get the plot labels.
bool PaintLegend(vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
Paint legend event for the Stacked plot, called whenever the legend needs the plot items symbol/mark/...
static vtkPlotStacked * New()
Creates a Stacked Plot Object.
bool SelectPoints(const vtkVector2f &min, const vtkVector2f &max) override
Select all points in the specified rectangle.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a) override
Set the plot color with integer values (comprised between 0 and 255)
~vtkPlotStacked() override
void GetColor(double rgb[3]) override
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
void SetInputArray(int index, const vtkStdString &name) override
When used to set additional arrays, stacked bars are created.
void GetUnscaledInputBounds(double bounds[4]) override
Get the unscaled input bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).
bool Paint(vtkContext2D *painter) override
Paint event for the Stacked plot, called whenever the chart needs to be drawn.
void GetBounds(double bounds[4]) override
Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).
bool CacheRequiresUpdate() override
Test if the internal cache requires an update.
vtkSmartPointer< vtkColorSeries > ColorSeries
The color series to use for each series.
void SetColorF(double r, double g, double b, double a) override
Set the plot color with floating values (comprised between 0.0 and 1.0)
bool UpdateCache() override
Update the internal cache.
void SetColorF(double r, double g, double b) override
Set the plot color with floating values (comprised between 0.0 and 1.0)
vtkColorSeries * GetColorSeries()
Get the color series used if when this is a stacked bar plot.
vtkIdTypeArray * BaseBadPoints
An array containing the indices of all the "bad base points", meaning any x, y pair that has an infin...
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.
void SetColorSeries(vtkColorSeries *colorSeries)
Set the color series to use if this becomes a stacked bar plot.
void CalculateLogSeries()
Handle calculating the log of the x or y series if necessary.
virtual void SetColorF(double r, double g, double b, double a)
Set the plot color with floating values (comprised between 0.0 and 1.0)
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.
virtual void GetColorF(double rgb[3])
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
represent and manipulate 2D points
Definition vtkPoints2D.h:27
Hold a reference to a vtkObjectBase instance.
Wrapper around std::string to keep symbols short.
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition vtkTable.h:60
#define VTK_DEPRECATED_IN_9_3_0(reason)
int vtkIdType
Definition vtkType.h:315
#define VTK_MARSHALAUTO
#define max(a, b)