OpenHarmony应用开发-基础手势与组合手势

素年锦时静待君丶
发布于 2023-4-14 15:33
浏览
0收藏

版本:v3.2 Release

基础手势

PinchGesture

用于触发捏合手势,触发捏合手势的最少手指为2指,最大为5指,最小识别距离为3vp。

说明:

从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

接口

PinchGesture(value?: { fingers?: number, distance?: number })

参数:

参数名称

参数类型

必填

参数描述

fingers

number

触发捏合的最少手指数, 最小为2指,最大为5指。

默认值:2

distance

number

最小识别距离,单位为vp。

默认值:3

事件

名称

功能描述

onActionStart(event:(event?: ​​GestureEvent​​) => void)

Pinch手势识别成功回调。

onActionUpdate(event:(event?: ​​GestureEvent​​) => void)

Pinch手势移动过程中回调。

onActionEnd(event:(event?: ​​GestureEvent​​) => void)

Pinch手势识别成功,手指抬起后触发回调。

onActionCancel(event: () => void)

Pinch手势识别成功,接收到触摸取消事件触发回调。

示例

// xxx.ets
@Entry
@Component
struct PinchGestureExample {
  @State scaleValue: number = 1
  @State pinchValue: number = 1
  @State pinchX: number = 0
  @State pinchY: number = 0

  build() {
    Column() {
      Column() {
        Text('PinchGesture scale:\n' + this.scaleValue)
        Text('PinchGesture center:\n(' + this.pinchX + ',' + this.pinchY + ')')
      }
      .height(200)
      .width(300)
      .padding(20)
      .border({ width: 3 })
      .margin({ top: 100 })
      .scale({ x: this.scaleValue, y: this.scaleValue, z: 1 })
      // 三指捏合触发该手势事件
      .gesture(
      PinchGesture({ fingers: 3 })
        .onActionStart((event: GestureEvent) => {
          console.info('Pinch start')
        })
        .onActionUpdate((event: GestureEvent) => {
          this.scaleValue = this.pinchValue * event.scale
          this.pinchX = event.pinchCenterX
          this.pinchY = event.pinchCenterY
        })
        .onActionEnd(() => {
          this.pinchValue = this.scaleValue
          console.info('Pinch end')
        })
      )
    }.width('100%')
  }
}

OpenHarmony应用开发-基础手势与组合手势-鸿蒙开发者社区

RotationGesture

用于触发旋转手势事件,触发旋转手势的最少手指为2指,最大为5指,最小改变度数为1度。

说明:

从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

接口

RotationGesture(value?: { fingers?: number, angle?: number })

参数:

参数名称

参数类型

必填

参数描述

fingers

number

触发旋转的最少手指数, 最小为2指,最大为5指。

默认值:2

angle

number

触发旋转手势的最小改变度数,单位为deg。

默认值:1

事件

名称

功能描述

onActionStart(event:(event?: ​​GestureEvent​​) => void)

Rotation手势识别成功回调。

onActionUpdate(event:(event?: ​​GestureEvent​​) => void)

Rotation手势移动过程中回调。

onActionEnd(event:(event?: ​​GestureEvent​​) => void)

Rotation手势识别成功,手指抬起后触发回调。

onActionCancel(event: () => void)

Rotation手势识别成功,接收到触摸取消事件触发回调。

示例

// xxx.ets
@Entry
@Component
struct RotationGestureExample {
  @State angle: number = 0
  @State rotateValue: number = 0

  build() {
    Column() {
      Column() {
        Text('RotationGesture angle:' + this.angle)
      }
      .height(200)
      .width(300)
      .padding(20)
      .border({ width: 3 })
      .margin(80)
      .rotate({ angle: this.angle })
      // 双指旋转触发该手势事件
      .gesture(
      RotationGesture()
        .onActionStart((event: GestureEvent) => {
          console.info('Rotation start')
        })
        .onActionUpdate((event: GestureEvent) => {
          this.angle = this.rotateValue + event.angle
        })
        .onActionEnd(() => {
          this.rotateValue = this.angle
          console.info('Rotation end')
        })
      )
    }.width('100%')
  }
}

OpenHarmony应用开发-基础手势与组合手势-鸿蒙开发者社区

SwipeGesture

用于触发滑动事件,滑动速度大于100vp/s时可识别成功。

说明:

从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

接口

SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: number })

参数:

参数名称

参数类型

必填

参数描述

fingers

number

触发滑动的最少手指数,默认为1,最小为1指,最大为10指。

默认值:1

direction

​SwipeDirection​

触发滑动手势的滑动方向。

默认值:SwipeDirection.All

speed

number

识别滑动的最小速度(默认为100VP/秒)。

