Private _availablePrivate _colorPrivate _intensityPrivate _lightPrivate _lightPrivate _managerPrivate _rotationPrivate _sphericalPrivate _supportedTrue if estimated light information is available.
if (app.xr.lightEstimation.available) {
entity.light.intensity = app.xr.lightEstimation.intensity;
}
Intensity of what is estimated to be the most prominent directional light. Or null if data is not available.
Spherical harmonic coefficients of estimated ambient light. Or null if data is not available.
True if Light Estimation is supported. This information is available only during an active AR session.
Private _onPrivate _onFire 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');
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
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
Start estimation of illumination data. Availability of such data will come later and an
available event will be fired. If it failed to start estimation, an error event will be
fired.
app.xr.on('start', function () {
if (app.xr.lightEstimation.supported) {
app.xr.lightEstimation.start();
}
});
Static EVENT_Fired when light estimation data becomes available.
app.xr.lightEstimation.on('available', () => {
console.log('Light estimation is available');
});
Static EVENT_Fired when light estimation has failed to start. The handler is passed the Error object related to failure of light estimation start.
app.xr.lightEstimation.on('error', (error) => {
console.error(error.message);
});
Light Estimation provides illumination data from the real world, which is estimated by the underlying AR system. It provides a reflection Cube Map, that represents the reflection estimation from the viewer position. A more simplified approximation of light is provided by L2 Spherical Harmonics data. And the most simple level of light estimation is the most prominent directional light, its rotation, intensity and color.