VTK  9.2.6
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=========================================================================*/
75
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
87class VTKIMAGINGCORE_EXPORT vtkImageBlend : public vtkThreadedImageAlgorithm
88{
89public:
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
119 vtkDataObject* GetInput() { return this->GetInput(0); }
121
128
130
134 void SetOpacity(int idx, double opacity);
135 double GetOpacity(int idx);
137
143
145
151
153
157 vtkGetMacro(BlendMode, int);
160 const char* GetBlendModeAsString(void);
162
164
168 vtkSetMacro(CompoundThreshold, double);
169 vtkGetMacro(CompoundThreshold, double);
171
173
180 vtkBooleanMacro(CompoundAlpha, vtkTypeBool);
182
183protected:
185 ~vtkImageBlend() override;
186
188
189 void InternalComputeInputUpdateExtent(int inExt[6], int outExt[6], int inWExtent[6]);
190
192 vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData, int ext[6],
193 int id) override;
194
195 // see vtkAlgorithm for docs.
197
198 // see vtkAlgorithm for docs.
200 vtkInformationVector* outputVector) override;
201
202 double* Opacity;
208
209private:
210 vtkImageBlend(const vtkImageBlend&) = delete;
211 void operator=(const vtkImageBlend&) = delete;
212};
213
218{
219 switch (this->BlendMode)
220 {
222 return "Normal";
224 return "Compound";
225 default:
226 return "Unknown Blend Mode";
227 }
228}
229
230#endif
Proxy object to connect input/output ports.
int GetNumberOfInputConnections(int port)
Get the number of inputs currently connected to a port.
general representation of visualization data
vtkDataObject * GetInput()
Get one input to this filter.
void SetStencilData(vtkImageStencilData *stencil)
Set a stencil to apply when blending the data.
void SetBlendModeToNormal()
Set the blend mode.
vtkTypeBool CompoundAlpha
void SetOpacity(int idx, double opacity)
Set the opacity of an input image: the alpha values of the image are multiplied by the opacity.
virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput *input)
Replace one of the input connections with a new input.
void SetBlendModeToCompound()
Set the blend mode.
void SetInputData(int num, vtkDataObject *input)
Assign a data object as input.
virtual void SetBlendMode(int)
Set the blend mode.
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to translate the update extent requests from each output port ...
const char * GetBlendModeAsString(void)
Get the blending mode as a descriptive string.
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called in response to a REQUEST_DATA request from the executive.
void InternalComputeInputUpdateExtent(int inExt[6], int outExt[6], int inWExtent[6])
void SetInputData(vtkDataObject *input)
Assign a data object as input.
int FillInputPortInformation(int, vtkInformation *) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id) override
If the subclass does not define an Execute method, then the task will be broken up,...
vtkDataObject * GetInput(int num)
Get one input to this filter.
~vtkImageBlend() override
double CompoundThreshold
vtkImageStencilData * GetStencil()
Set a stencil to apply when blending the data.
int GetNumberOfInputs()
Get the number of inputs to this filter.
double GetOpacity(int idx)
Set the opacity of an input image: the alpha values of the image are multiplied by the opacity.
void SetStencilConnection(vtkAlgorithmOutput *algOutput)
Set a stencil to apply when blending the data.
static vtkImageBlend * New()
topologically and geometrically regular array of data
efficient description of an image stencil
a simple class to control print indentation
Definition vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_IMAGE_BLEND_MODE_NORMAL
#define VTK_IMAGE_BLEND_MODE_COMPOUND