VTK  9.3.0
vtkPlot.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
21#ifndef vtkPlot_h
22#define vtkPlot_h
23
24#include "vtkChartsCoreModule.h" // For export macro
25#include "vtkContextItem.h"
26#include "vtkContextPolygon.h" // For vtkContextPolygon
27#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
28#include "vtkRect.h" // For vtkRectd ivar
29#include "vtkSmartPointer.h" // Needed to hold SP ivars
30#include "vtkStdString.h" // Needed to hold TooltipLabelFormat ivar
31
32VTK_ABI_NAMESPACE_BEGIN
33class vtkVariant;
34class vtkTable;
35class vtkIdTypeArray;
37class vtkPen;
38class vtkBrush;
39class vtkAxis;
40class vtkStringArray;
42
43class VTKCHARTSCORE_EXPORT vtkPlot : public vtkContextItem
44{
45public:
46 vtkTypeMacro(vtkPlot, vtkContextItem);
47 void PrintSelf(ostream& os, vtkIndent indent) override;
48
54 void Update() override;
55
57
62 vtkSetMacro(LegendVisibility, bool);
63 vtkGetMacro(LegendVisibility, bool);
64 vtkBooleanMacro(LegendVisibility, bool);
66
74 virtual bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex);
75
77
89 virtual void SetTooltipLabelFormat(const vtkStdString& label);
92
94
97 virtual void SetTooltipNotation(int notation);
98 virtual int GetTooltipNotation();
100
102
105 virtual void SetTooltipPrecision(int precision);
106 virtual int GetTooltipPrecision();
108
114 const vtkVector2d& plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex);
115
121 virtual vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
122 vtkVector2f* location, vtkIdType* segmentId);
123
127 virtual bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max);
128
132 virtual bool SelectPointsInPolygon(const vtkContextPolygon& polygon);
133
137 virtual void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
138
140
143 virtual void SetColorF(double r, double g, double b, double a);
144 virtual void SetColorF(double r, double g, double b);
145
146 // If removed, please remplace it with the following function:
147 // SetColor(unsigned char r, unsigned char g, unsigned char b)
148 // here and in the inheriting classes overriding it
149 VTK_DEPRECATED_IN_9_3_0("Please use unambiguous SetColorF method instead.")
150 virtual void SetColor(double r, double g, double b) { this->SetColorF(r, g, b); };
152
156 void GetColor(unsigned char rgb[3]);
157
159
162 virtual void GetColorF(double rgb[3]);
163
164 // If removed, please make GetColor(unsigned char rgb[3]) virtual
165 VTK_DEPRECATED_IN_9_3_0("Please use unambiguous GetColorF method instead.")
166 virtual void GetColor(double rgb[3]) { this->GetColorF(rgb); };
168
172 virtual void SetWidth(float width);
173
177 virtual float GetWidth();
178
180
183 void SetPen(vtkPen* pen);
186
188
191 void SetBrush(vtkBrush* brush);
194
196
203
205
212
216 virtual void SetLabel(const vtkStdString& label);
217
222
227 virtual void SetLabels(vtkStringArray* labels);
228
234
238 virtual int GetNumberOfLabels();
239
244
251
256
261
263
267 vtkGetMacro(UseIndexForXSeries, bool);
269
271
275 vtkSetMacro(UseIndexForXSeries, bool);
277
279
283 virtual void SetInputData(vtkTable* table);
284 virtual void SetInputData(
285 vtkTable* table, const vtkStdString& xColumn, const vtkStdString& yColumn);
286 void SetInputData(vtkTable* table, vtkIdType xColumn, vtkIdType yColumn);
288
290
295
299 virtual vtkTable* GetInput();
300
305
311 virtual void SetInputArray(int index, const vtkStdString& name);
312
314
320 vtkSetMacro(Selectable, bool);
321 vtkGetMacro(Selectable, bool);
322 vtkBooleanMacro(Selectable, bool);
324
326
331 virtual void SetSelection(vtkIdTypeArray* id);
332 vtkGetObjectMacro(Selection, vtkIdTypeArray);
334
336
339 vtkGetObjectMacro(XAxis, vtkAxis);
340 virtual void SetXAxis(vtkAxis* axis);
342
344
347 vtkGetObjectMacro(YAxis, vtkAxis);
348 virtual void SetYAxis(vtkAxis* axis);
350
352
358 void SetShiftScale(const vtkRectd& shiftScale);
361
367 virtual void GetBounds(double bounds[4]) { bounds[0] = bounds[1] = bounds[2] = bounds[3] = 0.0; }
368
393 virtual void GetUnscaledInputBounds(double bounds[4])
394 {
395 // Implemented here by calling GetBounds() to support plot
396 // subclasses that do no log-scaling or plot orientation.
397 return this->GetBounds(bounds);
398 }
399
401
405 virtual void SetProperty(const vtkStdString& property, const vtkVariant& var);
406 virtual vtkVariant GetProperty(const vtkStdString& property);
408
410
414 static bool ClampPos(double pos[2], double bounds[4]);
415 virtual bool ClampPos(double pos[2]);
417
421 bool Hit(const vtkContextMouseEvent& mouse) override;
422
429 virtual bool UpdateCache() { return true; }
430
436 vtkDataArray* points, vtkDataArray* selectedPoints, vtkIdTypeArray* selectedIds);
437
438protected:
440 ~vtkPlot() override;
441
445 vtkStdString GetNumber(double position, vtkAxis* axis);
446
448
452 virtual void TransformScreenToData(const vtkVector2f& in, vtkVector2f& out);
453 virtual void TransformDataToScreen(const vtkVector2f& in, vtkVector2f& out);
454 virtual void TransformScreenToData(double inX, double inY, double& outX, double& outY);
455 virtual void TransformDataToScreen(double inX, double inY, double& outX, double& outY);
457
461 virtual bool CacheRequiresUpdate();
462
467
472
477
483
489
494
499
504
510
516
521
526
531
536
542
548
551
556
558
559private:
560 vtkPlot(const vtkPlot&) = delete;
561 void operator=(const vtkPlot&) = delete;
562};
563
564VTK_ABI_NAMESPACE_END
565#endif // vtkPlot_h
Proxy object to connect input/output ports.
takes care of drawing 2D axes
Definition vtkAxis.h:61
provides a brush that fills shapes drawn by vtkContext2D.
Definition vtkBrush.h:30
Class for drawing 2D primitives to a graphical context.
base class for items that are part of a vtkContextScene.
Abstract class for 2D context mappers.
data structure to represent mouse events.
abstract superclass for arrays of numeric data
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition vtkIndent.h:29
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition vtkPen.h:29
Abstract class for 2D plots.
Definition vtkPlot.h:44
bool UseIndexForXSeries
Use the Y array index for the X value.
Definition vtkPlot.h:509
virtual vtkStdString GetLabel()
Get the label of this plot.
virtual int GetTooltipPrecision()
Sets/gets the tooltip precision.
vtkContextMapper2D * GetData()
Get the data object that the plot will draw.
vtkRectd ShiftScale
The current shift in origin and scaling factor applied to the plot.
Definition vtkPlot.h:555
virtual int GetTooltipNotation()
Sets/gets the tooltip notation style.
virtual vtkTable * GetInput()
Get the input table used by the plot.
void SetSelectionPen(vtkPen *pen)
Set/get the vtkBrush object that controls how this plot fills selected shapes.
int TooltipPrecision
Definition vtkPlot.h:550
vtkSmartPointer< vtkStringArray > IndexedLabels
Holds Labels when they're auto-created.
Definition vtkPlot.h:503
void SetIndexedLabels(vtkStringArray *labels)
Set indexed labels for the plot.
virtual void SetInputData(vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
This is a convenience function to set the input table and the x, y column for the plot.
virtual bool SelectPoints(const vtkVector2f &min, const vtkVector2f &max)
Select all points in the specified rectangle.
vtkAxis * XAxis
The X axis associated with this plot.
Definition vtkPlot.h:530
virtual vtkStdString GetTooltipLabel(const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored,...
static void FilterSelectedPoints(vtkDataArray *points, vtkDataArray *selectedPoints, vtkIdTypeArray *selectedIds)
Utility function that fills up selectedPoints with tuples from points.
vtkPen * GetPen()
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
virtual void SetWidth(float width)
@
virtual int GetNumberOfLabels()
Get the number of labels associated with this plot.
~vtkPlot() override
virtual vtkStdString GetTooltipLabelFormat()
Sets/gets a printf-style string to build custom tooltip labels from.
virtual vtkVariant GetProperty(const vtkStdString &property)
A General setter/getter that should be overridden.
virtual void SetInputData(vtkTable *table)
This is a convenience function to set the input table and the x, y column for the plot.
virtual void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a)
Set the plot color with integer values (comprised between 0 and 255)
vtkStdString GetLabel(vtkIdType index)
Get the label at the specified index.
bool LegendVisibility
Definition vtkPlot.h:557
virtual void SetInputArray(int index, const vtkStdString &name)
Convenience function to set the input arrays.
virtual void GetUnscaledInputBounds(double bounds[4])
Provide un-log-scaled bounds for the plot inputs.
Definition vtkPlot.h:393
vtkAlgorithmOutput * GetInputConnection()
Get the input connection used by the plot.
vtkPen * GetSelectionPen()
Set/get the vtkBrush object that controls how this plot fills selected shapes.
virtual void TransformScreenToData(double inX, double inY, double &outX, double &outY)
Transform the mouse event in the control-points space.
void SetBrush(vtkBrush *brush)
Set/get the vtkBrush object that controls how this plot fills shapes.
vtkIdTypeArray * Selection
Selected indices for the table the plot is rendering.
Definition vtkPlot.h:525
virtual vtkStringArray * GetLabels()
Get the plot labels.
virtual void SetLabel(const vtkStdString &label)
Set the label of this plot.
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)
vtkSmartPointer< vtkBrush > SelectionBrush
This object stores the vtkBrush that controls how the selected elements of the plot are drawn.
Definition vtkPlot.h:488
virtual void GetBounds(double bounds[4])
Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
Definition vtkPlot.h:367
virtual void SetTooltipLabelFormat(const vtkStdString &label)
Sets/gets a printf-style string to build custom tooltip labels from.
virtual void SetXAxis(vtkAxis *axis)
Get/set the X axis associated with this plot.
virtual bool UpdateCache()
Update the internal cache.
Definition vtkPlot.h:429
vtkAxis * YAxis
The X axis associated with this plot.
Definition vtkPlot.h:535
vtkStdString TooltipDefaultLabelFormat
The default printf-style string to build custom tooltip labels from.
Definition vtkPlot.h:547
vtkSmartPointer< vtkPen > SelectionPen
This object stores the vtkPen that controls how the selected elements of the plot are drawn.
Definition vtkPlot.h:482
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...
void SetSelectionBrush(vtkBrush *brush)
Set/get the vtkBrush object that controls how this plot fills selected shapes.
virtual void SetProperty(const vtkStdString &property, const vtkVariant &var)
A General setter/getter that should be overridden.
void GetColor(unsigned char rgb[3])
Get the plot color as integer rgb values (comprised between 0 and 255)
void SetPen(vtkPen *pen)
Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkStdString TooltipLabelFormat
A printf-style string to build custom tooltip labels from.
Definition vtkPlot.h:541
bool Selectable
Whether plot points can be selected or not.
Definition vtkPlot.h:520
int TooltipNotation
Definition vtkPlot.h:549
vtkRectd GetShiftScale()
Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1....
virtual vtkStringArray * GetIndexedLabels()
Get the indexed labels array.
virtual void TransformDataToScreen(double inX, double inY, double &outX, double &outY)
Transform the mouse event in the control-points space.
vtkSmartPointer< vtkContextMapper2D > Data
This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
Definition vtkPlot.h:515
vtkSmartPointer< vtkStringArray > Labels
Plot labels, used by legend.
Definition vtkPlot.h:493
void SetInputData(vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
This is a convenience function to set the input table and the x, y column for the plot.
void Update() override
Perform any updates to the item that may be necessary before rendering.
virtual void SetTooltipPrecision(int precision)
Sets/gets the tooltip precision.
void SetShiftScale(const vtkRectd &shiftScale)
Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1....
static bool ClampPos(double pos[2], double bounds[4])
Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped,...
virtual void TransformScreenToData(const vtkVector2f &in, vtkVector2f &out)
Transform the mouse event in the control-points space.
virtual void SetYAxis(vtkAxis *axis)
Get/set the Y axis associated with this plot.
bool Hit(const vtkContextMouseEvent &mouse) override
Returns true if the supplied x, y coordinate is inside the item.
vtkTimeStamp BuildTime
The point cache is marked dirty until it has been initialized.
Definition vtkPlot.h:466
vtkBrush * GetSelectionBrush()
Set/get the vtkBrush object that controls how this plot fills selected shapes.
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.
vtkSmartPointer< vtkStringArray > AutoLabels
Holds Labels when they're auto-created.
Definition vtkPlot.h:498
virtual void TransformDataToScreen(const vtkVector2f &in, vtkVector2f &out)
Transform the mouse event in the control-points space.
virtual bool ClampPos(double pos[2])
Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped,...
vtkStdString GetNumber(double position, vtkAxis *axis)
Get the properly formatted number for the supplied position and axis.
virtual void SetInputConnection(vtkAlgorithmOutput *input)
This is a convenience function to set the input connection for the plot.
vtkSmartPointer< vtkBrush > Brush
This object stores the vtkBrush that controls how the plot is drawn.
Definition vtkPlot.h:476
virtual void SetColorF(double r, double g, double b)
Set the plot color with floating values (comprised between 0.0 and 1.0)
virtual bool CacheRequiresUpdate()
Test if the internal cache requires an update.
virtual bool SelectPointsInPolygon(const vtkContextPolygon &polygon)
Select all points in the specified polygon.
vtkBrush * GetBrush()
Set/get the vtkBrush object that controls how this plot fills shapes.
virtual void SetSelection(vtkIdTypeArray *id)
Sets the list of points that must be selected.
vtkSmartPointer< vtkPen > Pen
This object stores the vtkPen that controls how the plot is drawn.
Definition vtkPlot.h:471
virtual float GetWidth()
Get the width of the line.
virtual void GetColorF(double rgb[3])
Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
virtual void SetLabels(vtkStringArray *labels)
Set the plot labels, these are used for stacked chart variants, with the index referring to the stack...
virtual void SetTooltipNotation(int notation)
Sets/gets the tooltip notation style.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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
record modification and/or execution time
A type representing the union of many types.
Definition vtkVariant.h:53
#define VTK_DEPRECATED_IN_9_3_0(reason)
int vtkIdType
Definition vtkType.h:315
#define max(a, b)