VTK  9.2.6
vtkPlotBar.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPlotBar.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
24
25#ifndef vtkPlotBar_h
26#define vtkPlotBar_h
27
28#include "vtkChartsCoreModule.h" // For export macro
29#include "vtkPlot.h"
30#include "vtkSmartPointer.h" // Needed to hold ColorSeries
31
32class vtkContext2D;
33class vtkTable;
34class vtkPoints2D;
35class vtkStdString;
36class vtkColorSeries;
39
40class vtkPlotBarPrivate;
41
42class VTKCHARTSCORE_EXPORT vtkPlotBar : public vtkPlot
43{
44public:
45 vtkTypeMacro(vtkPlotBar, vtkPlot);
46 void PrintSelf(ostream& os, vtkIndent indent) override;
47
51 enum
52 {
55 };
56
60 static vtkPlotBar* New();
61
65 bool Paint(vtkContext2D* painter) override;
66
73 bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;
74
76
79 void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a) override;
80 void SetColor(double r, double g, double b) override;
81 void GetColor(double rgb[3]) override;
83
85
88 void SetWidth(float _arg) override
89 {
90 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting Width to " << _arg);
91 if (this->Width != _arg)
92 {
93 this->Width = _arg;
94 this->Modified();
95 }
96 }
97
98
100
103 float GetWidth() override
104 {
105 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning Width of "
106 << this->Width);
107 return this->Width;
108 }
109
110
112
118 vtkSetMacro(Offset, float);
119 vtkGetMacro(Offset, float);
121
123
127 virtual void SetOrientation(int orientation);
128 vtkGetMacro(Orientation, int);
130
134 virtual void GetBounds(double bounds[4], bool unscaled);
135
139 void GetBounds(double bounds[4]) override;
140
144 void GetUnscaledInputBounds(double bounds[4]) override;
145
149 void SetInputArray(int index, const vtkStdString& name) override;
150
154 void SetColorSeries(vtkColorSeries* colorSeries);
155
160
162
168
174
176
179 vtkSetMacro(ScalarVisibility, bool);
180 vtkGetMacro(ScalarVisibility, bool);
181 vtkBooleanMacro(ScalarVisibility, bool);
183
185
188 vtkSetMacro(EnableOpacityMapping, bool);
189 vtkGetMacro(EnableOpacityMapping, bool);
190 vtkBooleanMacro(EnableOpacityMapping, bool);
192
194
200 void SelectColorArray(const vtkStdString& arrayName);
202
207
212
216 virtual void SetGroupName(const vtkStdString& name);
217
222
228 const vtkVector2d& plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override;
229
233 bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;
234
243 vtkIdType* segmentIndex) override;
245
250
254 void GetDataBounds(double bounds[2]);
255
262 bool UpdateCache() override;
263
264protected:
266 ~vtkPlotBar() override;
267
271 virtual bool CacheRequiresUpdate() override;
272
277
278 float Width;
279 float Offset;
280
282
287
289
298
299 bool LogX;
300 bool LogY;
301
302private:
303 vtkPlotBar(const vtkPlotBar&) = delete;
304 void operator=(const vtkPlotBar&) = delete;
305
306 vtkPlotBarPrivate* Private;
307};
308
309#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:34
const char * GetClassName() const
Return the class name as a string.
virtual void Modified()
Update the modification time for this object.
virtual void SetLookupTable(vtkScalarsToColors *lut)
Specify a lookup table for the mapper to use.
float Width
Definition vtkPlotBar.h:278
int Orientation
Definition vtkPlotBar.h:281
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.
void SetColor(double r, double g, double b) override
Set the plot color.
vtkSmartPointer< vtkScalarsToColors > LookupTable
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:292
virtual bool CacheRequiresUpdate() override
Test if the internal cache requires an update.
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:293
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:103
bool UpdateCache() override
Update the internal cache.
bool ScalarVisibility
Lookup Table for coloring bars by scalar value.
Definition vtkPlotBar.h:294
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:296
virtual void GetBounds(double bounds[4], bool unscaled)
A helper used by both GetUnscaledBounds and GetBounds(double[4]).
~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:276
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:295
void GetColor(double rgb[3]) override
Set the plot color.
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:286
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
float Offset
Definition vtkPlotBar.h:279
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:88
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.
represent and manipulate 2D points
Definition vtkPoints2D.h:34
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:68
dynamic, self-adjusting array of unsigned char
int vtkIdType
Definition vtkType.h:332
#define max(a, b)