@galacean/engine-loader 1.2.0-beta.5 → 1.3.0-alpha.0

package/package.json

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

package/types/PrefabLoader.d.ts

@@ -0,0 +1,5 @@
+import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine-core";
+import { PrefabResource } from "./prefab/PrefabResource";
+export declare class PrefabLoader extends Loader<PrefabResource> {
+    load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<PrefabResource>;
+}

package/types/gltf/GLTFResource.d.ts

@@ -1,6 +1,6 @@
 import { AnimationClip, AnimatorController, Camera, Engine, Entity, Light, Material, ModelMesh, ReferResource, Skin, Texture2D } from "@galacean/engine-core";
 /**
- * Product after glTF parser, usually, `defaultSceneRoot` is only needed to use.
+ * The glTF resource.
  */
 export declare class GLTFResource extends ReferResource {
     /** glTF file url. */

package/types/gltf/GLTFSchema.d.ts

@@ -694,7 +694,7 @@ export interface IScene extends IChildRootProperty {
     /**
      * The indices of each root node
      */
-    nodes: number[];
+    nodes?: number[];
 }
 /**
  * Joints and matrices defining a skin

package/types/index.d.ts

@@ -4,6 +4,7 @@ import "./BufferLoader";
 import "./EnvLoader";
 import "./FontLoader";
 import "./GLTFLoader";
+import "./PrefabLoader";
 import "./HDRLoader";
 import "./JSONLoader";
 import "./KTXCubeLoader";
@@ -27,3 +28,5 @@ export * from "./gltf";
 export { KTX2Loader, KTX2Transcoder } from "./ktx2/KTX2Loader";
 export { KTX2TargetFormat } from "./ktx2/KTX2TargetFormat";
 export * from "./resource-deserialize";
+export * from "./prefab/PrefabResource";
+export { PrefabLoader } from "./PrefabLoader";

package/types/prefab/PrefabParser.d.ts

@@ -0,0 +1,11 @@
+import { Engine, Entity } from "@galacean/engine-core";
+import { HierarchyParser } from "../resource-deserialize/resources/parser/HierarchyParser";
+import { PrefabResource } from "./PrefabResource";
+import { IHierarchyFile, ParserContext } from "../resource-deserialize";
+export declare class PrefabParser extends HierarchyParser<PrefabResource, ParserContext<IHierarchyFile, Entity>> {
+    readonly prefabResource: PrefabResource;
+    static parse(engine: Engine, url: string, data: IHierarchyFile): Promise<PrefabResource>;
+    constructor(data: IHierarchyFile, context: ParserContext<IHierarchyFile, Entity>, prefabResource: PrefabResource);
+    protected _handleRootEntity(id: string): void;
+    protected _clearAndResolve(): PrefabResource;
+}

package/types/prefab/PrefabResource.d.ts

@@ -0,0 +1,25 @@
+import { Engine, Entity, ReferResource } from "@galacean/engine-core";
+/**
+ * The Prefab resource.
+ */
+export declare class PrefabResource extends ReferResource {
+    readonly url: string;
+    /** @internal */
+    _root: Entity;
+    private _dependenceAssets;
+    /**
+     * @internal
+     * @param url - The url of the prefab
+     */
+    constructor(engine: Engine, url: string);
+    /**
+     * Instantiate prefab.
+     * @returns prefab's root entity
+     */
+    instantiate(): Entity;
+    /**
+     * @internal
+     */
+    _addDependenceAsset(resource: ReferResource): void;
+    protected _onDestroy(): void;
+}

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

@@ -2,7 +2,6 @@ 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/prefab/PrefabParser";
 export * from "./resources/animationClip/AnimationClipDecoder";
 export type { IModelMesh } from "./resources/mesh/IModelMesh";
 /**

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

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

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

@@ -1,29 +1,30 @@
-import { Component, EngineObject, Entity, ResourceManager } from "@galacean/engine-core";
-import type { IEntity } from "../schema";
+import { Component, Engine, EngineObject, Entity, ReferResource, ResourceManager, Scene } from "@galacean/engine-core";
+import type { IEntity, IHierarchyFile } from "../schema";
+export declare enum ParserType {
+    Prefab = 0,
+    Scene = 1
+}
 /**
  * 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;
+export declare class ParserContext<T extends IHierarchyFile, I extends EngineObject> {
+    readonly engine: Engine;
+    readonly type: ParserType;
+    readonly resource: ReferResource | Scene;
     entityMap: Map<string, Entity>;
-    components: Map<string, Component>;
-    assets: Map<string, any>;
     entityConfigMap: Map<string, IEntity>;
+    components: Map<string, Component>;
     rootIds: string[];
     strippedIds: string[];
     readonly resourceManager: ResourceManager;
-    constructor(originalData: T, engine: any, target?: I);
+    constructor(engine: Engine, type: ParserType, resource: ReferResource | Scene);
     /**
      * Destroy the context.
-     * @abstract
      * @memberof ParserContext
      */
-    destroy(): void;
+    clear(): void;
 }

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

