@galacean/engine-loader 1.2.0-alpha.1 → 1.2.0-alpha.10

package/package.json

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

package/types/PrimitiveMeshLoader.d.ts

@@ -0,0 +1 @@
+export {};

package/types/gltf/GLTFUtils.d.ts

@@ -40,9 +40,10 @@ export declare class GLTFUtils {
     /**
      * Parse the glb format.
      */
-    static parseGLB(context: GLTFParserContext, glb: ArrayBuffer): {
-        glTF: IGLTF;
-        buffers: ArrayBuffer[];
+    static parseGLB(context: GLTFParserContext, originBuffer: ArrayBuffer): {
+        glTF?: IGLTF;
+        buffers?: ArrayBuffer[];
+        originBuffer?: ArrayBuffer;
     };
     static parseSampler(texture: Texture2D, samplerInfo: ISamplerInfo): void;
     static getSamplerInfo(sampler: ISampler): ISamplerInfo;

package/types/gltf/parser/GLTFJSONParser.d.ts

@@ -0,0 +1,7 @@
+import { IGLTF } from "../GLTFSchema";
+import { GLTFParser } from "./GLTFParser";
+import { GLTFParserContext } from "./GLTFParserContext";
+export declare class GLTFJSONParser extends GLTFParser {
+    parse(context: GLTFParserContext): Promise<IGLTF>;
+    private _isGLB;
+}

package/types/gltf/parser/GLTFSchemaParser.d.ts

@@ -3,5 +3,4 @@ import { GLTFParser } from "./GLTFParser";
 import { GLTFParserContext } from "./GLTFParserContext";
 export declare class GLTFSchemaParser extends GLTFParser {
     parse(context: GLTFParserContext): Promise<IGLTF>;
-    private _isGLB;
 }

package/types/index.d.ts

@@ -10,19 +10,20 @@ import "./KTXCubeLoader";
 import "./KTXLoader";
 import "./MaterialLoader";
 import "./MeshLoader";
+import "./PrimitiveMeshLoader";
+import "./ProjectLoader";
 import "./SourceFontLoader";
 import "./SpriteAtlasLoader";
 import "./SpriteLoader";
 import "./Texture2DLoader";
 import "./TextureCubeLoader";
-import "./ProjectLoader";
 import "./ktx2/KTX2Loader";
+export { GLTFLoader } from "./GLTFLoader";
 export type { GLTFParams } from "./GLTFLoader";
 export * from "./SceneLoader";
 export type { Texture2DParams } from "./Texture2DLoader";
 export { parseSingleKTX } from "./compressed-texture";
 export * from "./gltf";
-export { GLTFLoader } from "./GLTFLoader";
 export { KTX2Loader, KTX2Transcoder } from "./ktx2/KTX2Loader";
 export { KTX2TargetFormat } from "./ktx2/KTX2TargetFormat";
 export * from "./resource-deserialize";

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;

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

@@ -32,6 +32,7 @@ export interface IScene extends IPrefabFile {
             shadowCascades: ShadowCascadesMode;
             shadowTwoCascadeSplits: number;
             shadowFourCascadeSplits: IVector3;
+            shadowFadeBorder: number;
         };
     };
     files: Array<{

package/types/ktx2/BinomialLLCTranscoder/BinomialLLCTranscoder.d.ts

@@ -1,13 +0,0 @@
-import { KTX2TargetFormat } from "../KTX2TargetFormat";
-import { TranscodeResult } from "../TranscodeResult";
-/** @internal */
-export declare class BinomialLLCTranscoder {
-    readonly workerLimit: number;
-    static MessageId: number;
-    private _transcodeWorkerPool;
-    private _initPromise;
-    constructor(workerLimit: number);
-    init(): Promise<any>;
-    transcode(buffer: ArrayBuffer, format: KTX2TargetFormat): Promise<TranscodeResult>;
-    destroy(): void;
-}

package/types/ktx2/BinomialLLCTranscoder/TranscodeWorkerCode.d.ts

@@ -1,33 +0,0 @@
-type MessageType = "init" | "transcode";
-export interface IBaseMessage {
-    type: MessageType;
-}
-export interface IInitMessage extends IBaseMessage {
-    type: "init";
-    transcoderWasm: ArrayBuffer;
-}
-export interface ITranscodeMessage extends IBaseMessage {
-    type: "transcode";
-    format: number;
-    buffer: ArrayBuffer;
-}
-export type IMessage = IInitMessage | ITranscodeMessage;
-export type TranscodeResult = {
-    width: number;
-    height: number;
-    hasAlpha: boolean;
-    format: number;
-    faces: Array<{
-        data: Uint8Array;
-        width: number;
-        height: number;
-    }>[];
-    faceCount: number;
-};
-export type TranscodeResponse = {
-    id: number;
-    type: "transcoded";
-} & TranscodeResult;
-/** @internal */
-export declare function TranscodeWorkerCode(): void;
-export {};

package/types/ktx2/KhronosTranscoder/KhronosTranscoder.d.ts

@@ -1,17 +0,0 @@
-import { KTX2Container } from "../KTX2Container";
-import { KTX2TargetFormat } from "../KTX2TargetFormat";
-import { TranscodeResult } from "./TranscoderWorkerCode";
-/** @internal */
-export declare class KhronosTranscoder {
-    readonly workerLimit: number;
-    readonly type: KTX2TargetFormat;
-    static transcoderMap: {
-        0: string;
-    };
-    private _transcodeWorkerPool;
-    private _initPromise;
-    constructor(workerLimit: number, type: KTX2TargetFormat);
-    init(): Promise<any>;
-    transcode(ktx2Container: KTX2Container): Promise<TranscodeResult>;
-    destroy(): void;
-}

package/types/ktx2/KhronosTranscoder/TranscoderWorkerCode.d.ts

@@ -1,34 +0,0 @@
-export interface EncodedData {
-    buffer: Uint8Array;
-    levelWidth: number;
-    levelHeight: number;
-    uncompressedByteLength: number;
-}
-type MessageType = "init" | "transcode";
-export interface IBaseMessage {
-    type: MessageType;
-}
-export interface IInitMessage extends IBaseMessage {
-    type: "init";
-    transcoderWasm: ArrayBuffer;
-}
-export interface ITranscodeMessage extends IBaseMessage {
-    type: "transcode";
-    format: number;
-    needZstd: boolean;
-    data: EncodedData[][];
-}
-export type IMessage = IInitMessage | ITranscodeMessage;
-export type TranscodeResult = {
-    data: Array<{
-        data: Uint8Array;
-        width: number;
-        height: number;
-    }>;
-};
-export type TranscodeResponse = {
-    id: number;
-    type: "transcoded";
-} & TranscodeResult;
-export declare function TranscodeWorkerCode(): void;
-export {};

package/types/ktx2/TranscodeResult.d.ts

@@ -1,10 +0,0 @@
-export interface TranscodeResult {
-    width: number;
-    height: number;
-    hasAlpha: boolean;
-    mipmaps: Array<{
-        data: Uint8Array;
-        width: number;
-        height: number;
-    }>;
-}

package/types/ktx2/constants.d.ts

@@ -1,7 +0,0 @@
-export declare enum SupercompressionScheme {
-    None = 0,
-    BasisLZ = 1,
-    Zstd = 2,
-    ZLib = 3
-}
-export declare const KHR_DF_SAMPLE_DATATYPE_SIGNED = 64;

package/types/ktx2/zstddec.d.ts

@@ -1,62 +0,0 @@
-/**
- * From https://github.com/donmccurdy/zstddec by Don McCurdy
- */
-interface DecoderExports {
-    memory: Uint8Array;
-    ZSTD_findDecompressedSize: (compressedPtr: number, compressedSize: number) => number;
-    ZSTD_decompress: (uncompressedPtr: number, uncompressedSize: number, compressedPtr: number, compressedSize: number) => number;
-    malloc: (ptr: number) => number;
-    free: (ptr: number) => void;
-}
-/**
- * ZSTD (Zstandard) decoder.
- */
-export declare class ZSTDDecoder {
-    static heap: Uint8Array;
-    static IMPORT_OBJECT: {
-        env: {
-            emscripten_notify_memory_growth: () => void;
-        };
-    };
-    static instance: {
-        exports: DecoderExports;
-    };
-    static WasmModuleURL: string;
-    _initPromise: Promise<any>;
-    init(): Promise<void>;
-    _init(result: WebAssembly.WebAssemblyInstantiatedSource): void;
-    decode(array: Uint8Array, uncompressedSize?: number): Uint8Array;
-}
-export {};
-/**
- * BSD License
- *
- * For Zstandard software
- *
- * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- *  * Redistributions of source code must retain the above copyright notice, this
- *    list of conditions and the following disclaimer.
- *
- *  * Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
- *
- *  * Neither the name Facebook nor the names of its contributors may be used to
- *    endorse or promote products derived from this software without specific
- *    prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
- * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */