vtkImageStencil.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 vtkImageStencil_h
#define vtkImageStencil_h
 
#include "vtkImagingStencilModule.h" // For export macro
#include "vtkThreadedImageAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkImageStencilData;
 
class VTKIMAGINGSTENCIL_EXPORT vtkImageStencil : public vtkThreadedImageAlgorithm
{
public:
  static vtkImageStencil* New();
  vtkTypeMacro(vtkImageStencil, vtkThreadedImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetStencilData(vtkImageStencilData* stencil);
  vtkImageStencilData* GetStencil();

  void SetStencilConnection(vtkAlgorithmOutput* outputPort)
  {
    this->SetInputConnection(2, outputPort);
  }


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


  virtual void SetBackgroundInputData(vtkImageData* input);
  vtkImageData* GetBackgroundInput();


  void SetBackgroundValue(double val) { this->SetBackgroundColor(val, val, val, val); }
  double GetBackgroundValue() { return this->BackgroundColor[0]; }


  vtkSetVector4Macro(BackgroundColor, double);
  vtkGetVector4Macro(BackgroundColor, double);
 
protected:
  vtkImageStencil();
  ~vtkImageStencil() override;
 
  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
    int extent[6], int id) override;
 
  vtkTypeBool ReverseStencil;
  double BackgroundColor[4];
 
  int FillInputPortInformation(int, vtkInformation*) override;
 
private:
  vtkImageStencil(const vtkImageStencil&) = delete;
  void operator=(const vtkImageStencil&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif