aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/TraceInputArea.qml
blob: f692503f8319f803a5257ab2fb47135f7b9a9e48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

import QtQuick
import QtQuick.Window
import QtQuick.VirtualKeyboard

/*!
    \qmltype TraceInputArea
    \inqmlmodule QtQuick.VirtualKeyboard.Components
    \ingroup qmlclass
    \ingroup qtvirtualkeyboard-components-qml
    \inherits MultiPointTouchArea
    \since QtQuick.VirtualKeyboard 2.0

    \brief A specialized MultiPointTouchArea for collecting touch input data.

    This type handles the trace interaction between the touch screen and the input engine.

    The traces are rendered using the delegate from the
    \l {KeyboardStyle::}{traceCanvasDelegate} property of the current
    \l KeyboardStyle.
*/

MultiPointTouchArea {
    id: traceInputArea

    /*! Pattern recognition mode of this input area.

        The default value is \l {InputEngine::patternRecognitionModes} {InputEngine.PatternRecognitionMode.None}.
    */
    property int patternRecognitionMode: InputEngine.PatternRecognitionMode.None

    /*! List of horizontal rulers in the input area.

        The rulers are defined as a number of pixels from the top edge of the boundingBox.

        Here is an example that demonstrates how to define rulers:

        \code
            horizontalRulers: [boundingBox.height / 3, boundingBox.height / 3 * 2]
            verticalRulers: [boundingBox.width / 3, boundingBox.width / 3 * 2]
        \endcode
    */
    property var horizontalRulers

    /*! List of vertical rulers in the input area.

        The rulers are defined as a number of pixels from the left edge of the boundingBox.
    */
    property var verticalRulers

    /*! Bounding box for the trace input.

        This property is readonly and is automatically updated based on the item size
        and margins.
    */
    readonly property rect boundingBox: (width > 0 && height > 0) ?
                    Qt.rect(traceInputArea.x + traceInputArea.anchors.leftMargin,
                            traceInputArea.y + traceInputArea.anchors.topMargin,
                            traceInputArea.width,
                            traceInputArea.height) :
                    Qt.rect(0, 0, 0, 0)

    /*! Canvas type of this trace input area.

        This property can be used to distinguish between different types of canvases.
        For example, in full screen handwriting mode this property is set to \c "fullscreen", and
        in keyboard handwriting mode this property is set to \c "keyboard".
    */
    property string canvasType

    property var __activeTraceCanvases:  ({})
    property var __traceCanvasList: ([])
    property var __recycledTraceCanvasList: ([])

    Component.onCompleted: {
        for (var i = 0; i < 6; i++) {
            __recycledTraceCanvasList.push(__createTraceCanvas())
        }
    }

    function __getTraceCanvas() {
        while (__recycledTraceCanvasList.length == 0 &&
               __traceCanvasList.length >= 15 &&
               !__traceCanvasList.shift().recycle()) {}

        return __recycledTraceCanvasList.length > 0 ?
                    __recycledTraceCanvasList.pop() :
                    __createTraceCanvas()
    }

    function __createTraceCanvas() {
        var traceCanvas = keyboard.style.traceCanvasDelegate.createObject(traceInputArea)
        traceCanvas.onRecycle.connect(__onTraceCanvasRecycled)
        traceCanvas.anchors.fill = traceCanvas.parent
        return traceCanvas
    }

    function __onTraceCanvasRecycled(traceCanvas) {
        var index = __traceCanvasList.findIndex(function(otherCanvas) {
            return traceCanvas === otherCanvas
        })
        if (index !== -1) {
            __traceCanvasList.splice(index, index + 1)
        }
        __recycledTraceCanvasList.push(traceCanvas)
    }

    property var __traceCaptureDeviceInfo:
        ({
             channels: ['t'],
             sampleRate: 60,
             uniform: false,
             latency: 0.0,
             dpi: Screen.pixelDensity * 25.4
         })
    property var __traceScreenInfo:
        ({
             boundingBox: traceInputArea.boundingBox,
             horizontalRulers: traceInputArea.horizontalRulers,
             verticalRulers: traceInputArea.verticalRulers,
             canvasType: traceInputArea.canvasType
         })

    enabled: patternRecognitionMode !== InputEngine.PatternRecognitionMode.None && InputContext.inputEngine.patternRecognitionModes.indexOf(patternRecognitionMode) !== -1

    onPressed: (touchPoints) => {
        if (!keyboard.style.traceCanvasDelegate)
            return
        for (var i = 0; i < touchPoints.length; i++) {
            var traceId = touchPoints[i].pointId
            var trace = InputContext.inputEngine.traceBegin(traceId, patternRecognitionMode, __traceCaptureDeviceInfo, __traceScreenInfo)
            if (trace) {
                var traceCanvas = __getTraceCanvas()
                if (traceCanvas) {
                    traceCanvas.trace = trace
                    var index = trace.addPoint(Qt.point(touchPoints[i].x, touchPoints[i].y))
                    if (trace.channels.indexOf('t') !== -1) {
                        var dt = new Date()
                        trace.setChannelData('t', index, dt.getTime())
                    }
                    __activeTraceCanvases[traceId] = traceCanvas
                } else {
                    __activeTraceCanvases[traceId] = null
                }
            } else {
                __activeTraceCanvases[traceId] = null
            }
        }
    }

    onUpdated: (touchPoints) => {
        for (var i = 0; i < touchPoints.length; i++) {
            var traceId = touchPoints[i].pointId
            var traceCanvas = __activeTraceCanvases[traceId]
            if (traceCanvas) {
                var trace = traceCanvas.trace
                var index = trace.addPoint(Qt.point(touchPoints[i].x, touchPoints[i].y))
                if (trace.channels.indexOf('t') !== -1) {
                    var dt = new Date()
                    trace.setChannelData('t', index, dt.getTime())
                }
            }
        }
    }

    onReleased: (touchPoints) => {
        for (var i = 0; i < touchPoints.length; i++) {
            var traceId = touchPoints[i].pointId
            var traceCanvas = __activeTraceCanvases[traceId]
            if (traceCanvas) {
                if (traceCanvas.trace) {
                    traceCanvas.trace.final = true
                    InputContext.inputEngine.traceEnd(traceCanvas.trace)
                }
                __traceCanvasList.push(traceCanvas)
                __activeTraceCanvases[traceId] = null
            }
        }
    }

    onCanceled: (touchPoints) => {
        for (var i = 0; i < touchPoints.length; i++) {
            var traceId = touchPoints[i].pointId
            var traceCanvas = __activeTraceCanvases[traceId]
            if (traceCanvas) {
                if (traceCanvas.trace) {
                    traceCanvas.trace.final = true
                    traceCanvas.trace.canceled = true
                    InputContext.inputEngine.traceEnd(traceCanvas.trace)
                }
                __traceCanvasList.push(traceCanvas)
                __activeTraceCanvases[traceId] = null
            }
        }
    }
}