VTK  9.1.0
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=========================================================================*/
67#ifndef vtkImageViewer2_h
68#define vtkImageViewer2_h
69
70#include "vtkInteractionImageModule.h" // For export macro
71#include "vtkObject.h"
72
73class vtkAlgorithm;
75class vtkImageActor;
76class vtkImageData;
78class vtkInformation;
80class vtkRenderWindow;
81class vtkRenderer;
83
84class VTKINTERACTIONIMAGE_EXPORT vtkImageViewer2 : public vtkObject
85{
86public:
88 vtkTypeMacro(vtkImageViewer2, vtkObject);
89 void PrintSelf(ostream& os, vtkIndent indent) override;
90
94 virtual const char* GetWindowName();
95
99 virtual void Render(void);
100
102
105 virtual void SetInputData(vtkImageData* in);
109
114 enum
115 {
116 SLICE_ORIENTATION_YZ = 0,
117 SLICE_ORIENTATION_XZ = 1,
118 SLICE_ORIENTATION_XY = 2
119 };
120
121 vtkGetMacro(SliceOrientation, int);
124 {
125 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XY);
126 }
128 {
129 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_YZ);
130 }
132 {
133 this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XZ);
134 }
135
137
141 vtkGetMacro(Slice, int);
142 virtual void SetSlice(int s);
144
157 virtual void UpdateDisplayExtent();
158
160
164 virtual int GetSliceMin();
165 virtual int GetSliceMax();
166 virtual void GetSliceRange(int range[2]) { this->GetSliceRange(range[0], range[1]); }
167 virtual void GetSliceRange(int& min, int& max);
168 virtual int* GetSliceRange();
170
172
175 virtual double GetColorWindow();
176 virtual double GetColorLevel();
177 virtual void SetColorWindow(double s);
178 virtual void SetColorLevel(double s);
180
182
185 virtual void SetDisplayId(void* a);
186 virtual void SetWindowId(void* a);
187 virtual void SetParentId(void* a);
189
191
195 virtual int* GetPosition() VTK_SIZEHINT(2);
196
202 virtual void SetPosition(int x, int y);
203 virtual void SetPosition(int a[2]) { this->SetPosition(a[0], a[1]); }
205
207
211 virtual int* GetSize() VTK_SIZEHINT(2);
212
221 virtual void SetSize(int width, int height);
222 virtual void SetSize(int a[2]) { this->SetSize(a[0], a[1]); }
224
226
230 vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
231 vtkGetObjectMacro(Renderer, vtkRenderer);
232 vtkGetObjectMacro(ImageActor, vtkImageActor);
233 vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);
234 vtkGetObjectMacro(InteractorStyle, vtkInteractorStyleImage);
236
238
242 virtual void SetRenderer(vtkRenderer* arg);
244
249
251
258 vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
260
261protected:
264
265 virtual void InstallPipeline();
266 virtual void UnInstallPipeline();
267
274
277 int Slice;
278
279 virtual void UpdateOrientation();
280
283
284 friend class vtkImageViewer2Callback;
285
286private:
287 vtkImageViewer2(const vtkImageViewer2&) = delete;
288 void operator=(const vtkImageViewer2&) = delete;
289};
290
291#endif
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:64
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:52
topologically and geometrically regular array of data
Definition: vtkImageData.h:57
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:43
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
@ orientation
Definition: vtkX3D.h:268
@ range
Definition: vtkX3D.h:244
@ height
Definition: vtkX3D.h:260
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)
#define max(a, b)