@needle-tools/gltf-progressive 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -4,6 +4,10 @@ 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).
 
+## [3.2.0] - 2025-08-11
+- Change: `useNeedleProgressive` hook parameters. It now only requires the GLTFLoader and WebGLRenderer: `useNeedleProgressive(<loader>, <renderer>)` instead of `useNeedleProgressive(<url>, <renderer>, <loader>)`. This simplify usage when using the same GLTFLoader for multiple different model load operations.
+- Internal: Start of web worker for texture and mesh LOD loading. Currently this can only be enabled by appending the `gltf-progressive-worker` query parameter to the URL.
+
 ## [3.1.1] - 2025-08-07
 - Fix: Issue where compressed texture did loose LOD information ([issue](https://linear.app/needle/issue/NE-6669))
 - Chore: Warn once if multi-mesh primitive is detected but compressed asset doesnt have densities per primitive, meaning an older compression pipeline version was used in processing this asset that would require an update for correct LOD updates

package/README.md

@@ -1,6 +1,17 @@
 # glTF progressive
 
-Blazingly fast loading with lazy LODs for glTF, GLB or VRM files + smart density based LOD selection for meshes or texture for any three.js based project.
+**Blazingly fast loading for glTF, GLB or VRM files** + smart density based LOD selection for meshes or texture for any three.js based project.  
+
+## Installation
+`npm i @needle-tools/gltf-progressive`
+
+```ts
+import { useNeedleProgressive } from "@needle-tools/gltf-progressive";
+
+// Before loading with GLTFLoader   
+// call 'useNeedleProgressive' once to register the loader plugin
+useNeedleProgressive(gltf_loader, webgl_renderer)
+```
 
 ## Features
 - [**Single line integration**](#usage) for any three.js project
@@ -49,7 +60,7 @@ const gltfLoader = new GLTFLoader();
 const url = "https://cloud.needle.tools/-/assets/Z23hmXBZN45qJ-ZN45qJ-world/file";
 
 // register the progressive loader plugin
-useNeedleProgressive(url, renderer, gltfLoader)
+useNeedleProgressive(gltfLoader, renderer)
 
 // just call the load method as usual
 gltfLoader.load(url, gltf => {
@@ -83,7 +94,7 @@ function MyModel() {
   const { gl } = useThree()
   const url = 'https://cloud.needle.tools/-/assets/Z23hmXBZN45qJ-ZN45qJ-world/file'
   const { scene } = useGLTF(url, false, false, (loader) => {
-    useNeedleProgressive(url, gl, loader as any)
+    useNeedleProgressive(loader as any, gl as any)
   })
   return <primitive object={scene} />
 }

package/examples/react-three-fiber/src/App.tsx

@@ -11,7 +11,7 @@ function MyModel() {
   const { gl } = useThree()
   const url = 'https://engine.needle.tools/demos/gltf-progressive/assets/church/model.glb'
   const { scene } = useGLTF(url, false, false, (loader) => {
-    useNeedleProgressive(url, gl, loader as any)
+    useNeedleProgressive(loader as any, gl as any);
   })
   return <primitive object={scene} />
 }

package/examples/threejs/main.js

@@ -89,7 +89,7 @@ function loadScene() {
     // Create a new GLTFLoader instance
     const gltfLoader = new GLTFLoader();
     /** Call this method to register the progressive loader */
-    useNeedleProgressive(url, renderer, gltfLoader)
+    useNeedleProgressive(gltfLoader, renderer)
 
     // just call the load method as usual
     gltfLoader.load(url, gltf => {