@galacean/engine-core 1.0.0-alpha.6 → 1.0.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-beta.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.0.0-alpha.6"
+    "@galacean/engine-math": "1.0.0-beta.1"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.0.0-alpha.6"
+    "@galacean/engine-design": "1.0.0-beta.1"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/atlas/SpriteAtlas.d.ts

@@ -29,4 +29,5 @@ export declare class SpriteAtlas extends ReferResource {
      * @param engine - Engine to which the SpriteAtlas belongs
      */
     constructor(engine: Engine);
+    protected _onDestroy(): void;
 }

package/types/2d/atlas/types.d.ts

@@ -1,8 +1,13 @@
-import { TextureFormat } from "../../texture";
+import { TextureFilterMode, TextureFormat, TextureWrapMode } from "../../texture";
 /**
  * The original data type of the atlas.
  */
 export interface AtlasConfig {
+    mipmap?: boolean;
+    wrapModeV?: TextureWrapMode;
+    wrapModeU?: TextureWrapMode;
+    filterMode?: TextureFilterMode;
+    anisoLevel?: number;
     /** Version of Atlas. */
     version: number;
     /** Texture format. */
@@ -49,5 +54,11 @@ export interface AtlasSprite {
         x: number;
         y: number;
     };
+    border: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
     pixelsPerUnit: number;
 }

package/types/2d/sprite/Sprite.d.ts

@@ -1,6 +1,6 @@
 import { Rect, Vector2, Vector4 } from "@galacean/engine-math";
-import { ReferResource } from "../../asset/ReferResource";
 import { Engine } from "../../Engine";
+import { ReferResource } from "../../asset/ReferResource";
 import { Texture2D } from "../../texture/Texture2D";
 /**
  * 2D sprite.
@@ -86,6 +86,7 @@ export declare class Sprite extends ReferResource {
      * @returns Cloned sprite
      */
     clone(): Sprite;
+    protected _onDestroy(): void;
     private _calDefaultSize;
     private _updatePositions;
     private _updateUVs;

package/types/2d/sprite/SpriteMask.d.ts

@@ -1,7 +1,7 @@
 import { BoundingBox } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
-import { Renderer } from "../../Renderer";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Renderer } from "../../Renderer";
+import { ICustomClone } from "../../clone/ComponentCloner";
 import { Sprite } from "./Sprite";
 /**
  * A component for masking Sprites.
@@ -45,17 +45,12 @@ export declare class SpriteMask extends Renderer implements ICustomClone {
      */
     get alphaCutoff(): number;
     set alphaCutoff(value: number);
-    /**
-     * @override
-     */
     protected _updateBounds(worldBounds: BoundingBox): void;
     /**
-     * @override
      * @inheritdoc
      */
     protected _render(context: RenderContext): void;
     /**
-     * @override
      * @inheritdoc
      */
     protected _onDestroy(): void;

package/types/2d/sprite/SpriteRenderer.d.ts

@@ -1,7 +1,7 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
-import { Renderer } from "../../Renderer";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Renderer } from "../../Renderer";
+import { ICustomClone } from "../../clone/ComponentCloner";
 import { SpriteDrawMode } from "../enums/SpriteDrawMode";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
 import { SpriteTileMode } from "../enums/SpriteTileMode";
@@ -77,17 +77,8 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      */
     get maskInteraction(): SpriteMaskInteraction;
     set maskInteraction(value: SpriteMaskInteraction);
-    /**
-     * @override
-     */
     protected _updateShaderData(context: RenderContext): void;
-    /**
-     * @override
-     */
     protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
     protected _render(context: RenderContext): void;
     private _updateStencilState;
     private _onSpriteChange;

package/types/2d/text/Font.d.ts

@@ -18,4 +18,5 @@ export declare class Font extends ReferResource {
      */
     get name(): string;
     constructor(engine: Engine, name?: string);
+    protected _onDestroy(): void;
 }

package/types/2d/text/TextRenderer.d.ts

