playn.scene

Class ClippedLayer

java.lang.Object

playn.scene.Layer

playn.scene.ClippedLayer

All Implemented Interfaces:

AutoCloseable, Closeable

Direct Known Subclasses:

GroupLayer

public abstract class ClippedLayer
extends Layer

A layer whose rendering is (usually) clipped to a rectangle. The clipping rectangle is defined to be the layer's x, y coordinate (as adjusted by its origin) extended to the layer's scaled width and height.

NOTE: clipping rectangles cannot be rotated. If the layer has a rotation, the clipping region will be undefined (and most certainly wacky).

Nested Class Summary

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

Layer.HitTester, Layer.Origin, Layer.State

Nested classes/interfaces inherited from interface react.Closeable

Closeable.Set, Closeable.Util

Field Summary

Fields inherited from class playn.scene.Layer

state

Constructor Summary

Constructors

Constructor and Description
ClippedLayer(float width, float height)

Method Summary

Modifier and Type	Method and Description
float	height() Returns the height of this layer.
ClippedLayer	setHeight(float height) Updates the height of this group layer, and hence its clipping rectangle.
ClippedLayer	setSize(float width, float height) Updates the size of this clipped layer, and hence its clipping rectangle.
ClippedLayer	setSize(IDimension size) Updates the size of this clipped layer, and hence its clipping rectangle.
ClippedLayer	setWidth(float width) Updates the width of this group layer, and hence its clipping rectangle.
float	width() Returns the width of this layer.

Methods inherited from class playn.scene.Layer

absorbHits, alpha, close, depth, disposed, events, hasEventListeners, hitTest, hitTestDefault, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClippedLayer

public ClippedLayer(float width,
                    float height)

Method Detail

width

public float width()

Description copied from class: Layer

Returns the width of this layer. Note: not all layers know their size. Those that don't return 0.

Overrides:

width in class Layer

height

public float height()

Description copied from class: Layer

Returns the height of this layer. Note: not all layers know their size. Those that don't return 0.

Overrides:

height in class Layer

setSize

public ClippedLayer setSize(float width,
                            float height)

Updates the size of this clipped layer, and hence its clipping rectangle.

setSize

public ClippedLayer setSize(IDimension size)

Updates the size of this clipped layer, and hence its clipping rectangle.

setWidth

public ClippedLayer setWidth(float width)

Updates the width of this group layer, and hence its clipping rectangle.

setHeight

public ClippedLayer setHeight(float height)

Updates the height of this group layer, and hence its clipping rectangle.