Qt 3D data visualization framework
Go to file
Mika Salmela edbaf4a432 License info for texturedsurface example
Change-Id: Iac6e8eac0da0264a586477038753c54edcd58e47
Reviewed-by: Mika Salmela <mika.salmela@digia.com>
2014-10-09 15:24:13 +03:00
dist Fix mac -> OS X 2014-10-06 11:42:27 +03:00
examples License info for texturedsurface example 2014-10-09 15:24:13 +03:00
src Added doc about reflections and stencil buffer 2014-10-09 12:32:39 +03:00
tests Fix screen position based queries in threaded rendering environment 2014-10-09 10:09:31 +03:00
tools Arrow blender files backup 2014-07-04 10:55:42 +03:00
.gitattributes Script for generating the release package on windows 2013-10-15 08:13:53 +03:00
.gitignore Axis abstraction 2013-06-25 13:45:48 +03:00
.qmake.conf Avoid the Missing cmake tests error from qmake with Qt 5.4 2014-08-04 08:06:56 +03:00
.tag Update version and readme for TP 2013-10-14 11:04:33 +03:00
README Fix mac -> OS X 2014-10-06 11:42:27 +03:00
qtdatavisualization.pro Fix readme 2014-02-26 13:25:12 +02:00
sync.profile Module renamed 2013-09-10 12:04:24 +03:00

README

---------------------------
Qt Data Visualization 1.1.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 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.1 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/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).
- Surfaces with non-straight rows and columns do not always render properly.
- Q3DLight class (and Light3D QML item) are currently not usable for anything.
- Changing any of Q3DScene properties affecting subviewports currently has no effect.
- Widget based examples layout incorrectly in iOS.
- Reparenting a graph to an item in another QQuickWindow is not supported.
- There is a low-impact binary break between 1.0 and 1.1. The break is due to a QML type
  registration conflict with QAbstractItemModel between QtDataVisualization and
  QtCommercial.Charts. Introducing the binary break makes it possible to use both
  Charts and Data Visualization in the same QML application.