playcanvas
Version:
PlayCanvas WebGL game engine
231 lines (228 loc) • 7.53 kB
JavaScript
import { platform } from '../../core/platform.js';
import { EventHandler } from '../../core/event-handler.js';
import { XrView } from './xr-view.js';
import { XRDEPTHSENSINGFORMAT_F32, XRDEPTHSENSINGFORMAT_R16U, XRDEPTHSENSINGFORMAT_L8A8, XRDEPTHSENSINGUSAGE_GPU, XRTYPE_AR } from './constants.js';
import { PIXELFORMAT_R32F, PIXELFORMAT_DEPTH, PIXELFORMAT_LA8 } from '../../platform/graphics/constants.js';
/**
* @import { XrManager } from './xr-manager.js'
*/ /**
* Provides access to list of {@link XrView}s and information about their capabilities, such as
* support and availability of view's camera color texture, depth texture and other parameters.
*
* @category XR
*/ class XrViews extends EventHandler {
static{
/**
* Fired when a 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 the underlying system. The
* handler is passed the {@link XrView} that has been added.
*
* @event
* @example
* xr.views.on('add', (view) => {
* console.log('View added');
* });
*/ this.EVENT_ADD = 'add';
}
static{
/**
* Fired when a view has been removed. They can be added/removed mid session by the underlying
* system. The handler is passed the {@link XrView} that has been removed.
*
* @event
* @example
* xr.views.on('remove', (view) => {
* console.log('View removed');
* });
*/ this.EVENT_REMOVE = 'remove';
}
/**
* Create a new XrViews instance.
*
* @param {XrManager} manager - WebXR Manager.
* @ignore
*/ constructor(manager){
super(), /**
* @type {Map<string,XrView>}
* @private
*/ this._index = new Map(), /**
* @type {Map<string,XrView>}
* @private
*/ this._indexTmp = new Map(), /**
* @type {XrView[]}
* @private
*/ this._list = [], /**
* @type {boolean}
* @private
*/ this._supportedColor = platform.browser && !!window.XRCamera && !!window.XRWebGLBinding, /**
* @type {boolean}
* @private
*/ this._supportedDepth = platform.browser && !!window.XRDepthInformation, /**
* @type {boolean}
* @private
*/ this._availableColor = false, /**
* @type {boolean}
* @private
*/ this._availableDepth = false, /**
* @type {string}
* @private
*/ this._depthUsage = '', /**
* @type {string}
* @private
*/ this._depthFormat = '', /**
* @type {object}
* @private
*/ this._depthFormats = {
[XRDEPTHSENSINGFORMAT_L8A8]: PIXELFORMAT_LA8,
[XRDEPTHSENSINGFORMAT_R16U]: PIXELFORMAT_DEPTH,
[XRDEPTHSENSINGFORMAT_F32]: PIXELFORMAT_R32F
};
this._manager = manager;
this._manager.on('start', this._onSessionStart, this);
this._manager.on('end', this._onSessionEnd, this);
}
/**
* An array of {@link XrView}s of this session. Views are not available straight away on
* session start, and can be added/removed mid-session. So use of `add`/`remove` events is
* required for accessing views.
*
* @type {XrView[]}
*/ get list() {
return this._list;
}
/**
* Check if Camera Color is supported. It might be still unavailable even if requested,
* based on hardware capabilities and granted permissions.
*
* @type {boolean}
*/ get supportedColor() {
return this._supportedColor;
}
/**
* Check if Camera Depth is supported. It might be still unavailable even if requested,
* based on hardware capabilities and granted permissions.
*
* @type {boolean}
*/ get supportedDepth() {
return this._supportedDepth;
}
/**
* Check if Camera Color is available. This information becomes available only after
* session has started.
*
* @type {boolean}
*/ get availableColor() {
return this._availableColor;
}
/**
* Check if Camera Depth is available. This information becomes available only after
* session has started.
*
* @type {boolean}
*/ get availableDepth() {
return this._availableDepth;
}
/**
* @type {string}
* @ignore
*/ get depthUsage() {
return this._depthUsage;
}
/**
* Whether the depth sensing is GPU optimized.
*
* @type {boolean}
*/ get depthGpuOptimized() {
return this._depthUsage === XRDEPTHSENSINGUSAGE_GPU;
}
/**
* @type {string}
* @ignore
*/ get depthFormat() {
return this._depthFormat;
}
/**
* The depth sensing pixel format. Can be:
*
* - {@link PIXELFORMAT_LA8}
* - {@link PIXELFORMAT_R32F}
*
* @type {PIXELFORMAT_LA8|PIXELFORMAT_R32F|null}
*/ get depthPixelFormat() {
return this._depthFormats[this._depthFormat] ?? null;
}
/**
* @param {XRFrame} frame - XRFrame from requestAnimationFrame callback.
* @param {XRView} xrView - XRView from WebXR API.
* @ignore
*/ update(frame, xrViews) {
for(let i = 0; i < xrViews.length; i++){
this._indexTmp.set(xrViews[i].eye, xrViews[i]);
}
for (const [eye, xrView] of this._indexTmp){
let view = this._index.get(eye);
if (!view) {
// add new view
view = new XrView(this._manager, xrView, xrViews.length);
this._index.set(eye, view);
this._list.push(view);
view.update(frame, xrView);
this.fire('add', view);
} else {
// update existing view0
view.update(frame, xrView);
}
}
// remove views
for (const [eye, view] of this._index){
if (this._indexTmp.has(eye)) {
continue;
}
view.destroy();
this._index.delete(eye);
const ind = this._list.indexOf(view);
if (ind !== -1) this._list.splice(ind, 1);
this.fire('remove', view);
}
this._indexTmp.clear();
}
/**
* Get an {@link XrView} by its associated eye constant.
*
* @param {string} eye - An XREYE_* view is associated with. Can be 'none' for monoscope views.
* @returns {XrView|null} View or null if view of such eye is not available.
*/ get(eye) {
return this._index.get(eye) || null;
}
/**
* @private
*/ _onSessionStart() {
if (this._manager.type !== XRTYPE_AR) {
return;
}
if (!this._manager.session.enabledFeatures) {
return;
}
this._availableColor = this._manager.session.enabledFeatures.indexOf('camera-access') !== -1;
this._availableDepth = this._manager.session.enabledFeatures.indexOf('depth-sensing') !== -1;
if (this._availableDepth) {
const session = this._manager.session;
this._depthUsage = session.depthUsage;
this._depthFormat = session.depthDataFormat;
}
}
/**
* @private
*/ _onSessionEnd() {
for (const view of this._index.values()){
view.destroy();
}
this._index.clear();
this._availableColor = false;
this._availableDepth = false;
this._depthUsage = '';
this._depthFormat = '';
this._list.length = 0;
}
}
export { XrViews };