PauseEffectController class

A controller that keeps constant progress over duration seconds.

Since "progress" represents the "logical time" of an Effect, keeping the progress constant over some time is equivalent to freezing in time or pausing the effect for the prescribed duration.

This controller is best used in combination with other controllers. For example, you can create a repeated controller where the progress changes 0->1->0 over a short period of time, then pauses, and this sequence repeats.

Inheritance

Constructors

PauseEffectController(double duration, {required double progress})

Properties

completed → bool
Has the effect already finished?
no setterinherited
duration ↔ double
Total duration of the effect. If the duration cannot be determined, this will return null. For an infinite effect the duration is infinity.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
isInfinite → bool
Will the effect continue to run forever (never completes)?
no setterinherited
isRandom → bool
Is the effect's duration random or fixed?
no setterinherited
progress → double
The current progress of the effect, a value between 0 and 1.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
started → bool
Has the effect started running? Some effects use a "delay" parameter to postpone the start of an animation. This property then tells you whether this delay period has already passed.
no setterinherited
timer → double
no setterinherited

Methods

advance(double dt) → double
Advances this controller's internal clock by dt seconds.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onMount(Effect parent) → void
This is called by the Effect class when the controller is attached to that effect. Controllers with children should propagate this to their children.
inherited
recede(double dt) → double
Similar to advance(), but makes the effect controller move back in time.
inherited
setToEnd() → void
Puts the controller into its final "completed" state.
inherited
setToStart() → void
Reverts the controller to its initial state, as it was before the start of the animation.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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