@galacean/engine-loader 1.2.0-alpha.3 → 1.2.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-loader",
-  "version": "1.2.0-alpha.3",
+  "version": "1.2.0-alpha.5",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,9 +15,9 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-core": "1.2.0-alpha.3",
-    "@galacean/engine-math": "1.2.0-alpha.3",
-    "@galacean/engine-rhi-webgl": "1.2.0-alpha.3"
+    "@galacean/engine-math": "1.2.0-alpha.5",
+    "@galacean/engine-rhi-webgl": "1.2.0-alpha.5",
+    "@galacean/engine-core": "1.2.0-alpha.5"
   },
   "scripts": {
     "b:types": "tsc"

package/types/resource-deserialize/index.d.ts

@@ -2,7 +2,7 @@ import { Engine } from "@galacean/engine-core";
 export { MeshDecoder } from "./resources/mesh/MeshDecoder";
 export { Texture2DDecoder } from "./resources/texture2D/TextureDecoder";
 export { ReflectionParser } from "./resources/parser/ReflectionParser";
-export { PrefabParser } from "./resources/parser/PrefabParser";
+export { PrefabParser } from "./resources/prefab/PrefabParser";
 export * from "./resources/animationClip/AnimationClipDecoder";
 export type { IModelMesh } from "./resources/mesh/IModelMesh";
 /**
@@ -16,3 +16,4 @@ export * from "./resources/schema";
 export * from "./resources/scene/SceneParser";
 export * from "./resources/scene/MeshLoader";
 export * from "./resources/scene/EditorTextureLoader";
+export * from "./resources/parser/ParserContext";

package/types/resource-deserialize/resources/animationClip/AnimationClipDecoder.d.ts

@@ -1,6 +1,5 @@
 import { AnimationClip, Engine } from "@galacean/engine-core";
 import type { BufferReader } from "../../utils/BufferReader";
-export { ComponentMap } from "./ComponentMap";
 export declare enum InterpolableValueType {
     Float = 0,
     FloatArray = 1,

package/types/resource-deserialize/resources/parser/HierarchyParser.d.ts

@@ -0,0 +1,36 @@
+import { Entity, Engine, Scene } from "@galacean/engine-core";
+import type { IPrefabFile } from "../schema";
+import { ReflectionParser } from "./ReflectionParser";
+import { ParserContext } from "./ParserContext";
+/** @Internal */
+export default abstract class HierarchyParser<T extends Scene | Entity, V extends ParserContext<IPrefabFile, T>> {
+    readonly context: V;
+    /**
+     * The promise of parsed object.
+     */
+    readonly promise: Promise<T>;
+    protected _resolve: (item: T) => void;
+    protected _reject: (reason: any) => void;
+    protected _engine: Engine;
+    protected _reflectionParser: ReflectionParser;
+    private prefabContextMap;
+    private prefabPromiseMap;
+    constructor(context: V);
+    /** start parse the scene or prefab or others */
+    start(): void;
+    protected abstract handleRootEntity(id: string): void;
+    private _parseEntities;
+    private _parseComponents;
+    private _parsePrefabModification;
+    private _parsePrefabRemovedEntities;
+    private _parsePrefabRemovedComponents;
+    private _clearAndResolve;
+    private _organizeEntities;
+    private _getEntityByConfig;
+    private _parseEntity;
+    private _parseGLTF;
+    private _parseStrippedEntity;
+    private _parseChildren;
+    private _applyEntityData;
+    private _traverseAddEntityToMap;
+}

package/types/resource-deserialize/resources/parser/ParserContext.d.ts

@@ -0,0 +1,29 @@
+import { Component, EngineObject, Entity, ResourceManager } from "@galacean/engine-core";
+import type { IEntity } from "../schema";
+/**
+ * Parser context
+ * @export
+ * @abstract
+ * @class ParserContext
+ * @template T
+ * @template I
+ */
+export declare class ParserContext<T extends Object, I extends EngineObject> {
+    readonly originalData: T;
+    readonly engine: any;
+    target?: I;
+    entityMap: Map<string, Entity>;
+    components: Map<string, Component>;
+    assets: Map<string, any>;
+    entityConfigMap: Map<string, IEntity>;
+    rootIds: string[];
+    strippedIds: string[];
+    readonly resourceManager: ResourceManager;
+    constructor(originalData: T, engine: any, target?: I);
+    /**
+     * Destroy the context.
+     * @abstract
+     * @memberof ParserContext
+     */
+    destroy(): void;
+}

package/types/resource-deserialize/resources/parser/ReflectionParser.d.ts

@@ -1,11 +1,11 @@
-import { Entity } from "@galacean/engine-core";
-import type { IBasicType, IClassObject, IEntity } from "../schema";
-import { SceneParserContext } from "../scene/SceneParserContext";
+import { EngineObject, Entity } from "@galacean/engine-core";
+import type { IBasicType, IClassObject, IEntity, IPrefabFile } from "../schema";
+import { ParserContext } from "./ParserContext";
 export declare class ReflectionParser {
     private readonly _context;
     static customParseComponentHandles: Map<string, Function>;
     static registerCustomParseComponent(componentType: string, handle: Function): void;
-    constructor(_context: SceneParserContext);
+    constructor(_context: ParserContext<IPrefabFile, EngineObject>);
     parseEntity(entityConfig: IEntity): Promise<Entity>;
     parseClassObject(item: IClassObject): Promise<any>;
     parsePropsAndMethods(instance: any, item: Omit<IClassObject, "class">): Promise<any>;

package/types/resource-deserialize/resources/prefab/PrefabParser.d.ts

@@ -1,5 +1,14 @@
-import { Entity } from "@galacean/engine-core";
-import type { IEntity } from "./PrefabDesign";
-export declare class PrefabParser {
-    static parseChildren(entitiesConfig: Map<string, IEntity>, entities: Map<string, Entity>, parentId: string): void;
+import { Entity, Engine } from "@galacean/engine-core";
+import type { IPrefabFile } from "../schema";
+import { PrefabParserContext } from "./PrefabParserContext";
+import HierarchyParser from "../parser/HierarchyParser";
+export declare class PrefabParser extends HierarchyParser<Entity, PrefabParserContext> {
+    /**
+     * Parse prefab data.
+     * @param engine - the engine of the parser context
+     * @param prefabData - prefab data which is exported by editor
+     * @returns a promise of prefab
+     */
+    static parse(engine: Engine, prefabData: IPrefabFile): PrefabParser;
+    protected handleRootEntity(id: string): void;
 }

package/types/resource-deserialize/resources/prefab/PrefabParserContext.d.ts

@@ -0,0 +1,5 @@
+import { Entity } from "@galacean/engine-core";
+import { IPrefabFile } from "../schema";
+import { ParserContext } from "../parser/ParserContext";
+export declare class PrefabParserContext extends ParserContext<IPrefabFile, Entity> {
+}

package/types/resource-deserialize/resources/scene/SceneParser.d.ts

@@ -1,9 +1,9 @@
 import { Engine, Scene } from "@galacean/engine-core";
 import type { IScene } from "../schema";
 import { SceneParserContext } from "./SceneParserContext";
+import HierarchyParser from "../parser/HierarchyParser";
 /** @Internal */
-export declare class SceneParser {
-    readonly context: SceneParserContext;
+export declare class SceneParser extends HierarchyParser<Scene, SceneParserContext> {
     /**
      * Parse scene data.
      * @param engine - the engine of the parser context
@@ -11,19 +11,5 @@ export declare class SceneParser {
      * @returns a promise of scene
      */
     static parse(engine: Engine, sceneData: IScene): Promise<Scene>;
-    /**
-     * The promise of parsed scene.
-     */
-    readonly promise: Promise<Scene>;
-    private _resolve;
-    private _reject;
-    private _engine;
-    private _reflectionParser;
-    constructor(context: SceneParserContext);
-    /** start parse the scene */
-    start(): void;
-    private _parseEntities;
-    private _organizeEntities;
-    private _parseComponents;
-    private _clearAndResolveScene;
+    protected handleRootEntity(id: string): void;
 }

package/types/resource-deserialize/resources/scene/SceneParserContext.d.ts

@@ -1,15 +1,9 @@
-import { Component, Engine, Entity, ResourceManager, Scene } from "@galacean/engine-core";
-import type { IEntity, IScene } from "../schema";
-export declare class SceneParserContext {
+import { Scene } from "@galacean/engine-core";
+import { IScene } from "../schema";
+import { ParserContext } from "../parser/ParserContext";
+export declare class SceneParserContext extends ParserContext<IScene, Scene> {
     readonly originalData: IScene;
+    readonly engine: any;
     readonly scene: Scene;
-    entityMap: Map<string, Entity>;
-    components: Map<string, Component>;
-    assets: Map<string, any>;
-    entityConfigMap: Map<string, IEntity>;
-    rootIds: string[];
-    readonly engine: Engine;
-    readonly resourceManager: ResourceManager;
-    constructor(originalData: IScene, scene: Scene);
-    destroy(): void;
+    constructor(originalData: IScene, engine: any, scene: Scene);
 }

package/types/resource-deserialize/resources/schema/BasicSchema.d.ts

@@ -36,11 +36,34 @@ export interface IBasicEntity {
     parent?: string;
     layer?: Layer;
 }
-export type IEntity = IBasicEntity | IRefEntity;
+export type IEntity = IBasicEntity | IRefEntity | IStrippedEntity;
 export interface IRefEntity extends IBasicEntity {
     assetRefId: string;
     key?: string;
     isClone?: boolean;
+    modifications: {
+        target: IPrefabModifyTarget;
+        methods?: {
+            [methodName: string]: Array<IMethodParams>;
+        };
+        props?: {
+            [key: string]: IBasicType | IMethodParams;
+        };
+    }[];
+    removedEntities: IPrefabModifyTarget[];
+    removedComponents: IPrefabModifyTarget[];
+}
+export interface IPrefabModifyTarget {
+    entityId?: string;
+    componentId?: string;
+}
+export interface IStrippedEntity extends IBasicEntity {
+    strippedId: string;
+    prefabInstanceId: string;
+    prefabSource: {
+        assetId: string;
+        entityId: string;
+    };
 }
 export type IComponent = {
     id: string;