@mml-io/mml-web-playcanvas-standalone 0.0.0-experimental-edf5cd7-20250120

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Improbable MV Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# MML Web PlayCanvas Standalone
+#### `@mml-io/mml-web-playcanvas-standalone`
+
+[![npm version](https://img.shields.io/npm/v/@mml-io/mml-web-playcanvas-standalone.svg?style=flat)](https://www.npmjs.com/package/@mml-io/mml-web-playcanvas-standalone)
+
+This package contains a class, `StandalonePlayCanvasAdapter`, that is a PlayCanvas-backed Graphics Adapter implementation for `@mml-io/mml-web` that creates:
+* A PlayCanvas App instance
+  * with embedded DRACO, Ammo, glglang, and twgsl WASM bundles as base64 encoded strings (to avoid external dependencies at runtime)
+* Orbit and drag-fly controls
+* A factory for MML element graphics instances from the `@mml-io/mml-web-playcanvas` package.
+
+It is intended to be used with the following packages:
+* `@mml-io/mml-web`
+  * provides the MML element handling and parsing and can use this package as a Graphics Adapter.
+
+
+## Example Usage
+
+```typescript
+import { FullScreenMMLScene } from "@mml-io/mml-web";
+import {
+  StandalonePlayCanvasAdapter, StandalonePlayCanvasAdapterControlsType,
+} from "@mml-io/mml-web-playcanvas-standalone";
+
+// ** This code is not a complete example. See @mml-io/mml-web for more info on how to use an MMLScene **
+
+// Create an MML Scene that will act as the container for MML content
+const fullScreenMMLScene = new FullScreenMMLScene<StandalonePlayCanvasAdapter>();
+// Append the element of the MML scene to the page
+document.body.append(fullScreenMMLScene.element);
+
+// Provide the element for the renderer to the adapter to attach controls to
+const graphicsAdapter = await StandalonePlayCanvasAdapter.create(fullScreenMMLScene.element, {
+  controlsType: StandalonePlayCanvasAdapterControlsType.DragFly,
+});
+
+// Provide the Graphics Adapter to the MML Scene to use to render elements
+fullScreenMMLScene.init(graphicsAdapter);
+```

package/build/StandalonePlayCanvasAdapter.d.ts

@@ -0,0 +1,54 @@
+import { Interaction, MMLGraphicsInterface } from "@mml-io/mml-web";
+import { PlayCanvasGraphicsAdapter } from "@mml-io/mml-web-playcanvas";
+import * as playcanvas from "playcanvas";
+import { PlayCanvasControls } from "./controls/PlayCanvasControls";
+export declare enum StandalonePlayCanvasAdapterControlsType {
+    None = 0,
+    DragFly = 1,
+    Orbit = 2
+}
+export type StandalonePlayCanvasAdapterOptions = {
+    controlsType?: StandalonePlayCanvasAdapterControlsType;
+};
+export declare class StandalonePlayCanvasAdapter implements PlayCanvasGraphicsAdapter {
+    private element;
+    private options;
+    containerType: playcanvas.Entity;
+    collisionType: playcanvas.Entity;
+    private playcanvasApp;
+    controls: PlayCanvasControls | null;
+    private camera;
+    private canvas;
+    private clickTrigger;
+    private constructor();
+    getPlayCanvasApp(): playcanvas.AppBase;
+    getCamera(): playcanvas.Entity;
+    getGraphicsAdapterFactory(): MMLGraphicsInterface<this>;
+    static create(element: HTMLElement, options: StandalonePlayCanvasAdapterOptions): Promise<StandalonePlayCanvasAdapter>;
+    interactionShouldShowDistance(interaction: Interaction<this>): number | null;
+    init(): Promise<void>;
+    setControlsType(type?: StandalonePlayCanvasAdapterControlsType): void;
+    setCameraFOV(fov: number): null | undefined;
+    start(): void;
+    getUserPositionAndRotation(): {
+        position: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        rotation: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+    resize(width: number, height: number): void;
+    dispose(): void;
+    getRootContainer(): playcanvas.Entity;
+    getBoundingBoxForElement(element: HTMLElement): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    } | null;
+}

package/build/controls/PlayCanvasControls.d.ts

@@ -0,0 +1,12 @@
+import { IVect3 } from "@mml-io/mml-web";
+export interface PlayCanvasControls {
+    type: string;
+    enable: () => void;
+    disable: () => void;
+    fitContent: (boundingBox: {
+        min: IVect3;
+        max: IVect3;
+    }) => void;
+    update: (dt: number) => void;
+    dispose: () => void;
+}

package/build/controls/PlayCanvasDragFlyCameraControls.d.ts

@@ -0,0 +1,42 @@
+import { IVect3 } from "@mml-io/mml-web";
+import * as playcanvas from "playcanvas";
+export declare class PlayCanvasDragFlyCameraControls {
+    readonly type = "drag-fly";
+    private enabled;
+    private camera;
+    private domElement;
+    private speed;
+    private yaw;
+    private pitch;
+    private forward;
+    private backward;
+    private left;
+    private right;
+    private up;
+    private down;
+    private minPolarAngle;
+    private maxPolarAngle;
+    private invertedMouseY;
+    private eventHandlerCollection;
+    private mouseDown;
+    constructor(camera: playcanvas.Entity, domElement: HTMLElement, speed?: number);
+    fitContent(boundingBox: {
+        min: IVect3;
+        max: IVect3;
+    }): void;
+    enable(): void;
+    disable(): void;
+    setInvert(invert: boolean): void;
+    dispose(): void;
+    setCameraPosition(x: number, y: number, z: number): void;
+    setLookAt(x: number, y: number, z: number): void;
+    update(dt: number): void;
+    private onKeyDown;
+    private onKeyUp;
+    private onBlur;
+    private onMouseDown;
+    private onMouseMove;
+    private updateCameraFromYawAndPitch;
+    private onMouseUp;
+    private onMouseWheel;
+}

package/build/controls/PlayCanvasOrbitCameraControls.d.ts

@@ -0,0 +1,39 @@
+import { IVect3 } from "@mml-io/mml-web";
+import * as playcanvas from "playcanvas";
+import { PlayCanvasControls } from "./PlayCanvasControls";
+export declare class PlayCanvasOrbitCameraControls implements PlayCanvasControls {
+    private camera;
+    private domElement;
+    private distance;
+    readonly type = "orbit";
+    private enabled;
+    private degreesPerSecond;
+    private yaw;
+    private pitch;
+    private minPolarAngle;
+    private maxPolarAngle;
+    private invertedMouseY;
+    private eventHandlerCollection;
+    private mouseDown;
+    private cameraLookAt;
+    constructor(camera: playcanvas.Entity, domElement: HTMLElement, distance?: number);
+    fitContent(boundingBox: {
+        min: IVect3;
+        max: IVect3;
+    }): void;
+    enable(): void;
+    disable(): void;
+    setInvert(invert: boolean): void;
+    dispose(): void;
+    private getBaseYaw;
+    update(): void;
+    private onBlur;
+    private onMouseDown;
+    setDegreesPerSecond(degreesPerSecond: number): void;
+    setLookAt(x: number, y: number, z: number): void;
+    setDistance(distance: number): void;
+    setPitchDegrees(pitch: number): void;
+    private onMouseMove;
+    private onMouseUp;
+    private onMouseWheel;
+}

package/build/controls/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./PlayCanvasControls";
+export * from "./PlayCanvasDragFlyCameraControls";
+export * from "./PlayCanvasOrbitCameraControls";

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./controls/";
+export * from "./StandalonePlayCanvasAdapter";