vtkChartBox.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 vtkChartBox_h
#define vtkChartBox_h

#include "vtkChart.h"
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkWrappingHints.h"    // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkIdTypeArray;
class vtkPlotBox;
class vtkStdString;
class vtkStringArray;
class vtkTooltipItem;

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

  static vtkChartBox* New();

  void Update() override;

  bool Paint(vtkContext2D* painter) override;


  void SetColumnVisibility(const vtkStdString& name, bool visible);
  void SetColumnVisibility(vtkIdType column, bool visible);

  void SetColumnVisibilityAll(bool visible);


  bool GetColumnVisibility(const vtkStdString& name);
  bool GetColumnVisibility(vtkIdType column);

  vtkIdType GetColumnId(const vtkStdString& name);


  vtkGetObjectMacro(VisibleColumns, vtkStringArray);

  // Index of the selected column in the visible columns list.
  vtkGetMacro(SelectedColumn, int);
  vtkSetMacro(SelectedColumn, int);

  vtkPlot* GetPlot(vtkIdType index) override;

  vtkIdType GetNumberOfPlots() override;

  virtual vtkAxis* GetYAxis();

  virtual float GetXPosition(int index);

  virtual vtkIdType GetNumberOfVisibleColumns();

  virtual void SetPlot(vtkPlotBox* plot);

  bool Hit(const vtkContextMouseEvent& mouse) override;

  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;

  virtual void SetTooltip(vtkTooltipItem* tooltip);

  virtual vtkTooltipItem* GetTooltip();

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

  void SetSize(const vtkRectf& rect) override;

  void SetGeometry(int arg1, int arg2) override;

  void SetLayoutStrategy(int strategy) override;

protected:
  vtkChartBox();
  ~vtkChartBox() override;


  class Private;
  Private* Storage;

  bool GeometryValid;

  vtkIdTypeArray* Selection;

  vtkStringArray* VisibleColumns;


  int SelectedColumn;
  float SelectedColumnDelta;

  vtkTimeStamp BuildTime;

  vtkSmartPointer<vtkTooltipItem> Tooltip;

  void ResetSelection();
  void UpdateGeometry(vtkContext2D*);
  void CalculatePlotTransform();
  void SwapAxes(int a1, int a2);

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

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

private:
  vtkChartBox(const vtkChartBox&) = delete;
  void operator=(const vtkChartBox&) = delete;
};


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

VTK_ABI_NAMESPACE_END
#endif // vtkChartBox_h