@domgell/gltf-parser 1.0.1 → 1.0.2

package/.idea/copilot.data.migration.agent.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AgentMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.ask2agent.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Ask2AgentMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.edit.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="EditMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/gltf-parser.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/gltf-parser.iml" filepath="$PROJECT_DIR$/.idea/gltf-parser.iml" />
+    </modules>
+  </component>
+</project>

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@domgell/gltf-parser",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "src/index.ts",
   "exports": "./src/index.ts",
   "author": "domgell",
   "license": "ISC",
   "description": "Parse .GLTF/.GLF files into JS objects",
-  "keywords": ["gltf", "glb", "mesh", "parser"],
+  "keywords": ["gltf", "glb", "mesh", "parser", "model"],
   "dependencies": {
     "@domgell/gltf-types": "*",
     "@domgell/ts-util": "*",

package/src/Parser.ts

@@ -10,7 +10,7 @@ import {mat4, TransformOrder} from "dom-game-math";
 import {Matrix4x4, TextureFilterMap, TextureWrapModeMap} from "./types.ts";
 import {assert, fail} from "@domgell/ts-util";
 
-export type ParserOptions = {
+export interface ParserOptions {
     transformOrder: TransformOrder,
 }
 
@@ -51,7 +51,10 @@ export class Parser {
 
     // ----------------------------------- Accessor ------------------------------------
 
-    accessor<T extends AccessorArrayType, I extends number | undefined>(index: I, type: T): I extends number ? AccessorConstructorType<T> : AccessorConstructorType<T> | undefined {
+    accessor<
+        T extends AccessorArrayType,
+        I extends number | undefined
+    >(index: I, type: T): I extends number ? AccessorConstructorType<T> : AccessorConstructorType<T> | undefined {
         if (index === undefined) return undefined as any;
 
         assert(this.header.accessors !== undefined, "Accessors are undefined");
@@ -132,7 +135,7 @@ export class Parser {
     skin(gltfSkin: GLTF.Skin) {
         assert(this.header.nodes !== undefined, "`Nodes` is undefined");
 
-        // Default: Array of identity matrices with length = number of joints
+        // Default to array of identity matrices with length = number of joints
         const inverseBindMatrices = gltfSkin.inverseBindMatrices
             ? chunk(this.accessor(gltfSkin.inverseBindMatrices, Float32Array), 16)
             : gltfSkin.joints.map(() => Array.from(mat4.idt) as Matrix4x4);
@@ -229,25 +232,22 @@ export class Parser {
 
         let normal: Parsed.MaterialNormalInfo | undefined;
         if (gltfMaterial.normalTexture !== undefined) {
-            fail("TODO");
+            fail("TODO: Normal Texture");
         }
 
         let emissive: Parsed.MaterialEmissiveInfo | undefined;
         if (gltfMaterial.emissiveTexture !== undefined) {
-            fail("TODO");
+            fail("TODO: Emissive Texture");
         }
 
         let ambientOcclusion: Parsed.MaterialAmbientOcclusionInfo | undefined;
         if (gltfMaterial.occlusionTexture !== undefined) {
-            fail("TODO");
+            fail("TODO: Occlusion Texture");
         }
 
         const alpha: Parsed.MaterialAlphaInfo = {
-
             mode: gltfMaterial.alphaMode ?? "OPAQUE",
-
             cutoff: gltfMaterial.alphaCutoff ?? 0.5,
-
         };
 
         const doubleSided = gltfMaterial.doubleSided ?? false;
@@ -302,11 +302,12 @@ export class Parser {
             const buffer = this.header.buffers[bufferView.buffer];
 
             if (buffer.uri !== undefined) {
-                fail("TODO");
+                fail("TODO: Buffer URI");
             }
 
-            // TODO: buffer length + bufferView offset (?)
-            const data = this.binary.slice(bufferView.byteOffset ?? 0, (bufferView.byteOffset ?? 0) + bufferView.byteLength);
+            const dataBegin = bufferView.byteOffset ?? 0;
+            const dataEnd = dataBegin + bufferView.byteLength;
+            const data = this.binary.slice(dataBegin, dataEnd);
             const blob = new Blob([new Uint8Array(data)]);
 
             return await createImageBitmap(blob);

package/src/types.ts

@@ -7,7 +7,7 @@ export type Vector4 = Tuple<number, 4>
 
 // ------------------------------- Scene -------------------------------
 
-export type Scene = {
+export interface Scene {
     /**
      * All nodes in scene
      */
@@ -24,15 +24,29 @@ export type Node = {
     name?: string,
     children: Node[],
     parent?: Node,
-} & (
-    | { mesh: Mesh, skin?: undefined, camera?: undefined }
-    | { skin: Skin, mesh?: undefined, camera?: undefined }
-    | { camera: Camera, mesh?: undefined, skin?: undefined }
-    )
+} & (MeshNode | SkinNode | CameraNode)
+
+interface MeshNode {
+    mesh: Mesh,
+    skin?: undefined,
+    camera?: undefined
+}
+
+interface SkinNode {
+    skin: Skin,
+    mesh?: undefined,
+    camera?: undefined
+}
+
+interface CameraNode {
+    camera: Camera,
+    mesh?: undefined,
+    skin?: undefined
+}
 
 // ------------------------------ Camera -------------------------------
 
-export type OrthographicCamera = {
+export interface OrthographicCamera {
     type: "Orthographic"
     xmag: number,
     ymag: number,
@@ -42,7 +56,7 @@ export type OrthographicCamera = {
     projection: Matrix4x4,
 }
 
-export type PerspectiveCamera = {
+export interface PerspectiveCamera {
     type: "Perspective"
     aspectRatio: number,
     yfov: number,
@@ -56,7 +70,7 @@ export type Camera = OrthographicCamera | PerspectiveCamera
 
 // ------------------------------- Mesh --------------------------------
 
-export type MeshPrimitiveAttributes = {
+export interface MeshPrimitiveAttributes {
     positions: Vector3[],
     uvs?: Vector2[],
     normals?: Vector3[],
@@ -66,7 +80,7 @@ export type MeshPrimitiveAttributes = {
     tangents?: Vector4[], // TODO
 }
 
-export type MeshPrimitive = {
+export interface MeshPrimitive {
     /**
      * Vertex attributes of the mesh primitive
      */
@@ -75,14 +89,14 @@ export type MeshPrimitive = {
     material?: Material,
 }
 
-export type Mesh = {
+export interface Mesh {
     primitives: MeshPrimitive[],
     name?: string,
 }
 
 // -------------------------------- Skin -------------------------------
 
-export type Joint = {
+export interface Joint {
     name: string,
     transform: Matrix4x4,
     inverseBindTransform: Matrix4x4,
@@ -90,7 +104,7 @@ export type Joint = {
     parent?: string,
 }
 
-export type Skin = {
+export interface Skin {
     root: Joint,
     joints: Record<string, Joint>,
     animations: Animation[],
@@ -100,31 +114,34 @@ export type Skin = {
 
 // ----------------------------- Animation -----------------------------
 
-export type Animation = {
+export interface Animation {
     duration: number,
     name?: string,
     channels: Record<string, AnimationChannel>,
 }
 
-export type AnimationChannel = {
-    translation: AnimationKeyframe<Vector3>[]
-    rotation: AnimationKeyframe<Vector4>[]
-    scale: AnimationKeyframe<Vector3>[]
+export interface AnimationChannel {
+    translation: AnimationKeyframe<Vector3>[];
+    rotation: AnimationKeyframe<Vector4>[];
+    scale: AnimationKeyframe<Vector3>[];
 }
 
-export type AnimationKeyframe<T> = { time: number, value: T }
+export interface AnimationKeyframe<T> {
+    time: number,
+    value: T
+}
 
 // ----------------------------- Texture -------------------------------
 
 
 // TODO: If source is undefined, don't create texture, if sampler is undefined create default sampler
-export type Texture = {
+export interface Texture {
     source: ImageBitmap,
     sampler: Sampler,
     name?: string,
 }
 
-export type Sampler = {
+export interface Sampler {
     wrap: { s: TextureWrapMode, t: TextureWrapMode },
     filter: { min: TextureMinFilter, mag: TextureMagFilter },
 }
@@ -161,7 +178,7 @@ export const TextureFilterMap = {
 
 // ----------------------------- Material ------------------------------
 
-export type Material = {
+export interface Material {
     metallicRoughness: MaterialMetallicRoughnessInfo,
     normal?: MaterialNormalInfo,
     emissive?: MaterialEmissiveInfo,
@@ -173,7 +190,7 @@ export type Material = {
     doubleSided: boolean,
 }
 
-export type MaterialAlphaInfo = {
+export interface MaterialAlphaInfo {
     /**
      * The alpha rendering mode of the material. Default is `"OPAQUE"`.
      */
@@ -184,7 +201,7 @@ export type MaterialAlphaInfo = {
     cutoff: number,
 }
 
-export type MaterialMetallicRoughnessInfo = {
+export interface MaterialMetallicRoughnessInfo {
     /**
      * The base color factor of the material. Default is `[1, 1, 1, 1]`.
      */
@@ -207,7 +224,7 @@ export type MaterialMetallicRoughnessInfo = {
     metallicRoughnessTexture?: Texture,
 }
 
-export type MaterialNormalInfo = {
+export interface MaterialNormalInfo {
     /**
      * The normal texture of the material.
      */
@@ -218,7 +235,7 @@ export type MaterialNormalInfo = {
     scale: number,
 }
 
-export type MaterialEmissiveInfo = {
+export interface MaterialEmissiveInfo {
     /**
      * The emissive texture of the material.
      */
@@ -230,7 +247,7 @@ export type MaterialEmissiveInfo = {
     factor: Vector3,
 }
 
-export type MaterialAmbientOcclusionInfo = {
+export interface MaterialAmbientOcclusionInfo {
     /**
      * The occlusion texture of the material.
      */