VTK  9.0.1
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 =========================================================================*/
58 #ifndef vtkImageViewer2_h
59 #define vtkImageViewer2_h
60 
61 #include "vtkInteractionImageModule.h" // For export macro
62 #include "vtkObject.h"
63 
64 class vtkAlgorithm;
65 class vtkAlgorithmOutput;
66 class vtkImageActor;
67 class vtkImageData;
69 class vtkInformation;
71 class vtkRenderWindow;
72 class vtkRenderer;
74 
75 class VTKINTERACTIONIMAGE_EXPORT vtkImageViewer2 : public vtkObject
76 {
77 public:
78  static vtkImageViewer2* New();
79  vtkTypeMacro(vtkImageViewer2, vtkObject);
80  void PrintSelf(ostream& os, vtkIndent indent) override;
81 
85  virtual const char* GetWindowName();
86 
90  virtual void Render(void);
91 
93 
96  virtual void SetInputData(vtkImageData* in);
97  virtual vtkImageData* GetInput();
98  virtual void SetInputConnection(vtkAlgorithmOutput* input);
100 
105  enum
106  {
107  SLICE_ORIENTATION_YZ = 0,
108  SLICE_ORIENTATION_XZ = 1,
109  SLICE_ORIENTATION_XY = 2
110  };
111 
112  vtkGetMacro(SliceOrientation, int);
113  virtual void SetSliceOrientation(int orientation);
114  virtual void SetSliceOrientationToXY()
115  {
116  this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XY);
117  }
118  virtual void SetSliceOrientationToYZ()
119  {
120  this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_YZ);
121  }
122  virtual void SetSliceOrientationToXZ()
123  {
124  this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XZ);
125  }
126 
128 
132  vtkGetMacro(Slice, int);
133  virtual void SetSlice(int s);
135 
148  virtual void UpdateDisplayExtent();
149 
151 
155  virtual int GetSliceMin();
156  virtual int GetSliceMax();
157  virtual void GetSliceRange(int range[2]) { this->GetSliceRange(range[0], range[1]); }
158  virtual void GetSliceRange(int& min, int& max);
159  virtual int* GetSliceRange();
161 
163 
166  virtual double GetColorWindow();
167  virtual double GetColorLevel();
168  virtual void SetColorWindow(double s);
169  virtual void SetColorLevel(double s);
171 
173 
176  virtual void SetDisplayId(void* a);
177  virtual void SetWindowId(void* a);
178  virtual void SetParentId(void* a);
180 
182 
186  virtual int* GetPosition() VTK_SIZEHINT(2);
187 
193  virtual void SetPosition(int x, int y);
194  virtual void SetPosition(int a[2]) { this->SetPosition(a[0], a[1]); }
196 
198 
202  virtual int* GetSize() VTK_SIZEHINT(2);
203 
212  virtual void SetSize(int width, int height);
213  virtual void SetSize(int a[2]) { this->SetSize(a[0], a[1]); }
215 
217 
221  vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
222  vtkGetObjectMacro(Renderer, vtkRenderer);
223  vtkGetObjectMacro(ImageActor, vtkImageActor);
224  vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);
225  vtkGetObjectMacro(InteractorStyle, vtkInteractorStyleImage);
227 
229 
232  virtual void SetRenderWindow(vtkRenderWindow* arg);
233  virtual void SetRenderer(vtkRenderer* arg);
235 
239  virtual void SetupInteractor(vtkRenderWindowInteractor*);
240 
242 
247  virtual void SetOffScreenRendering(vtkTypeBool);
248  virtual vtkTypeBool GetOffScreenRendering();
249  vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
251 
252 protected:
253  vtkImageViewer2();
254  ~vtkImageViewer2() override;
255 
256  virtual void InstallPipeline();
257  virtual void UnInstallPipeline();
258 
265 
268  int Slice;
269 
270  virtual void UpdateOrientation();
271 
272  vtkAlgorithm* GetInputAlgorithm();
273  vtkInformation* GetInputInformation();
274 
275  friend class vtkImageViewer2Callback;
276 
277 private:
278  vtkImageViewer2(const vtkImageViewer2&) = delete;
279  void operator=(const vtkImageViewer2&) = delete;
280 };
281 
282 #endif
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkImageMapToWindowLevelColors * WindowLevel
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetSliceOrientationToXY()
Store vtkAlgorithm input/output information.
vtkRenderWindowInteractor * Interactor
Map an image through a lookup table and/or a window/level.
Display a 2D image.
abstract specification for renderers
Definition: vtkRenderer.h:67
virtual void SetPosition(int a[2])
Get the position (x and y) of the rendering window in screen coordinates (in pixels).
Proxy object to connect input/output ports.
interactive manipulation of the camera specialized for images
int vtkTypeBool
Definition: vtkABI.h:69
platform-independent render window interaction including picking and frame rate control.
vtkImageActor * ImageActor
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:62
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:42
a simple class to control print indentation
Definition: vtkIndent.h:33
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
virtual void SetSize(int a[2])
Get the size (width and height) of the rendering window in screen coordinates (in pixels)...
#define VTK_SIZEHINT(...)
create a window for renderers to draw into
vtkRenderWindow * RenderWindow
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual void GetSliceRange(int range[2])
Return the minimum and maximum slice values (depending on the orientation this can be in X...
vtkRenderer * Renderer
virtual void SetSliceOrientationToXZ()
#define max(a, b)
vtkInteractorStyleImage * InteractorStyle
virtual void SetSliceOrientationToYZ()