MutableStrokeInputBatch

public final class MutableStrokeInputBatch extends StrokeInputBatch

java.lang.Object
   ↳ androidx.ink.strokes.StrokeInputBatch
     ↳ androidx.ink.strokes.MutableStrokeInputBatch

A mutable implementation of StrokeInputBatch. For an immutable alternative, see ImmutableStrokeInputBatch.

Each appended StrokeInput value is validated compared to the existing batch contents. This means:

  1. All floating point values are required to be finite and the format of all inputs must be consistent. This means all inputs must have the same set of optional member variables that hold a value. For example, every input holds a pressure value if-and-only-if every other input holds a pressure value. This is also true for tiltRadians and orientationRadians.

  2. The sequence of StrokeInput values must not contain repeated x-y-t triplets, and the time values must be non-negative and non-decreasing.

  3. Values of strokeUnitLengthCm must be finite and positive, or be StrokeInput.NO_STROKE_UNIT_LENGTH.

  4. Values of StrokeInput.pressure must fall within the range of 0, 1 or be StrokeInput.NO_PRESSURE

  5. Values of StrokeInput.tiltRadians must fall within the range of 0, π/2 or be StrokeInput.NO_TILT.

  6. Values of StrokeInput.orientationRadians must fall within the range of [0, 2π) or be StrokeInput.NO_ORIENTATION.

  7. The toolType and strokeUnitLengthCm values must be the same across all inputs.

Summary

Public constructors

Public methods
final @NonNull MutableStrokeInputBatch

Validates and appends an inputBatch.
final @NonNull MutableStrokeInputBatch

Validates and appends an input.
final @NonNull MutableStrokeInputBatch

Validates and appends a collection of StrokeInput.
final @NonNull MutableStrokeInputBatch
addOrIgnore(
    @NonNull InputToolType type,
    float x,
    float y,
    long elapsedTimeMillis,
    float strokeUnitLengthCm,
    float pressure,
    float tiltRadians,
    float orientationRadians
)

Validates and appends an input.
final @NonNull MutableStrokeInputBatch

Validates and appends an inputBatch.
final @NonNull MutableStrokeInputBatch

Validates and appends an input.
final @NonNull MutableStrokeInputBatch

Validates and appends a collection of StrokeInput.
final @NonNull MutableStrokeInputBatch
addOrThrow(
    @NonNull InputToolType type,
    float x,
    float y,
    long elapsedTimeMillis,
    float strokeUnitLengthCm,
    float pressure,
    float tiltRadians,
    float orientationRadians
)

Validates and appends an input.
final void
final void

Sets the per-stroke seed value that should be used when regenerating a stroke from this input batch.
@NonNull String

Inherited methods
From androidx.ink.strokes.StrokeInputBatch
final void
final @NonNull StrokeInput
get(int index)

Gets the value of the i-th input.
final long

The duration between the first and last input in milliseconds.
final int

Number of StrokeInput objects in the batch.
final float

The physical distance in centimeters that the pointer must travel in order to produce an input motion of one stroke unit.
final @NonNull InputToolType

How this input stream should be interpreted, as coming from a InputToolType.MOUSE, InputToolType.TOUCH, or InputToolType.STYLUS.
final boolean

Whether all of the individual inputs have a defined value for StrokeInput.orientationRadians.
final boolean

Whether all of the individual inputs have a defined value for StrokeInput.pressure.
final boolean

Whether strokeUnitLengthCm has a valid value, which is something other than StrokeInput.NO_STROKE_UNIT_LENGTH.
final boolean

Whether all of the individual inputs have a defined value for StrokeInput.tiltRadians.
final boolean

true if there are no StrokeInput objects in the batch, and false otherwise.
final @NonNull StrokeInput
populate(int index, @NonNull StrokeInput outStrokeInput)

Gets the value of the i-th input and overwrites outStrokeInput, which it then returns.

Public constructors

MutableStrokeInputBatch

Added in 1.0.0-alpha04
public MutableStrokeInputBatch()

Public methods

addOrIgnore

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrIgnore(@NonNull StrokeInputBatch inputBatch)

Validates and appends an inputBatch. Invalid inputBatch will result in no change. No exception will be thrown for invalid additions.

addOrIgnore

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrIgnore(@NonNull StrokeInput input)

Validates and appends an input. Invalid input will result in no change. No exception will be thrown for invalid additions.

addOrIgnore

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrIgnore(@NonNull Collection<@NonNull StrokeInput> inputs)

Validates and appends a collection of StrokeInput. Invalid inputs will result in no change. No exception will be thrown for invalid additions.

addOrIgnore

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrIgnore(
    @NonNull InputToolType type,
    float x,
    float y,
    long elapsedTimeMillis,
    float strokeUnitLengthCm,
    float pressure,
    float tiltRadians,
    float orientationRadians
)

Validates and appends an input. Invalid input will result in no change. No exception will be thrown for invalid additions.

addOrThrow

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrThrow(@NonNull StrokeInputBatch inputBatch)

Validates and appends an inputBatch. Invalid inputBatch will result in no change. An exception will be thrown for invalid additions.

addOrThrow

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrThrow(@NonNull StrokeInput input)

Validates and appends an input. Invalid input will result in no change. An exception will be thrown for invalid additions.

addOrThrow

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrThrow(@NonNull Collection<@NonNull StrokeInput> inputs)

Validates and appends a collection of StrokeInput. Invalid inputs will result in no change. An exception will be thrown for invalid additions.

addOrThrow

Added in 1.0.0-alpha04
public final @NonNull MutableStrokeInputBatch addOrThrow(
    @NonNull InputToolType type,
    float x,
    float y,
    long elapsedTimeMillis,
    float strokeUnitLengthCm,
    float pressure,
    float tiltRadians,
    float orientationRadians
)

Validates and appends an input. Invalid input will result in no change. An exception will be thrown for invalid additions.

clear

Added in 1.0.0-alpha04
public final void clear()

setNoiseSeed

Added in 1.0.0-alpha04
@ExperimentalInkCustomBrushApi
public final void setNoiseSeed(int seed)

Sets the per-stroke seed value that should be used when regenerating a stroke from this input batch.

toString

public @NonNull String toString()