vtkChartXY.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

#ifndef vtkChartXY_h
#define vtkChartXY_h

#include "vtkChart.h"
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkContextPolygon.h"   // For vtkContextPolygon
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_6_0
#include "vtkSmartPointer.h"     // For SP ivars
#include "vtkVector.h"           // For vtkVector2f in struct
#include "vtkWrappingHints.h"    // For VTK_MARSHALAUTO

#include <vector> // for std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkAxis;
class vtkChartLegend;
class vtkIdTypeArray;
class vtkMultiBlockDataSet;
class vtkPlot;
class vtkPlotGrid;
class vtkTooltipItem;

class vtkChartXYPrivate; // Private class to keep my STL vector in...

VTK_ABI_NAMESPACE_END
#include <map> // for std::map

VTK_ABI_NAMESPACE_BEGIN
class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkChartXY : public vtkChart
{
public:
  vtkTypeMacro(vtkChartXY, vtkChart);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkChartXY* New();

  void Update() override;

  bool Paint(vtkContext2D* painter) override;

  vtkPlot* AddPlot(int type) override;

  virtual vtkPlot* AddPlot(int type, unsigned int blockIndex);

  vtkIdType AddPlot(vtkPlot* plot) override;

  virtual vtkIdType AddPlot(vtkPlot* plot, unsigned int blockIndex);

  bool RemovePlot(vtkIdType index) override;

  void ClearPlots() override;

  vtkPlot* GetPlot(vtkIdType index) override;

  virtual vtkIdType GetPlotIndex(vtkPlot*);

  vtkIdType RaisePlot(vtkPlot* plot);

  virtual vtkIdType StackPlotAbove(vtkPlot* plot, vtkPlot* under);

  vtkIdType LowerPlot(vtkPlot* plot);

  virtual vtkIdType StackPlotUnder(vtkPlot* plot, vtkPlot* above);

  vtkIdType GetNumberOfPlots() override;

  int GetPlotCorner(vtkPlot* plot);

  void SetPlotCorner(vtkPlot* plot, int corner);

  vtkAxis* GetAxis(int axisIndex) override;

  void SetAxis(int axisIndex, vtkAxis*) override;

  void SetShowLegend(bool visible) override;

  vtkChartLegend* GetLegend() override;

  virtual void SetTooltip(vtkTooltipItem* tooltip);

  virtual vtkTooltipItem* GetTooltip();

  vtkIdType GetNumberOfAxes() override;

  void RecalculateBounds() override;

  void SetSelectionMethod(int method) override;

  void RemovePlotSelections();


  vtkSetMacro(DrawAxesAtOrigin, bool);
  vtkGetMacro(DrawAxesAtOrigin, bool);
  vtkBooleanMacro(DrawAxesAtOrigin, bool);


  vtkSetMacro(AutoAxes, bool);
  vtkGetMacro(AutoAxes, bool);
  vtkBooleanMacro(AutoAxes, bool);


  vtkSetMacro(HiddenAxisBorder, int);
  vtkGetMacro(HiddenAxisBorder, int);


  vtkSetMacro(ForceAxesToBounds, bool);
  vtkGetMacro(ForceAxesToBounds, bool);
  vtkBooleanMacro(ForceAxesToBounds, bool);


  vtkSetMacro(IgnoreNanInBounds, bool);
  vtkGetMacro(IgnoreNanInBounds, bool);
  vtkBooleanMacro(IgnoreNanInBounds, bool);


  vtkSetMacro(BarWidthFraction, float);
  vtkGetMacro(BarWidthFraction, float);


  vtkSetMacro(ZoomWithMouseWheel, bool);
  vtkGetMacro(ZoomWithMouseWheel, bool);
  vtkBooleanMacro(ZoomWithMouseWheel, bool);


  void SetAxisZoom(int index, bool v);
  bool GetAxisZoom(int index);


  vtkSetMacro(AdjustLowerBoundForLogPlot, bool);
  vtkGetMacro(AdjustLowerBoundForLogPlot, bool);
  vtkBooleanMacro(AdjustLowerBoundForLogPlot, bool);


  vtkSetMacro(DragPointAlongX, bool);
  vtkGetMacro(DragPointAlongX, bool);
  vtkBooleanMacro(DragPointAlongX, bool);


