ShapesKt

Added in 1.0.0

public final class ShapesKt

Summary

Public methods
static final @NonNull RoundedPolygon
circle(
    @NonNull RoundedPolygon.Companion receiver,
    @IntRange(from = 3) int numVertices,
    float radius,
    float centerX,
    float centerY
)

Creates a circular shape, approximating the rounding of the shape around the underlying polygon vertices.
static final @NonNull RoundedPolygon
pill(
    @NonNull RoundedPolygon.Companion receiver,
    float width,
    float height,
    float smoothing,
    float centerX,
    float centerY
)

A pill shape consists of a rectangle shape bounded by two semicircles at either of the long ends of the rectangle.
static final @NonNull RoundedPolygon
pillStar(
    @NonNull RoundedPolygon.Companion receiver,
    float width,
    float height,
    int numVerticesPerRadius,
    @FloatRange(from = 0.0, fromInclusive = false, to = 1.0, toInclusive = false) float innerRadiusRatio,
    @NonNull CornerRounding rounding,
    CornerRounding innerRounding,
    List<@NonNull CornerRounding> perVertexRounding,
    @FloatRange(from = 0.0, to = 1.0) float vertexSpacing,
    @FloatRange(from = 0.0, to = 1.0) float startLocation,
    float centerX,
    float centerY
)

A pillStar shape is like a pill except it has inner and outer radii along its pill-shaped outline, just like a star has inner and outer radii along its circular outline.
static final @NonNull RoundedPolygon
rectangle(
    @NonNull RoundedPolygon.Companion receiver,
    float width,
    float height,
    @NonNull CornerRounding rounding,
    List<@NonNull CornerRounding> perVertexRounding,
    float centerX,
    float centerY
)

Creates a rectangular shape with the given width/height around the given center.
static final @NonNull RoundedPolygon
star(
    @NonNull RoundedPolygon.Companion receiver,
    int numVerticesPerRadius,
    float radius,
    float innerRadius,
    @NonNull CornerRounding rounding,
    CornerRounding innerRounding,
    List<@NonNull CornerRounding> perVertexRounding,
    float centerX,
    float centerY
)

Creates a star polygon, which is like a regular polygon except every other vertex is on either an inner or outer radius.
static final @NonNull Path

Gets a Path representation for a RoundedPolygon shape.
static final @NonNull Path
toPath(@NonNull Morph receiver, float progress, @NonNull Path path)
static final @NonNull RoundedPolygon

Transforms a RoundedPolygon by the given matrix.

Public methods

circle

public static final @NonNull RoundedPolygon circle(
    @NonNull RoundedPolygon.Companion receiver,
    @IntRange(from = 3) int numVertices,
    float radius,
    float centerX,
    float centerY
)

Creates a circular shape, approximating the rounding of the shape around the underlying polygon vertices.

Parameters
@IntRange(from = 3) int numVertices

The number of vertices in the underlying polygon with which to approximate the circle, default value is 8
float radius

optional radius for the circle, default value is 1.0
float centerX

X coordinate of optional center for the circle, default value is 0
float centerY

Y coordinate of optional center for the circle, default value is 0
Throws
kotlin.IllegalArgumentException

numVertices must be at least 3

pill

public static final @NonNull RoundedPolygon pill(
    @NonNull RoundedPolygon.Companion receiver,
    float width,
    float height,
    float smoothing,
    float centerX,
    float centerY
)

A pill shape consists of a rectangle shape bounded by two semicircles at either of the long ends of the rectangle.

Parameters
float width

The width of the resulting shape.
float height

The height of the resulting shape.
float smoothing

the amount by which the arc is "smoothed" by extending the curve from the circular arc on each endcap to the edge between the endcaps. A value of 0 (no smoothing) indicates that the corner is rounded by only a circular arc.
float centerX

The X coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
float centerY

The Y coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
Throws
kotlin.IllegalArgumentException

if either width or height are <= 0.

pillStar

