Compose のシェイプ

Compose では、ポリゴンから作成されたシェイプを作成できます。たとえば、次のような形状を作成できます。

描画領域の中央にある青い六角形
図 1. graphics-shapes ライブラリで作成できるさまざまな形状の例

Compose でカスタムの角丸多角形を作成するには、graphics-shapes 依存関係を app/build.gradle に追加します。

implementation "androidx.graphics:graphics-shapes:1.0.1"

このライブラリを使用すると、ポリゴンで構成される形状を作成できます。多角形には直線と鋭角しかありませんが、これらの形状では角を丸くすることができます。これにより、2 つの異なる形状間のモーフィングが簡単になります。任意の形状間のモーフィングは難しく、設計時の問題になりがちです。しかし、このライブラリを使用すると、類似した多角形構造を持つこれらの形状間でモーフィングすることで、簡単に実現できます。

ポリゴンを作成する

次のスニペットは、描画領域の中央に 6 つの点を持つ基本的なポリゴン形状を作成します。

Box(
    modifier = Modifier
        .drawWithCache {
            val roundedPolygon = RoundedPolygon(
                numVertices = 6,
                radius = size.minDimension / 2,
                centerX = size.width / 2,
                centerY = size.height / 2
            )
            val roundedPolygonPath = roundedPolygon.toPath().asComposePath()
            onDrawBehind {
                drawPath(roundedPolygonPath, color = Color.Blue)
            }
        }
        .fillMaxSize()
)

描画領域の中央にある青い六角形
図 2. 描画領域の中央に青い六角形が表示されます。

この例では、ライブラリはリクエストされた形状を表すジオメトリを保持する RoundedPolygon を作成します。Compose アプリでそのシェイプを描画するには、そこから Path オブジェクトを取得して、Compose が描画方法を認識できる形式にシェイプを変換する必要があります。

ポリゴンの角を丸くする

多角形の角を丸くするには、CornerRounding パラメータを使用します。これは、radius と smoothing の 2 つのパラメータを受け取ります。各角丸は 1 ~ 3 個の 3 次曲線で構成されています。中央の曲線は円弧の形状をしており、両側の曲線は形状の端から中央の曲線に移行します。

半径

radius は、頂点を丸めるために使用される円の半径です。

たとえば、次の角丸三角形は次のように作成されます。

角が丸い三角形
図 3. 角が丸い三角形。
丸め半径 r は、角丸の円形の丸めサイズを決定します。
図 4. 丸め半径 r は、角丸の円形の丸めサイズを決定します。

Smoothing

スムージングは、角の円形の丸み部分から端までの時間を決定する要素です。平滑化係数が 0(平滑化なし、CornerRounding のデフォルト値)の場合、角は完全に円形に丸められます。ゼロ以外の平滑化係数(最大 1.0)を指定すると、3 つの別々の曲線で角が丸くなります。

平滑化係数が 0(平滑化なし)の場合、前述の例のように、指定された丸め半径で角の周りの円に沿った単一の 3 次曲線が生成されます。
図 5. 平滑化係数が 0(平滑化なし)の場合、前の例のように、指定された丸め半径で角の周りの円に沿った単一の 3 次曲線が生成されます。
スムージング係数がゼロ以外の場合、頂点を丸めるために 3 つの 3 次曲線が生成されます。内側の円曲線(前述のとおり)と、内側の曲線と多角形のエッジの間を遷移する 2 つの隣接曲線です。
図 6. ゼロ以外の平滑化係数を指定すると、頂点を丸めるために 3 つの 3 次曲線が生成されます。内側の円曲線(前述のとおり)と、内側の曲線と多角形のエッジの間を遷移する 2 つの隣接曲線です。

たとえば、次のスニペットは、スムージングを 0 に設定した場合と 1 に設定した場合の微妙な違いを示しています。

Box(
    modifier = Modifier
        .drawWithCache {
            val roundedPolygon = RoundedPolygon(
                numVertices = 3,
                radius = size.minDimension / 2,
                centerX = size.width / 2,
                centerY = size.height / 2,
                rounding = CornerRounding(
                    size.minDimension / 10f,
                    smoothing = 0.1f
                )
            )
            val roundedPolygonPath = roundedPolygon.toPath().asComposePath()
            onDrawBehind {
                drawPath(roundedPolygonPath, color = Color.Black)
            }
        }
        .size(100.dp)
)

2 つの黒い三角形は、平滑化パラメータの違いを示しています。
図 7. 2 つの黒い三角形は、平滑化パラメータの違いを示しています。

サイズと位置

デフォルトでは、中心(0, 0)の周囲に半径 1 のシェイプが作成されます。この半径は、シェイプのベースとなるポリゴンの中心と外側の頂点との距離を表します。角を丸くすると、丸められた角が丸められる頂点よりも中心に近くなるため、形状が小さくなります。ポリゴンのサイズを設定するには、radius 値を調整します。位置を調整するには、ポリゴンの centerX または centerY を変更します。または、DrawScope#translate() などの標準の DrawScope 変換関数を使用して、オブジェクトを変換してサイズ、位置、回転を変更します。

モーフィング シェイプ

Morph オブジェクトは、2 つの多角形間のアニメーションを表す新しいシェイプです。2 つのシェイプ間でモーフィングするには、2 つの RoundedPolygons と、これら 2 つのシェイプを受け取る Morph オブジェクトを作成します。開始シェイプと終了シェイプの間のシェイプを計算するには、0 ~ 1 の progress 値を指定して、開始シェイプ(0)と終了シェイプ(1)の間のフォームを決定します。

Box(
    modifier = Modifier
        .drawWithCache {
            val triangle = RoundedPolygon(
                numVertices = 3,
                radius = size.minDimension / 2f,
                centerX = size.width / 2f,
                centerY = size.height / 2f,
                rounding = CornerRounding(
                    size.minDimension / 10f,
                    smoothing = 0.1f
                )
            )
            val square = RoundedPolygon(
                numVertices = 4,
                radius = size.minDimension / 2f,
                centerX = size.width / 2f,
                centerY = size.height / 2f
            )

            val morph = Morph(start = triangle, end = square)
            val morphPath = morph
                .toPath(progress = 0.5f).asComposePath()

            onDrawBehind {
                drawPath(morphPath, color = Color.Black)
            }
        }
        .fillMaxSize()
)

上記の例では、進行状況は 2 つの形状(角丸三角形と正方形)のちょうど中間であり、次の結果が生成されます。

丸みを帯びた三角形と正方形の中間(50%)
図 8. 丸みを帯びた三角形と正方形の中間(50%)です。

ほとんどのシナリオでは、モーフィングは静的なレンダリングではなく、アニメーションの一部として行われます。この 2 つの間でアニメーション化するには、Compose の標準のアニメーション API を使用して、時間の経過とともに進行状況の値を変更します。たとえば、次のように、これら 2 つのシェイプ間のモーフィングを無限にアニメーション化できます。

val infiniteAnimation = rememberInfiniteTransition(label = "infinite animation")
val morphProgress = infiniteAnimation.animateFloat(
    initialValue = 0f,
    targetValue = 1f,
    animationSpec = infiniteRepeatable(
        tween(500),
        repeatMode = RepeatMode.Reverse
    ),
    label = "morph"
)
Box(
    modifier = Modifier
        .drawWithCache {
            val triangle = RoundedPolygon(
                numVertices = 3,
                radius = size.minDimension / 2f,
                centerX = size.width / 2f,
                centerY = size.height / 2f,
                rounding = CornerRounding(
                    size.minDimension / 10f,
                    smoothing = 0.1f
                )
            )
            val square = RoundedPolygon(
                numVertices = 4,
                radius = size.minDimension / 2f,
                centerX = size.width / 2f,
                centerY = size.height / 2f
            )

            val morph = Morph(start = triangle, end = square)
            val morphPath = morph
                .toPath(progress = morphProgress.value)
                .asComposePath()

            onDrawBehind {
                drawPath(morphPath, color = Color.Black)
            }
        }
        .fillMaxSize()
)

正方形と丸みを帯びた三角形の間で無限にモーフィング
図 9. 正方形と角丸三角形の間で無限にモーフィングします。