默认值:100

SwipeDirection枚举说明

名称

描述

All

所有方向。

Horizontal

水平方向,手指滑动方向与x轴夹角小于45度时触发。

Vertical

竖直方向,手指滑动方向与y轴夹角小于45度时触发。

None

任何方向均不可触发。

事件

名称

功能描述

onAction(event:(event?: ​​GestureEvent​​) => void)

滑动手势识别成功回调。

示例

// xxx.ets
@Entry
@Component
struct SwipeGestureExample {
  @State rotateAngle: number = 0
  @State speed: number = 1

  build() {
    Column() {
      Column() {
        Text("SwipeGesture speed\n" + this.speed)
        Text("SwipeGesture angle\n" + this.rotateAngle)
      }
      .border({ width: 3 })
      .width(300)
      .height(200)
      .margin(100)
      .rotate({ angle: this.rotateAngle })
      // 单指竖直方向滑动时触发该事件
      .gesture(
      SwipeGesture({ direction: SwipeDirection.Vertical })
        .onAction((event: GestureEvent) => {
          this.speed = event.speed
          this.rotateAngle = event.angle
        })
      )
    }.width('100%')
  }
}

OpenHarmony应用开发-基础手势与组合手势-鸿蒙开发者社区

组合手势

手势识别组合,即多种手势组合为复合手势,支持连续识别、并行识别和互斥识别。

说明:

从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

接口

GestureGroup(mode: GestureMode, …gesture: GestureType[])

  • 参数

参数名

参数类型

必填

默认值

参数描述

mode

​GestureMode​

-

设置组合手势识别模式。

gesture

​TapGesture​​​| ​​LongPressGesture​

| ​​PanGesture​

| ​​PinchGesture​

| ​​RotationGesture​

-

可变长参数,1个或者多个基础手势类型,这些手势会被组合识别。

GestureMode枚举说明

名称

描述

Sequence

顺序识别,按照手势的注册顺序识别手势,直到所有手势识别成功。当有一个手势识别失败时,所有手势识别失败。

Parallel

并发识别,注册的手势同时识别,直到所有手势识别结束,手势识别互相不影响。

Exclusive

互斥识别,注册的手势同时识别,若有一个手势识别成功,则结束手势识别。

事件

名称

功能描述

onCancel(event: () => void)

顺序组合手势(GestureMode.Sequence)取消后触发回调。

示例

// xxx.ets
@Entry
@Component
struct GestureGroupExample {
  @State count: number = 0
  @State offsetX: number = 0
  @State offsetY: number = 0
  @State positionX: number = 0
  @State positionY: number = 0
  @State borderStyles: BorderStyle = BorderStyle.Solid

  build() {
    Column() {
      Text('sequence gesture\n' + 'LongPress onAction:' + this.count + '\nPanGesture offset:\nX: ' + this.offsetX + '\n' + 'Y: ' + this.offsetY)
    }
    .translate({ x: this.offsetX, y: this.offsetY, z: 0 })
    .height(150)
    .width(200)
    .padding(20)
    .margin(20)
    .border({ width: 3, style: this.borderStyles })
    .gesture(
      // 以下组合手势为顺序识别,当长按手势事件未正常触发时则不会触发拖动手势事件
    GestureGroup(GestureMode.Sequence,
    LongPressGesture({ repeat: true })
      .onAction((event: GestureEvent) => {
        if (event.repeat) {
          this.count++
        }
        console.info('LongPress onAction')
      })
      .onActionEnd(() => {
        console.info('LongPress end')
      }),
    PanGesture()
      .onActionStart(() => {
        this.borderStyles = BorderStyle.Dashed
        console.info('pan start')
      })
      .onActionUpdate((event: GestureEvent) => {
        this.offsetX = this.positionX + event.offsetX
        this.offsetY = this.positionY + event.offsetY
        console.info('pan update')
      })
      .onActionEnd(() => {
        this.positionX = this.offsetX
        this.positionY = this.offsetY
        this.borderStyles = BorderStyle.Solid
        console.info('pan end')
      })
    )
      .onCancel(() => {
        console.info('sequence gesture canceled')
      })
    )
  }
}

示意图:

按顺序首先触发长按事件:

OpenHarmony应用开发-基础手势与组合手势-鸿蒙开发者社区

按顺序首先触发长按事件,长按事件识别结束之后,其次触发拖动事件,向右下方拖动:

OpenHarmony应用开发-基础手势与组合手势-鸿蒙开发者社区


文章转载自:​​https://docs.openharmony.cn/pages/v3.2/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md/​

已于2023-4-14 15:33:33修改
收藏
回复
举报
回复
    相关推荐