BackEvent

EDGE_LEFT

static val EDGE_LEFT: Int

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

Value: 0

EDGE_NONE

static val EDGE_NONE: 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.

Value: 2

EDGE_RIGHT

static val EDGE_RIGHT: Int

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

Value: 1

BackEvent

BackEvent(
    touchX: Float, 
    touchY: Float, 
    progress: Float, 
    swipeEdge: Int)

Creates a new BackEvent instance with a frame time of 0.

BackEvent

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

Creates a new BackEvent instance.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getFrameTimeMillis

fun getFrameTimeMillis(): Long

Returns the frameTime of the BackEvent in milliseconds. Useful for calculating velocity.

getProgress

fun getProgress(): Float

Returns a value between 0 and 1 on how far along the back gesture is. This value is driven by the horizontal location of the touch point, and should be used as the fraction to seek the predictive back animation with. Specifically,

1. The progress is 0 when the touch is at the starting edge of the screen (left or right), and animation should seek to its start state.
2. The progress is approximately 1 when the touch is at the opposite side of the screen, and animation should seek to its end state. Exact end value may vary depending on screen size.

getSwipeEdge

fun getSwipeEdge(): Int

Returns the screen edge that the swipe starts from.

getTouchX

fun getTouchX(): Float

Returns the absolute X location of the touch point, or NaN if the event is from a button press.

getTouchY

fun getTouchY(): Float

Returns the absolute Y location of the touch point, or NaN if the event is from a button press.

toString

fun toString(): String

Returns a string representation of the object.