VTK  9.3.0
vtkImageViewer2.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
49#ifndef vtkImageViewer2_h
50#define vtkImageViewer2_h
51
52#include "vtkInteractionImageModule.h" // For export macro
53#include "vtkObject.h"
54
55VTK_ABI_NAMESPACE_BEGIN
56class vtkAlgorithm;
58class vtkImageActor;
59class vtkImageData;
61class vtkInformation;
63class vtkRenderWindow;
64class vtkRenderer;
66
67class VTKINTERACTIONIMAGE_EXPORT vtkImageViewer2 : public vtkObject
68{
69public:
71 vtkTypeMacro(vtkImageViewer2, vtkObject);
72 void PrintSelf(ostream& os, vtkIndent indent) override;
73
77 virtual const char* GetWindowName();
78
82 virtual void Render();
83
85
88 virtual void SetInputData(vtkImageData* in);
92
97 enum
98 {
99 SLICE_ORIENTATION_YZ = 0,
100 SLICE_ORIENTATION_XZ = 1,
101 SLICE_ORIENTATION_XY = 2
102 };
103
104 vtkGetMacro(SliceOrientation, int);
105 virtual void SetSliceOrientation(int orientation);
107 {
108 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XY);
109 }
111 {
112 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_YZ);
113 }
115 {
116 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XZ);
117 }
118
120
124 vtkGetMacro(Slice, int);
125 virtual void SetSlice(int s);
127
140 virtual void UpdateDisplayExtent();
141
143
147 virtual int GetSliceMin();
148 virtual int GetSliceMax();
149 virtual void GetSliceRange(int range[2]) { this->GetSliceRange(range[0], range[1]); }
150 virtual void GetSliceRange(int& min, int& max);
151 virtual int* GetSliceRange();
153
155
158 virtual double GetColorWindow();
159 virtual double GetColorLevel();
160 virtual void SetColorWindow(double s);
161 virtual void SetColorLevel(double s);
163
165
168 virtual void SetDisplayId(void* a);
169 virtual void SetWindowId(void* a);
170 virtual void SetParentId(void* a);
172
174
178 virtual int* GetPosition() VTK_SIZEHINT(2);
179
185 virtual void SetPosition(int x, int y);
186 virtual void SetPosition(int a[2]) { this->SetPosition(a[0], a[1]); }
188
190
194 virtual int* GetSize() VTK_SIZEHINT(2);
195
204 virtual void SetSize(int width, int height);
205 virtual void SetSize(int a[2]) { this->SetSize(a[0], a[1]); }
207
209
213 vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
214 vtkGetObjectMacro(Renderer, vtkRenderer);
215 vtkGetObjectMacro(ImageActor, vtkImageActor);
216 vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);
217 vtkGetObjectMacro(InteractorStyle, vtkInteractorStyleImage);
219
221
225 virtual void SetRenderer(vtkRenderer* arg);
227
232
234
241 vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
243
244protected:
247
248 virtual void InstallPipeline();
249 virtual void UnInstallPipeline();
250
257
260 int Slice;
261
262 virtual void UpdateOrientation();
263
266
267 friend class vtkImageViewer2Callback;
268
269private:
270 vtkImageViewer2(const vtkImageViewer2&) = delete;
271 void operator=(const vtkImageViewer2&) = delete;
272};
273
274VTK_ABI_NAMESPACE_END
275#endif
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
draw an image in a rendered 3D scene
topologically and geometrically regular array of data
Map an image through a lookup table and/or a window/level.
Display a 2D image.
vtkAlgorithm * GetInputAlgorithm()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetDisplayId(void *a)
These are here when using a Tk window.
virtual int GetSliceMin()
Return the minimum and maximum slice values (depending on the orientation this can be in X,...
virtual void Render()
Render the resulting image.
virtual void SetSliceOrientation(int orientation)
virtual int * GetSliceRange()
Return the minimum and maximum slice values (depending on the orientation this can be in X,...
virtual void SetColorLevel(double s)
Set window and level for mapping pixels to colors.
virtual void UnInstallPipeline()
virtual const char * GetWindowName()
Get the name of rendering window.
virtual int * GetSize()
Get the size (width and height) of the rendering window in screen coordinates (in pixels).
virtual void UpdateDisplayExtent()
Update the display extent manually so that the proper slice for the given orientation is displayed.
virtual void SetWindowId(void *a)
These are here when using a Tk window.
virtual void SetOffScreenRendering(vtkTypeBool)
Create a window in memory instead of on the screen.
vtkRenderer * Renderer
virtual void SetSlice(int s)
Set/Get the current slice to display (depending on the orientation this can be in X,...
virtual void SetSliceOrientationToXZ()
virtual int * GetPosition()
Get the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual void GetSliceRange(int &min, int &max)
Return the minimum and maximum slice values (depending on the orientation this can be in X,...
vtkImageActor * ImageActor
virtual void SetupInteractor(vtkRenderWindowInteractor *)
Attach an interactor for the internal render window.
virtual void SetSize(int a[2])
Get the size (width and height) of the rendering window in screen coordinates (in pixels).
virtual void SetPosition(int a[2])
Get the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual double GetColorLevel()
Set window and level for mapping pixels to colors.
virtual void SetInputConnection(vtkAlgorithmOutput *input)
Set/Get the input image to the viewer.
virtual void SetSliceOrientationToYZ()
~vtkImageViewer2() override
virtual void GetSliceRange(int range[2])
Return the minimum and maximum slice values (depending on the orientation this can be in X,...
virtual vtkImageData * GetInput()
Set/Get the input image to the viewer.
vtkInformation * GetInputInformation()
virtual int GetSliceMax()
Return the minimum and maximum slice values (depending on the orientation this can be in X,...
virtual double GetColorWindow()
Set window and level for mapping pixels to colors.
virtual void SetRenderWindow(vtkRenderWindow *arg)
Set your own renderwindow and renderer.
virtual vtkTypeBool GetOffScreenRendering()
Create a window in memory instead of on the screen.
vtkRenderWindow * RenderWindow
virtual void SetColorWindow(double s)
Set window and level for mapping pixels to colors.
virtual void SetParentId(void *a)
These are here when using a Tk window.
vtkRenderWindowInteractor * Interactor
virtual void SetSliceOrientationToXY()
static vtkImageViewer2 * New()
virtual void SetRenderer(vtkRenderer *arg)
Set your own renderwindow and renderer.
virtual void SetInputData(vtkImageData *in)
Set/Get the input image to the viewer.
vtkImageMapToWindowLevelColors * WindowLevel
vtkInteractorStyleImage * InteractorStyle
virtual void InstallPipeline()
virtual void UpdateOrientation()
a simple class to control print indentation
Definition vtkIndent.h:29
Store vtkAlgorithm input/output information.
interactive manipulation of the camera specialized for images
abstract base class for most VTK objects
Definition vtkObject.h:49
platform-independent render window interaction including picking and frame rate control.
create a window for renderers to draw into
abstract specification for renderers
Definition vtkRenderer.h:59
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)
#define max(a, b)