@needle-tools/engine 5.1.0-alpha.5 → 5.1.0-alpha.6

package/dist/needle-engine.d.ts

@@ -124,6 +124,8 @@ export declare class __Ignore {
 
 export declare function __internalNotifyObjectDestroyed(obj: Object3D): void;
 
+/* Excluded from this release type: __otwqOR */
+
 /** Data describing the accessible semantics for a 3D object or component. */
 declare type AccessibilityData = {
     /** ARIA role (e.g. `"button"`, `"img"`, `"region"`). */
@@ -5420,6 +5422,8 @@ export declare class CustomShader extends RawShaderMaterial {
     onUpdateUniforms(camera?: Camera_2, obj?: any): void;
 }
 
+/* Excluded from this release type: _cxKhKwDL */
+
 export declare const debugNet: boolean;
 
 export declare const debugOwner: boolean;
@@ -8147,14 +8151,8 @@ export declare type GuidsMap = {
     [key: string]: string;
 };
 
-/* Excluded from this release type: hasCommercialLicense */
-
-/* Excluded from this release type: hasIndieLicense */
-
 /* Excluded from this release type: hasPointerEventComponent */
 
-/* Excluded from this release type: hasProLicense */
-
 export declare function hideDebugConsole(): void;
 
 export declare enum HideFlags {
@@ -10961,6 +10959,8 @@ declare class LowPassFilter {
     reset(value: number): void;
 }
 
+/* Excluded from this release type: LynjGsV */
+
 declare type MagicSkyboxName = "studio" | "blurred-skybox" | "quicklook-ar" | "quicklook";
 
 export declare class MainModule {
@@ -24001,6 +24001,25 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * @link https://github.com/immersive-web/marker-tracking/blob/main/explainer.md - WebXR Marker Tracking Specification
       */
      export declare class WebXRImageTracking extends Component {
+         /**
+          * Event invoked every frame when images are being tracked.
+          * @example
+          * ```ts
+          * const tracker = this.gameObject.getComponent(WebXRImageTracking);
+          * tracker?.imageTracked.addEventListener(evt => {
+          *   for (const img of evt.trackedImages) {
+          *     console.log(img.url, img.state);
+          *   }
+          * });
+          * ```
+          */
+         imageTracked: EventList<WebXRImageTrackingEvent>;
+         /** @inheritdoc */
+         addEventListener<K extends keyof WebXRImageTrackingEventMap>(type: K, listener: (evt: WebXRImageTrackingEventMap[K]) => any): void;
+         addEventListener<T extends Event>(type: string, listener: (evt: T) => any): void;
+         /** @inheritdoc */
+         removeEventListener<K extends keyof WebXRImageTrackingEventMap>(type: K, listener: (evt: WebXRImageTrackingEventMap[K]) => any): void;
+         removeEventListener<T extends Event>(type: string, listener: (evt: T) => any): void;
          /**
           * Set which marker should be primary (first in the list).
           * Useful when deploying to QuickLook mode where one marker is tracked at a time.
@@ -24087,6 +24106,18 @@ export declare class OrbitControls extends Component implements ICameraControlle
          private onImageTrackingUpdate;
      }
 
+     /** Data passed to image tracking event listeners. */
+     export declare interface WebXRImageTrackingEvent {
+         /** The images currently being tracked this frame. */
+         readonly trackedImages: readonly WebXRTrackedImage[];
+     }
+
+     /** Event map for {@link WebXRImageTracking} events. Use with `addEventListener` for typed event handling. */
+     export declare interface WebXRImageTrackingEventMap {
+         /** Dispatched every frame when images are being tracked. The event detail contains the tracking data for the current frame. */
+         "image-tracking": CustomEvent<WebXRImageTrackingEvent>;
+     }
+
      /**
       * Configuration model for a tracked image marker.
       * Defines which image to track, its physical size, and which 3D content to display when detected.
@@ -24285,8 +24316,39 @@ export declare class OrbitControls extends Component implements ICameraControlle
          get widthInMeters(): number;
          /** The ImageBitmap used for tracking */
          get bitmap(): ImageBitmap;
-         /** The {@link WebXRImageTrackingModel} configuration for this tracked image */
+         /**
+          * The {@link WebXRImageTrackingModel} configuration for this tracked image.
+          * Use this to access the assigned 3D object, marker settings, and other image tracking configuration.
+          * Available on each {@link WebXRTrackedImage} received from the `image-tracking` {@link CustomEvent} (`event.detail`).
+          * @example
+          * ```ts
+          * tracker.addEventListener("image-tracking", event => {
+          *   for (const img of event.detail.trackedImages) {
+          *     const model = img.model;
+          *     // Access the assigned 3D object
+          *     const obj = model.object;
+          *     // Access other settings
+          *     console.log(model.widthInMeters, model.hideWhenTrackingIsLost);
+          *   }
+          * });
+          * ```
+          */
          get model(): WebXRImageTrackingModel;
+         /**
+          * The 3D object or prefab assigned to this tracked image marker in the {@link WebXRImageTrackingModel}.
+          * Use this to access the object associated with an AR image tracking marker from the `image-tracking` {@link CustomEvent}.
+          * Shorthand for `this.model.object`.
+          * @example
+          * ```ts
+          * tracker.addEventListener("image-tracking", event => {
+          *   for (const img of event.detail.trackedImages) {
+          *     const obj = img.trackedModel;
+          *     // verbose alternative: img.model.object
+          *   }
+          * });
+          * ```
+          */
+         get trackedModel(): AssetReference | undefined;
          /**
           * The measured size of the detected image in the real world.
           * May differ from `widthInMeters` if the physical marker doesn't match the configured size.
@@ -24650,6 +24712,28 @@ export declare class OrbitControls extends Component implements ICameraControlle
      export { }
 
 
+declare module 'three' {
+    interface SkinnedMesh {
+        staticGenerator?: StaticGeometryGenerator;
+        staticGeometry?: BufferGeometry;
+        staticGeometryLastUpdate?: number;
+    }
+    interface Mesh {
+        acceleratedRaycast?: any;
+    }
+    interface SkinnedMesh {
+        /** @deprecated use autoUpdateMeshBvhInterval */
+        autoUpdateMeshBVH?: boolean;
+        /**
+         * Interval in milliseconds to automatically update the mesh BVH. When set to >= 0 the BVH will be updated every x milliseconds.
+         * @default undefined (disabled)
+         */
+        autoUpdateMeshBvhInterval?: number;
+        bvhNeedsUpdate?: boolean;
+    }
+}
+
+
 declare module 'three' {
     interface Object3D {
         get guid(): string | undefined;
@@ -24795,25 +24879,3 @@ declare module 'three' {
         slerp(end: Vector3, t: number): Vector3;
     }
 }
-
-
-declare module 'three' {
-    interface SkinnedMesh {
-        staticGenerator?: StaticGeometryGenerator;
-        staticGeometry?: BufferGeometry;
-        staticGeometryLastUpdate?: number;
-    }
-    interface Mesh {
-        acceleratedRaycast?: any;
-    }
-    interface SkinnedMesh {
-        /** @deprecated use autoUpdateMeshBvhInterval */
-        autoUpdateMeshBVH?: boolean;
-        /**
-         * Interval in milliseconds to automatically update the mesh BVH. When set to >= 0 the BVH will be updated every x milliseconds.
-         * @default undefined (disabled)
-         */
-        autoUpdateMeshBvhInterval?: number;
-        bvhNeedsUpdate?: boolean;
-    }
-}