vtkPVTransferFunction2D.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVTransferFunction2D_h
#define vtkPVTransferFunction2D_h

// VTK includes
#include <vtkObject.h>

#include "vtkPVTransferFunction2DBox.h" // needed for ivar
#include "vtkRemotingViewsModule.h"     // needed for export macro

#include <memory> // for unique_ptr
#include <vector> // needed for ivar

// Forward declarations
class vtkImageData;
class vtkPVTransferFunction2DInternals;

class VTKREMOTINGVIEWS_EXPORT vtkPVTransferFunction2D : public vtkObject
{
public:
  static vtkPVTransferFunction2D* New();


  vtkTypeMacro(vtkPVTransferFunction2D, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void Build();


  vtkSetVector2Macro(OutputDimensions, int);
  vtkGetVector2Macro(OutputDimensions, int);


  int AddControlBox(
    double x, double y, double width, double height, double r, double g, double b, double a);
  int AddControlBox(double x, double y, double width, double height, double* color);
  int AddControlBox(vtkRectd& box, double* color);
  int AddControlBox(vtkSmartPointer<vtkPVTransferFunction2DBox> box);
  int SetControlBox(int id, vtkSmartPointer<vtkPVTransferFunction2DBox> box);
  int RemoveControlBox(int id);
  int RemoveControlBox(vtkSmartPointer<vtkPVTransferFunction2DBox> box);

  std::vector<vtkSmartPointer<vtkPVTransferFunction2DBox>> GetBoxes();

  void RemoveAllBoxes();


  vtkSetVector4Macro(Range, double);
  vtkGetVector4Macro(Range, double);

  vtkImageData* GetFunction();

protected:
  vtkPVTransferFunction2D();
  ~vtkPVTransferFunction2D() override;

  // Helper members
  double Range[4] = { 0, 0, 0, 0 };

  int OutputDimensions[2] = { 10, 10 };

  bool UpdateRange();

private:
  // Helper members
  std::unique_ptr<vtkPVTransferFunction2DInternals> Internals;

  vtkPVTransferFunction2D(const vtkPVTransferFunction2D&) = delete;
  void operator=(const vtkPVTransferFunction2D) = delete;
};

#endif // vtkPVTransferFunction2D_h