Package playn.scene

Class GroupLayer

java.lang.Object

playn.scene.Layer

playn.scene.ClippedLayer

playn.scene.GroupLayer

All Implemented Interfaces:

java.lang.Iterable<Layer>

Direct Known Subclasses:

RootLayer

public class GroupLayer
extends ClippedLayer
implements java.lang.Iterable<Layer>

GroupLayer creates a Layer hierarchy by maintaining an ordered group of child Layers.

Nested Class Summary

Nested classes/interfaces inherited from interface react.Closeable

react.Closeable.Set, react.Closeable.Util

Nested classes/interfaces inherited from class playn.scene.Layer

Layer.HitTester, Layer.Origin, Layer.State, Layer.Visitor

Field Summary

Fields inherited from class playn.scene.Layer

DEBUG_RECTS, state

Constructor Summary

Constructors

Constructor	Description
GroupLayer()	Creates an unclipped group layer.
GroupLayer(float width, float height)	Creates a clipped group layer with the specified size.

Method Summary

Modifier and Type	Method	Description
void	add(Layer child)	Adds a layer to the bottom of the group.
void	add(Layer child0, Layer child1, Layer... childN)	Adds all supplied children to this layer, in order.
void	addAt(Layer child, float tx, float ty)	Adds the supplied layer to this group layer, adjusting its translation (relative to this group layer) to the supplied values.
void	addCenterAt(Layer child, float tx, float ty)	Adds child to this group layer, positioning it such that its center is at (tx, tx).
void	addFloorAt(Layer child, float tx, float ty)	Adds child to this group layer, adjusting its translation (relative to this group layer) to floor(tx), floor(ty).
Layer	childAt(int index)	Returns the layer at the specified index.
int	children()	Returns the number of child layers in this group.
void	close()	Disposes this layer, removing it from its parent layer.
void	disposeAll()	Removes and disposes all child layers from this group.
Layer	hitTestDefault(pythagoras.f.Point point)	Like Layer.hitTest(pythagoras.f.Point) except that it ignores a configured Layer.HitTester.
boolean	isEmpty()	Returns whether this group has any child layers.
java.util.Iterator<Layer>	iterator()
void	remove(Layer child)	Removes a layer from the group.
void	remove(Layer child0, Layer child1, Layer... childN)	Removes all supplied children from this layer, in order.
void	removeAll()	Removes all child layers from this group.

Methods inherited from class playn.scene.ClippedLayer

height, setHeight, setSize, setSize, setWidth, width

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class playn.scene.Layer

absorbHits, alpha, debugPrint, depth, disposed, events, hasEventListeners, hitTest, interactive, name, onAdded, onDisposed, onRemoved, origin, origin, originX, originY, paint, parent, rotation, scale, scaledHeight, scaledWidth, scaleX, scaleY, setAlpha, setBatch, setDepth, setHitTester, setInteractive, setName, setOrigin, setOrigin, setRotation, setScale, setScale, setScaleX, setScaleY, setTint, setTranslation, setTranslation, setTx, setTy, setVisible, tint, toString, transform, translation, translation, tx, ty, visible, visit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupLayer

public GroupLayer()

Creates an unclipped group layer. Unclipped groups have no defined size.

GroupLayer

public GroupLayer(float width,
                  float height)

Creates a clipped group layer with the specified size.

Method Detail

isEmpty

public boolean isEmpty()

Returns whether this group has any child layers.

children

public int children()

Returns the number of child layers in this group.

childAt

public Layer childAt(int index)

Returns the layer at the specified index. Layers are ordered in terms of their depth and will be returned in this order, with 0 being the layer on bottom.

add

public void add(Layer child)

Adds a layer to the bottom of the group. Because the Layer hierarchy is a tree, if child is already a child of another GroupLayer, it will be removed before being added to this GroupLayer.

add

public void add(Layer child0,
                Layer child1,
                Layer... childN)

Adds all supplied children to this layer, in order. See add(Layer).

addAt

public void addAt(Layer child,
                  float tx,
                  float ty)

Adds the supplied layer to this group layer, adjusting its translation (relative to this group layer) to the supplied values.

This is equivalent to: add(child.setTranslation(tx, ty)).

addCenterAt

public void addCenterAt(Layer child,
                        float tx,
                        float ty)

Adds child to this group layer, positioning it such that its center is at (tx, tx). The layer must report a non-zero size, thus this will not work on an unclipped group layer.

This is equivalent to: add(child.setTranslation(tx - child.width()/2, ty - child.height()/2)).

addFloorAt

public void addFloorAt(Layer child,
                       float tx,
                       float ty)

Adds child to this group layer, adjusting its translation (relative to this group layer) to floor(tx), floor(ty). This is useful for adding layers which display text a text can become blurry if it is positioned on sub-pixel boundaries.

remove

public void remove(Layer child)

Removes a layer from the group.

remove

public void remove(Layer child0,
                   Layer child1,
                   Layer... childN)

Removes all supplied children from this layer, in order. See remove(Layer).

removeAll

public void removeAll()

Removes all child layers from this group.

disposeAll

public void disposeAll()

Removes and disposes all child layers from this group.

iterator

public java.util.Iterator<Layer> iterator()

Specified by:

iterator in interface java.lang.Iterable<Layer>

close

public void close()

Description copied from class: Layer

Disposes this layer, removing it from its parent layer. Any resources associated with this layer are freed, and it cannot be reused after being disposed. Disposing a layer that has children will dispose them as well.

Overrides:

close in class Layer

hitTestDefault

public Layer hitTestDefault(pythagoras.f.Point point)

Description copied from class: Layer

Like Layer.hitTest(pythagoras.f.Point) except that it ignores a configured Layer.HitTester. This allows one to configure a hit tester which checks custom properties and then falls back on the default hit testing implementation.

Overrides:

hitTestDefault in class Layer