From 9549c09d4cfee485c31f54360a32d100d06a2095 Mon Sep 17 00:00:00 2001
From: Miikka Heikkinen <miikka.heikkinen@digia.com>
Date: Mon, 2 Dec 2013 12:59:46 +0200
Subject: Move series specific visual elements to series, part 2
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Surface series grid visibility and smoothness

Task-number: QTRD-2557
Change-Id: I0beecb7785bf2fb489d0faba797a145151513a79
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
---
 src/datavisualization/data/qabstract3dseries.cpp | 87 ++++++++++++++++--------
 1 file changed, 57 insertions(+), 30 deletions(-)

(limited to 'src/datavisualization/data/qabstract3dseries.cpp')

diff --git a/src/datavisualization/data/qabstract3dseries.cpp b/src/datavisualization/data/qabstract3dseries.cpp
index d5c4c6b8..93ce7fb0 100644
--- a/src/datavisualization/data/qabstract3dseries.cpp
+++ b/src/datavisualization/data/qabstract3dseries.cpp
@@ -63,6 +63,33 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * Sets the visibility of the series. If false, the series is not rendered.
  */
 
+/*!
+ * \qmlproperty Abstract3DSeries.Mesh Abstract3DSeries::mesh
+ *
+ * Sets the mesh of the items in the series, or the selection pointer in case of
+ * Surface3DSeries. If the \a mesh is \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined},
+ * then the userDefinedMesh property must also be set for items to render properly.
+ * The default value depends on the graph type.
+ */
+
+/*!
+ * \qmlproperty bool Abstract3DSeries::meshSmooth
+ *
+ * If \a enable is \c true, smooth versions of predefined meshes set via mesh property are used.
+ * This property doesn't affect custom meshes used when mesh is
+ * \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined}.
+ * Defaults to \c false.
+ */
+
+/*!
+ * \qmlproperty string Abstract3DSeries::userDefinedMesh
+ *
+ * Sets the \a fileName for user defined custom mesh for objects that is used when mesh
+ * is \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined}.
+ * \note The file specified by \a fileName needs to be in Wavefront obj format and include
+ * vertices, normals and UVs. It also needs to be in triangles.
+ */
+
 /*!
  * \enum QAbstract3DSeries::SeriesType
  *
@@ -79,34 +106,34 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  */
 
 /*!
-    \enum QAbstract3DSeries::Mesh
-
-    Predefined mesh types. All styles are not usable with all visualization types.
-
-    \value MeshUserDefined
-           User defined mesh, set via QAbstract3DSeries::userDefinedMesh property.
-    \value MeshBar
-           Basic rectangular bar.
-    \value MeshCube
-           Basic cube.
-    \value MeshPyramid
-           Four-sided pyramid.
-    \value MeshCone
-           Basic cone.
-    \value MeshCylinder
-           Basic cylinder.
-    \value MeshBevelBar
-           Slightly beveled (rounded) rectangular bar.
-    \value MeshBevelCube
-           Slightly beveled (rounded) cube.
-    \value MeshSphere
-           Sphere.
-    \value MeshMinimal
-           The minimal 3D mesh: a triangular pyramid. Usable only with Q3DScatter.
-    \value MeshPoint
-           2D point. Usable only with Q3DScatter.
-           \b Note: Shadows and color gradients do not affect this style.
-*/
+ *  \enum QAbstract3DSeries::Mesh
+ *
+ *  Predefined mesh types. All styles are not usable with all visualization types.
+ *
+ *  \value MeshUserDefined
+ *         User defined mesh, set via QAbstract3DSeries::userDefinedMesh property.
+ *  \value MeshBar
+ *         Basic rectangular bar.
+ *  \value MeshCube
+ *         Basic cube.
+ *  \value MeshPyramid
+ *         Four-sided pyramid.
+ *  \value MeshCone
+ *         Basic cone.
+ *  \value MeshCylinder
+ *         Basic cylinder.
+ *  \value MeshBevelBar
+ *         Slightly beveled (rounded) rectangular bar.
+ *  \value MeshBevelCube
+ *         Slightly beveled (rounded) cube.
+ *  \value MeshSphere
+ *         Sphere.
+ *  \value MeshMinimal
+ *         The minimal 3D mesh: a triangular pyramid. Usable only with Q3DScatter.
+ *  \value MeshPoint
+ *         2D point. Usable only with Q3DScatter.
+ *         \b Note: Shadows and color gradients do not affect this style.
+ */
 
 /*!
  * \internal
@@ -201,9 +228,9 @@ QAbstract3DSeries::Mesh QAbstract3DSeries::mesh() const
 /*!
  * \property QAbstract3DSeries::meshSmooth
  *
- * If \a enable is true, smooth versions of predefined meshes set via mesh property are used.
+ * If \a enable is \c true, smooth versions of predefined meshes set via mesh property are used.
  * This property doesn't affect custom meshes used when mesh is MeshUserDefined.
- * Defaults to false.
+ * Defaults to \c false.
  */
 void QAbstract3DSeries::setMeshSmooth(bool enable)
 {
-- 
cgit v1.2.3