@needle-tools/engine 6.0.0-alpha.5 → 6.0.0-alpha.7

package/dist/needle-engine.d.ts

@@ -23,7 +23,9 @@ import { DepthOfFieldEffect } from 'postprocessing';
 import { DepthTexture } from 'three';
 import { deriveInstanceId as deriveStableId } from '@needle-tools/addressing';
 import { dimforgeRapier3dCompat } from '@dimforge/rapier3d-compat';
+import { DocumentDefContext } from '@needle-tools/addressing/document';
 import { DocumentedOptions } from '../../../node_modules/three-mesh-ui/build/types/core/elements/MeshUIBaseElement.js';
+import { DocumentExtensionProvider } from '@needle-tools/addressing/document';
 import { Effect } from 'postprocessing';
 import { EffectComposer } from 'postprocessing';
 import { EffectComposer as EffectComposer_2 } from 'three/examples/jsm/postprocessing/EffectComposer.js';
@@ -138,6 +140,8 @@ export declare const $componentName: unique symbol;
 
 export declare const $physicsKey: unique symbol;
 
+/* Excluded from this release type: $TiDhB */
+
 export declare class __Ignore {
 }
 
@@ -145,7 +149,7 @@ export declare function __internalNotifyObjectDestroyed(obj: Object3D): void;
 
 /* Excluded from this release type: __internalStepGaussianSplatAdaptation */
 
-/* Excluded from this release type: __Pekxq */
+/* Excluded from this release type: __mor */
 
 /** Data describing the accessible semantics for a 3D object or component. */
 declare type AccessibilityData = {
@@ -4701,6 +4705,8 @@ export declare class Context implements IContext {
     get lifecycle(): ContextLifecycleMode;
     set lifecycle(value: ContextLifecycleMode);
     private _lifecycle;
+    /** Completes queued loading/setup callbacks without rendering or stepping simulation. */
+    flushPendingSceneSetup(): void;
     /**
      * Called when switching from "held" back to "running": while held, hierarchy active
      * flags keep updating but activation callbacks are gated. Components that were never
@@ -6005,6 +6011,16 @@ export declare class DocumentExtension implements IUSDExporterExtension {
     onAfterBuildDocument(_context: any): void;
 }
 
+/** Creates extension readers bound to each document's Engine context. */
+export declare interface DocumentExtensionRegistration {
+    readonly version: number;
+    readonly migrations?: DocumentExtensionProvider['migrations'];
+    readonly valueCodecs?: DocumentExtensionProvider['valueCodecs'];
+    readonly components?: {
+        createReader(context: DocumentDefContext): NonNullable<DocumentExtensionProvider['components']>['apply'] | undefined;
+    };
+}
+
 /**
  * [DragControls](https://engine.needle.tools/docs/api/DragControls) enables interactive dragging of objects in 2D (screen space) or 3D (world space).
  *
@@ -7324,8 +7340,6 @@ export declare class FixedRotationAxesConstraint implements IDragConstraint {
     apply(followObject: GameObject): void;
 }
 
-/* Excluded from this release type: _fncZ */
-
 declare type FocusRect = DOMRect | Element | {
     x: number;
     y: number;
@@ -15958,6 +15972,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      export declare class Physics {
+         /** Release the shared BVH worker pool after the last engine context is destroyed. */
+         static disposeMeshBVHWorkers(): void;
          private static _raycasting;
          /**
           * Returns true if raycasting is currently in progress
@@ -17893,6 +17909,11 @@ export declare class OrbitControls extends Component implements ICameraControlle
 
      export declare function registerCustomEffectType(name: string, effect: typeof PostProcessingEffect): void;
 
+     /** Register before loading documents. Disposing affects subsequent evaluations. */
+     export declare function registerDocumentExtensionProvider(id: string, provider: DocumentExtensionRegistration): {
+         dispose(): void;
+     };
+
      export declare class RegisteredAnimationInfo {
          private _start?;
          get start(): number;
@@ -18172,7 +18193,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
          reflectionProbeUsage: ReflectionProbeUsage;
          private _lightmaps?;
          /** Get the mesh Object3D for this renderer
-          * Warn: if this is a multimaterial object it will return the first mesh only
+          * Warn: if this is a multimaterial object it will return the first submesh only (same as `sharedMeshes[0]`), use {@link sharedMeshes} to get all of them
           * @returns a mesh object3D.
           * */
          get sharedMesh(): Mesh | SkinnedMesh | undefined;
@@ -21834,8 +21855,6 @@ export declare class OrbitControls extends Component implements ICameraControlle
          Manual = 4
      }
 
-     /* Excluded from this release type: sUknx */
-
      /**
       * Destroy an object across the network. See also {@link syncInstantiate}.
       * @param obj The object or component to be destroyed
@@ -26018,16 +26037,11 @@ export declare class OrbitControls extends Component implements ICameraControlle
          All = 4294967295
      }
 
+     /* Excluded from this release type: _yActo */
+
      export { }
 
 
-declare module 'three' {
-    interface Vector3 {
-        slerp(end: Vector3, t: number): Vector3;
-    }
-}
-
-
 declare module 'three' {
     interface Object3D {
         get guid(): string | undefined;
@@ -26168,6 +26182,28 @@ declare module 'three' {
 }
 
 
+declare module 'three' {
+    interface Vector3 {
+        slerp(end: Vector3, t: number): Vector3;
+    }
+}
+
+
+declare module 'three/examples/jsm/controls/OrbitControls.js' {
+    interface OrbitControls {
+        _sphericalDelta: import("three").Spherical;
+        _rotateLeft: (angleInRadians: number) => void;
+        _rotateUp: (angleInRadians: number) => void;
+        _pan: (dx: number, dy: number) => void;
+        _dollyIn: (dollyScale: number) => void;
+        _dollyOut: (dollyScale: number) => void;
+    }
+    interface OrbitControlsEventMap {
+        endMovement: Event;
+    }
+}
+
+
 declare module 'three' {
     interface SkinnedMesh {
         staticGenerator?: StaticGeometryGenerator;
@@ -26190,21 +26226,6 @@ declare module 'three' {
 }
 
 
-declare module 'three/examples/jsm/controls/OrbitControls.js' {
-    interface OrbitControls {
-        _sphericalDelta: import("three").Spherical;
-        _rotateLeft: (angleInRadians: number) => void;
-        _rotateUp: (angleInRadians: number) => void;
-        _pan: (dx: number, dy: number) => void;
-        _dollyIn: (dollyScale: number) => void;
-        _dollyOut: (dollyScale: number) => void;
-    }
-    interface OrbitControlsEventMap {
-        endMovement: Event;
-    }
-}
-
-
 declare module 'three' {
     interface Material {
         /** Unique ID for this material instance. Exists at runtime via Object.defineProperty. */