Label class

Labels are used to display a string of text in a the node tree. To align the label, the textAlign property of the TextStyle can be set.

Inheritance

Constructors

Label(String _text, {TextStyle? textStyle, TextAlign? textAlign})
Creates a new Label with the provided text and textStyle.

Properties

children List<Node>
A list of the children of this node.
no setterinherited
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.
getter/setter pairinherited
handleMultiplePointers bool
If set to true the node will receive multiple pointers, otherwise it will only receive events the first pointer.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
inverseTransformMatrix Matrix4
The inverse transform matrix used by this node.
no setterinherited
motions MotionController
The MotionController associated with this node.
no setterinherited
parent Node?
The parent of this node, or null if it doesn't have a parent.
no setterinherited
paused bool
Decides if the node and its children is currently paused.
getter/setter pairinherited
position Offset
The position of this node relative to its parent.
getter/setter pairinherited
rotation double
The rotation of this node in degrees.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scale double
The scale of this node relative its parent.
getter/setter pairinherited
scaleX double
The horizontal scale of this node relative its parent.
getter/setter pairinherited
scaleY double
The vertical scale of this node relative its parent.
getter/setter pairinherited
skewX double
The skew along the x-axis of this node in degrees.
getter/setter pairinherited
skewY double
The skew along the y-axis of this node in degrees.
getter/setter pairinherited
spriteBox SpriteBox?
The SpriteBox this node is added to, or null if it's not currently added to a SpriteBox.
no setterinherited
text String
The text being drawn by the label.
getter/setter pair
textAlign TextAlign
How the text should be aligned horizontally.
getter/setter pair
textStyle TextStyle
The style to draw the text in.
getter/setter pair
transformMatrix Matrix4
The transformMatrix describes the transformation from the node's parent.
no setterinherited
userInteractionEnabled bool
The node will receive user interactions, such as pointer (touch or mouse) events.
getter/setter pairinherited
visible bool
The visibility of this node and its children.
getter/setter pairinherited
zPosition double
The draw order of this node compared to its parent and its siblings.
getter/setter pairinherited

Methods

addChild(Node child) → void
Adds a child to this node.
inherited
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.
inherited
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.
inherited
convertPointFromNode(Offset point, Node node) Offset
Converts a point from another nodes coordinate system into the local coordinate system of this node.
inherited
convertPointToBoxSpace(Offset nodePoint) Offset
Converts a point from the local coordinate system of the node to the coordinate system of the SpriteBox.
inherited
convertPointToNodeSpace(Offset boxPoint) Offset
Converts a point from the coordinate system of the SpriteBox to the local coordinate system of the node.
inherited
handleEvent(SpriteBoxEvent event) bool
Handles an event, such as a pointer (touch or mouse) event.
inherited
handleKeyboardEvent(KeyEvent event) bool
Handles a keyboard event.
inherited
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.
inherited
isPointInside(Offset point) bool
Returns true if the point is inside the node, the point is in the local coordinate system of the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paint(Canvas canvas) → void
Paints this node to the canvas.
override
removeAllChildren() → void
Removes all children of this node.
inherited
removeChild(Node child) → void
Removes a child from this node.
inherited
removeFromParent() → void
Removes this node from its parent node.
inherited
spriteBoxPerformedLayout() → void
Called whenever the SpriteBox is modified or resized, or if the device is rotated.
inherited
toString() String
A string representation of this object.
inherited
update(double dt) → void
Called before a frame is drawn.
inherited

Operators

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