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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-loader",
-  "version": "1.2.0-alpha.0",
+  "version": "1.2.0-alpha.10",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,9 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-rhi-webgl": "1.2.0-alpha.0",
-    "@galacean/engine-core": "1.2.0-alpha.0",
-    "@galacean/engine-draco": "1.2.0-alpha.0",
-    "@galacean/engine-math": "1.2.0-alpha.0"
+    "@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/GLTFLoader.d.ts

@@ -1,6 +1,12 @@
-import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine-core";
+import { AssetPromise, Engine, EngineConfiguration, Loader, LoadItem, ResourceManager } from "@galacean/engine-core";
 import { GLTFResource } from "./gltf/GLTFResource";
 export declare class GLTFLoader extends Loader<GLTFResource> {
+    /**
+     * Release glTF loader memory(includes meshopt workers).
+     * @remarks If use loader after releasing, we should release again.
+     */
+    static release(): void;
+    initialize(_: Engine, configuration: EngineConfiguration): Promise<void>;
     load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<GLTFResource>;
 }
 /**

package/types/PrimitiveMeshLoader.d.ts

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

package/types/gltf/GLTFSchema.d.ts

@@ -419,7 +419,7 @@ export interface IBufferView extends IChildRootProperty {
      */
     byteOffset?: number;
     /**
-     * The lenth of the bufferView in bytes
+     * The length of the bufferView in bytes
      */
     byteLength: number;
     /**

package/types/gltf/GLTFUtils.d.ts

@@ -30,7 +30,7 @@ export declare class GLTFUtils {
     /**
      * Get accessor data.
      */
-    static processingSparseData(bufferViews: IBufferView[], accessor: IAccessor, buffers: ArrayBuffer[], bufferInfo: BufferInfo): void;
+    static processingSparseData(context: GLTFParserContext, accessor: IAccessor, bufferInfo: BufferInfo): Promise<void>;
     static getIndexFormat(type: AccessorComponentType): IndexFormat;
     static getElementFormat(type: AccessorComponentType, size: number, normalized?: boolean): VertexElementFormat;
     /**
@@ -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/extensions/EXT_meshopt_compression.d.ts

@@ -0,0 +1,13 @@
+declare module "@galacean/engine-core" {
+    interface EngineConfiguration {
+        /** glTF loader options. */
+        glTF?: {
+            /** Meshopt options. If set this option and workCount is great than 0, workers will be created. */
+            meshOpt?: {
+                /** Worker count for transcoder, default is 4. */
+                workerCount: number;
+            };
+        };
+    }
+}
+export {};

package/types/gltf/extensions/GLTFExtensionParser.d.ts

