CornerBasedShape

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.0.0

Common/All

• Cmn

  abstract class CornerBasedShape : Shape

Known direct subclasses

AbsoluteCutCornerShape, AbsoluteRoundedCornerShape, CutCornerShape, RoundedCornerShape

AbsoluteCutCornerShape	A shape describing the rectangle with cut corners.
AbsoluteRoundedCornerShape	A shape describing the rectangle with rounded corners.
CutCornerShape	A shape describing the rectangle with cut corners.
RoundedCornerShape	A shape describing the rectangle with rounded corners.

---

Base class for Shapes defined by four CornerSizes.

See also
RoundedCornerShape	for an example of the usage.

Summary

Public constructors
CornerBasedShape(     topStart: CornerSize,     topEnd: CornerSize,     bottomEnd: CornerSize,     bottomStart: CornerSize )	Cmn

Public functions
CornerBasedShape	copy(all: CornerSize) Creates a copy of this Shape with a new corner size.	Cmn
abstract CornerBasedShape	copy(     topStart: CornerSize,     topEnd: CornerSize,     bottomEnd: CornerSize,     bottomStart: CornerSize ) Creates a copy of this Shape with a new corner sizes.	Cmn
final Outline	createOutline(     size: Size,     layoutDirection: LayoutDirection,     density: Density ) Creates Outline of this shape for the given size.	Cmn
abstract Outline	createOutline(     size: Size,     topStart: Float,     topEnd: Float,     bottomEnd: Float,     bottomStart: Float,     layoutDirection: LayoutDirection ) Creates Outline of this shape for the given size.	Cmn

Public properties
CornerSize	bottomEnd a size of the bottom end corner	Cmn
CornerSize	bottomStart a size of the bottom start corner	Cmn
CornerSize	topEnd a size of the top end corner	Cmn
CornerSize	topStart a size of the top start corner	Cmn

Public constructors

CornerBasedShape

Cmn

Added in 1.0.0

CornerBasedShape(
    topStart: CornerSize,
    topEnd: CornerSize,
    bottomEnd: CornerSize,
    bottomStart: CornerSize
)

Parameters
topStart: CornerSize	a size of the top start corner
topEnd: CornerSize	a size of the top end corner
bottomEnd: CornerSize	a size of the bottom end corner
bottomStart: CornerSize	a size of the bottom start corner

Public functions

copy

Cmn

Added in 1.0.0

fun copy(all: CornerSize): CornerBasedShape

Creates a copy of this Shape with a new corner size.

Parameters
all: CornerSize	a size to apply for all four corners

copy

Cmn

Added in 1.0.0

abstract fun copy(
    topStart: CornerSize = this.topStart,
    topEnd: CornerSize = this.topEnd,
    bottomEnd: CornerSize = this.bottomEnd,
    bottomStart: CornerSize = this.bottomStart
): CornerBasedShape

Creates a copy of this Shape with a new corner sizes.

Parameters
topStart: CornerSize = this.topStart	a size of the top start corner
topEnd: CornerSize = this.topEnd	a size of the top end corner
bottomEnd: CornerSize = this.bottomEnd	a size of the bottom end corner
bottomStart: CornerSize = this.bottomStart	a size of the bottom start corner

createOutline

Cmn

final fun createOutline(
    size: Size,
    layoutDirection: LayoutDirection,
    density: Density
): Outline

Creates Outline of this shape for the given size.

Parameters
size: Size	the size of the shape boundary.
layoutDirection: LayoutDirection	the current layout direction.
density: Density	the current density of the screen.

Returns
Outline	Outline of this shape for the given size.

createOutline

Cmn

abstract fun createOutline(
    size: Size,
    topStart: Float,
    topEnd: Float,
    bottomEnd: Float,
    bottomStart: Float,
    layoutDirection: LayoutDirection
): Outline

Creates Outline of this shape for the given size.

Parameters
size: Size	the size of the shape boundary.
topStart: Float	the resolved size of the top start corner
topEnd: Float	the resolved size for the top end corner
bottomEnd: Float	the resolved size for the bottom end corner
bottomStart: Float	the resolved size for the bottom start corner
layoutDirection: LayoutDirection	the current layout direction.

Public properties

bottomEnd

Cmn

Added in 1.0.0

val bottomEnd: CornerSize

a size of the bottom end corner

bottomStart

Cmn

Added in 1.0.0

val bottomStart: CornerSize

a size of the bottom start corner

topEnd

Cmn

Added in 1.0.0

val topEnd: CornerSize

a size of the top end corner

topStart

Cmn

Added in 1.0.0

val topStart: CornerSize

a size of the top start corner