-
@Stable() public final class RiveFileA Rive file, which contains one or more artboards, state machines, and view model instances.
A Rive file is created from the Rive editor, which is exported as a
.rivfile.The this object can be used to query the file for its contents, such as artboards names. It can then be passed to rememberArtboard to create an Artboard, and then to RiveUI for rendering.
Queries are cached for performance.
-
-
Constructor Summary
Constructors Constructor Description RiveFile(FileHandle fileHandle, CommandQueue commandQueue, CoroutineScope parentScope)
-
Method Summary
Modifier and Type Method Description final List<String>getArtboardNames()final List<String>getViewModelNames()final List<String>getViewModelInstanceNames(String viewModel)final List<ViewModel.Property>getViewModelProperties(String viewModel)final List<File.Enum>getEnums()-
-
Constructor Detail
-
RiveFile
RiveFile(FileHandle fileHandle, CommandQueue commandQueue, CoroutineScope parentScope)
- Parameters:
fileHandle- The handle to the file on the command server.commandQueue- The command queue that owns and performs operations on this file.parentScope- The coroutine scope to use for launching coroutines.
-
-
Method Detail
-
getArtboardNames
final List<String> getArtboardNames()
-
getViewModelNames
final List<String> getViewModelNames()
-
getViewModelInstanceNames
final List<String> getViewModelInstanceNames(String viewModel)
-
getViewModelProperties
final List<ViewModel.Property> getViewModelProperties(String viewModel)
-
-
-
-