@driftengine/assets 3.61.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Drift Technologies
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+DriftEngine
+Copyright 2026 Drift Technologies
+
+This product includes software developed at Drift Technologies
+(https://github.com/drftrun/driftengine).
+
+Licensed under the Apache License, Version 2.0. Section 4(d) of that licence
+requires this NOTICE to be reproduced in any derivative work you distribute,
+in the source, the documentation, or a display generated by the work.

package/README.md

@@ -0,0 +1,9 @@
+# @driftengine/assets
+
+Model readers for seven formats, and the streaming loader that uploads them.
+
+**Cost: 12.5 KB gzipped on top of core.** Measured by `scripts/size-gate.test.mjs`, which fails if it drifts more than
+3% — the number is a fact about the build rather than a claim in a document.
+
+Part of [DriftEngine](../../README.md). See [`docs/ARCHITECTURE.md`](../../docs/ARCHITECTURE.md)
+for how the packages divide, and why some features are compiled into core on demand instead.

package/dist/assetPath.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Turning a path a model file wrote into paths worth trying. One responsibility: candidates.
+ *
+ * **No filesystem, no network, no opinion about either.** This is string work only, and it
+ * exists because every format has the same problem and none of them solve it: a model names
+ * its textures with a path that was true on the machine that exported it, and is true almost
+ * nowhere else. Deciding *how* to look is the host's job, because only the host knows
+ * whether it is reading a folder, a zip, a URL or a bundle somebody dragged in. Deciding
+ * *what to look for* is the same everywhere, so it is written once, here.
+ *
+ * What goes wrong without it, from the asset this was built against:
+ *
+ * - `textures\carbon.jpg` uses backslashes, which are a path separator on one platform and
+ *   an ordinary filename character on the others.
+ * - the absolute path beside it is `G:\SketchfabRipper_v1.18.0-b2\tools\blender-292\...`,
+ *   a drive on somebody else's computer. Trying it cannot succeed and, on a host that maps
+ *   unknown roots, is the one candidate that could succeed *wrongly*.
+ * - the file may have been moved since export, so the basename alone, beside the model or
+ *   in the folder next to it, is worth trying after the declared path and never before it.
+ *
+ * Order matters and is the whole value: most specific first, so an asset carrying two
+ * `wheel.jpg` files in different folders resolves each to its own rather than to whichever
+ * the search happened to reach.
+ */
+/**
+ * A texture a model named, with its bytes when the model carried them inline.
+ *
+ * One type for both cases because the difference is the *format's* business and not the
+ * baker's: glTF may embed an image in its binary chunk or in a data URI, and may equally
+ * point at a file beside itself, while FBX and OBJ only ever name a path. A reader reports
+ * whichever it has, and the resolver looks up only what arrived without bytes.
+ */
+export interface AssetReference {
+    /** What the source called it. Used to address the texture later, and to find it now. */
+    readonly name: string;
+    /** Present when the model carried the image itself, so nothing needs resolving. */
+    readonly bytes?: Uint8Array;
+}
+/** Everything after the last separator. */
+export declare function basenameOf(declared: string): string;
+/**
+ * Paths to try for a reference, best first, relative to the folder holding the model.
+ *
+ * Deduplicated, because a texture declared as plain `carbon.jpg` would otherwise produce the
+ * same candidate three times, and a host that logs its attempts would report three failures
+ * for one missing file.
+ *
+ * `subfolders` are the conventional places a bundle puts its images. They are tried with the
+ * basename only, and last, so they can never outrank a path the file actually stated.
+ */
+export declare function assetCandidates(declared: string, subfolders?: readonly string[]): string[];

package/dist/assetPath.js

@@ -0,0 +1,59 @@
+/**
+ * Turning a path a model file wrote into paths worth trying. One responsibility: candidates.
+ *
+ * **No filesystem, no network, no opinion about either.** This is string work only, and it
+ * exists because every format has the same problem and none of them solve it: a model names
+ * its textures with a path that was true on the machine that exported it, and is true almost
+ * nowhere else. Deciding *how* to look is the host's job, because only the host knows
+ * whether it is reading a folder, a zip, a URL or a bundle somebody dragged in. Deciding
+ * *what to look for* is the same everywhere, so it is written once, here.
+ *
+ * What goes wrong without it, from the asset this was built against:
+ *
+ * - `textures\carbon.jpg` uses backslashes, which are a path separator on one platform and
+ *   an ordinary filename character on the others.
+ * - the absolute path beside it is `G:\SketchfabRipper_v1.18.0-b2\tools\blender-292\...`,
+ *   a drive on somebody else's computer. Trying it cannot succeed and, on a host that maps
+ *   unknown roots, is the one candidate that could succeed *wrongly*.
+ * - the file may have been moved since export, so the basename alone, beside the model or
+ *   in the folder next to it, is worth trying after the declared path and never before it.
+ *
+ * Order matters and is the whole value: most specific first, so an asset carrying two
+ * `wheel.jpg` files in different folders resolves each to its own rather than to whichever
+ * the search happened to reach.
+ */
+/** Backslashes to forward slashes, and any drive letter or leading root removed. */
+function normalise(declared) {
+    const forward = declared.replace(/\\/g, '/');
+    /* `C:/x`, `//host/x` and `/x` are all absolute somewhere; keep only the part below them. */
+    return forward.replace(/^[a-zA-Z]:\//, '').replace(/^\/+/, '');
+}
+/** Everything after the last separator. */
+export function basenameOf(declared) {
+    const normalised = normalise(declared);
+    return normalised.slice(normalised.lastIndexOf('/') + 1);
+}
+/**
+ * Paths to try for a reference, best first, relative to the folder holding the model.
+ *
+ * Deduplicated, because a texture declared as plain `carbon.jpg` would otherwise produce the
+ * same candidate three times, and a host that logs its attempts would report three failures
+ * for one missing file.
+ *
+ * `subfolders` are the conventional places a bundle puts its images. They are tried with the
+ * basename only, and last, so they can never outrank a path the file actually stated.
+ */
+export function assetCandidates(declared, subfolders = ['textures', 'Textures', 'tex', 'maps', 'images']) {
+    const normalised = normalise(declared);
+    if (normalised === '')
+        return [];
+    const base = basenameOf(declared);
+    const out = [normalised];
+    /* A declared path with folders in it may have lost them; the basename beside the model
+       is the single most common way an asset arrives after being repacked. */
+    if (base !== normalised)
+        out.push(base);
+    for (const folder of subfolders)
+        out.push(`${folder}/${base}`);
+    return [...new Set(out)];
+}

package/dist/coarseLevel.d.ts

@@ -0,0 +1,94 @@
+/**
+ * One coarse mesh standing in for a whole asset, so a load can start with an outline.
+ *
+ * docs/FORMAT.md §4.6 argues for this and states the two things that make it worth building:
+ * a coarse whole model has to *exist as geometry* before it can be drawn, so it is baked
+ * rather than derived at load; and **level 0 for the whole asset is worth more than level 0
+ * for each of 187 parts**, because a single decimated body reads as a car while 187 coarse
+ * fragments read as a mess. So this takes every mesh and returns exactly one.
+ *
+ * **The surface of an occupancy grid, not a cluster of vertices.** The first version of this
+ * clustered vertices onto a grid and connected three clusters wherever a source triangle
+ * spanned three cells, which is the classic Rossignac-Borrel decimation and was wrong for
+ * this job in a way that only showed on screen: nothing stops the three clusters of a
+ * triangle from lying on *different surfaces* of the model, so a car whose seats and engine
+ * bay share cells with its shell grew triangles straight through the bodywork. It was
+ * reported, correctly, as white cliffs.
+ *
+ * This marks every cell any surface passes through, then emits the boundary between the
+ * occupied cells and the empty ones. That boundary is **closed by construction** and cannot
+ * contain a triangle joining two sides of the model, because it is the outside of a solid
+ * rather than a decimation of a surface. Interior geometry disappears into cells that are
+ * already occupied, which is exactly what should happen to it in an outline.
+ *
+ * The blocky result is then pulled onto the model: each corner of the boundary sits at the
+ * average of the real surface inside the cells around it. So a cube grid becomes a shape
+ * that follows the car, at the resolution the caller asked for.
+ *
+ * Offline work in the baker, so it may allocate freely. Nothing here runs per frame.
+ */
+import type { MeshData } from '@driftengine/drft';
+export interface CoarseLevelOptions {
+    /**
+     * Cells along the asset's longest axis. Higher is finer and larger.
+     *
+     * The whole point of the level is that it arrives before the model, so it is measured in
+     * kilobytes rather than in fidelity: at 40 a five-metre car resolves to about twelve
+     * centimetres, which is a recognisable car for a few hundred kilobytes against seventy
+     * megabytes of file.
+     */
+    readonly cells?: number;
+    /**
+     * How far the outline is held below the surface, as a fraction of a cell.
+     *
+     * **This is what lets it stay on screen while the real parts land on top of it**, which is
+     * the reveal §4.6 describes: an outline, then its elements. A corner of the boundary sits at
+     * the average of the surface around it, so it is already close; this is the margin that
+     * keeps it from landing in the same plane as the part covering it and showing through in
+     * patches. Being a little inside the model costs nothing, because the model is about to
+     * cover it.
+     */
+    readonly inset?: number;
+}
+/**
+ * The grid this uses when nobody names a resolution, exported because two other places used
+ * to carry their own copy of the number and disagreed with it.
+ *
+ * The baker printed 32 and the browser's converter passed nothing, so one path wrote an
+ * outline at 32 cells and the other at 40, and the same model taken through the two arrived
+ * differently for no stated reason. A default that callers restate is a default in name only.
+ */
+export declare const DEFAULT_COARSE_CELLS = 40;
+/**
+ * Build the coarse level, or `null` when there is nothing to build one from.
+ *
+ * `null` rather than an empty mesh: an asset with no extent, or one whose geometry all falls
+ * inside a single cell, has no outline worth a chunk in the file, and every caller would
+ * otherwise have to check the vertex count to find that out.
+ *
+ * Whether the result is *worth writing* is a separate question with a separate answer:
+ * `isOutlineWorthWriting`.
+ */
+export declare function buildCoarseLevel(meshes: readonly MeshData[], options?: CoarseLevelOptions): MeshData | null;
+/**
+ * Whether a built level is worth writing into a file as an outline.
+ *
+ * **A level of detail that is bigger than the model is not one.** The grid is a fixed number of
+ * cells across whatever it is given, so its cost follows the *shape* rather than the detail: four
+ * hand-written triangles come back as a 9,840-triangle shell, which is 308 KB of outline arriving
+ * ahead of a model measured in bytes. Everything an outline is for, being on screen before the
+ * geometry at a fraction of the download, is inverted.
+ *
+ * Found the day the default flipped from off to on, by a fixture. While an outline was asked for
+ * per asset by somebody who had looked, the case could not arise. A default has to hold for the
+ * assets nobody looks at, which is what makes it a default.
+ *
+ * **Separate from `buildCoarseLevel`, which stays a geometry function.** This is a budget, and a
+ * caller that wants the hull of a small mesh for some other purpose is entitled to it. It lives
+ * here rather than in the two callers because the baker and the browser's converter have to agree
+ * about what a file carries, and a rule stated twice is a rule until somebody edits one copy.
+ *
+ * Half rather than merely smaller: an outline that saves a few per cent is a chunk, an upload and
+ * a swap for no visible gain.
+ */
+export declare function isOutlineWorthWriting(level: MeshData, meshes: readonly MeshData[]): boolean;