Updating to Qt 6 (#523)

* Remove some deprecated calls.

* Update CMake Lists

* Update OIGTL/OIGTLIO

* VTK fix

* The macro SendMessage in winuser.h clashes with the method name in igtlioConnector. I would guess Qt6 now includes this somewhere where Qt5 wasn't. The cleaner way to resolve this would be to rename the SendMessage method in OIGTLIO to something unique, but this would require also changing every other application using OIGTLIO.

* Update Windows and Linux CI to build with Qt6

Author: errollgarner

.github/workflows/build-windows.yml

@@ -3,7 +3,7 @@ name: Build-Windows
 on: [push, pull_request]
 env:
   BUILD_TYPE: Release
-  QT_VERSION: 5.15.2
+  QT_VERSION: 6.9.0
   ARTIFACT: ibis-install-windows
   RELEASE_TAG: latest_dev
 permissions:
@@ -24,7 +24,7 @@ jobs:
             -B ${{github.workspace}}/b \
             -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} \
             -DCMAKE_CONFIGURATION_TYPES=${{env.BUILD_TYPE}} \
-            -DQt5_DIR=C:/Qt/5.15.2/msvc2019_64/lib/cmake/Qt5 \
+            -DQt6_DIR=C:/Qt/${{env.QT_VERSION}}/msvc2022_64/lib/cmake/Qt6 \
             -DIBIS_BUILD_ELASTIX=TRUE \
             -DIBIS_BUILD_OPENCV=TRUE \
             -DIBIS_BUILD_ALL_PLUGINS:BOOL=TRUE

.github/workflows/build_linux.yml

@@ -3,6 +3,7 @@ name: Build-Linux
 on: [push, pull_request]
 env:
   BUILD_TYPE: Release
+  QT_VERSION: 6.9.0
   ARTIFACT: ibis-install-linux
 permissions:
   contents: write
@@ -20,6 +21,7 @@ jobs:
             cmake IbisSuperBuild \
             -B "${{github.workspace}}/b" \
             -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} \
+            -DQt6_DIR=/opt/Qt/${{env.QT_VERSION}}/gcc_64/lib/cmake/Qt6 \
             -DIBIS_BUILD_ELASTIX=TRUE \
             -DIBIS_BUILD_OPENCV=TRUE \
             -DIBIS_BUILD_ALL_PLUGINS:BOOL=TRUE

CMakeCommon/windeployqt.cmake

@@ -20,11 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-find_package(Qt5Core REQUIRED)
+find_package(Qt6Core REQUIRED)
 
 # Retrieve the absolute path to qmake and then use that path to find
 # the windeployqt binary
-get_target_property(_qmake_executable Qt5::qmake IMPORTED_LOCATION)
+get_target_property(_qmake_executable Qt6::qmake IMPORTED_LOCATION)
 get_filename_component(_qt_bin_dir "${_qmake_executable}" DIRECTORY)
 find_program(WINDEPLOYQT_EXECUTABLE windeployqt HINTS "${_qt_bin_dir}")
 
@@ -44,7 +44,6 @@ function(windeployqt target directory)
             env PATH="${_qt_bin_dir}" "${WINDEPLOYQT_EXECUTABLE}"
                 --verbose 0
                 --no-compiler-runtime
-                --no-angle
                 --no-opengl-sw
                 \"$<TARGET_FILE:${target}>\"
     )
@@ -65,7 +64,6 @@ function(windeployqt target directory)
                 env PATH=\"${_qt_bin_dir}\" \"${WINDEPLOYQT_EXECUTABLE}\"
                     --dry-run
                     --no-compiler-runtime
-                    --no-angle
                     --no-opengl-sw
                     --list mapping
                     \${_file}

CMakeLists.txt

@@ -28,7 +28,7 @@ include( ${CMAKE_COMMON_DIR}/DependencyVersions.cmake )
 set( IBIS_EXTERNAL_DEPENDENCIES_DIR ${CMAKE_CURRENT_BINARY_DIR}/../IbisDeps CACHE PATH "Path where the external dependencies (itk, vtk, openCV) have been built" )
 
 #==================================================================
-# Look for QT5 (required)
+# Look for QT6 (required)
 #==================================================================
 option( IBIS_USE_QT_MULTIMEDIA "Find and link with the Multimedia module in Qt. This is not required by Ibis but may be used by some plugins." OFF )
 option( IBIS_USE_QT_NETWORK "Find and link with the Network module in Qt. This is not required by Ibis but may be used by some plugins." OFF )
