• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 组合手势
2
3手势识别组合，即多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。
4
5>  **说明：**
6>
7>  从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9
10## 接口
11
12GestureGroup(mode: GestureMode, ...gesture: GestureType[])
13
14- 参数
15  | 参数名     | 参数类型                                     | 必填   | 默认值  | 参数描述                           |
16  | ------- | ---------------------------------------- | ---- | ---- | ------------------------------ |
17  | mode    | [GestureMode](#gesturemode枚举说明)          | 是    | -    | 设置组合手势识别模式。                    |
18  | gesture | [TapGesture](ts-basic-gestures-tapgesture.md)<br/>\|&nbsp;[LongPressGesture](ts-basic-gestures-longpressgesture.md)<br/>\|&nbsp;[PanGesture](ts-basic-gestures-pangesture.md)<br/>\|&nbsp;[PinchGesture](ts-basic-gestures-pinchgesture.md)<br/>\|&nbsp;[RotationGesture](ts-basic-gestures-rotationgesture.md) | 是    | -    | 可变长参数，1个或者多个基础手势类型，这些手势会被组合识别。 |
19
20## GestureMode枚举说明
21| 名称        | 描述                                       |
22| --------- | ---------------------------------------- |
23| Sequence  | 顺序识别，按照手势的注册顺序识别手势，直到所有手势识别成功。当有一个手势识别失败时，所有手势识别失败。 |
24| Parallel  | 并发识别，注册的手势同时识别，直到所有手势识别结束，手势识别互相不影响。     |
25| Exclusive | 互斥识别，注册的手势同时识别，若有一个手势识别成功，则结束手势识别。       |
26
27
28## 事件
29
30| 名称                                       | 功能描述                                 |
31| ---------------------------------------- | ------------------------------------ |
32| onCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 顺序组合手势（GestureMode.Sequence）取消后触发回调。 |
33
34
35## 示例
36
37```ts
38// xxx.ets
39@Entry
40@Component
41struct GestureGroupExample {
42  @State count: number = 0
43  @State offsetX: number = 0
44  @State offsetY: number = 0
45  @State positionX: number = 0
46  @State positionY: number = 0
47  @State borderStyles: BorderStyle = BorderStyle.Solid
48
49  build() {
50    Column() {
51      Text('sequence gesture\n' + 'LongPress onAction:' + this.count + '\nPanGesture offset:\nX: ' + this.offsetX + '\n' + 'Y: ' + this.offsetY)
52        .fontSize(15)
53    }
54    .translate({ x: this.offsetX, y: this.offsetY, z: 0 })
55    .height(150)
56    .width(200)
57    .padding(20)
58    .margin(20)
59    .border({ width: 3, style: this.borderStyles })
60    .gesture(
61      // 以下组合手势为顺序识别，当长按手势事件未正常触发时则不会触发拖动手势事件
62    GestureGroup(GestureMode.Sequence,
63    LongPressGesture({ repeat: true })
64      .onAction((event: GestureEvent) => {
65        if (event.repeat) {
66          this.count++
67        }
68        console.info('LongPress onAction')
69      })
70      .onActionEnd(() => {
71        console.info('LongPress end')
72      }),
73    PanGesture()
74      .onActionStart(() => {
75        this.borderStyles = BorderStyle.Dashed
76        console.info('pan start')
77      })
78      .onActionUpdate((event: GestureEvent) => {
79        this.offsetX = this.positionX + event.offsetX
80        this.offsetY = this.positionY + event.offsetY
81        console.info('pan update')
82      })
83      .onActionEnd(() => {
84        this.positionX = this.offsetX
85        this.positionY = this.offsetY
86        this.borderStyles = BorderStyle.Solid
87        console.info('pan end')
88      })
89    )
90      .onCancel(() => {
91        console.info('sequence gesture canceled')
92      })
93    )
94  }
95}
96```
97
98示意图：
99
100按顺序首先触发长按事件：
101
102![zh-cn_image_0000001174104384](figures/zh-cn_image_0000001174104384.png)
103
104按顺序首先触发长按事件，长按事件识别结束之后，其次触发拖动事件，向右下方拖动：
105
106 ![zh-cn_image1_0000001174104384](figures/zh-cn_image1_0000001174104384.png)