VTK  9.1.0
vtkScatterPlotMatrix.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkScatterPlotMatrix.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 vtkScatterPlotMatrix_h
27#define vtkScatterPlotMatrix_h
28
29#include "vtkChartMatrix.h"
30#include "vtkChartsCoreModule.h" // For export macro
31#include "vtkColor.h" // For member function return
32#include "vtkNew.h" // For ivars
33#include "vtkSmartPointer.h" // For ivars
34#include "vtkStdString.h" // For ivars
35#include "vtkWeakPointer.h" // For currentPainter
36
37class vtkStringArray;
38class vtkTable;
39class vtkAxis;
41class vtkTextProperty;
42class vtkTooltipItem;
44
45class VTKCHARTSCORE_EXPORT vtkScatterPlotMatrix : public vtkChartMatrix
46{
47public:
48 enum
49 {
53 NOPLOT
54 };
55
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
63
67 void Update() override;
68
72 bool Paint(vtkContext2D* painter) override;
73
74 void SetScene(vtkContextScene* scene) override;
75
81 virtual bool SetActivePlot(const vtkVector2i& position);
82
86 void SetSize(const vtkVector2i& size) override;
87
92
98
103 virtual void SetInput(vtkTable* table);
104
108 void SetColumnVisibility(const vtkStdString& name, bool visible);
109
114 void InsertVisibleColumn(const vtkStdString& name, int index);
115
120
125 void SetColumnVisibilityAll(bool visible);
126
131
135 virtual void SetVisibleColumns(vtkStringArray* visColumns);
136
141 virtual void SetNumberOfBins(int numberOfBins);
142
147 virtual int GetNumberOfBins() const { return this->NumberOfBins; }
148
152 void SetPlotColor(int plotType, const vtkColor4ub& color);
153
157 void SetPlotMarkerStyle(int plotType, int style);
158
162 void SetPlotMarkerSize(int plotType, float size);
163
167 bool Hit(const vtkContextMouseEvent& mouse) override;
168
172 bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
173
177 bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
178
183
185
189 int GetPlotType(const vtkVector2i& pos);
190 int GetPlotType(int row, int column);
192
194
197 void SetTitle(const vtkStdString& title);
200
202
208
210
215 void SetGridVisibility(int plotType, bool visible);
216 bool GetGridVisibility(int plotType);
218
220
224 void SetBackgroundColor(int plotType, const vtkColor4ub& color);
227
229
233 void SetAxisColor(int plotType, const vtkColor4ub& color);
236
238
242 void SetGridColor(int plotType, const vtkColor4ub& color);
245
247
252 void SetAxisLabelVisibility(int plotType, bool visible);
253 bool GetAxisLabelVisibility(int plotType);
255
257
261 void SetAxisLabelProperties(int plotType, vtkTextProperty* prop);
264
266
270 void SetAxisLabelNotation(int plotType, int notation);
271 int GetAxisLabelNotation(int plotType);
273
275
279 void SetAxisLabelPrecision(int plotType, int precision);
280 int GetAxisLabelPrecision(int plotType);
282
284
288 void SetTooltipNotation(int plotType, int notation);
289 void SetTooltipPrecision(int plotType, int precision);
290 int GetTooltipNotation(int plotType);
291 int GetTooltipPrecision(int plotType);
293
298
303
308
313
315
321
323
329
334
338 void UpdateChartSettings(int plotType);
339
341
346 virtual void SetSelectionMode(int);
347 vtkGetMacro(SelectionMode, int);
349
354
359
364 void SetNumberOfFrames(int frames);
365
371
376
382 bool AddAnimationPath(const vtkVector2i& move);
383
388
393
398
403 virtual void AdvanceAnimation();
404
409
410protected:
413
418
423
425
429 void AxisRangeForwarderCallback(vtkObject*, unsigned long, void*);
431
436 void BigChartSelectionCallback(vtkObject*, unsigned long, void*);
437
443 virtual void UpdateAnimationPath(const vtkVector2i& newActivePos);
444
449 virtual void StartAnimation(vtkRenderWindowInteractor* interactor);
450
454 static void ProcessEvents(
455 vtkObject* caller, unsigned long event, void* clientData, void* callerData);
456
460 virtual void AddSupplementaryPlot(vtkChart* vtkNotUsed(chart), int vtkNotUsed(plotType),
461 vtkStdString vtkNotUsed(row), vtkStdString vtkNotUsed(column), int vtkNotUsed(plotCorner) = 0)
462 {
463 }
464
465 // The position of the active plot (defaults to 0, 1).
467
468 // A flag to show if the ActivePlot vector is valid or not
470
471 // Weakly owned input data for the scatter plot matrix.
473
474 // Strongly owned internal data for the column visibility.
476
477 // The number of bins in the histograms.
479
480 // The title of the scatter plot matrix.
483
484 // The mode when the chart is doing selection.
486
487 // How many frames should animations consist of, 0 means no transitions.
489
490 // A flag to know if we are animating the scatter plot along an animation path
492
493private:
495 void operator=(const vtkScatterPlotMatrix&) = delete;
496
497 class PIMPL;
498 PIMPL* Private;
499 friend class PIMPL;
500
501 vtkWeakPointer<vtkContext2D> CurrentPainter;
502 vtkMTimeType LayoutUpdatedTime;
503
504 // Go through the process of calculating axis ranges, etc...
505 void UpdateAxes();
506 void ApplyAxisSetting(vtkChart* chart, const vtkStdString& x, const vtkStdString& y);
507};
508
509#endif // vtkScatterPlotMatrix_h
takes care of drawing 2D axes
Definition: vtkAxis.h:178
container for a matrix of charts.
Factory class for drawing 2D charts.
Definition: vtkChart.h:45
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:73
data structure to represent mouse events.
Provides a 2D scene for vtkContextItem objects.
a simple class to control print indentation
Definition: vtkIndent.h:113
Allocate and hold a VTK object.
Definition: vtkNew.h:165
abstract base class for most VTK objects
Definition: vtkObject.h:82
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 vtkChart * GetMainChart()
Get the main plot (the one in the top-right of the matrix.
virtual vtkStringArray * GetVisibleColumns()
Get a list of the columns, and the order in which they are displayed.
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.
vtkTextProperty * GetAxisLabelProperties(int plotType)
Set/get the text property for the axis labels of the given plot type, possible types are vtkScatterPl...
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.
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.
vtkStringArray * GetIndexedLabels() const
Get the indexed labels array.
void SetTitleProperties(vtkTextProperty *prop)
Set/get the text properties for the chart title, i.e.
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.
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...
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.
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.
vtkTooltipItem * GetTooltip() const
Get the vtkTooltipItem object that will be displayed by the active chart.
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.
vtkAnnotationLink * GetAnnotationLink()
Get the AnnotationLink for the scatter plot matrix, this gives you access to the currently selected p...
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.
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,...
static vtkScatterPlotMatrix * New()
Creates a new object.
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.
vtkTextProperty * GetTitleProperties()
Set/get the text properties for the chart title, i.e.
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::...
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,...
Hold a reference to a vtkObjectBase instance.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:172
represent text properties.
takes care of drawing 2D axes
Some derived classes for the different vectors commonly used.
Definition: vtkVector.h:478
a weak reference to a vtkObject.
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287