• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# PinchGesture
2
3用于触发捏合手势,触发捏合手势的最少手指为2指,最大为5指,最小识别距离为5vp。
4
5>  **说明:**
6>
7>  从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9
10## 接口
11
12PinchGesture(value?: { fingers?: number, distance?: number })
13
14**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
15
16**参数:**
17
18| 参数名称 | 参数类型 | 必填 | 参数描述 |
19| -------- | -------- | -------- | -------- |
20| fingers | number | 否 | 触发捏合的最少手指数,&nbsp;最小为2指,最大为5指。<br/>默认值:2 <br/>触发手势手指可以多于fingers数目,但只有先落下的与fingers相同数目的手指参与手势计算。 |
21| distance | number | 否 | 最小识别距离,单位为vp。<br/>默认值:5 <br/>**说明:** <br/>取值范围:[0, +∞),当识别距离的值小于等于0时,会被转化为默认值。|
22| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。若触摸屏幕的手指数量不等于设置的触发捏合的最少手指数(即上述fingers参数),手势将不会被识别。只有当触摸屏幕的手指数等于设置的触发捏合手势的最小手指数,并且滑动距离满足阈值要求时,手势才能被成功识别(只有先落下的两根手指参与手势计算,若抬起其中的一个,手势识别失败)。对于已经成功识别的手势,后续改变触摸屏幕的手指数量,将不会触发[onActionUpdate](ts-basic-gestures-pinchgesture.md#事件)事件,但可以触发[onActionEnd](ts-basic-gestures-pinchgesture.md#事件)事件。<br>默认值:false。|
23
24
25## 事件
26
27| 名称 | 功能描述 |
28| -------- | -------- |
29| onActionStart(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Pinch手势识别成功回调。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
30| onActionUpdate(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Pinch手势移动过程中回调。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
31| onActionEnd(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Pinch手势识别成功,手指抬起后触发回调。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
32| onActionCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | Pinch手势识别成功,接收到触摸取消事件触发回调。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
33
34## 属性
35
36| 名称 | 类型    |描述                                        |
37| ----  | ------  | ---------------------------------------- |
38| tag<sup>11+</sup>   | string  | 设置Pinch手势标志,用于自定义手势判定时区分绑定的手势。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
39| allowedTypes<sup>14+</sup> | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)> | 设置Pinch手势支持的事件输入源。<br/>**原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。 |
40
41## 示例
42
43该示例通过配置PinchGesture实现了三指捏合手势的识别。
44
45```ts
46// xxx.ets
47@Entry
48@Component
49struct PinchGestureExample {
50  @State scaleValue: number = 1
51  @State pinchValue: number = 1
52  @State pinchX: number = 0
53  @State pinchY: number = 0
54
55  build() {
56    Column() {
57      Column() {
58        Text('PinchGesture scale:\n' + this.scaleValue)
59        Text('PinchGesture center:\n(' + this.pinchX + ',' + this.pinchY + ')')
60      }
61      .height(200)
62      .width(300)
63      .padding(20)
64      .border({ width: 3 })
65      .margin({ top: 100 })
66      .scale({ x: this.scaleValue, y: this.scaleValue, z: 1 })
67      // 三指捏合触发该手势事件
68      .gesture(
69      PinchGesture({ fingers: 3 })
70        .onActionStart((event: GestureEvent) => {
71          console.info('Pinch start')
72        })
73        .onActionUpdate((event: GestureEvent) => {
74          if (event) {
75            this.scaleValue = this.pinchValue * event.scale
76            this.pinchX = event.pinchCenterX
77            this.pinchY = event.pinchCenterY
78          }
79        })
80        .onActionEnd((event: GestureEvent) => {
81          this.pinchValue = this.scaleValue
82          console.info('Pinch end')
83        })
84      )
85    }.width('100%')
86  }
87}
88```
89
90 ![zh-cn_image_0000001174582848](figures/zh-cn_image_0000001174582848.png)
91