@webspatial/core-sdk 0.1.5 → 0.1.7

package/dist/core/SpatialHelper.js

@@ -1,195 +0,0 @@
-import { SpatialViewComponent } from './component';
-import { Spatial } from './Spatial';
-import { Vec3 } from './SpatialTransform';
-/**
- * Helper class used to quickly add spatial content to standard web pages
- * [Experimental] expect APIs to potentially change in future versions
- */
-export class SpatialHelper {
-    session;
-    static _instance = null;
-    static get instance() {
-        if (this._instance) {
-            return this._instance;
-        }
-        else {
-            let spatial = new Spatial();
-            if (spatial.isSupported()) {
-                let session = spatial.requestSession();
-                if (session) {
-                    this._instance = new SpatialHelper(session);
-                    return this._instance;
-                }
-            }
-        }
-        return null;
-    }
-    constructor(session) {
-        this.session = session;
-    }
-    shape = {
-        createShapeEntity: async (shape = 'box') => {
-            var box = await this.session.createMeshResource({ shape: shape });
-            var mat = await this.session.createPhysicallyBasedMaterialResource();
-            await mat.update();
-            var customModel = await this.session.createModelComponent();
-            customModel.setMaterials([mat]);
-            customModel.setMesh(box);
-            var boxEntity = await this.session.createEntity();
-            await boxEntity.setComponent(customModel);
-            boxEntity.transform.position.z = 0;
-            boxEntity.transform.scale = new Vec3(0.5, 0.5, 0.5);
-            await boxEntity.updateTransform();
-            return boxEntity;
-        },
-        createModelEntity: async (url) => {
-            var customModel = await this.session.createModelComponent({ url });
-            var boxEntity = await this.session.createEntity();
-            await boxEntity.setComponent(customModel);
-            await boxEntity.updateTransform();
-            return boxEntity;
-        },
-        wrapInBoundingBoxEntity: async (entityToWrap) => {
-            var bb = await entityToWrap.getBoundingBox();
-            // Scale to fit
-            var targetSize = 1.0;
-            var scale = targetSize / Math.max(bb.extents.x, bb.extents.y, bb.extents.z);
-            entityToWrap.transform.scale.x = scale;
-            entityToWrap.transform.scale.y = scale;
-            entityToWrap.transform.scale.z = scale;
-            // Center within view
-            entityToWrap.transform.position.x = -bb.center.x * scale;
-            entityToWrap.transform.position.y = -bb.center.y * scale;
-            entityToWrap.transform.position.z = -bb.center.z * scale;
-            await entityToWrap.updateTransform();
-            // wrap in boudning box
-            var boudningEntity = await SpatialHelper.instance?.session.createEntity();
-            await entityToWrap.setParent(boudningEntity);
-            return boudningEntity;
-        },
-    };
-    navigation = {
-        openPanel: async (url, options) => {
-            if (options?.resolution) {
-                await this.session
-                    .getCurrentWindowContainer()
-                    ._setOpenSettings({ resolution: options.resolution });
-            }
-            // Create window container
-            var wg = await this.session.createWindowContainer({
-                style: 'Plain',
-                windowComponent: null,
-                windowContainer: null,
-            });
-            // Create a root entity displaying a webpage
-            var ent = await this.session.createEntity({
-                windowComponent: null,
-                windowContainer: wg,
-            });
-            var i = await this.session.createWindowComponent({
-                windowComponent: null,
-                windowContainer: wg,
-            });
-            await i.loadURL(url);
-            await ent.setCoordinateSpace('Root');
-            await ent.setComponent(i);
-            // Add enitity the window container
-            await wg.setRootEntity(ent);
-            // Restore default size
-            await this.session
-                .getCurrentWindowContainer()
-                ._setOpenSettings({ resolution: { width: 900, height: 700 } });
-        },
-        openVolume: async (url, options) => {
-            var wg = await this.session.createWindowContainer({
-                style: 'Volumetric',
-                windowComponent: null,
-                windowContainer: null,
-            });
-            // Create a root view entity within the window container
-            var rootEnt = await this.session.createEntity({
-                windowComponent: null,
-                windowContainer: wg,
-            });
-            await rootEnt.setComponent(await this.session.createViewComponent({
-                windowComponent: null,
-                windowContainer: wg,
-            }));
-            await rootEnt.setCoordinateSpace('Root');
-            await wg.setRootEntity(rootEnt);
-            // Add webpage to the window container
-            var ent = await this.session.createEntity({
-                windowComponent: null,
-                windowContainer: wg,
-            });
-            var i = await this.session.createWindowComponent({
-                windowComponent: null,
-                windowContainer: wg,
-            });
-            await i.loadURL(url);
-            if (options?.resolution) {
-                await i.setResolution(options.resolution.width, options.resolution.height);
-            }
-            else {
-                await i.setResolution(1000, 1000);
-            }
-            ent.transform.position.z = -0.49;
-            await ent.updateTransform();
-            await ent.setCoordinateSpace('App');
-            await ent.setComponent(i);
-            await ent.setParent(rootEnt);
-        },
-    };
-    dom = {
-        attachSpatialView: async (divOnPage) => {
-            // Create SpatialView
-            var viewEnt = await this.session.createEntity();
-            await viewEnt.setCoordinateSpace('Dom'); // Set coordinate space so its transform is relative to the webpage's pixels
-            await viewEnt.setComponent(await this.session.createViewComponent());
-            // Add to the root window component to display
-            var wc = await this.session.getCurrentWindowComponent();
-            var ent = await wc.getEntity();
-            await viewEnt.setParent(ent);
-            // Keep spatialView positioned where the div is
-            var update = () => {
-                var rect = divOnPage.getBoundingClientRect();
-                viewEnt.transform.position.x = rect.x + rect.width / 2;
-                viewEnt.transform.position.y = rect.y + rect.height / 2 + window.scrollY;
-                viewEnt.updateTransform();
-                viewEnt
-                    .getComponent(SpatialViewComponent)
-                    .setResolution(rect.width, rect.height);
-            };
-            var mo = new MutationObserver(update);
-            mo.observe(divOnPage, { attributes: true });
-            var ro = new ResizeObserver(update);
-            ro.observe(divOnPage);
-            const addRemoveObserver = new MutationObserver(mutations => {
-                mutations.forEach(mutation => {
-                    mutation.removedNodes.forEach(node => {
-                        if (node instanceof HTMLElement) {
-                            update();
-                        }
-                    });
-                    mutation.addedNodes.forEach(node => {
-                        if (node instanceof HTMLElement) {
-                            update();
-                        }
-                    });
-                });
-            });
-            addRemoveObserver.observe(document.body, {
-                childList: true,
-                subtree: true,
-            });
-            update();
-            return {
-                entity: viewEnt,
-            };
-        },
-    };
-    setBackgroundStyle = async (style, backgroundColor = '#00000000') => {
-        document.documentElement.style.backgroundColor = backgroundColor;
-        await this.session.getCurrentWindowComponent().setStyle(style);
-    };
-}

