xrblocks 0.5.1 → 0.7.0

package/README.md

@@ -74,8 +74,8 @@ code below:
     <script type="importmap">
       {
         "imports": {
-          "three": "https://cdn.jsdelivr.net/npm/three@0.181.0/build/three.module.js",
-          "three/addons/": "https://cdn.jsdelivr.net/npm/three@0.181.0/examples/jsm/",
+          "three": "https://cdn.jsdelivr.net/npm/three@0.182.0/build/three.module.js",
+          "three/addons/": "https://cdn.jsdelivr.net/npm/three@0.182.0/examples/jsm/",
           "xrblocks": "https://cdn.jsdelivr.net/gh/google/xrblocks@build/xrblocks.js",
           "xrblocks/addons/": "https://cdn.jsdelivr.net/gh/google/xrblocks@build/addons/"
         }

package/build/ai/AI.d.ts

@@ -76,7 +76,7 @@ export declare class AI extends Script {
      * In XR mode, show a 3D UI to instruct users to get an API key.
      */
     triggerKeyPopup(): void;
-    generate(prompt: string | string[], type?: 'image', systemInstruction?: string, model?: string): Promise<string | void | undefined>;
+    generate(prompt: string | string[], type?: 'image', systemInstruction?: string, model?: undefined): Promise<string | void | undefined>;
     /**
      * Create a sample keys.json file structure for reference
      * @returns Sample keys.json structure

package/build/camera/CameraUtils.d.ts

@@ -12,13 +12,29 @@ export declare const aspectRatios: {
  *
  * @param rgbUv - The RGB UV coordinate, e.g., \{ u: 0.5, v: 0.5 \}.
  * @param xrDeviceCamera - The device camera instance.
+ * @returns The transformed UV coordinate in the render camera clip space, or null if
+ *     inputs are invalid.
+ */
+export declare function transformRgbToRenderCameraClip(rgbUv: {
+    u: number;
+    v: number;
+}, xrDeviceCamera?: XRDeviceCamera): THREE.Vector2 | null;
+/**
+ * Maps a UV coordinate from a RGB space to a destination depth space,
+ * applying Brown-Conrady distortion and affine transformations based on
+ * aspect ratios. If the simulator camera is used, no transformation is applied.
+ *
+ * @param rgbUv - The RGB UV coordinate, e.g., \{ u: 0.5, v: 0.5 \}.
+ * @param renderCameraWorldFromClip - Render camera world from clip, i.e. inverse of the View Projection matrix.
+ * @param depthCameraClipFromWorld - Depth camera clip from world, i.e.
+ * @param xrDeviceCamera - The device camera instance.
  * @returns The transformed UV coordinate in the depth image space, or null if
  *     inputs are invalid.
  */
 export declare function transformRgbToDepthUv(rgbUv: {
     u: number;
     v: number;
-}, xrDeviceCamera?: XRDeviceCamera): {
+}, renderCameraWorldFromClip: THREE.Matrix4, depthCameraClipFromWorld: THREE.Matrix4, xrDeviceCamera?: XRDeviceCamera): {
     u: number;
     v: number;
 } | null;
@@ -30,9 +46,9 @@ export declare function transformRgbToDepthUv(rgbUv: {
  *
  * @param rgbUv - The RGB UV coordinate, e.g., \{ u: 0.5, v: 0.5 \}.
  * @param depthArray - Array containing depth data.
- * @param viewProjectionMatrix - XRView object with corresponding
+ * @param projectionMatrix - XRView object with corresponding
  * projection matrix.
- * @param matrixWorld - Matrix for view-to-world translation.
+ * @param matrixWorld - Rendering camera's model matrix.
  * @param xrDeviceCamera - The device camera instance.
  * @param xrDepth - The SDK's Depth module.
  * @returns Vertex at (u, v) in world space.
@@ -40,7 +56,7 @@ export declare function transformRgbToDepthUv(rgbUv: {
 export declare function transformRgbUvToWorld(rgbUv: {
     u: number;
     v: number;
-}, depthArray: number[] | Uint16Array | Float32Array, viewProjectionMatrix: THREE.Matrix4, matrixWorld: THREE.Matrix4, xrDeviceCamera?: XRDeviceCamera, xrDepth?: Depth | undefined): THREE.Vector3 | null;
+}, depthArray: number[] | Uint16Array | Float32Array, projectionMatrix: THREE.Matrix4, matrixWorld: THREE.Matrix4, xrDeviceCamera?: XRDeviceCamera, xrDepth?: Depth | undefined): THREE.Vector3;
 /**
  * Asynchronously crops a base64 encoded image using a THREE.Box2 bounding box.
  * This function creates an in-memory image, draws a specified portion of it to

package/build/core/components/ScriptsManager.d.ts

@@ -14,6 +14,9 @@ export declare class ScriptsManager {
     callKeyUpBound: (event: KeyEvent) => void;
     /** The set of scripts currently being initialized. */
     private initializingScripts;
+    private seenScripts;
+    private syncPromises;
+    private checkScriptBound;
     constructor(initScriptFunction: (script: Script) => Promise<void>);
     /**
      * Initializes a script and adds it to the set of scripts which will receive
@@ -29,13 +32,17 @@ export declare class ScriptsManager {
      * @param script - The script to uninitialize.
      */
     uninitScript(script: Script): void;
+    /**
+     * Helper for scene traversal to avoid closure allocation.
+     */
+    private checkScript;
     /**
      * Finds all scripts in the scene and initializes them or uninitailizes them.
      * Returns a promise which resolves when all new scripts are finished
      * initalizing.
      * @param scene - The main scene which is used to find scripts.
      */
-    syncScriptsWithScene(scene: THREE.Scene): Promise<void>;
+    syncScriptsWithScene(scene: THREE.Scene): Promise<PromiseSettledResult<void>[]>;
     callSelectStart(event: SelectEvent): void;
     callSelectEnd(event: SelectEvent): void;
     callSelect(event: SelectEvent): void;

package/build/depth/Depth.d.ts

@@ -10,7 +10,6 @@ export declare class Depth {
     private renderer;
     private scene;
     private projectionMatrixInverse;
-    private xrRefSpace?;
     view: XRView[];
     cpuDepthData: XRCPUDepthInformation[];
     gpuDepthData: XRWebGLDepthInformation[];
@@ -20,11 +19,14 @@ export declare class Depth {
     options: DepthOptions;
     width: number;
     height: number;
-    rawValueToMeters: number;
+    get rawValueToMeters(): number;
     occludableShaders: Set<Shader>;
     private occlusionPass?;
     private depthClientsInitialized;
     private depthClients;
+    depthProjectionMatrices: THREE.Matrix4[];
+    depthViewMatrices: THREE.Matrix4[];
+    depthViewProjectionMatrices: THREE.Matrix4[];
     /**
      * Depth is a lightweight manager based on three.js to simply prototyping
      * with Depth in WebXR.
@@ -54,9 +56,10 @@ export declare class Depth {
      * @returns Vertex at (u, v)
      */
     getVertex(u: number, v: number): THREE.Vector3 | null;
-    updateCPUDepthData(depthData: XRCPUDepthInformation, view_id?: number): void;
-    updateGPUDepthData(depthData: XRWebGLDepthInformation, view_id?: number): void;
-    getTexture(view_id: number): THREE.DataTexture | THREE.ExternalTexture | undefined;
+    private updateDepthMatrices;
+    updateCPUDepthData(depthData: XRCPUDepthInformation, viewId?: number): void;
+    updateGPUDepthData(depthData: XRWebGLDepthInformation, viewId?: number): void;
+    getTexture(viewId: number): THREE.DataTexture | THREE.ExternalTexture | undefined;
     update(frame?: XRFrame): void;
     updateLocalDepth(frame: XRFrame): void;
     renderOcclusionPass(): void;

package/build/depth/DepthTextures.d.ts

@@ -2,14 +2,14 @@ import * as THREE from 'three';
 import { DepthOptions } from './DepthOptions';
 export declare class DepthTextures {
     private options;
-    private uint16Arrays;
+    private float32Arrays;
     private uint8Arrays;
     private dataTextures;
     private nativeTextures;
     depthData: XRCPUDepthInformation[];
     constructor(options: DepthOptions);
     private createDataDepthTextures;
-    updateData(depthData: XRCPUDepthInformation, view_id: number): void;
-    updateNativeTexture(depthData: XRWebGLDepthInformation, renderer: THREE.WebGLRenderer, view_id: number): void;
-    get(view_id: number): THREE.DataTexture | THREE.ExternalTexture;
+    updateData(depthData: XRCPUDepthInformation, viewId: number): void;
+    updateNativeTexture(depthData: XRWebGLDepthInformation, renderer: THREE.WebGLRenderer, viewId: number): void;
+    get(viewId: number): THREE.DataTexture | THREE.ExternalTexture;
 }

package/build/simulator/SimulatorDepth.d.ts

@@ -4,15 +4,25 @@ import { SimulatorDepthMaterial } from './SimulatorDepthMaterial';
 import { SimulatorScene } from './SimulatorScene';
 export declare class SimulatorDepth {
     private simulatorScene;
-    renderer: THREE.WebGLRenderer;
-    camera: THREE.Camera;
-    depth: Depth;
+    private renderer;
+    private camera;
+    private depth;
     depthWidth: number;
     depthHeight: number;
     depthBufferSlice: Float32Array<ArrayBuffer>;
     depthMaterial: SimulatorDepthMaterial;
     depthRenderTarget: THREE.WebGLRenderTarget;
     depthBuffer: Float32Array;
+    depthCamera: THREE.Camera;
+    /**
+     * If true, copies the rendering camera's projection matrix each frame.
+     */
+    autoUpdateDepthCameraProjection: boolean;
+    /**
+     * If true, copies the rendering camera's transform each frame.
+     */
+    autoUpdateDepthCameraTransform: boolean;
+    private projectionMatrixArray;
     constructor(simulatorScene: SimulatorScene);
     /**
      * Initialize Simulator Depth.
@@ -20,6 +30,7 @@ export declare class SimulatorDepth {
     init(renderer: THREE.WebGLRenderer, camera: THREE.Camera, depth: Depth): void;
     createRenderTarget(): void;
     update(): void;
-    renderDepthScene(): void;
-    updateDepth(): void;
+    private updateDepthCamera;
+    private renderDepthScene;
+    private updateDepth;
 }