@galacean/engine-loader 0.9.18 → 0.9.20

package/package.json

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

package/types/GLTFContentRestorer.d.ts

@@ -1,8 +1,8 @@
-import { AssetPromise, BlendShape, Buffer, ContentRestorer, ModelMesh, Texture2D } from "@galacean/engine-core";
+import { AssetPromise, BlendShape, Buffer, ContentRestorer, ModelMesh, Texture2D, TypedArray } from "@galacean/engine-core";
 import { RequestConfig } from "@galacean/engine-core/types/asset/request";
 import { Vector2 } from "@galacean/engine-math";
 import { GLTFResource } from "./gltf/GLTFResource";
-import { IBufferView } from "./gltf/GLTFSchema";
+import type { IBufferView } from "./gltf/GLTFSchema";
 /**
  * @internal
  */
@@ -65,18 +65,28 @@ export declare class BufferDataRestoreInfo {
  */
 export declare class RestoreDataAccessor {
     bufferIndex: number;
-    TypedArray: new (buffer: ArrayBuffer, byteOffset: number, length?: number) => ArrayBufferView;
+    TypedArray: new (buffer: ArrayBuffer, byteOffset: number, length?: number) => TypedArray;
     byteOffset: number;
     length: number;
-    constructor(bufferIndex: number, TypedArray: new (buffer: ArrayBuffer, byteOffset: number, length?: number) => ArrayBufferView, byteOffset: number, length: number);
+    constructor(bufferIndex: number, TypedArray: new (buffer: ArrayBuffer, byteOffset: number, length?: number) => TypedArray, byteOffset: number, length: number);
 }
 /**
  * @internal
  */
 export declare class BlendShapeRestoreInfo {
     blendShape: BlendShape;
-    position: BufferDataRestoreInfo;
-    normal?: BufferDataRestoreInfo;
-    tangent?: BufferDataRestoreInfo;
-    constructor(blendShape: BlendShape, position: BufferDataRestoreInfo, normal?: BufferDataRestoreInfo, tangent?: BufferDataRestoreInfo);
+    position: BlendShapeDataRestoreInfo;
+    normal?: BlendShapeDataRestoreInfo;
+    tangent?: BlendShapeDataRestoreInfo;
+    constructor(blendShape: BlendShape, position: BlendShapeDataRestoreInfo, normal?: BlendShapeDataRestoreInfo, tangent?: BlendShapeDataRestoreInfo);
+}
+/**
+ * @internal
+ */
+export declare class BlendShapeDataRestoreInfo {
+    buffer: BufferDataRestoreInfo;
+    stride: number;
+    byteOffset: number;
+    count: number;
+    constructor(buffer: BufferDataRestoreInfo, stride: number, byteOffset: number, count: number);
 }

package/types/gltf/GLTFUtils.d.ts

@@ -17,9 +17,10 @@ export declare class GLTFUtils {
     /**
      * Get the TypedArray corresponding to the component type.
      */
-    static getComponentType(componentType: AccessorComponentType): Uint8ArrayConstructor | Int8ArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor;
+    static getComponentType(componentType: AccessorComponentType): Float32ArrayConstructor | Uint32ArrayConstructor | Uint8ArrayConstructor | Uint16ArrayConstructor | Int8ArrayConstructor | Int16ArrayConstructor;
     static getNormalizedComponentScale(componentType: AccessorComponentType): number;
-    static getAccessorBuffer(context: GLTFParserContext, bufferViews: IBufferView[], accessor: IAccessor): BufferInfo;
+    static getAccessorBuffer(context: GLTFParserContext, bufferViews: IBufferView[], accessor: IAccessor): Promise<BufferInfo>;
+    static bufferToVector3Array(data: TypedArray, byteStride: number, accessorByteOffset: number, count: number): Vector3[];
     /**
      * @deprecated
      * Get accessor data.

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

@@ -1,4 +1,4 @@
-import { IMaterialNormalTextureInfo, ITextureInfo } from "../GLTFSchema";
+import type { IMaterialNormalTextureInfo, ITextureInfo } from "../GLTFSchema";
 /**
  * Interfaces from the KHR_lights_punctual extension
  */

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

@@ -6,7 +6,7 @@ export declare class GLTFAnimationParser extends GLTFParser {
     /**
      * @internal
      */
-    static _parseStandardProperty(context: GLTFParserContext, animationClip: AnimationClip, animationInfo: IAnimation): void;
+    static _parseStandardProperty(context: GLTFParserContext, animationClip: AnimationClip, animationInfo: IAnimation): Promise<void>;
     private static _addCurve;
-    parse(context: GLTFParserContext): AssetPromise<AnimationClip[]>;
+    parse(context: GLTFParserContext): AssetPromise<AnimationClip[]> | void;
 }

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

@@ -1,6 +1,6 @@
 import { AssetPromise, ModelMesh, TypedArray } from "@galacean/engine-core";
 import { ModelMeshRestoreInfo } from "../../GLTFContentRestorer";
-import { IGLTF, IMesh, IMeshPrimitive } from "../GLTFSchema";
+import type { IAccessor, IGLTF, IMesh, IMeshPrimitive } from "../GLTFSchema";
 import { GLTFParser } from "./GLTFParser";
 import { BufferInfo, GLTFParserContext } from "./GLTFParserContext";
 export declare class GLTFMeshParser extends GLTFParser {
@@ -8,12 +8,12 @@ export declare class GLTFMeshParser extends GLTFParser {
     /**
      * @internal
      */
-    static _parseMeshFromGLTFPrimitive(context: GLTFParserContext, mesh: ModelMesh, meshRestoreInfo: ModelMeshRestoreInfo, gltfMesh: IMesh, gltfPrimitive: IMeshPrimitive, gltf: IGLTF, getVertexBufferData: (semantic: string) => TypedArray, getBlendShapeData: (semantic: string, shapeIndex: number) => BufferInfo, getIndexBufferData: () => TypedArray, keepMeshData: boolean): Promise<ModelMesh>;
+    static _parseMeshFromGLTFPrimitive(context: GLTFParserContext, mesh: ModelMesh, meshRestoreInfo: ModelMeshRestoreInfo, gltfMesh: IMesh, gltfPrimitive: IMeshPrimitive, gltf: IGLTF, getVertexBufferData: (semantic: string) => TypedArray, getBlendShapeData: (semantic: string, shapeIndex: number) => Promise<BufferInfo>, getIndexBufferData: () => Promise<TypedArray>, keepMeshData: boolean): Promise<ModelMesh>;
     /**
      * @internal
      */
-    static _createBlendShape(mesh: ModelMesh, meshRestoreInfo: ModelMeshRestoreInfo, glTFMesh: IMesh, glTFTargets: {
+    static _createBlendShape(mesh: ModelMesh, meshRestoreInfo: ModelMeshRestoreInfo, glTFMesh: IMesh, accessors: IAccessor[], glTFTargets: {
         [name: string]: number;
-    }[], getBlendShapeData: (semantic: string, shapeIndex: number) => BufferInfo): void;
-    parse(context: GLTFParserContext): AssetPromise<ModelMesh[][]>;
+    }[], getBlendShapeData: (semantic: string, shapeIndex: number) => Promise<BufferInfo>): Promise<void[]>;
+    parse(context: GLTFParserContext): AssetPromise<ModelMesh[][]> | void;
 }

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

@@ -1,6 +1,6 @@
 import { AnimationClip, AssetPromise, EngineObject, Material, Mesh } from "@galacean/engine-core";
 import { GLTFExtensionMode, GLTFExtensionParser } from "../extensions/GLTFExtensionParser";
-import { GLTFExtensionOwnerSchema } from "../GLTFSchema";
+import type { GLTFExtensionOwnerSchema } from "../GLTFSchema";
 import { GLTFParserContext } from "./GLTFParserContext";
 /**
  * Base class of glTF parser.

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

@@ -1,13 +1,12 @@
 import { AnimationClip, AssetPromise, Buffer, Entity, Material, ModelMesh, Texture2D, TypedArray } from "@galacean/engine-core";
 import { BufferDataRestoreInfo, GLTFContentRestorer } from "../../GLTFContentRestorer";
 import { GLTFResource } from "../GLTFResource";
-import { IGLTF } from "../GLTFSchema";
+import type { IGLTF } from "../GLTFSchema";
 /**
  * @internal
  */
 export declare class GLTFParserContext {
     glTF: IGLTF;
-    buffers: ArrayBuffer[];
     glTFResource: GLTFResource;
     keepMeshData: boolean;
     hasSkinned: boolean;
@@ -21,7 +20,13 @@ export declare class GLTFParserContext {
     masterPromiseInfo: PromiseInfo<GLTFResource>;
     promiseMap: Record<string, AssetPromise<any>>;
     contentRestorer: GLTFContentRestorer;
+    /** @internal */
+    _buffers: ArrayBuffer[] | Promise<ArrayBuffer[]>;
     constructor(url: string);
+    /**
+     * Get all the buffer data.
+     */
+    getBuffers(): Promise<ArrayBuffer[]>;
     private _initPromiseInfo;
 }
 /**

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

@@ -1,10 +1,10 @@
-import { Entity } from "@galacean/engine-core";
+import { AssetPromise, Entity } from "@galacean/engine-core";
 import { GLTFParser } from "./GLTFParser";
 import { GLTFParserContext } from "./GLTFParserContext";
 export declare class GLTFSceneParser extends GLTFParser {
     private static _defaultMaterial;
     private static _getDefaultMaterial;
-    parse(context: GLTFParserContext): import("@galacean/engine-core").AssetPromise<Entity>;
+    parse(context: GLTFParserContext): AssetPromise<Entity> | void;
     private _createCamera;
     private _createRenderer;
     private _createAnimator;

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

@@ -1,6 +1,7 @@
+import { AssetPromise } from "@galacean/engine-core";
 import { GLTFParserContext } from ".";
 import { GLTFParser } from "./GLTFParser";
 export declare class GLTFSkinParser extends GLTFParser {
-    parse(context: GLTFParserContext): void;
+    parse(context: GLTFParserContext): AssetPromise<void>;
     private _findSkeletonRootBone;
 }

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

@@ -1,8 +1,9 @@
 import { AssetPromise, Texture2D } from "@galacean/engine-core";
-import { GLTFParser } from "./GLTFParser";
 import { GLTFParserContext } from ".";
+import { GLTFParser } from "./GLTFParser";
 export declare class GLTFTextureParser extends GLTFParser {
     private static _wrapMap;
-    parse(context: GLTFParserContext): AssetPromise<Texture2D[]>;
+    parse(context: GLTFParserContext): AssetPromise<Texture2D[]> | void;
+    private _getSamplerInfo;
     private _parseSampler;
 }

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/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/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";