Documentation/Labs/VTK8 - Revision history

JChris.FillionR at 21:32, 14 August 2017

2017-08-14T21:32:51Z

JChris.FillionR at 21:27, 14 August 2017

2017-08-14T21:27:22Z

JChris.FillionR at 21:26, 14 August 2017

2017-08-14T21:26:52Z

JChris.FillionR at 21:26, 14 August 2017

2017-08-14T21:26:24Z

JChris.FillionR at 21:26, 14 August 2017

2017-08-14T21:26:07Z

JChris.FillionR: /* Slicer-specific VTK commits */

2017-08-14T21:23:41Z

Slicer-specific VTK commits

JChris.FillionR: /* Outstanding VTK issues */

2017-08-14T21:22:08Z

Outstanding VTK issues

JChris.FillionR: /* Slicer-specific VTK commits */

2017-08-14T21:21:39Z

Slicer-specific VTK commits

JChris.FillionR: /* Slicer-specific VTK commits */

2017-08-14T21:20:48Z

Slicer-specific VTK commits

JChris.FillionR: /* Slicer-specific VTK commits */

2017-08-14T21:19:35Z

Slicer-specific VTK commits

← Older revision		Revision as of 21:32, 14 August 2017
Line 2:		Line 2:

	{{documentation/banner		{{documentation/banner
−	\| text = Status on this page is out-of-date. Since VTK8 transition will happen in conjunction with Qt5, see detailed TODO lists on [[Documentation/Labs/Qt5]]}}	+	\| text = Status on this page is out-of-date. Since VTK8 transition will happen in conjunction with Qt5, see detailed TODO lists on [[Documentation/Labs/Qt5-and-VTK8]]}}

← Older revision		Revision as of 21:27, 14 August 2017
Line 93:		Line 93:

	The transition plan was announced on the Slicer forum: https://discourse.slicer.org/t/transition-to-vtk-8-0/379.		The transition plan was announced on the Slicer forum: https://discourse.slicer.org/t/transition-to-vtk-8-0/379.
−
−	~~==Migration guide==~~
−
−	This section lists categories of code changes necessary to build and run Slicer with VTK 8.0. Each category has a short description, a suggested upgrade path, and references to relevant commits (TBD once merged).
−
−	~~===Use hierarchy files for VTK Python wrapping===~~
−
−	In VTK8 it's necessary to generate hierarchy files for proper wrapping VTK classes in Python. Without the information provided by the hierarchy files, the Python wrapping tool lacks complete information about classes and types. In this case, the generated classes contain methods that shouldn't be wrapped and fail to compile, and include references to types such as <tt>vtkTypeBool</tt>. Once the hierarchy files are generated and provided to the Python wrapping tool, the generated classes compile and typedefs like <tt>vtkTypeBool</tt> are correctly resolved.
−
−	~~Once the VTK8 changes are merged, generating hierarchy files is handled by https://github.com/Slicer/Slicer/blob/master/CMake/vtkMacroKitPythonWrap.cmake.~~
−
−	~~<b>References:</b>~~
−	* http://www.vtk.org/Wiki/VTK/WrapHierarchy
−
−	~~===Call InitializeObjectBase() in vtkObject New() methods===~~
−
−	In VTK8 it's necessary for <tt>vtkObject</tt> <tt>New()</tt> methods to call <tt>InitializeObjectBase()</tt> on the new object for proper tracking with <tt>vtkDebugLeaks</tt>. The standard macros (<tt>vtkStandardNewMacro</tt>, <tt>vtkObjectFactoryNewMacro</tt>) handle this. For those classes that don't use the macros, add a call to <tt>InitializeObjectBase()</tt> immediately after constructing the object by <tt>new vtkXXX()</tt>.
−
−	Additionally, <tt>vtkObjectFactory::CreateInstance()</tt> now doesn't register the class name with vtkDebugLeaks if the factory fails to create the object. Therefore, it's no longer necessary to unregister the class name with vtkDebugLeaks. Remove calls to <tt>vtkDebugLeaks::DestructClass(className)</tt> following <tt>vtkObjectFactory::CreateInstance()</tt>.
−
−	~~To support both VTK8 and earlier versions of VTK, wrap these changes in preprocessor checks for whether <tt>VTK_HAS_INITIALIZE_OBJECT_BASE</tt> is defined.~~
−
−	~~<b>References:</b>~~
−
−	* https://github.com/Kitware/VTK/commit/e5c793dbdf87e838bb2b60c6a5905ced0e5548f9
−	* http://public.kitware.com/pipermail/vtk-developers/2016-September/034332.html
−
−	~~===Add C++11 keywords===~~
−
−	~~VTK8 requires C++11. Subclasses of VTK classes must mark overridden methods with <tt>VTK_OVERRIDE</tt>.~~
−
−	~~===Qt5: QVTKOpenGLWidget===~~
−
−	When using Qt5, [https://github.com/Kitware/VTK/blob/9393774ff9b3d735a40eb445ff6c045e55c90eae/GUISupport/Qt/QVTKOpenGLWidget.h QVTKOpenGLWidget] should be used in place of QVTKGLWidget. To ensure that QVTKOpenGLWidget receives a properly configured OpenGL context it's necessary to call QSurfaceFormat::setDefaultFormat() before constructing the QApplication instance. QVTKOpenGLWidget::defaultFormat() supplies a suitable format, although it's recommended to disable multisampling for full compatibility with advanced rendering techniques. See http://doc.qt.io/qt-5/qopenglwidget.html.
−
−	~~===vtkWindowToImageFilter::SetMagnification() is deprecated===~~
−
−	VTK8.1 deprecated vtkWindowToImageFilter::SetMagnification() and vtkWindowToImageFilter::GetMagnification(). Replace calls to those methods with SetScale() and GetScale(). See https://github.com/Kitware/VTK/commit/af0a95fa7dd4e25ef869a0bc6077e547f18baa29.
−
−	~~===Enable C++11 in extensions===~~
−
−	~~SuperBuild extensions may have to enable C++11 for their external projects. Add the following lines to <tt>CMAKE_CACHE_ARGS</tt> in <tt>ExternalProject_Add</tt>~~
−
−	~~-DCMAKE_CXX_STANDARD:STRING=${CMAKE_CXX_STANDARD}~~
−	~~-DCMAKE_CXX_STANDARD_REQUIRED:BOOL=${CMAKE_CXX_STANDARD_REQUIRED}~~
−	~~-DCMAKE_CXX_EXTENSIONS:BOOL=${CMAKE_CXX_EXTENSIONS}~~

	==Future work==		==Future work==

@@ Line 1: / Line 1: @@
 This page documents the update of Slicer to use VTK 8.0.
 ==Overview==
 It is planned to update the version of VTK that Slicer uses from 7.1 to 8.0.
 ==Status==

@@ Line 1: / Line 1: @@
 This page documents the update of Slicer to use VTK 8.0.
 ==Overview==
 It is planned to update the version of VTK that Slicer uses from 7.1 to 8.0.
 ==Status==

@@ Line 1: / Line 1: @@
 This page documents the update of Slicer to use VTK 8.0.
 ==Overview==
 It is planned to update the version of VTK that Slicer uses from 7.1 to 8.0.
 ==Status==

@@ Line 49: / Line 49: @@
 Slicer's VTK 8.0 branch includes fixes/changes that aren't in upstream:
-* <del>Fix linking libvtkWrapping with Python wrapping and kits enabled on Mac</del>  (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/8a60be1)
+* <del>Fix linking libvtkWrapping with Python wrapping and kits enabled on Mac</del> {{done}} (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/8a60be1)
 ** <del>https://github.com/Slicer/VTK/commit/cbb1269509cb32d3827adfce1795e51209132e73</del>
-* <del>Respect access specifier of using statements in wrapping</del> (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/5a4ddec)
+* <del>Respect access specifier of using statements in wrapping</del> {{done}} (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/5a4ddec)
 ** <del>https://github.com/Slicer/VTK/commit/93a7c677481259cf23121a053d82ba4b7c2286e6</del>
-* ENH: Allow selection of seed points using vtkSeedWidget
+* <del>ENH: Allow selection of seed points using vtkSeedWidget</del> {{done}} (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/b684733)
-** https://github.com/Slicer/VTK/commit/734709ee38a0a25c92a9a0c7477cfddec5e12cf3
+** <del>https://github.com/Slicer/VTK/commit/734709ee38a0a25c92a9a0c7477cfddec5e12cf3</del>
-* <del>Ensure vtkVariant stream associated with << operator is set back to "dec".</del> (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/dc7c62a)
+* <del>Ensure vtkVariant stream associated with << operator is set back to "dec".</del> {{done}} (Merged upstream - Integrated in VTK as https://github.com/Kitware/VTK/commit/dc7c62a)
 ** <del>https://github.com/Slicer/VTK/commit/dbf5de60c0809ca6233fe428761ef19e561ef542</del>
 * BUG: WIP: fix vtkPickingManager interaction with widgets

@@ Line 43: / Line 43: @@
 * OpenGL errors occur when destroying vtkWin32OpenGLRenderWindow: https://gitlab.kitware.com/vtk/vtk/issues/17076
 ** Would be great to get a proper fix from the VTK team for this regression.
-* Can't build VTK on Mac with <tt>-DVTK_WRAP_PYTHON:BOOL=ON -DVTK_ENABLE_KITS:BOOL=ON</tt> because libvtkWrapping-8.1.1.dylib doesn't link.
+* <del>Can't build VTK on Mac with <tt>-DVTK_WRAP_PYTHON:BOOL=ON -DVTK_ENABLE_KITS:BOOL=ON</tt> because libvtkWrapping-8.1.1.dylib doesn't link.</del>
 * Update Slicer/VTK branch to include upstreamed fixes