@@ -19,7 +19,7 @@ export declare abstract class GLTFExtensionParser {
      * @param extensionOwnerSchema - The extension owner schema
      * @returns The resource or promise
      */
-    createAndParse(context: GLTFParserContext, extensionSchema: GLTFExtensionSchema, extensionOwnerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | Promise<EngineObject>;
+    createAndParse(context: GLTFParserContext, extensionSchema: GLTFExtensionSchema, extensionOwnerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | Promise<EngineObject | Uint8Array>;
     /**
      * Additive parse to the resource.
      * @param context - The parser context

package/types/gltf/extensions/GLTFExtensionSchema.d.ts

@@ -18,15 +18,6 @@ export interface IKHRLightsPunctual_Light {
 export interface IKHRLightsPunctual {
     lights: IKHRLightsPunctual_Light[];
 }
-/**
- * Interfaces from the KHR_draco_mesh_compression extension
- */
-export interface IKHRDracoMeshCompression {
-    bufferView: number;
-    attributes: {
-        [name: string]: number;
-    };
-}
 /**
  * Interfaces from the KHR_materials_clearcoat extension
  */
@@ -142,6 +133,15 @@ export interface IKHRXmp {
 export interface IKHRXmp_Node {
     packet: number;
 }
+export interface IEXTMeshoptCompressionSchema {
+    buffer: number;
+    byteOffset?: number;
+    byteLength: number;
+    byteStride: number;
+    mode: "ATTRIBUTES" | "TRIANGLES" | "INDICES";
+    count: number;
+    filter?: "NONE" | "OCTAHEDRAL" | "QUATERNION" | "EXPONENTIAL";
+}
 export interface IGalaceanMaterialRemap {
     refId: string;
     key?: string;
@@ -154,4 +154,4 @@ export interface IGalaceanAnimation {
         parameter: any;
     }[];
 }
-export type GLTFExtensionSchema = IKHRLightsPunctual_Light | IKHRDracoMeshCompression | IKHRMaterialsClearcoat | IKHRMaterialsIor | IKHRMaterialsUnlit | IKHRMaterialsPbrSpecularGlossiness | IKHRMaterialsSheen | IKHRMaterialsSpecular | IKHRMaterialsTransmission | IKHRMaterialsTranslucency | IKHRMaterialVariants_Mapping | IKHRMaterialVariants_Variants | IKHRMaterialsAnisotropy | IKHRTextureBasisU | IKHRTextureTransform | IKHRXmp | IKHRXmp_Node | IGalaceanAnimation | Object;
+export type GLTFExtensionSchema = IKHRLightsPunctual_Light | IKHRMaterialsClearcoat | IKHRMaterialsIor | IKHRMaterialsUnlit | IKHRMaterialsPbrSpecularGlossiness | IKHRMaterialsSheen | IKHRMaterialsSpecular | IKHRMaterialsTransmission | IKHRMaterialsTranslucency | IKHRMaterialVariants_Mapping | IKHRMaterialVariants_Variants | IKHRMaterialsAnisotropy | IKHRTextureBasisU | IKHRTextureTransform | IKHRXmp | IKHRXmp_Node | IGalaceanAnimation | Object;

package/types/gltf/extensions/MeshoptDecoder.d.ts

@@ -0,0 +1,8 @@
+declare const MeshoptDecoder: {
+    workerCount: number;
+    ready: Promise<void>;
+    useWorkers: () => void;
+    decodeGltfBuffer: (count: any, stride: any, source: any, mode: any, filter: any) => Promise<Uint8Array>;
+    release(): void;
+};
+export { MeshoptDecoder };

package/types/gltf/extensions/index.d.ts

@@ -1,4 +1,3 @@
-import "./KHR_draco_mesh_compression";
 import "./KHR_lights_punctual";
 import "./KHR_materials_clearcoat";
 import "./KHR_materials_ior";
@@ -14,6 +13,7 @@ import "./KHR_texture_transform";
 import "./KHR_materials_ior";
 import "./GALACEAN_materials_remap";
 import "./GALACEAN_animation_event";
+import "./EXT_meshopt_compression";
 import "./KHR_materials_anisotropy";
 export { GLTFExtensionParser, GLTFExtensionMode } from "./GLTFExtensionParser";
 export * from "./GLTFExtensionSchema";

package/types/gltf/index.d.ts

@@ -2,4 +2,5 @@ export { GLTFResource } from "./GLTFResource";
 export { GLTFUtils } from "./GLTFUtils";
 export * from "./parser";
 export * from "./extensions/index";
-export type { IMaterial, IMeshPrimitive, ITextureInfo, INode, GLTFExtensionOwnerSchema } from "./GLTFSchema";
+export { AccessorType } from "./GLTFSchema";
+export type { IMaterial, IMeshPrimitive, ITextureInfo, INode, GLTFExtensionOwnerSchema, IGLTF, IMesh } from "./GLTFSchema";

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

@@ -0,0 +1,5 @@
+import { GLTFParserContext } from "./GLTFParserContext";
+import { GLTFParser } from "./GLTFParser";
+export declare class GLTFBufferViewParser extends GLTFParser {
+    parse(context: GLTFParserContext, index: number): Promise<Uint8Array>;
+}

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

@@ -17,7 +17,7 @@ export declare abstract class GLTFParser {
      */
     static executeExtensionsCreateAndParse(extensions: {
         [key: string]: any;
-    }, context: GLTFParserContext, ownerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | void | Promise<EngineObject | void>;
+    }, context: GLTFParserContext, ownerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | void | Promise<EngineObject | Uint8Array | void>;
     /**
      * Execute all parses of extension to parse resource.
      * @param extensions - Related extensions field

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

@@ -59,11 +59,12 @@ export declare enum GLTFParserType {
     Validator = 1,
     Scene = 2,
     Buffer = 3,
-    Texture = 4,
-    Material = 5,
-    Mesh = 6,
-    Entity = 7,
-    Skin = 8,
-    Animation = 9
+    BufferView = 4,
+    Texture = 5,
+    Material = 6,
+    Mesh = 7,
+    Entity = 8,
+    Skin = 9,
+    Animation = 10
 }
 export declare function registerGLTFParser(pipeline: GLTFParserType): (Parser: new () => GLTFParser) => void;

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/gltf/parser/index.d.ts

@@ -9,4 +9,5 @@ export { GLTFSceneParser } from "./GLTFSceneParser";
 export { GLTFSkinParser } from "./GLTFSkinParser";
 export { GLTFTextureParser } from "./GLTFTextureParser";
 export { GLTFValidator } from "./GLTFValidator";
-export { GLTFParserContext, GLTFParserType, registerGLTFParser } from "./GLTFParserContext";
+export { GLTFParserContext, GLTFParserType, registerGLTFParser, BufferInfo } from "./GLTFParserContext";
+export { GLTFBufferViewParser } from "./GLTFBufferViewParser";

package/types/index.d.ts

@@ -10,13 +10,15 @@ 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";

package/types/ktx2/KTX2Loader.d.ts

@@ -8,9 +8,10 @@ export declare class KTX2Loader extends Loader<Texture2D | TextureCube> {
     private static _priorityFormats;
     private static _supportedMap;
     /**
-     * Destroy ktx2 transcoder worker.
+     * Release ktx2 transcoder worker.
+     * @remarks If use loader after releasing, we should release again.
      */
-    static destroy(): void;
+    static release(): void;
     /** @internal */
     static _parseBuffer(buffer: Uint8Array, engine: Engine, params?: KTX2Params): Promise<{
         engine: Engine;
@@ -50,7 +51,7 @@ export declare enum KTX2Transcoder {
 }
 declare module "@galacean/engine-core" {
     interface EngineConfiguration {
-        /** KTX2 loader options. */
+        /** KTX2 loader options. If set this option and workCount is great than 0, workers will be created. */
         ktx2Loader?: {
             /** Worker count for transcoder, default is 4. */
             workerCount?: number;

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

@@ -1,3 +1,4 @@
+import { Layer } from "@galacean/engine-core";
 export interface IVector3 {
     x: number;
     y: number;
@@ -33,12 +34,36 @@ export interface IBasicEntity {
     scale?: IVector3;
     children?: Array<string>;
     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<{