diff options
Diffstat (limited to 'src/datavisualization/doc')
7 files changed, 107 insertions, 77 deletions
diff --git a/src/datavisualization/doc/qtdatavisualization.qdocconf b/src/datavisualization/doc/qtdatavisualization.qdocconf index 81922313..8bf5a012 100644 --- a/src/datavisualization/doc/qtdatavisualization.qdocconf +++ b/src/datavisualization/doc/qtdatavisualization.qdocconf @@ -1,10 +1,14 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/global/macros.qdocconf) +include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) +include($QT_INSTALL_DOCS/global/compat.qdocconf) +include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) +include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) project = QtDataVisualization description = Qt Data Visualization Reference Documentation version = 1.0.0 -exampledirs += ../../../examples \ +exampledirs += ../../../examples/datavisualization \ snippets headerdirs += .. @@ -12,9 +16,11 @@ imagedirs += ../images \ images sourcedirs += .. -depends += qtcore qtgui qtdeclarative - -indexes += $QTDIR/doc/html/qt.index +indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \ + $QT_INSTALL_DOCS/qtgui/qtgui.index \ + $QT_INSTALL_DOCS/qtqml/qtqml.index \ + $QT_INSTALL_DOCS/qtquick/qtquick.index \ + $QT_INSTALL_DOCS/qtmultimedia/qtmultimedia.index qhp.projects = qtdatavisualization @@ -45,23 +51,6 @@ qhp.qtdatavisualization.subprojects.types.indexTitle = Qt Data Visual qhp.qtdatavisualization.subprojects.types.selectors = fake:qmlclass qhp.qtdatavisualization.subprojects.types.sortPages = true -HTML.footer = \ - "<div class=\"footer\">\n" \ - " <p>\n" \ - " <acronym title=\"Copyright\">©</acronym> 2014 Digia. Qt and Qt logos are\n" \ - " trademarks of of Digia Corporation in Finland and/or other countries worldwide.\n" \ - " </p>\n" \ - " All other trademarks are property of their respective owners.\n" \ - " <br />\n" \ - " <p>\n" \ - " Licensees holding valid Qt Enterprise licenses may use this document in accordance\n" \ - " with the Qt Enterprise License Agreement provided with the Software or,\n" \ - " alternatively, in accordance with the terms contained in a written agreement\n" \ - " between you and Digia.\n" \ - " </p>\n" \ - "</div>\n" - -navigation.homepage = Qt Enterprise: navigation.landingpage = Qt Data Visualization navigation.cppclassespage = Qt Data Visualization C++ Classes navigation.qmltypespage = Qt Data Visualization QML Types diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp index 458eeb45..6c6e49aa 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp @@ -72,7 +72,7 @@ QItemModelScatterDataProxy *proxy = new QItemModelScatterDataProxy(customModel, QItemModelSurfaceDataProxy *proxy = new QItemModelSurfaceDataProxy(customModel, QStringLiteral("longitude"), // Row role QStringLiteral("latitude"), // Column role - QStringLiteral("height")); // value role + QStringLiteral("height")); // Y-position role //! [5] //! [6] diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index df503eb4..5b251768 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -28,12 +28,6 @@ Note that this type is uncreatable, but contains properties that are shared between the 3D visualizations. - \note QML doesn't support the type of anti-aliasing used by Qt Data Visualization graphs - by default. Setting the \c antialiasing property doesn't affect graphs. To enable - anti-aliasing for graphs, a custom surface format must be set up for the QQuickView - before showing it. You can use the convenience function - \c{QtDataVisualization::qDefaultSurfaceFormat()} to create the custom surface format object. - For AbstractGraph3D enums, see \l QAbstract3DGraph::SelectionFlag and \l QAbstract3DGraph::ShadowQuality @@ -66,24 +60,62 @@ */ /*! - \qmlproperty bool AbstractGraph3D::clearWindowBeforeRendering - - Indicates if the graph should also clear the whole window before rendering the graph, - including the areas outside the graph. - Since the graphs are drawn first under other QML items, the regular QML window clearing - before rendering is suppressed when there are any graphs in the window; the graphs - handle the clearing themselves instead. - If you have any other items besides graphs that do similar - custom drawing under other QML items, you need to set this property to false on all graphs - drawn to same window with the other custom items, or it is likely that the - other custom items do not render properly. - Defaults to true. - - \note This property should be set to the same value for all graphs in the same window. - Otherwise some graphs may not show. - - \note If window clearing before rendering is suppressed, any areas of the window not fully - covered with opaque items may not draw properly. + \qmlproperty AbstractGraph3D.RenderingMode AbstractGraph3D::renderingMode + + Defaults to \c{RenderIndirect}. + + \table + \header + \li Render Mode + \li Description + \row + \li RenderDirectToBackground + \li Indicates the graph will be rendered directly on the window background. + This mode also clears the whole window before rendering the graph, including the areas + outside the graph. + Since the graphs in this rendering mode are drawn on the window background under other QML + items, the regular QML window clearing before rendering is suppressed. The graphs handle the clearing + themselves instead. + If the surface format of the window supports antialiasing, it will be used (see + \c {QtDataVisualization::qDefaultSurfaceFormat()}). + This rendering mode offers the best performance at the expense of non-standard QML behavior. For example, + the graphs do not obey the Z ordering of QML items and the opacity value has no effect on them. + \row + \li RenderDirectToBackground_NoClear + \li Similar to RenderDirectToBackground mode, except that the graph will not clear the whole + window before rendering the graph. This mode is better for windows where you have other custom items + besides the graphs that also draw on the window background. In that case you need to either take care + of the window clearing yourself or ensure that all areas of the window are fully covered with opaque + items. + If one graph in the window uses either of the direct rendering modes, then all other graphs in the + same window also drawn in direct modes should use the exact same direct rendering mode. + Otherwise some graphs may not show up, depending on the drawing order of the graphs. + \row + \li RenderIndirect + \li Indicates the graph will be first rendered to an offscreen surface that + is then drawn during normal QML item rendering. The rendered image is + antialiased using multisampling method if it is supported in the current environment and the + msaaSamples property value is greater than zero. + This rendering mode offers good quality and normal QML item behavior at the expense of performance. + \endtable + + \note Antialiasing is not supported in OpenGL ES2 environments in any rendering mode. + + \note Setting the \c antialiasing property of the graphs doesn't do anything. However, it is + set by the graph itself if the current rendering mode uses antialiasing. + + \sa msaaSamples + */ + +/*! + \qmlproperty int AbstractGraph3D::msaaSamples + The number of samples used in multisample antialiasing when renderingMode is \c RenderIndirect. + When renderingMode is \c RenderDirectToBackground or \c RenderDirectToBackground_NoClear, this + property value is read-only and returns the number of samples specified by the window surface + format. + Defaults to 4. + + \sa renderingMode */ /*! diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc index aaafe217..6ee51742 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -36,11 +36,6 @@ * * See \l{Qt Quick 2 Bars Example} for more thorough usage example. * - * \note Qt Data Visualization graphs are rendered behind any other QML elements on screen, including - * the parent elements of the graph. To make the whole graph show, ensure that no other element - * draws anything over the area the graph occupies. For example, having a non-transparent \c Rectangle - * item as the parent of a graph causes the graph to be hidden. - * * \sa Bar3DSeries, ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ @@ -93,6 +88,12 @@ */ /*! + * \qmlproperty Bar3DSeries Bars3D::selectedSeries + * The selected series or \c null. If \l {QAbstract3DGraph::selectionMode}{selectionMode} has + * \c SelectionMultiSeries flag set, this property holds the series which owns the selected bar. + */ + +/*! * \qmlproperty list<Bar3DSeries> Bars3D::seriesList * \default * This property holds the series of the graph. diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc index b969c536..4ea7888c 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -36,11 +36,6 @@ See \l{Qt Quick 2 Scatter Example} for more thorough usage example. - \note Qt Data Visualization graphs are rendered behind any other QML elements on screen, including - the parent elements of the graph. To make the whole graph show, ensure that no other element - draws anything over the area the graph occupies. For example, having a non-transparent \c Rectangle - item as the parent of a graph causes the graph to be hidden. - \sa Scatter3DSeries, ScatterDataProxy, Bars3D, Surface3D, {Qt Data Visualization C++ Classes} */ @@ -72,7 +67,12 @@ */ /*! - * \qmlproperty list<QScatter3DSeries> Scatter3D::seriesList + * \qmlproperty Scatter3DSeries Scatter3D::selectedSeries + * The selected series or \c null. + */ + +/*! + * \qmlproperty list<Scatter3DSeries> Scatter3D::seriesList * \default * This property holds the series of the graph. * By default, this property contains an empty list. @@ -80,13 +80,13 @@ */ /*! - * \qmlmethod void Scatter3D::addSeries(QScatter3DSeries *series) + * \qmlmethod void Scatter3D::addSeries(Scatter3DSeries series) * Adds the \a series to the graph. A graph can contain multiple series, but has only one set of * axes. If the newly added series has specified a selected item, it will be highlighted and * any existing selection will be cleared. Only one added series can have an active selection. */ /*! - * \qmlmethod void Scatter3D::removeSeries(QScatter3DSeries *series) + * \qmlmethod void Scatter3D::removeSeries(Scatter3DSeries series) * Remove the \a series from the graph. */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc index 3011336b..23a9a004 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -36,11 +36,6 @@ See \l{Qt Quick 2 Surface Example} for more thorough usage example. - \note Qt Data Visualization graphs are rendered behind any other QML elements on screen, including - the parent elements of the graph. To make the whole graph show, ensure that no other element - draws anything over the area the graph occupies. For example, having a non-transparent \c Rectangle - item as the parent of a graph causes the graph to be hidden. - \sa Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes} */ @@ -72,27 +67,30 @@ */ /*! + * \qmlproperty Surface3DSeries Surface3D::selectedSeries + * The selected series or \c null. If \l {QAbstract3DGraph::selectionMode}{selectionMode} has + * \c SelectionMultiSeries flag set, this property holds the series which owns the selected point. + */ + /*! \qmlproperty ColorGradient Surface3D::gradient The current surface gradient. Setting this property replaces the previous gradient. */ /*! - * \qmlproperty list<QSurface3DSeries> Surface3D::seriesList + * \qmlproperty list<Surface3DSeries> Surface3D::seriesList * \default * This property holds the series of the graph. * By default, this property contains an empty list. * To set the series, either use the addSeries() function or define them as children of the graph. - * \note The surface graph currently supports only a single series at a time. */ /*! - * \qmlmethod void Surface3D::addSeries(QSurface3DSeries *series) + * \qmlmethod void Surface3D::addSeries(Surface3DSeries series) * Adds the \a series to the graph. - * \note The surface graph currently supports only a single series at a time. */ /*! - * \qmlmethod void Surface3D::removeSeries(QSurface3DSeries *series) + * \qmlmethod void Surface3D::removeSeries(Surface3DSeries series) * Remove the \a series from the graph. */ diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index c85b9dbb..e68a1086 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -301,24 +301,34 @@ * \fn QSurfaceFormat QtDataVisualization::qDefaultSurfaceFormat(bool antialias = true) * \relates QAbstract3DGraph * - * Anti-aliasing is turned on by default on C++ and turned off on QML, except in OpenGL ES2 - * environments, where anti-aliasing is not supported by Qt Data Visualization. - * This convenience function can be used to construct a suitable surface format for use by + * This convenience function can be used to create a custom surface format suitable for use by * Qt Data Visualization graphs. - * The \a{antialias} parameter specifies whether or not anti-aliasing is activated. + * + * 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. * - * For example, disable anti-aliasing on C++ application: + * For example, disable antialiasing on C++ application: * * \code + * #include <QtDataVisualization/qutils.h> + * + * // ... + * * Q3DBars *graph = new Q3DBars(QtDataVisualization::qDefaultSurfaceFormat(false)); * \endcode * - * For example, enable anti-aliasing on QML application: + * For example, enable antialiasing for direct rendering modes on QML application: * * \code - * QtQuick2ApplicationViewer viewer; + * #include <QtDataVisualization/qutils.h> + * + * // ... + * + * QQuickView viewer; * viewer.setFormat(QtDataVisualization::qDefaultSurfaceFormat()); * \endcode + * + * \note Antialiasing is not supported in OpenGL ES2 environments. */ |