VTK  9.3.0
vtkPlotBar.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 vtkPlotBar_h
17#define vtkPlotBar_h
18
19#include "vtkChartsCoreModule.h" // For export macro
20#include "vtkPlot.h"
21#include "vtkSmartPointer.h" // Needed to hold ColorSeries
22
23VTK_ABI_NAMESPACE_BEGIN
24class vtkContext2D;
25class vtkTable;
26class vtkPoints2D;
27class vtkStdString;
28class vtkColorSeries;
31
32class vtkPlotBarPrivate;
33
34class VTKCHARTSCORE_EXPORT vtkPlotBar : public vtkPlot
35{
36public:
37 vtkTypeMacro(vtkPlotBar, vtkPlot);
38 void PrintSelf(ostream& os, vtkIndent indent) override;
39
43 enum
44 {
45 VERTICAL = 0,
46 HORIZONTAL
47 };
48
52 static vtkPlotBar* New();
53
57 bool Paint(vtkContext2D* painter) override;
58
65 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
66
70 void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a) override;
71
73
76 void SetColorF(double r, double g, double b, double a) override;
77 void SetColorF(double r, double g, double b) override;
78
79 VTK_DEPRECATED_IN_9_3_0("Please use unambiguous SetColorF method instead.")
80 void SetColor(double r, double g, double b) override { this->SetColorF(r, g, b); };
82
84
87 void GetColorF(double rgb[3]) override;
88
89 VTK_DEPRECATED_IN_9_3_0("Please use unambiguous GetColorF method instead.")
90 void GetColor(double rgb[3]) override { this->GetColorF(rgb); };
92
94
97 void SetWidth(float _arg) override
98 {
99 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting Width to " << _arg);
100 if (this->Width != _arg)
101 {
102 this->Width = _arg;
103 this->Modified();
104 }
105 }
107
109
112 float GetWidth() override
113 {
114 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning Width of "
115 << this->Width);
116 return this->Width;
117 }
119
121
127 vtkSetMacro(Offset, float);
128 vtkGetMacro(Offset, float);
130
132
136 virtual void SetOrientation(int orientation);
137 vtkGetMacro(Orientation, int);
139
143 virtual void GetBounds(double bounds[4], bool unscaled);
144
148 void GetBounds(double bounds[4]) override;
149
153 void GetUnscaledInputBounds(double bounds[4]) override;
154
158 void SetInputArray(int index, const vtkStdString& name) override;
159
163 void SetColorSeries(vtkColorSeries* colorSeries);
164
169
171
177
183
185
188 vtkSetMacro(ScalarVisibility, bool);
189 vtkGetMacro(ScalarVisibility, bool);
190 vtkBooleanMacro(ScalarVisibility, bool);
192
194
197 vtkSetMacro(EnableOpacityMapping, bool);
198 vtkGetMacro(EnableOpacityMapping, bool);
199 vtkBooleanMacro(EnableOpacityMapping, bool);
201
203
209 void SelectColorArray(const vtkStdString& arrayName);
211
216
221
225 virtual void SetGroupName(const vtkStdString& name);
226
231
237 const vtkVector2d& plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override;
238
242 bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;
243
252 vtkIdType* segmentIndex) override;
254
259
263 void GetDataBounds(double bounds[2]);
264
271 bool UpdateCache() override;
272
273protected:
275 ~vtkPlotBar() override;
276
280 bool CacheRequiresUpdate() override;
281
286
287 float Width;
288 float Offset;
289
291
296
298
307
308 bool LogX;
309 bool LogY;
310
311private:
312 vtkPlotBar(const vtkPlotBar&) = delete;
313 void operator=(const vtkPlotBar&) = delete;
314
315 vtkPlotBarPrivate* Private;
316};
317
318VTK_ABI_NAMESPACE_END
319#endif // vtkPlotBar_h
stores a list of colors.
Class for drawing 2D primitives to a graphical context.
a simple class to control print indentation
Definition vtkIndent.h:29
const char * GetClassName() const
Return the class name as a string.
virtual void Modified()
Update the modification time for this object.
Class for drawing an XY plot given two columns from a vtkTable.
Definition vtkPlotBar.h:35
virtual void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
float Width
Definition vtkPlotBar.h:287
int Orientation
Definition vtkPlotBar.h:290
vtkStringArray * GetLabels() override
Get the plot labels.
vtkStdString GetTooltipLabel(const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override
Generate and return the tooltip label string for this plot The segmentIndex is implemented here.
void GetUnscaledInputBounds(double bounds[4]) override
Get un-log-scaled bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).
int GetBarsCount()
Get amount of plotted bars.
void GetBounds(double bounds[4]) override
Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).
static vtkPlotBar * New()
Creates a 2D Chart object.
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)
vtkSmartPointer< vtkScalarsToColors > LookupTable
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:301
void SelectColorArray(vtkIdType arrayNum)
When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use f...
vtkSmartPointer< vtkUnsignedCharArray > Colors
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:302
void GetColorF(double rgb[3]) override
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
virtual vtkScalarsToColors * GetLookupTable()
Specify a lookup table for the mapper to use.
vtkStdString GetColorArrayName()
Get the array name to color by.
vtkColorSeries * GetColorSeries()
Get the color series used if when this is a stacked bar plot.
virtual void SetGroupName(const vtkStdString &name)
Set the group name of the bar chart - can be displayed on the X axis.
float GetWidth() override
Get the width of the line.
Definition vtkPlotBar.h:112
bool UpdateCache() override
Update the internal cache.
bool ScalarVisibility
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:303
void SetInputArray(int index, const vtkStdString &name) override
When used to set additional arrays, stacked bars are created.
vtkStdString ColorArrayName
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:305
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)
virtual void GetBounds(double bounds[4], bool unscaled)
A helper used by both GetUnscaledBounds and GetBounds(double[4]).
void SetColorF(double r, double g, double b) override
Set the plot color with floating values (comprised between 0.0 and 1.0)
~vtkPlotBar() override
void SetColorSeries(vtkColorSeries *colorSeries)
Set the color series to use if this becomes a stacked bar plot.
vtkPoints2D * Points
Store a well packed set of XY coordinates for this data series.
Definition vtkPlotBar.h:285
void SelectColorArray(const vtkStdString &arrayName)
When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use f...
bool EnableOpacityMapping
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:304
vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &, vtkVector2f *location, vtkIdType *segmentIndex) override
Function to query a plot for the nearest point to the specified coordinate.
vtkSmartPointer< vtkColorSeries > ColorSeries
The color series to use if this becomes a stacked bar.
Definition vtkPlotBar.h:295
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
float Offset
Definition vtkPlotBar.h:288
bool CacheRequiresUpdate() override
Test if the internal cache requires an update.
virtual vtkStdString GetGroupName()
Get the group name of the bar char - can be displayed on the X axis.
bool Paint(vtkContext2D *painter) override
Paint event for the XY plot, called whenever the chart needs to be drawn.
void GetDataBounds(double bounds[2])
Get the data bounds for this mapper as (Xmin,Xmax).
virtual void SetOrientation(int orientation)
Set/get the orientation of the bars.
virtual void CreateDefaultLookupTable()
Create default lookup table.
bool SelectPoints(const vtkVector2f &min, const vtkVector2f &max) override
Select all points in the specified rectangle.
bool PaintLegend(vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line ...
void SetWidth(float _arg) override
Set the width of the line.
Definition vtkPlotBar.h:97
Abstract class for 2D plots.
Definition vtkPlot.h:44
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:26
Superclass for mapping scalar values to colors.
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:59
dynamic, self-adjusting array of unsigned char
#define VTK_DEPRECATED_IN_9_3_0(reason)
int vtkIdType
Definition vtkType.h:315
#define max(a, b)