SpriteButton class
A StatelessWidget that uses Sprites to render a pressable button.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SpriteButton
Constructors
- SpriteButton.new({required Sprite sprite, required Sprite pressedSprite, required void onPressed()?, required double width, required double height, Widget? label, Vector2? srcPosition, Vector2? srcSize, Vector2? pressedSrcPosition, Vector2? pressedSrcSize, Sprite? disabledSprite, Vector2? disabledSrcPosition, Vector2? disabledSrcSize, EdgeInsets pressedInsets = const EdgeInsets.only(top: 5), WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Key? key})
- SpriteButton.asset({required String path, required String pressedPath, required void onPressed()?, required double width, required double height, Widget? label, Images? images, Vector2? srcPosition, Vector2? srcSize, Vector2? pressedSrcPosition, Vector2? pressedSrcSize, String? disabledPath, Vector2? disabledSrcPosition, Vector2? disabledSrcSize, EdgeInsets pressedInsets = const EdgeInsets.only(top: 5), WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Key? key})
-
Loads the images from the asset
pathandpressedPathand renders it as a widget. -
SpriteButton.future({required Future<
Sprite> sprite, required Future<Sprite> pressedSprite, required void onPressed()?, required double width, required double height, Widget? label, Vector2? srcPosition, Vector2? srcSize, Vector2? pressedSrcPosition, Vector2? pressedSrcSize, Future<Sprite> ? disabledSprite, Vector2? disabledSrcPosition, Vector2? disabledSrcSize, EdgeInsets pressedInsets = const EdgeInsets.only(top: 5), WidgetBuilder? errorBuilder, WidgetBuilder? loadingBuilder, Key? key})
Properties
- disabledSrcPosition → Vector2?
-
Holds the position of the disabled sprite on the image.
final
- disabledSrcSize → Vector2?
-
Holds the size of the disabled sprite on the image.
final
- errorBuilder → WidgetBuilder?
-
A builder function that is called if the loading fails.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double
-
The height of the button.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → Widget?
-
The widget that will be rendered on top of the button.
final
- loadingBuilder → WidgetBuilder?
-
A builder function that is called while the loading is on the way.
final
- onPressed → void Function()?
-
The function that will be called when the button is pressed.
final
- pressedInsets → EdgeInsets
-
The offset of the button when pressed.
final
- pressedSrcPosition → Vector2?
-
Holds the position of the pressed sprite on the image.
final
- pressedSrcSize → Vector2?
-
Holds the size of the pressed sprite on the image.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- srcPosition → Vector2?
-
Holds the position of the sprite on the image.
final
- srcSize → Vector2?
-
Holds the size of the sprite on the image.
final
- width → double
-
The width of the button.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
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