VTK  9.3.20240328
vtkScatterPlotMatrix.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 
17 #ifndef vtkScatterPlotMatrix_h
18 #define vtkScatterPlotMatrix_h
19 
20 #include "vtkChartMatrix.h"
21 #include "vtkChartsCoreModule.h" // For export macro
22 #include "vtkColor.h" // For member function return
23 #include "vtkNew.h" // For ivars
24 #include "vtkSmartPointer.h" // For ivars
25 #include "vtkStdString.h" // For ivars
26 #include "vtkWeakPointer.h" // For currentPainter
27 
28 VTK_ABI_NAMESPACE_BEGIN
29 class vtkStringArray;
30 class vtkTable;
31 class vtkAxis;
32 class vtkAnnotationLink;
33 class vtkTextProperty;
34 class vtkTooltipItem;
36 
37 class VTKCHARTSCORE_EXPORT vtkScatterPlotMatrix : public vtkChartMatrix
38 {
39 public:
40  enum
41  {
45  NOPLOT
46  };
47 
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
55 
59  void Update() override;
60 
64  bool Paint(vtkContext2D* painter) override;
65 
66  void SetScene(vtkContextScene* scene) override;
67 
73  virtual bool SetActivePlot(const vtkVector2i& position);
74 
78  void SetSize(const vtkVector2i& size) override;
79 
84 
90 
95  virtual void SetInput(vtkTable* table);
96 
100  void SetColumnVisibility(const vtkStdString& name, bool visible);
101 
107 
112 
117  void SetColumnVisibilityAll(bool visible);
118 
123 
127  virtual void SetVisibleColumns(vtkStringArray* visColumns);
128 
133  virtual void SetNumberOfBins(int numberOfBins);
134 
139  virtual int GetNumberOfBins() const { return this->NumberOfBins; }
140 
144  void SetPlotColor(int plotType, const vtkColor4ub& color);
145 
149  void SetPlotMarkerStyle(int plotType, int style);
150 
154  void SetPlotMarkerSize(int plotType, float size);
155 
159  bool Hit(const vtkContextMouseEvent& mouse) override;
160 
164  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
165 
169  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
170 
174  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
175 
177 
181  int GetPlotType(const vtkVector2i& pos);
182  int GetPlotType(int row, int column);
184 
186 
192 
194 
200 
202 
207  void SetGridVisibility(int plotType, bool visible);
208  bool GetGridVisibility(int plotType);
210 
212 
216  void SetBackgroundColor(int plotType, const vtkColor4ub& color);
219 
221 
225  void SetAxisColor(int plotType, const vtkColor4ub& color);
226  vtkColor4ub GetAxisColor(int plotType);
228 
230 
234  void SetGridColor(int plotType, const vtkColor4ub& color);
235  vtkColor4ub GetGridColor(int plotType);
237 
239 
244  void SetAxisLabelVisibility(int plotType, bool visible);
245  bool GetAxisLabelVisibility(int plotType);
247 
249 
253  void SetAxisLabelProperties(int plotType, vtkTextProperty* prop);
256 
258 
262  void SetAxisLabelNotation(int plotType, int notation);
263  int GetAxisLabelNotation(int plotType);
265 
267 
271  void SetAxisLabelPrecision(int plotType, int precision);
272  int GetAxisLabelPrecision(int plotType);
274 
276 
280  void SetTooltipNotation(int plotType, int notation);
281  void SetTooltipPrecision(int plotType, int precision);
282  int GetTooltipNotation(int plotType);
283  int GetTooltipPrecision(int plotType);
285 
289  void SetTooltip(vtkTooltipItem* tooltip);
290 
295 
300 
305 
307 
313 
315 
321 
326 
330  void UpdateChartSettings(int plotType);
331 
333 
338  virtual void SetSelectionMode(int);
339  vtkGetMacro(SelectionMode, int);
341 
346 
351 
356  void SetNumberOfFrames(int frames);
357 
363 
368 
374  bool AddAnimationPath(const vtkVector2i& move);
375 
380 
385 
390 
395  virtual void AdvanceAnimation();
396 
400  virtual vtkChart* GetMainChart();
401 
402 protected:
405 
409  void UpdateLayout();
410 
415 
417 
421  void AxisRangeForwarderCallback(vtkObject*, unsigned long, void*);
423 
428  void BigChartSelectionCallback(vtkObject*, unsigned long, void*);
429 
435  virtual void UpdateAnimationPath(const vtkVector2i& newActivePos);
436 
441  virtual void StartAnimation(vtkRenderWindowInteractor* interactor);
442 
446  static void ProcessEvents(
447  vtkObject* caller, unsigned long event, void* clientData, void* callerData);
448 
452  virtual void AddSupplementaryPlot(vtkChart* vtkNotUsed(chart), int vtkNotUsed(plotType),
453  vtkStdString vtkNotUsed(row), vtkStdString vtkNotUsed(column), int vtkNotUsed(plotCorner) = 0)
454  {
455  }
456 
457  // The position of the active plot (defaults to 0, 1).
459 
460  // A flag to show if the ActivePlot vector is valid or not
462 
463  // Weakly owned input data for the scatter plot matrix.
465 
466  // Strongly owned internal data for the column visibility.
468 
469  // The number of bins in the histograms.
471 
472  // The title of the scatter plot matrix.
475 
476  // The mode when the chart is doing selection.
478 
479  // How many frames should animations consist of, 0 means no transitions.
481 
482  // A flag to know if we are animating the scatter plot along an animation path
483  bool Animating;
484 
485 private:
487  void operator=(const vtkScatterPlotMatrix&) = delete;
488 
489  class PIMPL;
490  PIMPL* Private;
491  friend class PIMPL;
492 
493  vtkWeakPointer<vtkContext2D> CurrentPainter;
494  vtkMTimeType LayoutUpdatedTime;
495 
496  // Go through the process of calculating axis ranges, etc...
497  void UpdateAxes();
498  void ApplyAxisSetting(vtkChart* chart, const vtkStdString& x, const vtkStdString& y);
499 };
500 
501 VTK_ABI_NAMESPACE_END
502 #endif // vtkScatterPlotMatrix_h
takes care of drawing 2D axes
Definition: vtkAxis.h:170
container for a matrix of charts.
Factory class for drawing 2D charts.
Definition: vtkChart.h:150
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:69
data structure to represent mouse events.
Provides a 2D scene for vtkContextItem objects.
a simple class to control print indentation
Definition: vtkIndent.h:108
abstract base class for most VTK objects
Definition: vtkObject.h:161
platform-independent render window interaction including picking and frame rate control.
container for a matrix of charts.
void AxisRangeForwarderCallback(vtkObject *, unsigned long, void *)
Attach axis range listener so we can forward to dependent axes in matrix.
void SetGridVisibility(int plotType, bool visible)
Sets whether or not the grid for the given axis is visible given a plot type, which refers to vtkScat...
void UpdateChartSettings(int plotType)
Update charts based on settings given the plot type.
int GetAxisLabelNotation(int plotType)
Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{S...
vtkColor4ub GetScatterPlotSelectedActiveColor()
Set the scatter plot selected active chart background color.
virtual void SetInput(vtkTable *table)
Set the input table for the scatter plot matrix.
virtual bool SetActivePlot(const vtkVector2i &position)
Set the active plot, the one that will be displayed in the top-right.
void UpdateLayout()
Internal helper to do the layout of the charts in the scatter plot matrix.
void SetAxisLabelProperties(int plotType, vtkTextProperty *prop)
Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPl...
bool GetColumnVisibility(const vtkStdString &name)
Get the visibility of the specified column.
bool Hit(const vtkContextMouseEvent &mouse) override
Return true if the supplied x, y coordinate is inside the item.
int GetAxisLabelPrecision(int plotType)
Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{...
void SetPlotMarkerStyle(int plotType, int style)
Sets the marker style for the specified plotType.
vtkTextProperty * GetAxisLabelProperties(int plotType)
Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPl...
void Update() override
Perform any updates to the item that may be necessary before rendering.
virtual void AdvanceAnimation()
Advance the animation in response to the timer events.
void SetScene(vtkContextScene *scene) override
Set the vtkContextScene for the item, always set for an item in a scene.
void SetTitleProperties(vtkTextProperty *prop)
Set/get the text properties for the chart title, i.e.
vtkTooltipItem * GetTooltip() const
Get the vtkTooltipItem object that will be displayed by the active chart.
virtual vtkChart * GetMainChart()
Get the main plot (the one in the top-right of the matrix.
void SetScatterPlotSelectedRowColumnColor(const vtkColor4ub &color)
Set the scatter plot selected row/column charts' background color.
vtkColor4ub GetBackgroundColor(int plotType)
Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCA...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetNumberOfBins(int numberOfBins)
Set the number of bins in the histograms along the central diagonal of the scatter plot matrix.
virtual void UpdateAnimationPath(const vtkVector2i &newActivePos)
Given a new position for the active plot, calculate a an animation path from the old active plot to t...
static void ProcessEvents(vtkObject *caller, unsigned long event, void *clientData, void *callerData)
Process events and dispatch to the appropriate member functions.
static vtkScatterPlotMatrix * New()
Creates a new object.
void SetAxisLabelVisibility(int plotType, bool visible)
Sets whether or not the labels for the axes are visible, given a plot type, which refers to vtkScatte...
vtkStdString GetColumnName(int column)
Get the column name for the supplied index.
bool Paint(vtkContext2D *painter) override
Paint event for the chart matrix.
void InsertVisibleColumn(const vtkStdString &name, int index)
Insert the specified column at the index position of the visible columns.
void SetBackgroundColor(int plotType, const vtkColor4ub &color)
Sets the background color for the chart given a plot type, which refers to vtkScatterPlotMatrix::{SCA...
virtual vtkStringArray * GetVisibleColumns()
Get a list of the columns, and the order in which they are displayed.
void SetAxisColor(int plotType, const vtkColor4ub &color)
Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT,...
bool GetGridVisibility(int plotType)
Sets whether or not the grid for the given axis is visible given a plot type, which refers to vtkScat...
void SetAxisLabelPrecision(int plotType, int precision)
Sets the axis label precision for the axes given a plot type, which refers to vtkScatterPlotMatrix::{...
void SetSize(const vtkVector2i &size) override
Reset ActivePlotSet flag and call superclass method.
vtkTextProperty * GetTitleProperties()
Set/get the text properties for the chart title, i.e.
void ClearAnimationPath()
Clear the animation path.
int GetNumberOfFrames()
Get the number of animation frames in each transition.
bool BeginAnimationPath(vtkRenderWindowInteractor *interactor)
Trigger the animation of the scatter plot matrix to begin.
bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse) override
Mouse button down event.
virtual void SetVisibleColumns(vtkStringArray *visColumns)
Set the list of visible columns, and the order in which they will be displayed.
void UpdateSettings()
Convenient method to update all the chart settings.
void SetPlotMarkerSize(int plotType, float size)
Sets the marker size for the specified plotType.
virtual void StartAnimation(vtkRenderWindowInteractor *interactor)
Given the render window interactor, start animation of the animation path calculated above.
vtkIdType GetNumberOfAnimationPathElements()
Get the number of elements (transitions) in the animation path.
void SetScatterPlotSelectedActiveColor(const vtkColor4ub &color)
Set the scatter plot selected active chart background color.
vtkSmartPointer< vtkTable > Input
void ResizeBigChart()
Compute and set big chart resize.
void SetTooltipNotation(int plotType, int notation)
Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::...
int GetPlotType(int row, int column)
Returns the type of the plot at the given position.
void SetIndexedLabels(vtkStringArray *labels)
Set indexed labels array.
vtkStdString GetTitle()
Set/get the scatter plot title.
void SetPlotColor(int plotType, const vtkColor4ub &color)
Set the color for the specified plotType.
vtkColor4ub GetScatterPlotSelectedRowColumnColor()
Set the scatter plot selected row/column charts' background color.
vtkStringArray * GetIndexedLabels() const
Get the indexed labels array.
virtual int GetNumberOfBins() const
Get the number of bins the histograms along the central diagonal scatter plot matrix.
void SetTooltip(vtkTooltipItem *tooltip)
Set the vtkTooltipItem object that will be displayed by the active chart.
~vtkScatterPlotMatrix() override
bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override
Mouse move event.
void BigChartSelectionCallback(vtkObject *, unsigned long, void *)
The callback function when SelectionChangedEvent is invoked from the Big chart.
void SetColumnVisibility(const vtkStdString &name, bool visible)
Set the visibility of the specified column.
vtkColor4ub GetAxisColor(int plotType)
Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT,...
int GetPlotType(const vtkVector2i &pos)
Returns the type of the plot at the given position.
void SetGridColor(int plotType, const vtkColor4ub &color)
Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT,...
void SetColumnVisibilityAll(bool visible)
Set the visibility of all columns (true will make them all visible, false will remove all visible col...
bool AddAnimationPath(const vtkVector2i &move)
Add a move to the animation path.
void SetTitle(const vtkStdString &title)
Set/get the scatter plot title.
vtkVector2i GetAnimationPathElement(vtkIdType i)
Get the element specified from the animation path.
virtual vtkVector2i GetActivePlot()
Get the position of the active plot.
void AttachAxisRangeListener(vtkAxis *)
Attach axis range listener so we can forward to dependent axes in matrix.
virtual void AddSupplementaryPlot(vtkChart *vtkNotUsed(chart), int vtkNotUsed(plotType), vtkStdString vtkNotUsed(row), vtkStdString vtkNotUsed(column), int vtkNotUsed(plotCorner)=0)
Called when drawing a chart, does nothing at this level.
void SetNumberOfFrames(int frames)
Set the number of animation frames in each transition.
void SetAxisLabelNotation(int plotType, int notation)
Sets the axis label notation for the axes given a plot type, which refers to vtkScatterPlotMatrix::{S...
vtkSmartPointer< vtkTextProperty > TitleProperties
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse) override
Mouse button release event.
void SetTooltipPrecision(int plotType, int precision)
Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::...
bool GetAxisLabelVisibility(int plotType)
Sets whether or not the labels for the axes are visible, given a plot type, which refers to vtkScatte...
int GetTooltipNotation(int plotType)
Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::...
vtkAnnotationLink * GetAnnotationLink()
Get the AnnotationLink for the scatter plot matrix, this gives you access to the currently selected p...
vtkStdString GetRowName(int row)
Get the column name for the supplied index.
int GetTooltipPrecision(int plotType)
Set chart's tooltip notation and precision, given a plot type, which refers to vtkScatterPlotMatrix::...
vtkNew< vtkStringArray > VisibleColumns
virtual void SetSelectionMode(int)
Set/get the Selection Mode that will be used by the chart while doing selection.
vtkColor4ub GetGridColor(int plotType)
Sets the color for the axes given a plot type, which refers to vtkScatterPlotMatrix::{SCATTERPLOT,...
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:78
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:168
represent text properties.
takes care of drawing 2D axes
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:470
@ color
Definition: vtkX3D.h:221
@ style
Definition: vtkX3D.h:492
@ name
Definition: vtkX3D.h:219
@ position
Definition: vtkX3D.h:261
@ size
Definition: vtkX3D.h:253
@ index
Definition: vtkX3D.h:246
@ title
Definition: vtkX3D.h:500
int vtkIdType
Definition: vtkType.h:315
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270