Common event used to wrap signals from the platform so that they can be handled properly by the NavigationEventDispatcher

Summary

Constants

const Int

Indicates that the edge swipe starts from the left edge of the screen

Cmn
const Int

Indicates that the back event was not triggered by an edge swipe back gesture.

Cmn
const Int

Indicates that the edge swipe starts from the right edge of the screen

Cmn

Public constructors

NavigationEvent(
    touchX: Float,
    touchY: Float,
    progress: Float,
    swipeEdge: Int,
    frameTimeMillis: Long
)
Cmn

Public functions

open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn
open String
Cmn

Public properties

Long

Frame time of the navigation event.

Cmn
Float

Value between 0 and 1 on how far along the back gesture is.

Cmn
Int

Indicates which edge the swipe starts from.

Cmn
Float

Absolute X location of the touch point of this event in the coordinate space of the screen that received this navigation event.

Cmn
Float

Absolute Y location of the touch point of this event in the coordinate space of the screen that received this navigation event.

Cmn

Constants

EDGE_LEFT

const val EDGE_LEFT = 0: Int

Indicates that the edge swipe starts from the left edge of the screen

EDGE_NONE

const val EDGE_NONE = 2: Int

Indicates that the back event was not triggered by an edge swipe back gesture. This applies to cases like using the back button in 3-button navigation or pressing a hardware back button.

EDGE_RIGHT

const val EDGE_RIGHT = 1: Int

Indicates that the edge swipe starts from the right edge of the screen

Public constructors

NavigationEvent(
    touchX: Float,
    touchY: Float,
    progress: Float,
    swipeEdge: Int,
    frameTimeMillis: Long = 0
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

frameTimeMillis

val frameTimeMillisLong

Frame time of the navigation event.

progress

val progressFloat

Value between 0 and 1 on how far along the back gesture is.

swipeEdge

val swipeEdgeInt

Indicates which edge the swipe starts from.

touchX

val touchXFloat

Absolute X location of the touch point of this event in the coordinate space of the screen that received this navigation event.

touchY

val touchYFloat

Absolute Y location of the touch point of this event in the coordinate space of the screen that received this navigation event.