summaryrefslogtreecommitdiffstats
path: root/examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc')
-rw-r--r--examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc68
1 files changed, 50 insertions, 18 deletions
diff --git a/examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc b/examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc
index d6d215d6bd..07acef6b4d 100644
--- a/examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc
+++ b/examples/widgets/gestures/imagegestures/doc/src/imagegestures.qdoc
@@ -1,7 +1,7 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
@@ -10,15 +10,15 @@
** 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 Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/contact-us.
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://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
+** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
@@ -83,18 +83,50 @@
QGesture subclass.
To illustrate how a standard gesture can be interpreted by an application, we
- show the implementation of the \c swipeTriggered() function, which handles the
- gesture associated with a brushing or swiping motion on the user's display or
+ show the implementation of the \c pinchTriggered() function, which handles the
+ pinch gesture when the user moves two fingers around on the display or
input device:
- \snippet gestures/imagegestures/imagewidget.cpp swipe function
-
- The QSwipeGesture class provides specialized functions and defines a enum
- to make it more convenient for developers to discover which direction, if
- any, the user swiped the display. Here, we simply navigate to the previous
- image in the collection if the user swiped upwards or to the left; otherwise
- we navigate to the next image in the collection.
-
- The other gestures are also handled by special purpose functions, but use
- the values of properties held by the QGesture object passed to them.
+ \snippet gestures/imagegestures/imagewidget.cpp pinch function
+
+ The QPinchGesture class provides properties to interpret the changing
+ distance between the two touch points as a zoom factor, and the angle delta
+ as a rotation to be applied to the image. The center point between the
+ touch points could be used to drag the image, but in this example we use
+ the pan gesture for that purpose.
+
+ The \c scaleFactor() is a relative value representing how much the zoom
+ should change from one event to the next, whereas \c totalScaleFactor()
+ provides the amount of zoom that has been expressed since the gesture
+ began. When the touch points are released and another gesture begins,
+ \c totalScaleFactor() will begin again at 1.0. In this case we store
+ \c totalScaleFactor() into the \c currentStepScaleFactor variable so that
+ it can be used in \c paintEvent() to scale the image. Alternatively it would
+ be possible to simply multiply the stored total scale factor by
+ \c scaleFactor() here in the pinch handler.
+
+ In contrast, \c rotationAngle() represents the amount of rotation since the
+ pinch gesture began, while \c lastRotationAngle() provides the previous
+ value. So it is necessary to subtract in order to get an incremental delta.
+ When the user begins a new pinch gesture, \c rotationAngle() will start
+ from zero, and we want the image to begin to rotate from its current angle.
+ This is achieved by adding the delta to the stored \c rotationAngle (which
+ will be applied in \c paintEvent()). If we simply assigned
+ \c totalRotationAngle() to the stored \c rotationAngle, a new gesture would
+ cause the image to reset to a right-side-up orientation before beginning to
+ rotate again. But it would be possible to store the rotation angle since the
+ gesture began and add it to \c rotationAngle in \c paintEvent(), just as
+ we store the amount of zoom since the gesture began.
+
+ The pan and swipe gestures in this example are also handled in separate
+ functions, and use the values of properties from the QGesture objects
+ passed to them.
+
+ \snippet gestures/imagegestures/imagewidget.cpp paint method
+
+ In \c paintEvent(), scaleFactor represents the zoom level before the pinch
+ gesture began, while currentStepScaleFactor represents the additional zoom
+ factor while a pinch gesture is in progress. But for rotation, only the
+ current rotationAngle is stored. The horizontal and vertical offsets
+ represent the distance that the image has been dragged by the pan gesture.
*/