@needle-tools/gltf-build-pipeline 1.0.6 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +3 -0
  2. package/dist/extensions/NEEDLE_mesh_compression/NEEDLE_mesh_compression.d.ts +6 -4
  3. package/dist/extensions/NEEDLE_mesh_compression/NEEDLE_mesh_compression.js +29 -15
  4. package/dist/transforms/needle_mesh_transform.js +80 -51
  5. package/pack-gltf.mjs +1 -1
  6. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -4,6 +4,9 @@ All notable changes to this package will be documented in this file.
4
4
  The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5
5
  and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6
6
 
7
+ ## [1.1.0] - 2023-05-06
8
+ - add: support for per glb mesh compression selection (none, draco or meshopt)
9
+
7
10
  ## [1.0.6] - 2023-05-06
8
11
  - fix: dont add textures to cache when toktx is not installed
9
12
 
package/dist/extensions/NEEDLE_mesh_compression/NEEDLE_mesh_compression.d.ts CHANGED
@@ -1,5 +1,8 @@
1
1
  import { Extension, ExtensionProperty, PropertyType, ReaderContext } from "@gltf-transform/core";
2
- declare interface NEEDLE_mesh_compression_model {
2
+ export declare class NEEDLE_mesh_compression_model_root {
3
+ compression: "none" | "draco" | "meshopt";
4
+ }
5
+ export declare class NEEDLE_mesh_compression_model {
3
6
  useSimplifier: boolean;
4
7
  error: number;
5
8
  ratio: number;
@@ -8,7 +11,7 @@ declare interface NEEDLE_mesh_compression_model {
8
11
  export declare class NEEDLE_mesh_compression extends Extension {
9
12
  static EXTENSION_NAME: string;
10
13
  extensionName: string;
11
- create(model: NEEDLE_mesh_compression_model): NEEDLE_mesh_compression_property;
14
+ create(model: NEEDLE_mesh_compression_model | NEEDLE_mesh_compression_model_root): NEEDLE_mesh_compression_property;
12
15
  read(context: ReaderContext): this;
13
16
  write(ctx: any): this;
14
17
  }
@@ -18,6 +21,5 @@ export declare class NEEDLE_mesh_compression_property extends ExtensionProperty
18
21
  parentTypes: PropertyType[];
19
22
  propertyType: string;
20
23
  init(): void;
21
- model: NEEDLE_mesh_compression_model;
24
+ model: NEEDLE_mesh_compression_model | NEEDLE_mesh_compression_model_root;
22
25
  }
23
- export {};
package/dist/extensions/NEEDLE_mesh_compression/NEEDLE_mesh_compression.js CHANGED
@@ -1,5 +1,15 @@
1
1
  import { Extension, ExtensionProperty, PropertyType } from "@gltf-transform/core";
2
2
  const EXTENSION_NAME = "NEEDLE_mesh_compression";
3
+ // TODO: this extension can now be on the root and on primitives containing different contents
4
+ export class NEEDLE_mesh_compression_model_root {
5
+ compression;
6
+ }
7
+ export class NEEDLE_mesh_compression_model {
8
+ useSimplifier;
9
+ error;
10
+ ratio;
11
+ lockBorder;
12
+ }
3
13
  const debugLog = false;
4
14
  export class NEEDLE_mesh_compression extends Extension {
5
15
  static EXTENSION_NAME = EXTENSION_NAME;
@@ -10,23 +20,27 @@ export class NEEDLE_mesh_compression extends Extension {
10
20
  return ext;
11
21
  }
12
22
  read(context) {
13
- if (!context.jsonDoc.json.meshes)
14
- return;
15
23
  if (debugLog)
16
24
  console.log("READ " + EXTENSION_NAME);
17
- context.meshes?.forEach((mesh, index) => {
18
- const meshDefinition = context.jsonDoc.json.meshes[index];
19
- if (!meshDefinition)
20
- return;
21
- const primitives = mesh.listPrimitives();
22
- for (let i = 0; i < primitives.length; i++) {
23
- const primitive = meshDefinition.primitives[i];
24
- if (primitive.extensions && primitive.extensions[EXTENSION_NAME]) {
25
- const model = primitive.extensions[EXTENSION_NAME];
26
- primitives[i].setExtension(EXTENSION_NAME, this.create(model));
25
+ const root = context.jsonDoc.json.extensions?.[EXTENSION_NAME];
26
+ if (root) {
27
+ this.document.getRoot().setExtension(EXTENSION_NAME, this.create(root));
28
+ }
29
+ if (context.jsonDoc.json.meshes) {
30
+ context.meshes?.forEach((mesh, index) => {
31
+ const meshDefinition = context.jsonDoc.json.meshes[index];
32
+ if (!meshDefinition)
33
+ return;
34
+ const primitives = mesh.listPrimitives();
35
+ for (let i = 0; i < primitives.length; i++) {
36
+ const primitive = meshDefinition.primitives[i];
37
+ if (primitive.extensions && primitive.extensions[EXTENSION_NAME]) {
38
+ const model = primitive.extensions[EXTENSION_NAME];
39
+ primitives[i].setExtension(EXTENSION_NAME, this.create(model));
40
+ }
27
41
  }
28
- }
29
- });
42
+ });
43
+ }
30
44
  return this;
31
45
  }
32
46
  write(ctx) {
@@ -36,7 +50,7 @@ export class NEEDLE_mesh_compression extends Extension {
36
50
  export class NEEDLE_mesh_compression_property extends ExtensionProperty {
37
51
  static EXTENSION_NAME = EXTENSION_NAME;
38
52
  extensionName = EXTENSION_NAME;
39
- parentTypes = [PropertyType.PRIMITIVE];
53
+ parentTypes = [PropertyType.PRIMITIVE, PropertyType.ROOT];
40
54
  propertyType = EXTENSION_NAME;
41
55
  init() { }
42
56
  model;
package/dist/transforms/needle_mesh_transform.js CHANGED
@@ -1,67 +1,96 @@
1
1
  import { Primitive } from "@gltf-transform/core";
2
- import { simplifyPrimitive, SIMPLIFY_DEFAULTS, weldPrimitive, WELD_DEFAULTS } from "@gltf-transform/functions";
3
- import { MeshoptSimplifier } from "meshoptimizer";
2
+ import { meshopt, simplifyPrimitive, SIMPLIFY_DEFAULTS, weldPrimitive, WELD_DEFAULTS, draco } from "@gltf-transform/functions";
3
+ import { MeshoptEncoder, MeshoptSimplifier } from "meshoptimizer";
4
4
  import { NEEDLE_mesh_compression } from "../extensions/index.js";
5
- const NAME = 'needle_simplify';
5
+ const NAME = 'needle_mesh_transform';
6
6
  export const needle_mesh_transform = function (_options) {
7
+ return async (document, _context) => {
8
+ await simplifierTransform(document, _context, _options);
9
+ await applyMeshCompression(document, _context);
10
+ };
11
+ };
12
+ async function applyMeshCompression(document, _context) {
13
+ const rootExtension = document.getRoot().getExtension(NEEDLE_mesh_compression.EXTENSION_NAME);
14
+ if (rootExtension) {
15
+ const rootModel = rootExtension.model;
16
+ if (rootModel.compression) {
17
+ if (rootModel.compression === "none") {
18
+ console.log(`[${NAME}]: NONE → will not apply mesh compression`);
19
+ return;
20
+ }
21
+ console.log(`[${NAME}]: ${rootModel.compression.toUpperCase()} → will apply ${rootModel.compression} mesh compression`);
22
+ if (rootModel.compression === "draco") {
23
+ const transform = draco();
24
+ return transform(document, _context);
25
+ }
26
+ else if (rootModel.compression === "meshopt") {
27
+ const transform = meshopt({ encoder: MeshoptEncoder });
28
+ return transform(document, _context);
29
+ }
30
+ }
31
+ }
32
+ // by default we still want to run draco if the root doesnt have a compression model configured
33
+ return draco()(document, _context);
34
+ }
35
+ async function simplifierTransform(document, _context, _options) {
7
36
  const simplifier = MeshoptSimplifier;
8
37
  if (!simplifier) {
9
- throw new Error(`${NAME}: simplifier dependency required — install "meshoptimizer".`);
38
+ console.log(`WARN: [${NAME}] simplifier dependency required — install "meshoptimizer".`);
39
+ return false;
10
40
  }
11
- return (document, _context) => {
12
- const logger = document.getLogger();
13
- const options = { ...SIMPLIFY_DEFAULTS, ..._options };
14
- if (!options.simplifier)
15
- options.simplifier = simplifier;
16
- const weldOptions = {
17
- ...WELD_DEFAULTS,
18
- tolerance: 0.00000000001,
19
- overwrite: true,
20
- };
21
- for (const mesh of document.getRoot().listMeshes()) {
22
- for (const prim of mesh.listPrimitives()) {
23
- // TODO: mesh compression caching
24
- // const key = getKey(prim);
25
- // const cached = tryGetFromCache(key);
26
- // if (cached) {
27
- // logger.debug(`${NAME}: Skipping primitive of mesh "${mesh.getName()}": Already cached.`);
28
- // continue;
29
- // }
30
- // updatePrimitive(prim, simplifier, null, prim.getIndices());
31
- // continue;
32
- const ext = prim.getExtension(NEEDLE_mesh_compression.EXTENSION_NAME);
33
- const mesh_compression = ext?.model;
34
- const simplifyOpts = { ...options };
35
- if (!ext) {
36
- // If no extension exists on the primitive dont apply any simplification
37
- continue;
38
- }
39
- if (mesh_compression) {
40
- // Dont run if useSimplifier is turned off explictly
41
- if (mesh_compression.useSimplifier === false) {
42
- logger.debug(`${NAME}: Skipping primitive of mesh "${mesh.getName()}": useSimplifier is false.`);
43
- continue;
44
- }
45
- if (mesh_compression.error >= 0)
46
- simplifyOpts.error = mesh_compression.error;
47
- if (mesh_compression.ratio >= 0)
48
- simplifyOpts.ratio = mesh_compression.ratio;
49
- simplifyOpts.lockBorder = mesh_compression.lockBorder;
50
- }
51
- if (prim.getMode() !== Primitive.Mode.TRIANGLES) {
52
- logger.warn(`${NAME}: Skipping primitive of mesh "${mesh.getName()}": Requires TRIANGLES draw mode.`);
41
+ const logger = document.getLogger();
42
+ const options = { ...SIMPLIFY_DEFAULTS, ..._options };
43
+ if (!options.simplifier)
44
+ options.simplifier = simplifier;
45
+ const weldOptions = {
46
+ ...WELD_DEFAULTS,
47
+ tolerance: 0.00000000001,
48
+ overwrite: true,
49
+ };
50
+ for (const mesh of document.getRoot().listMeshes()) {
51
+ for (const prim of mesh.listPrimitives()) {
52
+ // TODO: mesh compression caching
53
+ // const key = getKey(prim);
54
+ // const cached = tryGetFromCache(key);
55
+ // if (cached) {
56
+ // logger.debug(`[${NAME}]: Skipping primitive of mesh "${mesh.getName()}": Already cached.`);
57
+ // continue;
58
+ // }
59
+ // updatePrimitive(prim, simplifier, null, prim.getIndices());
60
+ // continue;
61
+ const ext = prim.getExtension(NEEDLE_mesh_compression.EXTENSION_NAME);
62
+ const mesh_compression = ext?.model;
63
+ const simplifyOpts = { ...options };
64
+ if (!ext) {
65
+ // If no extension exists on the primitive dont apply any simplification
66
+ continue;
67
+ }
68
+ if (mesh_compression) {
69
+ // Dont run if useSimplifier is turned off explictly
70
+ if (mesh_compression.useSimplifier === false) {
71
+ logger.debug(`[${NAME}]: Skipping primitive of mesh "${mesh.getName()}": useSimplifier is false.`);
53
72
  continue;
54
73
  }
55
- compressPrimitive(document, mesh, prim, weldOptions, simplifyOpts);
74
+ if (mesh_compression.error >= 0)
75
+ simplifyOpts.error = mesh_compression.error;
76
+ if (mesh_compression.ratio >= 0)
77
+ simplifyOpts.ratio = mesh_compression.ratio;
78
+ simplifyOpts.lockBorder = mesh_compression.lockBorder;
79
+ }
80
+ if (prim.getMode() !== Primitive.Mode.TRIANGLES) {
81
+ logger.warn(`[${NAME}]: Skipping primitive of mesh "${mesh.getName()}": Requires TRIANGLES draw mode.`);
82
+ continue;
56
83
  }
84
+ compressPrimitive(document, mesh, prim, weldOptions, simplifyOpts);
57
85
  }
58
- };
59
- };
86
+ }
87
+ return true;
88
+ }
60
89
  function compressPrimitive(document, mesh, prim, weldOptions, meshOptions) {
61
90
  const logger = document.getLogger();
62
- logger.debug(`${NAME}: Welding primitive of mesh "${mesh.getName()}" → tolerance: ${weldOptions.tolerance}`);
91
+ logger.debug(`[${NAME}]: Welding primitive of mesh "${mesh.getName()}" → tolerance: ${weldOptions.tolerance}`);
63
92
  weldPrimitive(document, prim, weldOptions);
64
- logger.debug(`${NAME}: Simplifying primitive of mesh "${mesh.getName()}" → ratio: ${meshOptions.ratio}, error: ${meshOptions.error}, lockBorder: ${meshOptions.lockBorder}`);
93
+ logger.debug(`[${NAME}]: Simplifying primitive of mesh "${mesh.getName()}" → ratio: ${meshOptions.ratio}, error: ${meshOptions.error}, lockBorder: ${meshOptions.lockBorder}`);
65
94
  simplifyPrimitive(document, prim, meshOptions);
66
95
  }
67
96
  // function updatePrimitive(prim: Primitive, simplifier: any, positionArray, dstIndicesArray) {
package/pack-gltf.mjs CHANGED
@@ -112,7 +112,7 @@ async function packFile(file) {
112
112
  }),
113
113
  needle_mesh_transform({ ratio: 0.75, error: 0.0005 }),
114
114
  needle_animation_transform(),
115
- draco(),
115
+ // draco(),
116
116
  );
117
117
  if (debug) file += ".debug.glb";
118
118
  await io.write(file, document);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@needle-tools/gltf-build-pipeline",
3
- "version": "1.0.6",
3
+ "version": "1.1.0",
4
4
  "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
5
5
  "main": "index.mjs",
6
6
  "type": "module",