PolygonShapeGeometry

public class PolygonShapeGeometry internal constructor(
    public val vertices: List<Offset>,
    public val center: Offset,
    public val rounding: CornerRounding,
    @get:Suppress("NullableCollection") public val perVertexRounding: List<CornerRounding>?,
    internal val roundingReference: Size? = null,
)

Geometry describing a polygon's vertices, center, and rounding.

The consumer defines the coordinate space. PolygonShapeScope factories create geometry in pixels in the layout's coordinate space, while geometry passed directly to PolygonShape uses an author-chosen space and is scaled into the layout bounds at resolution time.

Rounding resolves in the vertex coordinate space. A float radius is a length in that space, and a percent radius resolves against the smaller dimension of the vertex bounds.

Functions

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

toString

override fun toString(): String

Members

CornerRounding

public class CornerRounding internal constructor(
        internal val value: Float,
        internal val unit: Int,
        internal val smoothing: Float,
    )

Amount and quality of rounding around a polygon vertex.

A corner takes one of three forms:

• unrounded, with a radius of 0, keeping the sharp vertex;

arc between adjacent edges;

• rounded with a circular arc, with a smoothing of 0, following an approximated circular

flanking curves connect the circular arc to the edges. A smoothing of 0 keeps a purely circular arc and 1 maximizes the flanking curves so they meet in the middle.

• rounded with continuous curvature, with smoothing > 0, where two symmetric cubic Bézier

Functions

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

toString

override fun toString(): String

Members

Companion

public companion object

Properties

Unrounded

public val Unrounded: CornerRounding = CornerRounding(0f, UnitLength, 0f)

Rounding with a radius of zero, producing a sharp corner at the vertex.

Companion

public companion object

Functions

CornerRounding

public fun CornerRounding(radius: Float, smoothing: Float = 0f): CornerRounding

Creates a CornerRounding with a radius in the same coordinate space as the vertices.

Parameters

Throws: IllegalArgumentException

if radius is negative or smoothing is outside the range 0 to 1

CornerRounding

public fun CornerRounding(radius: Dp, smoothing: Float = 0f): CornerRounding

Creates a CornerRounding with a radius in Dp, resolved with the shape's density.

Parameters

Throws: IllegalArgumentException

if radius is negative or unspecified, or smoothing is outside the range 0 to 1

CornerRounding

public fun CornerRounding(
            @IntRange(from = 0, to = 100) percent: Int,
            smoothing: Float = 0f,
        ): CornerRounding

Creates a CornerRounding with a radius as a percent of the geometry it applies to.

The reference is the generating radius for regular polygons and stars, or the smaller dimension of the vertex bounds for vertex-list geometry, so the radius scales with the shape rather than with the layout container.

Parameters

Throws: IllegalArgumentException

if percent is outside the range 0 to 100 or smoothing is outside the range 0 to 1