BrushTip

fun builder(): BrushTip.Builder

Returns a new BrushTip.Builder.

BrushTip(
    scaleX: @FloatRange(from = 0.0, toInclusive = false) Float = 1.0f,
    scaleY: @FloatRange(from = 0.0, toInclusive = false) Float = 1.0f,
    cornerRounding: @FloatRange(from = 0.0, to = 1.0) Float = 1.0f,
    slantDegrees: @FloatRange(from = -90.0, to = 90.0) @AngleDegreesFloat Float = 0.0f,
    pinch: @FloatRange(from = 0.0, to = 1.0) Float = 0.0f,
    rotationDegrees: @AngleDegreesFloat Float = 0.0f,
    particleGapDistanceScale: @FloatRange(from = 0.0, toInclusive = false) Float = 0.0f,
    particleGapDurationMillis: @IntRange(from = 0) Long = 0,
    behaviors: List<BrushBehavior> = emptyList()
)

Constructs a new BrushTip with the given attributes.

fun copy(
    scaleX: @FloatRange(from = 0.0, toInclusive = false) Float = this.scaleX,
    scaleY: @FloatRange(from = 0.0, toInclusive = false) Float = this.scaleY,
    cornerRounding: @FloatRange(from = 0.0, to = 1.0) Float = this.cornerRounding,
    slantDegrees: @FloatRange(from = -90.0, to = 90.0) @AngleDegreesFloat Float = this.slantDegrees,
    pinch: @FloatRange(from = 0.0, to = 1.0) Float = this.pinch,
    rotationDegrees: @AngleDegreesFloat Float = this.rotationDegrees,
    particleGapDistanceScale: @FloatRange(from = 0.0, toInclusive = false) Float = this.particleGapDistanceScale,
    particleGapDurationMillis: @IntRange(from = 0) Long = this.particleGapDurationMillis,
    behaviors: List<BrushBehavior> = this.behaviors
): BrushTip

Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.

Java callers should use Builder instead.

fun toBuilder(): BrushTip.Builder

Returns a Builder with values set equivalent to this. Java developers, use the returned builder to build a copy of a BrushTip. Kotlin developers, see copy method.

val behaviors: List<BrushBehavior>

An immutable list of BrushBehaviors that allow dynamic properties of each input to augment the tip shape and color.

val cornerRounding: Float

A normalized value in the range 0, 1 that is used to calculate the initial radius of curvature for the tip's corners. A value of 0 results in sharp corners and a value of 1 results in the maximum radius of curvature given the current tip dimensions.

val particleGapDistanceScale: Float

Parameter controlling emission of particles as a function of distance traveled by the stroke inputs.

When this and particleGapDurationMillis are both zero, the stroke will be continuous, unless gaps are introduced dynamically by BrushBehaviors. Otherwise, the stroke will be made up of particles. A new particle will be emitted after at least particleGapDistanceScale * Brush.size distance has been traveled by the stoke inputs.

val particleGapDurationMillis: Long

Parameter controlling emission of particles as a function of time elapsed along the stroke.

When this and particleGapDistanceScale are both zero, the stroke will be continuous, unless gaps are introduced dynamically by BrushBehaviors. Otherwise, the stroke will be made up of particles. Particles will be emitted at most once every particleGapDurationMillis.

val pinch: Float

A unitless parameter in the range 0, 1 that controls the separation between two of the shape's corners prior to applying rotationDegrees.

The two corners affected lie toward the negative y-axis relative to the center of the tip shape. I.e. the "upper edge" of the shape if positive y is chosen to point "down" in stroke coordinates.

If scaleX is not 0, different values of pinch produce the following shapes: A value of 0 will leave the corners unaffected as a rectangle or parallelogram. Values between 0 and 1 will bring the corners closer together to result in a (possibly slanted) trapezoidal shape. A value of 1 will make the two corners coincide and result in a triangular shape.

val rotationDegrees: Float

Angle in degrees specifying the initial rotation of the tip shape after applying scaleX, scaleY, pinch, and slantDegrees. The rotation is in the direction from the positive x-axis towards the positive y-axis.

val scaleX: Float

2D scale used to calculate the initial width and height of the tip shape relative to the brush size prior to applying slantDegrees and rotationDegrees.

The base width and height of the tip will be equal to the brush size multiplied by scaleX and scaleY respectively. Valid values must be finite and non-negative, with at least one value greater than zero.

val scaleY: Float

2D scale used to calculate the initial width and height of the tip shape relative to the brush size prior to applying slantDegrees and rotationDegrees.

The base width and height of the tip will be equal to the brush size multiplied by scaleX and scaleY respectively. Valid values must be finite and non-negative, with at least one value greater than zero.

val slantDegrees: Float

Angle in degrees used to calculate the initial slant of the tip shape prior to applying rotationDegrees.

The value should be in the range -90, 90 degrees, and represents the angle by which "vertical" lines of the tip shape will appear rotated about their intersection with the x-axis. A positive value will rotate from the positive x-axis towards the positive y-axis.

More info: This property is similar to the single-arg CSS skew() transformation. Unlike skew, slant tries to preserve the perimeter of the tip shape as opposed to its area. This is akin to "pressing" a rectangle into a parallelogram with non-right angles while preserving the side lengths.