DurationEffectController class abstract

Abstract class for an effect controller that has a predefined duration.

This effect controller cannot be used directly, instead it serves as base for some other effect controller classes.

The primary functionality offered by this class is the timer property, which keeps track of how much time has passed within this controller. The effect controller will be considered completed when the timer reaches the duration value.

Inheritance

• Object
• EffectController
• DurationEffectController

Implementers

• CurvedEffectController
• LinearEffectController
• PauseEffectController
• ReverseCurvedEffectController
• ReverseLinearEffectController
• SineEffectController
• ZigzagEffectController

Constructors

DurationEffectController(double duration)

Properties

completed → bool

Has the effect already finished?

no setter, override

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 pair, override-getter

hashCode → int

The hash code for this object.

no setter, inherited

isInfinite → bool

Will the effect continue to run forever (never completes)?

no setter, inherited

isRandom → bool

Is the effect's duration random or fixed?

no setter, inherited

progress → double

The current progress of the effect, a value between 0 and 1.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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 setter, inherited

timer → double

no setter

Methods

advance(double dt) → double

Advances this controller's internal clock by dt seconds.

override

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.

override

setToEnd() → void

Puts the controller into its final "completed" state.

override

setToStart() → void

Reverts the controller to its initial state, as it was before the start of the animation.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited