VTK  9.3.0
vtkChartMatrix.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 
26 #ifndef vtkChartMatrix_h
27 #define vtkChartMatrix_h
28 
29 #include "vtkAbstractContextItem.h"
30 #include "vtkChartsCoreModule.h" // For export macro
31 #include "vtkRect.h" // for ivars
32 #include "vtkVector.h" // For ivars
33 
34 #include <map> // For specific gutter
35 #include <utility> // For specific gutter
36 
37 VTK_ABI_NAMESPACE_BEGIN
38 class vtkChart;
39 
40 class VTKCHARTSCORE_EXPORT vtkChartMatrix : public vtkAbstractContextItem
41 {
42 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
49  static vtkChartMatrix* New();
50 
54  void Update() override;
55 
59  bool Paint(vtkContext2D* painter) override;
60 
66  virtual void SetSize(const vtkVector2i& size);
67 
71  virtual vtkVector2i GetSize() const { return this->Size; }
72 
74 
77  virtual void SetBorders(int left, int bottom, int right, int top);
78  void SetBorderLeft(int value);
80  void SetBorderRight(int value);
81  void SetBorderTop(int value);
82  virtual void GetBorders(int borders[4])
83  {
84  for (int i = 0; i < 4; i++)
85  {
86  borders[i] = this->Borders[i];
87  }
88  }
90 
92 
95  virtual void SetGutter(const vtkVector2f& gutter);
96  void SetGutterX(float value);
97  void SetGutterY(float value);
99 
101 
104  virtual void SetPadding(const float& padding);
106 
108 
111  virtual void SetSpecificResize(const vtkVector2i& index, const vtkVector2f& resize);
112  virtual void ClearSpecificResizes();
114 
118  virtual vtkVector2f GetGutter() const { return this->Gutter; }
119 
123  virtual void Allocate();
124 
131  virtual bool SetChart(const vtkVector2i& position, vtkChart* chart);
132 
139 
145  virtual bool SetChartSpan(const vtkVector2i& position, const vtkVector2i& span);
146 
151 
157 
161  virtual std::size_t GetFlatIndex(const vtkVector2i& index);
162 
166  virtual std::size_t GetNumberOfCharts();
167 
173  virtual void LabelOuter(const vtkVector2i& leftBottomIdx, const vtkVector2i& rightTopIdx);
174 
176 
182  virtual void Link(const vtkVector2i& index1, const vtkVector2i& index2, int axis = 1);
183  virtual void Link(const size_t& flatIndex1, const size_t& flatIndex2, int axis = 1);
185 
187 
190  virtual void LinkAll(const vtkVector2i& index, int axis = 1);
191  virtual void LinkAll(const size_t& flatIndex, int axis = 1);
193 
195 
199  virtual void Unlink(const vtkVector2i& index1, const vtkVector2i& index2, int axis = 1);
200  virtual void Unlink(const size_t& flatIndex1, const size_t& flatIndex2, int axis = 1);
202 
204 
207  virtual void UnlinkAll(const vtkVector2i& index, int axis = 1);
208  virtual void UnlinkAll(const size_t& flatIndex, int axis = 1);
210 
212 
219  virtual void ResetLinks(int axis = 1);
220  virtual void ResetLinkedLayout();
222 
224 
228  virtual void SetRect(vtkRecti rect);
229  vtkGetMacro(Rect, vtkRecti);
231 
239  virtual bool SetChartMatrix(const vtkVector2i& position, vtkChartMatrix* chartMatrix);
240 
247 
249 
256  virtual bool IsDoneWithTraversal();
258 
265  const vtkVector2i& index, const vtkVector2f& offset, const vtkVector2f& increment);
266 
267  enum class StretchType : unsigned int
268  {
269  SCENE = 0,
270  CUSTOM
271  };
273 
277  vtkSetEnumMacro(FillStrategy, StretchType);
278  StretchType GetFillStrategy() { return this->FillStrategy; }
280 
281 protected:
283  ~vtkChartMatrix() override;
284 
285  // The number of charts in x and y.
287 
288  // The gutter between each chart.
290 
291  // The padding used inside each chart
292  float Padding;
293  std::map<vtkVector2i, vtkVector2f> SpecificResize;
294  int Borders[4];
296 
297  // The rectangular region to occupy. (in scene coordinates.)
298  vtkRecti Rect = { 0, 0, 100, 100 };
299  StretchType FillStrategy = StretchType::SCENE;
300 
301  virtual void SynchronizeAxisRanges(vtkObject* caller, unsigned long eventId, void* calldata);
302 
303 private:
304  vtkChartMatrix(const vtkChartMatrix&) = delete;
305  void operator=(const vtkChartMatrix&) = delete;
306 
307  class PIMPL;
308  PIMPL* Private;
309 };
310 
311 VTK_ABI_NAMESPACE_END
312 #endif // vtkChartMatrix_h
base class for items that are part of a vtkContextScene.
container for a matrix of charts.
virtual void Link(const vtkVector2i &index1, const vtkVector2i &index2, int axis=1)
The chart at index2 will be setup to mimic axis range of chart at index1 for specified axis.
StretchType GetFillStrategy()
This specifies whether the chart matrix will fill the entire scene or instead draw itself in a user p...
void SetBorderBottom(int value)
Set/get the borders of the chart matrix (space in pixels around each chart).
void SetBorderRight(int value)
Set/get the borders of the chart matrix (space in pixels around each chart).
virtual void SynchronizeAxisRanges(vtkObject *caller, unsigned long eventId, void *calldata)
virtual void SetGutter(const vtkVector2f &gutter)
Set the gutter that should be left between the charts in the matrix.
virtual bool SetChart(const vtkVector2i &position, vtkChart *chart)
Set the chart element, note that the chart matrix must be large enough to accommodate the element bei...
virtual void GoToNextElement(vtkVector2i &index, vtkVector2f &offset)
These methods offer an API to iterate over the layout and obtain the offset of each child element (ch...
virtual vtkVector2i GetSize() const
Get the width and height of the chart matrix.
virtual void GetBorders(int borders[4])
Set/get the borders of the chart matrix (space in pixels around each chart).
vtkVector2i Size
virtual void Unlink(const vtkVector2i &index1, const vtkVector2i &index2, int axis=1)
Unlink the two charts for specified axis i.e, Chart at index2 will no longer mimic the axis range of ...
vtkVector2f Gutter
virtual vtkVector2i GetChartSpan(const vtkVector2i &position)
Get the span of the specified element.
virtual void InitLayoutTraversal(vtkVector2i &index, vtkVector2f &offset, vtkVector2f &increment)
These methods offer an API to iterate over the layout and obtain the offset of each child element (ch...
void SetBorderTop(int value)
Set/get the borders of the chart matrix (space in pixels around each chart).
virtual std::size_t GetFlatIndex(const vtkVector2i &index)
Get internal 1-D index corresponding to the 2-D element index.
virtual void Unlink(const size_t &flatIndex1, const size_t &flatIndex2, int axis=1)
Unlink the two charts for specified axis i.e, Chart at index2 will no longer mimic the axis range of ...
virtual void LinkAll(const size_t &flatIndex, int axis=1)
Link a chart to all other charts in this chart matrix for specified axis.
std::map< vtkVector2i, vtkVector2f > SpecificResize
void SetGutterY(float value)
Set the gutter that should be left between the charts in the matrix.
~vtkChartMatrix() override
virtual void UnlinkAll(const vtkVector2i &index, int axis=1)
Unlink all charts from given chart for a specified axis.
bool Paint(vtkContext2D *painter) override
Paint event for the chart matrix.
void SetGutterX(float value)
Set the gutter that should be left between the charts in the matrix.
virtual bool SetChartSpan(const vtkVector2i &position, const vtkVector2i &span)
Set the span of an element in the matrix.
virtual bool SetChartMatrix(const vtkVector2i &position, vtkChartMatrix *chartMatrix)
Set the element at position to a chart matrix, note that the chart matrix must be large enough to acc...
virtual void ResetLinkedLayout()
Unlink every chart from all other charts for a specified axis.
virtual vtkVector2f GetGutter() const
Get the gutter that should be left between the charts in the matrix.
virtual void SetRect(vtkRecti rect)
Set the rectangular region that this chart matrix will occupy.
virtual vtkChart * GetChart(const vtkVector2i &position)
Get the specified chart element, if the element does not exist nullptr will be returned.
virtual void ResetLinks(int axis=1)
Unlink every chart from all other charts for a specified axis.
virtual void SetPadding(const float &padding)
Set the gutter that should be left between the charts in the matrix.
virtual std::size_t GetNumberOfCharts()
Total number of charts within this chart matrix.
virtual void Link(const size_t &flatIndex1, const size_t &flatIndex2, int axis=1)
The chart at index2 will be setup to mimic axis range of chart at index1 for specified axis.
virtual void LabelOuter(const vtkVector2i &leftBottomIdx, const vtkVector2i &rightTopIdx)
Link all charts in the rectangle from leftBottom to rightTop.
static vtkChartMatrix * New()
Creates a new object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetSize(const vtkVector2i &size)
Set the width and height of the chart matrix.
virtual void LinkAll(const vtkVector2i &index, int axis=1)
Link a chart to all other charts in this chart matrix for specified axis.
virtual vtkVector2i GetChartIndex(const vtkVector2f &position)
Get the position of an element in the matrix at the specified location.
virtual void SetSpecificResize(const vtkVector2i &index, const vtkVector2f &resize)
Set a specific resize that will move the bottom left point of a chart.
virtual void ClearSpecificResizes()
Set a specific resize that will move the bottom left point of a chart.
virtual vtkRectf ComputeCurrentElementSceneRect(const vtkVector2i &index, const vtkVector2f &offset, const vtkVector2f &increment)
Override this method if you want to customize layout instead of the default.
virtual void Allocate()
Allocate the charts, this will cause any null chart to be allocated.
virtual bool IsDoneWithTraversal()
These methods offer an API to iterate over the layout and obtain the offset of each child element (ch...
virtual void SetBorders(int left, int bottom, int right, int top)
Set/get the borders of the chart matrix (space in pixels around each chart).
vtkSetEnumMacro(FillStrategy, StretchType)
This specifies whether the chart matrix will fill the entire scene or instead draw itself in a user p...
void Update() override
Perform any updates to the item that may be necessary before rendering.
virtual vtkChartMatrix * GetChartMatrix(const vtkVector2i &position)
Get the specified chart matrix element.
virtual void UnlinkAll(const size_t &flatIndex, int axis=1)
Unlink all charts from given chart for a specified axis.
void SetBorderLeft(int value)
Set/get the borders of the chart matrix (space in pixels around each chart).
Factory class for drawing 2D charts.
Definition: vtkChart.h:50
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:59
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract base class for most VTK objects
Definition: vtkObject.h:61
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:420
@ top
Definition: vtkX3D.h:502
@ value
Definition: vtkX3D.h:220
@ bottom
Definition: vtkX3D.h:290
@ position
Definition: vtkX3D.h:261
@ size
Definition: vtkX3D.h:253
@ index
Definition: vtkX3D.h:246
@ offset
Definition: vtkX3D.h:438