A Node that provides an intermediate rendering surface in the sprite rendering tree. A Layer can be used to change the opacity, color, or to apply an effect to a set of nodes. All nodes that are children to the Layer will be rendered into the surface. If the area that is needed for the children to be drawn is know, the layerRect property should be set as this can enhance performance.

Inheritance
Mixes-in

Constructors

Layer([Rect layerRect = null ])

Creates a new layer. The layerRect can optionally be passed as an argument if it is known.

Properties

actions ActionController

The ActionController associated with this node.

read-only, inherited
children List<Node>

A list of the children of this node.

read-only, inherited
colorOverlay Color

The color to draw on top of the sprite, null if no color overlay is used.

read / write, inherited
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, inherited
handleMultiplePointers bool

If set to true the node will receive multiple pointers, otherwise it will only receive events the first pointer.

read / write, inherited
hashCode int

Get a hash code for this object.

read-only, inherited
inverseTransformMatrix → Matrix4

The inverse transform matrix used by this node.

read-only, inherited
layerRect Rect

The area that the children of the Layer will occupy. This value is treated as a hint to the rendering system and may in some cases be ignored. If the area isn't known, the layerRect can be set to null.

read / write
opacity double

The opacity of the sprite in the range 0.0 to 1.0.

read / write, inherited
parent Node

The parent of this node, or null if it doesn't have a parent.

read-only, inherited
paused bool

Decides if the node and its children is currently paused.

read / write, inherited
position Point

The position of this node relative to its parent.

read / write, inherited
rotation double

The rotation of this node in degrees.

read / write, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited
scale double

The scale of this node relative its parent.

read / write, inherited
scaleX double

The horizontal scale of this node relative its parent.

read / write, inherited
scaleY double

The vertical scale of this node relative its parent.

read / write, inherited
skewX double

The skew along the x-axis of this node in degrees.

read / write, inherited
skewY double

The skew along the y-axis of this node in degrees.

read / write, inherited
spriteBox SpriteBox

The SpriteBox this node is added to, or null if it's not currently added to a SpriteBox.

read-only, inherited
transferMode TransferMode

The transfer mode used when drawing the sprite to screen.

read / write, inherited
transformMatrix → Matrix4

The transformMatrix describes the transformation from the node's parent.

read-only, inherited
userInteractionEnabled bool

The node will receive user interactions, such as pointer (touch or mouse) events.

read / write, inherited
visible bool

The visibility of this node and its children.

read / write, inherited
zPosition double

The draw order of this node compared to its parent and its siblings.

read / write, inherited

Operators

operator ==(other) bool

The equality operator.

inherited

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(Point point, Node node) Point

Converts a point from another nodes coordinate system into the local coordinate system of this node.

inherited
convertPointToBoxSpace(Point nodePoint) Point

Converts a point from the local coordinate system of the node to the coordinate system of the SpriteBox.

inherited
convertPointToNodeSpace(Point boxPoint) Point

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
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(Point 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 non-existent method or property is accessed.

inherited
paint(Canvas canvas) → void

Paints this node to the canvas.

inherited
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

Returns a string representation of this object.

inherited
update(double dt) → void

Called before a frame is drawn.

inherited