@carbonenginejs/runtime-resource 0.8.0 → 0.9.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.
- package/LICENSE +21 -21
- package/NOTICE +29 -29
- package/README.md +67 -548
- package/dist/CjsMotherLode.js +1271 -1271
- package/dist/CjsResMan.js +3005 -3005
- package/dist/CjsResManQueue.js +214 -214
- package/dist/CjsResource.js +566 -566
- package/dist/CjsResourceSource.js +59 -59
- package/dist/_virtual/_rollupPluginBabelHelpers.js +153 -153
- package/dist/format/CjsBlueReader.js +269 -269
- package/dist/format/CjsFormat.js +192 -192
- package/dist/format/CjsReader.js +18 -18
- package/dist/format/CjsResourceProbe.js +277 -277
- package/dist/format/payloadContract.js +173 -173
- package/dist/formats/black/CjsBlackFormat.js +278 -278
- package/dist/formats/black/core/CjsBlackBinaryReader.js +153 -153
- package/dist/formats/black/core/CjsBlackPropertyReaders.js +382 -382
- package/dist/formats/black/core/CjsBlackReader.js +639 -639
- package/dist/formats/black/core/CjsBlackSchemaRegistry.js +433 -433
- package/dist/formats/black/core/black-schema-v1-2026-07-11.json.js +4 -4
- package/dist/formats/black/core/blackConstants.js +7 -7
- package/dist/formats/black/core/blackDefinitions.js +10 -10
- package/dist/formats/black/core/blackEnums.js +6 -6
- package/dist/formats/black/core/blackSchema.js +3 -3
- package/dist/formats/black/core/blackVersion.js +22 -22
- package/dist/formats/black/core/helpers.js +182 -182
- package/dist/formats/black/core/schema.js +4 -4
- package/dist/formats/black/index.js +2 -2
- package/dist/formats/bnk/CjsBnkFormat.js +125 -125
- package/dist/formats/bnk/core/graph.js +140 -140
- package/dist/formats/bnk/core/helpers.js +409 -409
- package/dist/formats/bnk/core/musicNodes.js +489 -489
- package/dist/formats/bnk/core/soundbanksInfo.js +246 -246
- package/dist/formats/bnk/index.js +2 -2
- package/dist/formats/cmf/CjsCmfFormat.js +497 -497
- package/dist/formats/cmf/core/binary.js +118 -118
- package/dist/formats/cmf/core/buffers.js +233 -233
- package/dist/formats/cmf/core/constants.js +47 -47
- package/dist/formats/cmf/core/gr2Anim.js +453 -453
- package/dist/formats/cmf/core/helpers.js +287 -287
- package/dist/formats/cmf/core/pack.js +276 -276
- package/dist/formats/cmf/core/schema.js +364 -364
- package/dist/formats/cmf/core/shared.js +268 -268
- package/dist/formats/cmf/core/writer.js +517 -517
- package/dist/formats/cmf/index.js +2 -2
- package/dist/formats/dds/CjsDdsFormat.js +193 -193
- package/dist/formats/dds/core/bc6h.js +288 -288
- package/dist/formats/dds/core/bc7.js +251 -251
- package/dist/formats/dds/core/helpers.js +815 -815
- package/dist/formats/dds/index.js +2 -2
- package/dist/formats/fbx/CjsFbxFormat.js +266 -266
- package/dist/formats/fbx/core/helpers.js +3901 -3901
- package/dist/formats/fbx/index.js +2 -2
- package/dist/formats/flac/CjsFlacFormat.js +87 -87
- package/dist/formats/flac/core/helpers.js +295 -295
- package/dist/formats/flac/index.js +2 -2
- package/dist/formats/gif/CjsGifFormat.js +87 -87
- package/dist/formats/gif/core/helpers.js +360 -360
- package/dist/formats/gif/index.js +2 -2
- package/dist/formats/gltf/CjsGltfFormat.js +290 -290
- package/dist/formats/gltf/core/helpers.js +292 -292
- package/dist/formats/gltf/core/json.js +79 -79
- package/dist/formats/gltf/core/parser.js +666 -666
- package/dist/formats/gltf/core/targets.js +163 -163
- package/dist/formats/gltf/index.js +2 -2
- package/dist/formats/gr2/CjsGr2Format.js +46 -0
- package/dist/formats/gr2/CjsGr2Format.js.map +1 -0
- package/dist/formats/gr2/core/CjsFormatGr2.js +273 -0
- package/dist/formats/gr2/core/CjsFormatGr2.js.map +1 -0
- package/dist/formats/gr2/core/bitknit2.js +280 -0
- package/dist/formats/gr2/core/bitknit2.js.map +1 -0
- package/dist/formats/gr2/core/curves.js +1047 -0
- package/dist/formats/gr2/core/curves.js.map +1 -0
- package/dist/formats/gr2/core/gsf.js +72 -0
- package/dist/formats/gr2/core/gsf.js.map +1 -0
- package/dist/formats/gr2/core/helpers.js +332 -0
- package/dist/formats/gr2/core/helpers.js.map +1 -0
- package/dist/formats/gr2/core/json.js +622 -0
- package/dist/formats/gr2/core/json.js.map +1 -0
- package/dist/formats/gr2/core/oodle1.js +388 -0
- package/dist/formats/gr2/core/oodle1.js.map +1 -0
- package/dist/formats/gr2/core/reader.js +617 -0
- package/dist/formats/gr2/core/reader.js.map +1 -0
- package/dist/formats/gr2/core/tangents.js +48 -0
- package/dist/formats/gr2/core/tangents.js.map +1 -0
- package/dist/formats/gr2/core/targets.js +351 -0
- package/dist/formats/gr2/core/targets.js.map +1 -0
- package/dist/formats/gr2/index.js +3 -0
- package/dist/formats/gr2/index.js.map +1 -0
- package/dist/formats/index.js +30 -23
- package/dist/formats/index.js.map +1 -1
- package/dist/formats/jpeg/CjsJpegFormat.js +206 -206
- package/dist/formats/jpeg/core/helpers.js +350 -350
- package/dist/formats/jpeg/core/jpeg.js +377 -377
- package/dist/formats/jpeg/index.js +2 -2
- package/dist/formats/mp3/CjsMp3Format.js +192 -192
- package/dist/formats/mp3/core/helpers.js +338 -338
- package/dist/formats/mp3/index.js +2 -2
- package/dist/formats/mp4/CjsMp4Format.js +191 -191
- package/dist/formats/mp4/core/helpers.js +449 -449
- package/dist/formats/mp4/index.js +2 -2
- package/dist/formats/obj/CjsObjFormat.js +253 -253
- package/dist/formats/obj/core/helpers.js +573 -573
- package/dist/formats/obj/core/json.js +64 -64
- package/dist/formats/obj/core/parser.js +321 -321
- package/dist/formats/obj/index.js +2 -2
- package/dist/formats/ogg/CjsOggFormat.js +88 -88
- package/dist/formats/ogg/core/helpers.js +387 -387
- package/dist/formats/ogg/core/imdct.js +178 -178
- package/dist/formats/ogg/core/vorbis.js +999 -999
- package/dist/formats/ogg/index.js +2 -2
- package/dist/formats/png/CjsPngFormat.js +195 -195
- package/dist/formats/png/core/helpers.js +583 -583
- package/dist/formats/png/index.js +2 -2
- package/dist/formats/red/CjsRedFormat.js +261 -261
- package/dist/formats/red/core/CjsRedReader.js +194 -194
- package/dist/formats/red/core/blackDefinitions.js +3 -3
- package/dist/formats/red/core/helpers.js +139 -139
- package/dist/formats/red/core/redGraph.js +68 -68
- package/dist/formats/red/core/schema.js +4 -4
- package/dist/formats/red/index.js +2 -2
- package/dist/formats/stl/CjsStlFormat.js +365 -365
- package/dist/formats/stl/core/helpers.js +261 -261
- package/dist/formats/stl/core/json.js +51 -51
- package/dist/formats/stl/core/stl.js +629 -629
- package/dist/formats/stl/core/targets.js +163 -163
- package/dist/formats/stl/index.js +2 -2
- package/dist/formats/tga/CjsTgaFormat.js +192 -192
- package/dist/formats/tga/core/helpers.js +446 -446
- package/dist/formats/tga/index.js +2 -2
- package/dist/formats/wav/CjsWavFormat.js +192 -192
- package/dist/formats/wav/core/helpers.js +328 -328
- package/dist/formats/wav/index.js +2 -2
- package/dist/formats/webm/CjsWebmFormat.js +191 -191
- package/dist/formats/webm/core/helpers.js +537 -537
- package/dist/formats/webm/index.js +2 -2
- package/dist/formats/webp/CjsWebpFormat.js +86 -86
- package/dist/formats/webp/core/helpers.js +214 -214
- package/dist/formats/webp/index.js +2 -2
- package/dist/formats/wem/CjsWemFormat.js +241 -241
- package/dist/formats/wem/core/bitStream.js +259 -259
- package/dist/formats/wem/core/codebookLibrary.js +164 -164
- package/dist/formats/wem/core/helpers.js +417 -417
- package/dist/formats/wem/core/packedCodebooksAotuv603.js +30 -30
- package/dist/formats/wem/core/ptadpcm.js +77 -77
- package/dist/formats/wem/core/resolve.js +121 -121
- package/dist/formats/wem/core/wemToOgg.js +485 -485
- package/dist/formats/wem/index.js +2 -2
- package/dist/formats/yaml/CjsYamlFormat.js +83 -83
- package/dist/formats/yaml/core/CjsYamlReader.js +305 -305
- package/dist/formats/yaml/core/helpers.js +160 -160
- package/dist/formats/yaml/index.js +2 -2
- package/dist/index.js +49 -48
- package/dist/index.js.map +1 -1
- package/dist/resourcePath.js +18 -18
- package/dist/resourceStates.js +9 -9
- package/dist/resources/AudioGeometryResData.js +47 -47
- package/dist/resources/GStateBindingCallbackData.js +31 -31
- package/dist/resources/MeshDecalData.js +37 -37
- package/dist/resources/MeshDecalLodData.js +34 -34
- package/dist/resources/Tr2EffectRes.js +71 -71
- package/dist/resources/Tr2GrannyIntersectionResult.js +60 -60
- package/dist/resources/Tr2GrannyStateRes.js +44 -44
- package/dist/resources/Tr2ImageRes.js +114 -114
- package/dist/resources/Tr2LightProfileRes.js +40 -40
- package/dist/resources/Tr2MaterialArea.js +34 -34
- package/dist/resources/Tr2MaterialMesh.js +31 -31
- package/dist/resources/Tr2MaterialRes.js +34 -34
- package/dist/resources/Tr2ShaderPermutation.js +43 -43
- package/dist/resources/Tr2TextureLodManager.js +80 -80
- package/dist/resources/Tr2TextureLodUpdateRequest.js +37 -37
- package/dist/resources/Tr2TexturePackChannel.js +37 -37
- package/dist/resources/Tr2TexturePipeline.js +52 -52
- package/dist/resources/Tr2TexturePipelineParams.js +34 -34
- package/dist/resources/Tr2TexturePipelineStepCompress.js +40 -40
- package/dist/resources/Tr2TexturePipelineStepGenerateMips.js +22 -0
- package/dist/resources/Tr2TexturePipelineStepGenerateMips.js.map +1 -0
- package/dist/resources/Tr2TexturePipelineStepLimitSize.js +34 -34
- package/dist/resources/Tr2TexturePipelineStepLoad.js +31 -31
- package/dist/resources/Tr2TexturePipelineStepPack.js +43 -43
- package/dist/resources/TriGeometryRes.js +239 -239
- package/dist/resources/TriGeometryResAreaData.js +59 -59
- package/dist/resources/TriGeometryResJointData.js +38 -38
- package/dist/resources/TriGeometryResLodData.js +88 -88
- package/dist/resources/TriGeometryResMeshData.js +63 -63
- package/dist/resources/TriGeometryResSkeletonData.js +34 -34
- package/dist/resources/TriGrannyRes.js +43 -43
- package/dist/resources/TriJointBinding.js +38 -38
- package/dist/resources/TriMorphTargetGeometryConstants.js +46 -46
- package/dist/resources/TriRtGeometryConstants.js +88 -88
- package/dist/resources/TriTextureRes.js +304 -304
- package/dist/resources/enums.js +18 -18
- package/dist/resources/resourceBoundary.js +47 -47
- package/dist/resources/texturePipelineBehavior.js +308 -308
- package/dist/texture/CjsTextureArrayRes.js +406 -406
- package/dist/texture/CjsTextureParameterProxy.js +133 -133
- package/docs/README.md +69 -0
- package/docs/architecture.md +86 -0
- package/docs/concepts/resource-lifecycle.md +217 -0
- package/docs/formats/README.md +104 -0
- package/{FORMAT-PROVENANCE.md → docs/formats/provenance.md} +173 -155
- package/docs/formats/stl.md +37 -0
- package/docs/formats/wwise.md +44 -0
- package/docs/reference/events.md +92 -0
- package/docs/reference/motherlode-cache.md +244 -0
- package/docs/reference/queues.md +102 -0
- package/docs/reference/reload.md +107 -0
- package/docs/reference/texture-arrays.md +113 -0
- package/docs/reference/texture-pipeline.md +53 -0
- package/docs/roadmap.md +104 -0
- package/format-notices/black/LICENSE +21 -21
- package/format-notices/black/NOTICE +47 -47
- package/format-notices/bnk/LICENSE +21 -21
- package/format-notices/bnk/NOTICE +20 -20
- package/format-notices/cmf/LICENSE +21 -21
- package/format-notices/cmf/NOTICE +36 -36
- package/format-notices/dds/LICENSE +21 -21
- package/format-notices/dds/NOTICE +14 -14
- package/format-notices/fbx/LICENSE +21 -21
- package/format-notices/fbx/NOTICE +14 -14
- package/format-notices/flac/LICENSE +21 -21
- package/format-notices/flac/NOTICE +14 -14
- package/format-notices/gif/LICENSE +21 -21
- package/format-notices/gif/NOTICE +14 -14
- package/format-notices/gltf/LICENSE +21 -21
- package/format-notices/gltf/NOTICE +27 -27
- package/format-notices/gr2/LICENSE +21 -0
- package/format-notices/gr2/NOTICE +60 -0
- package/format-notices/gr2/THIRD-PARTY-NOTICES.md +93 -0
- package/format-notices/jpeg/LICENSE +21 -21
- package/format-notices/jpeg/NOTICE +14 -14
- package/format-notices/mp3/LICENSE +21 -21
- package/format-notices/mp3/NOTICE +14 -14
- package/format-notices/mp4/LICENSE +21 -21
- package/format-notices/mp4/NOTICE +14 -14
- package/format-notices/obj/LICENSE +21 -21
- package/format-notices/obj/NOTICE +26 -26
- package/format-notices/ogg/LICENSE +21 -21
- package/format-notices/ogg/NOTICE +28 -28
- package/format-notices/png/LICENSE +21 -21
- package/format-notices/png/NOTICE +14 -14
- package/format-notices/red/LICENSE +21 -21
- package/format-notices/red/NOTICE +31 -31
- package/format-notices/stl/LICENSE +21 -21
- package/format-notices/stl/NOTICE +21 -21
- package/format-notices/tga/LICENSE +21 -21
- package/format-notices/tga/NOTICE +14 -14
- package/format-notices/wav/LICENSE +21 -21
- package/format-notices/wav/NOTICE +14 -14
- package/format-notices/webm/LICENSE +21 -21
- package/format-notices/webm/NOTICE +14 -14
- package/format-notices/webp/LICENSE +21 -21
- package/format-notices/webp/NOTICE +14 -14
- package/format-notices/wem/LICENSE +57 -57
- package/format-notices/wem/NOTICE +33 -33
- package/format-notices/yaml/LICENSE +21 -21
- package/format-notices/yaml/NOTICE +44 -44
- package/package.json +52 -51
- package/resource-lifecycle.md +0 -679
|
@@ -1,365 +1,365 @@
|
|
|
1
|
-
import { DEFAULT_VALUES, normalizeValues, validateClassKey, validateClass, readWithValues, writeWithValues, inspectWithValues, toJsonValue, importNodeModule, OUTPUT_CMF, OUTPUT_GR2, OUTPUT_SHARED, OUTPUT_STL_JSON, OUTPUT_JSON, CLASS_KEYS } from './core/helpers.js';
|
|
2
|
-
import { isStl, isBinaryStl } from './core/stl.js';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Exposed CarbonEngineJS-facing STL format class.
|
|
6
|
-
*
|
|
7
|
-
* Keep this file small and reviewable: STL parsing, writing, printability
|
|
8
|
-
* inspection, option normalization, and JSON hydration live under src/core.
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
|
-
const FORMAT_NAME = "CjsStlFormat";
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* Shared mesh accepted by the STL writer. STL exports only `vertex.position`
|
|
15
|
-
* and triangular `indices[].faces`; all other shared channels are ignored.
|
|
16
|
-
*
|
|
17
|
-
* @typedef {object} CjsStlSharedMesh
|
|
18
|
-
* @property {string} [name] Diagnostic mesh name; `solidName` controls the STL header.
|
|
19
|
-
* @property {{position: ArrayLike<number>, normal?: ArrayLike<number>}} vertex Shared vertex channels.
|
|
20
|
-
* @property {Array<{name?: string, faces: ArrayLike<number>}>} indices Triangle index groups.
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Shared geometry root accepted by the STL writer.
|
|
25
|
-
*
|
|
26
|
-
* @typedef {object} CjsStlSharedRoot
|
|
27
|
-
* @property {Array<CjsStlSharedMesh>} meshes Meshes flattened into one STL solid.
|
|
28
|
-
* @property {string} [grannyFileSource] Optional source label used by inspection.
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Reusable STL read, write, and inspection options.
|
|
33
|
-
*
|
|
34
|
-
* @typedef {object} CjsStlFormatOptions
|
|
35
|
-
* @property {"shared"|"stlJson"|"json"|"gr2"|"cmf"} [emit="stlJson"] Read output contract.
|
|
36
|
-
* @property {string} [source="memory"] Source label stored in read/inspection output.
|
|
37
|
-
* @property {boolean} [binary=true] Whether writes return binary bytes instead of ASCII text.
|
|
38
|
-
* @property {string} [solidName="carbonenginejs"] Sanitized ASCII solid name and binary header label.
|
|
39
|
-
* @property {number} [scale=1] Positive finite multiplier applied to exported positions.
|
|
40
|
-
* @property {boolean} [recalculateNormals=true] Derive facet normals from winding instead of vertex normals.
|
|
41
|
-
* @property {boolean} [weldVertices=false] Weld equal positions while reading STL.
|
|
42
|
-
* @property {number} [weldTolerance=1e-5] Non-negative read/inspection position tolerance.
|
|
43
|
-
* @property {boolean} [skipDegenerate=true] Omit degenerate shared triangles during writes.
|
|
44
|
-
* @property {boolean} [requireWatertight=false] Reject writes with printability topology issues.
|
|
45
|
-
* @property {Record<string, Function>} [classes] Caller constructors used for read hydration.
|
|
46
|
-
*/
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* CarbonEngineJS-facing STL format surface.
|
|
50
|
-
*
|
|
51
|
-
* The Cjs prefix marks this as a JavaScript format/construction boundary.
|
|
52
|
-
* STL is a triangle-only import/export format; the JSON contract is the shared
|
|
53
|
-
* CarbonEngineJS mesh schema.
|
|
54
|
-
*/
|
|
55
|
-
class CjsStlFormat {
|
|
56
|
-
#emit = DEFAULT_VALUES.emit;
|
|
57
|
-
#source = DEFAULT_VALUES.source;
|
|
58
|
-
#binary = DEFAULT_VALUES.binary;
|
|
59
|
-
#solidName = DEFAULT_VALUES.solidName;
|
|
60
|
-
#scale = DEFAULT_VALUES.scale;
|
|
61
|
-
#recalculateNormals = DEFAULT_VALUES.recalculateNormals;
|
|
62
|
-
#weldVertices = DEFAULT_VALUES.weldVertices;
|
|
63
|
-
#weldTolerance = DEFAULT_VALUES.weldTolerance;
|
|
64
|
-
#skipDegenerate = DEFAULT_VALUES.skipDegenerate;
|
|
65
|
-
#requireWatertight = DEFAULT_VALUES.requireWatertight;
|
|
66
|
-
#classes = DEFAULT_VALUES.classes;
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Create a reusable format profile.
|
|
70
|
-
*
|
|
71
|
-
* The instance stores only normalized options; each `Read`, `Write`, or
|
|
72
|
-
* `Inspect` call may provide non-mutating overrides.
|
|
73
|
-
*
|
|
74
|
-
* @param {CjsStlFormatOptions} [options={}] Default format values.
|
|
75
|
-
* @throws {TypeError} If an option, output mode, numeric value, or class map is invalid.
|
|
76
|
-
*/
|
|
77
|
-
constructor(options = {}) {
|
|
78
|
-
this.SetValues(options);
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Set format values for this reusable profile.
|
|
83
|
-
*
|
|
84
|
-
* @param {CjsStlFormatOptions} [options={}] Values to merge into the profile.
|
|
85
|
-
* @returns {CjsStlFormat} This format profile.
|
|
86
|
-
* @throws {TypeError} If an option, output mode, numeric value, or class map is invalid.
|
|
87
|
-
*/
|
|
88
|
-
SetValues(options = {}) {
|
|
89
|
-
const values = normalizeValues(this.GetValues(), options, FORMAT_NAME);
|
|
90
|
-
this.#emit = values.emit;
|
|
91
|
-
this.#source = values.source;
|
|
92
|
-
this.#binary = values.binary;
|
|
93
|
-
this.#solidName = values.solidName;
|
|
94
|
-
this.#scale = values.scale;
|
|
95
|
-
this.#recalculateNormals = values.recalculateNormals;
|
|
96
|
-
this.#weldVertices = values.weldVertices;
|
|
97
|
-
this.#weldTolerance = values.weldTolerance;
|
|
98
|
-
this.#skipDegenerate = values.skipDegenerate;
|
|
99
|
-
this.#requireWatertight = values.requireWatertight;
|
|
100
|
-
this.#classes = values.classes;
|
|
101
|
-
return this;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* Get this profile's current values, optionally with per-call overrides.
|
|
106
|
-
*
|
|
107
|
-
* @param {CjsStlFormatOptions} [options={}] Optional values to merge into a copy.
|
|
108
|
-
* @returns {CjsStlFormatOptions} A validated copy of the effective values.
|
|
109
|
-
* @throws {TypeError} If an override is invalid.
|
|
110
|
-
*/
|
|
111
|
-
GetValues(options = {}) {
|
|
112
|
-
return normalizeValues({
|
|
113
|
-
emit: this.#emit,
|
|
114
|
-
source: this.#source,
|
|
115
|
-
binary: this.#binary,
|
|
116
|
-
solidName: this.#solidName,
|
|
117
|
-
scale: this.#scale,
|
|
118
|
-
recalculateNormals: this.#recalculateNormals,
|
|
119
|
-
weldVertices: this.#weldVertices,
|
|
120
|
-
weldTolerance: this.#weldTolerance,
|
|
121
|
-
skipDegenerate: this.#skipDegenerate,
|
|
122
|
-
requireWatertight: this.#requireWatertight,
|
|
123
|
-
classes: this.#classes
|
|
124
|
-
}, options, FORMAT_NAME);
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
* Set multiple node-class constructors for this profile.
|
|
129
|
-
*
|
|
130
|
-
* @param {object} [classes] Map of node class keys to constructors.
|
|
131
|
-
* @returns {CjsStlFormat} This format profile.
|
|
132
|
-
*/
|
|
133
|
-
SetClasses(classes = {}) {
|
|
134
|
-
return this.SetValues({
|
|
135
|
-
classes
|
|
136
|
-
});
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
* Set one node-class constructor for this profile.
|
|
141
|
-
*
|
|
142
|
-
* @param {string} type Node class key.
|
|
143
|
-
* @param {Function|null|undefined} Class Constructor to use, or nullish to delete.
|
|
144
|
-
* @returns {CjsStlFormat} This format profile.
|
|
145
|
-
*/
|
|
146
|
-
SetClass(type, Class) {
|
|
147
|
-
if (Class === null || Class === undefined) {
|
|
148
|
-
validateClassKey(type, FORMAT_NAME);
|
|
149
|
-
const classes = {
|
|
150
|
-
...this.#classes
|
|
151
|
-
};
|
|
152
|
-
delete classes[type];
|
|
153
|
-
this.#classes = classes;
|
|
154
|
-
return this;
|
|
155
|
-
}
|
|
156
|
-
validateClass(type, Class, FORMAT_NAME);
|
|
157
|
-
return this.SetValues({
|
|
158
|
-
classes: {
|
|
159
|
-
[type]: Class
|
|
160
|
-
}
|
|
161
|
-
});
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Get a configured node-class constructor.
|
|
166
|
-
*
|
|
167
|
-
* @param {string} type Node class key.
|
|
168
|
-
* @returns {Function|undefined} The registered constructor, if any.
|
|
169
|
-
*/
|
|
170
|
-
GetClass(type) {
|
|
171
|
-
validateClassKey(type, FORMAT_NAME);
|
|
172
|
-
return this.#classes[type];
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
/**
|
|
176
|
-
* Whether this format profile has a constructor registered for a node class key.
|
|
177
|
-
*
|
|
178
|
-
* @param {string} type Node class key.
|
|
179
|
-
* @returns {boolean} True when a constructor is registered.
|
|
180
|
-
*/
|
|
181
|
-
HasClass(type) {
|
|
182
|
-
return !!this.GetClass(type);
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* Read STL text/bytes with this profile's values.
|
|
187
|
-
*
|
|
188
|
-
* @param {string|Uint8Array|ArrayBuffer|DataView} input STL text or bytes.
|
|
189
|
-
* @param {object} [options] Per-call value overrides.
|
|
190
|
-
* @returns {object} The shared CarbonEngineJS JSON mesh schema.
|
|
191
|
-
*/
|
|
192
|
-
Read(input, options = {}) {
|
|
193
|
-
return readWithValues(this, input, this.GetValues(options));
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
/**
|
|
197
|
-
* Write shared JSON geometry as STL with this profile's values.
|
|
198
|
-
*
|
|
199
|
-
* Multiple meshes and index groups are flattened in encounter order because
|
|
200
|
-
* STL has no portable material or scene hierarchy. Degenerate triangles are
|
|
201
|
-
* skipped by default. Binary output validates that every coordinate is
|
|
202
|
-
* representable as float32 rather than silently writing infinities.
|
|
203
|
-
*
|
|
204
|
-
* @param {CjsStlSharedRoot|CjsStlSharedMesh} input Shared JSON root or mesh.
|
|
205
|
-
* @param {CjsStlFormatOptions} [options={}] Per-call writer overrides.
|
|
206
|
-
* @returns {string|Uint8Array} ASCII STL text or binary STL bytes.
|
|
207
|
-
* @throws {TypeError|RangeError|Error} If geometry, indices, coordinates, topology, or options are invalid.
|
|
208
|
-
*/
|
|
209
|
-
Write(input, options = {}) {
|
|
210
|
-
return writeWithValues(input, this.GetValues(options));
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
/**
|
|
214
|
-
* Inspect STL text/bytes or shared JSON geometry for printability blockers.
|
|
215
|
-
*
|
|
216
|
-
* @param {any} input STL text/bytes or shared JSON root/mesh.
|
|
217
|
-
* @param {object} [options] Per-call value overrides.
|
|
218
|
-
* @returns {object} Plain printability report.
|
|
219
|
-
*/
|
|
220
|
-
Inspect(input, options = {}) {
|
|
221
|
-
return inspectWithValues(input, this.GetValues(options));
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
/**
|
|
225
|
-
* Convert format output to JSON-compatible data.
|
|
226
|
-
*
|
|
227
|
-
* @param {any} value Format output to convert.
|
|
228
|
-
* @returns {any} Plain JSON-compatible data.
|
|
229
|
-
*/
|
|
230
|
-
ToJSON(value) {
|
|
231
|
-
return toJsonValue(value);
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
* Static one-shot read. Static methods use camelCase by convention.
|
|
236
|
-
*
|
|
237
|
-
* @param {string|Uint8Array|ArrayBuffer|DataView} input STL text or bytes.
|
|
238
|
-
* @param {object} [options] Format values.
|
|
239
|
-
* @returns {object} The shared CarbonEngineJS JSON mesh schema.
|
|
240
|
-
*/
|
|
241
|
-
static read(input, options = {}) {
|
|
242
|
-
return readWithValues(CjsStlFormat, input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* Static one-shot write.
|
|
247
|
-
*
|
|
248
|
-
* The call is one-shot and does not mutate `input`. Multiple meshes and
|
|
249
|
-
* index groups are flattened into a single STL solid in encounter order.
|
|
250
|
-
*
|
|
251
|
-
* @param {CjsStlSharedRoot|CjsStlSharedMesh} input Shared JSON root or mesh.
|
|
252
|
-
* @param {CjsStlFormatOptions} [options={}] Writer values.
|
|
253
|
-
* @returns {string|Uint8Array} ASCII STL text or binary STL bytes.
|
|
254
|
-
* @throws {TypeError|RangeError|Error} If geometry, indices, coordinates, topology, or options are invalid.
|
|
255
|
-
*/
|
|
256
|
-
static write(input, options = {}) {
|
|
257
|
-
return writeWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* Static one-shot inspection.
|
|
262
|
-
*
|
|
263
|
-
* @param {any} input STL text/bytes or shared JSON root/mesh.
|
|
264
|
-
* @param {object} [options] Format values.
|
|
265
|
-
* @returns {object} Plain printability report.
|
|
266
|
-
*/
|
|
267
|
-
static inspect(input, options = {}) {
|
|
268
|
-
return inspectWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
* Static JSON-compatible conversion.
|
|
273
|
-
*
|
|
274
|
-
* @param {any} value Format output to convert.
|
|
275
|
-
* @returns {any} Plain JSON-compatible data.
|
|
276
|
-
*/
|
|
277
|
-
static toJSON(value) {
|
|
278
|
-
return toJsonValue(value);
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
/**
|
|
282
|
-
* Node-only convenience: reads an STL file from disk.
|
|
283
|
-
*
|
|
284
|
-
* @param {string} path Path to an STL file.
|
|
285
|
-
* @param {object} [options] Format values.
|
|
286
|
-
* @returns {Promise<object>} The shared CarbonEngineJS JSON mesh schema.
|
|
287
|
-
*/
|
|
288
|
-
static async readFile(path, options = {}) {
|
|
289
|
-
if (typeof path !== "string" || !path) {
|
|
290
|
-
throw new TypeError(`${FORMAT_NAME}: readFile path must be a non-empty string`);
|
|
291
|
-
}
|
|
292
|
-
const {
|
|
293
|
-
readFile
|
|
294
|
-
} = await importNodeModule("node:fs/promises");
|
|
295
|
-
const input = await readFile(path);
|
|
296
|
-
return CjsStlFormat.read(input, {
|
|
297
|
-
source: path,
|
|
298
|
-
...options
|
|
299
|
-
});
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
/**
|
|
303
|
-
* Node-only convenience: writes an STL file to disk.
|
|
304
|
-
*
|
|
305
|
-
* The file is encoded entirely in memory before the Node-only filesystem
|
|
306
|
-
* write starts. Browser bundles do not include the filesystem module.
|
|
307
|
-
*
|
|
308
|
-
* @param {string} path Path to write.
|
|
309
|
-
* @param {CjsStlSharedRoot|CjsStlSharedMesh} input Shared JSON root or mesh.
|
|
310
|
-
* @param {CjsStlFormatOptions} [options={}] Writer values.
|
|
311
|
-
* @returns {Promise<string>} The written path.
|
|
312
|
-
* @throws {TypeError|RangeError|Error} If the path, geometry, topology, or options are invalid, or writing fails.
|
|
313
|
-
*/
|
|
314
|
-
static async writeFile(path, input, options = {}) {
|
|
315
|
-
if (typeof path !== "string" || !path) {
|
|
316
|
-
throw new TypeError(`${FORMAT_NAME}: writeFile path must be a non-empty string`);
|
|
317
|
-
}
|
|
318
|
-
const {
|
|
319
|
-
writeFile
|
|
320
|
-
} = await importNodeModule("node:fs/promises");
|
|
321
|
-
const output = CjsStlFormat.write(input, options);
|
|
322
|
-
await writeFile(path, output);
|
|
323
|
-
return path;
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
/**
|
|
327
|
-
* Cheap sniff for STL-like input.
|
|
328
|
-
*
|
|
329
|
-
* @param {string|Uint8Array|ArrayBuffer|DataView} input Candidate STL input.
|
|
330
|
-
* @returns {boolean} True when input looks like STL.
|
|
331
|
-
*/
|
|
332
|
-
static isStl(input) {
|
|
333
|
-
return isStl(input);
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
* Check whether byte-like input has an exact binary STL layout.
|
|
338
|
-
*
|
|
339
|
-
* @param {string|Uint8Array|ArrayBuffer|DataView} input Candidate STL input.
|
|
340
|
-
* @returns {boolean} True when input is binary STL bytes.
|
|
341
|
-
*/
|
|
342
|
-
static isBinaryStl(input) {
|
|
343
|
-
return isBinaryStl(input);
|
|
344
|
-
}
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* Emit targets for this format (canonical frozen enum).
|
|
348
|
-
*/
|
|
349
|
-
static Output = Object.freeze({
|
|
350
|
-
JSON: OUTPUT_JSON,
|
|
351
|
-
STL_JSON: OUTPUT_STL_JSON,
|
|
352
|
-
SHARED: OUTPUT_SHARED,
|
|
353
|
-
GR2: OUTPUT_GR2,
|
|
354
|
-
CMF: OUTPUT_CMF
|
|
355
|
-
});
|
|
356
|
-
static CLASS_KEYS = CLASS_KEYS;
|
|
357
|
-
static type = Object.freeze(["geometry"]);
|
|
358
|
-
static mediaTypes = Object.freeze(["geometry"]);
|
|
359
|
-
static inputTypes = Object.freeze(["stl"]);
|
|
360
|
-
static outputTypes = Object.freeze([OUTPUT_SHARED, OUTPUT_GR2, OUTPUT_CMF]);
|
|
361
|
-
static debugOutputTypes = Object.freeze([OUTPUT_JSON, OUTPUT_STL_JSON]);
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
export { CjsStlFormat, CjsStlFormat as default };
|
|
365
|
-
//# sourceMappingURL=CjsStlFormat.js.map
|
|
1
|
+
import { DEFAULT_VALUES, normalizeValues, validateClassKey, validateClass, readWithValues, writeWithValues, inspectWithValues, toJsonValue, importNodeModule, OUTPUT_CMF, OUTPUT_GR2, OUTPUT_SHARED, OUTPUT_STL_JSON, OUTPUT_JSON, CLASS_KEYS } from './core/helpers.js';
|
|
2
|
+
import { isStl, isBinaryStl } from './core/stl.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Exposed CarbonEngineJS-facing STL format class.
|
|
6
|
+
*
|
|
7
|
+
* Keep this file small and reviewable: STL parsing, writing, printability
|
|
8
|
+
* inspection, option normalization, and JSON hydration live under src/core.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
const FORMAT_NAME = "CjsStlFormat";
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Shared mesh accepted by the STL writer. STL exports only `vertex.position`
|
|
15
|
+
* and triangular `indices[].faces`; all other shared channels are ignored.
|
|
16
|
+
*
|
|
17
|
+
* @typedef {object} CjsStlSharedMesh
|
|
18
|
+
* @property {string} [name] Diagnostic mesh name; `solidName` controls the STL header.
|
|
19
|
+
* @property {{position: ArrayLike<number>, normal?: ArrayLike<number>}} vertex Shared vertex channels.
|
|
20
|
+
* @property {Array<{name?: string, faces: ArrayLike<number>}>} indices Triangle index groups.
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Shared geometry root accepted by the STL writer.
|
|
25
|
+
*
|
|
26
|
+
* @typedef {object} CjsStlSharedRoot
|
|
27
|
+
* @property {Array<CjsStlSharedMesh>} meshes Meshes flattened into one STL solid.
|
|
28
|
+
* @property {string} [grannyFileSource] Optional source label used by inspection.
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Reusable STL read, write, and inspection options.
|
|
33
|
+
*
|
|
34
|
+
* @typedef {object} CjsStlFormatOptions
|
|
35
|
+
* @property {"shared"|"stlJson"|"json"|"gr2"|"cmf"} [emit="stlJson"] Read output contract.
|
|
36
|
+
* @property {string} [source="memory"] Source label stored in read/inspection output.
|
|
37
|
+
* @property {boolean} [binary=true] Whether writes return binary bytes instead of ASCII text.
|
|
38
|
+
* @property {string} [solidName="carbonenginejs"] Sanitized ASCII solid name and binary header label.
|
|
39
|
+
* @property {number} [scale=1] Positive finite multiplier applied to exported positions.
|
|
40
|
+
* @property {boolean} [recalculateNormals=true] Derive facet normals from winding instead of vertex normals.
|
|
41
|
+
* @property {boolean} [weldVertices=false] Weld equal positions while reading STL.
|
|
42
|
+
* @property {number} [weldTolerance=1e-5] Non-negative read/inspection position tolerance.
|
|
43
|
+
* @property {boolean} [skipDegenerate=true] Omit degenerate shared triangles during writes.
|
|
44
|
+
* @property {boolean} [requireWatertight=false] Reject writes with printability topology issues.
|
|
45
|
+
* @property {Record<string, Function>} [classes] Caller constructors used for read hydration.
|
|
46
|
+
*/
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* CarbonEngineJS-facing STL format surface.
|
|
50
|
+
*
|
|
51
|
+
* The Cjs prefix marks this as a JavaScript format/construction boundary.
|
|
52
|
+
* STL is a triangle-only import/export format; the JSON contract is the shared
|
|
53
|
+
* CarbonEngineJS mesh schema.
|
|
54
|
+
*/
|
|
55
|
+
class CjsStlFormat {
|
|
56
|
+
#emit = DEFAULT_VALUES.emit;
|
|
57
|
+
#source = DEFAULT_VALUES.source;
|
|
58
|
+
#binary = DEFAULT_VALUES.binary;
|
|
59
|
+
#solidName = DEFAULT_VALUES.solidName;
|
|
60
|
+
#scale = DEFAULT_VALUES.scale;
|
|
61
|
+
#recalculateNormals = DEFAULT_VALUES.recalculateNormals;
|
|
62
|
+
#weldVertices = DEFAULT_VALUES.weldVertices;
|
|
63
|
+
#weldTolerance = DEFAULT_VALUES.weldTolerance;
|
|
64
|
+
#skipDegenerate = DEFAULT_VALUES.skipDegenerate;
|
|
65
|
+
#requireWatertight = DEFAULT_VALUES.requireWatertight;
|
|
66
|
+
#classes = DEFAULT_VALUES.classes;
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Create a reusable format profile.
|
|
70
|
+
*
|
|
71
|
+
* The instance stores only normalized options; each `Read`, `Write`, or
|
|
72
|
+
* `Inspect` call may provide non-mutating overrides.
|
|
73
|
+
*
|
|
74
|
+
* @param {CjsStlFormatOptions} [options={}] Default format values.
|
|
75
|
+
* @throws {TypeError} If an option, output mode, numeric value, or class map is invalid.
|
|
76
|
+
*/
|
|
77
|
+
constructor(options = {}) {
|
|
78
|
+
this.SetValues(options);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Set format values for this reusable profile.
|
|
83
|
+
*
|
|
84
|
+
* @param {CjsStlFormatOptions} [options={}] Values to merge into the profile.
|
|
85
|
+
* @returns {CjsStlFormat} This format profile.
|
|
86
|
+
* @throws {TypeError} If an option, output mode, numeric value, or class map is invalid.
|
|
87
|
+
*/
|
|
88
|
+
SetValues(options = {}) {
|
|
89
|
+
const values = normalizeValues(this.GetValues(), options, FORMAT_NAME);
|
|
90
|
+
this.#emit = values.emit;
|
|
91
|
+
this.#source = values.source;
|
|
92
|
+
this.#binary = values.binary;
|
|
93
|
+
this.#solidName = values.solidName;
|
|
94
|
+
this.#scale = values.scale;
|
|
95
|
+
this.#recalculateNormals = values.recalculateNormals;
|
|
96
|
+
this.#weldVertices = values.weldVertices;
|
|
97
|
+
this.#weldTolerance = values.weldTolerance;
|
|
98
|
+
this.#skipDegenerate = values.skipDegenerate;
|
|
99
|
+
this.#requireWatertight = values.requireWatertight;
|
|
100
|
+
this.#classes = values.classes;
|
|
101
|
+
return this;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Get this profile's current values, optionally with per-call overrides.
|
|
106
|
+
*
|
|
107
|
+
* @param {CjsStlFormatOptions} [options={}] Optional values to merge into a copy.
|
|
108
|
+
* @returns {CjsStlFormatOptions} A validated copy of the effective values.
|
|
109
|
+
* @throws {TypeError} If an override is invalid.
|
|
110
|
+
*/
|
|
111
|
+
GetValues(options = {}) {
|
|
112
|
+
return normalizeValues({
|
|
113
|
+
emit: this.#emit,
|
|
114
|
+
source: this.#source,
|
|
115
|
+
binary: this.#binary,
|
|
116
|
+
solidName: this.#solidName,
|
|
117
|
+
scale: this.#scale,
|
|
118
|
+
recalculateNormals: this.#recalculateNormals,
|
|
119
|
+
weldVertices: this.#weldVertices,
|
|
120
|
+
weldTolerance: this.#weldTolerance,
|
|
121
|
+
skipDegenerate: this.#skipDegenerate,
|
|
122
|
+
requireWatertight: this.#requireWatertight,
|
|
123
|
+
classes: this.#classes
|
|
124
|
+
}, options, FORMAT_NAME);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Set multiple node-class constructors for this profile.
|
|
129
|
+
*
|
|
130
|
+
* @param {object} [classes] Map of node class keys to constructors.
|
|
131
|
+
* @returns {CjsStlFormat} This format profile.
|
|
132
|
+
*/
|
|
133
|
+
SetClasses(classes = {}) {
|
|
134
|
+
return this.SetValues({
|
|
135
|
+
classes
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Set one node-class constructor for this profile.
|
|
141
|
+
*
|
|
142
|
+
* @param {string} type Node class key.
|
|
143
|
+
* @param {Function|null|undefined} Class Constructor to use, or nullish to delete.
|
|
144
|
+
* @returns {CjsStlFormat} This format profile.
|
|
145
|
+
*/
|
|
146
|
+
SetClass(type, Class) {
|
|
147
|
+
if (Class === null || Class === undefined) {
|
|
148
|
+
validateClassKey(type, FORMAT_NAME);
|
|
149
|
+
const classes = {
|
|
150
|
+
...this.#classes
|
|
151
|
+
};
|
|
152
|
+
delete classes[type];
|
|
153
|
+
this.#classes = classes;
|
|
154
|
+
return this;
|
|
155
|
+
}
|
|
156
|
+
validateClass(type, Class, FORMAT_NAME);
|
|
157
|
+
return this.SetValues({
|
|
158
|
+
classes: {
|
|
159
|
+
[type]: Class
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Get a configured node-class constructor.
|
|
166
|
+
*
|
|
167
|
+
* @param {string} type Node class key.
|
|
168
|
+
* @returns {Function|undefined} The registered constructor, if any.
|
|
169
|
+
*/
|
|
170
|
+
GetClass(type) {
|
|
171
|
+
validateClassKey(type, FORMAT_NAME);
|
|
172
|
+
return this.#classes[type];
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* Whether this format profile has a constructor registered for a node class key.
|
|
177
|
+
*
|
|
178
|
+
* @param {string} type Node class key.
|
|
179
|
+
* @returns {boolean} True when a constructor is registered.
|
|
180
|
+
*/
|
|
181
|
+
HasClass(type) {
|
|
182
|
+
return !!this.GetClass(type);
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* Read STL text/bytes with this profile's values.
|
|
187
|
+
*
|
|
188
|
+
* @param {string|Uint8Array|ArrayBuffer|DataView} input STL text or bytes.
|
|
189
|
+
* @param {object} [options] Per-call value overrides.
|
|
190
|
+
* @returns {object} The shared CarbonEngineJS JSON mesh schema.
|
|
191
|
+
*/
|
|
192
|
+
Read(input, options = {}) {
|
|
193
|
+
return readWithValues(this, input, this.GetValues(options));
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Write shared JSON geometry as STL with this profile's values.
|
|
198
|
+
*
|
|
199
|
+
* Multiple meshes and index groups are flattened in encounter order because
|
|
200
|
+
* STL has no portable material or scene hierarchy. Degenerate triangles are
|
|
201
|
+
* skipped by default. Binary output validates that every coordinate is
|
|
202
|
+
* representable as float32 rather than silently writing infinities.
|
|
203
|
+
*
|
|
204
|
+
* @param {CjsStlSharedRoot|CjsStlSharedMesh} input Shared JSON root or mesh.
|
|
205
|
+
* @param {CjsStlFormatOptions} [options={}] Per-call writer overrides.
|
|
206
|
+
* @returns {string|Uint8Array} ASCII STL text or binary STL bytes.
|
|
207
|
+
* @throws {TypeError|RangeError|Error} If geometry, indices, coordinates, topology, or options are invalid.
|
|
208
|
+
*/
|
|
209
|
+
Write(input, options = {}) {
|
|
210
|
+
return writeWithValues(input, this.GetValues(options));
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Inspect STL text/bytes or shared JSON geometry for printability blockers.
|
|
215
|
+
*
|
|
216
|
+
* @param {any} input STL text/bytes or shared JSON root/mesh.
|
|
217
|
+
* @param {object} [options] Per-call value overrides.
|
|
218
|
+
* @returns {object} Plain printability report.
|
|
219
|
+
*/
|
|
220
|
+
Inspect(input, options = {}) {
|
|
221
|
+
return inspectWithValues(input, this.GetValues(options));
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Convert format output to JSON-compatible data.
|
|
226
|
+
*
|
|
227
|
+
* @param {any} value Format output to convert.
|
|
228
|
+
* @returns {any} Plain JSON-compatible data.
|
|
229
|
+
*/
|
|
230
|
+
ToJSON(value) {
|
|
231
|
+
return toJsonValue(value);
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Static one-shot read. Static methods use camelCase by convention.
|
|
236
|
+
*
|
|
237
|
+
* @param {string|Uint8Array|ArrayBuffer|DataView} input STL text or bytes.
|
|
238
|
+
* @param {object} [options] Format values.
|
|
239
|
+
* @returns {object} The shared CarbonEngineJS JSON mesh schema.
|
|
240
|
+
*/
|
|
241
|
+
static read(input, options = {}) {
|
|
242
|
+
return readWithValues(CjsStlFormat, input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* Static one-shot write.
|
|
247
|
+
*
|
|
248
|
+
* The call is one-shot and does not mutate `input`. Multiple meshes and
|
|
249
|
+
* index groups are flattened into a single STL solid in encounter order.
|
|
250
|
+
*
|
|
251
|
+
* @param {CjsStlSharedRoot|CjsStlSharedMesh} input Shared JSON root or mesh.
|
|
252
|
+
* @param {CjsStlFormatOptions} [options={}] Writer values.
|
|
253
|
+
* @returns {string|Uint8Array} ASCII STL text or binary STL bytes.
|
|
254
|
+
* @throws {TypeError|RangeError|Error} If geometry, indices, coordinates, topology, or options are invalid.
|
|
255
|
+
*/
|
|
256
|
+
static write(input, options = {}) {
|
|
257
|
+
return writeWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Static one-shot inspection.
|
|
262
|
+
*
|
|
263
|
+
* @param {any} input STL text/bytes or shared JSON root/mesh.
|
|
264
|
+
* @param {object} [options] Format values.
|
|
265
|
+
* @returns {object} Plain printability report.
|
|
266
|
+
*/
|
|
267
|
+
static inspect(input, options = {}) {
|
|
268
|
+
return inspectWithValues(input, normalizeValues(DEFAULT_VALUES, options, FORMAT_NAME));
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* Static JSON-compatible conversion.
|
|
273
|
+
*
|
|
274
|
+
* @param {any} value Format output to convert.
|
|
275
|
+
* @returns {any} Plain JSON-compatible data.
|
|
276
|
+
*/
|
|
277
|
+
static toJSON(value) {
|
|
278
|
+
return toJsonValue(value);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Node-only convenience: reads an STL file from disk.
|
|
283
|
+
*
|
|
284
|
+
* @param {string} path Path to an STL file.
|
|
285
|
+
* @param {object} [options] Format values.
|
|
286
|
+
* @returns {Promise<object>} The shared CarbonEngineJS JSON mesh schema.
|
|
287
|
+
*/
|
|
288
|
+
static async readFile(path, options = {}) {
|
|
289
|
+
if (typeof path !== "string" || !path) {
|
|
290
|
+
throw new TypeError(`${FORMAT_NAME}: readFile path must be a non-empty string`);
|
|
291
|
+
}
|
|
292
|
+
const {
|
|
293
|
+
readFile
|
|
294
|
+
} = await importNodeModule("node:fs/promises");
|
|
295
|
+
const input = await readFile(path);
|
|
296
|
+
return CjsStlFormat.read(input, {
|
|
297
|
+
source: path,
|
|
298
|
+
...options
|
|
299
|
+
});
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* Node-only convenience: writes an STL file to disk.
|
|
304
|
+
*
|
|
305
|
+
* The file is encoded entirely in memory before the Node-only filesystem
|
|
306
|
+
* write starts. Browser bundles do not include the filesystem module.
|
|
307
|
+
*
|
|
308
|
+
* @param {string} path Path to write.
|
|
309
|
+
* @param {CjsStlSharedRoot|CjsStlSharedMesh} input Shared JSON root or mesh.
|
|
310
|
+
* @param {CjsStlFormatOptions} [options={}] Writer values.
|
|
311
|
+
* @returns {Promise<string>} The written path.
|
|
312
|
+
* @throws {TypeError|RangeError|Error} If the path, geometry, topology, or options are invalid, or writing fails.
|
|
313
|
+
*/
|
|
314
|
+
static async writeFile(path, input, options = {}) {
|
|
315
|
+
if (typeof path !== "string" || !path) {
|
|
316
|
+
throw new TypeError(`${FORMAT_NAME}: writeFile path must be a non-empty string`);
|
|
317
|
+
}
|
|
318
|
+
const {
|
|
319
|
+
writeFile
|
|
320
|
+
} = await importNodeModule("node:fs/promises");
|
|
321
|
+
const output = CjsStlFormat.write(input, options);
|
|
322
|
+
await writeFile(path, output);
|
|
323
|
+
return path;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Cheap sniff for STL-like input.
|
|
328
|
+
*
|
|
329
|
+
* @param {string|Uint8Array|ArrayBuffer|DataView} input Candidate STL input.
|
|
330
|
+
* @returns {boolean} True when input looks like STL.
|
|
331
|
+
*/
|
|
332
|
+
static isStl(input) {
|
|
333
|
+
return isStl(input);
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* Check whether byte-like input has an exact binary STL layout.
|
|
338
|
+
*
|
|
339
|
+
* @param {string|Uint8Array|ArrayBuffer|DataView} input Candidate STL input.
|
|
340
|
+
* @returns {boolean} True when input is binary STL bytes.
|
|
341
|
+
*/
|
|
342
|
+
static isBinaryStl(input) {
|
|
343
|
+
return isBinaryStl(input);
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* Emit targets for this format (canonical frozen enum).
|
|
348
|
+
*/
|
|
349
|
+
static Output = Object.freeze({
|
|
350
|
+
JSON: OUTPUT_JSON,
|
|
351
|
+
STL_JSON: OUTPUT_STL_JSON,
|
|
352
|
+
SHARED: OUTPUT_SHARED,
|
|
353
|
+
GR2: OUTPUT_GR2,
|
|
354
|
+
CMF: OUTPUT_CMF
|
|
355
|
+
});
|
|
356
|
+
static CLASS_KEYS = CLASS_KEYS;
|
|
357
|
+
static type = Object.freeze(["geometry"]);
|
|
358
|
+
static mediaTypes = Object.freeze(["geometry"]);
|
|
359
|
+
static inputTypes = Object.freeze(["stl"]);
|
|
360
|
+
static outputTypes = Object.freeze([OUTPUT_SHARED, OUTPUT_GR2, OUTPUT_CMF]);
|
|
361
|
+
static debugOutputTypes = Object.freeze([OUTPUT_JSON, OUTPUT_STL_JSON]);
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
export { CjsStlFormat, CjsStlFormat as default };
|
|
365
|
+
//# sourceMappingURL=CjsStlFormat.js.map
|