ポリゴンをクリップとして使用

Compose では、clip 修飾子を使用してコンポーザブルのレンダリング方法を変更し、クリッピング領域の周囲に描画されるシャドウを利用するのが一般的です。

fun RoundedPolygon.getBounds() = calculateBounds().let { Rect(it[0], it[1], it[2], it[3]) }
class RoundedPolygonShape(
    private val polygon: RoundedPolygon,
    private var matrix: Matrix = Matrix()
) : Shape {
    private var path = Path()
    override fun createOutline(
        size: Size,
        layoutDirection: LayoutDirection,
        density: Density
    ): Outline {
        path.rewind()
        path = polygon.toPath().asComposePath()
        matrix.reset()
        val bounds = polygon.getBounds()
        val maxDimension = max(bounds.width, bounds.height)
        matrix.scale(size.width / maxDimension, size.height / maxDimension)
        matrix.translate(-bounds.left, -bounds.top)

        path.transform(matrix)
        return Outline.Generic(path)
    }
}

次のスニペットに示すように、ポリゴンをクリップとして使用できます。

val hexagon = remember {
    RoundedPolygon(
        6,
        rounding = CornerRounding(0.2f)
    )
}
val clip = remember(hexagon) {
    RoundedPolygonShape(polygon = hexagon)
}
Box(
    modifier = Modifier
        .clip(clip)
        .background(MaterialTheme.colorScheme.secondary)
        .size(200.dp)
) {
    Text(
        "Hello Compose",
        color = MaterialTheme.colorScheme.onSecondary,
        modifier = Modifier.align(Alignment.Center)
    )
}

これにより、次のようになります。

中央に「hello compose」というテキストが表示された六角形。
図 10. 中央に「Hello Compose」というテキストが表示された六角形。

これは、以前にレンダリングされていたものとそれほど変わらないように見えるかもしれませんが、Compose の他の機能を活用できます。たとえば、この手法を使用して画像をクリップし、クリップされた領域の周囲にシャドウを適用できます。

val hexagon = remember {
    RoundedPolygon(
        6,
        rounding = CornerRounding(0.2f)
    )
}
val clip = remember(hexagon) {
    RoundedPolygonShape(polygon = hexagon)
}
Box(
    modifier = Modifier.fillMaxSize(),
    contentAlignment = Alignment.Center
) {
    Image(
        painter = painterResource(id = R.drawable.dog),
        contentDescription = "Dog",
        contentScale = ContentScale.Crop,
        modifier = Modifier
            .graphicsLayer {
                this.shadowElevation = 6.dp.toPx()
                this.shape = clip
                this.clip = true
                this.ambientShadowColor = Color.Black
                this.spotShadowColor = Color.Black
            }
            .size(200.dp)

    )
}

六角形の中に犬がいて、エッジの周りにシャドウが適用されている
図 11. カスタム シェイプがクリップとして適用されました。

クリック時にボタンをモーフィングする

graphics-shape ライブラリを使用すると、押したときに 2 つの形状間でモーフィングするボタンを作成できます。まず、Shape を拡張する MorphPolygonShape を作成し、適切に収まるようにスケーリングと変換を行います。シェイプをアニメーション化できるように、進行状況を渡していることに注目してください。

class MorphPolygonShape(
    private val morph: Morph,
    private val percentage: Float
) : Shape {

    private val matrix = Matrix()
    override fun createOutline(
        size: Size,
        layoutDirection: LayoutDirection,
        density: Density
    ): Outline {
        // Below assumes that you haven't changed the default radius of 1f, nor the centerX and centerY of 0f
        // By default this stretches the path to the size of the container, if you don't want stretching, use the same size.width for both x and y.
        matrix.scale(size.width / 2f, size.height / 2f)
        matrix.translate(1f, 1f)

        val path = morph.toPath(progress = percentage).asComposePath()
        path.transform(matrix)
        return Outline.Generic(path)
    }
}

このモーフィング シェイプを使用するには、2 つのポリゴン shapeA と shapeB を作成します。Morph を作成して覚えておきます。次に、ボタンが押されたときの interactionSource をアニメーションの原動力として、モーフィングをクリップ アウトラインとしてボタンに適用します。

