# Print output for @column tags ?> Path - Android SDK | Android Developers

Most visited

Recently visited

Path

public class Path
extends Object

java.lang.Object
   ↳ android.graphics.Path


The Path class encapsulates compound (multiple contour) geometric paths consisting of straight line segments, quadratic curves, and cubic curves. It can be drawn with canvas.drawPath(path, paint), either filled or stroked (based on the paint's Style), or it can be used for clipping or to draw text on a path.

Summary

Nested classes

enum Path.Direction

Specifies how closed shapes (e.g. rects, ovals) are oriented when they are added to a path. 

enum Path.FillType

Enum for the ways a path may be filled. 

enum Path.Op

The logical operations that can be performed when combining two paths. 

Public constructors

Path()

Create an empty path

Path(Path src)

Create a new path, copying the contents from the src path.

Public methods

void addArc(float left, float top, float right, float bottom, float startAngle, float sweepAngle)

Add the specified arc to the path as a new contour.

void addArc(RectF oval, float startAngle, float sweepAngle)

Add the specified arc to the path as a new contour.

void addCircle(float x, float y, float radius, Path.Direction dir)

Add a closed circle contour to the path

void addOval(RectF oval, Path.Direction dir)

Add a closed oval contour to the path

void addOval(float left, float top, float right, float bottom, Path.Direction dir)

Add a closed oval contour to the path

void addPath(Path src, Matrix matrix)

Add a copy of src to the path, transformed by matrix

void addPath(Path src)

Add a copy of src to the path

void addPath(Path src, float dx, float dy)

Add a copy of src to the path, offset by (dx,dy)

void addRect(RectF rect, Path.Direction dir)

Add a closed rectangle contour to the path

void addRect(float left, float top, float right, float bottom, Path.Direction dir)

Add a closed rectangle contour to the path

void addRoundRect(RectF rect, float rx, float ry, Path.Direction dir)

Add a closed round-rectangle contour to the path

void addRoundRect(float left, float top, float right, float bottom, float rx, float ry, Path.Direction dir)

Add a closed round-rectangle contour to the path

void addRoundRect(RectF rect, float[] radii, Path.Direction dir)

Add a closed round-rectangle contour to the path.

void addRoundRect(float left, float top, float right, float bottom, float[] radii, Path.Direction dir)

Add a closed round-rectangle contour to the path.

float[] approximate(float acceptableError)

Approximate the Path with a series of line segments.

void arcTo(RectF oval, float startAngle, float sweepAngle, boolean forceMoveTo)

Append the specified arc to the path as a new contour.

void arcTo(float left, float top, float right, float bottom, float startAngle, float sweepAngle, boolean forceMoveTo)

Append the specified arc to the path as a new contour.

void arcTo(RectF oval, float startAngle, float sweepAngle)

Append the specified arc to the path as a new contour.

void close()

Close the current contour.

void computeBounds(RectF bounds, boolean exact)

Compute the bounds of the control points of the path, and write the answer into bounds.

void cubicTo(float x1, float y1, float x2, float y2, float x3, float y3)

Add a cubic bezier from the last point, approaching control points (x1,y1) and (x2,y2), and ending at (x3,y3).

Path.FillType getFillType()

Return the path's fill type.

void incReserve(int extraPtCount)

Hint to the path to prepare for adding more points.

boolean isConvex()

This method is deprecated. This method is not reliable. The way convexity is computed may change from release to release, and convexity could change based on a matrix as well. This method was useful when non-convex Paths were unable to be used in certain contexts, but that is no longer the case.

boolean isEmpty()

Returns true if the path is empty (contains no lines or curves)

boolean isInverseFillType()

Returns true if the filltype is one of the INVERSE variants

boolean isRect(RectF rect)

Returns true if the path specifies a rectangle.

void lineTo(float x, float y)

Add a line from the last point to the specified point (x,y).

void moveTo(float x, float y)

Set the beginning of the next contour to the point (x,y).

void offset(float dx, float dy, Path dst)

Offset the path by (dx,dy)

void offset(float dx, float dy)

Offset the path by (dx,dy)

boolean op(Path path1, Path path2, Path.Op op)

Set this path to the result of applying the Op to the two specified paths.

boolean op(Path path, Path.Op op)

Set this path to the result of applying the Op to this path and the specified path.

void quadTo(float x1, float y1, float x2, float y2)

Add a quadratic bezier from the last point, approaching control point (x1,y1), and ending at (x2,y2).

void rCubicTo(float x1, float y1, float x2, float y2, float x3, float y3)

Same as cubicTo, but the coordinates are considered relative to the current point on this contour.

void rLineTo(float dx, float dy)

Same as lineTo, but the coordinates are considered relative to the last point on this contour.

void rMoveTo(float dx, float dy)

Set the beginning of the next contour relative to the last point on the previous contour.

void rQuadTo(float dx1, float dy1, float dx2, float dy2)

Same as quadTo, but the coordinates are considered relative to the last point on this contour.

void reset()

Clear any lines and curves from the path, making it empty.

void rewind()

Rewinds the path: clears any lines and curves from the path but keeps the internal data structure for faster reuse.

void set(Path src)

Replace the contents of this with the contents of src.

void setFillType(Path.FillType ft)

Set the path's fill type.

void setLastPoint(float dx, float dy)

Sets the last point of the path.

void toggleInverseFillType()

Toggles the INVERSE state of the filltype

void transform(Matrix matrix, Path dst)

Transform the points in this path by matrix, and write the answer into dst.

void transform(Matrix matrix)

Transform the points in this path by matrix.

Inherited methods

Public constructors

Path

public Path ()

Create an empty path

Path

public Path (Path src)

Create a new path, copying the contents from the src path.

Parameters
src Path: The path to copy from when initializing the new path This value may be null.

Public methods

addArc

public void addArc (float left, 
                float top, 
                float right, 
                float bottom, 
                float startAngle, 
                float sweepAngle)

Add the specified arc to the path as a new contour.

Parameters
left float

top float

right float

bottom float

startAngle float: Starting angle (in degrees) where the arc begins

sweepAngle float: Sweep angle (in degrees) measured clockwise

addArc

public void addArc (RectF oval, 
                float startAngle, 
                float sweepAngle)

Add the specified arc to the path as a new contour.

Parameters
oval RectF: The bounds of oval defining the shape and size of the arc This value cannot be null.

startAngle float: Starting angle (in degrees) where the arc begins

sweepAngle float: Sweep angle (in degrees) measured clockwise

addCircle

public void addCircle (float x, 
                float y, 
                float radius, 
                Path.Direction dir)

Add a closed circle contour to the path

Parameters
x float: The x-coordinate of the center of a circle to add to the path

y float: The y-coordinate of the center of a circle to add to the path

radius float: The radius of a circle to add to the path

dir Path.Direction: The direction to wind the circle's contour This value cannot be null.

addOval

public void addOval (RectF oval, 
                Path.Direction dir)

Add a closed oval contour to the path

Parameters
oval RectF: The bounds of the oval to add as a closed contour to the path This value cannot be null.

dir Path.Direction: The direction to wind the oval's contour This value cannot be null.

addOval

public void addOval (float left, 
                float top, 
                float right, 
                float bottom, 
                Path.Direction dir)

Add a closed oval contour to the path

Parameters
left float

top float

right float

bottom float

dir Path.Direction: The direction to wind the oval's contour This value cannot be null.

addPath

public void addPath (Path src, 
                Matrix matrix)

Add a copy of src to the path, transformed by matrix

Parameters
src Path: The path to add as a new contour This value cannot be null.

matrix Matrix: This value cannot be null.

addPath

public void addPath (Path src)

Add a copy of src to the path

Parameters
src Path: The path that is appended to the current path This value cannot be null.

addPath

public void addPath (Path src, 
                float dx, 
                float dy)

Add a copy of src to the path, offset by (dx,dy)

Parameters
src Path: The path to add as a new contour This value cannot be null.

dx float: The amount to translate the path in X as it is added

dy float

addRect

public void addRect (RectF rect, 
                Path.Direction dir)

Add a closed rectangle contour to the path

Parameters
rect RectF: The rectangle to add as a closed contour to the path This value cannot be null.

dir Path.Direction: The direction to wind the rectangle's contour This value cannot be null.

addRect

public void addRect (float left, 
                float top, 
                float right, 
                float bottom, 
                Path.Direction dir)

Add a closed rectangle contour to the path

Parameters
left float: The left side of a rectangle to add to the path

top float: The top of a rectangle to add to the path

right float: The right side of a rectangle to add to the path

bottom float: The bottom of a rectangle to add to the path

dir Path.Direction: The direction to wind the rectangle's contour This value cannot be null.

addRoundRect

public void addRoundRect (RectF rect, 
                float rx, 
                float ry, 
                Path.Direction dir)

Add a closed round-rectangle contour to the path

Parameters
rect RectF: The bounds of a round-rectangle to add to the path This value cannot be null.

rx float: The x-radius of the rounded corners on the round-rectangle

ry float: The y-radius of the rounded corners on the round-rectangle

dir Path.Direction: The direction to wind the round-rectangle's contour This value cannot be null.

addRoundRect

public void addRoundRect (float left, 
                float top, 
                float right, 
                float bottom, 
                float rx, 
                float ry, 
                Path.Direction dir)

Add a closed round-rectangle contour to the path

Parameters
left float

top float

right float

bottom float

rx float: The x-radius of the rounded corners on the round-rectangle

ry float: The y-radius of the rounded corners on the round-rectangle

dir Path.Direction: The direction to wind the round-rectangle's contour This value cannot be null.

addRoundRect

public void addRoundRect (RectF rect, 
                float[] radii, 
                Path.Direction dir)

Add a closed round-rectangle contour to the path. Each corner receives two radius values [X, Y]. The corners are ordered top-left, top-right, bottom-right, bottom-left

Parameters
rect RectF: The bounds of a round-rectangle to add to the path This value cannot be null.

radii float: Array of 8 values, 4 pairs of [X,Y] radii This value cannot be null.

dir Path.Direction: The direction to wind the round-rectangle's contour This value cannot be null.

addRoundRect

public void addRoundRect (float left, 
                float top, 
                float right, 
                float bottom, 
                float[] radii, 
                Path.Direction dir)

Add a closed round-rectangle contour to the path. Each corner receives two radius values [X, Y]. The corners are ordered top-left, top-right, bottom-right, bottom-left

Parameters
left float

top float

right float

bottom float

radii float: Array of 8 values, 4 pairs of [X,Y] radii This value cannot be null.

dir Path.Direction: The direction to wind the round-rectangle's contour This value cannot be null.

approximate

public float[] approximate (float acceptableError)

Approximate the Path with a series of line segments. This returns float[] with the array containing point components. There are three components for each point, in order:

  • Fraction along the length of the path that the point resides
  • The x coordinate of the point
  • The y coordinate of the point

Two points may share the same fraction along its length when there is a move action within the Path.

Parameters
acceptableError float: The acceptable error for a line on the Path. Typically this would be 0.5 so that the error is less than half a pixel. Value is 0 or greater

Returns
float[] An array of components for points approximating the Path. This value cannot be null.

arcTo

public void arcTo (RectF oval, 
                float startAngle, 
                float sweepAngle, 
                boolean forceMoveTo)

Append the specified arc to the path as a new contour. If the start of the path is different from the path's current last point, then an automatic lineTo() is added to connect the current contour to the start of the arc. However, if the path is empty, then we call moveTo() with the first point of the arc.

Parameters
oval RectF: The bounds of oval defining shape and size of the arc This value cannot be null.

startAngle float: Starting angle (in degrees) where the arc begins

sweepAngle float: Sweep angle (in degrees) measured clockwise, treated mod 360.

forceMoveTo boolean: If true, always begin a new contour with the arc

arcTo

public void arcTo (float left, 
                float top, 
                float right, 
                float bottom, 
                float startAngle, 
                float sweepAngle, 
                boolean forceMoveTo)

Append the specified arc to the path as a new contour. If the start of the path is different from the path's current last point, then an automatic lineTo() is added to connect the current contour to the start of the arc. However, if the path is empty, then we call moveTo() with the first point of the arc.

Parameters
left float

top float

right float

bottom float

startAngle float: Starting angle (in degrees) where the arc begins

sweepAngle float: Sweep angle (in degrees) measured clockwise, treated mod 360.

forceMoveTo boolean: If true, always begin a new contour with the arc

arcTo

public void arcTo (RectF oval, 
                float startAngle, 
                float sweepAngle)

Append the specified arc to the path as a new contour. If the start of the path is different from the path's current last point, then an automatic lineTo() is added to connect the current contour to the start of the arc. However, if the path is empty, then we call moveTo() with the first point of the arc.

Parameters
oval RectF: The bounds of oval defining shape and size of the arc This value cannot be null.

startAngle float: Starting angle (in degrees) where the arc begins

sweepAngle float: Sweep angle (in degrees) measured clockwise

close

public void close ()

Close the current contour. If the current point is not equal to the first point of the contour, a line segment is automatically added.

computeBounds

public void computeBounds (RectF bounds, 
                boolean exact)

Compute the bounds of the control points of the path, and write the answer into bounds. If the path contains 0 or 1 points, the bounds is set to (0,0,0,0)

Parameters
bounds RectF: Returns the computed bounds of the path's control points. This value cannot be null.

exact boolean: This parameter is no longer used.

cubicTo

public void cubicTo (float x1, 
                float y1, 
                float x2, 
                float y2, 
                float x3, 
                float y3)

Add a cubic bezier from the last point, approaching control points (x1,y1) and (x2,y2), and ending at (x3,y3). If no moveTo() call has been made for this contour, the first point is automatically set to (0,0).

Parameters
x1 float: The x-coordinate of the 1st control point on a cubic curve

y1 float: The y-coordinate of the 1st control point on a cubic curve

x2 float: The x-coordinate of the 2nd control point on a cubic curve

y2 float: The y-coordinate of the 2nd control point on a cubic curve

x3 float: The x-coordinate of the end point on a cubic curve

y3 float: The y-coordinate of the end point on a cubic curve

getFillType

public Path.FillType getFillType ()

Return the path's fill type. This defines how "inside" is computed. The default value is WINDING.

Returns
Path.FillType the path's fill type This value cannot be null.

incReserve

public void incReserve (int extraPtCount)

Hint to the path to prepare for adding more points. This can allow the path to more efficiently allocate its storage.

Parameters
extraPtCount int: The number of extra points that may be added to this path

isConvex

public boolean isConvex ()

This method is deprecated.
This method is not reliable. The way convexity is computed may change from release to release, and convexity could change based on a matrix as well. This method was useful when non-convex Paths were unable to be used in certain contexts, but that is no longer the case.

Returns the path's convexity, as defined by the content of the path.

A path is convex if it has a single contour, and only ever curves in a single direction.

This function will calculate the convexity of the path from its control points, and cache the result.

Returns
boolean True if the path is convex.

isEmpty

public boolean isEmpty ()

Returns true if the path is empty (contains no lines or curves)

Returns
boolean true if the path is empty (contains no lines or curves)

isInverseFillType

public boolean isInverseFillType ()

Returns true if the filltype is one of the INVERSE variants

Returns
boolean true if the filltype is one of the INVERSE variants

isRect

public boolean isRect (RectF rect)

Returns true if the path specifies a rectangle. If so, and if rect is not null, set rect to the bounds of the path. If the path does not specify a rectangle, return false and ignore rect.

Parameters
rect RectF: If not null, returns the bounds of the path if it specifies a rectangle This value may be null.

Returns
boolean true if the path specifies a rectangle

lineTo

public void lineTo (float x, 
                float y)

Add a line from the last point to the specified point (x,y). If no moveTo() call has been made for this contour, the first point is automatically set to (0,0).

Parameters
x float: The x-coordinate of the end of a line

y float: The y-coordinate of the end of a line

moveTo

public void moveTo (float x, 
                float y)

Set the beginning of the next contour to the point (x,y).

Parameters
x float: The x-coordinate of the start of a new contour

y float: The y-coordinate of the start of a new contour

offset

public void offset (float dx, 
                float dy, 
                Path dst)

Offset the path by (dx,dy)

Parameters
dx float: The amount in the X direction to offset the entire path

dy float: The amount in the Y direction to offset the entire path

dst Path: The translated path is written here. If this is null, then the original path is modified. This value may be null.

offset

public void offset (float dx, 
                float dy)

Offset the path by (dx,dy)

Parameters
dx float: The amount in the X direction to offset the entire path

dy float: The amount in the Y direction to offset the entire path

op

public boolean op (Path path1, 
                Path path2, 
                Path.Op op)

Set this path to the result of applying the Op to the two specified paths. The resulting path will be constructed from non-overlapping contours. The curve order is reduced where possible so that cubics may be turned into quadratics, and quadratics maybe turned into lines.

Parameters
path1 Path: The first operand (for difference, the minuend) This value cannot be null.

path2 Path: The second operand (for difference, the subtrahend) This value cannot be null.

op Path.Op: This value cannot be null.

Returns
boolean True if operation succeeded, false otherwise and this path remains unmodified.

See also:

op

public boolean op (Path path, 
                Path.Op op)

Set this path to the result of applying the Op to this path and the specified path. The resulting path will be constructed from non-overlapping contours. The curve order is reduced where possible so that cubics may be turned into quadratics, and quadratics maybe turned into lines.

Parameters
path Path: The second operand (for difference, the subtrahend) This value cannot be null.

op Path.Op: This value cannot be null.

Returns
boolean True if operation succeeded, false otherwise and this path remains unmodified.

See also:

quadTo

public void quadTo (float x1, 
                float y1, 
                float x2, 
                float y2)

Add a quadratic bezier from the last point, approaching control point (x1,y1), and ending at (x2,y2). If no moveTo() call has been made for this contour, the first point is automatically set to (0,0).

Parameters
x1 float: The x-coordinate of the control point on a quadratic curve

y1 float: The y-coordinate of the control point on a quadratic curve

x2 float: The x-coordinate of the end point on a quadratic curve

y2 float: The y-coordinate of the end point on a quadratic curve

rCubicTo

public void rCubicTo (float x1, 
                float y1, 
                float x2, 
                float y2, 
                float x3, 
                float y3)

Same as cubicTo, but the coordinates are considered relative to the current point on this contour. If there is no previous point, then a moveTo(0,0) is inserted automatically.

Parameters
x1 float

y1 float

x2 float

y2 float

x3 float

y3 float

rLineTo

public void rLineTo (float dx, 
                float dy)

Same as lineTo, but the coordinates are considered relative to the last point on this contour. If there is no previous point, then a moveTo(0,0) is inserted automatically.

Parameters
dx float: The amount to add to the x-coordinate of the previous point on this contour, to specify a line

dy float: The amount to add to the y-coordinate of the previous point on this contour, to specify a line

rMoveTo

public void rMoveTo (float dx, 
                float dy)

Set the beginning of the next contour relative to the last point on the previous contour. If there is no previous contour, this is treated the same as moveTo().

Parameters
dx float: The amount to add to the x-coordinate of the end of the previous contour, to specify the start of a new contour

dy float: The amount to add to the y-coordinate of the end of the previous contour, to specify the start of a new contour

rQuadTo

public void rQuadTo (float dx1, 
                float dy1, 
                float dx2, 
                float dy2)

Same as quadTo, but the coordinates are considered relative to the last point on this contour. If there is no previous point, then a moveTo(0,0) is inserted automatically.

Parameters
dx1 float: The amount to add to the x-coordinate of the last point on this contour, for the control point of a quadratic curve

dy1 float: The amount to add to the y-coordinate of the last point on this contour, for the control point of a quadratic curve

dx2 float: The amount to add to the x-coordinate of the last point on this contour, for the end point of a quadratic curve

dy2 float: The amount to add to the y-coordinate of the last point on this contour, for the end point of a quadratic curve

reset

public void reset ()

Clear any lines and curves from the path, making it empty. This does NOT change the fill-type setting.

rewind

public void rewind ()

Rewinds the path: clears any lines and curves from the path but keeps the internal data structure for faster reuse.

set

public void set (Path src)

Replace the contents of this with the contents of src.

Parameters
src Path: This value cannot be null.

setFillType

public void setFillType (Path.FillType ft)

Set the path's fill type. This defines how "inside" is computed.

Parameters
ft Path.FillType: The new fill type for this path This value cannot be null.

setLastPoint

public void setLastPoint (float dx, 
                float dy)

Sets the last point of the path.

Parameters
dx float: The new X coordinate for the last point

dy float: The new Y coordinate for the last point

toggleInverseFillType

public void toggleInverseFillType ()

Toggles the INVERSE state of the filltype

transform

public void transform (Matrix matrix, 
                Path dst)

Transform the points in this path by matrix, and write the answer into dst. If dst is null, then the the original path is modified.

Parameters
matrix Matrix: The matrix to apply to the path This value cannot be null.

dst Path: The transformed path is written here. If dst is null, then the the original path is modified This value may be null.

transform

public void transform (Matrix matrix)

Transform the points in this path by matrix.

Parameters
matrix Matrix: The matrix to apply to the path This value cannot be null.