PointerData class
Information about the state of a pointer.
Constructors
- PointerData({int viewId = 0, int embedderId = 0, Duration timeStamp = Duration.zero, PointerChange change = PointerChange.cancel, PointerDeviceKind kind = PointerDeviceKind.touch, PointerSignalKind? signalKind, int device = 0, int pointerIdentifier = 0, double physicalX = 0.0, double physicalY = 0.0, double physicalDeltaX = 0.0, double physicalDeltaY = 0.0, int buttons = 0, bool obscured = false, bool synthesized = false, double pressure = 0.0, double pressureMin = 0.0, double pressureMax = 0.0, double distance = 0.0, double distanceMax = 0.0, double size = 0.0, double radiusMajor = 0.0, double radiusMinor = 0.0, double radiusMin = 0.0, double radiusMax = 0.0, double orientation = 0.0, double tilt = 0.0, int platformData = 0, double scrollDeltaX = 0.0, double scrollDeltaY = 0.0, double panX = 0.0, double panY = 0.0, double panDeltaX = 0.0, double panDeltaY = 0.0, double scale = 0.0, double rotation = 0.0, PointerDataRespondCallback? onRespond})
-
Creates an object that represents the state of a pointer.
const
Properties
-
Bit field using the *Button constants (primaryMouseButton,
secondaryStylusButton, etc). For example, if this has the value 6 and the
kind is PointerDeviceKind.invertedStylus, then this indicates an
upside-down stylus with both its primary and secondary buttons pressed.
final
- change → PointerChange
-
How the pointer has changed since the last report.
final
- device → int
-
Unique identifier for the pointing device, reused across interactions.
final
- distance → double
-
The distance of the detected object from the input surface (e.g. the
distance of a stylus or finger from a touch screen), in arbitrary units on
an arbitrary (not necessarily linear) scale. If the pointer is down, this
is 0.0 by definition.
final
- distanceMax → double
-
The maximum value that a distance can return for this pointer. If this
input device cannot detect "hover touch" input events, then this will be
0.0.
final
- embedderId → int
-
Unique identifier that ties the PointerEvent to the embedder
event that created it.
it.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- kind → PointerDeviceKind
-
The kind of input device for which the event was generated.
final
- obscured → bool
-
Set if an application from a different security domain is in any way
obscuring this application's window. (Aspirational; not currently
implemented.)
final
- orientation → double
-
For PointerDeviceKind.touch events:
final
- panDeltaX → double
-
For events with change of PointerChange.panZoomUpdate:
final
- panDeltaY → double
-
For events with change of PointerChange.panZoomUpdate:
final
- panX → double
-
For events with change of PointerChange.panZoomUpdate:
final
- panY → double
-
For events with change of PointerChange.panZoomUpdate:
final
- physicalDeltaX → double
-
The distance of pointer movement on X coordinate in physical pixels.
final
- physicalDeltaY → double
-
The distance of pointer movement on Y coordinate in physical pixels.
final
- physicalX → double
-
X coordinate of the position of the pointer, in physical pixels in the
global coordinate space.
final
- physicalY → double
-
Y coordinate of the position of the pointer, in physical pixels in the
global coordinate space.
final
- platformData → int
-
Opaque platform-specific data associated with the event.
final
- pointerIdentifier → int
-
Unique identifier for the pointer.
final
- pressure → double
-
The pressure of the touch as a number ranging from 0.0, indicating a touch
with no discernible pressure, to 1.0, indicating a touch with "normal"
pressure, and possibly beyond, indicating a stronger touch. For devices
that do not detect pressure (e.g. mice), returns 1.0.
final
- pressureMax → double
-
The maximum value that pressure can return for this pointer. For devices
that do not detect pressure (e.g. mice), returns 1.0. This will always be
a greater than or equal to 1.0.
final
- pressureMin → double
-
The minimum value that pressure can return for this pointer. For devices
that do not detect pressure (e.g. mice), returns 1.0. This will always be
a number less than or equal to 1.0.
final
- radiusMajor → double
-
The radius of the contact ellipse along the major axis, in logical pixels.
final
- radiusMax → double
-
The minimum value that could be reported for radiusMajor and radiusMinor
for this pointer, in logical pixels.
final
- radiusMin → double
-
The minimum value that could be reported for radiusMajor and radiusMinor
for this pointer, in logical pixels.
final
- radiusMinor → double
-
The radius of the contact ellipse along the minor axis, in logical pixels.
final
- rotation → double
-
For events with change of PointerChange.panZoomUpdate:
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scale → double
-
For events with change of PointerChange.panZoomUpdate:
final
- scrollDeltaX → double
-
For events with signalKind of PointerSignalKind.scroll:
final
- scrollDeltaY → double
-
For events with signalKind of PointerSignalKind.scroll:
final
- signalKind → PointerSignalKind?
-
The kind of signal for a pointer signal event.
final
- size → double
-
The area of the screen being pressed, scaled to a value between 0 and 1.
The value of size can be used to determine fat touch events. This value
is only set on Android, and is a device specific approximation within
the range of detectable values. So, for example, the value of 0.1 could
mean a touch with the tip of the finger, 0.2 a touch with full finger,
and 0.3 the full palm.
final
- synthesized → bool
-
Set if this pointer data was synthesized by pointer data packet converter.
pointer data packet converter will synthesize additional pointer datas if
the input sequence of pointer data is illegal.
final
- tilt → double
-
For PointerDeviceKind.stylus and PointerDeviceKind.invertedStylus events:
final
- timeStamp → Duration
-
Time of event dispatch, relative to an arbitrary timeline.
final
- viewId → int
-
The ID of the FlutterView this PointerEvent originated from.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
respond(
{required bool allowPlatformDefault}) → void - Method that the framework/app can call to respond to the native event that triggered this PointerData.
-
toString(
) → String -
A string representation of this object.
override
-
toStringFull(
) → String - Returns a complete textual description of the information in this object.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited