CustomAnimationBuilder<T> class

A builder that plays a custom animation with a given tween and duration. It can be controlled with control.

Inheritance

Constructors

CustomAnimationBuilder({required ValueWidgetBuilder<T> builder, required Animatable<T> tween, required Duration duration, Control control = Control.play, Curve curve = Curves.linear, Duration delay = Duration.zero, double startPosition = 0.0, Widget? child, AnimationStatusListener? animationStatusListener, int? fps, bool developerMode = false, VoidCallback? onStarted, VoidCallback? onCompleted, Key? key})
const

Properties

animationStatusListener AnimationStatusListener?
Exposed AnimationStatusListener from the internal AnimationController.
final
builder ValueWidgetBuilder<T>
Builds the animation frame.
final
child Widget?
A child that's passed into the builder function.
final
control Control
Current execution command of the animation.
final
curve Curve
The curve of the animation. By default it's Curves.linear.
final
delay Duration
The delay before the animation starts.
final
developerMode bool
Connects to the closest AnimationDeveloperTools in the widget tree.
final
duration Duration
The duration of the animation.
final
fps int?
Limits the framerate of the animation if set.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onCompleted VoidCallback?
Called when the animation completes.
final
onStarted VoidCallback?
Called when the animation starts.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
startPosition double
The relative position where the animation starts. The value must be between 0.0 and 1.0, where 0.0 is the beginning of the animation and 1.0 is the end of the animation.
final
tween Animatable<T>
The tween to animate.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _CustomAnimationBuilderState<T>
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}) 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