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 LayerComposition#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 LayerComposition#layerList. |
| getTransparentIndex | Gets index of the semi-transparent part of the supplied layer in the LayerComposition#layerList. |
| insert | Inserts a layer (both opaque and semi-transparent parts) at the chosen index in the LayerComposition#layerList. |
| insertOpaque | Inserts an opaque part of the layer (non semi-transparent mesh instances) at the chosen index in the LayerComposition#layerList. |
| insertTransparent | Inserts a semi-transparent part of the layer at the chosen index in the LayerComposition#layerList. |
| push | Adds a layer (both opaque and semi-transparent parts) to the end of the LayerComposition#layerList. |
| pushOpaque | Adds part of the layer with opaque (non semi-transparent) objects to the end of the LayerComposition#layerList. |
| pushTransparent | Adds part of the layer with semi-transparent objects to the end of the LayerComposition#layerList. |
| remove | Removes a layer (both opaque and semi-transparent parts) from LayerComposition#layerList. |
| removeOpaque | Removes an opaque part of the layer (non semi-transparent mesh instances) from LayerComposition#layerList. |
| removeTransparent | Removes a transparent part of the layer from LayerComposition#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([name])
Create a new layer composition.
Parameters
| name | string | Optional non-unique name of the layer composition. Defaults to "Untitled" if not specified. |
Properties
A read-only array of CameraComponent that can be used during rendering. e.g. Inside Layer#onPreCull, Layer#onPostCull, Layer#onPreRender, Layer#onPostRender.
A read-only array of boolean values, matching LayerComposition#layerList. True means the layer is rendered, false means it's skipped.
Methods
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
Layer, nullThe 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
Layer, nullThe 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 LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to find index of. |
Returns
numberThe index of the opaque part of the specified layer.
getTransparentIndex(layer)
Gets index of the semi-transparent part of the supplied layer in the LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to find index of. |
Returns
numberThe 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 LayerComposition#layerList.
Parameters
| layer | Layer | A 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 LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to add. |
| index | number | Insertion position. |
insertTransparent(layer, index)
Inserts a semi-transparent part of the layer at the chosen index in the LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to add. |
| index | number | Insertion position. |
push(layer)
Adds a layer (both opaque and semi-transparent parts) to the end of the LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to add. |
pushOpaque(layer)
Adds part of the layer with opaque (non semi-transparent) objects to the end of the LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to add. |
pushTransparent(layer)
Adds part of the layer with semi-transparent objects to the end of the LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to add. |
remove(layer)
Removes a layer (both opaque and semi-transparent parts) from LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to remove. |
removeOpaque(layer)
Removes an opaque part of the layer (non semi-transparent mesh instances) from LayerComposition#layerList.
Parameters
| layer | Layer | A Layer to remove. |
removeTransparent(layer)
Removes a transparent part of the layer from LayerComposition#layerList.
Parameters
| layer | Layer | 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
| name | string | 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
EventHandlerSelf 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 falseParameters
| name | string | The name of the event to test. |
Returns
booleanTrue 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.
const 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 handler functions, called 'test' with scope thisParameters
| name | string | Name of the event to unbind. |
| callback | HandleEventCallback | Function to be unbound. |
| scope | object | Scope that was used as the this when the event is fired. |
Returns
EventHandlerSelf 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 consoleconst evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();Parameters
| name | string | Name of the event to bind the callback to. |
| callback | HandleEventCallback | 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
EventHandleCan be used for removing event in the future.
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 handledParameters
| name | string | Name of the event to bind the callback to. |
| callback | HandleEventCallback | 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
EventHandle- can be used for removing event in the future.