Feature/qt4 qt5

CMakeLists.txt

@@ -1,11 +1,12 @@
 # CMakeLists.txt has to be located in the project folder and cmake has to be
 # executed from 'project/build' with 'cmake ../'.
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 project(vizkit3d
 	VERSION 0.2
 	DESCRIPTION "vizkit3d visualization library")
 find_package(Rock)
 rock_init()
+rock_feature(NOCURDIR)
 
 rock_find_cmake(Boost REQUIRED COMPONENTS thread system)
 rock_standard_layout()

README.md

@@ -4,7 +4,43 @@ vizkit3d is a lightweight infrastructure to allow the creation of 3D views to di
 data (and in particular data related to robotic sensing) live. It is used as the
 core 3D view implementation in [Rock, the Robot Construction Kit](http://rock-robotics.org).
 Nonetheless, vizkit3d uses only widely accepted libraries (Qt and OSG) and depends
-on the Rock framework in no way.
+on the Rock framework in no way. It only uses Rocks cmake macros.
 
 Vizkit3D functionality can also be accessed from Ruby by using
 [the vizkit library](https://github.com/rock-core/gui-vizkit).
+
+Qt5 Porting Guide
+=================
+
+Different to Qt4, Qt5 uses the meta object compiler to register plugins.
+This requires a few changes to the plugin objects(the classes derived from
+`vizkit3d::VizkitPluginFactory`) setup:
+
+* The Qt4 macro must be protected against Qt5:
+```
+#if QT_VERSION < 0x050000
+	Q_EXPORT_PLUGIN2(QtPluginVizkitBase, QtPluginVizkitBase)
+#endif
+```
+* The class must use Q_OBJECT and have the line
+```
+#if QT_VERSION >= 0x050000
+	Q_PLUGIN_METADATA(IID "rock.vizkit3d.VizkitPluginFactory")
+#endif
+```
+* Since the class now needs to be processed by the moc, it is required that the
+  class is declared in a header.
+
+If the plugin is instantiated using the `VizkitQtPlugin(name)` macro,
+that needs to be replaced by two macro invocations; in a relevant header, use
+`VizkitQtPluginHeaderDecls(name)`, and in a compilation object file(.cc/.cpp),
+add `VizkitQtPluginImpl(name)` (probably just replacing the
+`VizkitQtPlugin(name)` invocation).
+
+It is possible to build both a Qt4 and Qt5 version of the plugins by avoiding
+placing the Qt4/Qt5 libraries and includes in the cmake directory scope
+variables.
+For this, it is easiest to use the Qt4/Qt5 targets provided by
+`findPackage(Qt4 COMPONENTE QtCore ...)`/`findPackage(Qt5 COMPONENTS Core ...)`
+in `target_link_libraries(viz-qt4 PRIVATE Qt4::QtCore ...)` and
+`target_link_libraries(viz-qt5 PRIVATE Qt5::Core ...)`.

manifest.xml

@@ -13,14 +13,20 @@
      <keyword>ui</keyword>
      <keyword>visualization</keyword>
      <keyword>vizkit3d</keyword>
-   </keywords>
-   <stage>-1</stage>
-    <depend package="osg" />
-    <depend package="qt4" />
-    <depend package="qt4-opengl" />
-    <depend package="gui/osg_qt4" />
+    </keywords>
+    <stage>-1</stage>
+    <!-- qt4 version dependencies -->
+    <depend package="osg" optional="1" />
+    <depend package="qt4" optional="1" />
+    <depend package="qt4-opengl" optional="1" />
+    <!-- qt5 version dependencies -->
+    <depend package="qt5" optional="1" />
+    <depend package="qt5-opengl" optional="1" />
+    <!-- common dependencies -->
     <depend package="boost" />
     <depend package="base/cmake" />
     <depend package="gui/osgviz" />
+    <depend package="gui/osg_qt4" /> <!-- also contains the qt5 version -->
+    <depend package="gui/qtpropertybrowser" />
     <!--    <depend package="qt-designer" /> !-->
 </package>

src/CMakeLists.txt

@@ -1,10 +1,8 @@
-rock_find_qt4(QtOpenGL)
-include(RockRuby)
 
-QT4_ADD_RESOURCES(PROPERTY_BROWSER_RESOURCES qtpropertybrowser/qtpropertybrowser.qrc)
+rock_find_qt4(OPTIONAL QtOpenGL)
+rock_find_qt5(OPTIONAL Core OpenGL Widgets UiPlugin)
 
-rock_library(vizkit3d
-    SOURCES
+set(VIZKIT3D_SOURCES
         QtThreadedWidget.cpp
         NodeLink.cpp
         ColorConversionHelper.cpp
@@ -16,23 +14,20 @@ rock_library(vizkit3d
         CoordinateFrame.cpp
         DefaultManipulator.cpp
         EnableGLDebugOperation.cpp
-        QPropertyBrowserWidget.cpp
-        ${PROPERTY_BROWSER_RESOURCES}
-    MOC
         Vizkit3DPlugin.cpp
         Vizkit3DWidget.cpp
         QVizkitMainWindow.cpp
-        qtpropertybrowser/qteditorfactory.cpp
-        qtpropertybrowser/qtvariantproperty.cpp
-        qtpropertybrowser/qtpropertymanager.cpp
-        qtpropertybrowser/qtbuttonpropertybrowser.cpp
-        qtpropertybrowser/qtpropertybrowser.cpp
-        qtpropertybrowser/qtpropertybrowserutils.cpp
-        qtpropertybrowser/qttreepropertybrowser.cpp
-        qtpropertybrowser/qtgroupboxpropertybrowser.cpp
         QPropertyBrowserWidget.cpp
-        ${MOC_EXTRA}
-    HEADERS
+)
+
+set(VIZKIT3D_MOC
+        Vizkit3DPlugin.hpp
+        Vizkit3DWidget.hpp
+        QVizkitMainWindow.hpp
+        QPropertyBrowserWidget.hpp
+)
+
+set(VIZKIT3D_HEADERS
         TransformerGraph.hpp
         GridNode.hpp
         TextureBox.hpp
@@ -49,26 +44,167 @@ rock_library(vizkit3d
         EnvPluginBase.hpp
         DefaultManipulator.hpp
         QPropertyBrowserWidget.hpp
-        qtpropertybrowser/qttreepropertybrowser.h
-        qtpropertybrowser/qtpropertybrowser.h
-        qtpropertybrowser/qtvariantproperty.h
-        qtpropertybrowser/qteditorfactory.h
-        qtpropertybrowser/qtpropertymanager.h
-        qtpropertybrowser/qtpropertybrowserutils.h
+)
+
+if (ROCK_QT_VERSION_4)
+include(RockRuby)
+    find_package(QtPropertyBrowser-qt4 QUIET)
+
+    if(QtPropertyBrowser-qt4_FOUND)
+        message(STATUS "Using external QtPropertyBrowser-qt4")
+        set(PROPERTY_BROWSER_TARGET QtPropertyBrowser-qt4)
+    else()
+        message(STATUS "Using internal qtpropertybrowser")
+        QT4_ADD_RESOURCES(PROPERTY_BROWSER_RESOURCES qtpropertybrowser/qtpropertybrowser.qrc)
+
+        set(PROPERTY_BROWSER_SOURCES
+                qtpropertybrowser/qteditorfactory.cpp
+                qtpropertybrowser/qtvariantproperty.cpp
+                qtpropertybrowser/qtpropertymanager.cpp
+                qtpropertybrowser/qtbuttonpropertybrowser.cpp
+                qtpropertybrowser/qtpropertybrowser.cpp
+                qtpropertybrowser/qtpropertybrowserutils.cpp
+                qtpropertybrowser/qttreepropertybrowser.cpp
+                qtpropertybrowser/qtgroupboxpropertybrowser.cpp
+        )
+
+        set(PROPERTY_BROWSER_MOC
+                qtpropertybrowser/qteditorfactory.h
+                qtpropertybrowser/qtvariantproperty.h
+                qtpropertybrowser/qtpropertymanager.h
+                qtpropertybrowser/qtbuttonpropertybrowser.h
+                qtpropertybrowser/qtpropertybrowser.h
+                qtpropertybrowser/qtpropertybrowserutils.h
+                qtpropertybrowser/qttreepropertybrowser.h
+                qtpropertybrowser/qtgroupboxpropertybrowser.h
+        )
+
+        set(PROPERTY_BROWSER_HEADERS
+                qtpropertybrowser/qttreepropertybrowser.h
+                qtpropertybrowser/qtpropertybrowser.h
+                qtpropertybrowser/qtvariantproperty.h
+                qtpropertybrowser/qteditorfactory.h
+                qtpropertybrowser/qtpropertymanager.h
+                qtpropertybrowser/qtpropertybrowserutils.h
+        )
+    endif()
+
+rock_library(vizkit3d
+    SOURCES
+        ${VIZKIT3D_SOURCES}
+        ${PROPERTY_BROWSER_SOURCES}
+        ${PROPERTY_BROWSER_RESOURCES}
+    MOC
+        ${VIZKIT3D_MOC}
+        ${PROPERTY_BROWSER_MOC}
+        ${MOC_EXTRA}
+    HEADERS
+        ${VIZKIT3D_HEADERS}
+        ${PROPERTY_BROWSER_HEADERS}
         ${HEADERS_EXTRA}
-    LIBS ${Boost_THREAD_LIBRARY} ${Boost_SYSTEM_LIBRARY}
+    LIBS ${Boost_THREAD_LIBRARY} ${Boost_SYSTEM_LIBRARY} Qt4::QtOpenGL
     DEPS_CMAKE OpenGL
+    DEPS_TARGET ${PROPERTY_BROWSER_TARGET}
     DEPS_PKGCONFIG openscenegraph openscenegraph-osgQt osgViz
                    PrimitivesFactory ManipulationClickHandler ${DEPS_EXTRA})
 
+    if(NOT QtPropertyBrowser-qt4_FOUND)
+        target_include_directories(vizkit3d PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/qtpropertybrowser)
+    endif()
+
 rock_library(vizkitwidgetloader
-    MOC QVizkitWidgetLoader.cpp
+        QVizkitWidgetLoader.cpp
+    MOC QVizkitWidgetLoader.hpp
     DEPS vizkit3d
     NOINSTALL) # installs in a non-standard location
 #rock_library(vizkitmainwindowloader
 #    MOC QVizkitMainWindowLoader.cpp
 #    DEPS vizkit3d
 #    NOINSTALL) # installs in a non-standard location
+
 install(TARGETS vizkitwidgetloader #vizkitmainwindowloader
     LIBRARY DESTINATION lib/qt/designer
     ARCHIVE DESTINATION lib/qt/designer)
+
+endif()
+
+if (ROCK_QT_VERSION_5)
+    find_package(QtPropertyBrowser QUIET)
+    find_package(QtPropertyBrowser-qt5 QUIET)
+    if(QtPropertyBrowser_FOUND)
+        message(STATUS "Using abhijitkundu QtPropertyBrowser")
+        set(QTPROPERTYBROWSER_NAME QtPropertyBrowser)
+    elseif(QtPropertyBrowser-qt5_FOUND)
+        message(STATUS "Using rock QtPropertyBrowser-qt5")
+        set(QTPROPERTYBROWSER_NAME QtPropertyBrowser-qt5)
+    else()
+        message(SEND_ERROR "Could not find QtPropertyBrowser or QtPropertyBrowser-qt5")
+    endif()
+
+pkg_check_modules(OSGQT QUIET osgQt)
+pkg_check_modules(OPENSCENEGRAPH_OSGQT5 QUIET openscenegraph-osgQt5)
+
+if(${OPENSCENEGRAPH_OSGQT5_FOUND})
+  set(OSGQT_PKGCONFIG_NAME "openscenegraph-osgQt5")
+elseif(${OSGQT_FOUND})
+  set(OSGQT_PKGCONFIG_NAME "osgQt")
+else()
+  message(SEND_ERROR "Could not find osgQt or openscenegraph-osgQt5 with pkg-config")
+endif()
+
+rock_library(vizkit3d-qt5
+    SOURCES
+        ${VIZKIT3D_SOURCES}
+    MOC5
+        ${VIZKIT3D_MOC}
+    HEADERS
+        QPropertyBrowserWidget.hpp
+        ${VIZKIT3D_HEADERS}
+    DEPS_TARGET
+# QtPropertyBrowser properly sets up its target, fails to setup the plain
+# cmake variables(thus cannot be used with DEPS_CMAKE) and does not have a
+# pkg-config file(cannot be used with DEPS_PKGCONFIG).
+        ${QTPROPERTYBROWSER_NAME}
+    LIBS
+# Qt has proper targets so potentially could be used with DEPS_TARGET, but
+# it also provides proper pkg-config files, that are prefered there. Here,
+# we have the qt dependencies hardcoded into the .pc.in and use the cmake
+# targets for the cmake side.
+        Qt5::Core
+        Qt5::Widgets
+        Qt5::OpenGL
+        Qt5::UiPlugin
+        ${Boost_THREAD_LIBRARY}
+        ${Boost_SYSTEM_LIBRARY}
+    DEPS_PKGCONFIG
+        osgViz
+        ${OSGQT_PKGCONFIG_NAME}
+        ManipulationClickHandler
+)
+
+rock_library(vizkitwidgetloader-qt5
+    SOURCES
+        QVizkitWidgetLoader.cpp
+    MOC5
+        QVizkitWidgetLoader.hpp
+    DEPS
+        vizkit3d-qt5
+    NOINSTALL # installs in a non-standard location
+)
+
+rock_library(vizkitmainwindowloader-qt5
+    SOURCES
+        QVizkitMainWindowLoader.cpp
+    DEPS
+        vizkit3d-qt5
+    NOINSTALL # installs in a non-standard location
+)
+
+#normally, these would go into lib/qt5/plugins/designer, but
+#in rock, we put them in lib/qt/designer as well, since we already
+#have that in QT_PLUGIN_PATH
+install(TARGETS vizkitwidgetloader-qt5 vizkitmainwindowloader-qt5
+    LIBRARY DESTINATION lib/qt/designer
+    ARCHIVE DESTINATION lib/qt/designer)
+
+endif()

src/QPropertyBrowserWidget.cpp

@@ -30,7 +30,13 @@ void QPropertyBrowserWidget::addGlobalProperties(QObject* obj, const QStringList
 
     for(int i = 1 ; i < metaObj->propertyCount(); i++)
     {
+#if QT_VERSION < 0x050000
         if(property_list.contains(QString::fromAscii(metaObj->property(i).name())))
+#else
+        if(!metaObj->property(i).isDesignable())
+            continue;
+        if(property_list.contains(QString::fromLocal8Bit(metaObj->property(i).name())))
+#endif
         {
             QtVariantProperty* property = variantManager->addProperty(metaObj->property(i).type(), metaObj->property(i).name());
             if(property == 0)
@@ -75,16 +81,25 @@ void QPropertyBrowserWidget::addProperties(QObject* obj,QObject* parent)
     //retrieve and add dynamic properties
     QList<QByteArray> dynamicProperties = obj->dynamicPropertyNames();
     for (auto dp : dynamicProperties){
+#if QT_VERSION >= 0x050000
+        QVariant val = obj->property(dp.toStdString().c_str());
+        QtVariantProperty* property =variantManager->addProperty(val.type(), QString(dp.toStdString().c_str()));
+#else
         QVariant val = obj->property(dp.data());
         QtVariantProperty* property =variantManager->addProperty(val.type(), QString(dp.data()));
+#endif
         property->setValue(val);
         properties.push_back(property);
     }
 
     for(int i = 1 ; i < metaObj->propertyCount(); i++)
     {
         QMetaProperty prop = metaObj->property(i);
+#if QT_VERSION < 0x050000
         if(!prop.isValid())
+#else
+        if(!prop.isValid() || !prop.isDesignable())
+#endif
             continue;
 
         QVariant var = obj->property(prop.name());
@@ -101,6 +116,12 @@ void QPropertyBrowserWidget::addProperties(QObject* obj,QObject* parent)
         if(prop.type() == QVariant::StringList)
         {
             QtVariantProperty* property = variantManager->addProperty(QtVariantPropertyManager::enumTypeId(),prop.name());
+            if(property == 0)
+            {
+                std::cerr << "QVariant type " << metaObj->property(i).type() << " with name " << metaObj->property(i).name() 
+                    << " is not supported by the QtPropertyBrowser." << std::endl;
+                continue;
+            }
             property->setAttribute("enumNames", var);
             properties.push_back(property);
             continue;

src/QPropertyBrowserWidget.hpp

@@ -1,9 +1,12 @@
 #ifndef QPROPERTYBROWSERWIDGET_HPP
 #define QPROPERTYBROWSERWIDGET_HPP
 
-#include "qtpropertybrowser/qttreepropertybrowser.h"
-#include "qtpropertybrowser/qtvariantproperty.h"
-#include "qtpropertybrowser/qtpropertymanager.h"
+//for QT_VERSION
+#include <QObject>
+
+#include <qttreepropertybrowser.h>
+#include <qtvariantproperty.h>
+#include <qtpropertymanager.h>
 
 #include <QWidget>
 #include <QHash>

src/QVizkitMainWindow.hpp

@@ -8,7 +8,11 @@
 
 
 #include <QMainWindow>
+#if QT_VERSION < 0x050000
 #include <QtDesigner/QDesignerExportWidget>
+#else
+#include <QtUiPlugin/QDesignerExportWidget>
+#endif
 
 namespace vizkit3d {
 

src/QVizkitMainWindowLoader.cpp

@@ -74,4 +74,6 @@ QString QVizkitMainWindowLoader::whatsThis() const
     return "";
 }
 
+#if QT_VERSION < 0x050000
 Q_EXPORT_PLUGIN2(QVizkitMainWindowLoader, QVizkitMainWindowLoader)
+#endif