package/dist/core/SpatialObject.d.ts

@@ -1,20 +0,0 @@
-import { WebSpatialResource } from './private/WebSpatial';
-/**
- * @hidden
- * Parent class of spatial objects, should not be used directly
- */
-export declare class SpatialObject {
-    /** @hidden */
-    _resource: WebSpatialResource;
-    /** @hidden */
-    constructor(
-    /** @hidden */
-    _resource: WebSpatialResource);
-    /**
-     * Marks resource to be released (it should no longer be used)
-     */
-    destroy(): Promise<void>;
-    name: string;
-    protected onDestroy(): Promise<void>;
-}
-//# sourceMappingURL=SpatialObject.d.ts.map

package/dist/core/SpatialObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SpatialObject.d.ts","sourceRoot":"","sources":["../../src/core/SpatialObject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;GAGG;AACH,qBAAa,aAAa;IAGtB,cAAc;IACP,SAAS,EAAE,kBAAkB;IAHtC,cAAc;;IAEZ,cAAc;IACP,SAAS,EAAE,kBAAkB;IAGtC;;OAEG;IACG,OAAO;IAKN,IAAI,EAAE,MAAM,CAAK;cAER,SAAS;CAC1B"}

package/dist/core/SpatialObject.js

@@ -1,23 +0,0 @@
-import { WebSpatial } from './private/WebSpatial';
-/**
- * @hidden
- * Parent class of spatial objects, should not be used directly
- */
-export class SpatialObject {
-    _resource;
-    /** @hidden */
-    constructor(
-    /** @hidden */
-    _resource) {
-        this._resource = _resource;
-    }
-    /**
-     * Marks resource to be released (it should no longer be used)
-     */
-    async destroy() {
-        await WebSpatial.destroyResource(this._resource);
-        await this.onDestroy();
-    }
-    name = '';
-    async onDestroy() { }
-}

package/dist/core/SpatialSession.d.ts

