• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 组合手势
2
3手势识别组合，即多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。
4
5>  **说明：**
6>
7>  从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9## 接口
10
11GestureGroup(mode: GestureMode, ...gesture: GestureType[])
12
13**参数：**
14
15| 参数名  | 参数类型                                                     | 必填 | 参数描述                                                     |
16| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
17| mode    | [GestureMode](#gesturemode枚举说明)                          | 是   | 设置组合手势识别模式。<br/>默认值：GestureMode.Sequence      |
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)<br/>\|&nbsp;[SwipeGesture](ts-basic-gestures-swipegesture.md)<br/>\|&nbsp;[GestureGroup](#组合手势) | 否   | 设置1个或者多个基础手势类型时，这些手势会被识别为组合手势。若此参数不填则组合手势识别功能不生效。<br/>**说明：**  <br/>当需要为一个组件同时添加单击和双击手势时，可在组合手势中添加两个TapGesture，需要双击手势在前，单击手势在后，否则不生效。 |
19
20## GestureMode枚举说明
21
22| 名称        | 描述                                       |
23| --------- | ---------------------------------------- |
24| Sequence  | 顺序识别，按照手势的注册顺序识别手势，直到所有手势识别成功。若有一个手势识别失败，后续手势识别均失败。<br>顺序识别手势组仅有最后一个手势可以响应onActionEnd。 |
25| Parallel  | 并发识别，注册的手势同时识别，直到所有手势识别结束，手势识别互相不影响。     |
26| Exclusive | 互斥识别，注册的手势同时识别，若有一个手势识别成功，则结束手势识别。       |
27
28
29## 事件
30
31| 名称                                       | 功能描述                                 |
32| ---------------------------------------- | ------------------------------------ |
33| onCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 顺序组合手势（GestureMode.Sequence）取消后触发回调。<br/>**说明：** <br/>在窗口失焦的时候会触发。 |
34
35
36## 示例
37
38```ts
39// xxx.ets
40@Entry
41@Component
42struct GestureGroupExample {
43  @State count: number = 0
44  @State offsetX: number = 0
45  @State offsetY: number = 0
46  @State positionX: number = 0
47  @State positionY: number = 0
48  @State borderStyles: BorderStyle = BorderStyle.Solid
49
50  build() {
51    Column() {
52      Text('sequence gesture\n' + 'LongPress onAction:' + this.count + '\nPanGesture offset:\nX: ' + this.offsetX + '\n' + 'Y: ' + this.offsetY)
53        .fontSize(15)
54    }
55    .translate({ x: this.offsetX, y: this.offsetY, z: 0 })
56    .height(150)
57    .width(200)
58    .padding(20)
59    .margin(20)
60    .border({ width: 3, style: this.borderStyles })
61    .gesture(
62      // 以下组合手势为顺序识别，当长按手势事件未正常触发时则不会触发拖动手势事件
63      GestureGroup(GestureMode.Sequence,
64        LongPressGesture({ repeat: true })
65          .onAction((event?: GestureEvent) => {
66            if (event && event.repeat) {
67              this.count++
68            }
69            console.info('LongPress onAction')
70          }),
71        PanGesture()
72          .onActionStart(() => {
73            this.borderStyles = BorderStyle.Dashed
74            console.info('pan start')
75          })
76          .onActionUpdate((event?: GestureEvent) => {
77            if (event) {
78              this.offsetX = this.positionX + event.offsetX
79              this.offsetY = this.positionY + event.offsetY
80            }
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)