Interface: Stage

Stage

A Stage is a container with the ability to render a stack of {@Layer layers}.

This is a superclass containing logic that is common to all implementations; it should never be instantiated directly. Instead, use one of the subclasses: WebGlStage, CssStage, FlashStage.

Methods

addLayer(layer)

Add a Layer into the stage.

Parameters:
Name Type Description
layer Layer
Throws:

Throws an error if the layer already belongs to the stage.

createTexture(tile, asset, done)

Create a texture for the given tile and asset. Called by TextureStore.

Parameters:
Name Type Description
tile Tile
asset Asset
done function

destroy()

Destructor.

domElement() → {HTMLElement}

Returns:

DOM element where layers are rendered

Type
HTMLElement

hasLayer(layer) → {boolean}

Return whether the stage contains a Layer.

Parameters:
Name Type Description
layer Layer
Returns:
Type
boolean

height() → {number}

Get the stage height.

Returns:
Type
number

listLayers() → {Array.<Layer>}

Return a list of all layers contained in the stage.

Returns:
Type
Array.<Layer>

moveLayer(layer, i)

Move a Layer to the given position in the stack.

Parameters:
Name Type Description
layer Layer
i Number
Throws:

Throws an error if the layer does not belong to the stage or the new position is invalid.

removeAllLayers()

Remove all layers from the stage.

removeLayer(layer)

Remove a Layer from the stage.

Parameters:
Name Type Description
layer Layer
Throws:

Throws an error if the layer does not belong to the stage.

render()

Render the current frame. Usually called from a RenderLoop.

This contains the rendering logic common to all stage types. Subclasses define the startFrame() and endFrame() methods to perform their own logic.

setSize(obj)

Set the stage dimensions.

This contains the size update logic common to all stage types. Subclasses define the _setSize() method to perform their own logic, if required.

Parameters:
Name Type Description
obj Object
Properties
Name Type Description
width number
height number

size(obj)

Get the stage dimensions. If an object argument is supplied, the object is filled in with the result and returned. Otherwise, a fresh object is returned.

Parameters:
Name Type Description
obj Object
Properties
Name Type Description
width number
height number

width() → {number}

Get the stage width.

Returns:
Type
number