Rive Android/app.rive/ViewModelSource

ViewModelSource

sealed interface ViewModelSource

One half of a source for a ViewModelInstance. This represents the view model that originates the instance. This can be either Named to refer to a specific view model, or DefaultForArtboard, which will use the default view model for the given Artboard. This is usually the one the designer has intended to be used with the artboard.

The ViewModelInstanceSource is the other half, which represents the specific view model instance. The helper methods on this interface are provided as a builder pattern.

Inheritors

DefaultForArtboard

Types

DefaultForArtboard

value class DefaultForArtboard(val artboard: Artboard) : ViewModelSource

The default view model for the given artboard.

value class Named(val viewModelName: String) : ViewModelSource

A specific view model by name.

Functions

open fun blankInstance(): ViewModelInstanceSource

A view model instance with default initialized properties.

defaultInstance

open fun defaultInstance(): ViewModelInstanceSource

The instance marked "Default" in the Rive file.

open fun namedInstance(instanceName: String): ViewModelInstanceSource

A specific instance by name.