From 63c10e11fa508e1b4b26fae3d7a897cc3d9375c3 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 8 Jun 2016 10:05:55 +0200 Subject: Doc: Add a skeleton for Scene 3D example docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö --- examples/qt3d/scene3d/doc/images/scene3d.png | Bin 0 -> 6552 bytes examples/qt3d/scene3d/doc/src/scene3d.qdoc | 24 ++++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 examples/qt3d/scene3d/doc/images/scene3d.png (limited to 'examples/qt3d/scene3d/doc') 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 Binary files /dev/null and b/examples/qt3d/scene3d/doc/images/scene3d.png 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 } */ -- cgit v1.2.3