@needle-tools/three-animation-pointer 1.0.1-next.98f6675 → 1.0.2-next.a516fc5

package/README.md

@@ -1,6 +1,6 @@
 # KHR_animation_pointer for three.js
 
-This package adds a [three.js](https://github.com/mrdoob/three.js) GLTFLoader plugin for [KHR_animation_pointer](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_animation_pointer) support.
+This package adds a [three.js](https://github.com/mrdoob/three.js) GLTFLoader plugin for [KHR_animation_pointer](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_animation_pointer) support allowing you to animate anything in your 3D scene, from material, light or camera properties to custom code.
 
 ### Animate anything
 - all material properties 💎 (including texture transforms) 
@@ -37,13 +37,15 @@ loader.register(p => {
 });
 ```
 
-### How to create glTF files using KHR_animation_pointer 
+*Note: To animate custom code you might need to register your own path resolver in the GLTFAnimationPointerExtension plugin* 
+
+### How to create glTF files with KHR_animation_pointer animations
 
 You can use one of the listed tools below to export glTF animations in the right format
 
 - [Blender 4.3](https://www.blender.org/) and newer - *experimental KHR_animation_pointer support, currently only in 'scene animation' mode ([#2285](https://github.com/KhronosGroup/glTF-Blender-IO/issues/2285))*
-- [Needle Engine for Unity](https://engine.needle.tools/docs/unity/) - defaults to KHR_animation_pointer and battle tested since 2022
-- [UnityGLTF](https://github.com/KhronosGroup/UnityGLTF)
+- [Needle Engine for Unity](https://engine.needle.tools/docs/unity/) - using KHR_animation_pointer by default in all projects since 2022
+- [UnityGLTF](https://github.com/KhronosGroup/UnityGLTF) - enable KHR_animation_pointer in settings to use in Exports
 
 
 **Mini Unity Tutorial**
@@ -58,6 +60,7 @@ You can use one of the listed tools below to export glTF animations in the right
 
 - [Khronos KHR_animation_pointer spec](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_animation_pointer)
 - [three.js repository PR #24108](https://github.com/mrdoob/three.js/pull/24108)
+- [three.js example](https://threejs.org/examples/?q=gltf#webgl_loader_gltf_animation_pointer) - created in Unity
 
 
 

package/dist/three-animation-pointer.js

@@ -13,40 +13,40 @@ const f = {
 };
 class j {
   /** @type {import("three/examples/jsm/loaders/GLTFLoader").GLTFParser} */
-  constructor(r) {
-    this.name = R, this.parser = r, this.animationPointerResolver = null;
+  constructor(a) {
+    this.name = R, this.parser = a, this.animationPointerResolver = null;
   }
   /** 
    * @param {import("..").AnimationPointerResolver | null} animationPointerResolver
    */
-  setAnimationPointerResolver(r) {
-    return this.animationPointerResolver = r, this;
+  setAnimationPointerResolver(a) {
+    return this.animationPointerResolver = a, this;
   }
   /* DUPLICATE of functionality in GLTFLoader */
-  loadAnimationTargetFromChannel(r) {
-    const s = r.target, a = s.node !== void 0 ? s.node : s.id;
-    return this.parser.getDependency("node", a);
+  loadAnimationTargetFromChannel(a) {
+    const t = a.target, r = t.node !== void 0 ? t.node : t.id;
+    return this.parser.getDependency("node", r);
   }
-  loadAnimationTargetFromChannelWithAnimationPointer(r) {
+  loadAnimationTargetFromChannelWithAnimationPointer(a) {
     var c;
     B();
-    const s = r.target, a = s.extensions && s.extensions[R] && s.path && s.path === "pointer";
-    if (!a) return null;
-    let e, t = f.node, n;
-    if (a) {
-      const m = s.extensions[R];
+    const t = a.target, r = t.extensions && t.extensions[R] && t.path && t.path === "pointer";
+    if (!r) return null;
+    let e, n = f.node, s;
+    if (r) {
+      const m = t.extensions[R];
       let o = m.pointer;
       if (!o) {
-        console.warn("Invalid path", m, s);
+        console.warn("Invalid path", m, t);
         return;
       }
-      if (o.startsWith("/materials/") ? t = f.material : o.startsWith("/extensions/KHR_lights_punctual/lights/") ? t = f.light : o.startsWith("/cameras/") && (t = f.camera), n = this._tryResolveTargetId(o, t), n === null || isNaN(n)) {
-        console.warn("Failed resolving animation node id: " + n, o);
+      if (o.startsWith("/materials/") ? n = f.material : o.startsWith("/extensions/KHR_lights_punctual/lights/") ? n = f.light : o.startsWith("/cameras/") && (n = f.camera), s = this._tryResolveTargetId(o, n), s === null || isNaN(s)) {
+        console.warn("Failed resolving animation node id: " + s, o);
         return;
       }
-      switch (t) {
+      switch (n) {
         case f.material:
-          const x = ("/materials/" + n.toString() + "/").length, h = o.substring(0, x);
+          const x = ("/materials/" + s.toString() + "/").length, h = o.substring(0, x);
           switch (e = o.substring(x), e) {
             case "pbrMetallicRoughness/baseColorFactor":
               e = "color";
@@ -133,7 +133,7 @@ class j {
           o = h + e;
           break;
         case f.node:
-          const u = ("/nodes/" + n.toString() + "/").length, l = o.substring(0, u);
+          const u = ("/nodes/" + s.toString() + "/").length, l = o.substring(0, u);
           switch (e = o.substring(u), e) {
             case "translation":
               e = "position";
@@ -151,7 +151,7 @@ class j {
           o = l + e;
           break;
         case f.light:
-          const p = ("/extensions/KHR_lights_punctual/lights/" + n.toString() + "/").length;
+          const p = ("/extensions/KHR_lights_punctual/lights/" + s.toString() + "/").length;
           switch (e = o.substring(p), e) {
             case "color":
               break;
@@ -167,10 +167,10 @@ class j {
               e = "distance";
               break;
           }
-          o = "/lights/" + n.toString() + "/" + e;
+          o = "/lights/" + s.toString() + "/" + e;
           break;
         case f.camera:
-          const g = ("/cameras/" + n.toString() + "/").length, b = o.substring(0, g);
+          const g = ("/cameras/" + s.toString() + "/").length, b = o.substring(0, g);
           switch (e = o.substring(g), e) {
             case "perspective/yfov":
               e = "fov";
@@ -196,25 +196,25 @@ class j {
           o = b + e;
           break;
       }
-      (c = this.animationPointerResolver) != null && c.resolvePath && (o = this.animationPointerResolver.resolvePath(o)), s.extensions[R].pointer = o;
+      (c = this.animationPointerResolver) != null && c.resolvePath && (o = this.animationPointerResolver.resolvePath(o)), t.extensions[R].pointer = o;
     }
-    if (n == null || isNaN(n)) {
-      console.warn("Failed resolving animation node id: " + n, s);
+    if (s == null || isNaN(s)) {
+      console.warn("Failed resolving animation node id: " + s, t);
       return;
     }
     let i;
-    return t === f.node ? i = this.parser.getDependency("node", n) : t === f.material ? i = this.parser.getDependency("material", n) : t === f.light ? i = this.parser.getDependency("light", n) : t === f.camera ? i = this.parser.getDependency("camera", n) : console.error("Unhandled type", t), i;
+    return n === f.node ? i = this.parser.getDependency("node", s) : n === f.material ? i = this.parser.getDependency("material", s) : n === f.light ? i = this.parser.getDependency("light", s) : n === f.camera ? i = this.parser.getDependency("camera", s) : console.error("Unhandled type", n), i;
   }
-  createAnimationTracksWithAnimationPointer(r, s, a, e, t) {
-    if (!(t.extensions && t.extensions[R] && t.path && t.path === "pointer")) return null;
-    let i = t.extensions[R].pointer;
+  createAnimationTracksWithAnimationPointer(a, t, r, e, n) {
+    if (!(n.extensions && n.extensions[R] && n.path && n.path === "pointer")) return null;
+    let i = n.extensions[R].pointer;
     if (!i) return null;
     const c = [];
     i = i.replaceAll("/", ".");
     const m = i.split(".");
-    var x = r.name !== void 0 && r.name !== null ? r.name : r.uuid;
-    if (m[2] = x, m[3] === "morphTargetInfluences" && r.type === "Group") {
-      for (const u of r.children)
+    var x = a.name !== void 0 && a.name !== null ? a.name : a.uuid;
+    if (m[2] = x, m[3] === "morphTargetInfluences" && a.type === "Group") {
+      for (const u of a.children)
         u instanceof S && u.morphTargetInfluences && (m[3] = u.name, m[4] = "morphTargetInfluences", h(this.parser));
       return c;
     }
@@ -222,7 +222,7 @@ class j {
     function h(u) {
       i = m.join(".");
       let l;
-      switch (a.itemSize) {
+      switch (r.itemSize) {
         case 1:
           l = O;
           break;
@@ -235,25 +235,25 @@ class j {
           break;
       }
       if (!l) {
-        console.warn("Unsupported output accessor format", a);
+        console.warn("Unsupported output accessor format", r);
         return;
       }
       const p = e.interpolation !== void 0 ? U[e.interpolation] : F;
-      let g = u._getArrayFromAccessor(a);
+      let g = u._getArrayFromAccessor(r);
       i.endsWith(".fov") && (g = g.map((k) => k / Math.PI * 180));
       const b = new l(
         i,
-        s.array,
+        t.array,
         g,
         p
       );
-      if (p === "CUBICSPLINE" && u._createCubicSplineTrackInterpolant(b), c.push(b), i && a.itemSize === 4 && i.startsWith(".materials.") && i.endsWith(".color")) {
+      if (p === "CUBICSPLINE" && u._createCubicSplineTrackInterpolant(b), c.push(b), i && r.itemSize === 4 && i.startsWith(".materials.") && i.endsWith(".color")) {
         const k = new Float32Array(g.length / 4);
         for (let T = 0, _ = g.length / 4; T < _; T += 1)
           k[T] = g[T * 4 + 3];
         const d = new l(
           i.replace(".color", ".opacity"),
-          s.array,
+          t.array,
           k,
           p
         );
@@ -262,9 +262,9 @@ class j {
     }
     return c;
   }
-  _tryResolveTargetId(r, s) {
-    let a = "";
-    return s === "node" ? a = r.substring(7) : s === "material" ? a = r.substring(11) : s === "light" ? a = r.substring(39) : s === "camera" && (a = r.substring(9)), a = a.substring(0, a.indexOf("/")), Number.parseInt(a);
+  _tryResolveTargetId(a, t) {
+    let r = "";
+    return t === "node" ? r = a.substring(7) : t === "material" ? r = a.substring(11) : t === "light" ? r = a.substring(39) : t === "camera" && (r = a.substring(9)), r = r.substring(0, r.indexOf("/")), Number.parseInt(r);
   }
   /* MOSTLY DUPLICATE of GLTFLoader.loadAnimation, but also tries to resolve KHR_animation_pointer. */
   /**
@@ -272,12 +272,12 @@ class j {
    * @param {number} animationIndex
    * @return {Promise<AnimationClip>}
    */
-  loadAnimation(r) {
-    const s = this, a = this.parser.json, e = this.parser, t = a.animations[r], n = t.name ? t.name : "animation_" + r, i = [], c = [], m = [], o = [], x = [];
-    for (let h = 0, u = t.channels.length; h < u; h++) {
-      const l = t.channels[h], p = t.samplers[l.sampler], g = l.target, b = t.parameters !== void 0 ? t.parameters[p.input] : p.input, k = t.parameters !== void 0 ? t.parameters[p.output] : p.output;
-      let d = s.loadAnimationTargetFromChannelWithAnimationPointer(l);
-      d || (d = s.loadAnimationTargetFromChannel(l)), i.push(d), c.push(e.getDependency("accessor", b)), m.push(e.getDependency("accessor", k)), o.push(p), x.push(g);
+  loadAnimation(a) {
+    const t = this, r = this.parser.json, e = this.parser, n = r.animations[a], s = n.name ? n.name : "animation_" + a, i = [], c = [], m = [], o = [], x = [];
+    for (let h = 0, u = n.channels.length; h < u; h++) {
+      const l = n.channels[h], p = n.samplers[l.sampler], g = l.target, b = n.parameters !== void 0 ? n.parameters[p.input] : p.input, k = n.parameters !== void 0 ? n.parameters[p.output] : p.output;
+      let d = t.loadAnimationTargetFromChannelWithAnimationPointer(l);
+      d || (d = t.loadAnimationTargetFromChannel(l)), i.push(d), c.push(e.getDependency("accessor", b)), m.push(e.getDependency("accessor", k)), o.push(p), x.push(g);
     }
     return Promise.all([
       Promise.all(i),
@@ -291,12 +291,12 @@ class j {
         const _ = u[d], v = l[d], A = p[d], N = g[d], K = b[d];
         if (_ === void 0) continue;
         _.updateMatrix && (_.updateMatrix(), _.matrixAutoUpdate = !0);
-        let y = s.createAnimationTracksWithAnimationPointer(_, v, A, N, K);
+        let y = t.createAnimationTracksWithAnimationPointer(_, v, A, N, K);
         if (y || (y = e._createAnimationTracks(_, v, A, N, K)), y)
           for (let P = 0; P < y.length; P++)
             k.push(y[P]);
       }
-      return new W(n, void 0, k);
+      return new W(s, void 0, k);
     });
   }
 }
@@ -305,36 +305,37 @@ function B() {
   if (H) return;
   H = !0;
   const I = z || (z = C.findNode);
-  C.findNode = function(r, s) {
-    if (s.startsWith(".materials.")) {
-      const a = s.substring(11).substring(s.indexOf(".")), e = a.indexOf("."), t = e < 0 ? a : a.substring(0, e);
-      let n = null;
-      return r.traverse((i) => {
-        n !== null || i.type !== "Mesh" && i.type !== "SkinnedMesh" || i.material && (i.material.uuid === t || i.material.name === t) && (n = i.material, n !== null && (a.endsWith(".map") ? n = n.map : a.endsWith(".emissiveMap") && (n = n.emissiveMap)));
-      }), n;
-    } else if (s.startsWith(".nodes.") || s.startsWith(".lights.") || s.startsWith(".cameras.")) {
-      const a = s.split(".");
+  C.findNode = function(a, t) {
+    if (!t) return I(a, t);
+    if (t.startsWith(".materials.")) {
+      const r = t.substring(11).substring(t.indexOf(".")), e = r.indexOf("."), n = e < 0 ? r : r.substring(0, e);
+      let s = null;
+      return a.traverse((i) => {
+        s !== null || i.type !== "Mesh" && i.type !== "SkinnedMesh" || i.material && (i.material.uuid === n || i.material.name === n) && (s = i.material, s !== null && (r.endsWith(".map") ? s = s.map : r.endsWith(".emissiveMap") && (s = s.emissiveMap)));
+      }), s;
+    } else if (t.startsWith(".nodes.") || t.startsWith(".lights.") || t.startsWith(".cameras.")) {
+      const r = t.split(".");
       let e;
-      for (let t = 1; t < a.length; t++) {
-        const n = a[t];
-        if (n.length == 36)
-          e = r.getObjectByProperty("uuid", n);
-        else if (e && e[n]) {
-          const c = Number.parseInt(n);
-          let m = n;
+      for (let n = 1; n < r.length; n++) {
+        const s = r[n];
+        if (s.length == 36)
+          e = a.getObjectByProperty("uuid", s);
+        else if (e && e[s]) {
+          const c = Number.parseInt(s);
+          let m = s;
           c >= 0 && (m = c), e = e[m];
         } else {
-          const c = r.getObjectByName(n);
+          const c = a.getObjectByName(s);
           c && (e = c);
         }
       }
       if (!e) {
-        const t = I(r, a[2]);
-        return t || console.warn(R + ": Property binding not found", s, r, r.name, a), t;
+        const n = I(a, r[2]);
+        return n || console.warn(R + ": Property binding not found", t, a, a.name, r), n;
       }
       return e;
     }
-    return I(r, s);
+    return I(a, t);
   };
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/three-animation-pointer",
-  "version": "1.0.1-next.98f6675",
+  "version": "1.0.2-next.a516fc5",
   "description": "KHR_animation_pointer support for three.js",
   "type": "module",
   "main": "dist/three-animation-pointer.js",

package/src/GLTFLoaderAnimationPointer.js

@@ -657,6 +657,10 @@ function _ensurePropertyBindingPatch() {
 	// "path" is the animated property path, just with translated material names.
 	PropertyBinding.findNode = function (node, path) {
 
+		// if the binding is empty fallback to original
+		if (!path) return findNode(node, path);
+
+
 		if (path.startsWith('.materials.')) {
 
 			if (_animationPointerDebug) console.log('FIND', path);