@needle-tools/usd 0.0.1-alpha.3 → 0.0.1-c92147f

package/CHANGELOG.md

@@ -4,5 +4,5 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [0.0.1-alpha.1] - 2025-05-14
+## [0.0.1-alpha] - 2025-05-14
 - initial release

package/README.md

@@ -9,7 +9,24 @@ For commercial use please contact hi@needle.tools
 
 
 
-## Usage
+## Use with Needle Engine
+
+
+```ts
+import { get } from "svelte/store";
+import { activeFiles } from "..";
+import { addPluginForNeedleEngine } from "@needle-tools/usd/plugins";
+
+export function addUsdPlugin() {
+    return addPluginForNeedleEngine({
+        // USD files to load (first file must be the main file)
+        getFiles: () => { return get(activeFiles) as Array<File & { path: string }> }
+    })
+}
+```
+
+
+### Use with other three.js based viewers
 
 
 See full example in [examples](./examples/src/main.ts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/usd",
-  "version": "0.0.1-alpha.3",
+  "version": "0.0.1-c92147f",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "type": "module",
@@ -37,7 +37,7 @@
   },
   "peerDependencies": {
     "three": "^0.164.1",
-    "@needle-tools/engine": ">= 4.5.0-alpha.4"
+    "@needle-tools/engine": ">= 4.6.0-0"
   },
   "devDependencies": {
     "vite": "^5.2.13",
@@ -47,4 +47,4 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   }
-}
+}

package/src/bindings/index.js

@@ -56,10 +56,22 @@ export async function getUsdModule(opts) {
 
     return usd_module_promise = getUsdModuleFn({
         mainScriptUrlOrBlob: bindings.default,// "./emHdBindings.js",
+        ...opts,
         setStatus: (status) => {
-            console.debug("🧊 USD STATUS", status);
+            // TODO: would be nice to have a progress event
+            // for now we parse the log 'Downloading data... (219516/849069)'
+            if (opts?.onDownloadProgress && status.includes("Downloading data...")) {
+                const start = status.indexOf("(");
+                const end = status.indexOf("/");
+                const start2 = status.indexOf("/", end);
+                const end2 = status.indexOf(")", start2);
+                const startNum = parseInt(status.substring(start + 1, end));
+                const endNum = parseInt(status.substring(end + 1, end2));
+                opts.onDownloadProgress(startNum, endNum);
+            }
+            if (opts?.setStatus) opts.setStatus(status);
+            else console.debug("🧊 USD STATUS", status);
         },
-        ...opts,
         locateFile: (file) => {
             // if (opts?.debug === true) console.warn("LOCATE FILE:", file)
 

package/src/index.js

@@ -2,5 +2,4 @@ export * from "./bindings/index.js";
 export * from "./hydra/index.js";
 export * from "./create.three.js";
 export * from "./vite/index.js";
-export * from "./plugins/index.js";
 export { tryDetermineFileFormat } from "./utils.js"

package/src/types/bindings.d.ts

@@ -60,10 +60,11 @@ export type GetUsdModuleOptions = {
     locateFile?: (path: string) => string,
     getPreloadedPackage?: (file: string, size: number) => ArrayBuffer | null,
     setStatus?: (status: string) => void,
+    onDownloadProgress?: (downloaded: number, total: number) => void,
     /** Returns a transferable object that can be resolved to an ArrayBuffer, 
      *  or an URL that can be fetched to get an ArrayBuffer.
     */
-    urlModifier?: (url: string) => 
+    urlModifier?: (url: string) =>
         Promise<
             ArrayBuffer | File | FileSystemFileHandle | FileSystemFileEntry | string
         > | ArrayBuffer | File | FileSystemFileHandle | FileSystemFileEntry | string,