diff options
Diffstat (limited to 'examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc')
-rw-r--r-- | examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc | 100 |
1 files changed, 0 insertions, 100 deletions
diff --git a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc deleted file mode 100644 index a0c2ef62..00000000 --- a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc +++ /dev/null @@ -1,100 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \example qmlspectrogram - \title Qt Quick 2 Spectrogram Example - \ingroup qtdatavisualization_examples - \brief Showing spectrogram graph in a QML application. - - The Qt Quick 2 Spectrogram example demonstrates how to show a polar and cartesian spectrograms - and how to utilize orthographic projection to show them in 2D. - - \image qmlspectrogram-example.png - - 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. 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, - see \l{Qt Quick 2 Scatter Example}. - - \include examples-run.qdocinc - - \section1 Creating a Spectrogram - - To create a 2D spectrogram, we define a Surface3D item: - - \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 0 - - The key properties for enabling the 2D effect are - \l{AbstractGraph3D::orthoProjection}{orthoProjection} and - \l{Camera3D::cameraPreset}{scene.activeCamera.cameraPreset}. We remove the perspective by - enabling orthographic projection for the graph, and then we eliminate the Y-dimension by - viewing the graph directly from above: - - \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 1 - - Since this viewpoint causes the horizontal axis grid to be mostly obscured by the surface, - we also specify that the horizontal grid should be drawn on top of the graph: - - \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 2 - - \section1 Polar Spectrogram - - Depending on the data, it is sometimes more natural to use a polar graph instead of a cartesian - one. Qt Data Visualization supports this via \l{AbstractGraph3D::polar}{polar} property. - In this example we provide a button to switch between polar and cartesian modes: - - \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 3 - - In the polar mode, the X-axis is converted into the angular polar axis, and the Z-axis is - converted into the radial polar axis. The surface points are recalculated according to new axes. - - The radial axis labels are drawn outside the graph by default, but in this example we want to - draw them right next to the 0 degree angular axis inside the graph, so we define only a tiny - offset for them: - - \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 -*/ |