summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
blob: d1422b1086150aac28739f08ffa7f2832057829a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/****************************************************************************
**
** 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 AbstractGraph3D
  \inqmlmodule QtDataVisualization
  \since QtDataVisualization 1.0
  \ingroup datavisualization_qml
  \brief Describes the usage of the 3D surface graph.

  This type enables developers to render surface plots in 3D with Qt Quick 2.

  You will need to import the 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 Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes}
 */

/*!
  \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 the 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 the 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 the same orientation.
 */

/*!
  \qmlproperty bool Surface3D::smoothSurfaceEnabled
  The smoothing of surface. If false, the shading of the surface is flat.
 */

/*!
 * \qmlproperty bool Surface3D::surfaceVisible
 * The surface visibility. If false, no surface is drawn. If surface grid is enabled, it is still
 * drawn.
 */

/*!
  \qmlproperty bool Surface3D::surfaceGridEnabled
  The surface grid visibility. If false, no surface grid is drawn.
 */

/*!
  \qmlproperty ColorGradient Surface3D::gradient
  The current surface gradient. Setting this property replaces the previous gradient.
 */

/*!
  \qmlproperty point Surface3D::selectedPoint

  Selects a surface grid point in a \a position. The position is the (row, column) position in
  the data array of the series.
  Only one point can be selected at a time.
  To clear selection, specify an illegal \a position, e.g. (-1, -1).
 */

/*!
 * \qmlproperty list<QSurface3DSeries> seriesList
 * 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 addSeries(QSurface3DSeries *series)
 * Add the \a series to the graph.
 */

/*!
 * \qmlmethod void removeSeries(QSurface3DSeries *series)
 * Remove the \a series from the graph.
 */