@@ -1,164 +0,0 @@
-import { SpatialEntity } from './SpatialEntity';
-import { SpatialWindowContainer } from './SpatialWindowContainer';
-import { LoadingMethodKind, sceneDataShape, WindowStyle } from './types';
-import { SpatialMeshResource, SpatialPhysicallyBasedMaterialResource } from './resource';
-import { SpatialModelComponent, SpatialInputComponent, SpatialWindowComponent, SpatialViewComponent, SpatialModel3DComponent } from './component';
-type CreateResourceOptions = {
-    windowContainer?: SpatialWindowContainer | null;
-    windowComponent?: SpatialWindowComponent | null;
-};
-/**
- * Animation callback with timestamp
- */
-type animCallback = (time: DOMHighResTimeStamp) => Promise<any>;
-/**
- * Session use to establish a connection to the spatial renderer of the system. All resources must be created by the session
- */
-export declare class SpatialSession {
-    /** @hidden */
-    _engineUpdateListeners: animCallback[];
-    /** @hidden */
-    _frameLoopStarted: boolean;
-    /**
-     * Add event listener callback to be called each frame
-     * @param callback callback to be called each update
-     */
-    addOnEngineUpdateEventListener(callback: animCallback): void;
-    /**
-     * Creates a Entity
-     * @returns Entity
-     */
-    createEntity(options?: CreateResourceOptions): Promise<SpatialEntity>;
-    /**
-     * Creates a WindowComponent
-     * [TODO] should creation of components be moved to entity? and these made private?
-     * @returns WindowComponent
-     */
-    createWindowComponent(options?: CreateResourceOptions): Promise<SpatialWindowComponent>;
-    /**
-     * Creates a ViewComponent used to display 3D content within the entity
-     * @returns SpatialViewComponent
-     */
-    createViewComponent(options?: CreateResourceOptions): Promise<SpatialViewComponent>;
-    /**
-     * Creates a ModelComponent used to display geometry + material of a 3D model
-     * @returns ModelComponent
-     */
-    createModelComponent(options?: {
-        url: string;
-    } & CreateResourceOptions): Promise<SpatialModelComponent>;
-    /**
-     * Creates a Model3DComponent
-     * @returns Model3DComponent
-     */
-    createModel3DComponent(options?: {
-        url: string;
-    } & CreateResourceOptions): Promise<SpatialModel3DComponent>;
-    /**
-     * Creates a InputComponent
-     * [Experimental] Creates a InputComponent used to handle click and drag events of the entity containing a model
-     * @returns InputComponent
-     */
-    createInputComponent(options?: CreateResourceOptions): Promise<SpatialInputComponent>;
-    /**
-     * Creates a MeshResource containing geometry data
-     * @returns MeshResource
-     */
-    createMeshResource(options?: {
-        shape?: string;
-    } & CreateResourceOptions): Promise<SpatialMeshResource>;
-    /**
-     * Creates a PhysicallyBasedMaterial containing PBR material data
-     * @returns PhysicallyBasedMaterial
-     */
-    createPhysicallyBasedMaterialResource(options?: {} & CreateResourceOptions): Promise<SpatialPhysicallyBasedMaterialResource>;
-    /**
-     * Creates a WindowContainer
-     * @returns SpatialWindowContainer
-     * */
-    createWindowContainer(options?: {
-        style: WindowStyle;
-    } & CreateResourceOptions): Promise<SpatialWindowContainer>;
-    /**
-     * Creates a Scene to display content within an anchored area managed by the OS
-     * @hidden
-     * @param {WindowStyle} [style='Plain'] - The style of the Scene container to be created with. Defaults to 'Plain'.
-     * @param {Object} [cfg={}] - Configuration object for the Scene.
-     * @returns Boolean
-     */
-    _createScene(style: WindowStyle | undefined, cfg: {
-        sceneData: sceneDataShape;
-    }): Promise<boolean>;
-    /**
-     * Retrieves the window for this page
-     * @returns the window component corresponding to the js running on this page
-     * [TODO] discuss implications of this not being async
-     */
-    getCurrentWindowComponent(): SpatialWindowComponent;
-    /**
-     * Retrieves the parent window for this page or null if this is the root page
-     * @returns the window component or null
-     */
-    getParentWindowComponent(): Promise<SpatialWindowComponent | null>;
-    /**
-     * Logs a message to the native apps console
-     * @param msg mesage to log
-     */
-    log(...msg: any[]): Promise<void>;
-    /**
-     * @hidden
-     * Debugging only, used to ping the native renderer
-     */
-    _ping(msg: string): Promise<unknown>;
-    /**
-     * @hidden
-     * Debugging to get internal state from native code
-     * @returns data as a js object
-     */
-    _getStats(): Promise<{
-        objects: any;
-        refObjects: any;
-    }>;
-    /**
-     * @hidden
-     */
-    _inspect(spatialObjectId?: string): Promise<any>;
-    /**
-     * @hidden
-     */
-    _inspectRootWindowContainer(): Promise<any>;
-    /** Opens the immersive space */
-    openImmersiveSpace(): Promise<void>;
-    /** Closes the immersive space */
-    dismissImmersiveSpace(): Promise<void>;
-    private static _immersiveWindowContainer;
-    /**
-     * Retreives the window container corresponding to the Immersive space
-     * @returns the immersive window container
-     */
-    getImmersiveWindowContainer(): Promise<SpatialWindowContainer>;
-    private static _currentWindowContainer;
-    /**
-     * Gets the current window container for the window
-     * [TODO] discuss what happens if it doesnt yet have a window container
-     * @returns the current window container for the window
-     */
-    getCurrentWindowContainer(): SpatialWindowContainer;
-    /**
-     * Start a transaction that queues up commands to submit them all at once to reduce ipc overhead
-     * @param fn function to be run, within this function, promises will not resolve
-     * @returns promise for the entire transaction completion
-     */
-    transaction(fn: Function): Promise<unknown>;
-    /**
-     * Creates a window context object that is compatable with SpatialWindowComponent's setFromWindow API
-     * @returns window context
-     */
-    createWindowContext(): Promise<Window | null>;
-    /** @hidden */
-    _getEntity(id: string): Promise<SpatialEntity>;
-    /** @hidden */
-    setLoading(method: LoadingMethodKind, style?: string): Promise<unknown>;
-}
-export {};
-//# sourceMappingURL=SpatialSession.d.ts.map

