vtkImageBlend.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 vtkImageBlend_h
#define vtkImageBlend_h

#include "vtkImagingCoreModule.h" // For export macro
#include "vtkThreadedImageAlgorithm.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkImageStencilData;

#define VTK_IMAGE_BLEND_MODE_NORMAL 0
#define VTK_IMAGE_BLEND_MODE_COMPOUND 1

class VTKIMAGINGCORE_EXPORT vtkImageBlend : public vtkThreadedImageAlgorithm
{
public:
  static vtkImageBlend* New();
  vtkTypeMacro(vtkImageBlend, vtkThreadedImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);


  void SetInputData(int num, vtkDataObject* input);
  void SetInputData(vtkDataObject* input) { this->SetInputData(0, input); }


  vtkDataObject* GetInput(int num);
  vtkDataObject* GetInput() { return this->GetInput(0); }

  int GetNumberOfInputs() { return this->GetNumberOfInputConnections(0); }


  void SetOpacity(int idx, double opacity);
  double GetOpacity(int idx);

  void SetStencilConnection(vtkAlgorithmOutput* algOutput);


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


  vtkSetClampMacro(BlendMode, int, VTK_IMAGE_BLEND_MODE_NORMAL, VTK_IMAGE_BLEND_MODE_COMPOUND);
  vtkGetMacro(BlendMode, int);
  void SetBlendModeToNormal() { this->SetBlendMode(VTK_IMAGE_BLEND_MODE_NORMAL); }
  void SetBlendModeToCompound() { this->SetBlendMode(VTK_IMAGE_BLEND_MODE_COMPOUND); }
  const char* GetBlendModeAsString();


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


  vtkSetMacro(CompoundThreshold, double);
  vtkGetMacro(CompoundThreshold, double);


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

protected:
  vtkImageBlend();
  ~vtkImageBlend() override;

  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  void InternalComputeInputUpdateExtent(
    int inExt[6], VTK_FUTURE_CONST int outExt[6], VTK_FUTURE_CONST int inWExtent[6]);

  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
    VTK_FUTURE_CONST int ext[6], int id) override;

  // see vtkAlgorithm for docs.
  int FillInputPortInformation(int, vtkInformation*) override;

  // see vtkAlgorithm for docs.
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  double* Opacity;
  int OpacityArrayLength;
  int BlendMode;
  double CompoundThreshold;
  vtkTypeBool DataWasPassed;
  vtkTypeBool BlendAlpha;
  vtkTypeBool CompoundAlpha;

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

inline const char* vtkImageBlend::GetBlendModeAsString()
{
  switch (this->BlendMode)
  {
    case VTK_IMAGE_BLEND_MODE_NORMAL:
      return "Normal";
    case VTK_IMAGE_BLEND_MODE_COMPOUND:
      return "Compound";
    default:
      return "Unknown Blend Mode";
  }
}

VTK_ABI_NAMESPACE_END
#endif