2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
10 # This software is governed by the CeCILL-B license under French law and
11 # abiding by the rules of distribution of free software. You can use,
12 # modify and/ or redistribute the software under the terms of the CeCILL-B
13 # license as circulated by CEA, CNRS and INRIA at the following URL
14 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15 # or in the file LICENSE.txt.
17 # As a counterpart to the access to the source code and rights to copy,
18 # modify and redistribute granted by the license, users are provided only
19 # with a limited warranty and the software's author, the holder of the
20 # economic rights, and the successive licensors have only limited
23 # The fact that you are presently reading this means that you have had
24 # knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------ */
28 /*=========================================================================
30 Program: Visualization Toolkit
31 Module: $RCSfile: wxvtkImageViewer2.h,v $
33 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
35 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
37 This software is distributed WITHOUT ANY WARRANTY; without even
38 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
39 PURPOSE. See the above copyright notice for more information.
41 =========================================================================*/
42 // .NAME wxvtkImageViewer2 - Display a 2D image.
43 // .SECTION Description
44 // wxvtkImageViewer2 is a convenience class for displaying a 2D image. It
45 // packages up the functionality found in vtkRenderWindow, vtkRenderer,
46 // vtkImageActor and vtkImageMapToWindowLevelColors into a single easy to use
47 // class. This class also creates an image interactor style
48 // (vtkInteractorStyleImage) that allows zooming and panning of images, and
49 // supports interactive window/level operations on the image. Note that
50 // wxvtkImageViewer2 is simply a wrapper around these classes.
52 // wxvtkImageViewer2 uses the 3D rendering and texture mapping engine
53 // to draw an image on a plane. This allows for rapid rendering,
54 // zooming, and panning. The image is placed in the 3D scene at a
55 // depth based on the z-coordinate of the particular image slice. Each
56 // call to SetSlice() changes the image data (slice) displayed AND
57 // changes the depth of the displayed slice in the 3D scene. This can
58 // be controlled by the AutoAdjustCameraClippingRange ivar of the
59 // InteractorStyle member.
61 // It is possible to mix images and geometry, using the methods:
63 // viewer->SetInput( myImage );
64 // viewer->GetRenderer()->AddActor( myActor );
66 // This can be used to annotate an image with a PolyData of "edges" or
67 // or highlight sections of an image or display a 3D isosurface
68 // with a slice from the volume, etc. Any portions of your geometry
69 // that are in front of the displayed slice will be visible; any
70 // portions of your geometry that are behind the displayed slice will
71 // be obscured. A more general framework (with respect to viewing
72 // direction) for achieving this effect is provided by the
73 // vtkImagePlaneWidget .
75 // Note that pressing 'r' will reset the window/level and pressing
76 // shift+'r' or control+'r' will reset the camera.
79 // vtkRenderWindow vtkRenderer vtkImageActor vtkImageMapToWindowLevelColors
81 #ifndef __wxvtkImageViewer2_h
82 #define __wxvtkImageViewer2_h
84 #include "vtkObject.h"
86 class vtkAlgorithmOutput;
89 class vtkImageMapToWindowLevelColors;
90 class vtkInteractorStyleImage;
91 class vtkRenderWindow;
93 class vtkRenderWindowInteractor;
95 class /*VTK_RENDERING_EXPORT*/ wxvtkImageViewer2 : public vtkObject
98 static wxvtkImageViewer2 *New();
99 vtkTypeRevisionMacro(wxvtkImageViewer2,vtkObject);
100 void PrintSelf(ostream& os, vtkIndent indent);
103 // Get the name of rendering window.
104 virtual const char *GetWindowName();
107 // Render the resulting image.
108 virtual void Render(void);
111 // Set/Get the input image to the viewer.
112 virtual void SetInput(vtkImageData *in);
113 virtual vtkImageData *GetInput();
114 virtual void SetInputConnection(vtkAlgorithmOutput* input);
117 // Set/get the slice orientation
121 SLICE_ORIENTATION_YZ = 0,
122 SLICE_ORIENTATION_XZ = 1,
123 SLICE_ORIENTATION_XY = 2
126 vtkGetMacro(SliceOrientation, int);
127 virtual void SetSliceOrientation(int orientation);
128 virtual void SetSliceOrientationToXY()
129 { this->SetSliceOrientation(wxvtkImageViewer2::SLICE_ORIENTATION_XY); };
130 virtual void SetSliceOrientationToYZ()
131 { this->SetSliceOrientation(wxvtkImageViewer2::SLICE_ORIENTATION_YZ); };
132 virtual void SetSliceOrientationToXZ()
133 { this->SetSliceOrientation(wxvtkImageViewer2::SLICE_ORIENTATION_XZ); };
136 // Set/Get the current slice to display (depending on the orientation
137 // this can be in X, Y or Z).
138 vtkGetMacro(Slice, int);
139 virtual void SetSlice(int s);
142 // Update the display extent manually so that the proper slice for the
143 // given orientation is displayed. It will also try to set a
144 // reasonable camera clipping range.
145 // This method is called automatically when the Input is changed, but
146 // most of the time the input of this class is likely to remain the same,
147 // i.e. connected to the output of a filter, or an image reader. When the
148 // input of this filter or reader itself is changed, an error message might
149 // be displayed since the current display extent is probably outside
150 // the new whole extent. Calling this method will ensure that the display
151 // extent is reset properly.
152 virtual void UpdateDisplayExtent();
155 // Return the minimum and maximum slice values (depending on the orientation
156 // this can be in X, Y or Z).
157 virtual int GetSliceMin();
158 virtual int GetSliceMax();
159 virtual void GetSliceRange(int range[2])
160 { this->GetSliceRange(range[0], range[1]); }
161 virtual void GetSliceRange(int &min, int &max);
162 virtual int* GetSliceRange();
165 // Set window and level for mapping pixels to colors.
166 virtual double GetColorWindow();
167 virtual double GetColorLevel();
168 virtual void SetColorWindow(double s);
169 virtual void SetColorLevel(double s);
172 // These are here when using a Tk window.
173 virtual void SetDisplayId(void *a);
174 virtual void SetWindowId(void *a);
175 virtual void SetParentId(void *a);
178 // Set/Get the position in screen coordinates of the rendering window.
179 virtual int* GetPosition();
180 virtual void SetPosition(int a,int b);
181 virtual void SetPosition(int a[2]) { this->SetPosition(a[0],a[1]); }
184 // Set/Get the size of the window in screen coordinates in pixels.
185 virtual int* GetSize();
186 virtual void SetSize(int a, int b);
187 virtual void SetSize(int a[2]) { this->SetSize(a[0],a[1]); }
190 // Get the internal render window, renderer, image actor, and
191 // image map instances.
192 vtkGetObjectMacro(RenderWindow,vtkRenderWindow);
193 vtkGetObjectMacro(Renderer, vtkRenderer);
194 vtkGetObjectMacro(ImageActor,vtkImageActor);
195 vtkGetObjectMacro(WindowLevel,vtkImageMapToWindowLevelColors);
196 vtkGetObjectMacro(InteractorStyle,vtkInteractorStyleImage);
199 // Set your own renderwindow and renderer
200 virtual void SetRenderWindow(vtkRenderWindow *arg);
201 virtual void SetRenderer(vtkRenderer *arg);
204 // Attach an interactor for the internal render window.
205 virtual void SetupInteractor(vtkRenderWindowInteractor*);
208 // Create a window in memory instead of on the screen. This may not
209 // be supported for every type of window and on some windows you may
210 // need to invoke this prior to the first render.
211 virtual void SetOffScreenRendering(int);
212 virtual int GetOffScreenRendering();
213 vtkBooleanMacro(OffScreenRendering,int);
216 // @deprecated Replaced by wxvtkImageViewer2::GetSliceMin() as of VTK 5.0.
217 VTK_LEGACY(int GetWholeZMin());
220 // @deprecated Replaced by wxvtkImageViewer2::GetSliceMax() as of VTK 5.0.
221 VTK_LEGACY(int GetWholeZMax());
224 // @deprecated Replaced by wxvtkImageViewer2::GetSlice() as of VTK 5.0.
225 VTK_LEGACY(int GetZSlice());
228 // @deprecated Replaced by wxvtkImageViewer2::SetSlice() as of VTK 5.0.
229 VTK_LEGACY(void SetZSlice(int));
233 ~wxvtkImageViewer2();
235 virtual void InstallPipeline();
236 virtual void UnInstallPipeline();
238 vtkImageMapToWindowLevelColors *WindowLevel;
239 vtkRenderWindow *RenderWindow;
240 vtkRenderer *Renderer;
241 vtkImageActor *ImageActor;
242 vtkRenderWindowInteractor *Interactor;
243 vtkInteractorStyleImage *InteractorStyle;
245 int SliceOrientation;
249 virtual void UpdateOrientation();
252 wxvtkImageViewer2(const wxvtkImageViewer2&); // Not implemented.
253 void operator=(const wxvtkImageViewer2&); // Not implemented.