summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2016-06-08 10:05:55 +0200
committerJani Heikkinen <jani.heikkinen@qt.io>2016-06-08 18:33:51 +0000
commit63c10e11fa508e1b4b26fae3d7a897cc3d9375c3 (patch)
tree5487fc31c8186bb44a99f906145d11afbb89a887 /examples
parent8ac70dc21e1dce73c79ad915f6eafcd832ead09c (diff)
Doc: Add a skeleton for Scene 3D example docs
Without this fix, Qt Creator tags the example as "broken" and hides it in the Examples tag in the Welcome screen. Change-Id: Ifebc926b17a7161abb49c61a2369f8c485532156 Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'examples')
-rw-r--r--examples/qt3d/scene3d/doc/images/scene3d.pngbin0 -> 6552 bytes
-rw-r--r--examples/qt3d/scene3d/doc/src/scene3d.qdoc24
2 files changed, 24 insertions, 0 deletions
diff --git a/examples/qt3d/scene3d/doc/images/scene3d.png b/examples/qt3d/scene3d/doc/images/scene3d.png
new file mode 100644
index 000000000..eee96f43b
--- /dev/null
+++ b/examples/qt3d/scene3d/doc/images/scene3d.png
Binary files differ
diff --git a/examples/qt3d/scene3d/doc/src/scene3d.qdoc b/examples/qt3d/scene3d/doc/src/scene3d.qdoc
index e771c0192..fd324e6a4 100644
--- a/examples/qt3d/scene3d/doc/src/scene3d.qdoc
+++ b/examples/qt3d/scene3d/doc/src/scene3d.qdoc
@@ -29,4 +29,28 @@
\example scene3d
\title Qt 3D: Scene3D QML Example
\ingroup qt3d-examples-qml
+ \brief A QML application that demonstrates visualizing a 3D scene.
+
+ \image scene3d.png
+
+ \e {Scene3D} demonstrates visualizing a 3D scene from a Qt Quick
+ application. The 3D scene contains a single active camera and a single
+ active light source. Visualized data is assumed to be at a fixed location.
+
+ \include examples-run.qdocinc
+
+ \section1 Visualizing 3D Scenes
+
+ We set up the 3D scene and specify the entity to animate in \e main.qml:
+
+ \quotefromfile scene3d/main.qml
+ \skipto Scene3D {
+ \printuntil }
+ \printuntil }
+
+ We specify the active camera in \e scene3d/AnimatedEntity.qml:
+
+ \quotefromfile scene3d/AnimatedEntity.qml
+ \skipto Camera
+ \printuntil }
*/