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 
21 #ifndef vtkChartXY_h
22 #define vtkChartXY_h
23 
24 #include "vtkChart.h"
25 #include "vtkChartsCoreModule.h" // For export macro
26 #include "vtkContextPolygon.h" // For vtkContextPolygon
27 #include "vtkSmartPointer.h" // For SP ivars
28 #include "vtkVector.h" // For vtkVector2f in struct
29 
30 #include <vector> // for std::vector
31 
32 VTK_ABI_NAMESPACE_BEGIN
33 class vtkAxis;
34 class vtkChartLegend;
35 class vtkIdTypeArray;
37 class vtkPlot;
38 class vtkPlotGrid;
39 class vtkTooltipItem;
40 
41 class vtkChartXYPrivate; // Private class to keep my STL vector in...
42 
43 VTK_ABI_NAMESPACE_END
44 #include <map> // for std::map
45 
46 VTK_ABI_NAMESPACE_BEGIN
47 class VTKCHARTSCORE_EXPORT vtkChartXY : public vtkChart
48 {
49 public:
50  vtkTypeMacro(vtkChartXY, vtkChart);
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
56  static vtkChartXY* New();
57 
63  void Update() override;
64 
68  bool Paint(vtkContext2D* painter) override;
69 
73  vtkPlot* AddPlot(int type) override;
74 
78  virtual vtkPlot* AddPlot(int type, unsigned int blockIndex);
79 
83  vtkIdType AddPlot(vtkPlot* plot) override;
84 
88  virtual vtkIdType AddPlot(vtkPlot* plot, unsigned int blockIndex);
89 
94  bool RemovePlot(vtkIdType index) override;
95 
99  void ClearPlots() override;
100 
105 
111 
118 
125  virtual vtkIdType StackPlotAbove(vtkPlot* plot, vtkPlot* under);
126 
133 
140  virtual vtkIdType StackPlotUnder(vtkPlot* plot, vtkPlot* above);
141 
146 
150  int GetPlotCorner(vtkPlot* plot);
151 
155  void SetPlotCorner(vtkPlot* plot, int corner);
156 
162  vtkAxis* GetAxis(int axisIndex) override;
163 
169  void SetAxis(int axisIndex, vtkAxis*) override;
170 
174  void SetShowLegend(bool visible) override;
175 
180 
184  virtual void SetTooltip(vtkTooltipItem* tooltip);
185 
190 
195 
200  void RecalculateBounds() override;
201 
209  void SetSelectionMethod(int method) override;
210 
215 
217 
220  vtkSetMacro(DrawAxesAtOrigin, bool);
221  vtkGetMacro(DrawAxesAtOrigin, bool);
222  vtkBooleanMacro(DrawAxesAtOrigin, bool);
224 
226 
230  vtkSetMacro(AutoAxes, bool);
231  vtkGetMacro(AutoAxes, bool);
232  vtkBooleanMacro(AutoAxes, bool);
234 
236 
239  vtkSetMacro(HiddenAxisBorder, int);
240  vtkGetMacro(HiddenAxisBorder, int);
242 
244 
249  vtkSetMacro(ForceAxesToBounds, bool);
250  vtkGetMacro(ForceAxesToBounds, bool);
251  vtkBooleanMacro(ForceAxesToBounds, bool);
253 
255 
261  vtkSetMacro(IgnoreNanInBounds, bool);
262  vtkGetMacro(IgnoreNanInBounds, bool);
263  vtkBooleanMacro(IgnoreNanInBounds, bool);
265 
267 
274  vtkSetMacro(BarWidthFraction, float);
275  vtkGetMacro(BarWidthFraction, float);
277 
279 
285  vtkSetMacro(ZoomWithMouseWheel, bool);
286  vtkGetMacro(ZoomWithMouseWheel, bool);
287  vtkBooleanMacro(ZoomWithMouseWheel, bool);
289 
291 
296  void SetAxisZoom(int index, bool v);
297  bool GetAxisZoom(int index);
299 
301 
306  vtkSetMacro(AdjustLowerBoundForLogPlot, bool);
307  vtkGetMacro(AdjustLowerBoundForLogPlot, bool);
308  vtkBooleanMacro(AdjustLowerBoundForLogPlot, bool);
310 
312 
317  vtkSetMacro(DragPointAlongX, bool);
318  vtkGetMacro(DragPointAlongX, bool);
319  vtkBooleanMacro(DragPointAlongX, bool);
321 
323 
328  vtkSetMacro(DragPointAlongY, bool);
329  vtkGetMacro(DragPointAlongY, bool);
330  vtkBooleanMacro(DragPointAlongY, bool);
332 
337  vtkIdType segmentIndex = -1);
338 
342  bool Hit(const vtkContextMouseEvent& mouse) override;
343 
347  bool MouseEnterEvent(const vtkContextMouseEvent& mouse) override;
348 
352  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
353 
357  bool MouseLeaveEvent(const vtkContextMouseEvent& mouse) override;
358 
362  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
363 
367  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
368 
372  bool MouseWheelEvent(const vtkContextMouseEvent& mouse, int delta) override;
373 
377  bool KeyPressEvent(const vtkContextKeyEvent& key) override;
378 
379  typedef std::map<unsigned int, vtkSmartPointer<vtkIdTypeArray>> MapIndexToIds;
380 
385  static void MakeSelection(vtkAnnotationLink* link, const MapIndexToIds& selection);
386 
390  const std::vector<vtkContextTransform*>& GetTransforms() const;
391 
396  static void MakeSelection(vtkAnnotationLink* link, vtkIdTypeArray* selectionIds, vtkPlot* plot);
397 
401  static void MinusSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);
402 
406  static void AddSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);
407 
411  static void ToggleSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);
412 
419  static void BuildSelection(vtkAnnotationLink* link, int selectionMode,
420  vtkIdTypeArray* plotSelection, vtkIdTypeArray* oldSelection, vtkPlot* plot);
421 
428  static void BuildSelection(
429  int selectionMode, MapIndexToIds& selection, const MapIndexToIds& oldSelection);
430 
435  static int GetMouseSelectionMode(const vtkContextMouseEvent& mouse, int selectionMode);
436 
437 protected:
439  ~vtkChartXY() override;
440 
445 
451 
457  virtual bool UpdateLayout(vtkContext2D* painter);
458 
464  virtual int GetLegendBorder(vtkContext2D* painter, int axisPosition);
465 
470  virtual void SetLegendPosition(const vtkRectf& rect);
471 
476 
481 
486 
491 
495  bool DrawBox;
496 
502 
507 
512 
519 
523  bool AutoAxes;
524 
529 
535 
542 
550 
556 
561  bool AxisZoom[4];
562 
568 
574 
575 private:
576  vtkChartXY(const vtkChartXY&) = delete;
577  void operator=(const vtkChartXY&) = delete;
578 
579  vtkChartXYPrivate* ChartPrivate; // Private class where I hide my STL containers
580 
585  bool DragPoint;
586 
590  void CalculateBarPlots();
591 
597  bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);
598 
599  int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
600  vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentIndex);
601 
605  bool RemovePlotFromCorners(vtkPlot* plot);
606 
607  void ZoomInAxes(vtkAxis* x, vtkAxis* y, float* originf, float* max);
608 
613  void ReleasePlotSelections();
614 
618  void TransformBoxOrPolygon(bool polygonMode, vtkTransform2D* transform,
619  const vtkVector2f& mousePosition, vtkVector2f& min, vtkVector2f& max,
620  vtkContextPolygon& polygon);
621 };
622 
624 
630 {
634  int Index;
635 };
637 
638 VTK_ABI_NAMESPACE_END
639 #endif // vtkChartXY_h
takes care of drawing 2D axes
Definition: vtkAxis.h:61
draw the chart legend
Factory class for drawing XY charts.
Definition: vtkChartXY.h:48
bool DrawNearestPoint
Should we draw the location of the nearest point on the plot?
Definition: vtkChartXY.h:511
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:495
vtkSmartPointer< vtkChartLegend > Legend
The legend for the chart.
Definition: vtkChartXY.h:475
bool IgnoreNanInBounds
Property to ignore NaN in RecalculateBounds().
Definition: vtkChartXY.h:549
vtkContextPolygon SelectionPolygon
The polygon created as the mouse is dragged around the screen when in polygonal selection mode.
Definition: vtkChartXY.h:501
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:573
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:518
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:523
bool AdjustLowerBoundForLogPlot
Property to adjust the minimum of a logarithmic axis to be greater than 0, regardless of the minimum ...
Definition: vtkChartXY.h:567
~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:485
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:534
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:555
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:572
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:506
vtkRectf MouseBox
The box created as the mouse is dragged around the screen.
Definition: vtkChartXY.h:490
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:379
vtkSmartPointer< vtkTooltipItem > Tooltip
The tooltip item for the chart - can be used to display extra information.
Definition: vtkChartXY.h:480
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:528
bool ForceAxesToBounds
Property to force the axes to have their Minimum and Maximum properties inside the plot boundaries.
Definition: vtkChartXY.h:541
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:41
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:50
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:29
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:44
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:29
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:411
@ 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:630
vtkVector2f Position
Definition: vtkChartXY.h:632
vtkVector2i ScreenPosition
Definition: vtkChartXY.h:633
vtkStdString SeriesName
Definition: vtkChartXY.h:631
int vtkIdType
Definition: vtkType.h:315
#define max(a, b)