vtkPlot.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 vtkPlot_h
#define vtkPlot_h
 
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkContextItem.h"
#include "vtkContextPolygon.h" // For vtkContextPolygon
#include "vtkDeprecation.h"    // For VTK_DEPRECATED_IN_9_3_0
#include "vtkRect.h"           // For vtkRectd ivar
#include "vtkSmartPointer.h"   // Needed to hold SP ivars
#include "vtkStdString.h"      // Needed to hold TooltipLabelFormat ivar
#include "vtkWrappingHints.h"  // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkVariant;
class vtkTable;
class vtkIdTypeArray;
class vtkContextMapper2D;
class vtkPen;
class vtkBrush;
class vtkAxis;
class vtkStringArray;
class vtkAlgorithmOutput;
 
class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlot : public vtkContextItem
{
public:
  vtkTypeMacro(vtkPlot, vtkContextItem);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Update() override;
 
 
  vtkSetMacro(LegendVisibility, bool);
  vtkGetMacro(LegendVisibility, bool);
  vtkBooleanMacro(LegendVisibility, bool);
 
  virtual bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex);
 
 
  virtual void SetTooltipLabelFormat(const vtkStdString& label);
  virtual vtkStdString GetTooltipLabelFormat();
 
 
  virtual void SetTooltipNotation(int notation);
  virtual int GetTooltipNotation();
 
 
  virtual void SetTooltipPrecision(int precision);
  virtual int GetTooltipPrecision();
 
  virtual vtkStdString GetTooltipLabel(
    const vtkVector2d& plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex);
 
  virtual vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
    vtkVector2f* location, vtkIdType* segmentId);
 
  virtual bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max);
 
  virtual bool SelectPointsInPolygon(const vtkContextPolygon& polygon);
 
  VTK_MARSHALSETTER(ColorRGBA)
  virtual void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
 
 
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  virtual void SetColorF(double r, double g, double b, double a);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  virtual void SetColorF(double r, double g, double b);
 
  // If removed, please remplace it with the following function:
  // SetColor(unsigned char r, unsigned char g, unsigned char b)
  // here and in the inheriting classes overriding it
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  VTK_DEPRECATED_IN_9_3_0("Please use unambiguous SetColorF method instead.")
  virtual void SetColor(double r, double g, double b) { this->SetColorF(r, g, b); }
 
 
  void GetColor(unsigned char rgb[3]);
  VTK_MARSHALGETTER(ColorRGBA)
  void GetColorRGBA(unsigned char rgba[4]);
 
 
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  virtual void GetColorF(double rgb[3]);
 
  // If removed, please make GetColor(unsigned char rgb[3]) virtual
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  VTK_DEPRECATED_IN_9_3_0("Please use unambiguous GetColorF method instead.")
  virtual void GetColor(double rgb[3]) { this->GetColorF(rgb); }
 
  virtual void SetWidth(float width);
 
  virtual float GetWidth();
 
 
  void SetPen(vtkPen* pen);
  vtkPen* GetPen();
 
 
  void SetBrush(vtkBrush* brush);
  vtkBrush* GetBrush();
 
 
  void SetSelectionPen(vtkPen* pen);
  vtkPen* GetSelectionPen();
 
 
  void SetSelectionBrush(vtkBrush* brush);
  vtkBrush* GetSelectionBrush();
 
  virtual void SetLabel(const vtkStdString& label);
 
  virtual vtkStdString GetLabel();
 
  virtual void SetLabels(vtkStringArray* labels);
 
  virtual vtkStringArray* GetLabels();
 
  virtual int GetNumberOfLabels();
 
  vtkStdString GetLabel(vtkIdType index);
 
  void SetIndexedLabels(vtkStringArray* labels);
 
  virtual vtkStringArray* GetIndexedLabels();
 
  vtkContextMapper2D* GetData();
 
 
  vtkGetMacro(UseIndexForXSeries, bool);
 
 
  vtkSetMacro(UseIndexForXSeries, bool);
 
 
  VTK_MARSHALSETTER(Input)
  virtual void SetInputData(vtkTable* table);
  virtual void SetInputData(
    vtkTable* table, const vtkStdString& xColumn, const vtkStdString& yColumn);
  void SetInputData(vtkTable* table, vtkIdType xColumn, vtkIdType yColumn);
 
 
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL);
  virtual void SetInputConnection(vtkAlgorithmOutput* input);
 
  VTK_MARSHALGETTER(Input)
  virtual vtkTable* GetInput();
 
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL);
  vtkAlgorithmOutput* GetInputConnection();
 
  virtual void SetInputArray(int index, const vtkStdString& name);
 
 
  void SetXAxisInputArrayToProcess(const std::string& name);
  std::string GetXAxisInputArrayToProcess();
  void SetYAxisInputArrayToProcess(const std::string& name);
  std::string GetYAxisInputArrayToProcess();
 
 
  vtkSetMacro(Selectable, bool);
  vtkGetMacro(Selectable, bool);
  vtkBooleanMacro(Selectable, bool);
 
 
  virtual void SetSelection(vtkIdTypeArray* id);
  vtkGetObjectMacro(Selection, vtkIdTypeArray);
 
 
  vtkGetObjectMacro(XAxis, vtkAxis);
  virtual void SetXAxis(vtkAxis* axis);
 
 
  vtkGetObjectMacro(YAxis, vtkAxis);
  virtual void SetYAxis(vtkAxis* axis);
 
 
  void SetShiftScale(const vtkRectd& shiftScale);
  vtkRectd GetShiftScale();
 
  virtual void GetBounds(double bounds[4]) { bounds[0] = bounds[1] = bounds[2] = bounds[3] = 0.0; }
 
  virtual void GetUnscaledInputBounds(double bounds[4])
  {
    // Implemented here by calling GetBounds() to support plot
    // subclasses that do no log-scaling or plot orientation.
    return this->GetBounds(bounds);
  }
 
 
  virtual void SetProperty(const vtkStdString& property, const vtkVariant& var);
  virtual vtkVariant GetProperty(const vtkStdString& property);
 
 
  static bool ClampPos(double pos[2], double bounds[4]);
  virtual bool ClampPos(double pos[2]);
 
  bool Hit(const vtkContextMouseEvent& mouse) override;
 
  virtual bool UpdateCache() { return true; }
 
  static void FilterSelectedPoints(
    vtkDataArray* points, vtkDataArray* selectedPoints, vtkIdTypeArray* selectedIds);
 
