VTK  9.2.6
vtkImageViewer2.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageViewer2.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=========================================================================*/
61#ifndef vtkImageViewer2_h
62#define vtkImageViewer2_h
63
64#include "vtkInteractionImageModule.h" // For export macro
65#include "vtkObject.h"
66
67class vtkAlgorithm;
69class vtkImageActor;
70class vtkImageData;
72class vtkInformation;
74class vtkRenderWindow;
75class vtkRenderer;
77
78class VTKINTERACTIONIMAGE_EXPORT vtkImageViewer2 : public vtkObject
79{
80public:
82 vtkTypeMacro(vtkImageViewer2, vtkObject);
83 void PrintSelf(ostream& os, vtkIndent indent) override;
84
88 virtual const char* GetWindowName();
89
93 virtual void Render(void);
94
96
99 virtual void SetInputData(vtkImageData* in);
103
108 enum
109 {
110 SLICE_ORIENTATION_YZ = 0,
111 SLICE_ORIENTATION_XZ = 1,
112 SLICE_ORIENTATION_XY = 2
113 };
114
115 vtkGetMacro(SliceOrientation, int);
116 virtual void SetSliceOrientation(int orientation);
118 {
119 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XY);
120 }
122 {
123 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_YZ);
124 }
126 {
127 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XZ);
128 }
129
131
135 vtkGetMacro(Slice, int);
136 virtual void SetSlice(int s);
138
151 virtual void UpdateDisplayExtent();
152
154
158 virtual int GetSliceMin();
159 virtual int GetSliceMax();
160 virtual void GetSliceRange(int range[2]) { this->GetSliceRange(range[0], range[1]); }
161 virtual void GetSliceRange(int& min, int& max);
162 virtual int* GetSliceRange();
164
166
169 virtual double GetColorWindow();
170 virtual double GetColorLevel();
171 virtual void SetColorWindow(double s);
172 virtual void SetColorLevel(double s);
174
176
179 virtual void SetDisplayId(void* a);
180 virtual void SetWindowId(void* a);
181 virtual void SetParentId(void* a);
183
185
189 virtual int* GetPosition() VTK_SIZEHINT(2);
190
196 virtual void SetPosition(int x, int y);
197 virtual void SetPosition(int a[2]) { this->SetPosition(a[0], a[1]); }
199
201
205 virtual int* GetSize() VTK_SIZEHINT(2);
206
215 virtual void SetSize(int width, int height);
216 virtual void SetSize(int a[2]) { this->SetSize(a[0], a[1]); }
218
220
224 vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
225 vtkGetObjectMacro(Renderer, vtkRenderer);
226 vtkGetObjectMacro(ImageActor, vtkImageActor);
227 vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);
228 vtkGetObjectMacro(InteractorStyle, vtkInteractorStyleImage);
230
232
236 virtual void SetRenderer(vtkRenderer* arg);
238
243
245
252 vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
254
255protected:
258
259 virtual void InstallPipeline();
260 virtual void UnInstallPipeline();
261
268
271 int Slice;
272
273 virtual void UpdateOrientation();
274
277
278 friend class vtkImageViewer2Callback;
279
280private:
281 vtkImageViewer2(const vtkImageViewer2&) = delete;
282 void operator=(const vtkImageViewer2&) = delete;
283};
284
285#endif
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:63
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:49
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
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 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 Render(void)
Render the resulting image.
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:40
Store vtkAlgorithm input/output information.
interactive manipulation of the camera specialized for images
abstract base class for most VTK objects
Definition: vtkObject.h:63
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:73
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)
#define max(a, b)