AndroidPathMeasure

Artifact: androidx.compose.ui:ui-graphics

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• android

  class AndroidPathMeasure : PathMeasure

---

Summary

Public functions
open Offset	getPosition(distance: Float) Pins distance to 0 <= distance <= getLength(), and then computes the corresponding position	android
open Boolean	getSegment(     startDistance: Float,     stopDistance: Float,     destination: Path,     startWithMoveTo: Boolean ) Given a start and stop distance, return in dst the intervening segment(s).	android
open Offset	getTangent(distance: Float) Pins distance to 0 <= distance <= getLength(), and then computes the corresponding tangent	android
open Unit	setPath(path: Path?, forceClosed: Boolean) Assign a new path, or null to have none.	android

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

Public functions

getPosition

android

Added in 1.8.0-alpha07

open fun getPosition(distance: Float): Offset

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

Parameters
distance: Float	The distance along the current contour to sample

Returns
Offset	Offset.Unspecified if there is no path set

getSegment

android

Added in 1.8.0-alpha07

open fun getSegment(
    startDistance: Float,
    stopDistance: Float,
    destination: Path,
    startWithMoveTo: Boolean
): 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.

getTangent

android

Added in 1.8.0-alpha07

open fun getTangent(distance: Float): Offset

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

Parameters
distance: Float	The distance along the current contour to sample

Returns
Offset	Offset.Unspecified if there is no path set

setPath

android

Added in 1.8.0-alpha07

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

Assign a new path, or null to have none.

Public properties

length

android

Added in 1.8.0-alpha07

open val length: Float

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