Qt 3D data visualization framework
Go to file
Tomi Korpipaa 28d3ed4edf Fix compilation of a manual test
Pick-to: 6.5
Change-Id: I563a604cb80ab2a605bec60064e5b5bd4d8b1271
Reviewed-by: Kwanghyo Park <kwanghyo.park@qt.io>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
2023-03-29 15:14:02 +03:00
LICENSES Add license headers to cmake files 2022-08-03 13:23:45 +02:00
coin Add Axivion config 2023-03-23 07:27:05 +00:00
dist Add changes file for Qt 5.15.1 2020-08-25 07:32:49 +00:00
examples Brush up the qmlsurfacegallery example 2023-03-16 08:15:20 +01:00
src Fix 2 documentation bugs 2023-03-03 06:17:02 +00:00
tests Fix compilation of a manual test 2023-03-29 15:14:02 +03:00
tools/blender Remove obsolete tool scripts and fix sync.profile to make coin pass 2016-01-12 15:38:19 +00:00
.cmake.conf Remove QT_USE_SYNCQT_CPP 2023-01-02 18:32:58 +01:00
.gitattributes Fix issues with COIN builds 2015-10-22 10:08:51 +00:00
.gitignore Update .gitignore to ignore qmlc files and build folders 2016-11-17 09:48:33 +00:00
.tag Update version and readme for TP 2013-10-14 11:04:33 +03:00
CMakeLists.txt Change the license of all CMakeLists.txt and *.cmake files to BSD 2022-08-23 15:45:50 +02:00
README Updated README and changes file 2016-11-23 09:37:28 +00:00
conanfile.py Use SPDX license identifiers 2022-06-13 15:58:51 +02:00
dependencies.yaml Update dependencies on 'dev' in qt/qtdatavis3d 2023-03-28 20:07:14 +00:00
sync.profile Modernize and update to latest CMake API 2021-06-11 10:24:41 +02:00

README

---------------------------
Qt Data Visualization 5.9.0
---------------------------

Qt Data Visualization module provides multiple graph types to visualize data in 3D space
both with C++ and Qt Quick 2.

System Requirements
===================

- Qt 5.2.1 or newer
- OpenGL 2.1 or newer (recommended) or OpenGL ES2 (reduced feature set)
- Manipulating Qt Data Visualization graphs with QML Designer requires
  Qt Creator 3.3 or newer

Building
========
Configure the project with qmake:
    qmake

After running qmake, build the project with make:
    (Linux) make
    (Windows with MinGw) mingw32-make
    (Windows with Visual Studio) nmake
    (OS X) make

The above generates the default makefiles for your configuration, which is typically
the release build if you are using precompiled binary Qt distribution. To build both
debug and release, or one specifically, use one of the following qmake lines instead.

For debug builds:
    qmake CONFIG+=debug
    make
  or
    qmake CONFIG+=debug_and_release
    make debug

For release builds:
    qmake CONFIG+=release
    make
  or
    qmake CONFIG+=debug_and_release
    make release

For both builds (Windows/OS X only):
    qmake CONFIG+="debug_and_release build_all"
    make

After building, install the module to your Qt directory:
    make install

If you want to uninstall the module:
    make uninstall

Building as a statically linked library
=======================================

The same as above applies, you will just have to add static to the CONFIG:
    qmake CONFIG+=static

Documentation
=============

The documentation can be generated with:
    make docs

The documentation is generated into the doc folder under the build folder.
Both Qt Assistant (qtdatavisualization.qch) and in HTML format
(qtdatavisualization subfolder) documentation is generated.

Please refer to the generated documentation for more information:
    doc/qtdatavisualization/qtdatavisualization-index.html

Known Issues
============

- Some platforms like Android and WinRT cannot handle multiple native windows properly,
  so only the Qt Quick 2 versions of graphs are available in practice for those platforms.
- Shadows are not supported with OpenGL ES2 (including Angle builds in Windows).
- Anti-aliasing doesn't work with OpenGL ES2 (including Angle builds in Windows).
- QCustom3DVolume items are not supported with OpenGL ES2 (including Angle builds in Windows).
- Surfaces with non-straight rows and columns do not always render properly.
- Widget based examples layout incorrectly in iOS.
- Reparenting a graph to an item in another QQuickWindow is not supported.
- Android builds of QML applications importing QtDataVisualization also require
  "QT += datavisualization" in the pro file. This is because Qt Data Visualization QML plugin has
  a dependency to Qt Data Visualization C++ library, which Qt Creator doesn't automatically add
  to the deployment package.
- Only OpenGL ES2 emulation is available for software renderer (that is, when using
  QCoreApplication::setAttribute(Qt::AA_UseSoftwareOpenGL))