SpriteWidget class

A StatelessWidget which renders a Sprite To render an animation, use SpriteAnimationWidget.

Inheritance

Constructors

SpriteWidget({required Sprite sprite, Anchor anchor = Anchor.topLeft, double angle = 0, WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Paint? paint, bool rasterize = false, Size? size, Key? key})
renders the sprite as a Widget.
const
SpriteWidget.asset({required String path, Images? images, Anchor anchor = Anchor.topLeft, double angle = 0, Vector2? srcPosition, Vector2? srcSize, WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Paint? paint, bool rasterize = false, Size? size, String? package, Key? key})
Load the image from the asset path and renders it as a widget.

Properties

anchor → Anchor
The positioning Anchor
final
angle → double
The angle to rotate this Sprite, in rad. (default = 0)
final
errorBuilder → WidgetBuilder?
A builder function that is called if the loading fails
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingBuilder → WidgetBuilder?
A builder function that is called while the loading is on the way
final
paint → Paint?
A custom Paint to be used when rendering the sprite. When omitted the default paint from the Sprite class will be used.
final
rasterize → bool
If the Sprite should be rasterized or not.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → Size?
The size of the widget. If null, the widget will fill the available space.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SpriteWidget>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited