@galacean/engine-loader 1.0.0-beta.9 → 1.0.1

package/types/ktx2/zstddec.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */

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

@@ -1,8 +1,8 @@
 import { Engine } from "@galacean/engine-core";
 export { MeshDecoder } from "./resources/mesh/MeshDecoder";
 export { Texture2DDecoder } from "./resources/texture2D/TextureDecoder";
-export { ReflectionParser } from "./resources/prefab/ReflectionParser";
-export { PrefabParser } from "./resources/prefab/PrefabParser";
+export { ReflectionParser } from "./resources/parser/ReflectionParser";
+export { PrefabParser } from "./resources/parser/PrefabParser";
 export * from "./resources/animationClip/AnimationClipDecoder";
 export type { IModelMesh } from "./resources/mesh/IModelMesh";
 /**
@@ -12,7 +12,7 @@ export type { IModelMesh } from "./resources/mesh/IModelMesh";
  * @returns
  */
 export declare function decode<T>(arrayBuffer: ArrayBuffer, engine: Engine): Promise<T>;
-export * from "./resources/prefab/PrefabDesign";
+export * from "./resources/schema";
 export * from "./resources/scene/SceneParser";
 export * from "./resources/scene/MeshLoader";
 export * from "./resources/scene/EditorTextureLoader";

package/types/resource-deserialize/resources/mesh/MeshDecoder.d.ts

@@ -1,5 +1,5 @@
-import { ModelMesh } from "@galacean/engine-core";
 import type { Engine } from "@galacean/engine-core";
