@needle-tools/engine 4.12.5 → 4.13.0-next.2d429c0

package/dist/needle-engine.d.ts

@@ -48,6 +48,7 @@ import { Layers } from 'three';
 import { LightProbe } from 'three';
 import { Line2 } from 'three/examples/jsm/lines/Line2.js';
 import { Loader } from 'three';
+import { LoadingManager } from 'three';
 import { LOD_Results } from '@needle-tools/gltf-progressive';
 import { LODsManager as LODsManager_2 } from '@needle-tools/gltf-progressive';
 import { Material } from 'three';
@@ -61,6 +62,7 @@ import { n8ao } from 'n8ao';
 import { N8AOPostPass } from 'n8ao';
 import { NEEDLE_progressive } from '@needle-tools/gltf-progressive';
 import { NEEDLE_progressive_plugin } from '@needle-tools/gltf-progressive';
+import { needleToolsMaterialx } from '@needle-tools/materialx';
 import { NormalBufferAttributes } from 'three';
 import { Object3D } from 'three';
 import { Object3DEventMap } from 'three';
@@ -8694,6 +8696,17 @@ export declare class MaskableGraphic extends Graphic {
     protected onAfterCreated(): void;
 }
 
+export declare namespace MaterialX {
+    /**
+     * Utility function to load a MaterialX material from a URL. This can be used in your own code to load MaterialX materials outside of the glTF loading process. The URL should point to a MaterialX XML file.
+     */
+    export function loadFromUrl(urlOrXML: string, opts?: {
+        url?: string;
+        loadingManager?: LoadingManager;
+        materialNameOrIndex?: number | string;
+    }): Promise<Material | null>;
+}
+
 export declare const Mathf: MathHelper;
 
 declare class MathHelper {
@@ -8914,6 +8927,15 @@ export declare namespace NEEDLE_ENGINE_FEATURE_FLAGS {
  * If a module is already loaded it's also available in the `MODULE` variable.
  */
 export declare namespace NEEDLE_ENGINE_MODULES {
+    export namespace MaterialX {
+        export type TYPE = needleToolsMaterialx;
+        let MODULE: TYPE;
+        let MAYBEMODULE: TYPE | null;
+        /** Wait for the module to be loaded (doesn't trigger a load) */
+        export function ready(): Promise<TYPE>;
+        /** Load the module */
+        export function load(): Promise<TYPE>;
+    }
     export namespace RAPIER_PHYSICS {
         export type TYPE = dimforgeRapier3dCompat;
         let MODULE: TYPE;
@@ -9508,7 +9530,7 @@ export declare type NeedleMenuPostMessageModel = {
 /**
  * The supported file types that can be determined by the engine. Used in {@link tryDetermineMimetypeFromURL} and {@link tryDetermineMimetypeFromBinary}
  */
-export declare type NeedleMimetype = "unknown" | "unsupported" | "model/gltf+json" | "model/gltf-binary" | "model/vrm" | "model/vnd.usdz+zip" | "model/vnd.usd" | "model/vnd.usda" | "model/vnd.usdc" | "model/fbx" | "model/vnd.autodesk.fbx" | "model/obj" | (string & {});
+export declare type NeedleMimetype = "unknown" | "unsupported" | "model/gltf+json" | "model/gltf-binary" | "model/vrm" | "model/vnd.usdz+zip" | "model/vnd.usd" | "model/vnd.usda" | "model/vnd.usdc" | "model/fbx" | "model/vnd.autodesk.fbx" | "model/obj" | "application/materialx+xml" | (string & {});
 
 export declare const NeedlePatchesKey = "Needle:Patches";