StrokeInput

public static final float NO_ORIENTATION

public static final float NO_PRESSURE

public static final float NO_STROKE_UNIT_LENGTH = 0.0f

public static final float NO_TILT

public StrokeInput()

@VisibleForTesting
public static final @NonNull StrokeInput create(
    float x,
    float y,
    @IntRange(from = 0) long elapsedTimeMillis,
    @NonNull InputToolType toolType,
    float strokeUnitLengthCm,
    float pressure,
    float tiltRadians,
    float orientationRadians
)

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.

public boolean equals(Object other)

public final long getElapsedTimeMillis()

Time elapsed since the start of the stroke.

public final float getOrientationRadians()

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.

public final float getPressure()

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.

public final float getStrokeUnitLengthCm()

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.

public final float getTiltRadians()

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.

public final @NonNull InputToolType getToolType()

The input device used to generate this stroke input.

public final float getX()

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

public final float getY()

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

public final boolean hasOrientation()

Whether the orientationRadians field contains a valid orientation value.

public final boolean hasPressure()

Whether the pressure field contains a valid pressure value.

public final boolean hasTilt()

Whether the tiltRadians field contains a valid tilt value.

public int hashCode()

public @NonNull String toString()

public final void update(
    float x,
    float y,
    @IntRange(from = 0) long elapsedTimeMillis,
    @NonNull InputToolType toolType,
    float strokeUnitLengthCm,
    float pressure,
    float tiltRadians,
    float orientationRadians
)

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