From e1d3fe529ddce015f62cc7ca22c29e8950c9cd39 Mon Sep 17 00:00:00 2001 From: Miikka Heikkinen Date: Tue, 14 Jan 2014 12:03:24 +0200 Subject: Documentation additions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTRD-2735 Change-Id: I4b28ac2876ad025c262f861e7620aa4d6de6ff60 Reviewed-by: Tomi Korpipää --- src/datavisualization/data/qabstract3dseries.cpp | 17 ++++++++++++++ src/datavisualization/data/qbar3dseries.cpp | 2 ++ src/datavisualization/data/qscatter3dseries.cpp | 2 ++ src/datavisualization/data/qscatterdataitem.cpp | 10 +++++++++ src/datavisualization/data/qsurface3dseries.cpp | 2 ++ ...tdatavisualization-qml-abstractdeclarative.qdoc | 6 +++++ .../doc/src/qtdatavisualization.qdoc | 26 ++++++++++++++++++++++ src/datavisualization/engine/qabstract3dgraph.cpp | 6 +++++ 8 files changed, 71 insertions(+) (limited to 'src') diff --git a/src/datavisualization/data/qabstract3dseries.cpp b/src/datavisualization/data/qabstract3dseries.cpp index 1aa4a46d..1afb63c4 100644 --- a/src/datavisualization/data/qabstract3dseries.cpp +++ b/src/datavisualization/data/qabstract3dseries.cpp @@ -158,6 +158,15 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \sa colorStyle */ +/*! + * \qmlproperty string Abstract3DSeries::name + * + * Sets the series name. + * Series name can be used in item label format with tag \c{@seriesName}. + * + * \sa itemLabelFormat + */ + /*! * \enum QAbstract3DSeries::SeriesType * @@ -488,6 +497,14 @@ QLinearGradient QAbstract3DSeries::multiHighlightGradient() const return d_ptr->m_multiHighlightGradient; } +/*! + * \property QAbstract3DSeries::name + * + * Sets the series name. + * Series name can be used in item label format with tag \c{@seriesName}. + * + * \sa itemLabelFormat + */ void QAbstract3DSeries::setName(const QString &name) { if (d_ptr->m_name != name) { diff --git a/src/datavisualization/data/qbar3dseries.cpp b/src/datavisualization/data/qbar3dseries.cpp index fea0b359..cdf9333a 100644 --- a/src/datavisualization/data/qbar3dseries.cpp +++ b/src/datavisualization/data/qbar3dseries.cpp @@ -53,6 +53,8 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \li @valueLabel \li Item value formatted using the same format the value axis attached to the graph uses, * see \l{QValue3DAxis::setLabelFormat()} for more information. * \row + * \li @seriesName \li Name of the series + * \row * \li % \li Item value in specified format. * \endtable * diff --git a/src/datavisualization/data/qscatter3dseries.cpp b/src/datavisualization/data/qscatter3dseries.cpp index 5aa17ed3..10b2f84b 100644 --- a/src/datavisualization/data/qscatter3dseries.cpp +++ b/src/datavisualization/data/qscatter3dseries.cpp @@ -50,6 +50,8 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \row * \li @zLabel \li Item value formatted using the same format the Z axis attached to the graph uses, * see \l{QValue3DAxis::setLabelFormat()} for more information. + * \row + * \li @seriesName \li Name of the series * \endtable * * For example: diff --git a/src/datavisualization/data/qscatterdataitem.cpp b/src/datavisualization/data/qscatterdataitem.cpp index 2c0c0d5a..18c67ee8 100644 --- a/src/datavisualization/data/qscatterdataitem.cpp +++ b/src/datavisualization/data/qscatterdataitem.cpp @@ -91,6 +91,16 @@ QScatterDataItem &QScatterDataItem::operator=(const QScatterDataItem &other) * \return position of this data item. */ +/*! + * \fn void QScatterDataItem::setRotation(const QQuaternion &rotation) + * Sets \a rotation to this data item. + */ + +/*! + * \fn QQuaternion QScatterDataItem::rotation() const + * \return rotation of this data item. + */ + /*! * \fn void QScatterDataItem::setX(float value) * Sets the X component of the item position to the \a value. diff --git a/src/datavisualization/data/qsurface3dseries.cpp b/src/datavisualization/data/qsurface3dseries.cpp index 25405959..74b0ca90 100644 --- a/src/datavisualization/data/qsurface3dseries.cpp +++ b/src/datavisualization/data/qsurface3dseries.cpp @@ -53,6 +53,8 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \row * \li @zLabel \li Item value formatted using the same format as the Z axis attached to the graph uses, * see \l{QValue3DAxis::setLabelFormat()} for more information. + * \row + * \li @seriesName \li Name of the series * \endtable * * For example: diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 5ac6a03f..71be09a2 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -28,6 +28,12 @@ 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. + \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 9c951877..d29de4f7 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -286,3 +286,29 @@ When multiple series are added to a graph, selecting an item in one of them will clear the selection on other series. */ + +/*! + * \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 + * Qt Data Visualization graphs. + * The \a{antialias} parameter specifies whether or not anti-aliasing 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: + * + * \code + * Q3DBars *graph = new Q3DBars(QtDataVisualization::qDefaultSurfaceFormat(false)); + * \endcode + * + * For example, enable anti-aliasing on QML application: + * + * \code + * QtQuick2ApplicationViewer viewer; + * viewer.setFormat(QtDataVisualization::qDefaultSurfaceFormat()); + * \endcode + */ diff --git a/src/datavisualization/engine/qabstract3dgraph.cpp b/src/datavisualization/engine/qabstract3dgraph.cpp index 01974e54..c7063438 100644 --- a/src/datavisualization/engine/qabstract3dgraph.cpp +++ b/src/datavisualization/engine/qabstract3dgraph.cpp @@ -41,6 +41,12 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * You should not need to use this class directly, but one of its subclasses instead. * + * Anti-aliasing is turned on by default on C++, except in OpenGL ES2 + * environments, where anti-aliasing is not supported by Qt Data Visualization. + * To specify non-default anti-aliasing for a graph, give a custom surface format as + * a constructor parameter. You can use the convenience function \c{QtDataVisualization::qDefaultSurfaceFormat()} + * to create the surface format object. + * * \note QAbstract3DGraph sets window flag \c{Qt::FramelessWindowHint} on by default. If you want to display * graph windows as standalone windows with regular window frame, clear this flag after constructing * the graph. For example: -- cgit v1.2.3