VTK  9.1.0
vtkImageRectilinearWipe.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageRectilinearWipe.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 =========================================================================*/
66 #ifndef vtkImageRectilinearWipe_h
67 #define vtkImageRectilinearWipe_h
68 
69 #include "vtkImagingHybridModule.h" // For export macro
71 
72 #define VTK_WIPE_QUAD 0
73 #define VTK_WIPE_HORIZONTAL 1
74 #define VTK_WIPE_VERTICAL 2
75 #define VTK_WIPE_LOWER_LEFT 3
76 #define VTK_WIPE_LOWER_RIGHT 4
77 #define VTK_WIPE_UPPER_LEFT 5
78 #define VTK_WIPE_UPPER_RIGHT 6
79 
80 class VTKIMAGINGHYBRID_EXPORT vtkImageRectilinearWipe : public vtkThreadedImageAlgorithm
81 {
82 public:
85  void PrintSelf(ostream& os, vtkIndent indent) override;
86 
88 
92  vtkSetVector2Macro(Position, int);
93  vtkGetVectorMacro(Position, int, 2);
95 
97 
101  vtkSetVector2Macro(Axis, int);
102  vtkGetVectorMacro(Axis, int, 2);
104 
108  virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
109  virtual void SetInput2Data(vtkDataObject* in) { this->SetInputData(1, in); }
110 
112 
130  vtkSetClampMacro(Wipe, int, VTK_WIPE_QUAD, VTK_WIPE_UPPER_RIGHT);
131  vtkGetMacro(Wipe, int);
132  void SetWipeToQuad() { this->SetWipe(VTK_WIPE_QUAD); }
133  void SetWipeToHorizontal() { this->SetWipe(VTK_WIPE_HORIZONTAL); }
134  void SetWipeToVertical() { this->SetWipe(VTK_WIPE_VERTICAL); }
135  void SetWipeToLowerLeft() { this->SetWipe(VTK_WIPE_LOWER_LEFT); }
136  void SetWipeToLowerRight() { this->SetWipe(VTK_WIPE_LOWER_RIGHT); }
137  void SetWipeToUpperLeft() { this->SetWipe(VTK_WIPE_UPPER_LEFT); }
138  void SetWipeToUpperRight() { this->SetWipe(VTK_WIPE_UPPER_RIGHT); }
140 
141 protected:
143  ~vtkImageRectilinearWipe() override = default;
144 
146  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
147  int outExt[6], int threadId) override;
148 
149  int Position[2];
150  int Wipe;
151  int Axis[2];
152 
153 private:
155  void operator=(const vtkImageRectilinearWipe&) = delete;
156 };
157 
158 #endif
vtkImageRectilinearWipe::New
static vtkImageRectilinearWipe * New()
vtkImageRectilinearWipe::Wipe
int Wipe
Definition: vtkImageRectilinearWipe.h:150
vtkImageRectilinearWipe::ThreadedRequestData
void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int outExt[6], int threadId) override
If the subclass does not define an Execute method, then the task will be broken up,...
vtkImageRectilinearWipe::SetWipeToVertical
void SetWipeToVertical()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:134
vtkImageRectilinearWipe::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageRectilinearWipe::SetInput1Data
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
Definition: vtkImageRectilinearWipe.h:108
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:145
VTK_WIPE_VERTICAL
#define VTK_WIPE_VERTICAL
Definition: vtkImageRectilinearWipe.h:74
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:39
vtkImageRectilinearWipe
make a rectilinear combination of two images.
Definition: vtkImageRectilinearWipe.h:81
VTK_WIPE_HORIZONTAL
#define VTK_WIPE_HORIZONTAL
Definition: vtkImageRectilinearWipe.h:73
VTK_WIPE_LOWER_RIGHT
#define VTK_WIPE_LOWER_RIGHT
Definition: vtkImageRectilinearWipe.h:76
vtkImageRectilinearWipe::~vtkImageRectilinearWipe
~vtkImageRectilinearWipe() override=default
vtkThreadedImageAlgorithm.h
vtkImageAlgorithm::SetInputData
void SetInputData(vtkDataObject *)
Assign a data object as input.
vtkImageRectilinearWipe::SetWipeToUpperLeft
void SetWipeToUpperLeft()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:137
vtkImageRectilinearWipe::SetWipeToUpperRight
void SetWipeToUpperRight()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:138
vtkImageRectilinearWipe::SetWipeToLowerRight
void SetWipeToLowerRight()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:136
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
VTK_WIPE_LOWER_LEFT
#define VTK_WIPE_LOWER_LEFT
Definition: vtkImageRectilinearWipe.h:75
VTK_WIPE_UPPER_LEFT
#define VTK_WIPE_UPPER_LEFT
Definition: vtkImageRectilinearWipe.h:77
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:183
vtkImageRectilinearWipe::SetWipeToLowerLeft
void SetWipeToLowerLeft()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:135
vtkParticleTracerBaseNamespace::Position
struct Position_t Position
Definition: vtkParticleTracerBase.h:63
vtkImageRectilinearWipe::SetInput2Data
virtual void SetInput2Data(vtkDataObject *in)
Definition: vtkImageRectilinearWipe.h:109
vtkImageRectilinearWipe::SetWipeToHorizontal
void SetWipeToHorizontal()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:133
VTK_WIPE_QUAD
#define VTK_WIPE_QUAD
Definition: vtkImageRectilinearWipe.h:72
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:169
vtkImageRectilinearWipe::vtkImageRectilinearWipe
vtkImageRectilinearWipe()
vtkImageRectilinearWipe::SetWipeToQuad
void SetWipeToQuad()
Specify the wipe mode.
Definition: vtkImageRectilinearWipe.h:132
VTK_WIPE_UPPER_RIGHT
#define VTK_WIPE_UPPER_RIGHT
Definition: vtkImageRectilinearWipe.h:78