@needle-tools/three-animation-pointer 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -4,6 +4,12 @@ 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).
 
+## [1.0.5] - 2025-10-15
+- Add: support for boolean animation tracks (when using ubyte type)
+
+## [1.0.4] - 2025-10-08
+- Add: KHR_node_visibility extension
+
 ## [1.0.3] - 2025-09-11
 - Fix: Handle undefined path if AnimationClip tracks have invalid/unexpected names. Fallback to default three implementation
 

package/dist/three-animation-pointer.js

@@ -1,5 +1,5 @@
-import { SkinnedMesh as S, InterpolateDiscrete as M, InterpolateLinear as F, AnimationClip as W, PropertyBinding as C, QuaternionKeyframeTrack as w, ColorKeyframeTrack as D, VectorKeyframeTrack as E, NumberKeyframeTrack as O } from "three";
-const f = {
+import { SkinnedMesh as S, InterpolateDiscrete as M, InterpolateLinear as F, AnimationClip as W, PropertyBinding as C, QuaternionKeyframeTrack as w, ColorKeyframeTrack as D, VectorKeyframeTrack as B, BooleanKeyframeTrack as E, NumberKeyframeTrack as O } from "three";
+const d = {
   node: "node",
   material: "material",
   camera: "camera",
@@ -11,7 +11,7 @@ const f = {
   LINEAR: F,
   STEP: M
 };
-class j {
+class G {
   /** @type {import("three/examples/jsm/loaders/GLTFLoader").GLTFParser} */
   constructor(a) {
     this.name = R, this.parser = a, this.animationPointerResolver = null;
@@ -28,26 +28,26 @@ class j {
     return this.parser.getDependency("node", r);
   }
   loadAnimationTargetFromChannelWithAnimationPointer(a) {
-    var c;
-    B();
+    var u;
+    L();
     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;
+    let e, n = d.node, s;
     if (r) {
-      const m = t.extensions[R];
-      let o = m.pointer;
+      const h = t.extensions[R];
+      let o = h.pointer;
       if (!o) {
-        console.warn("Invalid path", m, t);
+        console.warn("Invalid path", h, t);
         return;
       }
-      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)) {
+      if (o.startsWith("/materials/") ? n = d.material : o.startsWith("/extensions/KHR_lights_punctual/lights/") ? n = d.light : o.startsWith("/cameras/") && (n = d.camera), s = this._tryResolveTargetId(o, n), s === null || isNaN(s)) {
         console.warn("Failed resolving animation node id: " + s, o);
         return;
       }
       switch (n) {
-        case f.material:
-          const x = ("/materials/" + s.toString() + "/").length, h = o.substring(0, x);
-          switch (e = o.substring(x), e) {
+        case d.material:
+          const T = ("/materials/" + s.toString() + "/").length, g = o.substring(0, T);
+          switch (e = o.substring(T), e) {
             case "pbrMetallicRoughness/baseColorFactor":
               e = "color";
               break;
@@ -130,11 +130,11 @@ class j {
               e = "specularColor";
               break;
           }
-          o = h + e;
+          o = g + e;
           break;
-        case f.node:
-          const u = ("/nodes/" + s.toString() + "/").length, l = o.substring(0, u);
-          switch (e = o.substring(u), e) {
+        case d.node:
+          const k = ("/nodes/" + s.toString() + "/").length, l = o.substring(0, k);
+          switch (e = o.substring(k), e) {
             case "translation":
               e = "position";
               break;
@@ -147,12 +147,15 @@ class j {
             case "weights":
               e = "morphTargetInfluences";
               break;
+            case "KHR_node_visibility/visible":
+              e = "visible";
+              break;
           }
           o = l + e;
           break;
-        case f.light:
-          const p = ("/extensions/KHR_lights_punctual/lights/" + s.toString() + "/").length;
-          switch (e = o.substring(p), e) {
+        case d.light:
+          const c = ("/extensions/KHR_lights_punctual/lights/" + s.toString() + "/").length;
+          switch (e = o.substring(c), e) {
             case "color":
               break;
             case "intensity":
@@ -169,9 +172,9 @@ class j {
           }
           o = "/lights/" + s.toString() + "/" + e;
           break;
-        case f.camera:
-          const g = ("/cameras/" + s.toString() + "/").length, b = o.substring(0, g);
-          switch (e = o.substring(g), e) {
+        case d.camera:
+          const f = ("/cameras/" + s.toString() + "/").length, b = o.substring(0, f);
+          switch (e = o.substring(f), e) {
             case "perspective/yfov":
               e = "fov";
               break;
@@ -196,71 +199,81 @@ class j {
           o = b + e;
           break;
       }
-      (c = this.animationPointerResolver) != null && c.resolvePath && (o = this.animationPointerResolver.resolvePath(o)), t.extensions[R].pointer = o;
+      (u = this.animationPointerResolver) != null && u.resolvePath && (o = this.animationPointerResolver.resolvePath(o)), t.extensions[R].pointer = o;
     }
     if (s == null || isNaN(s)) {
       console.warn("Failed resolving animation node id: " + s, t);
       return;
     }
     let 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;
+    return n === d.node ? i = this.parser.getDependency("node", s) : n === d.material ? i = this.parser.getDependency("material", s) : n === d.light ? i = this.parser.getDependency("light", s) : n === d.camera ? i = this.parser.getDependency("camera", s) : console.error("Unhandled type", n), i;
   }
   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 = [];
+    const u = [];
     i = i.replaceAll("/", ".");
-    const m = i.split(".");
-    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;
+    const h = i.split(".");
+    var T = a.name !== void 0 && a.name !== null ? a.name : a.uuid;
+    if (h[2] = T, h[3] === "morphTargetInfluences" && a.type === "Group") {
+      for (const l of a.children)
+        l instanceof S && l.morphTargetInfluences && (h[3] = l.name, h[4] = "morphTargetInfluences", k(this.parser));
+      return u;
+    }
+    k(this.parser);
+    function g(l, c) {
+      try {
+        const f = c.split(".").filter(Boolean), m = f[f.length - 1].replace(/\[.*\]$/, "");
+        return m in l ? typeof l[m] == "boolean" : !1;
+      } catch {
+        return !1;
+      }
     }
-    h(this.parser);
-    function h(u) {
-      i = m.join(".");
-      let l;
+    function k(l) {
+      i = h.join(".");
+      let c, f = !1;
       switch (r.itemSize) {
         case 1:
-          l = O;
+          const _ = Object.prototype.toString.call(r.array) === "[object Uint8Array]" && // UNSIGNED_BYTE as a strong hint
+          g(a, i);
+          _ ? console.log("Assuming boolean animation for", i, "based on property type and accessor type") : console.log("Not a boolean target", i), _ ? (c = E, f = !0) : c = O;
           break;
         case 2:
         case 3:
-          l = E;
+          c = B;
           break;
         case 4:
-          i.endsWith(".quaternion") ? l = w : l = D;
+          i.endsWith(".quaternion") ? c = w : c = D;
           break;
       }
-      if (!l) {
+      if (!c) {
         console.warn("Unsupported output accessor format", r);
         return;
       }
-      const p = e.interpolation !== void 0 ? U[e.interpolation] : F;
-      let g = u._getArrayFromAccessor(r);
-      i.endsWith(".fov") && (g = g.map((k) => k / Math.PI * 180));
-      const b = new l(
+      const b = e.interpolation !== void 0 ? U[e.interpolation] : F;
+      let m = l._getArrayFromAccessor(r);
+      i.endsWith(".fov") && (m = m.map((x) => x / Math.PI * 180)), f && (m = m.map((x) => x > 0));
+      const p = new c(
         i,
         t.array,
-        g,
-        p
+        m,
+        b
       );
-      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(
+      if (b === "CUBICSPLINE" && l._createCubicSplineTrackInterpolant(p), u.push(p), i && r.itemSize === 4 && i.startsWith(".materials.") && i.endsWith(".color")) {
+        const x = new Float32Array(m.length / 4);
+        for (let _ = 0, P = m.length / 4; _ < P; _ += 1)
+          x[_] = m[_ * 4 + 3];
+        const y = new c(
           i.replace(".color", ".opacity"),
           t.array,
-          k,
-          p
+          x,
+          b
         );
-        p === "CUBICSPLINE" && u._createCubicSplineTrackInterpolant(b), c.push(d);
+        b === "CUBICSPLINE" && l._createCubicSplineTrackInterpolant(p), u.push(y);
       }
     }
-    return c;
+    return u;
   }
   _tryResolveTargetId(a, t) {
     let r = "";
@@ -273,38 +286,38 @@ class j {
    * @return {Promise<AnimationClip>}
    */
   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);
+    const t = this, r = this.parser.json, e = this.parser, n = r.animations[a], s = n.name ? n.name : "animation_" + a, i = [], u = [], h = [], o = [], T = [];
+    for (let g = 0, k = n.channels.length; g < k; g++) {
+      const l = n.channels[g], c = n.samplers[l.sampler], f = l.target, b = n.parameters !== void 0 ? n.parameters[c.input] : c.input, m = n.parameters !== void 0 ? n.parameters[c.output] : c.output;
+      let p = t.loadAnimationTargetFromChannelWithAnimationPointer(l);
+      p || (p = t.loadAnimationTargetFromChannel(l)), i.push(p), u.push(e.getDependency("accessor", b)), h.push(e.getDependency("accessor", m)), o.push(c), T.push(f);
     }
     return Promise.all([
       Promise.all(i),
-      Promise.all(c),
-      Promise.all(m),
+      Promise.all(u),
+      Promise.all(h),
       Promise.all(o),
-      Promise.all(x)
-    ]).then(function(h) {
-      const u = h[0], l = h[1], p = h[2], g = h[3], b = h[4], k = [];
-      for (let d = 0, T = u.length; d < T; d++) {
-        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 = 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]);
+      Promise.all(T)
+    ]).then(function(g) {
+      const k = g[0], l = g[1], c = g[2], f = g[3], b = g[4], m = [];
+      for (let p = 0, x = k.length; p < x; p++) {
+        const y = k[p], _ = l[p], P = c[p], N = f[p], K = b[p];
+        if (y === void 0) continue;
+        y.updateMatrix && (y.updateMatrix(), y.matrixAutoUpdate = !0);
+        let v = t.createAnimationTracksWithAnimationPointer(y, _, P, N, K);
+        if (v || (v = e._createAnimationTracks(y, _, P, N, K)), v)
+          for (let A = 0; A < v.length; A++)
+            m.push(v[A]);
       }
-      return new W(s, void 0, k);
+      return new W(s, void 0, m);
     });
   }
 }
-let H = !1, z = null;
-function B() {
+let H = !1, j = null;
+function L() {
   if (H) return;
   H = !0;
-  const I = z || (z = C.findNode);
+  const I = j || (j = C.findNode);
   C.findNode = function(a, t) {
     if (!t) return I(a, t);
     if (t.startsWith(".materials.")) {
@@ -321,12 +334,12 @@ function B() {
         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];
+          const u = Number.parseInt(s);
+          let h = s;
+          u >= 0 && (h = u), e = e[h];
         } else {
-          const c = a.getObjectByName(s);
-          c && (e = c);
+          const u = a.getObjectByName(s);
+          u && (e = u);
         }
       }
       if (!e) {
@@ -339,6 +352,6 @@ function B() {
   };
 }
 export {
-  j as GLTFAnimationPointerExtension,
-  j as default
+  G as GLTFAnimationPointerExtension,
+  G as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/three-animation-pointer",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "KHR_animation_pointer support for three.js",
   "type": "module",
   "main": "dist/three-animation-pointer.js",

package/src/GLTFLoaderAnimationPointer.js

@@ -7,7 +7,8 @@ import {
 	PropertyBinding,
 	QuaternionKeyframeTrack,
 	VectorKeyframeTrack,
-	SkinnedMesh
+	SkinnedMesh,
+	BooleanKeyframeTrack
 } from 'three';
 
 /** 
@@ -260,7 +261,9 @@ export class GLTFAnimationPointerExtension {
 						case 'weights':
 							targetProperty = 'morphTargetInfluences';
 							break;
-
+						case "KHR_node_visibility/visible":
+							targetProperty = 'visible';
+							break;
 					}
 
 					path = pathStartNode + targetProperty;
@@ -412,6 +415,29 @@ export class GLTFAnimationPointerExtension {
 		// default
 		__createTrack( this.parser );
 
+
+		function isBooleanTarget(node, trackPath)  {
+		// trackPath like ".nodes.MyNode.visible" or ".materials.<uuid>.wireframe"
+		try {
+	
+			// get last token after '.'
+			const sections = trackPath.split('.').filter(Boolean);
+			let last = sections[sections.length - 1]; // e.g., 'visible' or 'iridescenceThicknessRange[0]'
+		
+			// strip indexers like [0]
+			const propName = last.replace(/\[.*\]$/, '');
+		
+			// bail if not a direct property
+			if (!(propName in node)) return false;
+
+			const val = node[propName];
+			return typeof val === 'boolean';
+		} 
+		catch {
+			return false;
+		}
+		}
+
 		/** Create a new track using the current parts array */
 		function __createTrack( parser ) {
 
@@ -421,11 +447,31 @@ export class GLTFAnimationPointerExtension {
 				console.log( node, inputAccessor, outputAccessor, target, animationPointerPropertyPath );
 
 			let TypedKeyframeTrack;
-
+			let convertToBoolean = false;
 			switch ( outputAccessor.itemSize ) {
 
-				case 1:
-					TypedKeyframeTrack = NumberKeyframeTrack;
+				case 1: 
+					// Get type of outputAccessor.array elements
+					const arrayType = Object.prototype.toString.call(outputAccessor.array);
+					const isUInt8 = (arrayType === '[object Uint8Array]');
+
+					const looksLikeBool = isUInt8 && // UNSIGNED_BYTE as a strong hint
+						isBooleanTarget(node, animationPointerPropertyPath);
+
+						// Log once per target property if it looks like a boolean
+						if (looksLikeBool) {
+							console.log('Assuming boolean animation for', animationPointerPropertyPath, 'based on property type and accessor type');
+						}
+						else
+						{
+							console.log('Not a boolean target', animationPointerPropertyPath);
+						}
+					if (looksLikeBool) {
+						TypedKeyframeTrack = BooleanKeyframeTrack;
+						convertToBoolean = true; // map 0 => false, >0 => true
+					} else {
+						TypedKeyframeTrack = NumberKeyframeTrack;
+					}
 					break;
 				case 2:
 				case 3:
@@ -455,7 +501,11 @@ export class GLTFAnimationPointerExtension {
 			if ( animationPointerPropertyPath.endsWith( '.fov' ) ) {
 
 				outputArray = outputArray.map( value => value / Math.PI * 180 );
+			}
 
+			if (convertToBoolean) {
+				// boolean values are stored as ubyte in glTF, 0 = false, anything else = true 
+				outputArray = outputArray.map( v => v > 0 );
 			}
 
 			const track = new TypedKeyframeTrack(