val shapeA = remember {
    RoundedPolygon(
        6,
        rounding = CornerRounding(0.2f)
    )
}
val shapeB = remember {
    RoundedPolygon.star(
        6,
        rounding = CornerRounding(0.1f)
    )
}
val morph = remember {
    Morph(shapeA, shapeB)
}
val interactionSource = remember {
    MutableInteractionSource()
}
val isPressed by interactionSource.collectIsPressedAsState()
val animatedProgress = animateFloatAsState(
    targetValue = if (isPressed) 1f else 0f,
    label = "progress",
    animationSpec = spring(dampingRatio = 0.4f, stiffness = Spring.StiffnessMedium)
)
Box(
    modifier = Modifier
        .size(200.dp)
        .padding(8.dp)
        .clip(MorphPolygonShape(morph, animatedProgress.value))
        .background(Color(0xFF80DEEA))
        .size(200.dp)
        .clickable(interactionSource = interactionSource, indication = null) {
        }
) {
    Text("Hello", modifier = Modifier.align(Alignment.Center))
}

これにより、ボックスをタップすると次のアニメーションが表示されます。

2 つの図形間のクリックとして適用された変形
図 12. 2 つの図形間のクリックとして適用されたモーフィング。

図形のモーフィングを無限にアニメーション化する

モーフィング シェイプを無限にアニメーション化するには、rememberInfiniteTransition を使用します。以下は、時間の経過とともに形状が無限に変化する(回転する)プロフィール写真の例です。この方法では、上記の MorphPolygonShape に小さな調整を加えます。

class CustomRotatingMorphShape(
    private val morph: Morph,
    private val percentage: Float,
    private val rotation: Float
) : Shape {

    private val matrix = Matrix()
    override fun createOutline(
        size: Size,
        layoutDirection: LayoutDirection,
        density: Density
    ): Outline {
        // Below assumes that you haven't changed the default radius of 1f, nor the centerX and centerY of 0f
        // By default this stretches the path to the size of the container, if you don't want stretching, use the same size.width for both x and y.
        matrix.scale(size.width / 2f, size.height / 2f)
        matrix.translate(1f, 1f)
        matrix.rotateZ(rotation)

        val path = morph.toPath(progress = percentage).asComposePath()
        path.transform(matrix)

        return Outline.Generic(path)
    }
}

@Preview
@Composable
private fun RotatingScallopedProfilePic() {
    val shapeA = remember {
        RoundedPolygon(
            12,
            rounding = CornerRounding(0.2f)
        )
    }
    val shapeB = remember {
        RoundedPolygon.star(
            12,
            rounding = CornerRounding(0.2f)
        )
    }
    val morph = remember {
        Morph(shapeA, shapeB)
    }
    val infiniteTransition = rememberInfiniteTransition("infinite outline movement")
    val animatedProgress = infiniteTransition.animateFloat(
        initialValue = 0f,
        targetValue = 1f,
        animationSpec = infiniteRepeatable(
            tween(2000, easing = LinearEasing),
            repeatMode = RepeatMode.Reverse
        ),
        label = "animatedMorphProgress"
    )
    val animatedRotation = infiniteTransition.animateFloat(
        initialValue = 0f,
        targetValue = 360f,
        animationSpec = infiniteRepeatable(
            tween(6000, easing = LinearEasing),
            repeatMode = RepeatMode.Reverse
        ),
        label = "animatedMorphProgress"
    )
    Box(
        modifier = Modifier.fillMaxSize(),
        contentAlignment = Alignment.Center
    ) {
        Image(
            painter = painterResource(id = R.drawable.dog),
            contentDescription = "Dog",
            contentScale = ContentScale.Crop,
            modifier = Modifier
                .clip(
                    CustomRotatingMorphShape(
                        morph,
                        animatedProgress.value,
                        animatedRotation.value
                    )
                )
                .size(200.dp)
        )
    }
}

このコードを実行すると、次のような面白い結果が得られます。

ハートの形
図 13. 回転するスカラップ形状でクリップされたプロフィール写真。

カスタム ポリゴン

正多角形から作成された形状がユースケースに合わない場合は、頂点のリストを使用して、よりカスタムな形状を作成できます。たとえば、次のようなハート型を作成するとします。

ハートの形
図 14. ハートの形。

この形状の個々の頂点を指定するには、x 座標と y 座標の float 配列を受け取る RoundedPolygon オーバーロードを使用します。

ハートのポリゴンを分解するには、点を指定するための極座標系を使用すると、デカルト(x、y)座標系を使用するよりも簡単になります。0° は右側から始まり、時計回りに進み、270° は 12 時の位置にあります。

ハートの形
図 15. 座標付きのハートの形。

各ポイントの中心からの角度(𝜭)と半径を指定することで、形状をより簡単に定義できるようになりました。

ハートの形
図 16. 座標付きのハート型。丸みはありません。

これで、頂点を作成して RoundedPolygon 関数に渡すことができます。

val vertices = remember {
    val radius = 1f
    val radiusSides = 0.8f
    val innerRadius = .1f
    floatArrayOf(
        radialToCartesian(radiusSides, 0f.toRadians()).x,
        radialToCartesian(radiusSides, 0f.toRadians()).y,
        radialToCartesian(radius, 90f.toRadians()).x,
        radialToCartesian(radius, 90f.toRadians()).y,
        radialToCartesian(radiusSides, 180f.toRadians()).x,
        radialToCartesian(radiusSides, 180f.toRadians()).y,
        radialToCartesian(radius, 250f.toRadians()).x,
        radialToCartesian(radius, 250f.toRadians()).y,
        radialToCartesian(innerRadius, 270f.toRadians()).x,
        radialToCartesian(innerRadius, 270f.toRadians()).y,
        radialToCartesian(radius, 290f.toRadians()).x,
        radialToCartesian(radius, 290f.toRadians()).y,
    )
}

頂点は、次の radialToCartesian 関数を使用してデカルト座標に変換する必要があります。

internal fun Float.toRadians() = this * PI.toFloat() / 180f

internal val PointZero = PointF(0f, 0f)
internal fun radialToCartesian(
    radius: Float,
    angleRadians: Float,
    center: PointF = PointZero
) = directionVectorPointF(angleRadians) * radius + center

internal fun directionVectorPointF(angleRadians: Float) =
    PointF(cos(angleRadians), sin(angleRadians))

上記のコードでは、ハートの未加工の頂点が得られますが、選択したハートの形状を得るには、特定の角を丸める必要があります。90° と 270° の角は丸められていませんが、他の角は丸められています。個々の角にカスタムの丸めを適用するには、perVertexRounding パラメータを使用します。

val rounding = remember {
    val roundingNormal = 0.6f
    val roundingNone = 0f
    listOf(
        CornerRounding(roundingNormal),
        CornerRounding(roundingNone),
        CornerRounding(roundingNormal),
        CornerRounding(roundingNormal),
        CornerRounding(roundingNone),
        CornerRounding(roundingNormal),
    )
}

val polygon = remember(vertices, rounding) {
    RoundedPolygon(
        vertices = vertices,
        perVertexRounding = rounding
    )
}
Box(
    modifier = Modifier
        .drawWithCache {
            val roundedPolygonPath = polygon.toPath().asComposePath()
            onDrawBehind {
                scale(size.width * 0.5f, size.width * 0.5f) {
                    translate(size.width * 0.5f, size.height * 0.5f) {
                        drawPath(roundedPolygonPath, color = Color(0xFFF15087))
                    }
                }
            }
        }
        .size(400.dp)
)

これにより、ピンクのハートが表示されます。

ハートの形
図 17. ハート型の結果。

上記の形状がユースケースに合わない場合は、Path クラスを使用してカスタム形状を描画するか、ディスクから ImageVector ファイルを読み込むことを検討してください。graphics-shapes ライブラリは、任意の形状に使用することを目的としたものではなく、角丸多角形とそれらの間のモーフィング アニメーションの作成を簡素化することを目的としています。

参考情報

詳細と例については、次のリソースをご覧ください。