* 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.
*
* @return True if the path is convex.
*
* @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.
*/
@Deprecated
public boolean isConvex() {
return nIsConvex(mNativePath);
}
/**
* Enum for the ways a path may be filled.
*/
public enum FillType {
// these must match the values in SkPath.h
/**
* Specifies that "inside" is computed by a non-zero sum of signed
* edge crossings.
*/
WINDING (0),
/**
* Specifies that "inside" is computed by an odd number of edge
* crossings.
*/
EVEN_ODD (1),
/**
* Same as {@link #WINDING}, but draws outside of the path, rather than inside.
*/
INVERSE_WINDING (2),
/**
* Same as {@link #EVEN_ODD}, but draws outside of the path, rather than inside.
*/
INVERSE_EVEN_ODD(3);
FillType(int ni) {
nativeInt = ni;
}
final int nativeInt;
}
// these must be in the same order as their native values
static final FillType[] sFillTypeArray = {
FillType.WINDING,
FillType.EVEN_ODD,
FillType.INVERSE_WINDING,
FillType.INVERSE_EVEN_ODD
};
/**
* Return the path's fill type. This defines how "inside" is
* computed. The default value is WINDING.
*
* @return the path's fill type
*/
@NonNull
public FillType getFillType() {
return sFillTypeArray[nGetFillType(mNativePath)];
}
/**
* Set the path's fill type. This defines how "inside" is computed.
*
* @param ft The new fill type for this path
*/
public void setFillType(@NonNull FillType ft) {
nSetFillType(mNativePath, ft.nativeInt);
}
/**
* Returns true if the filltype is one of the INVERSE variants
*
* @return true if the filltype is one of the INVERSE variants
*/
public boolean isInverseFillType() {
final int ft = nGetFillType(mNativePath);
return (ft & FillType.INVERSE_WINDING.nativeInt) != 0;
}
/**
* Toggles the INVERSE state of the filltype
*/
public void toggleInverseFillType() {
int ft = nGetFillType(mNativePath);
ft ^= FillType.INVERSE_WINDING.nativeInt;
nSetFillType(mNativePath, ft);
}
/**
* Returns true if the path is empty (contains no lines or curves)
*
* @return true if the path is empty (contains no lines or curves)
*/
public boolean isEmpty() {
return nIsEmpty(mNativePath);
}
/**
* 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.
*
* @param rect If not null, returns the bounds of the path if it specifies
* a rectangle
* @return true if the path specifies a rectangle
*/
public boolean isRect(@Nullable RectF rect) {
return nIsRect(mNativePath, rect);
}
/**
* 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)
*
* @param bounds Returns the computed bounds of the path's control points.
* @param exact This parameter is no longer used.
*
* @deprecated use computeBounds(RectF) instead
*/
@Deprecated
@SuppressWarnings({"UnusedDeclaration"})
public void computeBounds(@NonNull RectF bounds, boolean exact) {
computeBounds(bounds);
}
/**
* 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)
*
* @param bounds Returns the computed bounds of the path's control points.
*/
@FlaggedApi(Flags.FLAG_EXACT_COMPUTE_BOUNDS)
public void computeBounds(@NonNull RectF bounds) {
nComputeBounds(mNativePath, bounds);
}
/**
* Hint to the path to prepare for adding more points. This can allow the
* path to more efficiently allocate its storage.
*
* @param extraPtCount The number of extra points that may be added to this
* path
*/
public void incReserve(int extraPtCount) {
nIncReserve(mNativePath, extraPtCount);
}
/**
* Set the beginning of the next contour to the point (x,y).
*
* @param x The x-coordinate of the start of a new contour
* @param y The y-coordinate of the start of a new contour
*/
public void moveTo(float x, float y) {
nMoveTo(mNativePath, x, y);
}
/**
* 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().
*
* @param dx The amount to add to the x-coordinate of the end of the
* previous contour, to specify the start of a new contour
* @param dy The amount to add to the y-coordinate of the end of the
* previous contour, to specify the start of a new contour
*/
public void rMoveTo(float dx, float dy) {
nRMoveTo(mNativePath, dx, dy);
}
/**
* 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).
*
* @param x The x-coordinate of the end of a line
* @param y The y-coordinate of the end of a line
*/
public void lineTo(float x, float y) {
nLineTo(mNativePath, x, y);
}
/**
* 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.
*
* @param dx The amount to add to the x-coordinate of the previous point on
* this contour, to specify a line
* @param dy The amount to add to the y-coordinate of the previous point on
* this contour, to specify a line
*/
public void rLineTo(float dx, float dy) {
nRLineTo(mNativePath, dx, dy);
}
/**
* 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).
*
* @param x1 The x-coordinate of the control point on a quadratic curve
* @param y1 The y-coordinate of the control point on a quadratic curve
* @param x2 The x-coordinate of the end point on a quadratic curve
* @param y2 The y-coordinate of the end point on a quadratic curve
*/
public void quadTo(float x1, float y1, float x2, float y2) {
nQuadTo(mNativePath, x1, y1, x2, y2);
}
/**
* 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.
*
* @param dx1 The amount to add to the x-coordinate of the last point on
* this contour, for the control point of a quadratic curve
* @param dy1 The amount to add to the y-coordinate of the last point on
* this contour, for the control point of a quadratic curve
* @param dx2 The amount to add to the x-coordinate of the last point on
* this contour, for the end point of a quadratic curve
* @param dy2 The amount to add to the y-coordinate of the last point on
* this contour, for the end point of a quadratic curve
*/
public void rQuadTo(float dx1, float dy1, float dx2, float dy2) {
nRQuadTo(mNativePath, dx1, dy1, dx2, dy2);
}
/**
* Add a quadratic bezier from the last point, approaching control point
* (x1,y1), and ending at (x2,y2), weighted by weight. If no
* moveTo() call has been made for this contour, the first point is
* automatically set to (0,0).
*
* A weight of 1 is equivalent to calling {@link #quadTo(float, float, float, float)}.
* A weight of 0 is equivalent to calling {@link #lineTo(float, float)} to
* (x1, y1) followed by {@link #lineTo(float, float)} to (x2, y2).
*
* @param x1 The x-coordinate of the control point on a conic curve
* @param y1 The y-coordinate of the control point on a conic curve
* @param x2 The x-coordinate of the end point on a conic curve
* @param y2 The y-coordinate of the end point on a conic curve
* @param weight The weight of the conic applied to the curve. A value of 1 is equivalent
* to a quadratic with the given control and anchor points and a value of 0 is
* equivalent to a line to the first and another line to the second point.
*/
public void conicTo(float x1, float y1, float x2, float y2, float weight) {
nConicTo(mNativePath, x1, y1, x2, y2, weight);
}
/**
* Same as conicTo, 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.
*
* @param dx1 The amount to add to the x-coordinate of the last point on
* this contour, for the control point of a conic curve
* @param dy1 The amount to add to the y-coordinate of the last point on
* this contour, for the control point of a conic curve
* @param dx2 The amount to add to the x-coordinate of the last point on
* this contour, for the end point of a conic curve
* @param dy2 The amount to add to the y-coordinate of the last point on
* this contour, for the end point of a conic curve
* @param weight The weight of the conic applied to the curve. A value of 1 is equivalent
* to a quadratic with the given control and anchor points and a value of 0 is
* equivalent to a line to the first and another line to the second point.
*/
public void rConicTo(float dx1, float dy1, float dx2, float dy2, float weight) {
nRConicTo(mNativePath, dx1, dy1, dx2, dy2, weight);
}
/**
* 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).
*
* @param x1 The x-coordinate of the 1st control point on a cubic curve
* @param y1 The y-coordinate of the 1st control point on a cubic curve
* @param x2 The x-coordinate of the 2nd control point on a cubic curve
* @param y2 The y-coordinate of the 2nd control point on a cubic curve
* @param x3 The x-coordinate of the end point on a cubic curve
* @param y3 The y-coordinate of the end point on a cubic curve
*/
public void cubicTo(float x1, float y1, float x2, float y2,
float x3, float y3) {
nCubicTo(mNativePath, x1, y1, x2, y2, x3, 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.
*/
public void rCubicTo(float x1, float y1, float x2, float y2,
float x3, float y3) {
nRCubicTo(mNativePath, x1, y1, x2, y2, x3, y3);
}
/**
* 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.
*
* @param oval The bounds of oval defining shape and size of the arc
* @param startAngle Starting angle (in degrees) where the arc begins
* @param sweepAngle Sweep angle (in degrees) measured clockwise, treated
* mod 360.
* @param forceMoveTo If true, always begin a new contour with the arc
*/
public void arcTo(@NonNull RectF oval, float startAngle, float sweepAngle,
boolean forceMoveTo) {
arcTo(oval.left, oval.top, oval.right, oval.bottom, startAngle, sweepAngle, 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.
*
* @param oval The bounds of oval defining shape and size of the arc
* @param startAngle Starting angle (in degrees) where the arc begins
* @param sweepAngle Sweep angle (in degrees) measured clockwise
*/
public void arcTo(@NonNull RectF oval, float startAngle, float sweepAngle) {
arcTo(oval.left, oval.top, oval.right, oval.bottom, startAngle, sweepAngle, false);
}
/**
* 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.
*
* @param startAngle Starting angle (in degrees) where the arc begins
* @param sweepAngle Sweep angle (in degrees) measured clockwise, treated
* mod 360.
* @param forceMoveTo If true, always begin a new contour with the arc
*/
public void arcTo(float left, float top, float right, float bottom, float startAngle,
float sweepAngle, boolean forceMoveTo) {
nArcTo(mNativePath, left, top, right, bottom, startAngle, sweepAngle, forceMoveTo);
}
/**
* Close the current contour. If the current point is not equal to the
* first point of the contour, a line segment is automatically added.
*/
public void close() {
nClose(mNativePath);
}
/**
* Specifies how closed shapes (e.g. rects, ovals) are oriented when they
* are added to a path.
*/
public enum Direction {
/** clockwise */
CW (0), // must match enum in SkPath.h
/** counter-clockwise */
CCW (1); // must match enum in SkPath.h
Direction(int ni) {
nativeInt = ni;
}
final int nativeInt;
}
/**
* Add a closed rectangle contour to the path
*
* @param rect The rectangle to add as a closed contour to the path
* @param dir The direction to wind the rectangle's contour
*/
public void addRect(@NonNull RectF rect, @NonNull Direction dir) {
addRect(rect.left, rect.top, rect.right, rect.bottom, dir);
}
/**
* Add a closed rectangle contour to the path
*
* @param left The left side of a rectangle to add to the path
* @param top The top of a rectangle to add to the path
* @param right The right side of a rectangle to add to the path
* @param bottom The bottom of a rectangle to add to the path
* @param dir The direction to wind the rectangle's contour
*/
public void addRect(float left, float top, float right, float bottom, @NonNull Direction dir) {
nAddRect(mNativePath, left, top, right, bottom, dir.nativeInt);
}
/**
* Add a closed oval contour to the path
*
* @param oval The bounds of the oval to add as a closed contour to the path
* @param dir The direction to wind the oval's contour
*/
public void addOval(@NonNull RectF oval, @NonNull Direction dir) {
addOval(oval.left, oval.top, oval.right, oval.bottom, dir);
}
/**
* Add a closed oval contour to the path
*
* @param dir The direction to wind the oval's contour
*/
public void addOval(float left, float top, float right, float bottom, @NonNull Direction dir) {
nAddOval(mNativePath, left, top, right, bottom, dir.nativeInt);
}
/**
* Add a closed circle contour to the path
*
* @param x The x-coordinate of the center of a circle to add to the path
* @param y The y-coordinate of the center of a circle to add to the path
* @param radius The radius of a circle to add to the path
* @param dir The direction to wind the circle's contour
*/
public void addCircle(float x, float y, float radius, @NonNull Direction dir) {
nAddCircle(mNativePath, x, y, radius, dir.nativeInt);
}
/**
* Add the specified arc to the path as a new contour.
*
* @param oval The bounds of oval defining the shape and size of the arc
* @param startAngle Starting angle (in degrees) where the arc begins
* @param sweepAngle Sweep angle (in degrees) measured clockwise
*/
public void addArc(@NonNull RectF oval, float startAngle, float sweepAngle) {
addArc(oval.left, oval.top, oval.right, oval.bottom, startAngle, sweepAngle);
}
/**
* Add the specified arc to the path as a new contour.
*
* @param startAngle Starting angle (in degrees) where the arc begins
* @param sweepAngle Sweep angle (in degrees) measured clockwise
*/
public void addArc(float left, float top, float right, float bottom, float startAngle,
float sweepAngle) {
nAddArc(mNativePath, left, top, right, bottom, startAngle, sweepAngle);
}
/**
* Add a closed round-rectangle contour to the path
*
* @param rect The bounds of a round-rectangle to add to the path
* @param rx The x-radius of the rounded corners on the round-rectangle
* @param ry The y-radius of the rounded corners on the round-rectangle
* @param dir The direction to wind the round-rectangle's contour
*/
public void addRoundRect(@NonNull RectF rect, float rx, float ry, @NonNull Direction dir) {
addRoundRect(rect.left, rect.top, rect.right, rect.bottom, rx, ry, dir);
}
/**
* Add a closed round-rectangle contour to the path
*
* @param rx The x-radius of the rounded corners on the round-rectangle
* @param ry The y-radius of the rounded corners on the round-rectangle
* @param dir The direction to wind the round-rectangle's contour
*/
public void addRoundRect(float left, float top, float right, float bottom, float rx, float ry,
@NonNull Direction dir) {
nAddRoundRect(mNativePath, left, top, right, bottom, rx, ry, dir.nativeInt);
}
/**
* 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
*
* @param rect The bounds of a round-rectangle to add to the path
* @param radii Array of 8 values, 4 pairs of [X,Y] radii
* @param dir The direction to wind the round-rectangle's contour
*/
public void addRoundRect(@NonNull RectF rect, @NonNull float[] radii, @NonNull Direction dir) {
if (rect == null) {
throw new NullPointerException("need rect parameter");
}
addRoundRect(rect.left, rect.top, rect.right, rect.bottom, radii, 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
*
* @param radii Array of 8 values, 4 pairs of [X,Y] radii
* @param dir The direction to wind the round-rectangle's contour
*/
public void addRoundRect(float left, float top, float right, float bottom,
@NonNull float[] radii, @NonNull Direction dir) {
if (radii.length < 8) {
throw new ArrayIndexOutOfBoundsException("radii[] needs 8 values");
}
nAddRoundRect(mNativePath, left, top, right, bottom, radii, dir.nativeInt);
}
/**
* Add a copy of src to the path, offset by (dx,dy)
*
* @param src The path to add as a new contour
* @param dx The amount to translate the path in X as it is added
*/
public void addPath(@NonNull Path src, float dx, float dy) {
nAddPath(mNativePath, src.mNativePath, dx, dy);
}
/**
* Add a copy of src to the path
*
* @param src The path that is appended to the current path
*/
public void addPath(@NonNull Path src) {
nAddPath(mNativePath, src.mNativePath);
}
/**
* Add a copy of src to the path, transformed by matrix
*
* @param src The path to add as a new contour
*/
public void addPath(@NonNull Path src, @NonNull Matrix matrix) {
nAddPath(mNativePath, src.mNativePath, matrix.ni());
}
/**
* Offset the path by (dx,dy)
*
* @param dx The amount in the X direction to offset the entire path
* @param dy The amount in the Y direction to offset the entire path
* @param dst The translated path is written here. If this is null, then
* the original path is modified.
*/
public void offset(float dx, float dy, @Nullable Path dst) {
if (dst != null) {
dst.set(this);
} else {
dst = this;
}
dst.offset(dx, dy);
}
/**
* Offset the path by (dx,dy)
*
* @param dx The amount in the X direction to offset the entire path
* @param dy The amount in the Y direction to offset the entire path
*/
public void offset(float dx, float dy) {
nOffset(mNativePath, dx, dy);
}
/**
* Sets the last point of the path.
*
* @param dx The new X coordinate for the last point
* @param dy The new Y coordinate for the last point
*/
public void setLastPoint(float dx, float dy) {
nSetLastPoint(mNativePath, dx, dy);
}
/**
* 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.
*
* @param matrix The matrix to apply to the path
* @param dst The transformed path is written here. If dst is null,
* then the the original path is modified
*/
public void transform(@NonNull Matrix matrix, @Nullable Path dst) {
nTransform(mNativePath, matrix.ni(), dst != null ? dst.mNativePath : 0);
}
/**
* Transform the points in this path by matrix.
*
* @param matrix The matrix to apply to the path
*/
public void transform(@NonNull Matrix matrix) {
nTransform(mNativePath, matrix.ni());
}
/** @hide */
public final long readOnlyNI() {
return mNativePath;
}
final long mutateNI() {
return mNativePath;
}
/**
* 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:
*
Two points may share the same fraction along its length when there is * a move action within the Path.
* * @param acceptableError 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. * @return An array of components for points approximating the Path. */ @NonNull @Size(min = 6, multiple = 3) public float[] approximate(@FloatRange(from = 0) float acceptableError) { if (acceptableError < 0) { throw new IllegalArgumentException("AcceptableError must be greater than or equal to 0"); } return nApproximate(mNativePath, acceptableError); } /** * Returns the generation ID of this path. The generation ID changes * whenever the path is modified. This can be used as an efficient way to * check if a path has changed. * * @return The current generation ID for this path */ public int getGenerationId() { return nGetGenerationID(mNativePath); } /** * Two paths can be interpolated, by calling {@link #interpolate(Path, float, Path)}, if they * have exactly the same structure. That is, both paths must have the same * operations, in the same order. If any of the operations are * of type {@link PathIterator#VERB_CONIC}, then the weights of those conics must also match. * * @param otherPath The otherPath being interpolated to from this one.
* @return true if interpolation is possible, false otherwise
*/
public boolean isInterpolatable(@NonNull Path otherPath) {
return nIsInterpolatable(mNativePath, otherPath.mNativePath);
}
/**
* This method will linearly interpolate from this path to otherPath given
* the interpolation parameter t, returning the result in
* interpolatedPath. Interpolation will only succeed if the structures of the
* two paths match exactly, as discussed in {@link #isInterpolatable(Path)}.
*
* @param otherPath The other Path being interpolated to.
* @param t The interpolation parameter. A value of 0 results in a Path
* equivalent to this path, a value of 1 results in one equivalent to
* otherPath.
* @param interpolatedPath The interpolated results.
*/
public boolean interpolate(@NonNull Path otherPath, float t, @NonNull Path interpolatedPath) {
return nInterpolate(mNativePath, otherPath.mNativePath, t, interpolatedPath.mNativePath);
}
// ------------------ Regular JNI ------------------------
private static native long nInit();
private static native long nInit(long nPath);
private static native long nGetFinalizer();
private static native void nSet(long native_dst, long nSrc);
private static native void nComputeBounds(long nPath, RectF bounds);
private static native void nIncReserve(long nPath, int extraPtCount);
private static native void nMoveTo(long nPath, float x, float y);
private static native void nRMoveTo(long nPath, float dx, float dy);
private static native void nLineTo(long nPath, float x, float y);
private static native void nRLineTo(long nPath, float dx, float dy);
private static native void nQuadTo(long nPath, float x1, float y1, float x2, float y2);
private static native void nRQuadTo(long nPath, float dx1, float dy1, float dx2, float dy2);
private static native void nConicTo(long nPath, float x1, float y1, float x2, float y2,
float weight);
private static native void nRConicTo(long nPath, float dx1, float dy1, float dx2, float dy2,
float weight);
private static native void nCubicTo(long nPath, float x1, float y1, float x2, float y2,
float x3, float y3);
private static native void nRCubicTo(long nPath, float x1, float y1, float x2, float y2,
float x3, float y3);
private static native void nArcTo(long nPath, float left, float top, float right, float bottom,
float startAngle, float sweepAngle, boolean forceMoveTo);
private static native void nClose(long nPath);
private static native void nAddRect(long nPath, float left, float top,
float right, float bottom, int dir);
private static native void nAddOval(long nPath, float left, float top,
float right, float bottom, int dir);
private static native void nAddCircle(long nPath, float x, float y, float radius, int dir);
private static native void nAddArc(long nPath, float left, float top, float right, float bottom,
float startAngle, float sweepAngle);
private static native void nAddRoundRect(long nPath, float left, float top,
float right, float bottom, float rx, float ry, int dir);
private static native void nAddRoundRect(long nPath, float left, float top,
float right, float bottom, float[] radii, int dir);
private static native void nAddPath(long nPath, long src, float dx, float dy);
private static native void nAddPath(long nPath, long src);
private static native void nAddPath(long nPath, long src, long matrix);
private static native void nOffset(long nPath, float dx, float dy);
private static native void nSetLastPoint(long nPath, float dx, float dy);
private static native void nTransform(long nPath, long matrix, long dst_path);
private static native void nTransform(long nPath, long matrix);
private static native boolean nOp(long path1, long path2, int op, long result);
private static native float[] nApproximate(long nPath, float error);
private static native boolean nInterpolate(long startPath, long endPath, float t,
long interpolatedPath);
// ------------------ Fast JNI ------------------------
@FastNative
private static native boolean nIsRect(long nPath, RectF rect);
// ------------------ Critical JNI ------------------------
@CriticalNative
private static native int nGetGenerationID(long nativePath);
@CriticalNative
private static native boolean nIsInterpolatable(long startPath, long endPath);
@CriticalNative
private static native void nReset(long nPath);
@CriticalNative
private static native void nRewind(long nPath);
@CriticalNative
private static native boolean nIsEmpty(long nPath);
@CriticalNative
private static native boolean nIsConvex(long nPath);
@CriticalNative
private static native int nGetFillType(long nPath);
@CriticalNative
private static native void nSetFillType(long nPath, int ft);
}