StrokeInput

@VisibleForTesting
fun create(
    x: Float,
    y: Float,
    elapsedTimeMillis: @IntRange(from = 0) Long,
    toolType: InputToolType = InputToolType.UNKNOWN,
    strokeUnitLengthCm: Float = NO_STROKE_UNIT_LENGTH,
    pressure: Float = NO_PRESSURE,
    tiltRadians: Float = NO_TILT,
    orientationRadians: Float = NO_ORIENTATION
): StrokeInput

Allocate and return a new StrokeInput. Only intended for test code - real code should use a recycling pattern to avoid allocating during latency-sensitive real-time input, using update on an instance allocated with the zero-argument constructor.

fun update(
    x: Float,
    y: Float,
    elapsedTimeMillis: @IntRange(from = 0) Long,
    toolType: InputToolType = InputToolType.UNKNOWN,
    strokeUnitLengthCm: Float = NO_STROKE_UNIT_LENGTH,
    pressure: Float = NO_PRESSURE,
    tiltRadians: Float = NO_TILT,
    orientationRadians: Float = NO_ORIENTATION
): Unit

Set new values on this instance, clearing values corresponding to optional parameters that are not specified.

val elapsedTimeMillis: Long

Time elapsed since the start of the stroke.

val hasOrientation: Boolean

Whether the orientationRadians field contains a valid orientation value.

val hasPressure: Boolean

Whether the pressure field contains a valid pressure value.

val hasTilt: Boolean

Whether the tiltRadians field contains a valid tilt value.

val orientationRadians: Float

The angle that indicates the direction in which the stylus is pointing in relation to the positive x axis. The value should be normalized to fall between 0 and 2π in radians, where 0 means the ray from the stylus tip to the end is along positive x and values increase towards the positive y-axis.

When tiltRadians is equal to π/2, the value for orientationRadians is indeterminant.

NO_ORIENTATION indicates that orientation is not reported, which can be checked with hasOrientation. Note, that this is a separate condition from the orientation being indeterminant when tiltRadians is π/2.

val pressure: Float

Pressure value in the normalized, unitless range of 0, 1 indicating the force exerted during input.

A value of NO_PRESSURE indicates that pressure is not reported, which can be checked with hasPressure.

val strokeUnitLengthCm: Float

The physical distance in centimeters that the pointer must travel in order to produce an input motion of one stroke unit. For stylus/touch, this is the real-world distance that the stylus/fingertip must move in physical space; for mouse, this is the visual distance that the mouse pointer must travel along the surface of the display.

A value of NO_STROKE_UNIT_LENGTH indicates that the relationship between stroke space and physical space is unknown or ill-defined.

val tiltRadians: Float

The angle between a stylus and the line perpendicular to the plane of the screen. The value should be normalized to fall between 0 and π/2 in radians, where 0 is perpendicular to the screen and π/2 is flat against the drawing surface.

NO_TILT indicates that tilt is not reported, which can be checked with hasTilt.

val toolType: InputToolType

The input device used to generate this stroke input.

val x: Float

The x-coordinate of the input position in stroke space.

val y: Float

The y-coordinate of the input position in stroke space.