vtkScatterPlotMatrix.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 vtkScatterPlotMatrix_h
#define vtkScatterPlotMatrix_h
 
#include "vtkChartMatrix.h"
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkColor.h"            // For member function return
#include "vtkNew.h"              // For ivars
#include "vtkSmartPointer.h"     // For ivars
#include "vtkStdString.h"        // For ivars
#include "vtkWeakPointer.h"      // For currentPainter
 
VTK_ABI_NAMESPACE_BEGIN
class vtkStringArray;
class vtkTable;
class vtkAxis;
class vtkAnnotationLink;
class vtkTextProperty;
class vtkTooltipItem;
class vtkRenderWindowInteractor;
 
class VTKCHARTSCORE_EXPORT vtkScatterPlotMatrix : public vtkChartMatrix
{
public:
  enum
  {
    SCATTERPLOT,
    HISTOGRAM,
    ACTIVEPLOT,
    NOPLOT
  };
 
  vtkTypeMacro(vtkScatterPlotMatrix, vtkChartMatrix);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkScatterPlotMatrix* New();
 
  void Update() override;
 
  bool Paint(vtkContext2D* painter) override;
 
  void SetScene(vtkContextScene* scene) override;
 
  virtual bool SetActivePlot(const vtkVector2i& position);
 
  void SetSize(const vtkVector2i& size) override;
 
  virtual vtkVector2i GetActivePlot();
 
  vtkAnnotationLink* GetAnnotationLink();
 
  virtual void SetInput(vtkTable* table);
 
  void SetColumnVisibility(const vtkStdString& name, bool visible);
 
  void InsertVisibleColumn(const vtkStdString& name, int index);
 
  bool GetColumnVisibility(const vtkStdString& name);
 
  void SetColumnVisibilityAll(bool visible);
 
  virtual vtkStringArray* GetVisibleColumns();
 
  virtual void SetVisibleColumns(vtkStringArray* visColumns);
 
  virtual void SetNumberOfBins(int numberOfBins);
 
  virtual int GetNumberOfBins() const { return this->NumberOfBins; }
 
  void SetPlotColor(int plotType, const vtkColor4ub& color);
 
  void SetPlotMarkerStyle(int plotType, int style);
 
  void SetPlotMarkerSize(int plotType, float size);
 
  bool Hit(const vtkContextMouseEvent& mouse) override;
 
  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
 
  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;
 
  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;
 
 
  int GetPlotType(const vtkVector2i& pos);
  int GetPlotType(int row, int column);
 
 
  void SetTitle(const vtkStdString& title);
  vtkStdString GetTitle();
 
 
  void SetTitleProperties(vtkTextProperty* prop);
  vtkTextProperty* GetTitleProperties();
 
 
  void SetGridVisibility(int plotType, bool visible);
  bool GetGridVisibility(int plotType);
 
 
  void SetBackgroundColor(int plotType, const vtkColor4ub& color);
  vtkColor4ub GetBackgroundColor(int plotType);
 
 
  void SetAxisColor(int plotType, const vtkColor4ub& color);
  vtkColor4ub GetAxisColor(int plotType);
 
 
  void SetGridColor(int plotType, const vtkColor4ub& color);
  vtkColor4ub GetGridColor(int plotType);
 
 
  void SetAxisLabelVisibility(int plotType, bool visible);
  bool GetAxisLabelVisibility(int plotType);
 
 
  void SetAxisLabelProperties(int plotType, vtkTextProperty* prop);
  vtkTextProperty* GetAxisLabelProperties(int plotType);
 
 
  void SetAxisLabelNotation(int plotType, int notation);
  int GetAxisLabelNotation(int plotType);
 
 
  void SetAxisLabelPrecision(int plotType, int precision);
  int GetAxisLabelPrecision(int plotType);
 
 
  void SetTooltipNotation(int plotType, int notation);
  void SetTooltipPrecision(int plotType, int precision);
  int GetTooltipNotation(int plotType);
  int GetTooltipPrecision(int plotType);
 
