@babylonjs/loaders 9.19.1 → 9.20.1

package/glTF/2.0/Extensions/objectModelMapping.d.ts

@@ -1,5 +1,5 @@
 import { type TransformNode } from "@babylonjs/core/Meshes/transformNode.js";
-import { type IAnimation, type ICamera, type IGLTF, type IKHRLightsPunctual_Light, type IEXTLightsArea_Light, type IMaterial, type IMesh, type INode } from "../glTFLoaderInterfaces.js";
+import { type IAnimation, type ICamera, type IGLTF, type IKHRLightsPunctual_Light, type IEXTLightsArea_Light, type IMaterial, type IMesh, type IMeshPrimitive, type INode, type IScene, type ISkin } from "../glTFLoaderInterfaces.js";
 import { type Vector3, Matrix, Quaternion, Vector2 } from "@babylonjs/core/Maths/math.vector.pure.js";
 import { type Color3, Color4 } from "@babylonjs/core/Maths/math.color.pure.js";
 import { type PBRMaterial } from "@babylonjs/core/Materials/PBR/pbrMaterial.js";
@@ -8,38 +8,49 @@ import { type Nullable } from "@babylonjs/core/types.js";
 import { type IEXTLightsImageBased_LightImageBased } from "babylonjs-gltf2interface";
 import { type BaseTexture } from "@babylonjs/core/Materials/Textures/baseTexture.js";
 import { type IInterpolationPropertyInfo, type IObjectAccessor } from "@babylonjs/core/FlowGraph/typeDefinitions.js";
+import { FlowGraphInteger } from "@babylonjs/core/FlowGraph/CustomTypes/flowGraphInteger.pure.js";
 import { GLTFPathToObjectConverter } from "./gltfPathToObjectConverter.js";
 import { type AnimationGroup } from "@babylonjs/core/Animations/animationGroup.js";
 import { type Mesh } from "@babylonjs/core/Meshes/mesh.js";
 /**
- * Describes the object model tree that maps glTF pointer paths to their corresponding Babylon objects.
+ * Top-level shape of the glTF Object Model accessor tree. Each property
+ * describes a navigable section of the JSON-Pointer namespace (e.g. `/nodes`,
+ * `/materials`, `/scenes`) that KHR_interactivity, KHR_animation_pointer and
+ * other extensions consume via {@link GetMappingForKey}.
  */
 export interface IGLTFObjectModelTree {
-    /** Mapping for the glTF cameras collection. */
+    /** Read-only accessor for the active scene index (`/scene`). */
+    scene: {
+        __target__: boolean;
+    } & IObjectAccessor<number | undefined, any, number>;
+    /** Accessor tree for `/cameras`. */
     cameras: IGLTFObjectModelTreeCamerasObject;
-    /** Mapping for the glTF nodes collection. */
+    /** Accessor tree for `/nodes`. */
     nodes: IGLTFObjectModelTreeNodesObject;
-    /** Mapping for the glTF materials collection. */
+    /** Accessor tree for `/materials`. */
     materials: IGLTFObjectModelTreeMaterialsObject;
-    /** Mapping for the glTF extensions. */
+    /** Accessor tree for `/extensions` (root-level glTF extensions). */
     extensions: IGLTFObjectModelTreeExtensionsObject;
-    /** Mapping for the glTF animations collection. */
+    /** Accessor tree for `/animations`. */
     animations: {
-        length: IObjectAccessor<IAnimation[], AnimationGroup[], number>;
-        __array__: {};
-    };
-    /** Mapping for the glTF meshes collection. */
-    meshes: {
-        length: IObjectAccessor<IMesh[], (Mesh | undefined)[], number>;
+        length: IObjectAccessor<IAnimation[], AnimationGroup[], FlowGraphInteger>;
         __array__: {};
     };
+    /** Accessor tree for `/meshes`. */
+    meshes: IGLTFObjectModelTreeMeshesObject;
+    /** Accessor tree for `/scenes`. */
+    scenes: IGLTFObjectModelTreeScenesObject;
+    /** Accessor tree for `/skins`. */
+    skins: IGLTFObjectModelTreeSkinsObject;
 }
 /**
- * Describes the mapping of glTF node properties to their corresponding Babylon transform node properties.
+ * Accessor tree describing the `/nodes` section of the glTF Object Model.
+ * Exposes per-node TRS, ref-typed parent/children/camera/mesh/skin links,
+ * morph-target weights and node-extension properties.
  */
 export interface IGLTFObjectModelTreeNodesObject<GLTFTargetType = INode, BabylonTargetType = TransformNode> {
-    /** Accessor for the number of nodes. */
-    length: IObjectAccessor<GLTFTargetType[], BabylonTargetType[], number>;
+    /** Number of nodes in the array. */
+    length: IObjectAccessor<GLTFTargetType[], BabylonTargetType[], FlowGraphInteger>;
     __array__: {
         __target__: boolean;
         translation: IObjectAccessor<GLTFTargetType, BabylonTargetType, Vector3>;
@@ -47,11 +58,23 @@ export interface IGLTFObjectModelTreeNodesObject<GLTFTargetType = INode, Babylon
         scale: IObjectAccessor<GLTFTargetType, BabylonTargetType, Vector3>;
         matrix: IObjectAccessor<GLTFTargetType, BabylonTargetType, Matrix>;
         globalMatrix: IObjectAccessor<GLTFTargetType, BabylonTargetType, Matrix>;
+        camera: IObjectAccessor<GLTFTargetType, any, string | undefined>;
+        mesh: IObjectAccessor<GLTFTargetType, any, string | undefined>;
+        skin: IObjectAccessor<GLTFTargetType, any, string | undefined>;
+        parent: IObjectAccessor<GLTFTargetType, any, string | undefined>;
+        children: {
+            length: IObjectAccessor<number[], any, FlowGraphInteger>;
+            __array__: {
+                __target__: boolean;
+            } & IObjectAccessor<any, any, string>;
+        };
         weights: {
-            length: IObjectAccessor<GLTFTargetType, BabylonTargetType, number>;
+            /** When true, the path converter skips objectTree traversal for this property, keeping the parent target. */
+            __passThroughTarget__?: boolean;
+            length: IObjectAccessor<GLTFTargetType, BabylonTargetType, FlowGraphInteger>;
             __array__: {
                 __target__: boolean;
-            } & IObjectAccessor<GLTFTargetType, BabylonTargetType, number>;
+            } & IObjectAccessor<GLTFTargetType, any, number>;
         } & IObjectAccessor<GLTFTargetType, BabylonTargetType, number[]>;
         extensions: {
             EXT_lights_ies?: {
@@ -65,9 +88,12 @@ export interface IGLTFObjectModelTreeNodesObject<GLTFTargetType = INode, Babylon
     };
 }
 /**
- * Describes the mapping of glTF camera properties to their corresponding Babylon camera properties.
+ * Accessor tree describing the `/cameras` section of the glTF Object Model.
+ * Exposes orthographic and perspective camera properties.
  */
 export interface IGLTFObjectModelTreeCamerasObject {
+    /** Number of cameras in the array. */
+    length: IObjectAccessor<ICamera[], any, FlowGraphInteger>;
     __array__: {
         __target__: boolean;
         orthographic: {
@@ -85,11 +111,16 @@ export interface IGLTFObjectModelTreeCamerasObject {
     };
 }
 /**
- * Describes the mapping of glTF material properties to their corresponding Babylon material properties.
+ * Accessor tree describing the `/materials` section of the glTF Object Model.
+ * Covers core PBR properties as well as the family of KHR_materials_* extensions.
  */
 export interface IGLTFObjectModelTreeMaterialsObject {
+    /** Number of materials in the array. */
+    length: IObjectAccessor<IMaterial[], PBRMaterial[], FlowGraphInteger>;
     __array__: {
         __target__: boolean;
+        doubleSided: IObjectAccessor<IMaterial, PBRMaterial, boolean>;
+        alphaCutoff: IObjectAccessor<IMaterial, PBRMaterial, number>;
         pbrMetallicRoughness: {
             baseColorFactor: IObjectAccessor<IMaterial, PBRMaterial, Color4>;
             metallicFactor: IObjectAccessor<IMaterial, PBRMaterial, Nullable<number>>;
@@ -247,18 +278,75 @@ interface ITextureDefinition {
     scale: IObjectAccessor<IMaterial, PBRMaterial, Vector2>;
 }
 /**
- * Describes the mapping of glTF mesh properties to their corresponding Babylon mesh properties.
+ * Accessor tree describing the `/meshes` section of the glTF Object Model.
+ * Exposes per-mesh primitives (and their material refs) and the mesh-level
+ * morph-target weights array.
  */
 export interface IGLTFObjectModelTreeMeshesObject {
+    /** Number of meshes in the array. */
+    length: IObjectAccessor<IMesh[], (Mesh | undefined)[], FlowGraphInteger>;
+    __array__: {
+        __target__: boolean;
+        primitives: {
+            length: IObjectAccessor<IMeshPrimitive[], any, FlowGraphInteger>;
+            __array__: {
+                __target__: boolean;
+                material: IObjectAccessor<any, any, string | undefined>;
+            };
+        };
+        weights: {
+            length: IObjectAccessor<number[], any, FlowGraphInteger>;
+            __array__: {
+                __target__: boolean;
+            } & IObjectAccessor<any, any, number>;
+        };
+    };
+}
+/**
+ * Accessor tree describing the `/scenes` section of the glTF Object Model.
+ * Per-scene root-node refs are exposed under `nodes/{i}`.
+ */
+export interface IGLTFObjectModelTreeScenesObject {
+    /** Number of scenes in the array. */
+    length: IObjectAccessor<IScene[], any, FlowGraphInteger>;
+    __array__: {
+        __target__: boolean;
+        nodes: {
+            length: IObjectAccessor<number[], any, FlowGraphInteger>;
+            __array__: {
+                __target__: boolean;
+            } & IObjectAccessor<any, any, string>;
+        };
+    };
+}
+/**
+ * Accessor tree describing the `/skins` section of the glTF Object Model.
+ * Joint and skeleton properties are exposed as JSON-Pointer refs.
+ */
+export interface IGLTFObjectModelTreeSkinsObject {
+    /** Number of skins in the array. */
+    length: IObjectAccessor<ISkin[], any, FlowGraphInteger>;
+    __array__: {
+        __target__: boolean;
+        joints: {
+            length: IObjectAccessor<number[], any, FlowGraphInteger>;
+            __array__: {
+                __target__: boolean;
+            } & IObjectAccessor<any, any, string>;
+        };
+        skeleton: IObjectAccessor<ISkin, any, string | undefined>;
+    };
 }
 /**
- * Describes the mapping of glTF extension properties to their corresponding Babylon properties.
+ * Accessor tree describing root-level glTF extensions exposed through the
+ * Object Model. Currently covers the punctual / area / IES / image-based
+ * light extension families.
  */
 export interface IGLTFObjectModelTreeExtensionsObject {
-    /** Mapping for the KHR_lights_punctual extension. */
+    /** Accessor tree for `/extensions/KHR_lights_punctual`. */
     KHR_lights_punctual: {
         lights: {
-            length: IObjectAccessor<IKHRLightsPunctual_Light[], Light[], number>;
+            length: IObjectAccessor<IKHRLightsPunctual_Light[], Light[], FlowGraphInteger>;
             __array__: {
                 __target__: boolean;
                 color: IObjectAccessor<IKHRLightsPunctual_Light, Light, Color3>;
@@ -271,10 +359,10 @@ export interface IGLTFObjectModelTreeExtensionsObject {
             };
         };
     };
-    /** Mapping for the EXT_lights_area extension. */
+    /** Accessor tree for `/extensions/EXT_lights_area`. */
     EXT_lights_area: {
         lights: {
-            length: IObjectAccessor<IEXTLightsArea_Light[], Light[], number>;
+            length: IObjectAccessor<IEXTLightsArea_Light[], Light[], FlowGraphInteger>;
             __array__: {
                 __target__: boolean;
                 color: IObjectAccessor<IEXTLightsArea_Light, Light, Color3>;
@@ -286,13 +374,13 @@ export interface IGLTFObjectModelTreeExtensionsObject {
             };
         };
     };
-    /** Mapping for the EXT_lights_ies extension. */
+    /** Accessor tree for `/extensions/EXT_lights_ies`. */
     EXT_lights_ies: {
         lights: {
-            length: IObjectAccessor<IKHRLightsPunctual_Light[], Light[], number>;
+            length: IObjectAccessor<IKHRLightsPunctual_Light[], Light[], FlowGraphInteger>;
         };
     };
-    /** Mapping for the EXT_lights_image_based extension. */
+    /** Accessor tree for `/extensions/EXT_lights_image_based`. */
     EXT_lights_image_based: {
         lights: {
             __array__: {
@@ -300,7 +388,7 @@ export interface IGLTFObjectModelTreeExtensionsObject {
                 intensity: IObjectAccessor<IEXTLightsImageBased_LightImageBased, BaseTexture, number>;
                 rotation: IObjectAccessor<IEXTLightsImageBased_LightImageBased, BaseTexture, Quaternion>;
             };
-            length: IObjectAccessor<IEXTLightsImageBased_LightImageBased[], BaseTexture[], number>;
+            length: IObjectAccessor<IEXTLightsImageBased_LightImageBased[], BaseTexture[], FlowGraphInteger>;
         };
     };
 }