@scenography/plugin-model 0.4.1 → 0.6.0

package/dist/index.cjs

@@ -1,12 +1,15 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_data = require("./data-tK2hlhyq.cjs");
 let three = require("three");
+let _scenography_engine = require("@scenography/engine");
 //#region src/buildModel.ts
 /**
 * Build the three.js object for an external `Model`. Returns an empty `Group`
 * with the transform applied immediately; the glTF/GLB is fetched async and its
 * scene added once ready (same pattern as texture loading). `GLTFLoader` is
-* imported on demand so it only ships in the bundle when a scene uses models.
+* imported on demand so it only ships in the bundle when a scene uses models;
+* the meshopt decoder rides along so `EXT_meshopt_compression` models load, and
+* the shared KTX2 loader handles `KHR_texture_basisu` maps.
 */
 function buildModel(model) {
 	const group = new three.Group();
@@ -16,8 +19,16 @@ function buildModel(model) {
 	if (model.rotation) group.rotation.set(...model.rotation);
 	if (model.scale !== void 0) if (typeof model.scale === "number") group.scale.setScalar(model.scale);
 	else group.scale.set(...model.scale);
-	import("three/examples/jsm/loaders/GLTFLoader.js").then(({ GLTFLoader }) => {
-		new GLTFLoader().load(model.src, (gltf) => {
+	const ktx2 = (0, _scenography_engine.getKtx2Loader)();
+	Promise.all([
+		import("three/examples/jsm/loaders/GLTFLoader.js"),
+		import("three/examples/jsm/libs/meshopt_decoder.module.js"),
+		ktx2 ?? Promise.resolve(null)
+	]).then(([{ GLTFLoader }, { MeshoptDecoder }, ktx2Loader]) => {
+		const loader = new GLTFLoader();
+		loader.setMeshoptDecoder(MeshoptDecoder);
+		if (ktx2Loader) loader.setKTX2Loader(ktx2Loader);
+		loader.load(model.src, (gltf) => {
 			gltf.scene.traverse((child) => {
 				child.castShadow = true;
 				child.receiveShadow = true;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["Group","modelData"],"sources":["../src/buildModel.ts","../src/plugin.ts"],"sourcesContent":["import { Group, type Object3D } from \"three\";\n\nimport type { Model } from \"./data\";\n\n/**\n * Build the three.js object for an external `Model`. Returns an empty `Group`\n * with the transform applied immediately; the glTF/GLB is fetched async and its\n * scene added once ready (same pattern as texture loading). `GLTFLoader` is\n * imported on demand so it only ships in the bundle when a scene uses models.\n */\nexport function buildModel(model: Model): Object3D {\n  const group = new Group();\n  group.name = `model:${model.id}`;\n  group.userData.scenographyId = model.id;\n\n  if (model.position) group.position.set(...model.position);\n  if (model.rotation) group.rotation.set(...model.rotation);\n  if (model.scale !== undefined) {\n    if (typeof model.scale === \"number\") group.scale.setScalar(model.scale);\n    else group.scale.set(...model.scale);\n  }\n\n  void import(\"three/examples/jsm/loaders/GLTFLoader.js\").then(({ GLTFLoader }) => {\n    new GLTFLoader().load(model.src, (gltf) => {\n      gltf.scene.traverse((child) => {\n        child.castShadow = true;\n        child.receiveShadow = true;\n      });\n      group.add(gltf.scene);\n    });\n  });\n\n  return group;\n}\n","import type { EnginePlugin } from \"@scenography/engine\";\n\nimport { buildModel } from \"./buildModel\";\nimport { modelData, type Model } from \"./data\";\n\n/** The model plugin: places each external glTF/GLB `Model` in the scene. */\nexport const model = (): EnginePlugin<Model> => ({\n  data: modelData,\n  build: (definition) => ({ object: buildModel(definition) }),\n});\n"],"mappings":";;;;;;;;;;AAUA,SAAgB,WAAW,OAAwB;CACjD,MAAM,QAAQ,IAAIA,MAAAA,MAAM;CACxB,MAAM,OAAO,SAAS,MAAM;CAC5B,MAAM,SAAS,gBAAgB,MAAM;CAErC,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,KAAA,GAClB,IAAI,OAAO,MAAM,UAAU,UAAU,MAAM,MAAM,UAAU,MAAM,KAAK;MACjE,MAAM,MAAM,IAAI,GAAG,MAAM,KAAK;CAGrC,OAAY,2CAA2C,CAAC,MAAM,EAAE,iBAAiB;EAC/E,IAAI,WAAW,CAAC,CAAC,KAAK,MAAM,MAAM,SAAS;GACzC,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,aAAa;IACnB,MAAM,gBAAgB;GACxB,CAAC;GACD,MAAM,IAAI,KAAK,KAAK;EACtB,CAAC;CACH,CAAC;CAED,OAAO;AACT;;;;AC3BA,MAAa,eAAoC;CAC/C,MAAMC,aAAAA;CACN,QAAQ,gBAAgB,EAAE,QAAQ,WAAW,UAAU,EAAE;AAC3D"}
+{"version":3,"file":"index.cjs","names":["Group","modelData"],"sources":["../src/buildModel.ts","../src/plugin.ts"],"sourcesContent":["import { Group, type Object3D } from \"three\";\nimport { getKtx2Loader } from \"@scenography/engine\";\n\nimport type { Model } from \"./data\";\n\n/**\n * Build the three.js object for an external `Model`. Returns an empty `Group`\n * with the transform applied immediately; the glTF/GLB is fetched async and its\n * scene added once ready (same pattern as texture loading). `GLTFLoader` is\n * imported on demand so it only ships in the bundle when a scene uses models;\n * the meshopt decoder rides along so `EXT_meshopt_compression` models load, and\n * the shared KTX2 loader handles `KHR_texture_basisu` maps.\n */\nexport function buildModel(model: Model): Object3D {\n  const group = new Group();\n  group.name = `model:${model.id}`;\n  group.userData.scenographyId = model.id;\n\n  if (model.position) group.position.set(...model.position);\n  if (model.rotation) group.rotation.set(...model.rotation);\n  if (model.scale !== undefined) {\n    if (typeof model.scale === \"number\") group.scale.setScalar(model.scale);\n    else group.scale.set(...model.scale);\n  }\n\n  const ktx2 = getKtx2Loader();\n  void Promise.all([\n    import(\"three/examples/jsm/loaders/GLTFLoader.js\"),\n    import(\"three/examples/jsm/libs/meshopt_decoder.module.js\"),\n    ktx2 ?? Promise.resolve(null),\n  ]).then(([{ GLTFLoader }, { MeshoptDecoder }, ktx2Loader]) => {\n    const loader = new GLTFLoader();\n    loader.setMeshoptDecoder(MeshoptDecoder);\n    if (ktx2Loader) loader.setKTX2Loader(ktx2Loader as Parameters<typeof loader.setKTX2Loader>[0]);\n    loader.load(model.src, (gltf) => {\n      gltf.scene.traverse((child) => {\n        child.castShadow = true;\n        child.receiveShadow = true;\n      });\n      group.add(gltf.scene);\n    });\n  });\n\n  return group;\n}\n","import type { EnginePlugin } from \"@scenography/engine\";\n\nimport { buildModel } from \"./buildModel\";\nimport { modelData, type Model } from \"./data\";\n\n/** The model plugin: places each external glTF/GLB `Model` in the scene. */\nexport const model = (): EnginePlugin<Model> => ({\n  data: modelData,\n  build: (definition) => ({ object: buildModel(definition) }),\n});\n"],"mappings":";;;;;;;;;;;;;AAaA,SAAgB,WAAW,OAAwB;CACjD,MAAM,QAAQ,IAAIA,MAAAA,MAAM;CACxB,MAAM,OAAO,SAAS,MAAM;CAC5B,MAAM,SAAS,gBAAgB,MAAM;CAErC,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,KAAA,GAClB,IAAI,OAAO,MAAM,UAAU,UAAU,MAAM,MAAM,UAAU,MAAM,KAAK;MACjE,MAAM,MAAM,IAAI,GAAG,MAAM,KAAK;CAGrC,MAAM,QAAA,GAAA,oBAAA,cAAA,CAAqB;CAC3B,QAAa,IAAI;EACf,OAAO;EACP,OAAO;EACP,QAAQ,QAAQ,QAAQ,IAAI;CAC9B,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,kBAAkB,gBAAgB;EAC5D,MAAM,SAAS,IAAI,WAAW;EAC9B,OAAO,kBAAkB,cAAc;EACvC,IAAI,YAAY,OAAO,cAAc,UAAwD;EAC7F,OAAO,KAAK,MAAM,MAAM,SAAS;GAC/B,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,aAAa;IACnB,MAAM,gBAAgB;GACxB,CAAC;GACD,MAAM,IAAI,KAAK,KAAK;EACtB,CAAC;CACH,CAAC;CAED,OAAO;AACT;;;;ACtCA,MAAa,eAAoC;CAC/C,MAAMC,aAAAA;CACN,QAAQ,gBAAgB,EAAE,QAAQ,WAAW,UAAU,EAAE;AAC3D"}

package/dist/index.d.cts

@@ -11,7 +11,9 @@ declare const model: () => EnginePlugin<Model>;
  * Build the three.js object for an external `Model`. Returns an empty `Group`
  * with the transform applied immediately; the glTF/GLB is fetched async and its
  * scene added once ready (same pattern as texture loading). `GLTFLoader` is
- * imported on demand so it only ships in the bundle when a scene uses models.
+ * imported on demand so it only ships in the bundle when a scene uses models;
+ * the meshopt decoder rides along so `EXT_meshopt_compression` models load, and
+ * the shared KTX2 loader handles `KHR_texture_basisu` maps.
  */
 declare function buildModel(model: Model): Object3D;
 //#endregion

package/dist/index.d.mts

@@ -11,7 +11,9 @@ declare const model: () => EnginePlugin<Model>;
  * Build the three.js object for an external `Model`. Returns an empty `Group`
  * with the transform applied immediately; the glTF/GLB is fetched async and its
  * scene added once ready (same pattern as texture loading). `GLTFLoader` is
- * imported on demand so it only ships in the bundle when a scene uses models.
+ * imported on demand so it only ships in the bundle when a scene uses models;
+ * the meshopt decoder rides along so `EXT_meshopt_compression` models load, and
+ * the shared KTX2 loader handles `KHR_texture_basisu` maps.
  */
 declare function buildModel(model: Model): Object3D;
 //#endregion

package/dist/index.mjs

@@ -1,11 +1,14 @@
 import { n as validateModel, t as modelData } from "./data-CHJeJEc2.mjs";
 import { Group } from "three";
+import { getKtx2Loader } from "@scenography/engine";
 //#region src/buildModel.ts
 /**
 * Build the three.js object for an external `Model`. Returns an empty `Group`
 * with the transform applied immediately; the glTF/GLB is fetched async and its
 * scene added once ready (same pattern as texture loading). `GLTFLoader` is
-* imported on demand so it only ships in the bundle when a scene uses models.
+* imported on demand so it only ships in the bundle when a scene uses models;
+* the meshopt decoder rides along so `EXT_meshopt_compression` models load, and
+* the shared KTX2 loader handles `KHR_texture_basisu` maps.
 */
 function buildModel(model) {
 	const group = new Group();
@@ -15,8 +18,16 @@ function buildModel(model) {
 	if (model.rotation) group.rotation.set(...model.rotation);
 	if (model.scale !== void 0) if (typeof model.scale === "number") group.scale.setScalar(model.scale);
 	else group.scale.set(...model.scale);
-	import("three/examples/jsm/loaders/GLTFLoader.js").then(({ GLTFLoader }) => {
-		new GLTFLoader().load(model.src, (gltf) => {
+	const ktx2 = getKtx2Loader();
+	Promise.all([
+		import("three/examples/jsm/loaders/GLTFLoader.js"),
+		import("three/examples/jsm/libs/meshopt_decoder.module.js"),
+		ktx2 ?? Promise.resolve(null)
+	]).then(([{ GLTFLoader }, { MeshoptDecoder }, ktx2Loader]) => {
+		const loader = new GLTFLoader();
+		loader.setMeshoptDecoder(MeshoptDecoder);
+		if (ktx2Loader) loader.setKTX2Loader(ktx2Loader);
+		loader.load(model.src, (gltf) => {
 			gltf.scene.traverse((child) => {
 				child.castShadow = true;
 				child.receiveShadow = true;

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/buildModel.ts","../src/plugin.ts"],"sourcesContent":["import { Group, type Object3D } from \"three\";\n\nimport type { Model } from \"./data\";\n\n/**\n * Build the three.js object for an external `Model`. Returns an empty `Group`\n * with the transform applied immediately; the glTF/GLB is fetched async and its\n * scene added once ready (same pattern as texture loading). `GLTFLoader` is\n * imported on demand so it only ships in the bundle when a scene uses models.\n */\nexport function buildModel(model: Model): Object3D {\n  const group = new Group();\n  group.name = `model:${model.id}`;\n  group.userData.scenographyId = model.id;\n\n  if (model.position) group.position.set(...model.position);\n  if (model.rotation) group.rotation.set(...model.rotation);\n  if (model.scale !== undefined) {\n    if (typeof model.scale === \"number\") group.scale.setScalar(model.scale);\n    else group.scale.set(...model.scale);\n  }\n\n  void import(\"three/examples/jsm/loaders/GLTFLoader.js\").then(({ GLTFLoader }) => {\n    new GLTFLoader().load(model.src, (gltf) => {\n      gltf.scene.traverse((child) => {\n        child.castShadow = true;\n        child.receiveShadow = true;\n      });\n      group.add(gltf.scene);\n    });\n  });\n\n  return group;\n}\n","import type { EnginePlugin } from \"@scenography/engine\";\n\nimport { buildModel } from \"./buildModel\";\nimport { modelData, type Model } from \"./data\";\n\n/** The model plugin: places each external glTF/GLB `Model` in the scene. */\nexport const model = (): EnginePlugin<Model> => ({\n  data: modelData,\n  build: (definition) => ({ object: buildModel(definition) }),\n});\n"],"mappings":";;;;;;;;;AAUA,SAAgB,WAAW,OAAwB;CACjD,MAAM,QAAQ,IAAI,MAAM;CACxB,MAAM,OAAO,SAAS,MAAM;CAC5B,MAAM,SAAS,gBAAgB,MAAM;CAErC,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,KAAA,GAClB,IAAI,OAAO,MAAM,UAAU,UAAU,MAAM,MAAM,UAAU,MAAM,KAAK;MACjE,MAAM,MAAM,IAAI,GAAG,MAAM,KAAK;CAGrC,OAAY,2CAA2C,CAAC,MAAM,EAAE,iBAAiB;EAC/E,IAAI,WAAW,CAAC,CAAC,KAAK,MAAM,MAAM,SAAS;GACzC,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,aAAa;IACnB,MAAM,gBAAgB;GACxB,CAAC;GACD,MAAM,IAAI,KAAK,KAAK;EACtB,CAAC;CACH,CAAC;CAED,OAAO;AACT;;;;AC3BA,MAAa,eAAoC;CAC/C,MAAM;CACN,QAAQ,gBAAgB,EAAE,QAAQ,WAAW,UAAU,EAAE;AAC3D"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/buildModel.ts","../src/plugin.ts"],"sourcesContent":["import { Group, type Object3D } from \"three\";\nimport { getKtx2Loader } from \"@scenography/engine\";\n\nimport type { Model } from \"./data\";\n\n/**\n * Build the three.js object for an external `Model`. Returns an empty `Group`\n * with the transform applied immediately; the glTF/GLB is fetched async and its\n * scene added once ready (same pattern as texture loading). `GLTFLoader` is\n * imported on demand so it only ships in the bundle when a scene uses models;\n * the meshopt decoder rides along so `EXT_meshopt_compression` models load, and\n * the shared KTX2 loader handles `KHR_texture_basisu` maps.\n */\nexport function buildModel(model: Model): Object3D {\n  const group = new Group();\n  group.name = `model:${model.id}`;\n  group.userData.scenographyId = model.id;\n\n  if (model.position) group.position.set(...model.position);\n  if (model.rotation) group.rotation.set(...model.rotation);\n  if (model.scale !== undefined) {\n    if (typeof model.scale === \"number\") group.scale.setScalar(model.scale);\n    else group.scale.set(...model.scale);\n  }\n\n  const ktx2 = getKtx2Loader();\n  void Promise.all([\n    import(\"three/examples/jsm/loaders/GLTFLoader.js\"),\n    import(\"three/examples/jsm/libs/meshopt_decoder.module.js\"),\n    ktx2 ?? Promise.resolve(null),\n  ]).then(([{ GLTFLoader }, { MeshoptDecoder }, ktx2Loader]) => {\n    const loader = new GLTFLoader();\n    loader.setMeshoptDecoder(MeshoptDecoder);\n    if (ktx2Loader) loader.setKTX2Loader(ktx2Loader as Parameters<typeof loader.setKTX2Loader>[0]);\n    loader.load(model.src, (gltf) => {\n      gltf.scene.traverse((child) => {\n        child.castShadow = true;\n        child.receiveShadow = true;\n      });\n      group.add(gltf.scene);\n    });\n  });\n\n  return group;\n}\n","import type { EnginePlugin } from \"@scenography/engine\";\n\nimport { buildModel } from \"./buildModel\";\nimport { modelData, type Model } from \"./data\";\n\n/** The model plugin: places each external glTF/GLB `Model` in the scene. */\nexport const model = (): EnginePlugin<Model> => ({\n  data: modelData,\n  build: (definition) => ({ object: buildModel(definition) }),\n});\n"],"mappings":";;;;;;;;;;;;AAaA,SAAgB,WAAW,OAAwB;CACjD,MAAM,QAAQ,IAAI,MAAM;CACxB,MAAM,OAAO,SAAS,MAAM;CAC5B,MAAM,SAAS,gBAAgB,MAAM;CAErC,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,MAAM,SAAS,IAAI,GAAG,MAAM,QAAQ;CACxD,IAAI,MAAM,UAAU,KAAA,GAClB,IAAI,OAAO,MAAM,UAAU,UAAU,MAAM,MAAM,UAAU,MAAM,KAAK;MACjE,MAAM,MAAM,IAAI,GAAG,MAAM,KAAK;CAGrC,MAAM,OAAO,cAAc;CAC3B,QAAa,IAAI;EACf,OAAO;EACP,OAAO;EACP,QAAQ,QAAQ,QAAQ,IAAI;CAC9B,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,kBAAkB,gBAAgB;EAC5D,MAAM,SAAS,IAAI,WAAW;EAC9B,OAAO,kBAAkB,cAAc;EACvC,IAAI,YAAY,OAAO,cAAc,UAAwD;EAC7F,OAAO,KAAK,MAAM,MAAM,SAAS;GAC/B,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,aAAa;IACnB,MAAM,gBAAgB;GACxB,CAAC;GACD,MAAM,IAAI,KAAK,KAAK;EACtB,CAAC;CACH,CAAC;CAED,OAAO;AACT;;;;ACtCA,MAAa,eAAoC;CAC/C,MAAM;CACN,QAAQ,gBAAgB,EAAE,QAAQ,WAAW,UAAU,EAAE;AAC3D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scenography/plugin-model",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Model plugin for scenography: external glTF/GLB models placed in the space.",
   "license": "MIT",
   "files": [
@@ -33,16 +33,16 @@
     }
   },
   "dependencies": {
-    "@scenography/scene": "0.4.1"
+    "@scenography/scene": "0.6.0"
   },
   "devDependencies": {
     "@types/three": "^0.160.0",
     "three": "^0.160.0",
-    "@scenography/engine": "0.4.1"
+    "@scenography/engine": "0.6.0"
   },
   "peerDependencies": {
     "three": ">=0.160.0",
-    "@scenography/engine": "0.4.1"
+    "@scenography/engine": "0.6.0"
   },
   "scripts": {
     "build": "tsdown",