vtkChartMatrix.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 vtkChartMatrix_h
#define vtkChartMatrix_h

#include "vtkAbstractContextItem.h"
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkRect.h"             // for ivars
#include "vtkVector.h"           // For ivars
#include "vtkWrappingHints.h"    // For VTK_MARSHALAUTO

#include <map>     // For specific gutter
#include <utility> // For specific gutter

VTK_ABI_NAMESPACE_BEGIN
class vtkChart;

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

  static vtkChartMatrix* New();

  void Update() override;

  bool Paint(vtkContext2D* painter) override;

  virtual void SetSize(const vtkVector2i& size);

  virtual vtkVector2i GetSize() const { return this->Size; }


  virtual void SetBorders(int left, int bottom, int right, int top);
  void SetBorderLeft(int value);
  void SetBorderBottom(int value);
  void SetBorderRight(int value);
  void SetBorderTop(int value);
  virtual void GetBorders(int borders[4])
  {
    for (int i = 0; i < 4; i++)
    {
      borders[i] = this->Borders[i];
    }
  }


  virtual void SetGutter(const vtkVector2f& gutter);
  void SetGutterX(float value);
  void SetGutterY(float value);


  virtual void SetPadding(const float& padding);


  virtual void SetSpecificResize(const vtkVector2i& index, const vtkVector2f& resize);
  virtual void ClearSpecificResizes();

  virtual vtkVector2f GetGutter() const { return this->Gutter; }

  virtual void Allocate();

  virtual bool SetChart(const vtkVector2i& position, vtkChart* chart);

  virtual vtkChart* GetChart(const vtkVector2i& position);

  virtual bool SetChartSpan(const vtkVector2i& position, const vtkVector2i& span);

  virtual vtkVector2i GetChartSpan(const vtkVector2i& position);

  virtual vtkVector2i GetChartIndex(const vtkVector2f& position);

  virtual std::size_t GetFlatIndex(const vtkVector2i& index);

  virtual std::size_t GetNumberOfCharts();

  virtual void LabelOuter(const vtkVector2i& leftBottomIdx, const vtkVector2i& rightTopIdx);


  virtual void Link(const vtkVector2i& index1, const vtkVector2i& index2, int axis = 1);
  virtual void Link(const size_t& flatIndex1, const size_t& flatIndex2, int axis = 1);


  virtual void LinkAll(const vtkVector2i& index, int axis = 1);
  virtual void LinkAll(const size_t& flatIndex, int axis = 1);


  virtual void Unlink(const vtkVector2i& index1, const vtkVector2i& index2, int axis = 1);
  virtual void Unlink(const size_t& flatIndex1, const size_t& flatIndex2, int axis = 1);


  virtual void UnlinkAll(const vtkVector2i& index, int axis = 1);
  virtual void UnlinkAll(const size_t& flatIndex, int axis = 1);


  virtual void ResetLinks(int axis = 1);
  virtual void ResetLinkedLayout();


  virtual void SetRect(vtkRecti rect);
  vtkGetMacro(Rect, vtkRecti);

  virtual bool SetChartMatrix(const vtkVector2i& position, vtkChartMatrix* chartMatrix);

  virtual vtkChartMatrix* GetChartMatrix(const vtkVector2i& position);


  virtual void InitLayoutTraversal(vtkVector2i& index, vtkVector2f& offset, vtkVector2f& increment);
  virtual void GoToNextElement(vtkVector2i& index, vtkVector2f& offset);
  virtual bool IsDoneWithTraversal();

  virtual vtkRectf ComputeCurrentElementSceneRect(
    const vtkVector2i& index, const vtkVector2f& offset, const vtkVector2f& increment);

  enum class StretchType : unsigned int
  {
    SCENE = 0,
    CUSTOM
  };

  vtkSetEnumMacro(FillStrategy, StretchType);
  StretchType GetFillStrategy() { return this->FillStrategy; }

protected:
  vtkChartMatrix();
  ~vtkChartMatrix() override;

  // The number of charts in x and y.
  vtkVector2i Size;

  // The gutter between each chart.
  vtkVector2f Gutter;

  // The padding used inside each chart
  float Padding;
  std::map<vtkVector2i, vtkVector2f> SpecificResize;
  int Borders[4];
  bool LayoutIsDirty;

  // The rectangular region to occupy. (in scene coordinates.)
  vtkRecti Rect = { 0, 0, 100, 100 };
  StretchType FillStrategy = StretchType::SCENE;

  virtual void SynchronizeAxisRanges(vtkObject* caller, unsigned long eventId, void* calldata);

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

  class PIMPL;
  PIMPL* Private;
};

VTK_ABI_NAMESPACE_END
#endif // vtkChartMatrix_h