protected:
  vtkPlot();
  ~vtkPlot() override;
 
  vtkStdString GetNumber(double position, vtkAxis* axis);
 
 
  virtual void TransformScreenToData(const vtkVector2f& in, vtkVector2f& out);
  virtual void TransformDataToScreen(const vtkVector2f& in, vtkVector2f& out);
  virtual void TransformScreenToData(double inX, double inY, double& outX, double& outY);
  virtual void TransformDataToScreen(double inX, double inY, double& outX, double& outY);
 
  virtual bool CacheRequiresUpdate();
 
  vtkTimeStamp BuildTime;
 
  vtkSmartPointer<vtkPen> Pen;
 
  vtkSmartPointer<vtkBrush> Brush;
 
  vtkSmartPointer<vtkPen> SelectionPen;
 
  vtkSmartPointer<vtkBrush> SelectionBrush;
 
  vtkSmartPointer<vtkStringArray> Labels;
 
  vtkSmartPointer<vtkStringArray> AutoLabels;
 
  vtkSmartPointer<vtkStringArray> IndexedLabels;
 
  bool UseIndexForXSeries;
 
  vtkSmartPointer<vtkContextMapper2D> Data;
 
  bool Selectable;
 
  vtkIdTypeArray* Selection;
 
  vtkAxis* XAxis;
 
  vtkAxis* YAxis;
 
  vtkStdString TooltipLabelFormat;
 
  vtkStdString TooltipDefaultLabelFormat;
 
  int TooltipNotation;
  int TooltipPrecision;
 
  vtkRectd ShiftScale;
 
  bool LegendVisibility;
 
private:
  vtkPlot(const vtkPlot&) = delete;
  void operator=(const vtkPlot&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkPlot_h