ParticleController class

The ParticleController is passed as a parameter to onTick and onInit and provides access to all of the run-time properties used to render the field, including the sprite sheet, list of particles, global opacity, blendmode, origin, and anchor.

These properties can be changed to modify the behavior of a running particle field.

Mixed-in types

• ChangeNotifier

Constructors

ParticleController({required ParticleFieldTick onTick, required ImageFrameProvider spriteSheet, ParticleFieldInit? onInit, required BlendMode blendMode, required Alignment origin, required Alignment anchor})

Properties

anchor ↔ Alignment

See ParticleField.anchor.

getter/setter pair

blendMode ↔ BlendMode

See ParticleField.blendMode.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

onInit ↔ ParticleFieldInit?

See ParticleField.onInit.

getter/setter pair

onTick ↔ ParticleFieldTick

See ParticleField.onTick.

getter/setter pair

opacity ↔ double

Global opacity for the particle field. For example, this could be used to fade all of the particles in or out.

getter/setter pair

origin ↔ Alignment

See ParticleField.origin.

getter/setter pair

particles ↔ List<Particle>

The list of Particle instances being managed and displayed.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

spriteSheet ↔ ImageFrameProvider

See ParticleField.spriteSheet.

getter/setter pair

Methods

addListener(VoidCallback listener) → void

Register a closure to be called when the object changes.

inherited

dispose() → void

Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).

inherited

executeOnTick(Size size) → void

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListeners() → void

Call all the registered listeners.

inherited

removeListener(VoidCallback listener) → void

Remove a previously registered closure from the list of closures that are notified when the object changes.

inherited

tick(Duration elapsed) → void

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited