three-stdlib 2.23.4 → 2.23.6

package/README.md

@@ -10,7 +10,9 @@ Stand-alone version of [threejs/examples/jsm](https://github.com/mrdoob/three.js
 
 ## Basic usage
 
-    npm install three-stdlib
+```bash
+npm install three-stdlib
+```
 
 ```ts
 // Export collection
@@ -21,24 +23,33 @@ import { OrbitControls, ... } from 'three-stdlib'
 
 ## Problem
 
-`threejs/examples` are usually regarded as something that you copy/paste into your project and adapt to your needs. That's not how people use it, and this has caused numerous issues in the past.
+`three/examples` are usually regarded as something that you copy/paste into your project and adapt to your needs. That's not how people use it, and this has caused numerous issues in the past.
 
 ## Solution
 
-- A build system for esm and cjs
-- Version managed dependencies
+- A build system for ESM and CJS, compatible with browser, workers, and Node
 - Class based, optimized for tree-shaking, no globals, exports instead of collections
-- Single flatbundle as well as individual transpiles
 - Typesafety with simple annotation-like types
-- CI, tests, linting, formatting (prettier)
+- SemVer and NPM managed dependencies
 
 But most importantly, allowing more people that use and rely on these primitives to hold a little stake, and to share the weight of maintaining it.
 
-## How to contribute
+## How to Contribute
+
+1.  Fork and clone the repo
+2.  Run `yarn install` to install dependencies
+3.  Create a branch for your PR with `git checkout -b pr-type/issue-number-your-branch-name beta
+4.  Let's get cooking! 👨🏻‍🍳🥓
+
+### Commit Guidelines
+
+Be sure your commit messages follow this specification: https://conventionalcommits.org/en/v1.0.0-beta.4
+
+## Publishing
 
-If you want to get involved you could do any of the following:
+We use `semantic-release-action` to deploy the package. Because of this only certain commits will trigger the action of creating a release:
 
-- Help to maintain and sync the existing primitives
-- Create stories for these examples for our dedicated storybook
-- Convert some of the files to Typescript
-- Add new examples for the library you think could be helpful for others
+- `chore` will not release a new version
+- `fix:` will create a `0.0.x` version
+- `feat:` will create a `0.x.0` version
+- `BREAKING CHANGE:` will create a `x.0.0` version

package/loaders/GLTFLoader.cjs

@@ -42,6 +42,9 @@ class GLTFLoader extends THREE.Loader {
     this.register(function(parser) {
       return new GLTFMaterialsIridescenceExtension(parser);
     });
+    this.register(function(parser) {
+      return new GLTFMaterialsAnisotropyExtension(parser);
+    });
     this.register(function(parser) {
       return new GLTFLightsExtension(parser);
     });
@@ -229,6 +232,7 @@ const EXTENSIONS = {
   KHR_MATERIALS_SPECULAR: "KHR_materials_specular",
   KHR_MATERIALS_TRANSMISSION: "KHR_materials_transmission",
   KHR_MATERIALS_IRIDESCENCE: "KHR_materials_iridescence",
+  KHR_MATERIALS_ANISOTROPY: "KHR_materials_anisotropy",
   KHR_MATERIALS_UNLIT: "KHR_materials_unlit",
   KHR_MATERIALS_VOLUME: "KHR_materials_volume",
   KHR_TEXTURE_BASISU: "KHR_texture_basisu",
@@ -610,6 +614,38 @@ class GLTFMaterialsSpecularExtension {
     return Promise.all(pending);
   }
 }
+class GLTFMaterialsAnisotropyExtension {
+  constructor(parser) {
+    this.parser = parser;
+    this.name = EXTENSIONS.KHR_MATERIALS_ANISOTROPY;
+  }
+  getMaterialType(materialIndex) {
+    const parser = this.parser;
+    const materialDef = parser.json.materials[materialIndex];
+    if (!materialDef.extensions || !materialDef.extensions[this.name])
+      return null;
+    return THREE.MeshPhysicalMaterial;
+  }
+  extendMaterialParams(materialIndex, materialParams) {
+    const parser = this.parser;
+    const materialDef = parser.json.materials[materialIndex];
+    if (!materialDef.extensions || !materialDef.extensions[this.name]) {
+      return Promise.resolve();
+    }
+    const pending = [];
+    const extension = materialDef.extensions[this.name];
+    if (extension.anisotropyStrength !== void 0) {
+      materialParams.anisotropy = extension.anisotropyStrength;
+    }
+    if (extension.anisotropyRotation !== void 0) {
+      materialParams.anisotropyRotation = extension.anisotropyRotation;
+    }
+    if (extension.anisotropyTexture !== void 0) {
+      pending.push(parser.assignTexture(materialParams, "anisotropyMap", extension.anisotropyTexture));
+    }
+    return Promise.all(pending);
+  }
+}
 class GLTFTextureBasisUExtension {
   constructor(parser) {
     this.parser = parser;
@@ -1205,13 +1241,18 @@ function updateMorphTargets(mesh, meshDef) {
   }
 }
 function createPrimitiveKey(primitiveDef) {
-  const dracoExtension = primitiveDef.extensions && primitiveDef.extensions[EXTENSIONS.KHR_DRACO_MESH_COMPRESSION];
   let geometryKey;
+  const dracoExtension = primitiveDef.extensions && primitiveDef.extensions[EXTENSIONS.KHR_DRACO_MESH_COMPRESSION];
   if (dracoExtension) {
     geometryKey = "draco:" + dracoExtension.bufferView + ":" + dracoExtension.indices + ":" + createAttributesKey(dracoExtension.attributes);
   } else {
     geometryKey = primitiveDef.indices + ":" + createAttributesKey(primitiveDef.attributes) + ":" + primitiveDef.mode;
   }
+  if (primitiveDef.targets !== void 0) {
+    for (let i = 0, il = primitiveDef.targets.length; i < il; i++) {
+      geometryKey += ":" + createAttributesKey(primitiveDef.targets[i]);
+    }
+  }
   return geometryKey;
 }
 function createAttributesKey(attributes) {
@@ -1915,12 +1956,12 @@ class GLTFParser {
   /** When Object3D instances are targeted by animation, they need unique names. */
   createUniqueName(originalName) {
     const sanitizedName = THREE.PropertyBinding.sanitizeNodeName(originalName || "");
-    let name = sanitizedName;
-    for (let i = 1; this.nodeNamesUsed[name]; ++i) {
-      name = sanitizedName + "_" + i;
+    if (sanitizedName in this.nodeNamesUsed) {
+      return sanitizedName + "_" + ++this.nodeNamesUsed[sanitizedName];
+    } else {
+      this.nodeNamesUsed[sanitizedName] = 0;
+      return sanitizedName;
     }
-    this.nodeNamesUsed[name] = true;
-    return name;
   }
   /**
    * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#geometry
@@ -2023,9 +2064,13 @@ class GLTFParser {
         });
       }
       if (meshes.length === 1) {
+        if (meshDef.extensions)
+          addUnknownExtensionsToUserData(extensions, meshes[0], meshDef);
         return meshes[0];
       }
       const group = new THREE.Group();
+      if (meshDef.extensions)
+        addUnknownExtensionsToUserData(extensions, group, meshDef);
       parser.associations.set(group, { meshes: meshIndex });
       for (let i = 0, il = meshes.length; i < il; i++) {
         group.add(meshes[i]);

package/loaders/GLTFLoader.js

@@ -40,6 +40,9 @@ class GLTFLoader extends Loader {
     this.register(function(parser) {
       return new GLTFMaterialsIridescenceExtension(parser);
     });
+    this.register(function(parser) {
+      return new GLTFMaterialsAnisotropyExtension(parser);
+    });
     this.register(function(parser) {
       return new GLTFLightsExtension(parser);
     });
@@ -227,6 +230,7 @@ const EXTENSIONS = {
   KHR_MATERIALS_SPECULAR: "KHR_materials_specular",
   KHR_MATERIALS_TRANSMISSION: "KHR_materials_transmission",
   KHR_MATERIALS_IRIDESCENCE: "KHR_materials_iridescence",
+  KHR_MATERIALS_ANISOTROPY: "KHR_materials_anisotropy",
   KHR_MATERIALS_UNLIT: "KHR_materials_unlit",
   KHR_MATERIALS_VOLUME: "KHR_materials_volume",
   KHR_TEXTURE_BASISU: "KHR_texture_basisu",
@@ -608,6 +612,38 @@ class GLTFMaterialsSpecularExtension {
     return Promise.all(pending);
   }
 }
+class GLTFMaterialsAnisotropyExtension {
+  constructor(parser) {
+    this.parser = parser;
+    this.name = EXTENSIONS.KHR_MATERIALS_ANISOTROPY;
+  }
+  getMaterialType(materialIndex) {
+    const parser = this.parser;
+    const materialDef = parser.json.materials[materialIndex];
+    if (!materialDef.extensions || !materialDef.extensions[this.name])
+      return null;
+    return MeshPhysicalMaterial;
+  }
+  extendMaterialParams(materialIndex, materialParams) {
+    const parser = this.parser;
+    const materialDef = parser.json.materials[materialIndex];
+    if (!materialDef.extensions || !materialDef.extensions[this.name]) {
+      return Promise.resolve();
+    }
+    const pending = [];
+    const extension = materialDef.extensions[this.name];
+    if (extension.anisotropyStrength !== void 0) {
+      materialParams.anisotropy = extension.anisotropyStrength;
+    }
+    if (extension.anisotropyRotation !== void 0) {
+      materialParams.anisotropyRotation = extension.anisotropyRotation;
+    }
+    if (extension.anisotropyTexture !== void 0) {
+      pending.push(parser.assignTexture(materialParams, "anisotropyMap", extension.anisotropyTexture));
+    }
+    return Promise.all(pending);
+  }
+}
 class GLTFTextureBasisUExtension {
   constructor(parser) {
     this.parser = parser;
@@ -1203,13 +1239,18 @@ function updateMorphTargets(mesh, meshDef) {
   }
 }
 function createPrimitiveKey(primitiveDef) {
-  const dracoExtension = primitiveDef.extensions && primitiveDef.extensions[EXTENSIONS.KHR_DRACO_MESH_COMPRESSION];
   let geometryKey;
+  const dracoExtension = primitiveDef.extensions && primitiveDef.extensions[EXTENSIONS.KHR_DRACO_MESH_COMPRESSION];
   if (dracoExtension) {
     geometryKey = "draco:" + dracoExtension.bufferView + ":" + dracoExtension.indices + ":" + createAttributesKey(dracoExtension.attributes);
   } else {
     geometryKey = primitiveDef.indices + ":" + createAttributesKey(primitiveDef.attributes) + ":" + primitiveDef.mode;
   }
+  if (primitiveDef.targets !== void 0) {
+    for (let i = 0, il = primitiveDef.targets.length; i < il; i++) {
+      geometryKey += ":" + createAttributesKey(primitiveDef.targets[i]);
+    }
+  }
   return geometryKey;
 }
 function createAttributesKey(attributes) {
@@ -1913,12 +1954,12 @@ class GLTFParser {
   /** When Object3D instances are targeted by animation, they need unique names. */
   createUniqueName(originalName) {
     const sanitizedName = PropertyBinding.sanitizeNodeName(originalName || "");
-    let name = sanitizedName;
-    for (let i = 1; this.nodeNamesUsed[name]; ++i) {
-      name = sanitizedName + "_" + i;
+    if (sanitizedName in this.nodeNamesUsed) {
+      return sanitizedName + "_" + ++this.nodeNamesUsed[sanitizedName];
+    } else {
+      this.nodeNamesUsed[sanitizedName] = 0;
+      return sanitizedName;
     }
-    this.nodeNamesUsed[name] = true;
-    return name;
   }
   /**
    * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#geometry
@@ -2021,9 +2062,13 @@ class GLTFParser {
         });
       }
       if (meshes.length === 1) {
+        if (meshDef.extensions)
+          addUnknownExtensionsToUserData(extensions, meshes[0], meshDef);
         return meshes[0];
       }
       const group = new Group();
+      if (meshDef.extensions)
+        addUnknownExtensionsToUserData(extensions, group, meshDef);
       parser.associations.set(group, { meshes: meshIndex });
       for (let i = 0, il = meshes.length; i < il; i++) {
         group.add(meshes[i]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "three-stdlib",
-  "version": "2.23.4",
+  "version": "2.23.6",
   "description": "stand-alone library of threejs examples",
   "keywords": [
     "three",