vtkScalarsToColorsItem.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 vtkScalarsToColorsItem_h
#define vtkScalarsToColorsItem_h

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkNew.h"              // For vtkNew
#include "vtkPlot.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkImageData;
class vtkPlotBar;
class vtkPoints2D;

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

  void GetBounds(double bounds[4]) override;


  vtkSetVector4Macro(UserBounds, double);
  vtkGetVector4Macro(UserBounds, double);

  bool Paint(vtkContext2D* painter) override;


  vtkGetObjectMacro(PolyLinePen, vtkPen);


  void SetHistogramTable(vtkTable* histogramTable);
  vtkGetObjectMacro(HistogramTable, vtkTable);


  vtkSetMacro(MaskAboveCurve, bool);
  vtkGetMacro(MaskAboveCurve, bool);

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

  vtkStdString GetTooltipLabel(
    const vtkVector2d& plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override;

protected:
  vtkScalarsToColorsItem();
  ~vtkScalarsToColorsItem() override;

  virtual void ComputeBounds(double* bounds);

  virtual void ComputeTexture() = 0;

  vtkGetMacro(TextureWidth, int);

  virtual bool ConfigurePlotBar();


  virtual void ScalarsToColorsModified(vtkObject* caller, unsigned long eid, void* calldata);
  static void OnScalarsToColorsModified(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);

  double UserBounds[4];

  bool Interpolate = true;
  int TextureWidth;
  vtkImageData* Texture = nullptr;
  vtkTable* HistogramTable = nullptr;

  vtkNew<vtkPoints2D> Shape;
  vtkNew<vtkCallbackCommand> Callback;
  vtkNew<vtkPlotBar> PlotBar;
  vtkNew<vtkPen> PolyLinePen;
  bool MaskAboveCurve;

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

VTK_ABI_NAMESPACE_END
#endif