PrimaryPointerGestureRecognizer class abstract

A base class for gesture recognizers that track a single primary pointer.

Gestures based on this class will stop tracking the gesture if the primary pointer travels beyond preAcceptSlopTolerance or postAcceptSlopTolerance pixels from the original contact point of the gesture.

If the preAcceptSlopTolerance was breached before the gesture was accepted in the gesture arena, the gesture will be rejected.

Inheritance
Implementers

Constructors

PrimaryPointerGestureRecognizer({Duration? deadline, double? preAcceptSlopTolerance = kTouchSlop, double? postAcceptSlopTolerance = kTouchSlop, Object? debugOwner, Set<PointerDeviceKind>? supportedDevices, AllowedButtonsFilter allowedButtonsFilter = _defaultButtonAcceptBehavior})
Initializes the deadline field during construction of subclasses.

Properties

allowedButtonsFilter → AllowedButtonsFilter
Called when interaction starts. This limits the dragging behavior for custom clicks (such as scroll click). Its parameter comes from PointerEvent.buttons.
finalinherited
deadline → Duration?
If non-null, the recognizer will call didExceedDeadline after this amount of time has elapsed since starting to track the primary pointer.
final
debugDescription → String
Returns a very short pretty description of the gesture that the recognizer looks for, like 'tap' or 'horizontal drag'.
no setterinherited
debugOwner → Object?
The recognizer's owner.
finalinherited
gestureSettings ↔ DeviceGestureSettings?
Optional device specific configuration for device gestures that will take precedence over framework defaults.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
initialPosition → OffsetPair?
The location at which the primary pointer contacted the screen.
no setter
postAcceptSlopTolerance → double?
The maximum distance in logical pixels the gesture is allowed to drift after the gesture has been accepted.
final
preAcceptSlopTolerance → double?
The maximum distance in logical pixels the gesture is allowed to drift from the initial touch down position before the gesture is accepted.
final
primaryPointer → int?
The ID of the primary pointer this recognizer is tracking.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → GestureRecognizerState
The current state of the recognizer.
no setter
supportedDevices ↔ Set<PointerDeviceKind>?
The kind of devices that are allowed to be recognized as provided by supportedDevices in the constructor, or the currently deprecated kind. These cannot both be set. If both are null, events from all device kinds will be tracked and recognized.
getter/setter pairinherited
team ↔ GestureArenaTeam?
The team that this recognizer belongs to, if any.
getter/setter pairinherited

Methods

acceptGesture(int pointer) → void
Called when this member wins the arena for the given pointer id.
override
addAllowedPointer(PointerDownEvent event) → void
Registers a new pointer that's been checked to be allowed by this gesture recognizer.
override
addAllowedPointerPanZoom(PointerPanZoomStartEvent event) → void
Registers a new pointer pan/zoom that's been checked to be allowed by this gesture recognizer.
inherited
addPointer(PointerDownEvent event) → void
Registers a new pointer that might be relevant to this gesture detector.
inherited
addPointerPanZoom(PointerPanZoomStartEvent event) → void
Registers a new pointer pan/zoom that might be relevant to this gesture detector.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
didExceedDeadline() → void
Override to be notified when deadline is exceeded.
didExceedDeadlineWithEvent(PointerDownEvent event) → void
Same as didExceedDeadline but receives the event that initiated the gesture.
didStopTrackingLastPointer(int pointer) → void
Called when the number of pointers this recognizer is tracking changes from one to zero.
override
dispose() → void
Releases any resources used by the object.
override
getKindForPointer(int pointer) → PointerDeviceKind
For a given pointer ID, returns the device kind associated with it.
inherited
handleEvent(PointerEvent event) → void
Called when a pointer event is routed to this recognizer.
override
handleNonAllowedPointer(PointerDownEvent event) → void
Handles a pointer being added that's not allowed by this recognizer.
override
handleNonAllowedPointerPanZoom(PointerPanZoomStartEvent event) → void
Handles a pointer pan/zoom being added that's not allowed by this recognizer.
inherited
handlePrimaryPointer(PointerEvent event) → void
Override to provide behavior for the primary pointer when the gesture is still possible.
invokeCallback<T>(String name, RecognizerCallback<T> callback, {String debugReport()?}) → T?
Invoke a callback provided by the application, catching and logging any exceptions.
inherited
isPointerAllowed(PointerDownEvent event) → bool
Checks whether or not a pointer is allowed to be tracked by this recognizer.
inherited
isPointerPanZoomAllowed(PointerPanZoomStartEvent event) → bool
Checks whether or not a pointer pan/zoom is allowed to be tracked by this recognizer.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rejectGesture(int pointer) → void
Called when this member loses the arena for the given pointer id.
override
resolve(GestureDisposition disposition) → void
Resolves this recognizer's participation in each gesture arena with the given disposition.
inherited
resolvePointer(int pointer, GestureDisposition disposition) → void
Resolves this recognizer's participation in the given gesture arena with the given disposition.
inherited
startTrackingPointer(int pointer, [Matrix4? transform]) → void
Causes events related to the given pointer ID to be routed to this recognizer.
inherited
stopTrackingIfPointerNoLongerDown(PointerEvent event) → void
Stops tracking the pointer associated with the given event if the event is a PointerUpEvent or a PointerCancelEvent event.
inherited
stopTrackingPointer(int pointer) → void
Stops events related to the given pointer ID from being routed to this recognizer.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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