@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,497 +1,497 @@
|
|
|
1
|
-
import { convertGr2SkeletonsAndAnimations } from './core/gr2Anim.js';
|
|
2
|
-
import { packGraphBuffers } from './core/pack.js';
|
|
3
|
-
import { buildCmfFromShared } from './core/shared.js';
|
|
4
|
-
import { writeCmf, writeCmfAsync } from './core/writer.js';
|
|
5
|
-
import { DEFAULT_VALUES, normalizeValues, validateClassKey, validateClass, readWithValues, loadNativeWithValues, loadSharedWithValues, readWithValuesAsync, readRawInput, readRawInputAsync, inspectRawCmfResult, toJsonValue } from './core/helpers.js';
|
|
6
|
-
import { OUTPUT_SHARED, OUTPUT_RAW, OUTPUT_NATIVE, OUTPUT_GR2, OUTPUT_CMF_JSON, OUTPUT_CMF, OUTPUT_JSON, CLASS_KEYS } from './core/constants.js';
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* Exposed CarbonEngineJS-facing CMF format class.
|
|
10
|
-
*
|
|
11
|
-
* CMF is expected to become the common CarbonEngineJS geometry container, so
|
|
12
|
-
* this public wrapper keeps parsing details under core/ and exposes CMF-native
|
|
13
|
-
* data by default.
|
|
14
|
-
*/
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* CarbonEngineJS-facing CMF reader.
|
|
19
|
-
*
|
|
20
|
-
* The Cjs prefix marks this as a JavaScript format/construction boundary. It
|
|
21
|
-
* can load CMF files, load CMF-native JSON, construct CMF-native data from
|
|
22
|
-
* shared geometry, emit shared geometry when requested, or hydrate
|
|
23
|
-
* caller-supplied CarbonEngineJS-style classes.
|
|
24
|
-
*/
|
|
25
|
-
class CjsCmfFormat {
|
|
26
|
-
#emit = DEFAULT_VALUES.emit;
|
|
27
|
-
#validateCrc = DEFAULT_VALUES.validateCrc;
|
|
28
|
-
#decodeBuffers = DEFAULT_VALUES.decodeBuffers;
|
|
29
|
-
#classes = {};
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Create a reusable format profile.
|
|
33
|
-
*
|
|
34
|
-
* @param {object} [options] Default format/build values.
|
|
35
|
-
*/
|
|
36
|
-
constructor(options = {}) {
|
|
37
|
-
this.SetValues(options);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* Set format values for this reusable profile.
|
|
42
|
-
*
|
|
43
|
-
* @param {object} [options] Values to merge into the profile.
|
|
44
|
-
* @returns {CjsCmfFormat} This format profile.
|
|
45
|
-
*/
|
|
46
|
-
SetValues(options = {}) {
|
|
47
|
-
const values = normalizeValues(this.GetValues(), options);
|
|
48
|
-
this.#emit = values.emit;
|
|
49
|
-
this.#validateCrc = values.validateCrc;
|
|
50
|
-
this.#decodeBuffers = values.decodeBuffers;
|
|
51
|
-
this.#classes = values.classes;
|
|
52
|
-
return this;
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Get this profile's current values, optionally with per-call overrides.
|
|
57
|
-
*
|
|
58
|
-
* @param {object} [options] Optional values to merge into a copy.
|
|
59
|
-
* @returns {object} A copy of the effective values.
|
|
60
|
-
*/
|
|
61
|
-
GetValues(options = {}) {
|
|
62
|
-
return normalizeValues({
|
|
63
|
-
emit: this.#emit,
|
|
64
|
-
validateCrc: this.#validateCrc,
|
|
65
|
-
decodeBuffers: this.#decodeBuffers,
|
|
66
|
-
classes: this.#classes
|
|
67
|
-
}, options);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* Set multiple CMF JSON node constructors for this profile.
|
|
72
|
-
*
|
|
73
|
-
* @param {object} [classes] Map of node class keys to constructors.
|
|
74
|
-
* @returns {CjsCmfFormat} This format profile.
|
|
75
|
-
*/
|
|
76
|
-
SetClasses(classes = {}) {
|
|
77
|
-
return this.SetValues({
|
|
78
|
-
classes
|
|
79
|
-
});
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* Set a CMF JSON node constructor for this profile.
|
|
84
|
-
*
|
|
85
|
-
* @param {string} type Node class key.
|
|
86
|
-
* @param {Function|null|undefined} Class Constructor to use, or nullish to delete.
|
|
87
|
-
* @returns {CjsCmfFormat} This format profile.
|
|
88
|
-
*/
|
|
89
|
-
SetClass(type, Class) {
|
|
90
|
-
validateClassKey(type);
|
|
91
|
-
if (Class === null || Class === undefined) {
|
|
92
|
-
delete this.#classes[type];
|
|
93
|
-
return this;
|
|
94
|
-
}
|
|
95
|
-
validateClass(type, Class);
|
|
96
|
-
this.#classes = {
|
|
97
|
-
...this.#classes,
|
|
98
|
-
[type]: Class
|
|
99
|
-
};
|
|
100
|
-
return this;
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Get a configured CMF JSON node constructor.
|
|
105
|
-
*
|
|
106
|
-
* @param {string} type Node class key.
|
|
107
|
-
* @returns {Function|undefined}
|
|
108
|
-
*/
|
|
109
|
-
GetClass(type) {
|
|
110
|
-
validateClassKey(type);
|
|
111
|
-
return this.#classes[type];
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
/**
|
|
115
|
-
* Whether this reader has a constructor for a CMF JSON node key.
|
|
116
|
-
*
|
|
117
|
-
* @param {string} type Node class key.
|
|
118
|
-
* @returns {boolean}
|
|
119
|
-
*/
|
|
120
|
-
HasClass(type) {
|
|
121
|
-
return !!this.GetClass(type);
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Parse a .cmf buffer and return CMF-native JSON by default, shared
|
|
126
|
-
* geometry when `emit` is "shared", or raw parsed data when `emit` is
|
|
127
|
-
* "raw".
|
|
128
|
-
*
|
|
129
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
130
|
-
* @param {object} [options] Per-call values.
|
|
131
|
-
* @returns {object}
|
|
132
|
-
*/
|
|
133
|
-
Read(input, options = {}) {
|
|
134
|
-
return readWithValues(this, input, this.GetValues(options));
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Load CMF-native JSON. Shared geometry uses LoadShared.
|
|
139
|
-
*
|
|
140
|
-
* @param {object} input CMF-native JSON root.
|
|
141
|
-
* @param {object} [options] Per-call values.
|
|
142
|
-
* @returns {object}
|
|
143
|
-
*/
|
|
144
|
-
Load(input, options = {}) {
|
|
145
|
-
return loadNativeWithValues(input, this.GetValues(options));
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
/**
|
|
149
|
-
* Build CMF-native JSON from shared CarbonEngineJS geometry.
|
|
150
|
-
*
|
|
151
|
-
* @param {object} input Shared geometry root or mesh.
|
|
152
|
-
* @param {object} [options] Per-call values.
|
|
153
|
-
* @returns {object}
|
|
154
|
-
*/
|
|
155
|
-
LoadShared(input, options = {}) {
|
|
156
|
-
return loadSharedWithValues(input, this.GetValues(options));
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
/**
|
|
160
|
-
* Parse a .cmf buffer and emit the shared deinterleaved mesh graph.
|
|
161
|
-
*
|
|
162
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
163
|
-
* @param {object} [options] Per-call values.
|
|
164
|
-
* @returns {object}
|
|
165
|
-
*/
|
|
166
|
-
ReadShared(input, options = {}) {
|
|
167
|
-
return this.Read(input, {
|
|
168
|
-
...options,
|
|
169
|
-
emit: OUTPUT_SHARED
|
|
170
|
-
});
|
|
171
|
-
}
|
|
172
|
-
|
|
173
|
-
/**
|
|
174
|
-
* Parse a .cmf buffer with async meshoptimizer initialization support.
|
|
175
|
-
*
|
|
176
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
177
|
-
* @param {object} [options] Per-call values.
|
|
178
|
-
* @returns {Promise<object>}
|
|
179
|
-
*/
|
|
180
|
-
async ReadAsync(input, options = {}) {
|
|
181
|
-
return readWithValuesAsync(this, input, this.GetValues(options));
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* Parse a .cmf buffer asynchronously and emit the shared deinterleaved mesh graph.
|
|
186
|
-
*
|
|
187
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
188
|
-
* @param {object} [options] Per-call values.
|
|
189
|
-
* @returns {Promise<object>}
|
|
190
|
-
*/
|
|
191
|
-
async ReadSharedAsync(input, options = {}) {
|
|
192
|
-
return this.ReadAsync(input, {
|
|
193
|
-
...options,
|
|
194
|
-
emit: OUTPUT_SHARED
|
|
195
|
-
});
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
/**
|
|
199
|
-
* Parse a .cmf buffer into the raw parsed CMF graph.
|
|
200
|
-
*
|
|
201
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
202
|
-
* @param {object} [options] Per-call values.
|
|
203
|
-
* @returns {object}
|
|
204
|
-
*/
|
|
205
|
-
ReadRaw(input, options = {}) {
|
|
206
|
-
return readRawInput(input, this.GetValues(options));
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* Parse a .cmf buffer into the raw parsed CMF graph with async
|
|
211
|
-
* meshoptimizer initialization support.
|
|
212
|
-
*
|
|
213
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
214
|
-
* @param {object} [options] Per-call values.
|
|
215
|
-
* @returns {Promise<object>}
|
|
216
|
-
*/
|
|
217
|
-
async ReadRawAsync(input, options = {}) {
|
|
218
|
-
return readRawInputAsync(input, this.GetValues(options));
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* Return a stable, lightweight summary for a CMF buffer or raw result.
|
|
223
|
-
*
|
|
224
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
225
|
-
* @param {object} [options] Per-call values.
|
|
226
|
-
* @returns {object}
|
|
227
|
-
*/
|
|
228
|
-
Inspect(input, options = {}) {
|
|
229
|
-
return inspectRawCmfResult(input, this.GetValues(options));
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
/**
|
|
233
|
-
* Convert format output to plain JSON-compatible data.
|
|
234
|
-
*
|
|
235
|
-
* @param {object} value Format output to convert.
|
|
236
|
-
* @returns {any} Plain JSON-compatible data.
|
|
237
|
-
*/
|
|
238
|
-
ToJSON(value) {
|
|
239
|
-
return toJsonValue(value);
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
/**
|
|
243
|
-
* Serialize a CMF-native graph to binary .cmf bytes without compression.
|
|
244
|
-
*
|
|
245
|
-
* Use WriteAsync for meshoptimizer-compressed GPU sections. The graph
|
|
246
|
-
* shape matches Read output: meshes/skeletons/animations plus optional
|
|
247
|
-
* metadata and a `buffers` list supplying uncompressed bytes per
|
|
248
|
-
* BufferView index.
|
|
249
|
-
*
|
|
250
|
-
* @param {object} graph CMF-native graph.
|
|
251
|
-
* @param {object} [options] Writer options (`compress`).
|
|
252
|
-
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
253
|
-
*/
|
|
254
|
-
Write(graph, options = {}) {
|
|
255
|
-
return writeCmf(graph, options);
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
/**
|
|
259
|
-
* Serialize a CMF-native graph to binary .cmf bytes with meshoptimizer
|
|
260
|
-
* compression enabled by default.
|
|
261
|
-
*
|
|
262
|
-
* @param {object} graph CMF-native graph.
|
|
263
|
-
* @param {object} [options] Writer options (`compress`, default true).
|
|
264
|
-
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
265
|
-
*/
|
|
266
|
-
async WriteAsync(graph, options = {}) {
|
|
267
|
-
return writeCmfAsync(graph, options);
|
|
268
|
-
}
|
|
269
|
-
|
|
270
|
-
/**
|
|
271
|
-
* Serialize shared CarbonEngineJS geometry (e.g. from the GR2/OBJ/glTF
|
|
272
|
-
* readers) straight to binary .cmf bytes without compression.
|
|
273
|
-
*
|
|
274
|
-
* Channels are interleaved into GPU buffers per the generated
|
|
275
|
-
* declaration. Skeletons/animations must already be CMF-native shaped.
|
|
276
|
-
*
|
|
277
|
-
* @param {object} input Shared geometry root or mesh.
|
|
278
|
-
* @param {object} [options] Writer options (`compress`).
|
|
279
|
-
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
280
|
-
*/
|
|
281
|
-
WriteShared(input, options = {}) {
|
|
282
|
-
return CjsCmfFormat.writeShared(input, options);
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
/**
|
|
286
|
-
* Serialize shared CarbonEngineJS geometry to compressed .cmf bytes.
|
|
287
|
-
*
|
|
288
|
-
* @param {object} input Shared geometry root or mesh.
|
|
289
|
-
* @param {object} [options] Writer options (`compress`, default true).
|
|
290
|
-
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
291
|
-
*/
|
|
292
|
-
async WriteSharedAsync(input, options = {}) {
|
|
293
|
-
return CjsCmfFormat.writeSharedAsync(input, options);
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* Static one-shot read. Static methods use camelCase by convention.
|
|
298
|
-
*
|
|
299
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
300
|
-
* @param {object} [options] Reader values.
|
|
301
|
-
* @returns {object}
|
|
302
|
-
*/
|
|
303
|
-
static read(input, options = {}) {
|
|
304
|
-
return readWithValues(CjsCmfFormat, input, normalizeValues(DEFAULT_VALUES, options));
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
/**
|
|
308
|
-
* Static one-shot CMF-native JSON load.
|
|
309
|
-
*
|
|
310
|
-
* @param {object} input CMF-native JSON root.
|
|
311
|
-
* @param {object} [options] Reader values.
|
|
312
|
-
* @returns {object}
|
|
313
|
-
*/
|
|
314
|
-
static load(input, options = {}) {
|
|
315
|
-
return loadNativeWithValues(input, normalizeValues(DEFAULT_VALUES, options));
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
/**
|
|
319
|
-
* Static one-shot shared geometry to CMF-native JSON construction.
|
|
320
|
-
*
|
|
321
|
-
* @param {object} input Shared geometry root or mesh.
|
|
322
|
-
* @param {object} [options] Reader values.
|
|
323
|
-
* @returns {object}
|
|
324
|
-
*/
|
|
325
|
-
static loadShared(input, options = {}) {
|
|
326
|
-
return loadSharedWithValues(input, normalizeValues(DEFAULT_VALUES, options));
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
/**
|
|
330
|
-
* Static one-shot read to shared geometry.
|
|
331
|
-
*
|
|
332
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
333
|
-
* @param {object} [options] Reader values.
|
|
334
|
-
* @returns {object}
|
|
335
|
-
*/
|
|
336
|
-
static readShared(input, options = {}) {
|
|
337
|
-
return CjsCmfFormat.read(input, {
|
|
338
|
-
...options,
|
|
339
|
-
emit: OUTPUT_SHARED
|
|
340
|
-
});
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
/**
|
|
344
|
-
* Static one-shot async read.
|
|
345
|
-
*
|
|
346
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
347
|
-
* @param {object} [options] Reader values.
|
|
348
|
-
* @returns {Promise<object>}
|
|
349
|
-
*/
|
|
350
|
-
static async readAsync(input, options = {}) {
|
|
351
|
-
return readWithValuesAsync(CjsCmfFormat, input, normalizeValues(DEFAULT_VALUES, options));
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* Static one-shot async read to shared geometry.
|
|
356
|
-
*
|
|
357
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
358
|
-
* @param {object} [options] Reader values.
|
|
359
|
-
* @returns {Promise<object>}
|
|
360
|
-
*/
|
|
361
|
-
static async readSharedAsync(input, options = {}) {
|
|
362
|
-
return CjsCmfFormat.readAsync(input, {
|
|
363
|
-
...options,
|
|
364
|
-
emit: OUTPUT_SHARED
|
|
365
|
-
});
|
|
366
|
-
}
|
|
367
|
-
|
|
368
|
-
/**
|
|
369
|
-
* Static one-shot raw read.
|
|
370
|
-
*
|
|
371
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
372
|
-
* @param {object} [options] Reader values.
|
|
373
|
-
* @returns {object}
|
|
374
|
-
*/
|
|
375
|
-
static readRaw(input, options = {}) {
|
|
376
|
-
return readRawInput(input, normalizeValues(DEFAULT_VALUES, options));
|
|
377
|
-
}
|
|
378
|
-
|
|
379
|
-
/**
|
|
380
|
-
* Static one-shot async raw read.
|
|
381
|
-
*
|
|
382
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
383
|
-
* @param {object} [options] Reader values.
|
|
384
|
-
* @returns {Promise<object>}
|
|
385
|
-
*/
|
|
386
|
-
static async readRawAsync(input, options = {}) {
|
|
387
|
-
return readRawInputAsync(input, normalizeValues(DEFAULT_VALUES, options));
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Static one-shot inspection.
|
|
392
|
-
*
|
|
393
|
-
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
394
|
-
* @param {object} [options] Reader values.
|
|
395
|
-
* @returns {object}
|
|
396
|
-
*/
|
|
397
|
-
static inspect(input, options = {}) {
|
|
398
|
-
return inspectRawCmfResult(input, normalizeValues(DEFAULT_VALUES, options));
|
|
399
|
-
}
|
|
400
|
-
|
|
401
|
-
/**
|
|
402
|
-
* Static JSON-compatible conversion.
|
|
403
|
-
*
|
|
404
|
-
* @param {object} value Format output to convert.
|
|
405
|
-
* @returns {any} Plain JSON-compatible data.
|
|
406
|
-
*/
|
|
407
|
-
static toJSON(value) {
|
|
408
|
-
return toJsonValue(value);
|
|
409
|
-
}
|
|
410
|
-
|
|
411
|
-
/**
|
|
412
|
-
* Static one-shot binary write without compression.
|
|
413
|
-
*
|
|
414
|
-
* @param {object} graph CMF-native graph.
|
|
415
|
-
* @param {object} [options] Writer options (`compress`).
|
|
416
|
-
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
417
|
-
*/
|
|
418
|
-
static write(graph, options = {}) {
|
|
419
|
-
return writeCmf(graph, options);
|
|
420
|
-
}
|
|
421
|
-
|
|
422
|
-
/**
|
|
423
|
-
* Static one-shot binary write with meshoptimizer compression enabled by
|
|
424
|
-
* default.
|
|
425
|
-
*
|
|
426
|
-
* @param {object} graph CMF-native graph.
|
|
427
|
-
* @param {object} [options] Writer options (`compress`, default true).
|
|
428
|
-
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
429
|
-
*/
|
|
430
|
-
static async writeAsync(graph, options = {}) {
|
|
431
|
-
return writeCmfAsync(graph, options);
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
/**
|
|
435
|
-
* Static one-shot shared-geometry write without compression.
|
|
436
|
-
*
|
|
437
|
-
* Equivalent to `loadShared` + buffer packing + `write`; this is the
|
|
438
|
-
* GR2/OBJ/glTF → CMF conversion entry point.
|
|
439
|
-
*
|
|
440
|
-
* @param {object} input Shared geometry root or mesh.
|
|
441
|
-
* @param {object} [options] Writer options (`compress`).
|
|
442
|
-
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
443
|
-
*/
|
|
444
|
-
static writeShared(input, options = {}) {
|
|
445
|
-
const root = input && input.meshes ? input : {
|
|
446
|
-
meshes: [input]
|
|
447
|
-
};
|
|
448
|
-
const converted = convertGr2SkeletonsAndAnimations(root, options);
|
|
449
|
-
const packed = packGraphBuffers(buildCmfFromShared(converted));
|
|
450
|
-
return writeCmf({
|
|
451
|
-
...packed.graph,
|
|
452
|
-
buffers: packed.buffers
|
|
453
|
-
}, options);
|
|
454
|
-
}
|
|
455
|
-
|
|
456
|
-
/**
|
|
457
|
-
* Static one-shot shared-geometry write with meshoptimizer compression
|
|
458
|
-
* enabled by default.
|
|
459
|
-
*
|
|
460
|
-
* @param {object} input Shared geometry root or mesh.
|
|
461
|
-
* @param {object} [options] Writer options (`compress`, default true).
|
|
462
|
-
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
463
|
-
*/
|
|
464
|
-
static async writeSharedAsync(input, options = {}) {
|
|
465
|
-
const root = input && input.meshes ? input : {
|
|
466
|
-
meshes: [input]
|
|
467
|
-
};
|
|
468
|
-
const converted = convertGr2SkeletonsAndAnimations(root, options);
|
|
469
|
-
const packed = packGraphBuffers(buildCmfFromShared(converted));
|
|
470
|
-
return writeCmfAsync({
|
|
471
|
-
...packed.graph,
|
|
472
|
-
buffers: packed.buffers
|
|
473
|
-
}, options);
|
|
474
|
-
}
|
|
475
|
-
|
|
476
|
-
/**
|
|
477
|
-
* Emit targets for this format (canonical frozen enum).
|
|
478
|
-
*/
|
|
479
|
-
static Output = Object.freeze({
|
|
480
|
-
JSON: OUTPUT_JSON,
|
|
481
|
-
CMF: OUTPUT_CMF,
|
|
482
|
-
CMF_JSON: OUTPUT_CMF_JSON,
|
|
483
|
-
GR2: OUTPUT_GR2,
|
|
484
|
-
NATIVE: OUTPUT_NATIVE,
|
|
485
|
-
RAW: OUTPUT_RAW,
|
|
486
|
-
SHARED: OUTPUT_SHARED
|
|
487
|
-
});
|
|
488
|
-
static CLASS_KEYS = CLASS_KEYS;
|
|
489
|
-
static type = Object.freeze(["geometry"]);
|
|
490
|
-
static mediaTypes = Object.freeze(["geometry"]);
|
|
491
|
-
static inputTypes = Object.freeze(["cmf"]);
|
|
492
|
-
static outputTypes = Object.freeze([OUTPUT_CMF, OUTPUT_GR2, OUTPUT_SHARED]);
|
|
493
|
-
static debugOutputTypes = Object.freeze([OUTPUT_JSON, OUTPUT_CMF_JSON, OUTPUT_RAW]);
|
|
494
|
-
}
|
|
495
|
-
|
|
496
|
-
export { CjsCmfFormat, CjsCmfFormat as default };
|
|
497
|
-
//# sourceMappingURL=CjsCmfFormat.js.map
|
|
1
|
+
import { convertGr2SkeletonsAndAnimations } from './core/gr2Anim.js';
|
|
2
|
+
import { packGraphBuffers } from './core/pack.js';
|
|
3
|
+
import { buildCmfFromShared } from './core/shared.js';
|
|
4
|
+
import { writeCmf, writeCmfAsync } from './core/writer.js';
|
|
5
|
+
import { DEFAULT_VALUES, normalizeValues, validateClassKey, validateClass, readWithValues, loadNativeWithValues, loadSharedWithValues, readWithValuesAsync, readRawInput, readRawInputAsync, inspectRawCmfResult, toJsonValue } from './core/helpers.js';
|
|
6
|
+
import { OUTPUT_SHARED, OUTPUT_RAW, OUTPUT_NATIVE, OUTPUT_GR2, OUTPUT_CMF_JSON, OUTPUT_CMF, OUTPUT_JSON, CLASS_KEYS } from './core/constants.js';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Exposed CarbonEngineJS-facing CMF format class.
|
|
10
|
+
*
|
|
11
|
+
* CMF is expected to become the common CarbonEngineJS geometry container, so
|
|
12
|
+
* this public wrapper keeps parsing details under core/ and exposes CMF-native
|
|
13
|
+
* data by default.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* CarbonEngineJS-facing CMF reader.
|
|
19
|
+
*
|
|
20
|
+
* The Cjs prefix marks this as a JavaScript format/construction boundary. It
|
|
21
|
+
* can load CMF files, load CMF-native JSON, construct CMF-native data from
|
|
22
|
+
* shared geometry, emit shared geometry when requested, or hydrate
|
|
23
|
+
* caller-supplied CarbonEngineJS-style classes.
|
|
24
|
+
*/
|
|
25
|
+
class CjsCmfFormat {
|
|
26
|
+
#emit = DEFAULT_VALUES.emit;
|
|
27
|
+
#validateCrc = DEFAULT_VALUES.validateCrc;
|
|
28
|
+
#decodeBuffers = DEFAULT_VALUES.decodeBuffers;
|
|
29
|
+
#classes = {};
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Create a reusable format profile.
|
|
33
|
+
*
|
|
34
|
+
* @param {object} [options] Default format/build values.
|
|
35
|
+
*/
|
|
36
|
+
constructor(options = {}) {
|
|
37
|
+
this.SetValues(options);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Set format values for this reusable profile.
|
|
42
|
+
*
|
|
43
|
+
* @param {object} [options] Values to merge into the profile.
|
|
44
|
+
* @returns {CjsCmfFormat} This format profile.
|
|
45
|
+
*/
|
|
46
|
+
SetValues(options = {}) {
|
|
47
|
+
const values = normalizeValues(this.GetValues(), options);
|
|
48
|
+
this.#emit = values.emit;
|
|
49
|
+
this.#validateCrc = values.validateCrc;
|
|
50
|
+
this.#decodeBuffers = values.decodeBuffers;
|
|
51
|
+
this.#classes = values.classes;
|
|
52
|
+
return this;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Get this profile's current values, optionally with per-call overrides.
|
|
57
|
+
*
|
|
58
|
+
* @param {object} [options] Optional values to merge into a copy.
|
|
59
|
+
* @returns {object} A copy of the effective values.
|
|
60
|
+
*/
|
|
61
|
+
GetValues(options = {}) {
|
|
62
|
+
return normalizeValues({
|
|
63
|
+
emit: this.#emit,
|
|
64
|
+
validateCrc: this.#validateCrc,
|
|
65
|
+
decodeBuffers: this.#decodeBuffers,
|
|
66
|
+
classes: this.#classes
|
|
67
|
+
}, options);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Set multiple CMF JSON node constructors for this profile.
|
|
72
|
+
*
|
|
73
|
+
* @param {object} [classes] Map of node class keys to constructors.
|
|
74
|
+
* @returns {CjsCmfFormat} This format profile.
|
|
75
|
+
*/
|
|
76
|
+
SetClasses(classes = {}) {
|
|
77
|
+
return this.SetValues({
|
|
78
|
+
classes
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Set a CMF JSON node constructor for this profile.
|
|
84
|
+
*
|
|
85
|
+
* @param {string} type Node class key.
|
|
86
|
+
* @param {Function|null|undefined} Class Constructor to use, or nullish to delete.
|
|
87
|
+
* @returns {CjsCmfFormat} This format profile.
|
|
88
|
+
*/
|
|
89
|
+
SetClass(type, Class) {
|
|
90
|
+
validateClassKey(type);
|
|
91
|
+
if (Class === null || Class === undefined) {
|
|
92
|
+
delete this.#classes[type];
|
|
93
|
+
return this;
|
|
94
|
+
}
|
|
95
|
+
validateClass(type, Class);
|
|
96
|
+
this.#classes = {
|
|
97
|
+
...this.#classes,
|
|
98
|
+
[type]: Class
|
|
99
|
+
};
|
|
100
|
+
return this;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Get a configured CMF JSON node constructor.
|
|
105
|
+
*
|
|
106
|
+
* @param {string} type Node class key.
|
|
107
|
+
* @returns {Function|undefined}
|
|
108
|
+
*/
|
|
109
|
+
GetClass(type) {
|
|
110
|
+
validateClassKey(type);
|
|
111
|
+
return this.#classes[type];
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Whether this reader has a constructor for a CMF JSON node key.
|
|
116
|
+
*
|
|
117
|
+
* @param {string} type Node class key.
|
|
118
|
+
* @returns {boolean}
|
|
119
|
+
*/
|
|
120
|
+
HasClass(type) {
|
|
121
|
+
return !!this.GetClass(type);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Parse a .cmf buffer and return CMF-native JSON by default, shared
|
|
126
|
+
* geometry when `emit` is "shared", or raw parsed data when `emit` is
|
|
127
|
+
* "raw".
|
|
128
|
+
*
|
|
129
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
130
|
+
* @param {object} [options] Per-call values.
|
|
131
|
+
* @returns {object}
|
|
132
|
+
*/
|
|
133
|
+
Read(input, options = {}) {
|
|
134
|
+
return readWithValues(this, input, this.GetValues(options));
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Load CMF-native JSON. Shared geometry uses LoadShared.
|
|
139
|
+
*
|
|
140
|
+
* @param {object} input CMF-native JSON root.
|
|
141
|
+
* @param {object} [options] Per-call values.
|
|
142
|
+
* @returns {object}
|
|
143
|
+
*/
|
|
144
|
+
Load(input, options = {}) {
|
|
145
|
+
return loadNativeWithValues(input, this.GetValues(options));
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* Build CMF-native JSON from shared CarbonEngineJS geometry.
|
|
150
|
+
*
|
|
151
|
+
* @param {object} input Shared geometry root or mesh.
|
|
152
|
+
* @param {object} [options] Per-call values.
|
|
153
|
+
* @returns {object}
|
|
154
|
+
*/
|
|
155
|
+
LoadShared(input, options = {}) {
|
|
156
|
+
return loadSharedWithValues(input, this.GetValues(options));
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* Parse a .cmf buffer and emit the shared deinterleaved mesh graph.
|
|
161
|
+
*
|
|
162
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
163
|
+
* @param {object} [options] Per-call values.
|
|
164
|
+
* @returns {object}
|
|
165
|
+
*/
|
|
166
|
+
ReadShared(input, options = {}) {
|
|
167
|
+
return this.Read(input, {
|
|
168
|
+
...options,
|
|
169
|
+
emit: OUTPUT_SHARED
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Parse a .cmf buffer with async meshoptimizer initialization support.
|
|
175
|
+
*
|
|
176
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
177
|
+
* @param {object} [options] Per-call values.
|
|
178
|
+
* @returns {Promise<object>}
|
|
179
|
+
*/
|
|
180
|
+
async ReadAsync(input, options = {}) {
|
|
181
|
+
return readWithValuesAsync(this, input, this.GetValues(options));
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Parse a .cmf buffer asynchronously and emit the shared deinterleaved mesh graph.
|
|
186
|
+
*
|
|
187
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
188
|
+
* @param {object} [options] Per-call values.
|
|
189
|
+
* @returns {Promise<object>}
|
|
190
|
+
*/
|
|
191
|
+
async ReadSharedAsync(input, options = {}) {
|
|
192
|
+
return this.ReadAsync(input, {
|
|
193
|
+
...options,
|
|
194
|
+
emit: OUTPUT_SHARED
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Parse a .cmf buffer into the raw parsed CMF graph.
|
|
200
|
+
*
|
|
201
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
202
|
+
* @param {object} [options] Per-call values.
|
|
203
|
+
* @returns {object}
|
|
204
|
+
*/
|
|
205
|
+
ReadRaw(input, options = {}) {
|
|
206
|
+
return readRawInput(input, this.GetValues(options));
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* Parse a .cmf buffer into the raw parsed CMF graph with async
|
|
211
|
+
* meshoptimizer initialization support.
|
|
212
|
+
*
|
|
213
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
214
|
+
* @param {object} [options] Per-call values.
|
|
215
|
+
* @returns {Promise<object>}
|
|
216
|
+
*/
|
|
217
|
+
async ReadRawAsync(input, options = {}) {
|
|
218
|
+
return readRawInputAsync(input, this.GetValues(options));
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Return a stable, lightweight summary for a CMF buffer or raw result.
|
|
223
|
+
*
|
|
224
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
225
|
+
* @param {object} [options] Per-call values.
|
|
226
|
+
* @returns {object}
|
|
227
|
+
*/
|
|
228
|
+
Inspect(input, options = {}) {
|
|
229
|
+
return inspectRawCmfResult(input, this.GetValues(options));
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* Convert format output to plain JSON-compatible data.
|
|
234
|
+
*
|
|
235
|
+
* @param {object} value Format output to convert.
|
|
236
|
+
* @returns {any} Plain JSON-compatible data.
|
|
237
|
+
*/
|
|
238
|
+
ToJSON(value) {
|
|
239
|
+
return toJsonValue(value);
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Serialize a CMF-native graph to binary .cmf bytes without compression.
|
|
244
|
+
*
|
|
245
|
+
* Use WriteAsync for meshoptimizer-compressed GPU sections. The graph
|
|
246
|
+
* shape matches Read output: meshes/skeletons/animations plus optional
|
|
247
|
+
* metadata and a `buffers` list supplying uncompressed bytes per
|
|
248
|
+
* BufferView index.
|
|
249
|
+
*
|
|
250
|
+
* @param {object} graph CMF-native graph.
|
|
251
|
+
* @param {object} [options] Writer options (`compress`).
|
|
252
|
+
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
253
|
+
*/
|
|
254
|
+
Write(graph, options = {}) {
|
|
255
|
+
return writeCmf(graph, options);
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Serialize a CMF-native graph to binary .cmf bytes with meshoptimizer
|
|
260
|
+
* compression enabled by default.
|
|
261
|
+
*
|
|
262
|
+
* @param {object} graph CMF-native graph.
|
|
263
|
+
* @param {object} [options] Writer options (`compress`, default true).
|
|
264
|
+
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
265
|
+
*/
|
|
266
|
+
async WriteAsync(graph, options = {}) {
|
|
267
|
+
return writeCmfAsync(graph, options);
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
/**
|
|
271
|
+
* Serialize shared CarbonEngineJS geometry (e.g. from the GR2/OBJ/glTF
|
|
272
|
+
* readers) straight to binary .cmf bytes without compression.
|
|
273
|
+
*
|
|
274
|
+
* Channels are interleaved into GPU buffers per the generated
|
|
275
|
+
* declaration. Skeletons/animations must already be CMF-native shaped.
|
|
276
|
+
*
|
|
277
|
+
* @param {object} input Shared geometry root or mesh.
|
|
278
|
+
* @param {object} [options] Writer options (`compress`).
|
|
279
|
+
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
280
|
+
*/
|
|
281
|
+
WriteShared(input, options = {}) {
|
|
282
|
+
return CjsCmfFormat.writeShared(input, options);
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Serialize shared CarbonEngineJS geometry to compressed .cmf bytes.
|
|
287
|
+
*
|
|
288
|
+
* @param {object} input Shared geometry root or mesh.
|
|
289
|
+
* @param {object} [options] Writer options (`compress`, default true).
|
|
290
|
+
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
291
|
+
*/
|
|
292
|
+
async WriteSharedAsync(input, options = {}) {
|
|
293
|
+
return CjsCmfFormat.writeSharedAsync(input, options);
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* Static one-shot read. Static methods use camelCase by convention.
|
|
298
|
+
*
|
|
299
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
300
|
+
* @param {object} [options] Reader values.
|
|
301
|
+
* @returns {object}
|
|
302
|
+
*/
|
|
303
|
+
static read(input, options = {}) {
|
|
304
|
+
return readWithValues(CjsCmfFormat, input, normalizeValues(DEFAULT_VALUES, options));
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Static one-shot CMF-native JSON load.
|
|
309
|
+
*
|
|
310
|
+
* @param {object} input CMF-native JSON root.
|
|
311
|
+
* @param {object} [options] Reader values.
|
|
312
|
+
* @returns {object}
|
|
313
|
+
*/
|
|
314
|
+
static load(input, options = {}) {
|
|
315
|
+
return loadNativeWithValues(input, normalizeValues(DEFAULT_VALUES, options));
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* Static one-shot shared geometry to CMF-native JSON construction.
|
|
320
|
+
*
|
|
321
|
+
* @param {object} input Shared geometry root or mesh.
|
|
322
|
+
* @param {object} [options] Reader values.
|
|
323
|
+
* @returns {object}
|
|
324
|
+
*/
|
|
325
|
+
static loadShared(input, options = {}) {
|
|
326
|
+
return loadSharedWithValues(input, normalizeValues(DEFAULT_VALUES, options));
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Static one-shot read to shared geometry.
|
|
331
|
+
*
|
|
332
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
333
|
+
* @param {object} [options] Reader values.
|
|
334
|
+
* @returns {object}
|
|
335
|
+
*/
|
|
336
|
+
static readShared(input, options = {}) {
|
|
337
|
+
return CjsCmfFormat.read(input, {
|
|
338
|
+
...options,
|
|
339
|
+
emit: OUTPUT_SHARED
|
|
340
|
+
});
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
/**
|
|
344
|
+
* Static one-shot async read.
|
|
345
|
+
*
|
|
346
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
347
|
+
* @param {object} [options] Reader values.
|
|
348
|
+
* @returns {Promise<object>}
|
|
349
|
+
*/
|
|
350
|
+
static async readAsync(input, options = {}) {
|
|
351
|
+
return readWithValuesAsync(CjsCmfFormat, input, normalizeValues(DEFAULT_VALUES, options));
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Static one-shot async read to shared geometry.
|
|
356
|
+
*
|
|
357
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
358
|
+
* @param {object} [options] Reader values.
|
|
359
|
+
* @returns {Promise<object>}
|
|
360
|
+
*/
|
|
361
|
+
static async readSharedAsync(input, options = {}) {
|
|
362
|
+
return CjsCmfFormat.readAsync(input, {
|
|
363
|
+
...options,
|
|
364
|
+
emit: OUTPUT_SHARED
|
|
365
|
+
});
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Static one-shot raw read.
|
|
370
|
+
*
|
|
371
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
372
|
+
* @param {object} [options] Reader values.
|
|
373
|
+
* @returns {object}
|
|
374
|
+
*/
|
|
375
|
+
static readRaw(input, options = {}) {
|
|
376
|
+
return readRawInput(input, normalizeValues(DEFAULT_VALUES, options));
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Static one-shot async raw read.
|
|
381
|
+
*
|
|
382
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
383
|
+
* @param {object} [options] Reader values.
|
|
384
|
+
* @returns {Promise<object>}
|
|
385
|
+
*/
|
|
386
|
+
static async readRawAsync(input, options = {}) {
|
|
387
|
+
return readRawInputAsync(input, normalizeValues(DEFAULT_VALUES, options));
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* Static one-shot inspection.
|
|
392
|
+
*
|
|
393
|
+
* @param {Uint8Array|Buffer|ArrayBuffer|object} input Raw .cmf bytes or an existing raw read result.
|
|
394
|
+
* @param {object} [options] Reader values.
|
|
395
|
+
* @returns {object}
|
|
396
|
+
*/
|
|
397
|
+
static inspect(input, options = {}) {
|
|
398
|
+
return inspectRawCmfResult(input, normalizeValues(DEFAULT_VALUES, options));
|
|
399
|
+
}
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
* Static JSON-compatible conversion.
|
|
403
|
+
*
|
|
404
|
+
* @param {object} value Format output to convert.
|
|
405
|
+
* @returns {any} Plain JSON-compatible data.
|
|
406
|
+
*/
|
|
407
|
+
static toJSON(value) {
|
|
408
|
+
return toJsonValue(value);
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Static one-shot binary write without compression.
|
|
413
|
+
*
|
|
414
|
+
* @param {object} graph CMF-native graph.
|
|
415
|
+
* @param {object} [options] Writer options (`compress`).
|
|
416
|
+
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
417
|
+
*/
|
|
418
|
+
static write(graph, options = {}) {
|
|
419
|
+
return writeCmf(graph, options);
|
|
420
|
+
}
|
|
421
|
+
|
|
422
|
+
/**
|
|
423
|
+
* Static one-shot binary write with meshoptimizer compression enabled by
|
|
424
|
+
* default.
|
|
425
|
+
*
|
|
426
|
+
* @param {object} graph CMF-native graph.
|
|
427
|
+
* @param {object} [options] Writer options (`compress`, default true).
|
|
428
|
+
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
429
|
+
*/
|
|
430
|
+
static async writeAsync(graph, options = {}) {
|
|
431
|
+
return writeCmfAsync(graph, options);
|
|
432
|
+
}
|
|
433
|
+
|
|
434
|
+
/**
|
|
435
|
+
* Static one-shot shared-geometry write without compression.
|
|
436
|
+
*
|
|
437
|
+
* Equivalent to `loadShared` + buffer packing + `write`; this is the
|
|
438
|
+
* GR2/OBJ/glTF → CMF conversion entry point.
|
|
439
|
+
*
|
|
440
|
+
* @param {object} input Shared geometry root or mesh.
|
|
441
|
+
* @param {object} [options] Writer options (`compress`).
|
|
442
|
+
* @returns {Uint8Array} Complete .cmf file bytes.
|
|
443
|
+
*/
|
|
444
|
+
static writeShared(input, options = {}) {
|
|
445
|
+
const root = input && input.meshes ? input : {
|
|
446
|
+
meshes: [input]
|
|
447
|
+
};
|
|
448
|
+
const converted = convertGr2SkeletonsAndAnimations(root, options);
|
|
449
|
+
const packed = packGraphBuffers(buildCmfFromShared(converted));
|
|
450
|
+
return writeCmf({
|
|
451
|
+
...packed.graph,
|
|
452
|
+
buffers: packed.buffers
|
|
453
|
+
}, options);
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* Static one-shot shared-geometry write with meshoptimizer compression
|
|
458
|
+
* enabled by default.
|
|
459
|
+
*
|
|
460
|
+
* @param {object} input Shared geometry root or mesh.
|
|
461
|
+
* @param {object} [options] Writer options (`compress`, default true).
|
|
462
|
+
* @returns {Promise<Uint8Array>} Complete .cmf file bytes.
|
|
463
|
+
*/
|
|
464
|
+
static async writeSharedAsync(input, options = {}) {
|
|
465
|
+
const root = input && input.meshes ? input : {
|
|
466
|
+
meshes: [input]
|
|
467
|
+
};
|
|
468
|
+
const converted = convertGr2SkeletonsAndAnimations(root, options);
|
|
469
|
+
const packed = packGraphBuffers(buildCmfFromShared(converted));
|
|
470
|
+
return writeCmfAsync({
|
|
471
|
+
...packed.graph,
|
|
472
|
+
buffers: packed.buffers
|
|
473
|
+
}, options);
|
|
474
|
+
}
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Emit targets for this format (canonical frozen enum).
|
|
478
|
+
*/
|
|
479
|
+
static Output = Object.freeze({
|
|
480
|
+
JSON: OUTPUT_JSON,
|
|
481
|
+
CMF: OUTPUT_CMF,
|
|
482
|
+
CMF_JSON: OUTPUT_CMF_JSON,
|
|
483
|
+
GR2: OUTPUT_GR2,
|
|
484
|
+
NATIVE: OUTPUT_NATIVE,
|
|
485
|
+
RAW: OUTPUT_RAW,
|
|
486
|
+
SHARED: OUTPUT_SHARED
|
|
487
|
+
});
|
|
488
|
+
static CLASS_KEYS = CLASS_KEYS;
|
|
489
|
+
static type = Object.freeze(["geometry"]);
|
|
490
|
+
static mediaTypes = Object.freeze(["geometry"]);
|
|
491
|
+
static inputTypes = Object.freeze(["cmf"]);
|
|
492
|
+
static outputTypes = Object.freeze([OUTPUT_CMF, OUTPUT_GR2, OUTPUT_SHARED]);
|
|
493
|
+
static debugOutputTypes = Object.freeze([OUTPUT_JSON, OUTPUT_CMF_JSON, OUTPUT_RAW]);
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
export { CjsCmfFormat, CjsCmfFormat as default };
|
|
497
|
+
//# sourceMappingURL=CjsCmfFormat.js.map
|