package/dist/core/SpatialSession.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SpatialSession.d.ts","sourceRoot":"","sources":["../../src/core/SpatialSession.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAMjE,OAAO,EACL,iBAAiB,EACjB,cAAc,EAEd,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,OAAO,EACL,mBAAmB,EACnB,sCAAsC,EACvC,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,aAAa,CAAA;AAGpB,KAAK,qBAAqB,GAAG;IAC3B,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;IAC/C,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;CAChD,CAAA;AAED;;GAEG;AACH,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;AA2B/D;;GAEG;AACH,qBAAa,cAAc;IACzB,cAAc;IACd,sBAAsB,iBAAwB;IAC9C,cAAc;IACd,iBAAiB,UAAQ;IAEzB;;;OAGG;IACH,8BAA8B,CAAC,QAAQ,EAAE,YAAY;IAerD;;;OAGG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB;IAUlD;;;;OAIG;IACG,qBAAqB,CAAC,OAAO,CAAC,EAAE,qBAAqB;IAU3D;;;OAGG;IACG,mBAAmB,CAAC,OAAO,CAAC,EAAE,qBAAqB;IAUzD;;;OAGG;IACG,oBAAoB,CACxB,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,qBAAqB;IAgBnD;;;OAGG;IACG,sBAAsB,CAC1B,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,qBAAqB;IAgBnD;;;;OAIG;IACG,oBAAoB,CAAC,OAAO,CAAC,EAAE,qBAAqB;IAU1D;;;OAGG;IACG,kBAAkB,CACtB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,qBAAqB;IAYtD;;;OAGG;IACG,qCAAqC,CACzC,OAAO,CAAC,EAAE,EAAE,GAAG,qBAAqB;IAWtC;;;SAGK;IACC,qBAAqB,CACzB,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,WAAW,CAAA;KACnB,GAAG,qBAAqB;IAa3B;;;;;;OAMG;IACG,YAAY,CAChB,KAAK,EAAE,WAAW,YAAU,EAC5B,GAAG,EAAE;QACH,SAAS,EAAE,cAAc,CAAA;KAC1B;IAKH;;;;OAIG;IACH,yBAAyB;IAIzB;;;OAGG;IACG,wBAAwB;IAgB9B;;;OAGG;IACG,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAUvB;;;OAGG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM;IAIvB;;;;OAIG;IACG,SAAS;iBACsC,GAAG;oBAAc,GAAG;;IAGzE;;OAEG;IACG,QAAQ,CAAC,eAAe,GAAE,MAA2C;IAI3E;;OAEG;IACG,2BAA2B;IAIjC,gCAAgC;IAC1B,kBAAkB;IAIxB,iCAAiC;IAC3B,qBAAqB;IAI3B,OAAO,CAAC,MAAM,CAAC,yBAAyB,CACD;IACvC;;;OAGG;IACG,2BAA2B;IAYjC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAwC;IAE9E;;;;OAIG;IACH,yBAAyB;IAWzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,QAAQ;IAMxB;;;OAGG;IACG,mBAAmB;IAgCzB,cAAc;IACR,UAAU,CAAC,EAAE,EAAE,MAAM;IAoB3B,cAAc;IACR,UAAU,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,CAAC,EAAE,MAAM;CAG3D"}