Create a new layer composition.
Optional name: string = 'Untitled'Optional non-unique name of the layer composition. Defaults to "Untitled" if not specified.
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 Layer sorted in the order they will be rendered.
A read-only array of boolean values, matching LayerComposition#layerList. True means the layer is rendered, false means it's skipped.
Private _updateFire an event, all additional arguments are passed on to the event listener.
Name of event to fire.
Optional arg1: anyFirst argument that is passed to the event handler.
Optional arg2: anySecond argument that is passed to the event handler.
Optional arg3: anyThird argument that is passed to the event handler.
Optional arg4: anyFourth argument that is passed to the event handler.
Optional arg5: anyFifth argument that is passed to the event handler.
Optional arg6: anySixth argument that is passed to the event handler.
Optional arg7: anySeventh argument that is passed to the event handler.
Optional arg8: anyEighth argument that is passed to the event handler.
Self for chaining.
obj.fire('test', 'This is the message');
Gets index of the opaque part of the supplied layer in the LayerComposition#layerList.
The index of the opaque part of the specified layer, or -1 if it is not part of the composition.
Gets index of the semi-transparent part of the supplied layer in the LayerComposition#layerList.
The index of the semi-transparent part of the specified layer, or -1 if it is not part of the composition.
Test if there are any handlers bound to an event name.
The name of the event to test.
True if the object has handlers bound to the specified event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
Inserts a layer (both opaque and semi-transparent parts) at the chosen index in the LayerComposition#layerList.
Inserts an opaque part of the layer (non semi-transparent mesh instances) at the chosen index in the LayerComposition#layerList.
Inserts a semi-transparent part of the layer at the chosen index in the LayerComposition#layerList.
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.
Optional name: stringName of the event to unbind.
Optional callback: HandleEventCallbackFunction to be unbound.
Optional scope: objectScope that was used as the this when the event is fired.
Self for chaining.
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 this
Attach an event handler to an event.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
Can be used for removing event in the future.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Attach an event handler to an event. This handler will be removed after being fired once.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
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
Adds a layer (both opaque and semi-transparent parts) to the end of the LayerComposition#layerList.
Adds part of the layer with opaque (non semi-transparent) objects to the end of the LayerComposition#layerList.
Adds part of the layer with semi-transparent objects to the end of the LayerComposition#layerList.
Removes a layer (both opaque and semi-transparent parts) from LayerComposition#layerList.
Removes an opaque part of the layer (non semi-transparent mesh instances) from LayerComposition#layerList.
Removes a transparent part of the layer from LayerComposition#layerList.
Private sortPrivate Used to determine which array of layers has any opaque sublayer that is on top of all the opaque sublayers in the other array.
IDs of layers.
IDs of layers.
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.
Private sortPrivate Used to determine which array of layers has any transparent sublayer that is on top of all the transparent sublayers in the other array.
IDs of layers.
IDs of layers.
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.
Layer Composition is a collection of Layer that is fed to Scene#layers to define rendering order.