ScaleUpdateEvent class

Event propagated through the Flame engine when the user updates a scale (pinch/zoom/rotate) gesture on the game canvas.

Constructors

ScaleUpdateEvent(int pointerId, Game game, ScaleUpdateDetails details)

Properties

canvasDelta Vector2
Event delta in the coordinate space of the game widget, i.e. relative to the game canvas.
latefinalinherited
canvasEndPosition Vector2
Event end position in the coordinate space of the game widget, i.e. relative to the game canvas.
latefinalinherited
canvasStartPosition Vector2
Event start position in the coordinate space of the game widget, i.e. relative to the game canvas.
latefinalinherited
continuePropagation bool
If this flag is false (default), the event will be delivered to the first component that can handle it. If that component sets this flag to true, the event will propagate further down the component tree to other eligible components.
getter/setter pairinherited
deviceDelta Vector2
Event delta in the coordinate space of the device -- either the phone, or the browser window, or the app.
latefinalinherited
deviceEndPosition Vector2
Event end position in the coordinate space of the device -- either the phone, or the browser window, or the app.
finalinherited
deviceStartPosition Vector2
Event start position in the coordinate space of the device -- either the phone, or the browser window, or the app.
finalinherited
focalPointDelta Vector2
Movement of the pinch center since last frame
final
handled bool
Flag that can be used to indicate that the event was handled by one of the components.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
horizontalScale double
Horizontal-only scale factor
final
localDelta Vector2
Event delta in the local coordinate space of the current component.
no setterinherited
localEndPosition Vector2
Event end position in the local coordinate space of the current component.
no setterinherited
localStartPosition Vector2
Event start position in the local coordinate space of the current component.
no setterinherited
parentContext → DisplacementContext?
The context in the parent's coordinate space, containing start and end points.
no setterinherited
pointerCount int
Number of fingers detected during this update
final
pointerId int
Unique identifier of this scale gesture (Flame-level)
final
raw ScaleUpdateDetails
The original Flutter raw event that triggered this Flame event.
getter/setter pairinherited
renderingTrace List<DisplacementContext>
The stacktrace of coordinates of the event within the components in their rendering order.
finalinherited
rotation double
Rotation delta in radians
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scale double
The instantaneous 2D scale factor (global)
final
timestamp Duration
Timestamp for ordering/debugging
final
verticalScale double
Vertical-only scale factor
final

Methods

collectApplicableChildren({required Component rootComponent}) Iterable<Component>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited