glTF parse support custom extsnions and parser

packages/loader/src/GLTFLoader.ts

@@ -1,18 +1,19 @@
 import { AssetPromise, AssetType, Loader, LoadItem, resourceLoader, ResourceManager } from "@oasis-engine/core";
-import { GLTFParser } from "./gltf/GLTFParser";
+import { GLTFPipeline } from "./gltf/GLTFPipeline";
 import { GLTFResource } from "./gltf/GLTFResource";
-import { ParserContext } from "./gltf/parser/ParserContext";
+import { GLTFParserContext } from "./gltf/parser/GLTFParserContext";
 
 @resourceLoader(AssetType.Prefab, ["gltf", "glb"])
 export class GLTFLoader extends Loader<GLTFResource> {
   load(item: LoadItem, resourceManager: ResourceManager): Record<string, AssetPromise<any>> {
-    const url = item.url;
-    const context = new ParserContext(url);
+    const { url } = item;
+    const params = <GLTFParams>item.params;
+    const context = new GLTFParserContext(url);
     const glTFResource = new GLTFResource(resourceManager.engine, url);
     const masterPromiseInfo = context.masterPromiseInfo;
 
     context.glTFResource = glTFResource;
-    context.keepMeshData = item.params?.keepMeshData ?? false;
+    context.keepMeshData = params?.keepMeshData ?? false;
 
     masterPromiseInfo.onCancel(() => {
       const { chainPromises } = context;
@@ -21,8 +22,8 @@ export class GLTFLoader extends Loader<GLTFResource> {
       }
     });
 
-    GLTFParser.defaultPipeline
-      .parse(context)
+    (params?.pipeline || GLTFPipeline.defaultPipeline)
+      ._parse(context)
       .then(masterPromiseInfo.resolve)
       .catch((e) => {
         console.error(e);
@@ -39,4 +40,6 @@ export class GLTFLoader extends Loader<GLTFResource> {
 export interface GLTFParams {
   /** Keep raw mesh data for glTF parser, default is false. */
   keepMeshData: boolean;
+  /** Custom glTF pipeline. */
+  pipeline: GLTFPipeline;
 }

packages/loader/src/gltf/GLTFPipeline.ts

@@ -0,0 +1,76 @@
+import { AssetPromise } from "@oasis-engine/core";
+import { GLTFResource } from "./GLTFResource";
+import { GLTFAnimationParser } from "./parser/GLTFAnimationParser";
+import { GLTFBufferParser } from "./parser/GLTFBufferParser";
+import { GLTFEntityParser } from "./parser/GLTFEntityParser";
+import { GLTFMaterialParser } from "./parser/GLTFMaterialParser";
+import { GLTFMeshParser } from "./parser/GLTFMeshParser";
+import { GLTFParser } from "./parser/GLTFParser";
+import { GLTFParserContext } from "./parser/GLTFParserContext";
+import { GLTFSceneParser } from "./parser/GLTFSceneParser";
+import { GLTFSkinParser } from "./parser/GLTFSkinParser";
+import { GLTFTextureParser } from "./parser/GLTFTextureParser";
+import { GLTFValidator } from "./parser/GLTFValidator";
+
+/**
+ * GLTF pipeline.
+ */
+export class GLTFPipeline {
+  /**
+   * Default pipeline.
+   */
+  static defaultPipeline = new GLTFPipeline(
+    GLTFBufferParser,
+    GLTFValidator,
+    GLTFTextureParser,
+    GLTFMaterialParser,
+    GLTFMeshParser,
+    GLTFEntityParser,
+    GLTFSkinParser,
+    GLTFAnimationParser,
+    GLTFSceneParser
+  );
+
+  private _parsers: GLTFParser[] = [];
+
+  /**
+   * Constructor of GLTFPipeline.
+   * @param parsers - Parsers to be executed in order
+   */
+  constructor(...parsers: (new () => GLTFParser)[]) {
+    parsers.forEach((pipe: new () => GLTFParser, index: number) => {
+      this._parsers[index] = new pipe();
+    });
+  }
+
+  /**
+   * @internal
+   */
+  _parse(context: GLTFParserContext): AssetPromise<GLTFResource> {
+    const glTFResource = context.glTFResource;
+    let lastParser;
+
+    return new AssetPromise<GLTFResource>((resolve, reject) => {
+      this._parsers.forEach((parser: GLTFParser) => {
+        if (lastParser) {
+          lastParser = lastParser.then(() => {
+            return parser.parse(context);
+          });
+          if (lastParser.cancel) {
+            context.chainPromises.push(lastParser);
+          }
+        } else {
+          lastParser = parser.parse(context);
+        }
+      });
+
+      if (lastParser) {
+        lastParser
+          .then(() => {
+            resolve(glTFResource);
+          })
+          .catch(reject);
+      }
+    });
+  }
+}

packages/loader/src/gltf/GLTFResource.ts

@@ -7,7 +7,6 @@ import {
   Light,
   Material,
   ModelMesh,
-  Renderer,
   Skin,
   Texture2D
 } from "@oasis-engine/core";
@@ -38,8 +37,8 @@ export class GLTFResource extends EngineObject {
   sceneRoots: Entity[];
   /** Oasis RootEntity after SceneParser. */
   defaultSceneRoot: Entity;
-  /** Renderer can replace material by `renderer.setMaterial` if gltf use plugin-in KHR_materials_variants. */
-  variants?: { renderer: Renderer; material: Material; variants: string[] }[];
+  /** Extensions data. */
+  extensionsData: Record<string, any>;
 
   constructor(engine: Engine, url: string) {
     super(engine);
@@ -66,6 +65,6 @@ export class GLTFResource extends EngineObject {
     this.cameras = null;
     this.lights = null;
     this.sceneRoots = null;
-    this.variants = null;
+    this.extensionsData = null;
   }
 }

packages/loader/src/gltf/Schema.ts → packages/loader/src/gltf/GLTFSchema.ts

@@ -853,3 +853,6 @@ export interface IGLTF extends IProperty {
    */
   textures?: ITexture[];
 }
+
+/** glTF extensible owner schema. */
+export type GLTFExtensionOwnerSchema = IMeshPrimitive | IMaterial | ITextureInfo | INode;

packages/loader/src/gltf/GLTFUtil.ts

@@ -1,27 +1,7 @@
 import { IndexFormat, TypedArray, VertexElementFormat } from "@oasis-engine/core";
 import { Color, Vector2, Vector3, Vector4 } from "@oasis-engine/math";
-import { BufferInfo, ParserContext } from "./parser/ParserContext";
-import { AccessorComponentType, AccessorType, IAccessor, IBufferView, IGLTF } from "./Schema";
-
-const charCodeOfDot = ".".charCodeAt(0);
-const reEscapeChar = /\\(\\)?/g;
-const rePropName = RegExp(
-  // Match anything that isn't a dot or bracket.
-  "[^.[\\]]+" +
-    "|" +
-    // Or match property names within brackets.
-    "\\[(?:" +
-    // Match a non-string expression.
-    "([^\"'][^[]*)" +
-    "|" +
-    // Or match strings (supports escaping characters).
-    "([\"'])((?:(?!\\2)[^\\\\]|\\\\.)*?)\\2" +
-    ")\\]" +
-    "|" +
-    // Or match "" as the space between consecutive dots or empty brackets.
-    "(?=(?:\\.|\\[\\])(?:\\.|\\[\\]|$))",
-  "g"
-);
+import { BufferInfo, GLTFParserContext } from "./parser/GLTFParserContext";
+import { AccessorComponentType, AccessorType, IAccessor, IBufferView, IGLTF } from "./GLTFSchema";
 
 /**
  * @internal
@@ -147,7 +127,7 @@ export class GLTFUtil {
     }
   }
 
-  static getAccessorBuffer(context: ParserContext, gltf: IGLTF, accessor: IAccessor): BufferInfo {
+  static getAccessorBuffer(context: GLTFParserContext, gltf: IGLTF, accessor: IAccessor): BufferInfo {
     const { buffers } = context;
     const bufferViews = gltf.bufferViews;
 

packages/loader/src/gltf/extensions/GLTFExtensionParser.ts

@@ -0,0 +1,73 @@
+import { EngineObject } from "@oasis-engine/core";
+import { GLTFExtensionOwnerSchema } from "../GLTFSchema";
+import { GLTFParserContext } from "../parser/GLTFParserContext";
+import { GLTFExtensionSchema } from "./GLTFExtensionSchema";
+
+/**
+ * Base class of glTF extension parser.
+ */
+export abstract class GLTFExtensionParser {
+  /**
+   * @internal
+   * The extension mode.
+   */
+  _mode: GLTFExtensionMode;
+
+  /**
+   * Initialize the parser.
+   * @remarks Some plugins require initialization.
+   * @returns The void or promise
+   */
+  initialize(): void | Promise<void> {}
+
+  /**
+   * Create and parse the resource.
+   * @remarks This method overrides the default resource creation.
+   * @param context - The parser context
+   * @param extensionSchema - The extension schema
+   * @param extensionOwnerSchema - The extension owner schema
+   * @returns The resource or promise
+   */
+  createAndParse(
+    context: GLTFParserContext,
+    extensionSchema: GLTFExtensionSchema,
+    extensionOwnerSchema: GLTFExtensionOwnerSchema,
+    ...extra
+  ): EngineObject | Promise<EngineObject> {
+    throw "Not implemented.";
+  }
+
+  /**
+   * Additive parse to the resource.
+   * @param context - The parser context
+   * @param parseResource - The parsed resource
+   * @param extensionSchema - The extension schema
+   * @param extensionOwnerSchema - The extension owner schema
+   * @returns The void or promise
+   */
+  additiveParse(
+    context: GLTFParserContext,
+    parseResource: EngineObject,
+    extensionSchema: GLTFExtensionSchema,
+    extensionOwnerSchema: GLTFExtensionOwnerSchema,
+    ...extra
+  ): void | Promise<void> {
+    throw "Not implemented.";
+  }
+}
+
+/**
+ * glTF Extension mode.
+ */
+export enum GLTFExtensionMode {
+  /**
+   * Cerate instance and parse mode.
+   * @remarks
+   * If the glTF property has multiple extensions of `CreateAndParse` mode, only execute the last one.
+   * If this method is registered, the default pipeline processing will be ignored.
+   */
+  CreateAndParse,
+
+  /** Additive parse mode. */
+  AdditiveParse
+}

packages/loader/src/gltf/extensions/Schema.ts → packages/loader/src/gltf/extensions/GLTFExtensionSchema.ts

@@ -1,4 +1,4 @@
-import { IMaterialNormalTextureInfo, ITextureInfo } from "../Schema";
+import { IMaterialNormalTextureInfo, ITextureInfo } from "../GLTFSchema";
 
 /**
  * Interfaces from the KHR_lights_punctual extension
@@ -159,7 +159,7 @@ export interface IOasisMaterialRemap {
   isClone?: boolean;
 }
 
-export type ExtensionSchema =
+export type GLTFExtensionSchema =
   | IKHRLightsPunctual_Light
   | IKHRDracoMeshCompression
   | IKHRMaterialsClearcoat
@@ -175,4 +175,5 @@ export type ExtensionSchema =
   | IKHRTextureBasisU
   | IKHRTextureTransform
   | IKHRXmp
-  | IKHRXmp_Node;
+  | IKHRXmp_Node
+  | Object;