+import { ModelMesh } from "@galacean/engine-core";
 import type { BufferReader } from "../../utils/BufferReader";
 /**
  * @todo refactor

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

@@ -0,0 +1,5 @@
+import { Entity } from "@galacean/engine-core";
+import type { IEntity } from "../schema";
+export declare class PrefabParser {
+    static parseChildren(entitiesConfig: Map<string, IEntity>, entities: Map<string, Entity>, parentId: string): void;
+}

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

@@ -0,0 +1,14 @@
+import { Engine, Entity } from "@galacean/engine-core";
+import type { IBasicType, IClassObject, IEntity } from "../schema";
+export declare class ReflectionParser {
+    static customParseComponentHandles: Map<string, Function>;
+    static registerCustomParseComponent(componentType: string, handle: Function): void;
+    static parseEntity(entityConfig: IEntity, engine: Engine): Promise<Entity>;
+    private static getEntityByConfig;
+    static parseClassObject(item: IClassObject, engine: Engine, resourceManager?: any): Promise<any>;
+    static parseBasicType(value: IBasicType, engine: Engine, resourceManager?: any): Promise<any>;
+    static parsePropsAndMethods(instance: any, item: Omit<IClassObject, "class">, engine: Engine, resourceManager?: any): Promise<any>;
+    static parseMethod(instance: any, methodName: string, methodParams: Array<IBasicType>, engine: Engine, resourceManager?: any): Promise<any>;
+    private static _isClass;
+    private static _isRef;
+}

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

@@ -1,5 +1,5 @@
 import type { BackgroundMode } from "@galacean/engine-core";
-import { IReferable } from "@galacean/engine-core/types/asset/IReferable";
+import { IRefObject } from "@galacean/engine-core/types/asset/IRefObject";
 import { IColor } from "../mesh/IModelMesh";
 export interface IPrefabFile {
     entities: Array<IEntity>;
@@ -9,11 +9,11 @@ export interface IScene extends IPrefabFile {
         background: {
             mode: BackgroundMode;
             color: IColor;
-            texture?: IReferable;
-            sky?: IReferable;
+            texture?: IRefObject;
+            sky?: IRefObject;
         };
         ambient: {
-            ambientLight: IReferable;
+            ambientLight: IRefObject;
             diffuseSolidColor: IColor;
             diffuseIntensity: number;
             specularIntensity: number;

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

@@ -1,5 +1,5 @@
 import { Engine, Scene } from "@galacean/engine-core";
-import { IScene } from "../prefab/PrefabDesign";
+import type { IScene } from "../schema";
 import { SceneParserContext } from "./SceneParserContext";
 /** @Internal */
 export declare class SceneParser {

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

@@ -1,5 +1,5 @@
 import { Component, Entity, Scene } from "@galacean/engine-core";
-import { IEntity, IScene } from "../prefab/PrefabDesign";
+import type { IEntity, IScene } from "../schema";
 export declare class SceneParserContext {
     readonly originalData: IScene;
     readonly scene: Scene;

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

@@ -0,0 +1,61 @@
+export interface IVector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface IVector2 {
+    x: number;
+    y: number;
+}
+export interface IVector4 {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+export interface IColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface IPrefabFile {
+    entities: Array<IEntity>;
+}
+export type IMethodParams = Array<IBasicType>;
+export type IClassObject = {
+    class: string;
+    constructParams?: IMethodParams;
+    methods?: {
+        [methodName: string]: Array<IMethodParams>;
+    };
+    props?: {
+        [key: string]: IBasicType | IMethodParams;
+    };
+};
+export type IBasicType = string | number | boolean | null | undefined | IAssetRef | IClassObject | IMethodParams;
+export type IAssetRef = {
+    key?: string;
+    refId: string;
+};
+export interface IBasicEntity {
+    name?: string;
+    id?: string;
+    components?: Array<IComponent>;
+    isActive?: boolean;
+    position?: IVector3;
+    rotation?: IVector3;
+    scale?: IVector3;
+    children?: Array<string>;
+    parent?: string;
+}
+export type IEntity = IBasicEntity | IRefEntity;
+export interface IRefEntity extends IBasicEntity {
+    assetRefId: string;
+    key?: string;
+    isClone?: boolean;
+}
+export type IComponent = {
+    id: string;
+    refId?: string;
+} & IClassObject;

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

@@ -0,0 +1,91 @@
+import { BlendFactor, BlendOperation, ColorWriteMask, CompareFunction, CullMode, RenderQueueType, StencilOperation } from "@galacean/engine-core";
+import type { IAssetRef, IColor, IVector2, IVector3 } from "./BasicSchema";
+export interface IRenderState {
+    /** Blend state. */
+    blendState: {
+        /** The blend state of the render target. */
+        targetBlendState: {
+            /** Whether to enable blend. */
+            enabled: boolean;
+            /** color (RGB) blend operation. */
+            colorBlendOperation: BlendOperation;
+            /** alpha (A) blend operation. */
+            alphaBlendOperation: BlendOperation;
+            /** color blend factor (RGB) for source. */
+            sourceColorBlendFactor: BlendFactor;
+            /** alpha blend factor (A) for source. */
+            sourceAlphaBlendFactor: BlendFactor;
+            /** color blend factor (RGB) for destination. */
+            destinationColorBlendFactor: BlendFactor;
+            /** alpha blend factor (A) for destination. */
+            destinationAlphaBlendFactor: BlendFactor;
+            /** color mask. */
+            colorWriteMask: ColorWriteMask;
+        };
+        blendColor: IColor;
+        /** Whether to use (Alpha-to-Coverage) technology. */
+        alphaToCoverage: boolean;
+    };
+    /** Depth state. */
+    depthState: {
+        /** Whether to enable the depth test. */
+        enabled: boolean;
+        /** Whether the depth value can be written.*/
+        writeEnabled: boolean;
+        /** Depth comparison function. */
+        compareFunction: CompareFunction;
+    };
+    /** Stencil state. */
+    stencilState: {
+        /** Whether to enable stencil test. */
+        enabled: boolean;
+        /** Write the reference value of the stencil buffer. */
+        referenceValue: number;
+        /** Specifying a bit-wise mask that is used to AND the reference value and the stored stencil value when the test is done. */
+        mask: number;
+        /** Specifying a bit mask to enable or disable writing of individual bits in the stencil planes. */
+        writeMask: number;
+        /** The comparison function of the reference value of the front face of the geometry and the current buffer storage value. */
+        compareFunctionFront: CompareFunction;
+        /** The comparison function of the reference value of the back of the geometry and the current buffer storage value. */
+        compareFunctionBack: CompareFunction;
+        /** specifying the function to use for front face when both the stencil test and the depth test pass. */
+        passOperationFront: StencilOperation;
+        /** specifying the function to use for back face when both the stencil test and the depth test pass. */
+        passOperationBack: StencilOperation;
+        /** specifying the function to use for front face when the stencil test fails. */
+        failOperationFront: StencilOperation;
+        /** specifying the function to use for back face when the stencil test fails. */
+        failOperationBack: StencilOperation;
+        /** specifying the function to use for front face when the stencil test passes, but the depth test fails. */
+        zFailOperationFront: StencilOperation;
+        /** specifying the function to use for back face when the stencil test passes, but the depth test fails. */
+        zFailOperationBack: StencilOperation;
+    };
+    /** Raster state. */
+    rasterState: {
+        /** Specifies whether or not front- and/or back-facing polygons can be culled. */
+        cullMode: CullMode;
+        /** The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset. */
+        depthBias: number;
+        /** The scale factor for the variable depth offset for each polygon. */
+        slopeScaledDepthBias: number;
+    };
+    /** Render queue type. */
+    renderQueueType: RenderQueueType;
+}
+export interface IMaterialSchema {
+    name: string;
+    shader: string;
+    shaderData: {
+        [key: string]: {
+            type: "Vector2" | "Vector3" | "Vector4" | "Color" | "Float" | "Texture";
+            value: IVector3 | IVector2 | IColor | number | IAssetRef;
+        };
+    };
+    macros: Array<{
+        name: string;
+        value?: string;
+    }>;
+    renderState: IRenderState;
+}

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

@@ -0,0 +1,9 @@
+export interface IProject {
+    scene: string;
+    files: {
+        virtualPath: string;
+        path: string;
+        type: string;
+        id: string;
+    }[];
+}

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

@@ -0,0 +1,41 @@
+import { BackgroundMode, DiffuseMode, ShadowCascadesMode, ShadowResolution } from "@galacean/engine-core";
+import type { IReferable } from "@galacean/engine-core/types/asset/IReferable";
+import type { IColor, IPrefabFile } from "./BasicSchema";
+export declare enum SpecularMode {
+    Sky = "Sky",
+    Custom = "Custom"
+}
+export interface IScene extends IPrefabFile {
+    scene: {
+        background: {
+            mode: BackgroundMode;
+            color: IColor;
+            texture?: IReferable;
+            skyMesh?: IReferable;
+            skyMaterial?: IReferable;
+        };
+        ambient: {
+            diffuseMode: DiffuseMode;
+            ambientLight: IReferable;
+            customAmbientLight: IReferable;
+            customSpecularTexture: IReferable;
+            diffuseSolidColor: IColor;
+            diffuseIntensity: number;
+            specularIntensity: number;
+            specularMode: SpecularMode;
+            bakerResolution: number;
+        };
+        shadow?: {
+            castShadows: boolean;
+            shadowResolution: ShadowResolution;
+            shadowDistance: number;
+            shadowCascades: ShadowCascadesMode;
+        };
+    };
+    files: Array<{
+        id: string;
+        type: string;
+        virtualPath: string;
+        path: string;
+    }>;
+}

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

@@ -0,0 +1,3 @@
+export * from "./BasicSchema";
+export * from "./MaterialSchema";
+export * from "./SceneSchema";