LayerComposition() 

Create a new layer composition.

pc.CameraComponent[]cameras 

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

pc.Layer[]layerList 

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

boolean[]subLayerEnabled 

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

boolean[]subLayerList 

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

getLayerById(id) 

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

Parameters

id

number

An ID of the layer to find.

Returns

pc.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

name

string

The name of the layer to find.

Returns

pc.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 pc.Layer#layerList.

Parameters

layer

pc.Layer

A pc.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 pc.Layer#layerList.

Parameters

layer

pc.Layer

A pc.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 pc.Layer#layerList.

Parameters

layer	pc.Layer	A pc.Layer to add.
index	number	Insertion position.

insertOpaque(layer, index) 

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

Parameters

layer	pc.Layer	A pc.Layer to add.
index	number	Insertion position.

insertTransparent(layer, index) 

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

Parameters

layer	pc.Layer	A pc.Layer to add.
index	number	Insertion position.

push(layer) 

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

Parameters

layer

pc.Layer

A pc.Layer to add.

pushOpaque(layer) 

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

Parameters

layer

pc.Layer

A pc.Layer to add.

pushTransparent(layer) 

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

Parameters

layer

pc.Layer

A pc.Layer to add.

remove(layer) 

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

Parameters

layer

pc.Layer

A pc.Layer to remove.

removeOpaque(layer) 

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

Parameters

layer

pc.Layer

A pc.Layer to remove.

removeTransparent(layer) 

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

Parameters

layer

pc.Layer

A pc.Layer to remove.

sortOpaqueLayers(layersA, layersB) 

Used to determine which array of layers has any opaque sublayer that is on top of all the opaque sublayers in the other array.

Parameters

layersA	number[]	IDs of layers.
layersB	number[]	IDs of layers.

Returns

number

Returns a negative number if any of the opaque sublayers in layersA is on top of all the opaque sublayers in layersB, or a positive number if any of the opaque sublayers in layersB is on top of all the opaque sublayers in layersA, or 0 otherwise.

sortTransparentLayers(layersA, layersB) 

Used to determine which array of layers has any transparent sublayer that is on top of all the transparent sublayers in the other array.

Parameters

layersA	number[]	IDs of layers.
layersB	number[]	IDs of layers.

Returns

number

Returns a negative number if any of the transparent sublayers in layersA is on top of all the transparent sublayers in layersB, or a positive number if any of the transparent sublayers in layersB is on top of all the transparent sublayers in layersA, or 0 otherwise.

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

name	object	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

pc.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

name

string

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

name	string	Name of the event to unbind.
callback	pc.callbacks.HandleEvent	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

pc.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

name	string	Name of the event to bind the callback to.
callback	pc.callbacks.HandleEvent	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

pc.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

name	string	Name of the event to bind the callback to.
callback	pc.callbacks.HandleEvent	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

pc.EventHandler

Self for chaining.