TickerSignal class
Ticker signal used to drive animations and can create animation controllers
void main() {
final ticker = TickerSignal(); // could be a global
final controller = ticker.toAnimationController(); // can be local or global
final curve = CurvedAnimation(parent: controller, curve: Curves.easeOut); // can be used outside of widget tree
final alpha = IntTween(begin: 0, end: 255).animate(curve);
...
final alphaSignal = alpha.toSignal(); // can be converted to a signal
}
- Inheritance
- Implemented types
Constructors
- TickerSignal({Duration? initialDuration, String? debugLabel})
- Ticker signal used to drive animations and can create animation controllers
Properties
- autoDispose ↔ bool
-
Throws and error if read after dispose and can be
disposed on last unsubscribe.
getter/setter pairinherited
- brand → Symbol
-
finalinherited
- debugLabel → String?
-
Debug label for Debug Mode
finalinherited
- disposed ↔ bool
-
Check if the effect is disposed
getter/setter pairinherited
- equalityCheck ↔ bool Function(Duration a, Duration b)
-
Optional method to check if to values are the same
getter/setter pairinherited
- globalId → int
-
Global ID of the signal
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- internalValue ↔ Duration
-
getter/setter pairinherited
- isInitialized ↔ bool
-
Check if the value is set and not a lazy signal
getter/setter pairinherited
- node ↔ Node?
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- targets ↔ Node?
-
getter/setter pairinherited
- value ↔ Duration
-
Compute the current value
getter/setter pairinherited
- version ↔ int
-
Version numbers should always be >= 0, because the special value -1 is used
by Nodes to signify potentially unused but recyclable nodes.
getter/setter pairinherited
Methods
-
afterCreate(
Duration val) → void -
Internal hook for after a signal is created
inherited
-
beforeUpdate(
Duration val) → void -
Internal hook for after a signal is updated
inherited
-
call(
) → Duration -
Return the value when invoked
inherited
-
createTicker(
TickerCallback onTick) → Ticker -
Creates a ticker with the given callback.
override
-
dispose(
) → void -
Dispose the signal
override
-
get(
) → Duration -
Helper method to get the current value
inherited
-
internalRefresh(
) → bool -
inherited
-
internalSetValue(
Duration val) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onDispose(
void cleanup()) → EffectCleanup -
Add a cleanup function to be called when the signal is disposed
inherited
-
overrideWith(
Duration val) → Signal< Duration> -
Override the current signal with a new value as if it was created with it
inherited
-
peek(
) → Duration -
In the rare instance that you have an effect that should write to another signal based on the previous value, but you don't want the effect to be subscribed to that signal, you can read a signals's previous value via
signal.peek().inherited -
readonly(
) → ReadonlySignal< Duration> -
Returns a readonly signal
inherited
-
set(
Duration val, {bool force = false}) → bool -
Set the current value by a method
inherited
-
subscribe(
void fn(Duration value)) → void Function() -
Subscribe to value changes with a dispose function
inherited
-
subscribeToNode(
Node node) → void -
inherited
-
toAnimationController(
{double? value, Duration? duration, Duration? reverseDuration, String? debugLabel, double lowerBound = 0.0, double upperBound = 1.0, AnimationBehavior animationBehavior = AnimationBehavior.normal}) → AnimationController - Create a new AnimationController
-
toJson(
) → dynamic -
Convert value to JSON
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
unsubscribeFromNode(
Node node) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited