playcanvas
Version:
Open-source WebGL/WebGPU 3D engine for the web
428 lines (427 loc) • 12.6 kB
JavaScript
var __defProp = Object.defineProperty;
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
import { EventHandler } from "../../core/event-handler.js";
import { platform } from "../../core/platform.js";
import { XrAnchor } from "./xr-anchor.js";
class XrAnchors extends EventHandler {
/**
* Create a new XrAnchors instance.
*
* @param {XrManager} manager - WebXR Manager.
* @ignore
*/
constructor(manager) {
super();
/**
* @type {XrManager}
* @ignore
*/
__publicField(this, "manager");
/**
* @type {boolean}
* @private
*/
__publicField(this, "_supported", platform.browser && !!window.XRAnchor);
/** @private */
__publicField(this, "_available", false);
/** @private */
__publicField(this, "_checkingAvailability", false);
/**
* @type {boolean}
* @private
*/
__publicField(this, "_persistence", platform.browser && !!window?.XRSession?.prototype.restorePersistentAnchor);
/**
* List of anchor creation requests.
*
* @type {object[]}
* @private
*/
__publicField(this, "_creationQueue", []);
/**
* Index of XrAnchors, with XRAnchor (native handle) used as a key.
*
* @type {Map<XRAnchor,XrAnchor>}
* @private
*/
__publicField(this, "_index", /* @__PURE__ */ new Map());
/**
* Index of XrAnchors, with UUID (persistent string) used as a key.
*
* @type {Map<string,XrAnchor>}
* @private
*/
__publicField(this, "_indexByUuid", /* @__PURE__ */ new Map());
/**
* @type {XrAnchor[]}
* @private
*/
__publicField(this, "_list", []);
/**
* Map of callbacks to XRAnchors so that we can call its callback once an anchor is updated
* with a pose for the first time.
*
* @type {Map<XrAnchor, XrAnchorCreateCallback>}
* @private
*/
__publicField(this, "_callbacksAnchors", /* @__PURE__ */ new Map());
this.manager = manager;
if (this._supported) {
this.manager.on("start", this._onSessionStart, this);
this.manager.on("end", this._onSessionEnd, this);
}
}
/** @private */
_onSessionStart() {
const available = this.manager.session.enabledFeatures?.indexOf("anchors") >= 0;
if (!available) return;
this._available = available;
this.fire("available");
}
/** @private */
_onSessionEnd() {
if (!this._available) return;
this._available = false;
for (let i2 = 0; i2 < this._creationQueue.length; i2++) {
if (!this._creationQueue[i2].callback) {
continue;
}
this._creationQueue[i2].callback(new Error("session ended"), null);
}
this._creationQueue.length = 0;
this._index.clear();
this._indexByUuid.clear();
let i = this._list.length;
while (i--) {
this._list[i].destroy();
}
this._list.length = 0;
this.fire("unavailable");
}
/**
* @param {XRAnchor} xrAnchor - XRAnchor that has been added.
* @param {string|null} [uuid] - UUID string associated with persistent anchor.
* @returns {XrAnchor} new instance of XrAnchor.
* @private
*/
_createAnchor(xrAnchor, uuid = null) {
const anchor = new XrAnchor(this, xrAnchor, uuid);
this._index.set(xrAnchor, anchor);
if (uuid) this._indexByUuid.set(uuid, anchor);
this._list.push(anchor);
anchor.once("destroy", this._onAnchorDestroy, this);
return anchor;
}
/**
* @param {XRAnchor} xrAnchor - XRAnchor that has been destroyed.
* @param {XrAnchor} anchor - Anchor that has been destroyed.
* @private
*/
_onAnchorDestroy(xrAnchor, anchor) {
this._index.delete(xrAnchor);
if (anchor.uuid) this._indexByUuid.delete(anchor.uuid);
const ind = this._list.indexOf(anchor);
if (ind !== -1) this._list.splice(ind, 1);
this.fire("destroy", anchor);
}
/**
* Create an anchor using position and rotation, or from hit test result.
*
* @param {Vec3|XRHitTestResult} position - Position for an anchor or a hit test result.
* @param {Quat|XrAnchorCreateCallback} [rotation] - Rotation for an anchor or a callback if
* creating from a hit test result.
* @param {XrAnchorCreateCallback} [callback] - Callback to fire when anchor was created or
* failed to be created.
* @example
* // create an anchor using a position and rotation
* app.xr.anchors.create(position, rotation, (err, anchor) => {
* if (!err) {
* // new anchor has been created
* }
* });
* @example
* // create an anchor from a hit test result
* hitTestSource.on('result', (position, rotation, inputSource, hitTestResult) => {
* app.xr.anchors.create(hitTestResult, (err, anchor) => {
* if (!err) {
* // new anchor has been created
* }
* });
* });
*/
create(position, rotation, callback) {
if (!this._available) {
callback?.(new Error("Anchors API is not available"), null);
return;
}
if (window.XRHitTestResult && position instanceof XRHitTestResult) {
const hitResult = position;
callback = rotation;
if (!this._supported) {
callback?.(new Error("Anchors API is not supported"), null);
return;
}
if (!hitResult.createAnchor) {
callback?.(new Error("Creating Anchor from Hit Test is not supported"), null);
return;
}
hitResult.createAnchor().then((xrAnchor) => {
const anchor = this._createAnchor(xrAnchor);
callback?.(null, anchor);
this.fire("add", anchor);
}).catch((ex) => {
callback?.(ex, null);
this.fire("error", ex);
});
} else {
this._creationQueue.push({
transform: new XRRigidTransform(position, rotation),
callback
});
}
}
/**
* Restore anchor using persistent UUID.
*
* @param {string} uuid - UUID string associated with persistent anchor.
* @param {XrAnchorCreateCallback} [callback] - Callback to fire when anchor was created or
* failed to be created.
* @example
* // restore an anchor using uuid string
* app.xr.anchors.restore(uuid, (err, anchor) => {
* if (!err) {
* // new anchor has been created
* }
* });
* @example
* // restore all available persistent anchors
* const uuids = app.xr.anchors.uuids;
* for(let i = 0; i < uuids.length; i++) {
* app.xr.anchors.restore(uuids[i]);
* }
*/
restore(uuid, callback) {
if (!this._available) {
callback?.(new Error("Anchors API is not available"), null);
return;
}
if (!this._persistence) {
callback?.(new Error("Anchor Persistence is not supported"), null);
return;
}
if (!this.manager.active) {
callback?.(new Error("WebXR session is not active"), null);
return;
}
this.manager.session.restorePersistentAnchor(uuid).then((xrAnchor) => {
const anchor = this._createAnchor(xrAnchor, uuid);
callback?.(null, anchor);
this.fire("add", anchor);
}).catch((ex) => {
callback?.(ex, null);
this.fire("error", ex);
});
}
/**
* Forget an anchor by removing its UUID from underlying systems.
*
* @param {string} uuid - UUID string associated with persistent anchor.
* @param {XrAnchorForgetCallback} [callback] - Callback to fire when anchor persistent data
* was removed or error if failed.
* @example
* // forget all available anchors
* const uuids = app.xr.anchors.uuids;
* for (let i = 0; i < uuids.length; i++) {
* app.xr.anchors.forget(uuids[i]);
* }
*/
forget(uuid, callback) {
if (!this._available) {
callback?.(new Error("Anchors API is not available"));
return;
}
if (!this._persistence) {
callback?.(new Error("Anchor Persistence is not supported"));
return;
}
if (!this.manager.active) {
callback?.(new Error("WebXR session is not active"));
return;
}
this.manager.session.deletePersistentAnchor(uuid).then(() => {
callback?.(null);
}).catch((ex) => {
callback?.(ex);
this.fire("error", ex);
});
}
/**
* @param {XRFrame} frame - XRFrame from requestAnimationFrame callback.
* @ignore
*/
update(frame) {
if (!this._available) {
if (!this.manager.session.enabledFeatures && !this._checkingAvailability) {
this._checkingAvailability = true;
frame.createAnchor(new XRRigidTransform(), this.manager._referenceSpace).then((xrAnchor) => {
xrAnchor.delete();
if (this.manager.active) {
this._available = true;
this.fire("available");
}
}).catch(() => {
});
}
return;
}
if (this._creationQueue.length) {
for (let i = 0; i < this._creationQueue.length; i++) {
const request = this._creationQueue[i];
frame.createAnchor(request.transform, this.manager._referenceSpace).then((xrAnchor) => {
if (request.callback) {
this._callbacksAnchors.set(xrAnchor, request.callback);
}
}).catch((ex) => {
if (request.callback) {
request.callback(ex, null);
}
this.fire("error", ex);
});
}
this._creationQueue.length = 0;
}
for (const [xrAnchor, anchor] of this._index) {
if (frame.trackedAnchors.has(xrAnchor)) {
continue;
}
this._index.delete(xrAnchor);
anchor.destroy();
}
for (let i = 0; i < this._list.length; i++) {
this._list[i].update(frame);
}
for (const xrAnchor of frame.trackedAnchors) {
if (this._index.has(xrAnchor)) {
continue;
}
try {
const tmp = xrAnchor.anchorSpace;
} catch (ex) {
continue;
}
const anchor = this._createAnchor(xrAnchor);
anchor.update(frame);
const callback = this._callbacksAnchors.get(xrAnchor);
if (callback) {
this._callbacksAnchors.delete(xrAnchor);
callback(null, anchor);
}
this.fire("add", anchor);
}
}
/**
* True if Anchors are supported.
*
* @type {boolean}
*/
get supported() {
return this._supported;
}
/**
* True if Anchors are available. This information is available only when session has started.
*
* @type {boolean}
*/
get available() {
return this._available;
}
/**
* True if Anchors support persistence.
*
* @type {boolean}
*/
get persistence() {
return this._persistence;
}
/**
* Array of UUID strings of persistent anchors, or null if not available.
*
* @type {null|string[]}
*/
get uuids() {
if (!this._available) {
return null;
}
if (!this._persistence) {
return null;
}
if (!this.manager.active) {
return null;
}
return this.manager.session.persistentAnchors;
}
/**
* List of available {@link XrAnchor}s.
*
* @type {XrAnchor[]}
*/
get list() {
return this._list;
}
}
/**
* Fired when anchors become available.
*
* @event
* @example
* app.xr.anchors.on('available', () => {
* console.log('Anchors are available');
* });
*/
__publicField(XrAnchors, "EVENT_AVAILABLE", "available");
/**
* Fired when anchors become unavailable.
*
* @event
* @example
* app.xr.anchors.on('unavailable', () => {
* console.log('Anchors are unavailable');
* });
*/
__publicField(XrAnchors, "EVENT_UNAVAILABLE", "unavailable");
/**
* Fired when an anchor failed to be created. The handler is passed an Error object.
*
* @event
* @example
* app.xr.anchors.on('error', (err) => {
* console.error(err.message);
* });
*/
__publicField(XrAnchors, "EVENT_ERROR", "error");
/**
* Fired when a new {@link XrAnchor} is added. The handler is passed the {@link XrAnchor} that
* was added.
*
* @event
* @example
* app.xr.anchors.on('add', (anchor) => {
* console.log('Anchor added');
* });
*/
__publicField(XrAnchors, "EVENT_ADD", "add");
/**
* Fired when an {@link XrAnchor} is destroyed. The handler is passed the {@link XrAnchor} that
* was destroyed.
*
* @event
* @example
* app.xr.anchors.on('destroy', (anchor) => {
* console.log('Anchor destroyed');
* });
*/
__publicField(XrAnchors, "EVENT_DESTROY", "destroy");
export {
XrAnchors
};