VTK  9.1.0
vtkChartMatrix.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkChartMatrix.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
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 class vtkChart;
38 
39 class VTKCHARTSCORE_EXPORT vtkChartMatrix : public vtkAbstractContextItem
40 {
41 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
48  static vtkChartMatrix* New();
49 
53  void Update() override;
54 
58  bool Paint(vtkContext2D* painter) override;
59 
65  virtual void SetSize(const vtkVector2i& size);
66 
70  virtual vtkVector2i GetSize() const { return this->Size; }
71 
73 
76  virtual void SetBorders(int left, int bottom, int right, int top);
77  void SetBorderLeft(int value);
79  void SetBorderRight(int value);
80  void SetBorderTop(int value);
81  virtual void GetBorders(int borders[4])
82  {
83  for (int i = 0; i < 4; i++)
84  {
85  borders[i] = this->Borders[i];
86  }
87  }
89 
91 
94  virtual void SetGutter(const vtkVector2f& gutter);
95  void SetGutterX(float value);
96  void SetGutterY(float value);
98 
100 
103  virtual void SetSpecificResize(const vtkVector2i& index, const vtkVector2f& resize);
104  virtual void ClearSpecificResizes();
106 
110  virtual vtkVector2f GetGutter() const { return this->Gutter; }
111 
115  virtual void Allocate();
116 
123  virtual bool SetChart(const vtkVector2i& position, vtkChart* chart);
124 
131 
137  virtual bool SetChartSpan(const vtkVector2i& position, const vtkVector2i& span);
138 
143 
149 
153  virtual std::size_t GetFlatIndex(const vtkVector2i& index);
154 
158  virtual std::size_t GetNumberOfCharts();
159 
165  virtual void LabelOuter(const vtkVector2i& leftBottomIdx, const vtkVector2i& rightTopIdx);
166 
168 
174  virtual void Link(const vtkVector2i& index1, const vtkVector2i& index2, int axis = 1);
175  virtual void Link(const size_t& flatIndex1, const size_t& flatIndex2, int axis = 1);
177 
179 
182  virtual void LinkAll(const vtkVector2i& index, int axis = 1);
183  virtual void LinkAll(const size_t& flatIndex, int axis = 1);
185 
187 
191  virtual void Unlink(const vtkVector2i& index1, const vtkVector2i& index2, int axis = 1);
192  virtual void Unlink(const size_t& flatIndex1, const size_t& flatIndex2, int axis = 1);
194 
196 
199  virtual void UnlinkAll(const vtkVector2i& index, int axis = 1);
200  virtual void UnlinkAll(const size_t& flatIndex, int axis = 1);
202 
204 
211  virtual void ResetLinks(int axis = 1);
212  virtual void ResetLinkedLayout();
214 
216 
220  virtual void SetRect(vtkRecti rect);
221  vtkGetMacro(Rect, vtkRecti);
223 
231  virtual bool SetChartMatrix(const vtkVector2i& position, vtkChartMatrix* chartMatrix);
232 
239 
241 
248  virtual bool IsDoneWithTraversal();
250 
257  const vtkVector2i& index, const vtkVector2f& offset, const vtkVector2f& increment);
258 
259  enum class StretchType : unsigned int
260  {
261  SCENE = 0,
262  CUSTOM
263  };
265 
269  vtkSetEnumMacro(FillStrategy, StretchType);
270  StretchType GetFillStrategy() { return this->FillStrategy; }
272 
273 protected:
275  ~vtkChartMatrix() override;
276 
277  // The number of charts in x and y.
279 
280  // The gutter between each chart.
282  std::map<vtkVector2i, vtkVector2f> SpecificResize;
283  int Borders[4];
285 
286  // The rectangular region to occupy. (in scene coordinates.)
287  vtkRecti Rect = { 0, 0, 100, 100 };
288  StretchType FillStrategy = StretchType::SCENE;
289 
290  virtual void SynchronizeAxisRanges(vtkObject* caller, unsigned long eventId, void* calldata);
291 
292 private:
293  vtkChartMatrix(const vtkChartMatrix&) = delete;
294  void operator=(const vtkChartMatrix&) = delete;
295 
296  class PIMPL;
297  PIMPL* Private;
298 };
299 
300 #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 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:45
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:54
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:419
@ top
Definition: vtkX3D.h:508
@ value
Definition: vtkX3D.h:226
@ bottom
Definition: vtkX3D.h:296
@ position
Definition: vtkX3D.h:267
@ size
Definition: vtkX3D.h:259
@ index
Definition: vtkX3D.h:252
@ offset
Definition: vtkX3D.h:444