Fit

sealed class Fit

Describes how size differences are handled between an authored Rive artboard and its containing view.

Inheritors

Types

Contain

data class Contain(val alignment: Alignment = Alignment.Center) : Fit

Preserve aspect ratio and scale the artboard so that its larger dimension matches the corresponding dimension of the containing view.

Cover

data class Cover(val alignment: Alignment = Alignment.Center) : Fit

Preserve aspect ratio and scale the artboard so that its smaller dimension matches the corresponding dimension of the containing view.

Fill

object Fill : Fit

Do not preserve aspect ratio and stretch to the containing view's dimensions.

FitHeight

data class FitHeight(val alignment: Alignment = Alignment.Center) : Fit

Preserve aspect ratio and scale the artboard height to match the containing view's height.

FitWidth

data class FitWidth(val alignment: Alignment = Alignment.Center) : Fit

Preserve aspect ratio and scale the artboard width to match the containing view's width.

Layout

data class Layout(val scaleFactor: Float = 1.0f) : Fit

Invokes the Rive layout engine to apply responsive layout to the artboard. This assumes that the artboard was designed with layouts in mind.

None

data class None(val alignment: Alignment = Alignment.Center) : Fit

Do not scale. Use the artboard's original dimensions.

ScaleDown

data class ScaleDown(val alignment: Alignment = Alignment.Center) : Fit

Preserve aspect ratio and behave like Fit.Contain when the artboard is larger than the containing view. Otherwise, use the artboard's original dimensions.

Properties

alignment

open val alignment: Alignment

Default alignment. Not relevant for all fit modes, but still passed when drawing or on pointer events.

scaleFactor

open val scaleFactor: Float = 1.0f

Default scale factor. Only relevant with Fit.Layout, but still passed when drawing or on pointer events.