Node class
A base class for all objects that can be added to the sprite node tree and rendered to screen using SpriteBox and SpriteWidget.
The Node class itself doesn't render any content, but provides the basic functions of any type of node, such as handling transformations and user input. To render the node tree, a root node must be added to a SpriteBox or a SpriteWidget. Commonly used sub-classes of Node are Sprite, NodeWithSize, and many more upcoming subclasses.
Nodes form a hierarchical tree. Each node can have a number of children, and the transformation (positioning, rotation, and scaling) of a node also affects its children.
- Implemented by
Constructors
Properties
- actions → ActionController
-
The ActionController associated with this node. [...]
read-only
- children → List<Node>
-
A list of the children of this node. [...]
read-only
- constraints ↔ List<Constraint>
-
A List of Constraints that will be applied to the node.
The constraints are applied after the update method has been called.
read / write
- handleMultiplePointers ↔ bool
-
If set to true the node will receive multiple pointers, otherwise it will only receive events the first pointer. [...]
read / write
- inverseTransformMatrix → Matrix4
-
The inverse transform matrix used by this node.
read-only
- parent → Node
-
The parent of this node, or null if it doesn't have a parent. [...]
read-only
- paused ↔ bool
-
Decides if the node and its children is currently paused. [...]
read / write
- position ↔ Offset
-
The position of this node relative to its parent. [...]
read / write
- rotation ↔ double
-
The rotation of this node in degrees. [...]
read / write
- scale ↔ double
-
The scale of this node relative its parent. [...]
read / write
- scaleX ↔ double
-
The horizontal scale of this node relative its parent. [...]
read / write
- scaleY ↔ double
-
The vertical scale of this node relative its parent. [...]
read / write
- skewX ↔ double
-
The skew along the x-axis of this node in degrees. [...]
read / write
- skewY ↔ double
-
The skew along the y-axis of this node in degrees. [...]
read / write
- spriteBox → SpriteBox
-
The SpriteBox this node is added to, or null if it's not currently added to a SpriteBox. [...]
read-only
- transformMatrix → Matrix4
-
The transformMatrix describes the transformation from the node's parent. [...]
read-only
- userInteractionEnabled ↔ bool
-
The node will receive user interactions, such as pointer (touch or mouse) events. [...]
read / write
- visible ↔ bool
-
The visibility of this node and its children.
read / write
- zPosition ↔ double
-
The draw order of this node compared to its parent and its siblings. [...]
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
addChild(
Node child) → void - Adds a child to this node. [...]
-
applyConstraints(
double dt) → void - Called to apply the constraints to the node. Normally, this method is called automatically by the SpriteBox, but it can be called manually if the constraints need to be applied immediately.
-
computeTransformMatrix(
) → Matrix4 - Computes the transformation matrix of this node. This method can be overriden if a custom matrix is required. There is usually no reason to call this method directly.
-
convertPointFromNode(
Offset point, Node node) → Offset -
Converts a
point
from anothernode
s coordinate system into the local coordinate system of this node. [...] -
convertPointToBoxSpace(
Offset nodePoint) → Offset - Converts a point from the local coordinate system of the node to the coordinate system of the SpriteBox. [...]
-
convertPointToNodeSpace(
Offset boxPoint) → Offset - Converts a point from the coordinate system of the SpriteBox to the local coordinate system of the node. [...]
-
handleEvent(
SpriteBoxEvent event) → bool - Handles an event, such as a pointer (touch or mouse) event. [...]
-
invalidateTransformMatrix(
) → void - Invalidates the current transform matrix. If the computeTransformMatrix method is overidden, this method should be called whenever a property changes that affects the matrix.
-
isPointInside(
Offset point) → bool -
Returns true if the
point
is inside the node, thepoint
is in the local coordinate system of the node. [...] -
paint(
Canvas canvas) → void - Paints this node to the canvas. [...]
-
removeAllChildren(
) → void - Removes all children of this node. [...]
-
removeChild(
Node child) → void - Removes a child from this node. [...]
-
removeFromParent(
) → void - Removes this node from its parent node. [...]
-
spriteBoxPerformedLayout(
) → void - Called whenever the SpriteBox is modified or resized, or if the device is rotated. [...]
-
update(
double dt) → void - Called before a frame is drawn. [...]
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
other) → bool -
The equality operator. [...]
inherited