Qt 3D data visualization framework
Go to file
Lucie Gérard 2d3e4b6fb8 Add REUSE.toml files and missing licenses
REUSE.toml files are read by reuse to complement or override the
copyright and licensing information found in file.

The use of REUSE.toml files was introduced in REUSE version 3.1.0a1.
This reuse version is compatible with reuse specification
version 3.2 [1].
With this commit's files,
* The SPDX document generated by reuse spdx conforms to SPDX 2.3,
* The reuse lint command reports that the Qt project is reuse compliant.

[1]: https://reuse.software/spec-3.2/

Task-number: QTBUG-124453
Task-number: QTBUG-125211
Pick-to: 6.8
Change-Id: I32099a8829af3f80f40d8a583f6d9b5aa5e0532a
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2024-10-28 10:40:50 +02:00
LICENSES Add license headers to cmake files 2022-08-03 13:23:45 +02:00
coin CI: Disable build and test on configs with '-no-opengl' configure arg 2024-06-19 16:49:29 +03:00
dist Add REUSE.toml files and missing licenses 2024-10-28 10:40:50 +02:00
examples Correct license for snippets and examples files 2024-03-15 11:19:32 +01:00
src Fix compilation with -qreal float 2024-09-09 15:06:11 +08:00
tests Skip offscreen target and no-GLX configuration 2024-08-05 11:32:54 +00: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 Bump version to 6.9.0 2024-06-07 00:49:41 +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 Add the use of the qt_internal_project_setup function 2023-05-10 18:51:16 +02:00
README Updated README and changes file 2016-11-23 09:37:28 +00:00
REUSE.toml Add REUSE.toml files and missing licenses 2024-10-28 10:40:50 +02:00
dependencies.yaml Update dependencies on 'dev' in qt/qtdatavis3d 2024-10-23 10:10:19 +00:00
licenseRule.json Fix real dot in location keys regular expression 2024-04-24 08:33:03 +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))