@@ -39,28 +39,18 @@ endif()
 if( IBIS_USE_QT_NETWORK )
     list( APPEND IbisQtModules Network )
 endif()
-if( UNIX AND NOT APPLE )
-    list( APPEND IbisQtModules X11Extras )
-endif()
-find_package( Qt5 COMPONENTS ${IbisQtModules} REQUIRED )
 
-# Qt support by Qt Company: QT 5.1.0 to 5.5.0 support ended.  5.6.0 still supported until March 2019.
-# ibis was never tested with versions 5.6.0, 5.7.0 and 5.8.0. It might work with 5.8.0.
-# it worked with 5.9.3
+find_package( Qt6 COMPONENTS ${IbisQtModules} REQUIRED )
 
-if( Qt5Widgets_FOUND )
-    if( Qt5Widgets_VERSION VERSION_LESS 5.6.0 )
-        message( SEND_ERROR "Qt version 5.5.x or lower is no longer supported.\nCurrently supported Qt version is 5.9 and higher.\nYou are using " ${Qt5Widgets_VERSION} "." )
-    elseif( Qt5Widgets_VERSION VERSION_LESS 5.9.0 )
-        message( SEND_ERROR "Currently supported Qt version is 5.9 and higher.\nYou are using " ${Qt5Widgets_VERSION} ". It may work." )
-    endif()
-else()
-    message( SEND_ERROR "The Qt5Widgets library could not be found!" )
+if( NOT Qt6Widgets_FOUND )
+    message( SEND_ERROR "The Qt6Widgets library could not be found!" )
 endif()
 
-include_directories( ${Qt5Widgets_INCLUDE_DIRS} )
-include_directories( ${Qt5Xml_INCLUDE_DIRS} )
-include_directories( ${Qt5Multimedia_INCLUDE_DIRS} )
+cmake_path(GET Qt6_DIR PARENT_PATH Qt6_root)
+
+include_directories( ${Qt6Widgets_INCLUDE_DIRS} )
+include_directories( ${Qt6Xml_INCLUDE_DIRS} )
+include_directories( ${Qt6Multimedia_INCLUDE_DIRS} )
 
 #==================================================================
 # Look for VTK (required)
@@ -125,7 +115,7 @@ endif()
 
 # define version and build info
 set( IBIS_MAJOR_VERSION 4 )
-set( IBIS_MINOR_VERSION 0 )
+set( IBIS_MINOR_VERSION 1 )
 set( IBIS_PATCH_VERSION 0 )
 set( IBIS_VERSION_QUALIFIER "Dev" )                    # Dev, Alpha, Beta or nothing for official releases
 if( CMAKE_BUILD_TYPE MATCHES "Debug" )
@@ -178,4 +168,4 @@ if( IBIS_BUILD_DOCUMENTATION )
     else( DOXYGEN_FOUND )
         message( "Doxygen needs to be installed to generate documentation" )
     endif()
-endif()
+endif()

Ibis/CMakeLists.txt

@@ -1,8 +1,8 @@
 PROJECT ( IBIS_MAIN )
 
 # define sources
-SET( IBIS_SRC main.cpp commandlinearguments.cpp )
-SET( IBIS_HDR commandlinearguments.h )
+set( IBIS_SRC main.cpp commandlinearguments.cpp )
+set( IBIS_HDR commandlinearguments.h )
 set( exec_name ibis )
 
 # option to turn on vtk warnings
@@ -12,7 +12,7 @@ if( NOT IBIS_ENABLE_VTK_WARNINGS )
 endif()
 
 # moc Qt source file without a ui file
-qt5_wrap_cpp( IBIS_MOC ${IBIS_HDR_MOC} )
+qt6_wrap_cpp( IBIS_MOC ${IBIS_HDR_MOC} )
 
 # make rules to create c++ source from Qt resource files
 
@@ -70,7 +70,7 @@ endif()
 #================================
 # Define executable
 #================================
-SET( SOURCE ${IBIS_HDR} ${IBIS_HDR_MOC} ${IBIS_SRC} ${ImportPluginsSourceFile} ${IBIS_MOC} ${IBIS_SRC_ICNS} ${platform_src} )
+set( SOURCE ${IBIS_HDR} ${IBIS_HDR_MOC} ${IBIS_SRC} ${ImportPluginsSourceFile} ${IBIS_MOC} ${IBIS_SRC_ICNS} ${platform_src} )
 ADD_EXECUTABLE( ${exec_name} ${executable_flags} ${SOURCE} )
 
 if (APPLE)
