Private _availablePrivate _availablePrivate _depthPrivate _depthPrivate _depthPrivate _indexPrivate _indexPrivate _listPrivate _managerPrivate _supportedPrivate _supportedCheck if Camera Color is available. This information becomes available only after session has started.
Check if Camera Depth is available. This information becomes available only after session has started.
Whether the depth sensing is GPU optimized.
The depth sensing pixel format. Currently supported either: PIXELFORMAT_LA8 or PIXELFORMAT_R32F
Check if Camera Color is supported. It might be still unavailable even if requested, based on hardware capabilities and granted permissions.
Check if Camera Depth is supported. It might be still unavailable even if requested, based on hardware capabilities and granted permissions.
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
Static EVENT_Fired when view has been added. Views are not available straight away on session start and are added mid-session. They can be added/removed mid session by underlyng system. The handler is passed the XrView that has been added.
xr.views.on('add', (view) => {
console.log('View added');
});
Static EVENT_Fired when view has been removed. They can be added/removed mid session by underlyng system. The handler is passed the XrView that has been removed.
xr.views.on('remove', (view) => {
console.log('View removed');
});
Provides access to list of XrView's. And information about their capabilities, such as support and availability of view's camera color texture, depth texture and other parameters.