effects library

Classes

AnchorByEffect
An AnchorEffect that changes its target's anchor by the specified offset.
AnchorEffect
Base class for effects that affect the anchor of their targets.
AnchorProvider
Interface for a component that can be affected by anchor effects.
AnchorToEffect
An effect that moves the target's anchor to the specified value.
AngleProvider
Interface for a component that can be affected by rotation effects.
ColorEffect
Change the color of a component over time.
ComponentEffect<T extends Component>
Base class for effects that target a Component of type T.
CurvedEffectController
A controller that grows non-linearly from 0 to 1 following the provided curve. The duration cannot be 0.
DelayedEffectController
An effect controller that waits for delay seconds before running the child controller. While waiting, the progress will be reported at 0.
DurationEffectController
Abstract class for an effect controller that has a predefined duration.
Effect
An Effect is a component that changes properties or appearance of another component over time.
EffectController
Base "controller" class to facilitate animation of effects.
GlowEffect
Change the MaskFilter on Paint of a component over time.
InfiniteEffectController
Effect controller that wraps a child effect controller and repeats it infinitely.
LinearEffectController
A controller that grows linearly from 0 to 1 over duration seconds.
MoveAlongPathEffect
This effect will move the target along the specified path, which may contain curved segments, but must be simply-connected.
MoveByEffect
A MoveEffect that moves its target by the specified offset vector.
MoveEffect
Base class for effects that affect the position of their targets.
MoveToEffect
A MoveEffect that moves its target towards the given destination point.
OpacityEffect
Change the opacity of a component over time.
OpacityProvider
Interface for a component that can be affected by opacity effects. Value of opacity must be in the range of 0-1 (both inclusive).
PauseEffectController
A controller that keeps constant progress over duration seconds.
PositionProvider
Interface for a component that can be affected by move effects.
RandomEffectController
An EffectController that wraps another effect controller child and randomizes its duration after each reset.
RandomVariable
RandomVariable is an object capable of producing random values with the prescribed distribution function. Each distribution is implemented within its own derived class.
ReadOnlyAngleProvider
Interface for a class that has angle property which can be read but not modified.
ReadOnlyPositionProvider
Interface for a class that has position property which can be read but not modified.
ReadOnlyScaleProvider
Interface for a class that has scale property which can be read but not modified.
ReadOnlySizeProvider
Interface for a class that has size property which can be read but not modified.
RemoveEffect
This simple effect, when attached to a component, will cause that component to be removed from the game tree after delay seconds.
RepeatedEffectController
Effect controller that repeats child controller a certain number of times.
ReverseCurvedEffectController
A controller that grows non-linearly from 1 to 0 following the provided curve. The duration cannot be 0.
ReverseLinearEffectController
A controller that grows linearly from 1 to 0 over duration seconds.
RotateEffect
Rotate a component around its anchor.
ScaleEffect
Scale a component.
ScaleProvider
Interface for a component that can be affected by scale effects.
SequenceEffect
Run multiple effects in a sequence, one after another.
SequenceEffectController
An effect controller that executes a list of other controllers one after another.
SineEffectController
This effect controller follows a sine wave.
SizeEffect
Change the size of a component over time.
SizeProvider
Interface for a component that can be affected by size effects.
SpeedEffectController
This controller can force execution of an effect at a predefined speed.
Transform2DEffect
Base class for effects that target a Transform2D property.
ZigzagEffectController
This effect controller goes from 0 to 1, then back to 0, then to -1, and then again to 0.

Mixins

EffectTarget<T>
Mixin adds field target of type T to an Effect. The target can be either set explicitly by the effect class, or acquired automatically from the effect's parent when mounting.
HasSingleChildEffectController<T extends EffectController>
This mixin must be used with EffectControllers that wrap a single child effect controller of type T.