@@ -90,10 +90,13 @@ if( USE_POINT_GREY_CAMERA )
     set( flycaptureLib flycapture )
 endif()
 
-TARGET_LINK_LIBRARIES( ${exec_name} ${PluginLibs} ${PluginExternalLibs} ${HardwareModulesLibs} ${libsToUse} ${QT_LIBRARIES}
-                                    ${VTK_LIBRARIES} ${MINC4ITK_LIBRARIES} ${ELASTIX_LIBRARIES}
+target_link_libraries( ${exec_name} ${PluginLibs} ${PluginExternalLibs} ${HardwareModulesLibs} ${libsToUse} 
+                                    ${VTK_LIBRARIES} ${MINC4ITK_LIBRARIES} ${ELASTIX_LIBRARIES} 
                                     ${itkLibsToUse} ${OpenCV_LIBS} ${flycaptureLib} svl ${gpuLibs} )
-qt5_use_modules( ${exec_name} ${IbisQtModules} )
+foreach( module IN LISTS IbisQtModules )
+	message( STATUS "Linking against Qt6::${module}" )
+    target_link_libraries( ${exec_name} "Qt6::${module}" )
+endforeach()
 
 vtk_module_autoinit( TARGETS ${exec_name} MODULES ${VTK_LIBRARIES})
 
@@ -117,7 +120,7 @@ endif()
 #================================
 if( APPLE )
    # On mac, we need to run macdeployqt on the installed bundle (should eventually implement a better solution)
-   get_target_property( QMakeLocation Qt5::qmake LOCATION)
+   get_target_property( QMakeLocation Qt6::qmake LOCATION)
    get_filename_component( QtBinLocation ${QMakeLocation} DIRECTORY )
    set( MacDeployQtExec ${QtBinLocation}/macdeployqt )
    set( BuiltExecFullPath ${CMAKE_CURRENT_BINARY_DIR}/${exec_name}.app )
@@ -148,7 +151,7 @@ endif()
 #================================
 set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "Ibis image-guided neurosurgery program and viewer")
 set( CPACK_PACKAGE_NAME ${exec_name} )
-set( CPACK_PACKAGE_CONTACT "Simon Drouin and Anka Kochanowska")
+set( CPACK_PACKAGE_CONTACT "Étienne Léger")
 set( CPACK_PACKAGE_VENDOR "NeuroImaging and Surgical Technologies (NIST) Lab - McConnell Brain Imaging Centre - Montreal Neurological Institute")
 set( CPACK_PACKAGE_VERSION_MAJOR ${IBIS_MAJOR_VERSION})
 set( CPACK_PACKAGE_VERSION_MINOR ${IBIS_MINOR_VERSION})

IbisHardwareIGSIO/CMakeLists.txt

@@ -21,10 +21,10 @@ set( IbisHardwareIgsioHdrMoc ibishardwareIGSIO.h plusserverinterface.h ibishardw
 set( IbisHardwareIgsioUi ibishardwareIGSIOsettingswidget.ui )
 
 # moc Qt source file without a ui file
-qt5_wrap_cpp( IbisHardwareIgsioMoc ${IbisHardwareIgsioHdrMoc} )
+qt6_wrap_cpp( IbisHardwareIgsioMoc ${IbisHardwareIgsioHdrMoc} )
 
 # Generate code for .ui files -> ui_xxx.h
-qt5_wrap_ui( IbisHardwareIgsioUiHdr ${IbisHardwareIgsioUi} )
+qt6_wrap_ui( IbisHardwareIgsioUiHdr ${IbisHardwareIgsioUi} )
 
 #================================
 # Define output

IbisHardwareIGSIO/ibishardwareIGSIO.cpp

@@ -41,6 +41,8 @@ See Copyright.txt or http://ibisneuronav.org/Copyright.html for details.
 #include "qIGTLIOLogicController.h"
 #include "usprobeobject.h"
 
+#undef SendMessage
+
 const double IbisHardwareIGSIO::MaxTimeBetweenTransformSamples = 0.2;
 const QString IbisHardwareIGSIO::PlusServerExecutable          = "PlusServerExecutable";
 

IbisLib/CMakeLists.txt

@@ -183,14 +183,14 @@ set( IBISLIB_UI
 
 
 # moc Qt source file without a ui file
-qt5_wrap_cpp( IBISLIB_MOC ${IBISLIB_HDR_MOC} )
+qt6_wrap_cpp( IBISLIB_MOC ${IBISLIB_HDR_MOC} )
 
 # Generate code for .ui files -> ui_xxx.h
-qt5_wrap_ui( IBISLIB_HDR_UI ${IBISLIB_UI} )
+qt6_wrap_ui( IBISLIB_HDR_UI ${IBISLIB_UI} )
 
 # make rules to create c++ source from Qt resource files
 set( IBISLIB_RCC IbisLib.qrc )
-qt5_add_resources( IBISLIB_RCC_SRC ${IBISLIB_RCC})
+qt6_add_resources( IBISLIB_RCC_SRC ${IBISLIB_RCC})
 
 #================================
 # Define output

IbisLib/application.cpp

@@ -71,7 +71,7 @@ void ApplicationSettings::LoadSettings( QSettings & settings )
     ViewBackgroundColor.setGreen( settings.value( "ViewBackgroundColor_g", 50 ).toInt() );
     ViewBackgroundColor.setBlue( settings.value( "ViewBackgroundColor_b", 50 ).toInt() );
     // then 3D view, if not found in settings, set the same as 2D.
-    double bgColor[3];
+    float bgColor[3];
     ViewBackgroundColor.getRgbF( &bgColor[0], &bgColor[1], &bgColor[2] );
     View3DBackgroundColor.setRed( settings.value( "View3DBackgroundColor_r", int( bgColor[0] * 255 ) ).toInt() );
     View3DBackgroundColor.setGreen( settings.value( "View3DBackgroundColor_g", int( bgColor[1] * 255 ) ).toInt() );
@@ -221,14 +221,17 @@ Application::~Application()
 
 void Application::ApplyApplicationSettings()
 {
-    double bgColor[3];
+    float bgColor[3] = {0., 0., 0.};
     m_settings.ViewBackgroundColor.getRgbF( &bgColor[0], &bgColor[1], &bgColor[2] );
-    m_sceneManager->SetViewBackgroundColor( bgColor );
-    m_settings.View3DBackgroundColor.getRgbF( &bgColor[0], &bgColor[1], &bgColor[2] );
-    m_sceneManager->SetView3DBackgroundColor( bgColor );
+    double bgColord[3] = { bgColor[0], bgColor[1], bgColor[2] };
+    m_sceneManager->SetViewBackgroundColor( bgColord );
+    float bg3DColor[3] = {0., 0., 0.};
+    m_settings.View3DBackgroundColor.getRgbF( &bg3DColor[0], &bg3DColor[1], &bg3DColor[2] );
+    double bg3DColord[3] = { bg3DColor[0], bg3DColor[1], bg3DColor[2] };
+    m_sceneManager->SetView3DBackgroundColor( bg3DColord );
     m_sceneManager->Set3DCameraViewAngle( m_settings.CameraViewAngle3D );
 
-    double cursorColor[3];
+    float cursorColor[3] = {0., 0., 0.};
     m_settings.CutPlanesCursorColor.getRgbF( &cursorColor[0], &cursorColor[1], &cursorColor[2] );
     WorldObject * world = WorldObject::SafeDownCast( m_sceneManager->GetSceneRoot() );
     world->SetCursorColor( cursorColor );
@@ -445,7 +448,7 @@ void Application::OpenFiles( OpenFileParams * params, bool addToScene )
         {
             QString message( "No read permission on file: " );
             message.append( cur.fileName );
-            QMessageBox::critical( nullptr, "Error", message, 1, 0 );
+            QMessageBox::critical( nullptr, "Error", message, QMessageBox::Ok );
             return;
         }
         if( m_fileReader->IsMINC1( cur.fileName.toUtf8().data() ) )
@@ -557,7 +560,7 @@ bool Application::GetPointsFromTagFile( QString fileName, PointsObject * pts1, P
     {
         QString message( "No read permission on file: " );
         message.append( fileName );
-        QMessageBox::critical( nullptr, "Error", message, 1, 0 );
+        QMessageBox::critical( nullptr, "Error", message, QMessageBox::Ok );
         return false;
     }
     bool ok = m_fileReader->GetPointsDataFromTagFile( fileName, pts1, pts2 );
@@ -1014,7 +1017,7 @@ int Application::GetNumberOfComponents( QString filename )
     {
         QString message( "No read permission on file: " );
         message.append( filename );
-        QMessageBox::critical( nullptr, "Error", message, 1, 0 );
+        QMessageBox::critical( nullptr, "Error", message, QMessageBox::Ok );
         return false;
     }
     int n = m_fileReader->GetNumberOfComponents( filename );
@@ -1031,7 +1034,7 @@ bool Application::GetGrayFrame( QString filename, IbisItkUnsignedChar3ImageType:
     {
         QString message( "No read permission on file: " );
         message.append( filename );
-        QMessageBox::critical( nullptr, "Error", message, 1, 0 );
+        QMessageBox::critical( nullptr, "Error", message, QMessageBox::Ok );
         return false;
     }
     bool ok = m_fileReader->GetGrayFrame( filename, itkImage );
@@ -1049,7 +1052,7 @@ bool Application::GetRGBFrame( QString filename, IbisRGBImageType::Pointer itkIm
     {
         QString message( "No read permission on file: " );
         message.append( filename );
-        QMessageBox::critical( nullptr, "Error", message, 1, 0 );
+        QMessageBox::critical( nullptr, "Error", message, QMessageBox::Ok );
         return false;
     }
     bool ok = m_fileReader->GetRGBFrame( filename, itkImage );

IbisLib/filereader.cpp

@@ -114,7 +114,7 @@ void FileReader::SetIbisAPI( IbisAPI * api )
         QString mincDir = m_ibisAPI->GetCustomPath( MINCToolsPathVarName );
         if( !mincDir.isNull() && !mincDir.isEmpty() )
         {
-            if( mincDir.at( mincDir.count() - 1 ) != '/' ) mincDir.append( "/" );
+            if( mincDir.at( mincDir.size() - 1 ) != '/' ) mincDir.append( "/" );
             m_mincconvert.clear();
             m_mincconvert.append( mincDir );
             m_mincconvert.append( "mincconvert" );
@@ -183,7 +183,7 @@ bool FileReader::ConvertMINC1toMINC2( QString & inputileName, QString & outputil
         tmp.append( inputileName + " is of MINC1 type and needs to be converted to MINC2.\n" +
                     "Tool mincconvert was not found in standard paths on your file system.\n" +
                     "Please convert using command: \nmincconvert -2 <input> <output>" );
-        QMessageBox::critical( 0, "Error", tmp, 1, 0 );
+        QMessageBox::critical( 0, "Error", tmp, QMessageBox::Ok );
         return false;
     }
     QString dirname( QDir::homePath() );
@@ -247,7 +247,7 @@ bool FileReader::ConvertMINC1toMINC2( QString & inputileName, QString & outputil
                 QString tmp( "File " );
                 tmp.append( inputileName + " is an acquired frame of MINC1 type and needs to be converted to MINC2.\n" +
                             "Tool minccalc was not found in standard paths on your file system.\n" );
-                QMessageBox::critical( 0, "Error", tmp, 1, 0 );
+                QMessageBox::critical( 0, "Error", tmp, QMessageBox::Ok );
                 return false;
             }
         }
@@ -346,7 +346,7 @@ bool FileReader::OpenFile( QList<SceneObject *> & readObjects, QString filename,
                 QString tmp( "File " );
                 tmp.append( filename + " is  of MINC1 type and needs to be converted to MINC2.\n" +
                             "Open Settings/Preferences and set path to the directory containing MINC tools.\n" );
-                QMessageBox::critical( 0, "Error", tmp, 1, 0 );
+                QMessageBox::critical( 0, "Error", tmp, QMessageBox::Ok );
                 return false;
             }
             if( this->ConvertMINC1toMINC2( filename, fileMINC2, true ) )
@@ -847,7 +847,7 @@ int FileReader::GetNumberOfComponents( QString filename )
             QString tmp( "File " );
             tmp.append( filename + " is an acquired frame of MINC1 type and needs to be converted to MINC2.\n" +
                         "Open Settings/Preferences and set path to the directory containing MINC tools.\n" );
-            QMessageBox::critical( 0, "Error", tmp, 1, 0 );
+            QMessageBox::critical( 0, "Error", tmp, QMessageBox::Ok );
             return 0;
         }
         if( this->ConvertMINC1toMINC2( filename, fileMINC2, true ) )