VTK  9.3.0
vtkChartXY.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 
30 #ifndef vtkChartXY_h
31 #define vtkChartXY_h
32 
33 #include "vtkChart.h"
34 #include "vtkChartsCoreModule.h" // For export macro
35 #include "vtkContextPolygon.h" // For vtkContextPolygon
36 #include "vtkSmartPointer.h" // For SP ivars
37 #include "vtkVector.h" // For vtkVector2f in struct
38 
39 #include <vector> // for std::vector
40 
41 VTK_ABI_NAMESPACE_BEGIN
42 class vtkAxis;
43 class vtkChartLegend;
44 class vtkIdTypeArray;
46 class vtkPlot;
47 class vtkPlotGrid;
48 class vtkTooltipItem;
49 
50 class vtkChartXYPrivate; // Private class to keep my STL vector in...
51 
52 VTK_ABI_NAMESPACE_END
53 #include <map> // for std::map
54 
55 VTK_ABI_NAMESPACE_BEGIN
56 class VTKCHARTSCORE_EXPORT vtkChartXY : public vtkChart
57 {
58 public:
59  vtkTypeMacro(vtkChartXY, vtkChart);
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
65  static vtkChartXY* New();
66 
72  void Update() override;
73 
77  bool Paint(vtkContext2D* painter) override;
78 
82  vtkPlot* AddPlot(int type) override;
83 
87  virtual vtkPlot* AddPlot(int type, unsigned int blockIndex);
88 
92  vtkIdType AddPlot(vtkPlot* plot) override;
93 
97  virtual vtkIdType AddPlot(vtkPlot* plot, unsigned int blockIndex);
98 
103  bool RemovePlot(vtkIdType index) override;
104 
108  void ClearPlots() override;
109 
114 
120 
127 
134  virtual vtkIdType StackPlotAbove(vtkPlot* plot, vtkPlot* under);
135 
142 
149  virtual vtkIdType StackPlotUnder(vtkPlot* plot, vtkPlot* above);
150 
155 
159  int GetPlotCorner(vtkPlot* plot);
160 
164  void SetPlotCorner(vtkPlot* plot, int corner);
165 
171  vtkAxis* GetAxis(int axisIndex) override;
172 
178  void SetAxis(int axisIndex, vtkAxis*) override;
179 
183  void SetShowLegend(bool visible) override;
184 
189 
193  virtual void SetTooltip(vtkTooltipItem* tooltip);
194 
199 
204 
209  void RecalculateBounds() override;
210 
218  void SetSelectionMethod(int method) override;
219 
224 
226 
229  vtkSetMacro(DrawAxesAtOrigin, bool);
230  vtkGetMacro(DrawAxesAtOrigin, bool);
231  vtkBooleanMacro(DrawAxesAtOrigin, bool);
233 
235 
239  vtkSetMacro(AutoAxes, bool);
240  vtkGetMacro(AutoAxes, bool);
241  vtkBooleanMacro(AutoAxes, bool);
243 
245 
248  vtkSetMacro(HiddenAxisBorder, int);
249  vtkGetMacro(HiddenAxisBorder, int);
251 
253 
258  vtkSetMacro(ForceAxesToBounds, bool);
259  vtkGetMacro(ForceAxesToBounds, bool);
260  vtkBooleanMacro(ForceAxesToBounds, bool);
262 
264 
270  vtkSetMacro(IgnoreNanInBounds, bool);
271  vtkGetMacro(IgnoreNanInBounds, bool);
272  vtkBooleanMacro(IgnoreNanInBounds, bool);
274 
276 
283  vtkSetMacro(BarWidthFraction, float);
284  vtkGetMacro(BarWidthFraction, float);
286 
288 
294  vtkSetMacro(ZoomWithMouseWheel, bool);
295  vtkGetMacro(ZoomWithMouseWheel, bool);
296  vtkBooleanMacro(ZoomWithMouseWheel, bool);
298 
300 
305  void SetAxisZoom(int index, bool v);
306  bool GetAxisZoom(int index);
308 
310 
315  vtkSetMacro(AdjustLowerBoundForLogPlot, bool);
316  vtkGetMacro(AdjustLowerBoundForLogPlot, bool);
317  vtkBooleanMacro(AdjustLowerBoundForLogPlot, bool);
319 
321 
326  vtkSetMacro(DragPointAlongX, bool);
327  vtkGetMacro(DragPointAlongX, bool);
328  vtkBooleanMacro(DragPointAlongX, bool);
330 
332 
337  vtkSetMacro(DragPointAlongY, bool);
338  vtkGetMacro(DragPointAlongY, bool);
339  vtkBooleanMacro(DragPointAlongY, bool);
341 
346  vtkIdType segmentIndex = -1);
347 
351  bool Hit(const vtkContextMouseEvent& mouse) override;
352 
356  bool MouseEnterEvent(const vtkContextMouseEvent& mouse) override;
357 
361  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
362 
366  bool MouseLeaveEvent(const vtkContextMouseEvent& mouse) override;
367 
371  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
372 
376  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
377 
381  bool MouseWheelEvent(const vtkContextMouseEvent& mouse, int delta) override;
382 
386  bool KeyPressEvent(const vtkContextKeyEvent& key) override;
387 
388  typedef std::map<unsigned int, vtkSmartPointer<vtkIdTypeArray>> MapIndexToIds;
389 
394  static void MakeSelection(vtkAnnotationLink* link, const MapIndexToIds& selection);
395 
399  const std::vector<vtkContextTransform*>& GetTransforms() const;
400 
405  static void MakeSelection(vtkAnnotationLink* link, vtkIdTypeArray* selectionIds, vtkPlot* plot);
406 
410  static void MinusSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);
411 
415  static void AddSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);
416 
420  static void ToggleSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);
421 
428  static void BuildSelection(vtkAnnotationLink* link, int selectionMode,
429  vtkIdTypeArray* plotSelection, vtkIdTypeArray* oldSelection, vtkPlot* plot);
430 
437  static void BuildSelection(
438  int selectionMode, MapIndexToIds& selection, const MapIndexToIds& oldSelection);
439 
444  static int GetMouseSelectionMode(const vtkContextMouseEvent& mouse, int selectionMode);
445 
446 protected:
448  ~vtkChartXY() override;
449 
454 
460 
466  virtual bool UpdateLayout(vtkContext2D* painter);
467 
473  virtual int GetLegendBorder(vtkContext2D* painter, int axisPosition);
474 
479  virtual void SetLegendPosition(const vtkRectf& rect);
480 
485 
490 
495 
500 
504  bool DrawBox;
505 
511 
516 
521 
528 
532  bool AutoAxes;
533 
538 
544 
551 
559 
565 
570  bool AxisZoom[4];
571 
577 
583 
584 private:
585  vtkChartXY(const vtkChartXY&) = delete;
586  void operator=(const vtkChartXY&) = delete;
587 
588  vtkChartXYPrivate* ChartPrivate; // Private class where I hide my STL containers
589 
594  bool DragPoint;
595 
599  void CalculateBarPlots();
600 
606  bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
607 
608  int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
609  vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentIndex);
610 
614  bool RemovePlotFromCorners(vtkPlot* plot);
615 
616  void ZoomInAxes(vtkAxis* x, vtkAxis* y, float* originf, float* max);
617 
622  void ReleasePlotSelections();
623 
627  void TransformBoxOrPolygon(bool polygonMode, vtkTransform2D* transform,
628  const vtkVector2f& mousePosition, vtkVector2f& min, vtkVector2f& max,
629  vtkContextPolygon& polygon);
630 };
631 
633 
639 {
643  int Index;
644 };
646 
647 VTK_ABI_NAMESPACE_END
648 #endif // vtkChartXY_h
takes care of drawing 2D axes
Definition: vtkAxis.h:70
draw the chart legend
Factory class for drawing XY charts.
Definition: vtkChartXY.h:57
bool DrawNearestPoint
Should we draw the location of the nearest point on the plot?
Definition: vtkChartXY.h:520
virtual vtkIdType StackPlotUnder(vtkPlot *plot, vtkPlot *above)
Lowers the plot under the above plot.
vtkIdType AddPlot(vtkPlot *plot) override
Adds a plot to the chart.
vtkPlot * AddPlot(int type) override
Add a plot to the chart, defaults to using the name of the y column.
vtkChartLegend * GetLegend() override
Get the vtkChartLegend object that will be displayed by the chart.
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse) override
Mouse button release event.
static void MakeSelection(vtkAnnotationLink *link, vtkIdTypeArray *selectionIds, vtkPlot *plot)
Populate the annotation link with the supplied selectionIds array, and set the appropriate node prope...
virtual vtkIdType AddPlot(vtkPlot *plot, unsigned int blockIndex)
Adds a plot to the chart holding data specific to a block in a vtkMultiBlockDataSet.
vtkIdType GetNumberOfPlots() override
Get the number of plots the chart contains.
vtkIdType GetNumberOfAxes() override
Get the number of axes in the current chart.
bool DrawBox
Should the box be drawn (could be selection, zoom etc).
Definition: vtkChartXY.h:504
vtkSmartPointer< vtkChartLegend > Legend
The legend for the chart.
Definition: vtkChartXY.h:484
bool IgnoreNanInBounds
Property to ignore NaN in RecalculateBounds().
Definition: vtkChartXY.h:558
vtkContextPolygon SelectionPolygon
The polygon created as the mouse is dragged around the screen when in polygonal selection mode.
Definition: vtkChartXY.h:510
virtual void SetTooltipInfo(const vtkContextMouseEvent &, const vtkVector2d &, vtkIdType, vtkPlot *, vtkIdType segmentIndex=-1)
Set the information passed to the tooltip.
void RecalculatePlotTransforms()
Recalculate the necessary transforms.
bool RemovePlot(vtkIdType index) override
Remove the plot at the specified index, returns true if successful, false if the index was invalid.
void Update() override
Perform any updates to the item that may be necessary before rendering.
const std::vector< vtkContextTransform * > & GetTransforms() const
Get the vector of vtkContextTransform.
virtual int GetLegendBorder(vtkContext2D *painter, int axisPosition)
Layout for the legend if it is visible.
virtual vtkIdType GetPlotIndex(vtkPlot *)
Get the index of the specified plot, returns -1 if the plot does not belong to the chart.
virtual vtkPlot * AddPlot(int type, unsigned int blockIndex)
Adds a plot to the chart holding data specific to a block in a vtkMultiBlockDataSet.
bool DragPointAlongY
Definition: vtkChartXY.h:582
bool Hit(const vtkContextMouseEvent &mouse) override
Return true if the supplied x, y coordinate is inside the item.
vtkIdType RaisePlot(vtkPlot *plot)
Raises the plot to the top of the plot's stack.
bool DrawAxesAtOrigin
Keep the axes drawn at the origin? This will attempt to keep the axes drawn at the origin,...
Definition: vtkChartXY.h:527
static void AddSelection(vtkIdTypeArray *selection, vtkIdTypeArray *oldSelection)
Add the supplied selection from the oldSelection.
static void BuildSelection(int selectionMode, MapIndexToIds &selection, const MapIndexToIds &oldSelection)
Build a selection based on the supplied selectionMode using the new plotSelection and combining it wi...
vtkAxis * GetAxis(int axisIndex) override
Get the axis specified by axisIndex.
static void MakeSelection(vtkAnnotationLink *link, const MapIndexToIds &selection)
Populate the selection node in the annotation link coressponding to the give node with the supplied s...
static vtkChartXY * New()
Creates a 2D Chart object.
vtkPlot * GetPlot(vtkIdType index) override
Get the plot at the specified index, returns null if the index is invalid.
bool MouseEnterEvent(const vtkContextMouseEvent &mouse) override
Mouse enter event.
bool KeyPressEvent(const vtkContextKeyEvent &key) override
Key press event.
void SetSelectionMethod(int method) override
Set the selection method, which controls how selections are handled by the chart.
static void BuildSelection(vtkAnnotationLink *link, int selectionMode, vtkIdTypeArray *plotSelection, vtkIdTypeArray *oldSelection, vtkPlot *plot)
Build a selection based on the supplied selectionMode using the new plotSelection and combining it wi...
void RecalculateBounds() override
Request that the chart recalculates the range of its axes.
bool AutoAxes
Should axes be turned on and off automatically - defaults to on.
Definition: vtkChartXY.h:532
bool AdjustLowerBoundForLogPlot
Property to adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum ...
Definition: vtkChartXY.h:576
~vtkChartXY() override
void RemovePlotSelections()
Remove all the selection from Plots.
virtual bool UpdateLayout(vtkContext2D *painter)
Update the layout of the chart, this may require the vtkContext2D in order to get font metrics etc.
bool PlotTransformValid
Does the plot area transform need to be recalculated?
Definition: vtkChartXY.h:494
float BarWidthFraction
The fraction of the interval taken up along the x axis by any bars that are drawn on the chart.
Definition: vtkChartXY.h:543
bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override
Mouse move event.
void SetAxisZoom(int index, bool v)
Set the behavior of the mouse wheel for individual axes.
virtual vtkIdType StackPlotAbove(vtkPlot *plot, vtkPlot *under)
Raises the plot above the under plot.
bool ZoomWithMouseWheel
Property to enable zooming the chart with the mouse wheel.
Definition: vtkChartXY.h:564
void ClearPlots() override
Remove all plots from the chart.
static void ToggleSelection(vtkIdTypeArray *selection, vtkIdTypeArray *oldSelection)
Toggle the supplied selection from the oldSelection.
bool MouseWheelEvent(const vtkContextMouseEvent &mouse, int delta) override
Mouse wheel event, positive delta indicates forward movement of the wheel.
bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse) override
Mouse button down event.
bool DragPointAlongX
Properties to enable the drag of a point for the ClickAndDrag Action.
Definition: vtkChartXY.h:581
int GetPlotCorner(vtkPlot *plot)
Figure out which quadrant the plot is in.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetShowLegend(bool visible) override
Set whether the chart should draw a legend.
bool DrawSelectionPolygon
Should the selection polygon be drawn.
Definition: vtkChartXY.h:515
vtkRectf MouseBox
The box created as the mouse is dragged around the screen.
Definition: vtkChartXY.h:499
void SetPlotCorner(vtkPlot *plot, int corner)
Figure out which quadrant the plot is in.
virtual void SetLegendPosition(const vtkRectf &rect)
Called after the edges of the chart are decided, set the position of the legend, depends upon its ali...
void SetAxis(int axisIndex, vtkAxis *) override
Set the axis specified by axisIndex.
virtual void SetTooltip(vtkTooltipItem *tooltip)
Set the vtkTooltipItem object that will be displayed by the chart.
bool Paint(vtkContext2D *painter) override
Paint event for the chart, called whenever the chart needs to be drawn.
std::map< unsigned int, vtkSmartPointer< vtkIdTypeArray > > MapIndexToIds
Definition: vtkChartXY.h:388
vtkSmartPointer< vtkTooltipItem > Tooltip
The tooltip item for the chart - can be used to display extra information.
Definition: vtkChartXY.h:489
vtkIdType LowerPlot(vtkPlot *plot)
Lowers the plot to the bottom of the plot's stack.
int HiddenAxisBorder
Size of the border when an axis is hidden.
Definition: vtkChartXY.h:537
bool ForceAxesToBounds
Property to force the axes to have their Minimum and Maximum properties inside the plot boundaries.
Definition: vtkChartXY.h:550
void RecalculatePlotBounds()
Calculate the optimal zoom level such that all of the points to be plotted will fit into the plot are...
static void MinusSelection(vtkIdTypeArray *selection, vtkIdTypeArray *oldSelection)
Subtract the supplied selection from the oldSelection.
static int GetMouseSelectionMode(const vtkContextMouseEvent &mouse, int selectionMode)
Combine the SelectionMode with any mouse modifiers to get an effective selection mode for this click ...
bool MouseLeaveEvent(const vtkContextMouseEvent &mouse) override
Mouse leave event.
virtual vtkTooltipItem * GetTooltip()
Get the vtkTooltipItem object that will be displayed by the chart.
bool GetAxisZoom(int index)
Set the behavior of the mouse wheel for individual axes.
Factory class for drawing 2D charts.
Definition: vtkChart.h:50
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:59
data structure to represent key events.
data structure to represent mouse events.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:38
Composite dataset that organizes datasets into blocks.
takes care of drawing the plot grid
Definition: vtkPlotGrid.h:27
Abstract class for 2D plots.
Definition: vtkPlot.h:53
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
takes care of drawing 2D axes
describes linear transformations via a 3x3 matrix
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:420
@ key
Definition: vtkX3D.h:257
@ type
Definition: vtkX3D.h:516
@ position
Definition: vtkX3D.h:261
@ index
Definition: vtkX3D.h:246
Small struct used by InvokeEvent to send some information about the point that was clicked on.
Definition: vtkChartXY.h:639
vtkVector2f Position
Definition: vtkChartXY.h:641
vtkVector2i ScreenPosition
Definition: vtkChartXY.h:642
vtkStdString SeriesName
Definition: vtkChartXY.h:640
int vtkIdType
Definition: vtkType.h:315
#define max(a, b)