FollowEffect class - ignis library

Constructors

FollowEffect({required PositionOwner following, required double speed, bool? cleanup, bool? enabled, int? priority})

Properties

ancestors → Iterable<Node>: This node's ancestors in the tree.
no setterinherited
children → Iterable<Node>: This node's direct children.
no setterinherited
cleanup ↔ bool: Whether to detach once finished. Defaults to false.
getter/setter pairinherited
descendants → Iterable<Node>: This node's descendants in depth-first preorder.
no setterinherited
destination → Vector2: Where target is currently moving toward.
no setter
enabled ↔ bool: Whether this node updates and renders. Defaults to true.
getter/setter pairinherited
following → PositionOwner: Where target moves toward.
final
hashCode → int: The hash code for this object.
no setterinherited
hasParent → bool: True if this node has a non-null parent.
no setterinherited
isMounted → bool: True while this node is part of a mounted tree.
no setterinherited
onFinish → Signal0: Emitted once, when this effect finishes progressing.
finalinherited
onMount → Signal0: Emitted when this node is added to a scene.
finalinherited
onSceneResize → Signal1<Vector2>: Emitted when the scene resizes, and once at mount.
finalinherited
onUnmount → Signal0: Emitted when this node is removed from a scene.
finalinherited
parent → Node?: The parent that owns this node, or null when it is parentless.
no setterinherited
priority ↔ int: This node's order in updating and rendering in its parent. Defaults to 0.
getter/setter pairinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scene → Scene<Node>: This node's owning scene. Only valid while isMounted.
no setterinherited
speed ↔ double: How fast target closes the distance to following.
getter/setter pair
target → PositionOwner?: The PositionOwner whose position is mutated by this effect.
no setter

Methods

add<T extends Node>(T node) → T: Adds node to this node. The node is returned.
inherited
addAll(Iterable<Node> nodes) → void: Adds all nodes to this node.
inherited
attach(Node node) → void: Adds this node to the target node.
inherited
build() → void: Declares this node's children and behavior.
override
contains(Node other) → bool: Checks if this node contains the other node in its tree.
inherited
containsPoint(Vector2 point) → bool: Whether this node's hit area contains point.
inherited
cycles(Node node) → bool: True if node is (or soon will be) an ancestor of this node.
inherited
debugDraw(DebugDraw draw) → void: Draws to the debug overlay every frame, in the same space as draw.
inherited
debugRender(Canvas canvas) → void: Renders the debug overlay for this node and its children to canvas.
inherited
debugRenderSelf(Canvas canvas) → void: Runs this node's debugDraw callbacks, in the same space as renderSelf.
inherited
detach() → bool: Removes this node from its parent, or from the parent it is on its way to.
inherited
disable() → void: Disables this node, so it stops updating and rendering.
inherited
draw(Draw draw) → void: Draws to canvas every frame, in this node's own coordinate space.
inherited
enable() → void: Enables this node, so it resumes updating and rendering.
inherited
hitTest(Vector2 point) → Iterable<Node>: Finds every enabled node in this subtree whose hit area contains point, per containsPoint, topmost first.
inherited
mount() → Scene<T>: Available on T, provided by the Mount extension
Mounts this node as the root of a new Scene and returns it.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
owns(Node other) → bool: Checks if this node owns the other node.
inherited
provide<T>(T value) → void: Provides value as this node's instance of T, overwriting any value previously provided for T.
inherited
query<T extends Node>() → Iterable<T>: This node's direct children of type T, in priority order.
inherited
read<T>() → T: Reads the nearest instance of T provided by this node or an ancestor, checking this node first.
inherited
readOrNull<T>() → T?: Reads the nearest instance of T provided by this node or an ancestor, checking this node first. Returns null if none was provided.
inherited
reassemble() → void: What this node does when the tree is reassembled.
inherited
rebuild() → void: Re-derives this node by running build again over the wreckage of the last one.
inherited
remove(Node node) → bool: Removes the child node.
inherited
removeAll() → void: Removes all children.
inherited
render(Canvas canvas) → void: Renders this node and its children to canvas.
inherited
renderSelf(Canvas canvas) → void: Runs this node's draw callbacks.
inherited
reset() → void: Resets this effect back to its start.
override
tick(Tick tick) → void: Calls tick with the elapsed seconds on every frame.
inherited
toString() → String: A string representation of this object.
inherited
trash(Cleanup cleanup) → void: Defers cleanup until this build stops being current.
inherited
update(double dt) → void: Updates this node and its children by dt seconds.
inherited

Operators

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