rive library
Classes
- AABB
- AdvanceRequestInterface
- This interface is used internally to notify that something has changed that requires and advance/paint at a higher level.
- Animation
- Artboard
- ArtboardAtIndex
- Selects the artboard at the given index.
- ArtboardDefault
- Selects the default artboard.
- ArtboardNamed
- Selects the artboard with the given name.
- ArtboardPainter
- ArtboardSelector
- A selector for an artboard in a Rive file.
-
ArtboardWidgetPainter<
T extends ProceduralPainter> - ArtboardWidgetRiveRenderer
- AudioAsset
- AutoBind
- Auto-bind with a boolean value
- BasicArtboardPainter
- BindableArtboard
- BindByIndex
- Bind by index with a number value
- BindByInstance
- Bind by view model instance
- BindByName
- Bind by name with a string value
- BindEmpty
- Empty binding
- BitFieldLoc
- Location of an integer within a bitfield. https://en.wikipedia.org/wiki/C_syntax#Bit_fields
- BooleanInput
- CallbackHandler
- ClosureCallbackHandler
- Component
- CursorVisualPosition
- CustomBooleanProperty
- CustomNumberProperty
-
CustomProperty<
T> -
CustomPropertyInterface<
T> - CustomStringProperty
- DashPathEffect
- DataBind
- A data bind option for a Rive file.
- DataEnum
- A view model enum that represents a list of values.
- EmptyCallbackHandler
- Event
- EventInterface
- EventListenerInterface
- Factory
- File
- FileAsset
- FileAssetInterface
- FileLoader
- A class that loads a Rive file from an asset, URL, or file.
- FlutterRenderer
- FlutterRiveRenderBox
- FlutterRiveRendererWidget
- Font
- FontAsset
- GeneralEvent
- A general Rive event
- HitTester
- IAABB
- ImageAsset
- IndexRenderBuffer
- Input
- InternalViewModelInstanceAsset
- Mat2D
- NumberInput
- OpenUrlEvent
- An event for opening a URL
- PathCommand
- PathInterface
- PathMeasure
- ProceduralPainter
- ProjectionResult
- Result of projecting a point onto a segment.
- RawTextInput
- A low level text input helper. Takes high level input and creates shaped text, selection, and cursor. Does not handle scrolling internally.
- RenderBuffer
- Renderer
- RenderGradient
- RenderImage
- RenderLinearGradient
- RenderPaint
- RenderPath
- RenderRadialGradient
- RenderText
- RenderTexture
- RenderTexturePainter
- A painting context passed to a Rive RenderTexture widget which will invoke the paint method as necessary to paint into the texture with a Rive renderer.
- Rive
- RiveArtboardWidget
- RiveDefaults
- RiveFailed
- The state when the Rive file, controller, or view model instance fails to load.
- RiveFileWidget
- RiveLoaded
- The state when the Rive file is loaded and the controller is created.
- RiveLoading
- The state when the Rive file is still loading.
- RiveNative
- RiveNativeRenderBox
- RivePainter
- Base class for a Rive painter.
- RivePanel
- A widget that creates a shared texture to paint multiple RiveWidgets to.
- RiveProceduralRenderingWidget
-
RiveRenderBox<
T extends RivePainter> - Inherited widget that will pass the background render texture down the tree
- RiveState
- The state of the RiveBuilder widget.
- RiveWidget
- A widget that displays a Rive artboard.
- RiveWidgetBuilder
- A widget that builds a Rive file.
- RiveWidgetController
- This controller builds on top of the concept of a Rive painter, but provides a more convenient API for building Rive widgets.
- Segment2D
- A line segment with a discrete start and end.
- EXPERIMENTAL: This API may change or be removed in a future release.
- EXPERIMENTAL: This API may change or be removed in a future release.
- Renderers the artboard to a sharedTexture.
- SingleAnimationPainter
- StateMachine
- StateMachineAtIndex
- Selects the state machine at the given index.
- StateMachineDefault
- Selects the default state machine.
- StateMachineNamed
- Selects the state machine with the given name.
- StateMachinePainter
- StateMachineSelector
- A selector for a state machine in a Rive file.
- TransformComponents
- TransformingHitTester
- A HitTester with a settable transform. We can roll this into HitTester if we like it.
- TriggerInput
- TrimPathEffect
- UnimplementedRenderTexture
- UnknownAsset
- Vec2D
- VertexRenderBuffer
- ViewModel
- A Rive View Model as created in the Rive editor.
- ViewModelInstance
- An instance of a Rive ViewModel that can be used to access and modify properties in the view model.
- ViewModelInstanceArtboard
- ViewModelInstanceAssetImage
- A Rive view model property of type RenderImage that represents an asset image value.
- ViewModelInstanceBoolean
- A Rive view model property of type bool that represents a boolean value.
- ViewModelInstanceCallbacks
- ViewModelInstanceColor
- A Rive view model property of type Color that represents a color value.
- ViewModelInstanceEnum
- A Rive view model property of type String that represents an enumerator value.
- ViewModelInstanceList
- A Rive view model property of type List<ViewModelInstance> that represents a list of view model instances.
- ViewModelInstanceNumber
- A Rive view model property of type double that represents a number value.
-
ViewModelInstanceObservableValue<
T> - ViewModelInstanceString
- A Rive view model property of type String that represents a string value.
- ViewModelInstanceSymbolListIndex
- A Rive view model property of type int that represents the list index.
- ViewModelInstanceTrigger
- A Rive view model property of type bool that represents a trigger value.
- ViewModelInstanceValue
- ViewModelProperty
- A representation of a property in a Rive view model.
Enums
- CursorBoundary
- CustomPropertyType
- The custom property type
- DataType
- The type of data that a view model property can hold.
- EventType
- Type of Rive event
- Fit
- HitResult
- OpenUrlTarget
- The target for opening a URL
- PaintingStyle
- PathDirection
- PathFillRule
- PathFillType
- PathVerb
- RiveHitTestBehavior
- How to behave during hit tests on Rive Listeners (hit targets).
- TrimPathMode
Mixins
- AdvanceRequestMixin
- Shared implementation of AdvanceRequestInterface.
- DeformableBehavior
- EventListenerMixin
- EventPropertyMixin
- RivePointerEventMixin
- Mixin that provides methods for handling pointer events on a RivePainter.
- ViewModelInstanceCallbackMixin
-
ViewModelInstanceObservableValueMixin<
T> - A mixin that implements the ViewModelInstanceObservableValue interface and provides the basic functionality for handling listeners (observables) and notifying them of changes. This allows users to observe changes to the underlying Rive property value.
Extensions
Constants
- circleConstant → const double
- Use this for perfect rounded corners. https://stackoverflow.com/questions/1734745/how-to-create-circle-with-b%C3%A9zier-curves
- icircleConstant → const double
Typedefs
- AssetLoaderCallback = bool Function(FileAsset fileAsset, Uint8List? bytes)
- Controller = RiveWidgetController Function(File file)
- A function that builds a controller based on the Rive file.
- OnRiveEvent = void Function(Event event)
- A Rive event listener callback
- RiveBuilder = Widget Function(BuildContext context, RiveState state)
- A function that builds a widget based on the state of the Rive file.
- RiveOnFailed = void Function(Object error, StackTrace stackTrace)
- A function that is called when the Rive state failed to load.
- RiveOnLoaded = void Function(RiveLoaded state)
- A function that is called when the Rive state is loaded.
Exceptions / Errors
- RiveArtboardException
- An exception that is thrown when a Rive Artboard fails to load.
- RiveDataBindException
- An exception that is thrown when a data bind fails.
- RiveException
- A base class for all Rive exceptions.
- RiveFileLoaderException
- An exception that is thrown when a Rive FileLoader fails to load.
- RiveStateMachineException
- An exception that is thrown when a Rive State Machine fails to load.