summaryrefslogtreecommitdiffstats
path: root/examples/datavisualization/qmlspectrogram/doc
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2014-07-04 12:14:13 +0300
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2014-07-04 12:55:05 +0300
commit1b311517f8889e6faa8a1ae51af582c1cd07e739 (patch)
treed1b023e36b5c7ddd67368007bb64c4b8551c480b /examples/datavisualization/qmlspectrogram/doc
parent9c3b9fb2d8f07b2b3f2e5bc84653711043c9936c (diff)
Exposed default input handlers to QML
Also added properties to control rotation, zoom, and selection individually. Also added missing documentation about surface texture. Task-number: QTRD-3202 Change-Id: I981edb7f336aea499440559f4a2098711200206d Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'examples/datavisualization/qmlspectrogram/doc')
-rw-r--r--examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc20
1 files changed, 15 insertions, 5 deletions
diff --git a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc
index ee0018e3..0aebdde0 100644
--- a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc
+++ b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc
@@ -29,11 +29,8 @@
Spectrogram is simply a surface graph with a range gradient used to emphasize the different
values. Typically spectrograms are shown with two dimensional surfaces, which we simulate
- with a top down orthographic view of the graph. In this example, the default input handler
- is enabled, so you can also rotate the graph to see how it looks in three dimensions. In
- a real application you may want to disable the default input handling if you wish to show
- only the two dimensional graph. See \l{Qt Quick 2 Custom Input Example} for guidelines on
- customizing input handling.
+ with a top down orthographic view of the graph. To enforce the 2D effect, we disable the
+ graph rotation via mouse or touch when in the orthographic mode.
The focus in this example is on showing how to display spectrograms, so the basic
functionality is not explained. For more detailed QML example documentation,
@@ -75,5 +72,18 @@
\snippet qmlspectrogram/qml/qmlspectrogram/main.qml 4
+ To enforce the 2D effect, graph rotation via user input is disabled when in orthographic mode.
+ We do this by specifying a new input handler:
+
+ \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 5
+ \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 7
+ \dots 0
+ \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 6
+ \dots 0
+
+ When the projection mode changes, we adjust the value of the
+ \l{InputHandler3D::rotationEnabled}{rotationEnabled} property of the \c{customInputHandler}
+ to control the rotation.
+
\section1 Example contents
*/