diff options
Diffstat (limited to 'src/datavisualization/doc/src/qtdatavisualization.qdoc')
| -rw-r--r-- | src/datavisualization/doc/src/qtdatavisualization.qdoc | 149 |
1 files changed, 24 insertions, 125 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 37a05d9d..72f2302c 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2017 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Data Visualization module of the Qt Toolkit. @@ -73,119 +73,6 @@ */ /*! - \group qtdatavisualization_getting_started - \title Qt Data Visualization Getting Started - - \section1 Installing the Qt Data Visualization Module - - Use the \c {Package Manager} in \c {Maintenance Tool} or the \c {Online installer} to install - the Qt Data Visualization module. The module can be found under \c {Qt Enterprise Add-Ons} - in the package manager. - - After installation Qt Data Visualization documentation and examples are available in Qt Creator. - Examples can be found on the examples page of Qt Creator by selecting the Qt Data Visualization - component from the drop-down menu. - - The source code is installed into the QtDataVisualization folder under EnterpriseAddOns. - - \section1 Building Qt Data Visualization - - To build the Qt Data Visualization module from source code yourself, set up a command prompt - with an environment for building Qt applications, navigate to the directory containing - \c {qtdatavisualization.pro}, and configure the project with qmake: - \code - qmake - \endcode - - After running qmake, build the project with make: - \table - \header - \li OS \li Make command - \row - \li Linux \li make - \row - \li Windows (MinGw) \li mingw32-make - \row - \li Windows (MSVC) \li nmake - \row - \li OS X \li make - \endtable - - 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: - \code - qmake CONFIG+=debug - make - \endcode - or - \code - qmake CONFIG+=debug_and_release - make debug - \endcode - - For release builds: - \code - qmake CONFIG+=release - make - \endcode - or - \code - qmake CONFIG+=debug_and_release - make release - \endcode - - For both builds (Windows/OS X only): - \code - qmake CONFIG+="debug_and_release build_all" - make - \endcode - - After building, install the module to your Qt directory: - \code - make install - \endcode - - If you want to uninstall the module: - \code - make uninstall - \endcode - - To build a statically linked version of the Qt Data Visualization module, give the following - commands: - - \snippet doc_src_qtdatavisualization.cpp 7 - - \section1 Creating a Simple Application - - To create a simple application, start by creating a new Qt Gui Application project in Qt - Creator and add this line to the \c .pro file of the project: - - \snippet doc_src_qtdatavisualization.pro 0 - - In the \c main.cpp file, include the module headers and declare namespace usage: - - \snippet doc_src_qtdatavisualization.cpp 0 - - Then, add the sample code found in one of the following pages, depending on what kind of - visualization you are interested in: - \l{How to construct a minimal Q3DBars graph}, - \l{How to construct a minimal Q3DScatter graph}, or - \l{How to construct a minimal Q3DSurface graph}. - - To use Qt Data Visualization graphs in widget based applications, you can use - the QWidget::createWindowContainer() function to wrap the graph into a widget: - - \snippet doc_src_qtdatavisualization.cpp 9 - - For further code examples, see one of the Qt Data Visualization examples: - - \annotatedlist qtdatavisualization_examples -*/ - -/*! \page qtdatavisualization_data_handling.html \title Qt Data Visualization Data Handling @@ -294,9 +181,27 @@ \section1 Interacting with Data - You can interact with the rendered graph with either mouse or touch to rotate, zoom, or select - data. For the default mouse controls, see Q3DInputHandler documentation, and for the default - touch controls, see QTouch3DInputHandler documentation. + End users can interact with the rendered graph by using either the mouse or + touch to rotate, zoom, or select data. Graphs can be rotated freely by + holding down the right mouse button and moving the mouse. Zooming is done by + rolling the mouse wheel. Selecting, if enabled, is done by pressing the left + mouse button. The scene can be reset to the default camera view by clicking + the mouse wheel. In touch devices, rotation is done by tap-and-move, + selection by tap-and-hold, and zoom by pinch. + + Qt Data Visualization has default handlers for mouse actions and touch + gestures. For the default mouse controls, see Q3DInputHandler, and for + the default touch controls, see QTouch3DInputHandler. The default handlers + must be disabled when using customized input handlers. + + The \l{Custom Input Example} illustrates how to use a custom input handler + to select items upon mouseover instead of mouse click. The information + below the mouse cursor is displayed as a popup. + + In addition to perspective projection, orthographic projection can be used + to create 2D graphs by replacing the default input handler with one that + does not allow rotating the graph and setting the camera to view the graph + directly from the side or from the top. \section1 Data Selection Modes @@ -324,10 +229,6 @@ \list \li Some platforms like Android and WinRT cannot handle multiple native windows properly, so only the Qt Quick 2 graphs are available in practice for those platforms. - \li Shadows are not supported with OpenGL ES2 (including Angle builds in Windows). - \li Anti-aliasing doesn't work with OpenGL ES2 (including Angle builds in Windows). - \li QCustom3DVolume items are not supported with OpenGL ES2 (including Angle builds in - Windows). \li Surfaces with non-straight rows and columns do not always render properly. \li Q3DLight class (and Light3D QML item) are currently not usable for anything. \li Changing most of Q3DScene properties affecting subviewports currently has no effect. @@ -337,13 +238,11 @@ "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. - \li Only OpenGL ES2 emulation is available for software renderer (that is, when using - QCoreApplication::setAttribute(Qt::AA_UseSoftwareOpenGL)) \endlist */ /*! - * \fn QSurfaceFormat QtDataVisualization::qDefaultSurfaceFormat(bool antialias = true) + * \fn QSurfaceFormat QtDataVisualization::qDefaultSurfaceFormat(bool antialias) * \relates QAbstract3DGraph * * This convenience function can be used to create a custom surface format suitable for use by @@ -352,7 +251,7 @@ * The \a antialias parameter specifies whether or not antialiasing is activated. * * Give the surface format returned by this function to the graph constructor (C++) or set - * it as the window format for QQuickView (QML) before calling show on it. + * it as the window format for QQuickView (QML) before calling \c show() on it. * * For example, disable antialiasing on C++ application: * |