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 =========================================================================*/
61 #ifndef vtkImageViewer2_h
62 #define vtkImageViewer2_h
63 
64 #include "vtkInteractionImageModule.h" // For export macro
65 #include "vtkObject.h"
66 
67 class vtkAlgorithm;
68 class vtkAlgorithmOutput;
69 class vtkImageActor;
70 class vtkImageData;
72 class vtkInformation;
74 class vtkRenderWindow;
75 class vtkRenderer;
77 
78 class VTKINTERACTIONIMAGE_EXPORT vtkImageViewer2 : public vtkObject
79 {
80 public:
81  static vtkImageViewer2 *New();
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);
100  virtual vtkImageData *GetInput();
101  virtual void SetInputConnection(vtkAlgorithmOutput* input);
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);
117  virtual void SetSliceOrientationToXY()
118  { this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XY); };
119  virtual void SetSliceOrientationToYZ()
120  { this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_YZ); };
121  virtual void SetSliceOrientationToXZ()
122  { this->SetSliceOrientation(vtkImageViewer2::SLICE_ORIENTATION_XZ); };
123 
125 
129  vtkGetMacro(Slice, int);
130  virtual void SetSlice(int s);
132 
145  virtual void UpdateDisplayExtent();
146 
148 
152  virtual int GetSliceMin();
153  virtual int GetSliceMax();
154  virtual void GetSliceRange(int range[2])
155  { this->GetSliceRange(range[0], range[1]); }
156  virtual void GetSliceRange(int &min, int &max);
157  virtual int* GetSliceRange();
159 
161 
164  virtual double GetColorWindow();
165  virtual double GetColorLevel();
166  virtual void SetColorWindow(double s);
167  virtual void SetColorLevel(double s);
169 
171 
174  virtual void SetDisplayId(void *a);
175  virtual void SetWindowId(void *a);
176  virtual void SetParentId(void *a);
178 
180 
183  virtual int* GetPosition() VTK_SIZEHINT(2);
184  virtual void SetPosition(int a,int b);
185  virtual void SetPosition(int a[2]) { this->SetPosition(a[0],a[1]); }
187 
189 
192  virtual int* GetSize() VTK_SIZEHINT(2);
193  virtual void SetSize(int a, int b);
194  virtual void SetSize(int a[2]) { this->SetSize(a[0],a[1]); }
196 
198 
202  vtkGetObjectMacro(RenderWindow,vtkRenderWindow);
203  vtkGetObjectMacro(Renderer, vtkRenderer);
204  vtkGetObjectMacro(ImageActor,vtkImageActor);
205  vtkGetObjectMacro(WindowLevel,vtkImageMapToWindowLevelColors);
206  vtkGetObjectMacro(InteractorStyle,vtkInteractorStyleImage);
208 
210 
213  virtual void SetRenderWindow(vtkRenderWindow *arg);
214  virtual void SetRenderer(vtkRenderer *arg);
216 
220  virtual void SetupInteractor(vtkRenderWindowInteractor*);
221 
223 
228  virtual void SetOffScreenRendering(vtkTypeBool);
229  virtual vtkTypeBool GetOffScreenRendering();
230  vtkBooleanMacro(OffScreenRendering,vtkTypeBool);
232 
233 protected:
234  vtkImageViewer2();
235  ~vtkImageViewer2() override;
236 
237  virtual void InstallPipeline();
238  virtual void UnInstallPipeline();
239 
246 
249  int Slice;
250 
251  virtual void UpdateOrientation();
252 
253  vtkAlgorithm* GetInputAlgorithm();
254  vtkInformation* GetInputInformation();
255 
256  friend class vtkImageViewer2Callback;
257 
258 private:
259  vtkImageViewer2(const vtkImageViewer2&) = delete;
260  void operator=(const vtkImageViewer2&) = delete;
261 };
262 
263 #endif
abstract base class for most VTK objects
Definition: vtkObject.h:59
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:63
virtual void SetPosition(int a[2])
Set/Get the position in screen coordinates of the rendering window.
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:59
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:49
a simple class to control print indentation
Definition: vtkIndent.h:39
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
virtual void SetSize(int a[2])
Set/Get the size of the 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()