diff options
author | Keränen Pasi <pasi.keranen@digia.com> | 2013-09-24 11:43:16 +0300 |
---|---|---|
committer | Pasi Keränen <pasi.keranen@digia.com> | 2013-09-25 13:56:56 +0300 |
commit | 0b191307ac22b14175f846e06e3356ca00099c52 (patch) | |
tree | a972244ed315b185226a57ff69903eb2c6d9a85c /src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc | |
parent | acd398f38f228960367bcccd3f2c99aca753248f (diff) |
Added abstract baseclass for declarative components.
Change-Id: Icdeb487388bb9c36cfbb6d7077de052434ec3fe3
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc')
-rw-r--r-- | src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc new file mode 100644 index 00000000..069fa9e9 --- /dev/null +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -0,0 +1,87 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtDataVisualization module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + \qmltype Surface3D + \inherits AbstractDeclarative + \inmodule QtDataVisualization + + This type enables developers to render surface plots in 3D with Qt Quick 2. + + You will need to import data visualization module to use this type: + + \snippet doc_src_qmldatavisualization.cpp 0 + + After that you can use Surface3D in your qml files: + + \snippet doc_src_qmldatavisualization.cpp 3 + + See \l{Qt Quick 2 Surface Example} for more thorough usage example. + + \sa ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes} + */ + +/*! + \qmlproperty SurfaceDataProxy Surface3D::dataProxy + The active data proxy. + + If a proxy is not given, a temporary default proxy is created and activated. + This temporary proxy is destroyed if another proxy is explicitly set active via this property. + */ + +/*! + \qmlproperty ValueAxis3D Surface3D::axisX + A user-defined X axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty ValueAxis3D Surface3D::axisY + A user-defined Y axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty ValueAxis3D Surface3D::axisZ + A user-defined Z axis. + + If an axis is not given, a temporary default axis with no labels and automatically adjusting + range is created. + This temporary axis is destroyed if another axis is explicitly set to same orientation. + */ + +/*! + \qmlproperty bool Surface3D::smoothSurfaceEnabled + Smoothing of surface. If false, shading of the surface is flat. + */ + +/*! + \qmlproperty bool Surface3D::surfaceGridEnabled + Surface grid visibility. If false, no surface grid is drawn. + */ + +/*! + \qmlproperty var Surface3D::gradient + The current surface gradient. Setting this property replaces the previous gradient. + */ |