summaryrefslogtreecommitdiffstats
path: root/examples/datavisualization/customitems/doc
diff options
context:
space:
mode:
authorTomi Korpipää <tomi.korpipaa@digia.com>2014-04-22 13:19:49 +0300
committerMika Salmela <mika.salmela@digia.com>2014-04-22 13:24:16 +0300
commita11dcce773b9ad2a913a32efe0c51b1221694659 (patch)
tree5cec5b3957af99cf7d4d65540c08827487edd604 /examples/datavisualization/customitems/doc
parentbf8ed99fb5a474aa6a56d61c9e3a1b5e44d6b6cf (diff)
Custom Item Example added
Task-number: QTRD-3043 + surface selection bug fix - snapshot to be added Change-Id: I17276e39c304cbf1a58eaa2334eff2268656dbf4 Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'examples/datavisualization/customitems/doc')
-rw-r--r--examples/datavisualization/customitems/doc/src/customitems.qdoc68
1 files changed, 68 insertions, 0 deletions
diff --git a/examples/datavisualization/customitems/doc/src/customitems.qdoc b/examples/datavisualization/customitems/doc/src/customitems.qdoc
new file mode 100644
index 00000000..1878609b
--- /dev/null
+++ b/examples/datavisualization/customitems/doc/src/customitems.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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
+**
+****************************************************************************/
+
+/*!
+ \example customitems
+ \title Custom Items Example
+ \ingroup qtdatavisualization_examples
+ \brief Adding custom items to a surface graph.
+
+ The custom items example shows how to add your own custom meshes as items to a graph, and how
+ to remove them.
+
+ \image customitems-example.png
+
+ \section1 Adding custom meshes to the application
+
+ We'll add the meshes in a resource file:
+
+ \code
+ <RCC>
+ ...
+ <qresource prefix="/items">
+ <file>refinery.obj</file>
+ <file>oilrig.obj</file>
+ </qresource>
+ </RCC>
+ \endcode
+
+ \section1 Adding custom item to a graph
+
+ In this example we do not have specific textures for our meshes, so we'll just create a small
+ QImage and fill it with a single color:
+
+ \snippet customitems/customitemgraph.cpp 0
+
+ Then we'll specify the position for the item in a variable. This way we'll be able to use it
+ later for removing the correct item:
+
+ \snippet customitems/customitemgraph.cpp 1
+
+ And finally we'll just add the item to the wanted position with the scale and rotation we want:
+
+ \snippet customitems/customitemgraph.cpp 2
+
+ \section1 Removing custom item from a graph
+
+ We'll just call \c removeCustomItemAt() with the position
+ of the item:
+
+ \snippet customitems/customitemgraph.cpp 3
+
+ \section1 Example Contents
+*/