Skip to main content

ScaleUpdateEvent

Continuous payload for scale, pan, and rotation updates.

Inherits: Event

Properties

  • focal_point_delta - The amount the gesture's focal point has moved in the coordinate space of the event receiver since the previous update.
  • global_focal_point - The focal point of the pointers in contact with the screen, in global coordinates.
  • horizontal_scale - The scale implied by the average distance along the horizontal axis between the pointers in contact with the screen.
  • local_focal_point - The focal point of the pointers in contact with the screen, in local coordinates.
  • pointer_count - The number of pointers being tracked by the gesture recognizer.
  • rotation - The angle (in radians) implied by the first two pointers to enter in contact with the screen.
  • scale - The scale implied by the average distance between the pointers in contact with the screen.
  • timestamp - Recorded timestamp of the source pointer event that triggered the scale event.
  • vertical_scale - The scale implied by the average distance along the vertical axis between the pointers in contact with the screen.

Properties​

focal_point_deltaclass-attributeinstance-attribute​

focal_point_delta: Offset = field(metadata={'data_field': 'fpd'})

The amount the gesture's focal point has moved in the coordinate space of the event receiver since the previous update.

global_focal_pointclass-attributeinstance-attribute​

global_focal_point: Offset = field(metadata={'data_field': 'gfp'})

The focal point of the pointers in contact with the screen, in global coordinates.

horizontal_scaleclass-attributeinstance-attribute​

horizontal_scale: float = field(metadata={'data_field': 'hs'})

The scale implied by the average distance along the horizontal axis between the pointers in contact with the screen.

This value must be greater than or equal to zero.

local_focal_pointclass-attributeinstance-attribute​

local_focal_point: Offset = field(metadata={'data_field': 'lfp'})

The focal point of the pointers in contact with the screen, in local coordinates.

pointer_countclass-attributeinstance-attribute​

pointer_count: int = field(metadata={'data_field': 'pc'})

The number of pointers being tracked by the gesture recognizer.

Typically this is the number of fingers being used to pan the widget using the gesture recognizer. Due to platform limitations, trackpad gestures count as two fingers even if more than two fingers are used.

rotationclass-attributeinstance-attribute​

rotation: float = field(metadata={'data_field': 'rot'})

The angle (in radians) implied by the first two pointers to enter in contact with the screen.

scaleclass-attributeinstance-attribute​

scale: float = field(metadata={'data_field': 's'})

The scale implied by the average distance between the pointers in contact with the screen.

This value must be greater than or equal to zero.

timestampclass-attributeinstance-attribute​

timestamp: Optional[Duration] = field(default=None, metadata={'data_field': 'ts'})

Recorded timestamp of the source pointer event that triggered the scale event.

Could be None if triggered from proxied events such as accessibility.

vertical_scaleclass-attributeinstance-attribute​

vertical_scale: float = field(metadata={'data_field': 'vs'})

The scale implied by the average distance along the vertical axis between the pointers in contact with the screen.

This value must be greater than or equal to zero.