public static final @NonNull RoundedPolygon pillStar(
    @NonNull RoundedPolygon.Companion receiver,
    float width,
    float height,
    int numVerticesPerRadius,
    @FloatRange(from = 0.0, fromInclusive = false, to = 1.0, toInclusive = false) float innerRadiusRatio,
    @NonNull CornerRounding rounding,
    CornerRounding innerRounding,
    List<@NonNull CornerRounding> perVertexRounding,
    @FloatRange(from = 0.0, to = 1.0) float vertexSpacing,
    @FloatRange(from = 0.0, to = 1.0) float startLocation,
    float centerX,
    float centerY
)

A pillStar shape is like a pill except it has inner and outer radii along its pill-shaped outline, just like a star has inner and outer radii along its circular outline. The parameters for a pillStar are similar to those of a star except, like pill, it has a width and height to determine the general shape of the underlying pill. Also, there is a subtle complication with the way that inner and outer vertices proceed along the circular ends of the shape, depending on the magnitudes of the rounding, innerRounding, and innerRadiusRatio parameters. For example, a shape with outer vertices that lie along the curved end outline will necessarily have inner vertices that are closer to each other, because of the curvature of that part of the shape. Conversely, if the inner vertices are lined up along the pill outline at the ends, then the outer vertices will be much further apart from each other.

The default approach, reflected by the default value of vertexSpacing, is to use the average of the outer and inner radii, such that each set of vertices falls equally to the other side of the pill outline on the curved ends. Depending on the values used for the various rounding and radius parameters, you may want to change that value to suit the look you want. A value of 0 for vertexSpacing is equivalent to aligning the inner vertices along the circular curve, and a value of 1 is equivalent to aligning the outer vertices along that curve.

Parameters
float width

The width of the resulting shape.
float height

The height of the resulting shape.
int numVerticesPerRadius

The number of vertices along each of the two radii.
@FloatRange(from = 0.0, fromInclusive = false, to = 1.0, toInclusive = false) float innerRadiusRatio

Inner radius ratio for this star shape, must be greater than 0 and less than or equal to 1. Note that a value of 1 would be similar to creating a pill, but with more vertices. The default value is .5.
@NonNull CornerRounding rounding

The CornerRounding properties of every vertex. If some vertices should have different rounding properties, then use perVertexRounding instead. The default rounding value is CornerRounding.Unrounded, meaning that the polygon will use the vertices themselves in the final shape and not curves rounded around the vertices.
CornerRounding innerRounding

Optional rounding parameters for the vertices on the innerRadiusRatio. If null (the default value), inner vertices will use the rounding or perVertexRounding parameters instead.
List<@NonNull CornerRounding> perVertexRounding

The CornerRounding properties of every vertex. If this parameter is not null, then it must have the same size as 2 * numVerticesPerRadius. If this parameter is null, then the polygon will use the rounding parameter for every vertex instead. The default value is null.
@FloatRange(from = 0.0, to = 1.0) float vertexSpacing

This factor determines how the vertices on the circular ends are laid out along the outline. A value of 0 aligns spaces the inner vertices the same as those along the straight edges, with the outer vertices then being spaced further apart. A value of 1 does the opposite, with the outer vertices spaced the same as the vertices on the straight edges. The default value is .5, which takes the average of these two extremes.
@FloatRange(from = 0.0, to = 1.0) float startLocation

A value from 0 to 1 which determines how far along the perimeter of this shape to start the underlying curves of which it is comprised. This is not usually needed or noticed by the user. But if the caller wants to manually and gradually stroke the path when drawing it, it might matter where that path outline begins and ends. The default value is 0.
float centerX

The X coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
float centerY

The Y coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
Throws
kotlin.IllegalArgumentException

if either width or height are <= 0 or if innerRadiusRatio is outside the range of (0, 1].

rectangle

public static final @NonNull RoundedPolygon rectangle(
    @NonNull RoundedPolygon.Companion receiver,
    float width,
    float height,
    @NonNull CornerRounding rounding,
    List<@NonNull CornerRounding> perVertexRounding,
    float centerX,
    float centerY
)

