vtkColorLegend.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 vtkColorLegend_h
#define vtkColorLegend_h

#include "vtkChartLegend.h"
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkSmartPointer.h"     // For SP ivars
#include "vtkVector.h"           // For vtkRectf
#include "vtkWrappingHints.h"    // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkAxis;
class vtkContextMouseEvent;
class vtkImageData;
class vtkScalarsToColors;
class vtkCallbackCommand;

class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkColorLegend : public vtkChartLegend
{
public:
  vtkTypeMacro(vtkColorLegend, vtkChartLegend);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkColorLegend* New();

  enum
  {
    VERTICAL = 0,
    HORIZONTAL
  };

  virtual void GetBounds(double bounds[4]);

  void Update() override;

  bool Paint(vtkContext2D* painter) override;


  virtual void SetTransferFunction(vtkScalarsToColors* transfer);
  virtual vtkScalarsToColors* GetTransferFunction();

  void SetPoint(float x, float y) override;

  virtual void SetTextureSize(float w, float h);
  virtual void GetTextureSize(float& w, float& h);

  virtual void SetPosition(const vtkRectf& pos);

  virtual vtkRectf GetPosition();

  vtkRectf GetBoundingRect(vtkContext2D* painter) override;


  virtual void SetOrientation(int orientation);
  vtkGetMacro(Orientation, int);


  virtual void SetTitle(const vtkStdString& title);
  virtual vtkStdString GetTitle();


  vtkSetMacro(DrawBorder, bool);
  vtkGetMacro(DrawBorder, bool);
  vtkBooleanMacro(DrawBorder, bool);

  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;

protected:
  vtkColorLegend();
  ~vtkColorLegend() override;

  virtual void ComputeTexture();


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

  void UpdateAxisPosition();

  vtkSmartPointer<vtkScalarsToColors> TransferFunction;
  vtkSmartPointer<vtkImageData> ImageData;
  vtkSmartPointer<vtkAxis> Axis;
  vtkSmartPointer<vtkCallbackCommand> Callback;
  bool Interpolate;
  bool CustomPositionSet;
  bool DrawBorder;
  vtkRectf Position;
  int Orientation;

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

VTK_ABI_NAMESPACE_END
#endif