  vtkSetMacro(DragPointAlongY, bool);
  vtkGetMacro(DragPointAlongY, bool);
  vtkBooleanMacro(DragPointAlongY, bool);

  virtual void SetTooltipInfo(const vtkContextMouseEvent&, const vtkVector2d&, vtkIdType, vtkPlot*,
    vtkIdType segmentIndex = -1);

  bool Hit(const vtkContextMouseEvent& mouse) override;

  bool MouseEnterEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseLeaveEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseWheelEvent(const vtkContextMouseEvent& mouse, int delta) override;

  bool KeyPressEvent(const vtkContextKeyEvent& key) override;

  typedef std::map<unsigned int, vtkSmartPointer<vtkIdTypeArray>> MapIndexToIds;

  static void MakeSelection(vtkAnnotationLink* link, const MapIndexToIds& selection);

  const std::vector<vtkContextTransform*>& GetTransforms() const;

  static void MakeSelection(vtkAnnotationLink* link, vtkIdTypeArray* selectionIds, vtkPlot* plot);

  static void MinusSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);

  static void AddSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);

  static void ToggleSelection(vtkIdTypeArray* selection, vtkIdTypeArray* oldSelection);

  static void BuildSelection(vtkAnnotationLink* link, int selectionMode,
    vtkIdTypeArray* plotSelection, vtkIdTypeArray* oldSelection, vtkPlot* plot);

  static void BuildSelection(
    int selectionMode, MapIndexToIds& selection, const MapIndexToIds& oldSelection);

  VTK_DEPRECATED_IN_9_6_0("Use use vtkChart::GetSelectionModeFromMouseModifiers instead")
  static int GetMouseSelectionMode(const vtkContextMouseEvent& mouse, int selectionMode);

protected:
  vtkChartXY();
  ~vtkChartXY() override;

  void RecalculatePlotTransforms();

  void RecalculatePlotBounds();

  virtual bool UpdateLayout(vtkContext2D* painter);

  virtual int GetLegendBorder(vtkContext2D* painter, int axisPosition);

  virtual void SetLegendPosition(const vtkRectf& rect);

  vtkSmartPointer<vtkChartLegend> Legend;

  vtkSmartPointer<vtkTooltipItem> Tooltip;

  bool PlotTransformValid;

  vtkRectf MouseBox;

  bool DrawBox;

  vtkContextPolygon SelectionPolygon;

  bool DrawSelectionPolygon;

  bool DrawNearestPoint;

  bool DrawAxesAtOrigin;

  bool AutoAxes;

  int HiddenAxisBorder;

  float BarWidthFraction;

  bool ForceAxesToBounds;

  bool IgnoreNanInBounds;

  bool ZoomWithMouseWheel;

  bool AxisZoom[4];

  bool AdjustLowerBoundForLogPlot;

  bool DragPointAlongX;
  bool DragPointAlongY;

private:
  vtkChartXY(const vtkChartXY&) = delete;
  void operator=(const vtkChartXY&) = delete;

  vtkChartXYPrivate* ChartPrivate; // Private class where I hide my STL containers

  bool DragPoint;

  void CalculateBarPlots();

  bool LocatePointInPlots(const vtkContextMouseEvent& mouse, int invokeEvent = -1);

  int LocatePointInPlot(const vtkVector2f& position, const vtkVector2f& tolerance,
    vtkVector2f& plotPos, vtkPlot* plot, vtkIdType& segmentIndex);

  bool RemovePlotFromCorners(vtkPlot* plot);

  void ZoomInAxes(vtkAxis* x, vtkAxis* y, float* originf, float* max);

  void ReleasePlotSelections();

  void TransformBoxOrPolygon(bool polygonMode, vtkTransform2D* transform,
    const vtkVector2f& mousePosition, vtkVector2f& min, vtkVector2f& max,
    vtkContextPolygon& polygon);
};


struct vtkChartPlotData
{
  vtkStdString SeriesName;
  vtkVector2f Position;
  vtkVector2i ScreenPosition;
  int Index;
};

VTK_ABI_NAMESPACE_END
#endif // vtkChartXY_h