Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/graphics/PathMeasure#constants) \| [Ctors](https://developer.android.com/reference/android/graphics/PathMeasure#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/PathMeasure#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/graphics/PathMeasure#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/PathMeasure#inhmethods)

# PathMeasure

*** ** * ** ***


`
public


class
PathMeasure
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.graphics.PathMeasure |

<br />

*** ** * ** ***

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/graphics/PathMeasure#POSITION_MATRIX_FLAG` |
| `int` | `https://developer.android.com/reference/android/graphics/PathMeasure#TANGENT_MATRIX_FLAG` |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/PathMeasure#PathMeasure()() ` Create an empty PathMeasure object. |
| ` https://developer.android.com/reference/android/graphics/PathMeasure#PathMeasure(android.graphics.Path,%20boolean)(https://developer.android.com/reference/android/graphics/Path path, boolean forceClosed) ` Create a PathMeasure object associated with the specified path object (already created and specified). |

| ### Public methods ||
|---|---|
| ` float` | ` https://developer.android.com/reference/android/graphics/PathMeasure#getLength()() ` Return the total length of the current contour, or 0 if no path is associated with this measure object. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/PathMeasure#getMatrix(float,%20android.graphics.Matrix,%20int)(float distance, https://developer.android.com/reference/android/graphics/Matrix matrix, int flags) ` Pins distance to 0 \<= distance \<= getLength(), and then computes the corresponding matrix. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/PathMeasure#getPosTan(float,%20float[],%20float[])(float distance, float[] pos, float[] tan) ` Pins distance to 0 \<= distance \<= getLength(), and then computes the corresponding position and tangent. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/PathMeasure#getSegment(float,%20float,%20android.graphics.Path,%20boolean)(float startD, float stopD, https://developer.android.com/reference/android/graphics/Path dst, boolean startWithMoveTo) ` Given a start and stop distance, append to dst the intervening segment(s). |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/PathMeasure#isClosed()() ` Return true if the current contour is closed() |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/PathMeasure#nextContour()() ` Move to the next contour in the path. |
| ` void` | ` https://developer.android.com/reference/android/graphics/PathMeasure#setPath(android.graphics.Path,%20boolean)(https://developer.android.com/reference/android/graphics/Path path, boolean forceClosed) ` Assign a new path, or null to have none. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/PathMeasure#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Constants

### POSITION_MATRIX_FLAG

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int POSITION_MATRIX_FLAG
```

<br />

<br />

Constant Value:

1
(0x00000001)


### TANGENT_MATRIX_FLAG

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int TANGENT_MATRIX_FLAG
```

<br />

<br />

Constant Value:

2
(0x00000002)


## Public constructors

### PathMeasure

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PathMeasure ()
```

Create an empty PathMeasure object. To uses this to measure the length
of a path, and/or to find the position and tangent along it, call
setPath.

Note that once a path is associated with the measure object, it is
undefined if the path is subsequently modified and the measure object
is used. If the path is modified, you must call setPath with the path.

<br />

### PathMeasure

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PathMeasure (Path path, 
                boolean forceClosed)
```

Create a PathMeasure object associated with the specified path object
(already created and specified). The measure object can now return the
path's length, and the position and tangent of any position along the
path.

Note that once a path is associated with the measure object, it is
undefined if the path is subsequently modified and the measure object
is used. If the path is modified, you must call setPath with the path.

<br />

| Parameters ||
|---|---|
| `path` | `Path`: The path that will be measured by this object <br /> |
| `forceClosed` | `boolean`: If true, then the path will be considered as "closed" even if its contour was not explicitly closed. <br /> |

## Public methods

### getLength

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getLength ()
```

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

<br />

| Returns ||
|---|---|
| `float` | <br /> |

### getMatrix

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getMatrix (float distance, 
                Matrix matrix, 
                int flags)
```

Pins distance to 0 \<= distance \<= getLength(), and then computes the
corresponding matrix. Returns false if there is no path, or a zero-length
path was specified, in which case matrix is unchanged.

<br />

| Parameters ||
|---|---|
| `distance` | `float`: The distance along the associated path <br /> |
| `matrix` | `Matrix`: Allocated by the caller, this is set to the transformation associated with the position and tangent at the specified distance <br /> |
| `flags` | `int`: Specified what aspects should be returned in the matrix. <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### getPosTan

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getPosTan (float distance, 
                float[] pos, 
                float[] tan)
```

Pins distance to 0 \<= distance \<= getLength(), and then computes the
corresponding position and tangent. Returns false if there is no path,
or a zero-length path was specified, in which case position and tangent
are unchanged.

<br />

| Parameters ||
|---|---|
| `distance` | `float`: The distance along the current contour to sample <br /> |
| `pos` | `float`: If not null, returns the sampled position (x==\[0\], y==\[1\]) <br /> |
| `tan` | `float`: If not null, returns the sampled tangent (x==\[0\], y==\[1\]) <br /> |

| Returns ||
|---|---|
| `boolean` | false if there was no path associated with this measure object <br /> |

### getSegment

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getSegment (float startD, 
                float stopD, 
                Path dst, 
                boolean startWithMoveTo)
```

Given a start and stop distance, append to 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.

On `https://developer.android.com/reference/android/os/Build.VERSION_CODES#KITKAT` and earlier
releases, the resulting path may not display on a hardware-accelerated
Canvas. A simple workaround is to add a single operation to this path,
such as `dst.rLineTo(0, 0)`.

<br />

<br />

| Parameters ||
|---|---|
| `startD` | `float` <br /> |
| `stopD` | `float` <br /> |
| `dst` | `Path` <br /> |
| `startWithMoveTo` | `boolean` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### isClosed

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isClosed ()
```

Return true if the current contour is closed()

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### nextContour

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean nextContour ()
```

Move to the next contour in the path. Return true if one exists, or
false if we're done with the path.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### setPath

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setPath (Path path, 
                boolean forceClosed)
```

Assign a new path, or null to have none.

<br />

| Parameters ||
|---|---|
| `path` | `Path` <br /> |
| `forceClosed` | `boolean` <br /> |

## Protected methods

### finalize

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected void finalize ()
```

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
A subclass overrides the `finalize` method to dispose of
system resources or to perform other cleanup.


The general contract of `finalize` is that it is invoked
if and when the Java virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The `finalize` method may take any action, including
making this object available again to other threads; the usual purpose
of `finalize`, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.


The `finalize` method of class `Object` performs no
special action; it simply returns normally. Subclasses of
`Object` may override this definition.


The Java programming language does not guarantee which thread will
invoke the `finalize` method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.


After the `finalize` method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.


The `finalize` method is never invoked more than once by a Java
virtual machine for any given object.


Any exception thrown by the `finalize` method causes
the finalization of this object to be halted, but is otherwise
ignored.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/Throwable` |   |