@yschindel/ara3d-webgl 1.3.0

package/dist/types/viewer/inputs/keyboard.d.ts

@@ -0,0 +1,107 @@
+import { InputHandler } from './inputHandler';
+export declare const KEYS: {
+    KEY_0: number;
+    KEY_1: number;
+    KEY_2: number;
+    KEY_3: number;
+    KEY_4: number;
+    KEY_5: number;
+    KEY_6: number;
+    KEY_7: number;
+    KEY_8: number;
+    KEY_9: number;
+    KEY_LEFT: number;
+    KEY_RIGHT: number;
+    KEY_UP: number;
+    KEY_DOWN: number;
+    KEY_CTRL: number;
+    KEY_SHIFT: number;
+    KEY_ENTER: number;
+    KEY_SPACE: number;
+    KEY_TAB: number;
+    KEY_ESCAPE: number;
+    KEY_BACKSPACE: number;
+    KEY_HOME: number;
+    KEY_END: number;
+    KEY_INSERT: number;
+    KEY_DELETE: number;
+    KEY_ALT: number;
+    KEY_F1: number;
+    KEY_F2: number;
+    KEY_F3: number;
+    KEY_F4: number;
+    KEY_F5: number;
+    KEY_F6: number;
+    KEY_F7: number;
+    KEY_F8: number;
+    KEY_F9: number;
+    KEY_F10: number;
+    KEY_F11: number;
+    KEY_F12: number;
+    KEY_NUMPAD0: number;
+    KEY_NUMPAD1: number;
+    KEY_NUMPAD2: number;
+    KEY_NUMPAD3: number;
+    KEY_NUMPAD4: number;
+    KEY_NUMPAD5: number;
+    KEY_NUMPAD6: number;
+    KEY_NUMPAD7: number;
+    KEY_NUMPAD8: number;
+    KEY_NUMPAD9: number;
+    KEY_ADD: number;
+    KEY_SUBTRACT: number;
+    KEY_MULTIPLY: number;
+    KEY_DIVIDE: number;
+    KEY_SEPARATOR: number;
+    KEY_DECIMAL: number;
+    KEY_OEM_PLUS: number;
+    KEY_OEM_MINUS: number;
+    KEY_A: number;
+    KEY_B: number;
+    KEY_C: number;
+    KEY_D: number;
+    KEY_E: number;
+    KEY_F: number;
+    KEY_G: number;
+    KEY_H: number;
+    KEY_I: number;
+    KEY_J: number;
+    KEY_K: number;
+    KEY_L: number;
+    KEY_M: number;
+    KEY_N: number;
+    KEY_O: number;
+    KEY_P: number;
+    KEY_Q: number;
+    KEY_R: number;
+    KEY_S: number;
+    KEY_T: number;
+    KEY_U: number;
+    KEY_V: number;
+    KEY_W: number;
+    KEY_X: number;
+    KEY_Y: number;
+    KEY_Z: number;
+};
+/**
+ * Manages keyboard user inputs
+ */
+export declare class KeyboardHandler extends InputHandler {
+    private SHIFT_MULTIPLIER;
+    isUpPressed: boolean;
+    isDownPressed: boolean;
+    isLeftPressed: boolean;
+    isRightPressed: boolean;
+    isEPressed: boolean;
+    isQPressed: boolean;
+    isShiftPressed: boolean;
+    isCtrlPressed: boolean;
+    arrowsEnabled: boolean;
+    protected addListeners(): void;
+    reset(): void;
+    private get camera();
+    private onKeyUp;
+    private onKeyDown;
+    private onKey;
+    private applyMove;
+}

package/dist/types/viewer/inputs/mouse.d.ts

@@ -0,0 +1,40 @@
+import { InputHandler } from './inputHandler';
+import { Viewer } from '../viewer';
+/**
+ * Manages mouse user inputs
+ */
+export declare class MouseHandler extends InputHandler {
+    private readonly _idleDelayMs;
+    zoomSpeed: number;
+    panSpeed: number;
+    rotateSpeed: number;
+    orbitSpeed: number;
+    private _buttonDown;
+    private _hasMouseMoved;
+    private _hasCameraMoved;
+    private _idleTimeout;
+    private _idlePosition;
+    private _lastPosition;
+    private _downPosition;
+    constructor(viewer: Viewer);
+    private get camera();
+    private get viewport();
+    private get canvas();
+    private get inputs();
+    protected addListeners(): void;
+    reset: () => void;
+    private resetIdle;
+    private onMouseOut;
+    private onCameraMoved;
+    private onMouseMove;
+    private onMouseDown;
+    private onMouseDrag;
+    private toRotation;
+    private onMouseMainDrag;
+    private onMouseMiddleDrag;
+    private onMouseRightDrag;
+    private onMouseWheel;
+    private getButton;
+    private onMouseUp;
+    private getModifier;
+}

package/dist/types/viewer/inputs/touch.d.ts

@@ -0,0 +1,33 @@
+import { InputHandler } from './inputHandler';
+import { Viewer } from '../viewer';
+export declare class TouchHandler extends InputHandler {
+    private readonly TAP_DURATION_MS;
+    private readonly DOUBLE_TAP_DELAY_MS;
+    private readonly TAP_MAX_MOVE_PIXEL;
+    private readonly ZOOM_SPEED;
+    private readonly MOVE_SPEED;
+    rotateSpeed: number;
+    orbitSpeed: number;
+    constructor(viewer: Viewer);
+    private get camera();
+    private get viewport();
+    private _touch;
+    private _touch1;
+    private _touch2;
+    private _touchStartTime;
+    private _lastTapMs;
+    private _touchStart;
+    protected addListeners(): void;
+    reset: () => void;
+    private onTap;
+    private onTouchStart;
+    private toRotation;
+    private onDrag;
+    private onDoubleDrag;
+    private onPinchOrSpread;
+    private onTouchMove;
+    private onTouchEnd;
+    private isSingleTouch;
+    private touchToVector;
+    private average;
+}

package/dist/types/viewer/rendering/renderer.d.ts

@@ -0,0 +1,22 @@
+import * as THREE from 'three';
+import { Viewport } from '../viewport';
+import { Camera } from '../camera/camera';
+import { Settings } from '../viewerSettings';
+export declare class Renderer {
+    renderer: THREE.WebGLRenderer;
+    antialias: boolean;
+    scene: THREE.Scene;
+    viewport: Viewport;
+    camera: Camera;
+    needsUpdate: boolean;
+    constructor(scene: THREE.Scene, viewport: Viewport, camera: Camera, settings: Settings);
+    dispose(): void;
+    get background(): THREE.Color | THREE.Texture;
+    set background(color: THREE.Color | THREE.Texture);
+    render(): void;
+    add(target: THREE.Object3D): boolean;
+    remove(target: THREE.Object3D): void;
+    clear(): void;
+    private _lastSize;
+    private fitViewport;
+}

package/dist/types/viewer/viewer.d.ts

@@ -0,0 +1,28 @@
+import * as THREE from 'three';
+import { Settings, PartialSettings } from './viewerSettings';
+import { Camera } from './camera/camera';
+import { Input } from './inputs/input';
+import { Environment } from './environment';
+import { GizmoOrbit } from './gizmos/gizmoOrbit';
+import { Viewport } from './viewport';
+import { Renderer } from './rendering/renderer';
+export declare class Viewer {
+    settings: Settings;
+    renderer: Renderer;
+    viewport: Viewport;
+    inputs: Input;
+    camera: Camera;
+    environment: Environment;
+    gizmoOrbit: GizmoOrbit;
+    running: boolean;
+    updateId: number | null;
+    clock: any;
+    scene: any;
+    constructor(options?: PartialSettings);
+    start(): void;
+    stop(): void;
+    private animate;
+    add(obj: THREE.Object3D, frameCamera?: boolean): void;
+    clear(): void;
+    dispose(): void;
+}

package/dist/types/viewer/viewerSettings.d.ts

@@ -0,0 +1,109 @@
+import * as THREE from 'three';
+export type TextureEncoding = 'url' | 'base64' | undefined;
+export { GizmoOptions } from './gizmos/gizmoAxes';
+/**
+ * Makes all field optional recursively
+ * https://stackoverflow.com/questions/41980195/recursive-partialt-in-typescript
+ */
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};
+/** Viewer related options  */
+export type Settings = {
+    /**
+     * Webgl canvas related options
+     */
+    canvas: {
+        /** Canvas dom model id. If none provided a new canvas will be created */
+        id: string | undefined;
+        /** Limits how often canvas will be resized if window is resized. */
+        resizeDelay: number;
+    };
+    /**
+     * Three.js camera related options
+     */
+    camera: {
+        /** Start with orthographic camera */
+        orthographic: boolean;
+        /** Vector3 of 0 or 1 to enable/disable movement along each axis */
+        allowedMovement: THREE.Vector3;
+        /** Vector2 of 0 or 1 to enable/disable rotation around x or y. */
+        allowedRotation: THREE.Vector2;
+        /** Near clipping plane distance */
+        near: number;
+        /** Far clipping plane distance */
+        far: number;
+        /** Fov angle in degrees */
+        fov: number;
+        /** Zoom level */
+        zoom: number;
+        /** Initial forward of the camera */
+        forward: THREE.Vector3;
+        /** Camera controls related options */
+        controls: {
+            /**
+             * <p>Set true to start in orbit mode.</p>
+             * <p>Camera has two modes: First person and orbit</p>
+             * <p>First person allows to moves the camera around freely</p>
+             * <p>Orbit rotates the camera around a focus point</p>
+             */
+            orbit: boolean;
+            /** Camera rotation speed factor */
+            rotateSpeed: number;
+            orbitSpeed: number;
+            /** Camera movement speed factor */
+            moveSpeed: number;
+        };
+        /** Camera gizmo related options */
+        gizmo: {
+            enable: boolean;
+            size: number;
+            color: THREE.Color;
+            opacity: number;
+            opacityAlways: number;
+        };
+    };
+    /**
+     * Rendering background options
+     */
+    background: {
+        color: THREE.Color;
+    };
+    /**
+     * Plane under scene related options
+     */
+    groundPlane: {
+        /** Enables/Disables plane under scene */
+        visible: boolean;
+        encoding: TextureEncoding;
+        /** Local or remote texture url for plane */
+        texture: string;
+        /** Opacity of the plane */
+        opacity: number;
+        /** Color of the plane */
+        color: THREE.Color;
+        /** Actual size is SceneRadius*size */
+        size: number;
+    };
+    /**
+     * Skylight (hemisphere light) options
+     */
+    skylight: {
+        skyColor: THREE.Color;
+        groundColor: THREE.Color;
+        intensity: number;
+    };
+    /**
+     * Sunlight (directional light) options
+     */
+    sunLights: {
+        position: THREE.Vector3;
+        color: THREE.Color;
+        intensity: number;
+    }[];
+    rendering: {
+        onDemand: boolean;
+    };
+};
+export type PartialSettings = RecursivePartial<Settings>;
+export declare function getSettings(options?: PartialSettings): Settings;