@@ -1,9 +1,9 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { Entity } from "../../Entity";
-import { Renderer } from "../../Renderer";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Renderer } from "../../Renderer";
 import { TransformModifyFlags } from "../../Transform";
+import { ICustomClone } from "../../clone/ComponentCloner";
 import { FontStyle } from "../enums/FontStyle";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
 import { TextHorizontalAlignment, TextVerticalAlignment } from "../enums/TextAlignment";
@@ -107,17 +107,9 @@ export declare class TextRenderer extends Renderer implements ICustomClone {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
-    /**
-     * @override
-     */
+    protected _onDestroy(): void;
     protected _updateShaderData(context: RenderContext): void;
-    /**
-     * @override
-     */
     protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
     protected _render(context: RenderContext): void;
     private _updateStencilState;
     private _resetSubFont;

package/types/Camera.d.ts

@@ -204,17 +204,14 @@ export declare class Camera extends Component {
      */
     resetReplacementShader(): void;
     /**
-     * @override
      * @inheritdoc
      */
     _onEnable(): void;
     /**
-     * @override
      * @inheritdoc
      */
     _onDisable(): void;
     /**
-     * @override
      * @inheritdoc
      */
     protected _onDestroy(): void;

package/types/Component.d.ts

@@ -21,4 +21,5 @@ export declare class Component extends EngineObject {
      */
     get scene(): Scene;
     constructor(entity: Entity);
+    protected _onDestroy(): void;
 }

package/types/Entity.d.ts

@@ -1,10 +1,10 @@
 import { Matrix } from "@galacean/engine-math";
-import { EngineObject } from "./base";
 import { Component } from "./Component";
 import { Engine } from "./Engine";
 import { Layer } from "./Layer";
 import { Scene } from "./Scene";
 import { Transform } from "./Transform";
+import { EngineObject } from "./base";
 /**
  * Entity, be used as components container.
  */

package/types/Renderer.d.ts

@@ -2,8 +2,8 @@ import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { RenderContext } from "./RenderPipeline/RenderContext";
 import { TransformModifyFlags } from "./Transform";
-import { ShaderData } from "./shader/ShaderData";
 import { Material } from "./material";
+import { ShaderData } from "./shader/ShaderData";
 /**
  * Basis for all renderers.
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`

package/types/Scene.d.ts

@@ -1,8 +1,8 @@
 import { Color, Vector3 } from "@galacean/engine-math";
 import { Background } from "./Background";
-import { EngineObject } from "./base";
 import { Engine } from "./Engine";
 import { Entity } from "./Entity";
+import { EngineObject } from "./base";
 import { FogMode } from "./enums/FogMode";
 import { AmbientLight } from "./lighting/AmbientLight";
 import { ShaderData } from "./shader/ShaderData";
@@ -14,6 +14,8 @@ import { ShadowResolution } from "./shadow/enum/ShadowResolution";
 export declare class Scene extends EngineObject {
     private static _fogColorProperty;
     private static _fogParamsProperty;
+    private static _sunlightColorProperty;
+    private static _sunlightDirectionProperty;
     /** Scene name. */
     name: string;
     /** The background of the scene. */

package/types/Script.d.ts

@@ -118,4 +118,5 @@ export declare class Script extends Component {
      * Called at the end of the destroyed frame.
      */
     onDestroy(): void;
+    protected _onDestroy(): void;
 }

package/types/Utils.d.ts

@@ -1,3 +1,31 @@
 export declare class Utils {
+    /**
+     * Fast remove an element from array.
+     * @param array - Array
+     * @param item - Element
+     */
+    static removeFromArray(array: any[], item: any): boolean;
+    /**
+     * Decodes a given Uint8Array into a string.
+     */
+    static decodeText(array: Uint8Array): string;
+    /**
+     * Judge whether the url is absolute url.
+     * @param url - The url to be judged.
+     * @returns Whether the url is absolute url.
+     */
+    static isAbsoluteUrl(url: string): boolean;
+    /**
+     * Get the values of an object.
+     */
+    static objectValues(obj: any): any[];
+    /**
+     * Convert a relative URL to an absolute URL based on a given base URL.
+     * @param baseUrl - The base url.
+     * @param relativeUrl - The relative url.
+     * @returns The resolved url.
+     */
+    static resolveAbsoluteUrl(baseUrl: string, relativeUrl: string): string;
     private static _stringToPath;
+    private static _formatRelativePath;
 }

package/types/animation/animationCurve/AnimationFloatArrayCurve.d.ts

@@ -6,7 +6,6 @@ import { AnimationCurve } from "./AnimationCurve";
 export declare class AnimationFloatArrayCurve extends AnimationCurve<Float32Array> {
     /**
      * @inheritdoc
-     * @override
      */
     addKey(key: Keyframe<Float32Array>): void;
 }

package/types/asset/GraphicsResource.d.ts

@@ -2,8 +2,5 @@ import { Engine } from "../Engine";
 import { ReferResource } from "./ReferResource";
 export declare abstract class GraphicsResource extends ReferResource {
     protected constructor(engine: Engine);
-    /**
-     * @override
-     */
     protected _onDestroy(): void;
 }

package/types/asset/ReferResource.d.ts

@@ -14,14 +14,10 @@ export declare abstract class ReferResource extends EngineObject implements IRef
     get refCount(): number;
     protected constructor(engine: Engine);
     /**
-     * @override
      * Destroy self.
      * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
      * @returns Whether the release was successful.
      */
     destroy(force?: boolean): boolean;
-    /**
-     * @override
-     */
     protected _onDestroy(): void;
 }

package/types/asset/ResourceManager.d.ts

@@ -57,6 +57,18 @@ export declare class ResourceManager {
      * @returns AssetPromise
      */
     load(assetItems: LoadItem[]): AssetPromise<Object[]>;
+    /**
+     * Get the resource from cache by asset url, return the resource object if it loaded, otherwise return null.
+     * @param url - Resource url
+     * @returns Resource object
+     */
+    getFromCache<T>(url: string): T;
+    /**
+     * Get asset url from instanceId.
+     * @param instanceId - Engine instance id
+     * @returns Asset url
+     */
+    getAssetPath(instanceId: number): string;
     /**
      * Cancel all assets that have not finished loading.
      */
@@ -76,12 +88,6 @@ export declare class ResourceManager {
      * @remarks The release principle is that it is not referenced by the components, including direct and indirect reference.
      */
     gc(): void;
-    /**
-     * Get asset url from instanceId.
-     * @param instanceId - Engine instance id
-     * @returns Asset url
-     */
-    getAssetPath(instanceId: number): string;
     /**
      * Add content restorer.
      * @param restorer - The restorer

package/types/base/index.d.ts

@@ -1,6 +1,5 @@
 export { EventDispatcher } from "./EventDispatcher";
 export { Logger } from "./Logger";
 export { Time } from "./Time";
-export { Util, ObjectValues } from "./Util";
 export { EngineObject } from "./EngineObject";
 export * from "./Constant";

package/types/env-probe/CubeProbe.d.ts

@@ -9,15 +9,9 @@ export declare class CubeProbe extends Probe {
      * The position of the probe can be set, the default is the origin [0,0,0].
      */
     position: Vector3;
-    /**
-     * @override
-     */
     protected readonly _isCube: boolean;
     private oriViewMatrix;
     private _oriFieldOfView;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
     /**
      * Store original camera parameters.

package/types/env-probe/Probe.d.ts

@@ -46,13 +46,7 @@ export declare abstract class Probe extends Script {
      * @remarks Prevent issue: Feedback Loops Between Textures and the Framebuffer.
      */
     onTextureChange(renderColorTexture: Texture): void;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
-    /**
-     * @override
-     */
     onEndRender(camera: Camera): void;
     protected _reset(): void;
 }

package/types/graphic/Buffer.d.ts

@@ -90,10 +90,8 @@ export declare class Buffer extends GraphicsResource {
      * @param dataLength - Output data length
      */
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
-    /**
-     * @override
-     */
     _rebuild(): void;
+    protected _onDestroy(): void;
     /**
      * @deprecated
      */

package/types/graphic/BufferUtil.d.ts

@@ -7,5 +7,5 @@ export interface ElementInfo {
 }
 export declare class BufferUtil {
     static _getGLIndexType(indexFormat: IndexFormat): DataType;
-    static _getGLIndexByteCount(indexFormat: IndexFormat): DataType;
+    static _getGLIndexByteCount(indexFormat: IndexFormat): number;
 }

package/types/graphic/Mesh.d.ts

@@ -55,13 +55,7 @@ export declare abstract class Mesh extends GraphicsResource {
      * Clear all sub-mesh.
      */
     clearSubMesh(): void;
-    /**
-     * @override
-     */
     _addReferCount(value: number): void;
-    /**
-     * @override
-     */
     _rebuild(): void;
     protected _setVertexElements(elements: VertexElement[]): void;
     protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;

package/types/index.d.ts

@@ -49,5 +49,6 @@ export * from "./Layer";
 export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
+export * from "./Utils";
 export { Basic2DBatcher } from "./RenderPipeline/Basic2DBatcher";
 export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";

package/types/material/BaseMaterial.d.ts

@@ -5,17 +5,17 @@ import { BlendMode } from "./enums/BlendMode";
 import { RenderFace } from "./enums/RenderFace";
 import { Material } from "./Material";
 export declare class BaseMaterial extends Material {
+    protected static _baseTextureMacro: ShaderMacro;
+    protected static _normalTextureMacro: ShaderMacro;
+    protected static _emissiveTextureMacro: ShaderMacro;
+    protected static _transparentMacro: ShaderMacro;
     protected static _baseColorProp: ShaderProperty;
     protected static _baseTextureProp: ShaderProperty;
-    protected static _baseTextureMacro: ShaderMacro;
     protected static _tilingOffsetProp: ShaderProperty;
     protected static _normalTextureProp: ShaderProperty;
     protected static _normalIntensityProp: ShaderProperty;
-    protected static _normalTextureMacro: ShaderMacro;
     protected static _emissiveColorProp: ShaderProperty;
     protected static _emissiveTextureProp: ShaderProperty;
-    protected static _emissiveTextureMacro: ShaderMacro;
-    protected static _transparentMacro: ShaderMacro;
     private static _alphaCutoffProp;
     private static _alphaCutoffMacro;
     private _renderFace;
@@ -75,12 +75,10 @@ export declare class BaseMaterial extends Material {
      */
     setRenderFace(passIndex: number, renderFace: RenderFace): void;
     /**
-     * @override
      * Clone and return the instance.
      */
     clone(): BaseMaterial;
     /**
-     * @override
      * Clone to the target material.
      * @param target - target material
      */

package/types/material/BlinnPhongMaterial.d.ts

@@ -64,8 +64,5 @@ export declare class BlinnPhongMaterial extends BaseMaterial {
      * @param engine - Engine to which the material belongs
      */
     constructor(engine: Engine);
-    /**
-     * @override
-     */
     clone(): BlinnPhongMaterial;
 }

package/types/material/Material.d.ts

@@ -1,6 +1,6 @@
 import { IClone } from "@galacean/engine-design";
-import { ReferResource } from "../asset/ReferResource";
 import { Engine } from "../Engine";
+import { ReferResource } from "../asset/ReferResource";
 import { Shader } from "../shader/Shader";
 import { ShaderData } from "../shader/ShaderData";
 import { RenderState } from "../shader/state/RenderState";
@@ -40,8 +40,5 @@ export declare class Material extends ReferResource implements IClone {
      * @param target - target material
      */
     cloneTo(target: Material): void;
-    /**
-     * @override
-     */
     _addReferCount(value: number): void;
 }

package/types/material/PBRMaterial.d.ts

@@ -30,7 +30,7 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): PBRMaterial;
 }

package/types/material/PBRSpecularMaterial.d.ts

@@ -32,7 +32,7 @@ export declare class PBRSpecularMaterial extends PBRBaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): PBRSpecularMaterial;
 }

package/types/material/UnlitMaterial.d.ts

@@ -27,7 +27,7 @@ export declare class UnlitMaterial extends BaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): UnlitMaterial;
 }

