VTK
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 
185  virtual int* GetPosition() VTK_SIZEHINT(2);
186  virtual void SetPosition(int a, int b);
187  virtual void SetPosition(int a[2]) { this->SetPosition(a[0], a[1]); }
189 
191 
194  virtual int* GetSize() VTK_SIZEHINT(2);
195  virtual void SetSize(int a, int b);
196  virtual void SetSize(int a[2]) { this->SetSize(a[0], a[1]); }
198 
200 
204  vtkGetObjectMacro(RenderWindow, vtkRenderWindow);
205  vtkGetObjectMacro(Renderer, vtkRenderer);
206  vtkGetObjectMacro(ImageActor, vtkImageActor);
207  vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);
208  vtkGetObjectMacro(InteractorStyle, vtkInteractorStyleImage);
210 
212 
215  virtual void SetRenderWindow(vtkRenderWindow* arg);
216  virtual void SetRenderer(vtkRenderer* arg);
218 
222  virtual void SetupInteractor(vtkRenderWindowInteractor*);
223 
225 
230  virtual void SetOffScreenRendering(vtkTypeBool);
231  virtual vtkTypeBool GetOffScreenRendering();
232  vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
234 
235 protected:
236  vtkImageViewer2();
237  ~vtkImageViewer2() override;
238 
239  virtual void InstallPipeline();
240  virtual void UnInstallPipeline();
241 
248 
251  int Slice;
252 
253  virtual void UpdateOrientation();
254 
255  vtkAlgorithm* GetInputAlgorithm();
256  vtkInformation* GetInputInformation();
257 
258  friend class vtkImageViewer2Callback;
259 
260 private:
261  vtkImageViewer2(const vtkImageViewer2&) = delete;
262  void operator=(const vtkImageViewer2&) = delete;
263 };
264 
265 #endif
vtkImageViewer2::SLICE_ORIENTATION_XZ
Definition: vtkImageViewer2.h:108
vtkImageViewer2::Interactor
vtkRenderWindowInteractor * Interactor
Definition: vtkImageViewer2.h:246
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:53
vtkImageViewer2::SLICE_ORIENTATION_YZ
Definition: vtkImageViewer2.h:107
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkX3D::range
Definition: vtkX3D.h:244
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:53
vtkImageViewer2
Display a 2D image.
Definition: vtkImageViewer2.h:75
vtkInteractorStyleImage
interactive manipulation of the camera specialized for images
Definition: vtkInteractorStyleImage.h:78
max
#define max(a, b)
Definition: vtkX3DExporterFIWriterHelper.h:31
vtkImageViewer2::WindowLevel
vtkImageMapToWindowLevelColors * WindowLevel
Definition: vtkImageViewer2.h:242
vtkImageViewer2::SetSliceOrientationToXY
virtual void SetSliceOrientationToXY()
Definition: vtkImageViewer2.h:114
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
vtkImageViewer2::FirstRender
int FirstRender
Definition: vtkImageViewer2.h:250
vtkImageMapToWindowLevelColors
Map an image through a lookup table and/or a window/level.
Definition: vtkImageMapToWindowLevelColors.h:48
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkImageViewer2::SetPosition
virtual void SetPosition(int a[2])
Definition: vtkImageViewer2.h:187
vtkImageViewer2::SetSliceOrientationToXZ
virtual void SetSliceOrientationToXZ()
Definition: vtkImageViewer2.h:122
vtkImageViewer2::ImageActor
vtkImageActor * ImageActor
Definition: vtkImageViewer2.h:245
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkRenderWindowInteractor
platform-independent render window interaction including picking and frame rate control.
Definition: vtkRenderWindowInteractor.h:72
vtkImageViewer2::SetSize
virtual void SetSize(int a[2])
Definition: vtkImageViewer2.h:196
vtkImageViewer2::InteractorStyle
vtkInteractorStyleImage * InteractorStyle
Definition: vtkImageViewer2.h:247
vtkObject.h
vtkImageViewer2::Slice
int Slice
Definition: vtkImageViewer2.h:251
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:64
vtkImageViewer2::SLICE_ORIENTATION_XY
Definition: vtkImageViewer2.h:109
vtkImageViewer2::RenderWindow
vtkRenderWindow * RenderWindow
Definition: vtkImageViewer2.h:243
vtkX3D::orientation
Definition: vtkX3D.h:268
vtkImageViewer2::SliceOrientation
int SliceOrientation
Definition: vtkImageViewer2.h:249
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:36
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:58
vtkImageActor
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:42
vtkRenderWindow
create a window for renderers to draw into
Definition: vtkRenderWindow.h:84
vtkImageViewer2::SetSliceOrientationToYZ
virtual void SetSliceOrientationToYZ()
Definition: vtkImageViewer2.h:118
vtkImageViewer2::GetSliceRange
virtual void GetSliceRange(int range[2])
Definition: vtkImageViewer2.h:157
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkImageViewer2::Renderer
vtkRenderer * Renderer
Definition: vtkImageViewer2.h:244