vtkPlotPoints.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 vtkPlotPoints_h
#define vtkPlotPoints_h

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkNew.h"              // For ivars
#include "vtkPlot.h"
#include "vtkRenderingCoreEnums.h" // For marker enum
#include "vtkScalarsToColors.h"    // For VTK_COLOR_MODE_DEFAULT and _MAP_SCALARS
#include "vtkStdString.h"          // For color array name
#include "vtkWrappingHints.h"      // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkCharArray;
class vtkContext2D;
class vtkTable;
class vtkPoints2D;
class vtkFloatArray;
class vtkImageData;
class vtkScalarsToColors;
class vtkUnsignedCharArray;

class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlotPoints : public vtkPlot
{
public:
  vtkTypeMacro(vtkPlotPoints, vtkPlot);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkPlotPoints* New();

  bool Paint(vtkContext2D* painter) override;

  bool PaintLegend(vtkContext2D* painter, const vtkRectf& rect, int legendIndex) override;

  void GetBounds(double bounds[4]) override;

  void GetUnscaledInputBounds(double bounds[4]) override;


  void SetLookupTable(vtkScalarsToColors* lut);
  vtkScalarsToColors* GetLookupTable();

  virtual void CreateDefaultLookupTable();


  vtkSetMacro(ScalarVisibility, vtkTypeBool);
  vtkGetMacro(ScalarVisibility, vtkTypeBool);
  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);


  void SelectColorArray(vtkIdType arrayNum);
  void SelectColorArray(const vtkStdString& arrayName);

  vtkStdString GetColorArrayName();

  vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance,
    vtkVector2f* location, vtkIdType* segmentId) override;
  using vtkPlot::GetNearestPoint;

  bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max) override;

  bool SelectPointsInPolygon(const vtkContextPolygon& polygon) override;

  enum
  {
    NONE = VTK_MARKER_NONE,
    CROSS = VTK_MARKER_CROSS,
    PLUS = VTK_MARKER_PLUS,
    SQUARE = VTK_MARKER_SQUARE,
    CIRCLE = VTK_MARKER_CIRCLE,
    DIAMOND = VTK_MARKER_DIAMOND
  };


  vtkGetMacro(MarkerStyle, int);
  vtkSetMacro(MarkerStyle, int);


  vtkGetMacro(MarkerSize, float);
  vtkSetMacro(MarkerSize, float);


  vtkGetMacro(ValidPointMaskName, vtkStdString);
  vtkSetMacro(ValidPointMaskName, vtkStdString);

  bool UpdateCache() override;

  void ReleaseGraphicsCache() override;

protected:
  vtkPlotPoints();
  ~vtkPlotPoints() override;

  bool GetDataArrays(vtkTable* table, vtkDataArray* array[2]);

  bool CacheRequiresUpdate() override;

  void CalculateUnscaledInputBounds();

  void CalculateLogSeries();

  void FindBadPoints();

  void CalculateBounds(double bounds[4]);

  void CreateSortedPoints();


  vtkPoints2D* Points;
  vtkNew<vtkFloatArray> SelectedPoints;


  class VectorPIMPL;
  VectorPIMPL* Sorted;

  vtkIdTypeArray* BadPoints;

  vtkCharArray* ValidPointMask;

  vtkStdString ValidPointMaskName;


  int MarkerStyle;
  float MarkerSize;

  bool LogX, LogY;


  vtkScalarsToColors* LookupTable;
  vtkUnsignedCharArray* Colors;
  vtkTypeBool ScalarVisibility;
  vtkStdString ColorArrayName;

  double UnscaledInputBounds[4];

private:
  vtkPlotPoints(const vtkPlotPoints&) = delete;
  void operator=(const vtkPlotPoints&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkPlotPoints_h