Creates a rectangular shape with the given width/height around the given center. Optional rounding parameters can be used to create a rounded rectangle instead.

As with all RoundedPolygon objects, if this shape is created with default dimensions and center, it is sized to fit within the 2x2 bounding box around a center of (0, 0) and will need to be scaled and moved using RoundedPolygon.transformed to fit the intended area in a UI.

Parameters
float width

The width of the rectangle, default value is 2
float height

The height of the rectangle, default value is 2
@NonNull CornerRounding rounding

The CornerRounding properties of every vertex. If some vertices should have different rounding properties, then use perVertexRounding instead. The default rounding value is CornerRounding.Unrounded, meaning that the polygon will use the vertices themselves in the final shape and not curves rounded around the vertices.
List<@NonNull CornerRounding> perVertexRounding

The CornerRounding properties of every vertex. If this parameter is not null, then it must be of size 4 for the four corners of the shape. If this parameter is null, then the polygon will use the rounding parameter for every vertex instead. The default value is null.
float centerX

The X coordinate of the center of the rectangle, around which all vertices will be placed equidistantly. The default center is at (0,0).
float centerY

The X coordinate of the center of the rectangle, around which all vertices will be placed equidistantly. The default center is at (0,0).

star

public static final @NonNull RoundedPolygon star(
    @NonNull RoundedPolygon.Companion receiver,
    int numVerticesPerRadius,
    float radius,
    float innerRadius,
    @NonNull CornerRounding rounding,
    CornerRounding innerRounding,
    List<@NonNull CornerRounding> perVertexRounding,
    float centerX,
    float centerY
)

Creates a star polygon, which is like a regular polygon except every other vertex is on either an inner or outer radius. The two radii specified in the constructor must both both nonzero. If the radii are equal, the result will be a regular (not star) polygon with twice the number of vertices specified in numVerticesPerRadius.

Parameters
int numVerticesPerRadius

The number of vertices along each of the two radii.
float radius

Outer radius for this star shape, must be greater than 0. Default value is 1.
float innerRadius

Inner radius for this star shape, must be greater than 0 and less than or equal to radius. Note that equal radii would be the same as creating a RoundedPolygon directly, but with 2 * numVerticesPerRadius vertices. Default value is .5.
@NonNull CornerRounding rounding

The CornerRounding properties of every vertex. If some vertices should have different rounding properties, then use perVertexRounding instead. The default rounding value is CornerRounding.Unrounded, meaning that the polygon will use the vertices themselves in the final shape and not curves rounded around the vertices.
CornerRounding innerRounding

Optional rounding parameters for the vertices on the innerRadius. If null (the default value), inner vertices will use the rounding or perVertexRounding parameters instead.
List<@NonNull CornerRounding> perVertexRounding

The CornerRounding properties of every vertex. If this parameter is not null, then it must have the same size as 2 * numVerticesPerRadius. If this parameter is null, then the polygon will use the rounding parameter for every vertex instead. The default value is null.
float centerX

The X coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
float centerY

The Y coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
Throws
kotlin.IllegalArgumentException

if either radius or innerRadius are <= 0 or innerRadius radius.

toPath

public static final @NonNull Path toPath(@NonNull RoundedPolygon receiver, @NonNull Path path)

Gets a Path representation for a RoundedPolygon shape. Note that there is some rounding happening (to the nearest thousandth), to work around rendering artifacts introduced by some points being just slightly off from each other (far less than a pixel). This also allows for a more optimal path, as redundant curves (usually a single point) can be detected and not added to the resulting path.

Parameters
@NonNull Path path

an optional Path object which, if supplied, will avoid the function having to create a new Path object

toPath

public static final @NonNull Path toPath(@NonNull Morph receiver, float progress, @NonNull Path path)

transformed

public static final @NonNull RoundedPolygon transformed(@NonNull RoundedPolygon receiver, @NonNull Matrix matrix)

Transforms a RoundedPolygon by the given matrix.

Parameters
@NonNull Matrix matrix

The matrix by which the polygon is to be transformed