VTK  9.0.1
vtkImageBlend.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageBlend.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
76 #ifndef vtkImageBlend_h
77 #define vtkImageBlend_h
78 
79 #include "vtkImagingCoreModule.h" // For export macro
81 
83 
84 #define VTK_IMAGE_BLEND_MODE_NORMAL 0
85 #define VTK_IMAGE_BLEND_MODE_COMPOUND 1
86 
87 class VTKIMAGINGCORE_EXPORT vtkImageBlend : public vtkThreadedImageAlgorithm
88 {
89 public:
90  static vtkImageBlend* New();
92  void PrintSelf(ostream& os, vtkIndent indent) override;
93 
100  virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);
101 
103 
108  void SetInputData(int num, vtkDataObject* input);
109  void SetInputData(vtkDataObject* input) { this->SetInputData(0, input); }
111 
113 
118  vtkDataObject* GetInput(int num);
119  vtkDataObject* GetInput() { return this->GetInput(0); }
121 
128 
130 
134  void SetOpacity(int idx, double opacity);
135  double GetOpacity(int idx);
137 
142  void SetStencilConnection(vtkAlgorithmOutput* algOutput);
143 
145 
148  void SetStencilData(vtkImageStencilData* stencil);
149  vtkImageStencilData* GetStencil();
151 
153 
156  vtkSetClampMacro(BlendMode, int, VTK_IMAGE_BLEND_MODE_NORMAL, VTK_IMAGE_BLEND_MODE_COMPOUND);
157  vtkGetMacro(BlendMode, int);
158  void SetBlendModeToNormal() { this->SetBlendMode(VTK_IMAGE_BLEND_MODE_NORMAL); }
160  const char* GetBlendModeAsString(void);
162 
164 
168  vtkSetMacro(CompoundThreshold, double);
169  vtkGetMacro(CompoundThreshold, double);
171 
173 
178  vtkSetMacro(CompoundAlpha, vtkTypeBool);
179  vtkGetMacro(CompoundAlpha, vtkTypeBool);
180  vtkBooleanMacro(CompoundAlpha, vtkTypeBool);
182 
183 protected:
184  vtkImageBlend();
185  ~vtkImageBlend() override;
186 
188 
189  void InternalComputeInputUpdateExtent(int inExt[6], int outExt[6], int inWExtent[6]);
190 
191  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
192  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData, int ext[6],
193  int id) override;
194 
195  // see vtkAlgorithm for docs.
196  int FillInputPortInformation(int, vtkInformation*) override;
197 
198  // see vtkAlgorithm for docs.
199  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
200  vtkInformationVector* outputVector) override;
201 
202  double* Opacity;
208 
209 private:
210  vtkImageBlend(const vtkImageBlend&) = delete;
211  void operator=(const vtkImageBlend&) = delete;
212 };
213 
215 
219 {
220  switch (this->BlendMode)
221  {
223  return "Normal";
225  return "Compound";
226  default:
227  return "Unknown Blend Mode";
228  }
229 }
231 
232 #endif
int GetNumberOfInputConnections(int port)
Get the number of inputs currently connected to a port.
double CompoundThreshold
void SetInputData(vtkDataObject *input)
Assign a data object as input.
#define VTK_IMAGE_BLEND_MODE_COMPOUND
Definition: vtkImageBlend.h:85
const char * GetBlendModeAsString(void)
Get the blending mode as a descriptive string.
Store vtkAlgorithm input/output information.
void SetBlendModeToCompound()
Set the blend mode.
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.
vtkDataObject * GetInput()
Get a data object for one of the input port connections.
#define VTK_IMAGE_BLEND_MODE_NORMAL
Definition: vtkImageBlend.h:84
void SetInputData(vtkDataObject *)
Assign a data object as input.
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Subclasses can reimplement this method to translate the update extent requests from each output port ...
Proxy object to connect input/output ports.
int vtkTypeBool
Definition: vtkABI.h:69
Generic filter that has one input.
a simple class to control print indentation
Definition: vtkIndent.h:33
efficient description of an image stencil
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
vtkTypeBool CompoundAlpha
virtual void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method.
double * Opacity
vtkDataObject * GetInput()
Get one input to this filter.
void SetBlendModeToNormal()
Set the blend mode.
blend images together using alpha or opacity
Definition: vtkImageBlend.h:87
int GetNumberOfInputs()
Get the number of inputs to this filter.
int FillInputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
Store zero or more vtkInformation instances.
static vtkAlgorithm * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
general representation of visualization data
Definition: vtkDataObject.h:59