@@ -1,11 +1,11 @@
 import { EngineObject, Entity } from "@galacean/engine-core";
-import type { IBasicType, IClassObject, IEntity, IPrefabFile } from "../schema";
+import type { IBasicType, IClassObject, IEntity, IHierarchyFile } 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: ParserContext<IPrefabFile, EngineObject>);
+    constructor(_context: ParserContext<IHierarchyFile, 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/scene/SceneParser.d.ts

@@ -1,9 +1,10 @@
 import { Engine, Scene } from "@galacean/engine-core";
 import type { IScene } from "../schema";
-import { SceneParserContext } from "./SceneParserContext";
-import HierarchyParser from "../parser/HierarchyParser";
+import { HierarchyParser } from "../parser/HierarchyParser";
+import { ParserContext } from "../parser/ParserContext";
 /** @Internal */
-export declare class SceneParser extends HierarchyParser<Scene, SceneParserContext> {
+export declare class SceneParser extends HierarchyParser<Scene, ParserContext<IScene, Scene>> {
+    readonly scene: Scene;
     /**
      * Parse scene data.
      * @param engine - the engine of the parser context
@@ -11,5 +12,7 @@ export declare class SceneParser extends HierarchyParser<Scene, SceneParserConte
      * @returns a promise of scene
      */
     static parse(engine: Engine, sceneData: IScene): Promise<Scene>;
-    protected handleRootEntity(id: string): void;
+    constructor(data: IScene, context: ParserContext<IScene, Scene>, scene: Scene);
+    protected _handleRootEntity(id: string): void;
+    protected _clearAndResolve(): Scene;
 }

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

@@ -20,7 +20,7 @@ export interface IColor {
     b: number;
     a: number;
 }
-export interface IPrefabFile {
+export interface IHierarchyFile {
     entities: Array<IEntity>;
 }
 export type IMethodParams = Array<IBasicType>;

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

@@ -1,16 +1,17 @@
-import { BackgroundMode, DiffuseMode, FogMode, ShadowCascadesMode, ShadowResolution } from "@galacean/engine-core";
+import { BackgroundMode, BackgroundTextureFillMode, DiffuseMode, FogMode, ShadowCascadesMode, ShadowResolution } from "@galacean/engine-core";
 import type { IReferable } from "@galacean/engine-core/types/asset/IReferable";
-import type { IColor, IPrefabFile, IVector3 } from "./BasicSchema";
+import type { IColor, IHierarchyFile, IVector3 } from "./BasicSchema";
 export declare enum SpecularMode {
     Sky = "Sky",
     Custom = "Custom"
 }
-export interface IScene extends IPrefabFile {
+export interface IScene extends IHierarchyFile {
     scene: {
         background: {
             mode: BackgroundMode;
             color: IColor;
             texture?: IReferable;
+            textureFillMode?: BackgroundTextureFillMode;
             skyMesh?: IReferable;
             skyMaterial?: IReferable;
         };