  void SetTooltip(vtkTooltipItem* tooltip);
 
  vtkTooltipItem* GetTooltip() const;
 
  void SetIndexedLabels(vtkStringArray* labels);
 
  vtkStringArray* GetIndexedLabels() const;
 
 
  void SetScatterPlotSelectedRowColumnColor(const vtkColor4ub& color);
  vtkColor4ub GetScatterPlotSelectedRowColumnColor();
 
 
  void SetScatterPlotSelectedActiveColor(const vtkColor4ub& color);
  vtkColor4ub GetScatterPlotSelectedActiveColor();
 
  void UpdateSettings();
 
  void UpdateChartSettings(int plotType);
 
 
  virtual void SetSelectionMode(int);
  vtkGetMacro(SelectionMode, int);
 
  vtkStdString GetColumnName(int column);
 
  vtkStdString GetRowName(int row);
 
  void SetNumberOfFrames(int frames);
 
  int GetNumberOfFrames();
 
  void ClearAnimationPath();
 
  bool AddAnimationPath(const vtkVector2i& move);
 
  vtkIdType GetNumberOfAnimationPathElements();
 
  vtkVector2i GetAnimationPathElement(vtkIdType i);
 
  bool BeginAnimationPath(vtkRenderWindowInteractor* interactor);
 
  virtual void AdvanceAnimation();
 
  virtual vtkChart* GetMainChart();
 
protected:
  vtkScatterPlotMatrix();
  ~vtkScatterPlotMatrix() override;
 
  void UpdateLayout();
 
  void ResizeBigChart();
 
 
  void AttachAxisRangeListener(vtkAxis*);
  void AxisRangeForwarderCallback(vtkObject*, unsigned long, void*);
 
  void BigChartSelectionCallback(vtkObject*, unsigned long, void*);
 
  virtual void UpdateAnimationPath(const vtkVector2i& newActivePos);
 
  virtual void StartAnimation(vtkRenderWindowInteractor* interactor);
 
  static void ProcessEvents(
    vtkObject* caller, unsigned long event, void* clientData, void* callerData);
 
  virtual void AddSupplementaryPlot(vtkChart* vtkNotUsed(chart), int vtkNotUsed(plotType),
    vtkStdString vtkNotUsed(row), vtkStdString vtkNotUsed(column), int vtkNotUsed(plotCorner) = 0)
  {
  }
 
  // The position of the active plot (defaults to 0, 1).
  vtkVector2i ActivePlot;
 
  // A flag to show if the ActivePlot vector is valid or not
  bool ActivePlotValid;
 
  // Weakly owned input data for the scatter plot matrix.
  vtkSmartPointer<vtkTable> Input;
 
  // Strongly owned internal data for the column visibility.
  vtkNew<vtkStringArray> VisibleColumns;
 
  // The number of bins in the histograms.
  int NumberOfBins;
 
  // The title of the scatter plot matrix.
  vtkStdString Title;
  vtkSmartPointer<vtkTextProperty> TitleProperties;
 
  // The mode when the chart is doing selection.
  int SelectionMode;
 
  // How many frames should animations consist of, 0 means no transitions.
  int NumberOfFrames;
 
  // A flag to know if we are animating the scatter plot along an animation path
  bool Animating;
 
private:
  vtkScatterPlotMatrix(const vtkScatterPlotMatrix&) = delete;
  void operator=(const vtkScatterPlotMatrix&) = delete;
 
  class PIMPL;
  PIMPL* Private;
  friend class PIMPL;
 
  vtkWeakPointer<vtkContext2D> CurrentPainter;
  vtkMTimeType LayoutUpdatedTime;
 
  // Go through the process of calculating axis ranges, etc...
  void UpdateAxes();
  void ApplyAxisSetting(vtkChart* chart, const vtkStdString& x, const vtkStdString& y);
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkScatterPlotMatrix_h