VTK
vtkPlot.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPlot.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 
33 #ifndef vtkPlot_h
34 #define vtkPlot_h
35 
36 #include "vtkChartsCoreModule.h" // For export macro
37 #include "vtkContextItem.h"
38 #include "vtkStdString.h" // Needed to hold TooltipLabelFormat ivar
39 #include "vtkSmartPointer.h" // Needed to hold SP ivars
40 #include "vtkContextPolygon.h" // For vtkContextPolygon
41 #include "vtkRect.h" // For vtkRectd ivar
42 
43 class vtkVariant;
44 class vtkTable;
45 class vtkIdTypeArray;
46 class vtkContextMapper2D;
47 class vtkPen;
48 class vtkBrush;
49 class vtkAxis;
50 class vtkStringArray;
51 
52 class VTKCHARTSCORE_EXPORT vtkPlot : public vtkContextItem
53 {
54 public:
55  vtkTypeMacro(vtkPlot, vtkContextItem);
56  void PrintSelf(ostream &os, vtkIndent indent) override;
57 
59 
64  vtkSetMacro(LegendVisibility, bool);
65  vtkGetMacro(LegendVisibility, bool);
66  vtkBooleanMacro(LegendVisibility, bool);
68 
76  virtual bool PaintLegend(vtkContext2D *painter, const vtkRectf& rect,
77  int legendIndex);
78 
80 
92  virtual void SetTooltipLabelFormat(const vtkStdString &label);
95 
97 
100  virtual void SetTooltipNotation(int notation);
101  virtual int GetTooltipNotation();
103 
105 
108  virtual void SetTooltipPrecision(int precision);
109  virtual int GetTooltipPrecision();
111 
116  virtual vtkStdString GetTooltipLabel(const vtkVector2d &plotPos,
117  vtkIdType seriesIndex,
118  vtkIdType segmentIndex);
119 
126  const vtkVector2f& tolerance,
128 
132  virtual bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max);
133 
137  virtual bool SelectPointsInPolygon(const vtkContextPolygon &polygon);
138 
140 
143  virtual void SetColor(unsigned char r, unsigned char g, unsigned char b,
144  unsigned char a);
145  virtual void SetColor(double r, double g, double b);
146  virtual void GetColor(double rgb[3]);
147  void GetColor(unsigned char rgb[3]);
149 
153  virtual void SetWidth(float width);
154 
158  virtual float GetWidth();
159 
161 
164  void SetPen(vtkPen *pen);
167 
169 
172  void SetBrush(vtkBrush *brush);
175 
177 
184 
186 
193 
197  virtual void SetLabel(const vtkStdString &label);
198 
203 
208  virtual void SetLabels(vtkStringArray *labels);
209 
215 
219  virtual int GetNumberOfLabels();
220 
225 
232 
237 
242 
244 
248  vtkGetMacro(UseIndexForXSeries, bool);
250 
252 
256  vtkSetMacro(UseIndexForXSeries, bool);
258 
260 
264  virtual void SetInputData(vtkTable *table);
265  virtual void SetInputData(vtkTable *table, const vtkStdString &xColumn,
266  const vtkStdString &yColumn);
267  void SetInputData(vtkTable *table, vtkIdType xColumn, vtkIdType yColumn);
269 
273  virtual vtkTable* GetInput();
274 
280  virtual void SetInputArray(int index, const vtkStdString &name);
281 
283 
289  vtkSetMacro(Selectable,bool);
290  vtkGetMacro(Selectable,bool);
291  vtkBooleanMacro(Selectable,bool);
293 
295 
300  virtual void SetSelection(vtkIdTypeArray *id);
301  vtkGetObjectMacro(Selection, vtkIdTypeArray);
303 
305 
308  vtkGetObjectMacro(XAxis, vtkAxis);
309  virtual void SetXAxis(vtkAxis* axis);
311 
313 
316  vtkGetObjectMacro(YAxis, vtkAxis);
317  virtual void SetYAxis(vtkAxis* axis);
319 
321 
327  void SetShiftScale(const vtkRectd &scaling);
330 
336  virtual void GetBounds(double bounds[4])
337  { bounds[0] = bounds[1] = bounds[2] = bounds[3] = 0.0; }
338 
363  virtual void GetUnscaledInputBounds(double bounds[4])
364  {
365  // Implemented here by calling GetBounds() to support plot
366  // subclasses that do no log-scaling or plot orientation.
367  return this->GetBounds(bounds);
368  }
369 
376  virtual void UpdateCache() {}
377 
379 
383  virtual void SetProperty(const vtkStdString &property, const vtkVariant &var);
384  virtual vtkVariant GetProperty(const vtkStdString &property);
386 
387 protected:
389  ~vtkPlot() override;
390 
395 
400 
405 
411 
417 
422 
427 
432 
438 
444 
449 
454 
459 
464 
470 
476 
479 
484 
486 
487 private:
488  vtkPlot(const vtkPlot &) = delete;
489  void operator=(const vtkPlot &) = delete;
490 
491 };
492 
493 #endif //vtkPlot_h
vtkBrush
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:41
vtkPlot::AutoLabels
vtkSmartPointer< vtkStringArray > AutoLabels
Holds Labels when they're auto-created.
Definition: vtkPlot.h:426
vtkPlot::GetTooltipLabel
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,...
vtkPlot::GetTooltipPrecision
virtual int GetTooltipPrecision()
vtkPlot::SetSelectionPen
void SetSelectionPen(vtkPen *pen)
Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkStdString.h
vtkPlot::TooltipLabelFormat
vtkStdString TooltipLabelFormat
A printf-style string to build custom tooltip labels from.
Definition: vtkPlot.h:469
vtkPlot::IndexedLabels
vtkSmartPointer< vtkStringArray > IndexedLabels
Holds Labels when they're auto-created.
Definition: vtkPlot.h:431
vtkContextPolygon.h
vtkPlot::SetInputData
void SetInputData(vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
vtkPlot::Brush
vtkSmartPointer< vtkBrush > Brush
This object stores the vtkBrush that controls how the plot is drawn.
Definition: vtkPlot.h:404
vtkPlot::TooltipNotation
int TooltipNotation
Definition: vtkPlot.h:477
vtkContextMapper2D
Abstract class for 2D context mappers.
Definition: vtkContextMapper2D.h:38
vtkPlot::GetWidth
virtual float GetWidth()
Get the width of the line.
vtkPlot::SetWidth
virtual void SetWidth(float width)
Set the width of the line.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:69
vtkPlot::GetIndexedLabels
virtual vtkStringArray * GetIndexedLabels()
Get the indexed labels array.
vtkPlot::LegendVisibility
bool LegendVisibility
Definition: vtkPlot.h:485
vtkPlot::Data
vtkSmartPointer< vtkContextMapper2D > Data
This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
Definition: vtkPlot.h:443
vtkPlot::SetLabels
virtual void SetLabels(vtkStringArray *labels)
Set the plot labels, these are used for stacked chart variants, with the index referring to the stack...
vtkPlot::TooltipPrecision
int TooltipPrecision
Definition: vtkPlot.h:478
vtkPlot::SetIndexedLabels
void SetIndexedLabels(vtkStringArray *labels)
Set indexed labels for the plot.
vtkPlot::GetBrush
vtkBrush * GetBrush()
vtkPlot::SetInputData
virtual void SetInputData(vtkTable *table)
This is a convenience function to set the input table and the x, y column for the plot.
vtkPlot::GetLabel
vtkStdString GetLabel(vtkIdType index)
Get the label at the specified index.
vtkSmartPointer< vtkPen >
vtkPlot::GetSelectionBrush
vtkBrush * GetSelectionBrush()
vtkPlot::SetSelection
virtual void SetSelection(vtkIdTypeArray *id)
Sets the list of points that must be selected.
vtkPlot::GetShiftScale
vtkRectd GetShiftScale()
vtkPlot::SetColor
virtual void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a)
Set the plot color.
vtkPlot::Selectable
bool Selectable
Whether plot points can be selected or not.
Definition: vtkPlot.h:448
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:59
vtkContextItem.h
vtkPlot::GetTooltipNotation
virtual int GetTooltipNotation()
vtkPlot
Abstract class for 2D plots.
Definition: vtkPlot.h:53
vtkPlot::Labels
vtkSmartPointer< vtkStringArray > Labels
Plot labels, used by legend.
Definition: vtkPlot.h:421
vtkPlot::GetInput
virtual vtkTable * GetInput()
Get the input table used by the plot.
vtkRectd
Definition: vtkRect.h:342
max
#define max(a, b)
Definition: vtkX3DExporterFIWriterHelper.h:31
vtkPlot::SetColor
virtual void SetColor(double r, double g, double b)
vtkVector2d
Definition: vtkVector.h:428
vtkX3D::position
@ position
Definition: vtkX3D.h:261
vtkX3D::point
@ point
Definition: vtkX3D.h:236
vtkPlot::SetPen
void SetPen(vtkPen *pen)
Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkPlot::SelectPoints
virtual bool SelectPoints(const vtkVector2f &min, const vtkVector2f &max)
Select all points in the specified rectangle.
vtkPlot::SetYAxis
virtual void SetYAxis(vtkAxis *axis)
vtkPlot::UpdateCache
virtual void UpdateCache()
Subclasses that build data caches to speed up painting should override this method to update such cac...
Definition: vtkPlot.h:376
vtkPlot::UseIndexForXSeries
bool UseIndexForXSeries
Use the Y array index for the X value.
Definition: vtkPlot.h:437
vtkPlot::vtkPlot
vtkPlot()
vtkRect.h
vtkPlot::SetSelectionBrush
void SetSelectionBrush(vtkBrush *brush)
Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkPlot::GetNearestPoint
virtual vtkIdType GetNearestPoint(const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
Function to query a plot for the nearest point to the specified coordinate.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPlot::SelectionBrush
vtkSmartPointer< vtkBrush > SelectionBrush
This object stores the vtkBrush that controls how the selected elements of the plot are drawn.
Definition: vtkPlot.h:416
vtkPlot::TooltipDefaultLabelFormat
vtkStdString TooltipDefaultLabelFormat
The default printf-style string to build custom tooltip labels from.
Definition: vtkPlot.h:475
vtkPlot::SetLabel
virtual void SetLabel(const vtkStdString &label)
Set the label of this plot.
vtkPlot::SetXAxis
virtual void SetXAxis(vtkAxis *axis)
vtkSmartPointer.h
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:72
vtkPlot::GetProperty
virtual vtkVariant GetProperty(const vtkStdString &property)
vtkPlot::Pen
vtkSmartPointer< vtkPen > Pen
This object stores the vtkPen that controls how the plot is drawn.
Definition: vtkPlot.h:399
vtkContextPolygon
Definition: vtkContextPolygon.h:27
vtkPlot::PaintLegend
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...
vtkPlot::SelectionPen
vtkSmartPointer< vtkPen > SelectionPen
This object stores the vtkPen that controls how the selected elements of the plot are drawn.
Definition: vtkPlot.h:410
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkPlot::GetSelectionPen
vtkPen * GetSelectionPen()
vtkPlot::Selection
vtkIdTypeArray * Selection
Selected indices for the table the plot is rendering.
Definition: vtkPlot.h:453
vtkPlot::SetTooltipNotation
virtual void SetTooltipNotation(int notation)
Sets/gets the tooltip notation style.
vtkPlot::GetNumberOfLabels
virtual int GetNumberOfLabels()
Get the number of labels associated with this plot.
vtkPlot::XAxis
vtkAxis * XAxis
The X axis associated with this plot.
Definition: vtkPlot.h:458
vtkContextItem
base class for items that are part of a vtkContextScene.
Definition: vtkContextItem.h:35
vtkPlot::SetBrush
void SetBrush(vtkBrush *brush)
Set/get the vtkBrush object that controls how this plot fills shapes.
vtkPlot::GetPen
vtkPen * GetPen()
vtkPlot::~vtkPlot
~vtkPlot() override
vtkPlot::SetInputArray
virtual void SetInputArray(int index, const vtkStdString &name)
Convenience function to set the input arrays.
vtkPlot::SetProperty
virtual void SetProperty(const vtkStdString &property, const vtkVariant &var)
A General setter/getter that should be overridden.
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:42
vtkPlot::GetLabels
virtual vtkStringArray * GetLabels()
Get the plot labels.
vtkPlot::GetUnscaledInputBounds
virtual void GetUnscaledInputBounds(double bounds[4])
Provide un-log-scaled bounds for the plot inputs.
Definition: vtkPlot.h:363
vtkAxis
takes care of drawing 2D axes
Definition: vtkAxis.h:72
vtkPlot::SetShiftScale
void SetShiftScale(const vtkRectd &scaling)
Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1....
vtkPlot::SetTooltipLabelFormat
virtual void SetTooltipLabelFormat(const vtkStdString &label)
Sets/gets a printf-style string to build custom tooltip labels from.
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:43
vtkX3D::location
@ location
Definition: vtkX3D.h:406
vtkPlot::ShiftScale
vtkRectd ShiftScale
The current shift in origin and scaling factor applied to the plot.
Definition: vtkPlot.h:483
vtkPlot::GetColor
void GetColor(unsigned char rgb[3])
vtkPen
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:40
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkPlot::GetLabel
virtual vtkStdString GetLabel()
Get the label of this plot.
vtkPlot::SelectPointsInPolygon
virtual bool SelectPointsInPolygon(const vtkContextPolygon &polygon)
Select all points in the specified polygon.
vtkPlot::GetBounds
virtual void GetBounds(double bounds[4])
Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
Definition: vtkPlot.h:336
vtkPlot::GetData
vtkContextMapper2D * GetData()
Get the data object that the plot will draw.
vtkPlot::GetColor
virtual void GetColor(double rgb[3])
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkPlot::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkRectf
Definition: vtkRect.h:333
vtkPlot::SetTooltipPrecision
virtual void SetTooltipPrecision(int precision)
Sets/gets the tooltip precision.
vtkVector2f
Definition: vtkVector.h:419
vtkPlot::SetInputData
virtual void SetInputData(vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
vtkPlot::YAxis
vtkAxis * YAxis
The X axis associated with this plot.
Definition: vtkPlot.h:463
vtkPlot::GetTooltipLabelFormat
virtual vtkStdString GetTooltipLabelFormat()
vtkPlot::GetNumber
vtkStdString GetNumber(double position, vtkAxis *axis)
Get the properly formatted number for the supplied position and axis.