RoundedPolygon.Companion

Summary

Extension functions
RoundedPolygon
RoundedPolygon.Companion.circle(
    numVertices: @IntRange(from = 3) Int,
    radius: Float,
    centerX: Float,
    centerY: Float
)

Creates a circular shape, approximating the rounding of the shape around the underlying polygon vertices.
Cmn
RoundedPolygon
RoundedPolygon.Companion.pill(
    width: Float,
    height: Float,
    smoothing: Float,
    centerX: Float,
    centerY: Float
)

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

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.
Cmn
RoundedPolygon
RoundedPolygon.Companion.rectangle(
    width: Float,
    height: Float,
    rounding: CornerRounding,
    perVertexRounding: List<CornerRounding>?,
    centerX: Float,
    centerY: Float
)

Creates a rectangular shape with the given width/height around the given center.
Cmn
RoundedPolygon
RoundedPolygon.Companion.star(
    numVerticesPerRadius: Int,
    radius: Float,
    innerRadius: Float,
    rounding: CornerRounding,
    innerRounding: CornerRounding?,
    perVertexRounding: List<CornerRounding>?,
    centerX: Float,
    centerY: Float
)

Creates a star polygon, which is like a regular polygon except every other vertex is on either an inner or outer radius.
Cmn

Extension functions

circle

Cmn 
fun RoundedPolygon.Companion.circle(
    numVertices: @IntRange(from = 3) Int = 8,
    radius: Float = 1.0f,
    centerX: Float = 0.0f,
    centerY: Float = 0.0f
): RoundedPolygon

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

Parameters
numVertices: @IntRange(from = 3) Int = 8

The number of vertices in the underlying polygon with which to approximate the circle, default value is 8
radius: Float = 1.0f

optional radius for the circle, default value is 1.0
centerX: Float = 0.0f

X coordinate of optional center for the circle, default value is 0
centerY: Float = 0.0f

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

numVertices must be at least 3

pill

Cmn 
fun RoundedPolygon.Companion.pill(
    width: Float = 2.0f,
    height: Float = 1.0f,
    smoothing: Float = 0.0f,
    centerX: Float = 0.0f,
    centerY: Float = 0.0f
): RoundedPolygon

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

Parameters
width: Float = 2.0f

The width of the resulting shape.
height: Float = 1.0f

The height of the resulting shape.
smoothing: Float = 0.0f

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.
centerX: Float = 0.0f

The X coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
centerY: Float = 0.0f

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

Cmn 
fun RoundedPolygon.Companion.pillStar(
    width: Float = 2.0f,
    height: Float = 1.0f,
    numVerticesPerRadius: Int = 8,
    innerRadiusRatio: @FloatRange(from = 0.0, fromInclusive = false, to = 1.0, toInclusive = false) Float = 0.5f,
    rounding: CornerRounding = CornerRounding.Unrounded,
    innerRounding: CornerRounding? = null,
    perVertexRounding: List<CornerRounding>? = null,
    vertexSpacing: @FloatRange(from = 0.0, to = 1.0) Float = 0.5f,
    startLocation: @FloatRange(from = 0.0, to = 1.0) Float = 0.0f,
    centerX: Float = 0.0f,
    centerY: Float = 0.0f
): RoundedPolygon

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
width: Float = 2.0f

The width of the resulting shape.
height: Float = 1.0f

The height of the resulting shape.
numVerticesPerRadius: Int = 8

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

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.
rounding: CornerRounding = CornerRounding.Unrounded

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.
innerRounding: CornerRounding? = null

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

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.
vertexSpacing: @FloatRange(from = 0.0, to = 1.0) Float = 0.5f

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.
startLocation: @FloatRange(from = 0.0, to = 1.0) Float = 0.0f

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.
centerX: Float = 0.0f

The X coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
centerY: Float = 0.0f

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

Cmn 
fun RoundedPolygon.Companion.rectangle(
    width: Float = 2.0f,
    height: Float = 2.0f,
    rounding: CornerRounding = CornerRounding.Unrounded,
    perVertexRounding: List<CornerRounding>? = null,
    centerX: Float = 0.0f,
    centerY: Float = 0.0f
): RoundedPolygon

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
width: Float = 2.0f

The width of the rectangle, default value is 2
height: Float = 2.0f

The height of the rectangle, default value is 2
rounding: CornerRounding = CornerRounding.Unrounded

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.
perVertexRounding: List<CornerRounding>? = null

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.
centerX: Float = 0.0f

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

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

Cmn 
fun RoundedPolygon.Companion.star(
    numVerticesPerRadius: Int,
    radius: Float = 1.0f,
    innerRadius: Float = 0.5f,
    rounding: CornerRounding = CornerRounding.Unrounded,
    innerRounding: CornerRounding? = null,
    perVertexRounding: List<CornerRounding>? = null,
    centerX: Float = 0.0f,
    centerY: Float = 0.0f
): RoundedPolygon

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
numVerticesPerRadius: Int

The number of vertices along each of the two radii.
radius: Float = 1.0f

Outer radius for this star shape, must be greater than 0. Default value is 1.
innerRadius: Float = 0.5f

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.
rounding: CornerRounding = CornerRounding.Unrounded

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.
innerRounding: CornerRounding? = null

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

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.
centerX: Float = 0.0f

The X coordinate of the center of the polygon, around which all vertices will be placed. The default center is at (0,0).
centerY: Float = 0.0f

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.