PathMeasure

Interface

Common
@JvmDefaultWithCompatibility
interface PathMeasure

Properties

Common
val length: Float

The total length of the current contour, or 0 if no path is associated with this measure object.

Functions

fun getSegment(
        startDistance: Float,
        stopDistance: Float,
        destination: Path,
        startWithMoveTo: Boolean = true,
    ): Boolean

Given a start and stop distance, return in dst the intervening segment(s). If the segment is zero-length, return false, else return true. startD and stopD are pinned to legal values (0..getLength()). If startD >= stopD then return false (and leave dst untouched). Begin the segment with a moveTo if startWithMoveTo is true.

fun setPath(path: Path?, forceClosed: Boolean)

Assign a new path, or null to have none.

fun getPosition(distance: Float): Offset

Pins distance to 0 <= distance <= getLength(), and then computes the corresponding position

Parameters

distanceThe distance along the current contour to sample

Returns

Offset.Unspecified if there is no path set
fun getTangent(distance: Float): Offset

Pins distance to 0 <= distance <= getLength(), and then computes the corresponding tangent

Parameters

distanceThe distance along the current contour to sample

Returns

Offset.Unspecified if there is no path set