API Reference

Class List

LayerComposition

Extends: EventHandler

Layer Composition is a collection of Layer that is fed to Scene#layers to define rendering order.

Summary

Properties

cameras

A read-only array of CameraComponent that can be used during rendering.

layerList

A read-only array of Layer sorted in the order they will be rendered.

subLayerEnabled

A read-only array of boolean values, matching Layer#layerList.

subLayerList

A read-only array of boolean values, matching Layer#layerList.

Methods

getLayerById

Finds a layer inside this composition by its ID.

getLayerByName

Finds a layer inside this composition by its name.

getOpaqueIndex

Gets index of the opaque part of the supplied layer in the Layer#layerList.

getTransparentIndex

Gets index of the semi-transparent part of the supplied layer in the Layer#layerList.

insert

Inserts a layer (both opaque and semi-transparent parts) at the chosen index in the Layer#layerList.

insertOpaque

Inserts an opaque part of the layer (non semi-transparent mesh instances) at the chosen index in the Layer#layerList.

insertTransparent

Inserts a semi-transparent part of the layer at the chosen index in the Layer#layerList.

push

Adds a layer (both opaque and semi-transparent parts) to the end of the Layer#layerList.

pushOpaque

Adds part of the layer with opaque (non semi-transparent) objects to the end of the Layer#layerList.

pushTransparent

Adds part of the layer with semi-transparent objects to the end of the Layer#layerList.

remove

Removes a layer (both opaque and semi-transparent parts) from Layer#layerList.

removeOpaque

Removes an opaque part of the layer (non semi-transparent mesh instances) from Layer#layerList.

removeTransparent

Removes a transparent part of the layer from Layer#layerList.

Inherited

Methods

fire

Fire an event, all additional arguments are passed on to the event listener.

hasEvent

Test if there are any handlers bound to an event name.

off

Detach an event handler from an event.

on

Attach an event handler to an event.

once

Attach an event handler to an event.

Details

Constructor

LayerComposition([graphicsDevice], [name])

Create a new layer composition.

Parameters

graphicsDeviceGraphicsDevice

The graphics device used to manage this layer composition. If it is not provided, a device is obtained from the Application.

namestring

Optional non-unique name of the layer composition. Defaults to "Untitled" if not specified.

Properties

CameraComponent[]cameras

A read-only array of CameraComponent that can be used during rendering. e.g. Inside Layer#onPreCull, Layer#onPostCull, Layer#onPreRender, Layer#onPostRender.

Layer[]layerList

A read-only array of Layer sorted in the order they will be rendered.

boolean[]subLayerEnabled

A read-only array of boolean values, matching Layer#layerList. True means the layer is rendered, false means it's skipped.

boolean[]subLayerList

A read-only array of boolean values, matching Layer#layerList. True means only semi-transparent objects are rendered, and false means opaque.

Methods

getLayerById(id)

Finds a layer inside this composition by its ID. Null is returned, if nothing is found.

Parameters

idnumber

An ID of the layer to find.

Returns

Layer

The layer corresponding to the specified ID. Returns null if layer is not found.

getLayerByName(name)

Finds a layer inside this composition by its name. Null is returned, if nothing is found.

Parameters

namestring

The name of the layer to find.

Returns

Layer

The layer corresponding to the specified name. Returns null if layer is not found.

getOpaqueIndex(layer)

Gets index of the opaque part of the supplied layer in the Layer#layerList.

Parameters

layerLayer

A Layer to find index of.

Returns

number

The index of the opaque part of the specified layer.

getTransparentIndex(layer)

Gets index of the semi-transparent part of the supplied layer in the Layer#layerList.

Parameters

layerLayer

A Layer to find index of.

Returns

number

The index of the semi-transparent part of the specified layer.

insert(layer, index)

Inserts a layer (both opaque and semi-transparent parts) at the chosen index in the Layer#layerList.

Parameters

layerLayer

A Layer to add.

indexnumber

Insertion position.

insertOpaque(layer, index)

Inserts an opaque part of the layer (non semi-transparent mesh instances) at the chosen index in the Layer#layerList.

Parameters

layerLayer

A Layer to add.

indexnumber

Insertion position.

insertTransparent(layer, index)

Inserts a semi-transparent part of the layer at the chosen index in the Layer#layerList.

Parameters

layerLayer

A Layer to add.

indexnumber

Insertion position.

push(layer)

Adds a layer (both opaque and semi-transparent parts) to the end of the Layer#layerList.

Parameters

layerLayer

A Layer to add.

pushOpaque(layer)

Adds part of the layer with opaque (non semi-transparent) objects to the end of the Layer#layerList.

Parameters

layerLayer

A Layer to add.

pushTransparent(layer)

Adds part of the layer with semi-transparent objects to the end of the Layer#layerList.

Parameters

layerLayer

A Layer to add.

remove(layer)

Removes a layer (both opaque and semi-transparent parts) from Layer#layerList.

Parameters

layerLayer

A Layer to remove.

removeOpaque(layer)

Removes an opaque part of the layer (non semi-transparent mesh instances) from Layer#layerList.

Parameters

layerLayer

A Layer to remove.

removeTransparent(layer)

Removes a transparent part of the layer from Layer#layerList.

Parameters

layerLayer

A Layer to remove.

Inherited

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

nameobject

Name of event to fire.

arg1*

First argument that is passed to the event handler.

arg2*

Second argument that is passed to the event handler.

arg3*

Third argument that is passed to the event handler.

arg4*

Fourth argument that is passed to the event handler.

arg5*

Fifth argument that is passed to the event handler.

arg6*

Sixth argument that is passed to the event handler.

arg7*

Seventh argument that is passed to the event handler.

arg8*

Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

namestring

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all hander functions, called 'test' with scope this

Parameters

namestring

Name of the event to unbind.

callbackcallbacks.HandleEvent

Function to be unbound.

scopeobject

Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

namestring

Name of the event to bind the callback to.

callbackcallbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

namestring

Name of the event to bind the callback to.

callbackcallbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.