package/dist/types/viewer/viewport.d.ts

@@ -0,0 +1,41 @@
+import { Settings } from './viewerSettings';
+export declare class Viewport {
+    /** HTML Canvas on which the model is rendered */
+    canvas: HTMLCanvasElement;
+    /** HTML Element in which text is rendered */
+    text: HTMLElement | undefined;
+    private _unregisterResize;
+    private _ownedCanvas;
+    private _onResize;
+    get onResize(): import("ste-signals").ISignal;
+    constructor(settings: Settings);
+    /**
+     * Either returns html canvas at provided Id or creates a canvas at root level
+     */
+    private static getOrCreateCanvas;
+    /** Returns a text renderer that will render html in an html element sibling to canvas */
+    createTextRenderer(): any;
+    /** Removes canvas if owned */
+    dispose(): void;
+    /**
+     * Returns the pixel size of the parent element.
+     */
+    getParentSize(): any;
+    /**
+     * Returns the pixel size of the canvas.
+     */
+    getSize(): any;
+    /** Returns x/y of the parent size */
+    getAspectRatio(): number;
+    /**
+     * Resizes canvas and update camera to match new parent dimensions.
+     */
+    ResizeToParent(): void;
+    /**
+     * Set a callback for canvas resize with debouncing
+     * https://stackoverflow.com/questions/5825447/javascript-event-for-canvas-resize/30688151
+     * @param callback code to be called
+     * @param timeout time after the last resize before code will be called
+     */
+    private watchResize;
+}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@yschindel/ara3d-webgl",
+  "version": "1.3.0",
+  "description": "A 3D viewer designed for large architectural (BIM) models built on top of Three.JS.",
+  "files": [
+    "dist"
+  ],
+  "types": "./dist/types/index.d.ts",
+  "module": "dist/ara3d-webgl.mjs",
+  "homepage": "https://github.com/ara3d/ara3d-webgl.git",
+  "bugs": {
+    "url": "https://github.com/ara3d/ara3d-webgl/issues"
+  },
+  "license": "MIT",
+  "author": "Ara 3D <info@ara3d.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ara3d/ara3d-webgl.git"
+  },
+  "scripts": {
+    "dev": "vite --config vite.config.docs.js --host",
+    "build:docs": "vite build --config vite.config.docs.js && npm run gentypes",
+    "build:lib": "npx vite build --config vite.config.lib.js && npm run gentypes",
+    "preview:docs": "vite preview --mode github --config vite.config.docs.js --host",
+    "serve:docs": "http-server ./docs -o --host",
+    "eslint": "eslint --ext .js,.ts src --fix",
+    "gentypes": "tsc --declaration --emitDeclarationOnly --outdir ./dist/types",
+    "prepare": "npm run build:lib"
+  },
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.1",
+    "@typescript-eslint/parser": "^5.45.1",
+    "eslint": "^8.29.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "http-server": "^14",
+    "opener": "^1.5.2",
+    "prettier": "^2.8.0",
+    "typescript": "^5.9.3",
+    "vite": "^3.2.5"
+  },
+  "dependencies": {
+    "@types/node": "^18.11.11",
+    "deepmerge": "^4.2.2",
+    "hyparquet": "^1.23.2",
+    "hyparquet-compressors": "^1.1.1",
+    "jszip": "^3.10.1",
+    "ste-events": "^3.0.7",
+    "ste-signals": "^3.0.9",
+    "ste-simple-events": "^3.0.7"
+  },
+  "peerDependencies": {
+    "three": ">=0.150.0"
+  },
+  "keywords": [
+    "3d",
+    "ara3d",
+    "ara 3d",
+    "bim",
+    "viewer",
+    "three.js",
+    "model",
+    "aec",
+    "BIM Open Schema",
+    "BIM",
+    "BOS",
+    ".bos",
+    "loader",
+    "webgl"
+  ]
+}