package/types/mesh/MeshRenderer.d.ts

@@ -1,8 +1,8 @@
 import { BoundingBox } from "@galacean/engine-math";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { Renderer } from "../Renderer";
 import { ICustomClone } from "../clone/ComponentCloner";
 import { Mesh } from "../graphic/Mesh";
-import { Renderer } from "../Renderer";
-import { RenderContext } from "../RenderPipeline/RenderContext";
 /**
  * MeshRenderer Component.
  */
@@ -17,13 +17,8 @@ export declare class MeshRenderer extends Renderer implements ICustomClone {
      */
     get mesh(): Mesh;
     set mesh(value: Mesh);
-    /**
-     * @override
-     */
+    protected _onDestroy(): void;
     protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
     protected _render(context: RenderContext): void;
     private _setMesh;
     private _onMeshChanged;

package/types/mesh/ModelMesh.d.ts

@@ -216,6 +216,7 @@ export declare class ModelMesh extends Mesh {
      * @remark based on http://foundationsofgameenginedev.com/FGED2-sample.pdf
      */
     calculateTangents(): void;
+    protected _onDestroy(): void;
     private _supplementaryVertexElements;
     private _updateVertexElements;
     private _updateVertices;

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -41,17 +41,8 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get rootBone(): Entity;
     set rootBone(value: Entity);
-    /**
-     * @override
-     */
     protected _updateShaderData(context: RenderContext): void;
-    /**
-     * @override
-     */
     protected _registerEntityTransformListener(): void;
-    /**
-     * @override
-     */
     protected _updateBounds(worldBounds: BoundingBox): void;
     private _initSkin;
     private _computeApproximateBindMatrix;

package/types/physics/CharacterController.d.ts

@@ -41,12 +41,10 @@ export declare class CharacterController extends Collider {
     /**
      * Add collider shape on this controller.
      * @param shape - Collider shape
-     * @override
      */
     addShape(shape: ColliderShape): void;
     /**
      * Remove all shape attached.
-     * @override
      */
     clearShapes(): void;
     private _setUpDirection;

package/types/physics/Collider.d.ts

@@ -26,4 +26,5 @@ export declare class Collider extends Component {
      * Remove all shape attached.
      */
     clearShapes(): void;
+    protected _onDestroy(): void;
 }

package/types/physics/joint/HingeJoint.d.ts

@@ -1,7 +1,7 @@
-import { Joint } from "./Joint";
 import { Vector3 } from "@galacean/engine-math";
-import { JointMotor } from "./JointMotor";
+import { Joint } from "./Joint";
 import { JointLimits } from "./JointLimits";
+import { JointMotor } from "./JointMotor";
 /**
  * A joint which behaves in a similar way to a hinge or axle.
  */

package/types/physics/joint/SpringJoint.d.ts

@@ -1,5 +1,5 @@
-import { Joint } from "./Joint";
 import { Vector3 } from "@galacean/engine-math";
+import { Joint } from "./Joint";
 /**
  * A joint that maintains an upper or lower bound (or both) on the distance between two points on different objects.
  */

package/types/shaderlib/ShaderLib.d.ts

@@ -19,7 +19,6 @@ export declare const ShaderLib: {
     normal_share: string;
     uv_share: string;
     worldpos_share: string;
-    RendererFragmentDeclaration: string;
     FogVertexDeclaration: string;
     FogFragmentDeclaration: string;
     begin_normal_vert: string;