@needle-tools/engine 4.15.0-next.f391a30 → 4.15.0

package/dist/needle-engine.d.ts

@@ -3503,6 +3503,21 @@ export declare const colorSerializer: ColorSerializer;
  */
 export declare function compareAssociation<T extends Material>(obj1: T, obj2: T): boolean;
 
+declare type ComparisonSceneOptions = {
+    /**
+     * An array of model urls to load
+     */
+    files: string[];
+    /**
+     * Optional dom element to attach the orbit controls to. By default this should be the WebGLRenderer.domElement
+     */
+    domElement?: HTMLElement;
+    /**
+     * Can be a .hdr or .exr file url
+     */
+    environment?: string;
+};
+
 /**
  * Needle Engine component's are the main building blocks of the Needle Engine.
  * Derive from {@link Behaviour} to implement your own using the provided lifecycle methods.
@@ -10987,10 +11002,7 @@ export declare class NeedleEngineWebComponent extends HTMLElement implements INe
     private _previousSrc;
     /** @private set to true after <needle-engine> did load completely at least once. Set to false when < to false when <needle-engine> is removed from the document removed from the document */
     private _didFullyLoad;
-    private _didInitialize;
     constructor();
-    private ensureInitialized;
-    private initializeDom;
     /* Excluded from this release type: connectedCallback */
     /* Excluded from this release type: disconnectedCallback */
     connectedMoveCallback(): void;
@@ -15618,19 +15630,11 @@ export declare class OrbitControls extends Component implements ICameraControlle
       */
      export declare class ReflectionProbe extends Component {
          private static _probes;
-         /**
-          * Checks if the given material is currently using a reflection probe. This is determined by checking for an override on the material's "envMap" property, which is set by the Renderer component when applying a reflection probe.
-          */
          static isUsingReflectionProbe(material: Material): boolean;
          /**
           * Event invoked when a reflection probe is enabled. Used internally by Renderer components to update probes when they become active. Not recommended to call this directly in most cases.
-          * @see {@link onDisabled} for the corresponding disable event.
           */
          static readonly onEnabled: EventList<ReflectionProbe>;
-         /**
-          * Event invoked when a reflection probe is disabled. Used internally by Renderer components to update probes when they become inactive. Not recommended to call this directly in most cases.
-          * @see {@link onEnabled} for the corresponding enable event.
-          */
          static readonly onDisabled: EventList<ReflectionProbe>;
          /**
           * Gets the active reflection probe for the given object and context. If `isAnchor` is true, it will only return a probe if the object is the anchor of that probe. Otherwise, it checks if the object is within the probe's influence area.
@@ -15646,11 +15650,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
          static get(object: Object3D | null | undefined, context: Context, isAnchor: boolean, anchor?: Object3D): ReflectionProbe | null;
          private _texture;
          private _textureUrlInFlight?;
-         /**
-          * The cubemap or HDR texture used for reflections. Can be assigned directly or via a URL string. When assigning via URL, the texture will be loaded asynchronously and applied once ready.
-          */
-         set texture(tex: Texture | null);
-         get texture(): Texture | null;
+         set texture(tex: Texture);
+         get texture(): Texture;
          intensity: number;
          /**
           * Defines the center and size of the reflection probe's influence area.
@@ -15667,18 +15668,12 @@ export declare class OrbitControls extends Component implements ICameraControlle
          private _boxHelper?;
          private isInBox;
          constructor();
-         /* Excluded from this release type: awake */
-         /* Excluded from this release type: onEnable */
-         /* Excluded from this release type: onDisable */
-         /* Excluded from this release type: start */
-         /* Excluded from this release type: onDestroy */
-         /**
-          * Applies this reflection probe to the given object by setting material property overrides for "envMap", "envMapRotation", and "envMapIntensity". This is typically called by the Renderer component when determining which reflection probe to use for a given object.
-          */
+         awake(): void;
+         onEnable(): void;
+         onDisable(): void;
+         start(): void;
+         onDestroy(): void;
          apply(object: Object3D): void;
-         /**
-          * Removes the reflection probe overrides from the given object. This is typically called by the Renderer component when an object is no longer influenced by this probe or when the probe is disabled.
-          */
          unapply(obj: Object3D): void;
      }
 
@@ -19686,6 +19681,30 @@ export declare class OrbitControls extends Component implements ICameraControlle
 
      /* Excluded from this release type: TestRunner */
 
+     /**
+      * A collection of utility methods for quickly spinning up test environments
+      */
+     export declare class TestSceneUtils {
+         /**
+          * Use this method to quickly setup a scene to compare multiple models.
+          * @example
+          * ```ts
+          * const files = [
+          *    "https://threejs.org/examples/models/gltf/RobotExpressive/RobotExpressive.glb",
+          *   "https://threejs.org/examples/models/gltf/Lantern/glTF-Binary/Lantern.glb",
+          * ];
+          * const { scene, camera } = await TestUtils.createComparisonScene({ files });
+          * // this could now be assigned to the Needle Engine Context
+          * context.scene = scene;
+          * context.mainCamera = camera;
+          * ```
+          */
+         static createComparisonScene(opts: ComparisonSceneOptions): Promise<{
+             scene: Scene;
+             camera: PerspectiveCamera;
+         }>;
+     }
+
      /* Excluded from this release type: TestSimulateUserData */
 
      /**
@@ -23147,12 +23166,6 @@ export declare namespace SplineUtils {
     function createFromPoints(positions: Vector3[], closed?: boolean, tension?: number): SplineContainer;
 }
 
-declare global {
-    interface HTMLElementTagNameMap {
-        "needle-logo-element": NeedleLogoElement;
-    }
-}
-
 
 /**
  * Internal registry for USDZ exporters. This is used by NeedleXRSession.start("immersive-ar")
@@ -23163,6 +23176,12 @@ export declare namespace InternalUSDZRegistry {
     function unregisterExporter(exporter: USDZExporter): void;
 }
 
+declare global {
+    interface HTMLElementTagNameMap {
+        "needle-logo-element": NeedleLogoElement;
+    }
+}
+
 
 declare module 'three' {
     interface Vector3 {