@gamewall/threejs 1.1.0 → 1.2.0

package/README.md

@@ -66,7 +66,7 @@ This function is asynchronous because KTX2 textures may require transcoding, whi
 > - `--t2` ensures the texture is in KTX2 format
 > - `--bcmp` applies Basis Universal supercompression
 
-### `async loadGltf(name: string, renderer: THREE.WebGLRenderer): Promise<[THREE.Object3D, { [name: string]: THREE.MeshPhysicalMaterial }]>`
+### `async loadGltf(name: string, renderer: THREE.WebGLRenderer): Promise<[THREE.Object3D, { [name: string]: THREE.MeshPhysicalMaterial }, GLTF]>`
 
 Loads a GLTF/GLB model from the GameWall assets, with support for KTX2 and Meshopt.
 
@@ -89,7 +89,13 @@ async function loadModel() {
 }
 ```
 
-This function returns a touple containing the loaded model (as a THREE.Object3D) and a dictionary of materials by their names. This allows you to easily modify specific materials after loading.
+This function returns a touple containing
+
+- the loaded model (as a THREE.Object3D),
+- a dictionary of materials by their names, and
+- the full GLTF object.
+
+This allows you to easily access the 3D object and modify specific materials after loading and access other GLTF data. For advanced use cases, like modifying animations or accessing specific nodes, you can use the GLTF object directly.
 
 > ⚠️ Warning: The returned materials dictionary only includes PBR materials (MeshPhysicalMaterial). Please make sure your 3D modeling tool exports materials in this format for compatibility. If you use Blender, the default "Principled BSDF" shader corresponds to MeshPhysicalMaterial in ThreeJS.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gamewall/threejs",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "ThreeJS utils for GameWall",
   "main": "src/index.ts",
   "scripts": {

package/src/gltf.ts

@@ -1,5 +1,5 @@
 import * as THREE from 'three'
-import { GLTFLoader } from 'three/addons/loaders/GLTFLoader.js'
+import { GLTFLoader, GLTF } from 'three/addons/loaders/GLTFLoader.js'
 import { getBuffer } from 'gamewall'
 import { extractBuffer } from './utils'
 
@@ -19,7 +19,7 @@ export function getGltfLoader(renderer: THREE.WebGLRenderer): GLTFLoader {
   return loader;
 }
 
-export async function loadGltf(url: string, renderer: THREE.WebGLRenderer): Promise<[THREE.Object3D, { [name: string]: THREE.MeshPhysicalMaterial }]> {
+export async function loadGltf(url: string, renderer: THREE.WebGLRenderer): Promise<[THREE.Object3D, { [name: string]: THREE.MeshPhysicalMaterial }, GLTF]> {
   const glbBuffer = extractBuffer(getBuffer(url));
   const gltfLoader = getGltfLoader(renderer);
 
@@ -52,5 +52,5 @@ export async function loadGltf(url: string, renderer: THREE.WebGLRenderer): Prom
     }
   });
 
-  return [result, Object.fromEntries(materials)];
+  return [result, Object.fromEntries(materials), gltf];
 }