summaryrefslogtreecommitdiffstats
path: root/doc/src/examples/teapot.qdoc
diff options
context:
space:
mode:
authorSarah Smith <sarah.j.smith@nokia.com>2011-04-14 17:28:34 +1000
committerSarah Smith <sarah.j.smith@nokia.com>2011-04-14 17:28:34 +1000
commitbe2940e0e76b357e9c0e45dd9726ab2887bf865d (patch)
tree9b0274c721e33220d02448007813a606484c4b17 /doc/src/examples/teapot.qdoc
parentb751eeb3c192c99e265db272d500bdb8c0982288 (diff)
Refactoring doco.
Also remove N900 stuff and document that this is superseded by packaging stuff in the debian directory. Change-Id: Ic4db8524a8c6a93984e74fa0866861c353a457f2
Diffstat (limited to 'doc/src/examples/teapot.qdoc')
-rw-r--r--doc/src/examples/teapot.qdoc18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/src/examples/teapot.qdoc b/doc/src/examples/teapot.qdoc
index 02310277..80d10ddb 100644
--- a/doc/src/examples/teapot.qdoc
+++ b/doc/src/examples/teapot.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \example teapot
+ \example qt3d/teapot
\title Teapot Example
The Teapot example shows how Qt3D can be used to draw a simple
@@ -37,9 +37,9 @@
We start by defining a class that inherits from QGLView, which
provides some basic scene setup logic and 3D camera navigation:
- \snippet teapot/teapotview.h class-defn
+ \snippet qt3d/teapot/teapotview.h class-defn
\dots
- \quotefromfile teapot/main.cpp
+ \quotefromfile qt3d/teapot/main.cpp
\skipuntil [main]
\printto [main-args]
\skipuntil [main-args-end]
@@ -48,9 +48,9 @@
When the application starts up, we set up some scene parameters
in the \c{initializeGL()} function:
- \quotefromfile teapot/teapotview.cpp
+ \quotefromfile qt3d/teapot/teapotview.cpp
\skipuntil [initialize]
- \printto [create-display-list]
+ \printto [build-geometry]
The first line of the function selects a standard rendering
effect that lights material colors with the default OpenGL
@@ -59,8 +59,8 @@
The \c{teapot} member variable is an instance of QGLSceneNode,
which we create using QGLBuilder during \c{initializeGL()}:
- \quotefromfile teapot/teapotview.cpp
- \skipuntil [create-display-list]
+ \quotefromfile qt3d/teapot/teapotview.cpp
+ \skipuntil [build-geometry]
\printto [initialize]
The QGLTeapot class represents the geometry for the teapot,
@@ -73,11 +73,11 @@
We have to take care to clean up our scene after we're done with it
and here that is done in the destructor:
- \snippet teapot/teapotview.cpp destructor
+ \snippet qt3d/teapot/teapotview.cpp destructor
Finally, we paint the teapot every time the window is refreshed:
- \snippet teapot/teapotview.cpp paint
+ \snippet qt3d/teapot/teapotview.cpp paint
The QGLView class has in-built support for camera navigation
using the mouse and keyboard. By clicking and dragging the mouse,