vtkChart.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 vtkChart_h
#define vtkChart_h

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkContextItem.h"
#include "vtkContextScene.h"  // For SelectionModifier
#include "vtkRect.h"          // For vtkRectf
#include "vtkSmartPointer.h"  // For SP ivars
#include "vtkStdString.h"     // For vtkStdString ivars
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkTransform2D;
class vtkContextScene;
class vtkPlot;
class vtkAxis;
class vtkBrush;
class vtkTextProperty;
class vtkChartLegend;

class vtkInteractorStyle;
class vtkAnnotationLink;

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

  enum
  {
    LINE,
    POINTS,
    BAR,
    STACKED,
    BAG,
    FUNCTIONALBAG,
    AREA
  };

  enum
  {
    PAN = 0,
    ZOOM = 1,
    ZOOM_AXIS = 2,
    SELECT = 3,
    SELECT_RECTANGLE = SELECT,
    SELECT_POLYGON = 4,
    CLICK_AND_DRAG = 5,
    NOTIFY = 6,
    ACTION_TYPES_COUNT = 7
  };

  enum EventIds
  {
    UpdateRange = 1002
  };

  bool Paint(vtkContext2D* painter) override = 0;

  virtual vtkPlot* AddPlot(int type);

  virtual vtkIdType AddPlot(vtkPlot* plot);

  virtual bool RemovePlot(vtkIdType index);

  virtual bool RemovePlotInstance(vtkPlot* plot);
  bool RemovePlot(vtkPlot* plot) { return this->RemovePlotInstance(plot); }

  virtual void ClearPlots();
  void RemoveAllPlots() { this->ClearPlots(); }

  virtual vtkPlot* GetPlot(vtkIdType index);

  virtual vtkIdType GetNumberOfPlots();

  virtual vtkAxis* GetAxis(int axisIndex);

  virtual void SetAxis(int axisIndex, vtkAxis*);

  virtual vtkIdType GetNumberOfAxes();

  virtual void RecalculateBounds();

  enum
  {
    SELECTION_ROWS,
    SELECTION_PLOTS,
    SELECTION_COLUMNS
  };


  virtual void SetSelectionMethod(int method);
  virtual int GetSelectionMethod();

  virtual void SetAnnotationLink(vtkAnnotationLink* link);


  vtkGetObjectMacro(AnnotationLink, vtkAnnotationLink);


  vtkSetVector2Macro(Geometry, int);
  vtkGetVector2Macro(Geometry, int);


  vtkSetVector2Macro(Point1, int);
  vtkGetVector2Macro(Point1, int);


  vtkSetVector2Macro(Point2, int);
  vtkGetVector2Macro(Point2, int);


  virtual void SetShowLegend(bool visible);
  virtual bool GetShowLegend();

  virtual vtkChartLegend* GetLegend();


  virtual void SetTitle(const vtkStdString& title);
  virtual vtkStdString GetTitle();


  vtkGetObjectMacro(TitleProperties, vtkTextProperty);


  void SetBottomBorder(int border);
  void SetTopBorder(int border);
  void SetLeftBorder(int border);
  void SetRightBorder(int border);

  void SetBorders(int left, int bottom, int right, int top);

  virtual void SetSize(const vtkRectf& rect);

  vtkRectf GetSize();

  enum
  {
    FILL_SCENE,  // Attempt to fill the entire scene.
    FILL_RECT,   // Attempt to supply the supplied vtkRectf in Size.
    AXES_TO_RECT // Put the corners of the axes on the vtkRectf in Size.
  };


  vtkSetMacro(LayoutStrategy, int);
  vtkGetMacro(LayoutStrategy, int);


  virtual void SetAutoSize(bool isAutoSized)
  {
    this->LayoutStrategy = isAutoSized ? vtkChart::FILL_SCENE : vtkChart::FILL_RECT;
  }
  virtual bool GetAutoSize() { return this->LayoutStrategy == vtkChart::FILL_SCENE ? true : false; }


  vtkSetMacro(RenderEmpty, bool);
  vtkGetMacro(RenderEmpty, bool);

  virtual void SetActionToButton(int action, int button);

  virtual int GetActionToButton(int action);

  virtual void SetClickActionToButton(int action, int button);

  virtual int GetClickActionToButton(int action);


  void SetBackgroundBrush(vtkBrush* brush);
  vtkBrush* GetBackgroundBrush();


  vtkSetClampMacro(
    SelectionMode, int, vtkContextScene::SELECTION_DEFAULT, vtkContextScene::SELECTION_TOGGLE);
  vtkGetMacro(SelectionMode, int);


  int GetSelectionModeFromMouseModifiers(const vtkContextMouseEvent& mouseEvent);
  static int GetSelectionModeFromMouseModifiers(
    const vtkContextMouseEvent& mouseEvent, int currentSelectionMode);

protected:
  vtkChart();
  ~vtkChart() override;

  bool CalculatePlotTransform(vtkAxis* x, vtkAxis* y, vtkTransform2D* transform);

  bool CalculateUnscaledPlotTransform(vtkAxis* x, vtkAxis* y, vtkTransform2D* transform);

  void AttachAxisRangeListener(vtkAxis*);

  void AxisRangeForwarderCallback(vtkObject*, unsigned long, void*);

  vtkAnnotationLink* AnnotationLink;

  int Geometry[2];

  int Point1[2];

  int Point2[2];

  int Borders[4];

  bool ShowLegend;

  vtkStdString Title;

  vtkTextProperty* TitleProperties;

  vtkRectf Size;
  // The layout strategy to employ when fitting the chart into the space.
  int LayoutStrategy;
  bool RenderEmpty;

  vtkSmartPointer<vtkBrush> BackgroundBrush;

  // The mode when the chart is doing selection.
  int SelectionMode;

  // How plot selections are handled, SELECTION_ROWS (default) or
  // SELECTION_PLOTS - based on the plot that created the selection.
  int SelectionMethod;


  class MouseActions
  {
  public:
    MouseActions();
    enum
    {
      MaxAction = 6
    };
    short& Pan() { return Data[0]; }
    short& Zoom() { return Data[1]; }
    short& ZoomAxis() { return Data[2]; }
    short& Select() { return Data[3]; }
    short& SelectPolygon() { return Data[4]; }
    short& ClickAndDrag() { return Data[5]; }
    short& operator[](int index) { return Data[index]; }
    short Data[MaxAction];
  };
  class MouseClickActions
  {
  public:
    MouseClickActions();
    short& Notify() { return Data[0]; }
    short& Select() { return Data[1]; }
    short& operator[](int index) { return Data[index]; }
    short Data[2];
  };

  MouseActions Actions;
  MouseClickActions ActionsClick;

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

VTK_ABI_NAMESPACE_END
#endif // vtkChart_h