@galacean/engine-core 1.0.0 → 1.0.2

package/package.json

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

package/types/2d/assembler/TiledSpriteAssembler.d.ts

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

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

@@ -1,10 +1,10 @@
-import { RefObject } from "../../asset/RefObject";
+import { ReferResource } from "../../asset/ReferResource";
 import { Engine } from "../../Engine";
 import { Sprite } from "../sprite/Sprite";
 /**
  * Sprite Atlas.
  */
-export declare class SpriteAtlas extends RefObject {
+export declare class SpriteAtlas extends ReferResource {
     private _sprites;
     private _spriteNamesToIndex;
     /**
@@ -29,8 +29,4 @@ export declare class SpriteAtlas extends RefObject {
      * @param engine - Engine to which the SpriteAtlas belongs
      */
     constructor(engine: Engine);
-    /**
-     * @override
-     */
-    _onDestroy(): void;
 }

package/types/2d/data/VertexData2D.d.ts

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

package/types/2d/enums/SpriteDrawMode.d.ts

@@ -4,6 +4,8 @@
 export declare enum SpriteDrawMode {
     /** Overall scaling when modifying size. */
     Simple = 0,
-    /** When modifying the size, it is transformed according to the 9-slice settings (border). */
-    Sliced = 1
+    /** When modifying the size of the renderer, it scales to fill the range according to the sprite border settings. */
+    Sliced = 1,
+    /** When modifying the size of the renderer, it will tile to fill the range according to the sprite border settings. */
+    Tiled = 2
 }

package/types/2d/enums/SpriteTileMode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sprite's tiling mode enumeration.
+ * Only works in `SpriteDrawMode.tiled` mode.
+ */
+export declare enum SpriteTileMode {
+    /** SpriteRenderer will tile continuously. */
+    Continuous = 0,
+    /** When the fractional part of the tiling multiple is greater than or equal to `SpriteRenderer.tileStretchValue`,
+     * a tile will be added，and the number of tiles can only be an integer. */
+    Adaptive = 1
+}

package/types/2d/index.d.ts

@@ -5,5 +5,6 @@ export { OverflowMode } from "./enums/TextOverflow";
 export { FontStyle } from "./enums/FontStyle";
 export { SpriteAtlas } from "./atlas/SpriteAtlas";
 export { SpriteDrawMode } from "./enums/SpriteDrawMode";
+export { SpriteTileMode } from "./enums/SpriteTileMode";
 export * from "./sprite/index";
 export * from "./text/index";

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

@@ -1,15 +1,17 @@
 import { Rect, Vector2, Vector4 } from "@galacean/engine-math";
-import { RefObject } from "../../asset/RefObject";
 import { Engine } from "../../Engine";
+import { ReferResource } from "../../asset/ReferResource";
 import { Texture2D } from "../../texture/Texture2D";
 /**
  * 2D sprite.
  */
-export declare class Sprite extends RefObject {
+export declare class Sprite extends ReferResource {
     /** The name of sprite. */
     name: string;
-    private _width;
-    private _height;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
     private _positions;
     private _uvs;
     private _bounds;
@@ -28,11 +30,19 @@ export declare class Sprite extends RefObject {
     set texture(value: Texture2D);
     /**
      * The width of the sprite (in world coordinates).
+     *
+     * @remarks
+     * If width is set, return the set value,
+     * otherwise return the width calculated according to `Texture.width`, `Sprite.region`, `Sprite.atlasRegion`, `Sprite.atlasRegionOffset` and `Engine._pixelsPerUnit`.
      */
     get width(): number;
     set width(value: number);
     /**
      * The height of the sprite (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return the height calculated according to `Texture.height`, `Sprite.region`, `Sprite.atlasRegion`, `Sprite.atlasRegionOffset` and `Engine._pixelsPerUnit`.
      */
     get height(): number;
     set height(value: number);
@@ -86,12 +96,11 @@ export declare class Sprite extends RefObject {
      * @returns Cloned sprite
      */
     clone(): Sprite;
-    /**
-     * @override
-     */
-    _onDestroy(): void;
     private _calDefaultSize;
     private _updatePositions;
     private _updateUVs;
     private _dispatchSpriteChange;
+    private _onRegionChange;
+    private _onPivotChange;
+    private _onBorderChange;
 }

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

@@ -1,27 +1,34 @@
-import { BoundingBox } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
 import { Renderer } from "../../Renderer";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
 import { Sprite } from "./Sprite";
 /**
  * A component for masking Sprites.
  */
-export declare class SpriteMask extends Renderer implements ICustomClone {
+export declare class SpriteMask extends Renderer {
     /** The mask layers the sprite mask influence to. */
     influenceLayers: number;
     private _sprite;
-    private _width;
-    private _height;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
     private _flipX;
     private _flipY;
     private _alphaCutoff;
     /**
-     * Render width.
+     * Render width (in world coordinates).
+     *
+     * @remarks
+     * If width is set, return the set value,
+     * otherwise return `SpriteMask.sprite.width`.
      */
     get width(): number;
     set width(value: number);
     /**
-     * Render height.
+     * Render height (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return `SpriteMask.sprite.height`.
      */
     get height(): number;
     set height(value: number);
@@ -45,19 +52,6 @@ export declare class SpriteMask extends Renderer implements ICustomClone {
      */
     get alphaCutoff(): number;
     set alphaCutoff(value: number);
-    /**
-     * @override
-     * @inheritdoc
-     */
-    _onDestroy(): void;
-    /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     * @inheritdoc
-     */
-    protected _render(context: RenderContext): void;
+    private _calDefaultSize;
     private _onSpriteChange;
 }

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

@@ -1,20 +1,23 @@
-import { BoundingBox, Color } from "@galacean/engine-math";
-import { ICustomClone } from "../../clone/ComponentCloner";
+import { Color } from "@galacean/engine-math";
 import { Renderer } from "../../Renderer";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
 import { SpriteDrawMode } from "../enums/SpriteDrawMode";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
+import { SpriteTileMode } from "../enums/SpriteTileMode";
 import { Sprite } from "./Sprite";
 /**
  * Renders a Sprite for 2D graphics.
  */
-export declare class SpriteRenderer extends Renderer implements ICustomClone {
+export declare class SpriteRenderer extends Renderer {
     private _drawMode;
     private _assembler;
+    private _tileMode;
+    private _tiledAdaptiveThreshold;
     private _color;
     private _sprite;
-    private _width;
-    private _height;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
     private _flipX;
     private _flipY;
     private _maskLayer;
@@ -23,7 +26,17 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      * The draw mode of the sprite renderer.
      */
     get drawMode(): SpriteDrawMode;
-    set drawMode(drawMode: SpriteDrawMode);
+    set drawMode(value: SpriteDrawMode);
+    /**
+     * The tiling mode of the sprite renderer. (Only works in tiled mode.)
+     */
+    get tileMode(): SpriteTileMode;
+    set tileMode(value: SpriteTileMode);
+    /**
+     * Stretch Threshold in Tile Adaptive Mode, specified in normalized. (Only works in tiled adaptive mode.)
+     */
+    get tiledAdaptiveThreshold(): number;
+    set tiledAdaptiveThreshold(value: number);
     /**
      * The Sprite to render.
      */
@@ -35,12 +48,20 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
     get color(): Color;
     set color(value: Color);
     /**
-     * Render width.
+     * Render width (in world coordinates).
+     *
+     * @remarks
+     * If width is set, return the set value,
+     * otherwise return `SpriteRenderer.sprite.width`.
      */
     get width(): number;
     set width(value: number);
     /**
-     * Render height.
+     * Render height (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return `SpriteRenderer.sprite.height`.
      */
     get height(): number;
     set height(value: number);
@@ -64,14 +85,7 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      */
     get maskInteraction(): SpriteMaskInteraction;
     set maskInteraction(value: SpriteMaskInteraction);
-    /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
-    protected _render(context: RenderContext): void;
+    private _calDefaultSize;
     private _updateStencilState;
     private _onSpriteChange;
 }

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

@@ -1,10 +1,9 @@
-import { RefObject } from "../../asset/RefObject";
+import { ReferResource } from "../../asset/ReferResource";
 import { Engine } from "../../Engine";
 /**
  * Font.
  */
-export declare class Font extends RefObject {
-    private static _fontMap;
+export declare class Font extends ReferResource {
     /**
      * Create a system font.
      * @param engine - Engine to which the font belongs
@@ -19,8 +18,4 @@ export declare class Font extends RefObject {
      */
     get name(): string;
     constructor(engine: Engine, name?: string);
-    /**
-     * @override
-     */
-    _onDestroy(): void;
 }

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

@@ -1,9 +1,6 @@
 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 { TransformModifyFlags } from "../../Transform";
 import { FontStyle } from "../enums/FontStyle";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
 import { TextHorizontalAlignment, TextVerticalAlignment } from "../enums/TextAlignment";
@@ -12,7 +9,7 @@ import { Font } from "./Font";
 /**
  * Renders a text for 2D graphics.
  */
-export declare class TextRenderer extends Renderer implements ICustomClone {
+export declare class TextRenderer extends Renderer {
     private static _charRenderDataPool;
     private static _tempVec30;
     private static _tempVec31;
@@ -107,17 +104,8 @@ export declare class TextRenderer extends Renderer implements ICustomClone {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
-    /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
-     */
-    protected _render(context: RenderContext): void;
     private _updateStencilState;
     private _resetSubFont;
     private _updatePosition;
     private _updateLocalData;
-    protected _onTransformChanged(bit: TransformModifyFlags): void;
 }

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

@@ -1,2 +1,3 @@
 export { Font } from "./Font";
 export { TextRenderer } from "./TextRenderer";
+export { TextUtils } from "./TextUtils";

package/types/Camera.d.ts

@@ -2,16 +2,16 @@ import { Matrix, Ray, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { CameraClearFlags } from "./enums/CameraClearFlags";
 import { Layer } from "./Layer";
+import { Shader } from "./shader/Shader";
 import { ShaderData } from "./shader/ShaderData";
+import { ShaderTagKey } from "./shader/ShaderTagKey";
 import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
 import { RenderTarget } from "./texture/RenderTarget";
 /**
  * Camera component, as the entrance to the three-dimensional world.
- * @decorator `@dependentComponents(Transform)`
+ * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 export declare class Camera extends Component {
-    /** Shader data. */
-    readonly shaderData: ShaderData;
     /** Rendering priority - A Camera with higher priority will be rendered on top of a camera with lower priority. */
     priority: number;
     /** Whether to enable frustum culling, it is enabled by default. */
@@ -26,6 +26,7 @@ export declare class Camera extends Component {
      * @remarks Support bit manipulation, corresponding to `Layer`.
      */
     cullingMask: Layer;
+    private _shaderData;
     private _isProjMatSetting;
     private _nearClipPlane;
     private _farClipPlane;
@@ -44,6 +45,10 @@ export declare class Camera extends Component {
     private _inverseProjectionMatrix;
     private _lastAspectSize;
     private _invViewProjMat;
+    /**
+     * Shader data.
+     */
+    get shaderData(): ShaderData;
     /**
      * Near clip plane - the closest point to the camera when rendering occurs.
      */
@@ -178,20 +183,37 @@ export declare class Camera extends Component {
      */
     render(cubeFace?: TextureCubeFace, mipLevel?: number): void;
     /**
-     * @override
-     * @inheritdoc
+     * Set the replacement shader.
+     * @param shader - Replacement shader
+     * @param replacementTagName - Sub shader tag name
+     *
+     * @remarks
+     * If replacementTagName is not specified, the first sub shader will be replaced.
+     * If replacementTagName is specified, the replacement shader will find the first sub shader which has the same tag value get by replacementTagKey.
      */
-    _onEnable(): void;
+    setReplacementShader(shader: Shader, replacementTagName?: string): any;
+    /**
+     * Set the replacement shader.
+     * @param shader - Replacement shader
+     * @param replacementTag - Sub shader tag
+     *
+     * @remarks
+     * If replacementTag is not specified, the first sub shader will be replaced.
+     * If replacementTag is specified, the replacement shader will find the first sub shader which has the same tag value get by replacementTagKey.
+     */
+    setReplacementShader(shader: Shader, replacementTag?: ShaderTagKey): any;
+    /**
+     * Reset and clear the replacement shader.
+     */
+    resetReplacementShader(): void;
     /**
-     * @override
      * @inheritdoc
      */
-    _onDisable(): void;
+    _onEnable(): void;
     /**
-     * @override
      * @inheritdoc
      */
-    _onDestroy(): void;
+    _onDisable(): void;
     private _projMatChange;
     private _innerViewportToWorldPoint;
     private _updateShaderData;

package/types/Component.d.ts

@@ -12,10 +12,6 @@ export declare class Component extends EngineObject {
      */
     get enabled(): boolean;
     set enabled(value: boolean);
-    /**
-     * Indicates whether the component is destroyed.
-     */
-    get destroyed(): boolean;
     /**
      * The entity which the component belongs to.
      */
@@ -25,8 +21,4 @@ export declare class Component extends EngineObject {
      */
     get scene(): Scene;
     constructor(entity: Entity);
-    /**
-     * Destroy this instance.
-     */
-    destroy(): void;
 }

package/types/ComponentsDependencies.d.ts

@@ -2,16 +2,24 @@ import { Component } from "./Component";
 import { Entity } from "./Entity";
 type ComponentConstructor = new (entity: Entity) => Component;
 /**
- * Used for component dependency registration.
+ * Declare dependent component.
+ * @param component - Dependent component
+ * @param dependentMode - Dependent mode
  */
-export declare class ComponentsDependencies {
-    private static _invDependenciesMap;
-    private static _addDependency;
-    private constructor();
-}
+export declare function dependentComponents(component: ComponentConstructor, dependentMode?: DependentMode): any;
+/**
+ * Declare dependent components.
+ * @param components - Dependent components
+ * @param dependentMode - Dependent mode
+ */
+export declare function dependentComponents(components: ComponentConstructor[], dependentMode?: DependentMode): any;
 /**
- * Dependent components, automatically added if they do not exist.
- * @param components -  Dependent components
+ * Dependent mode.
  */
-export declare function dependentComponents(...components: ComponentConstructor[]): <T extends ComponentConstructor>(target: T) => void;
+export declare enum DependentMode {
+    /** Check only, throw error if dependent components do not exist. */
+    CheckOnly = 0,
+    /** Auto add if dependent components do not exist. */
+    AutoAdd = 1
+}
 export {};

package/types/ComponentsManager.d.ts

@@ -2,6 +2,7 @@ import { Camera } from "./Camera";
 import { Component } from "./Component";
 import { Renderer } from "./Renderer";
 import { Script } from "./Script";
+import { Animator } from "./animation";
 /**
  * The manager of the components.
  */
@@ -26,8 +27,8 @@ export declare class ComponentsManager {
     removeOnLateUpdateScript(script: Script): void;
     addOnPhysicsUpdateScript(script: Script): void;
     removeOnPhysicsUpdateScript(script: Script): void;
-    addOnUpdateAnimations(animation: Component): void;
-    removeOnUpdateAnimations(animation: Component): void;
+    addOnUpdateAnimations(animation: Animator): void;
+    removeOnUpdateAnimations(animation: Animator): void;
     addOnUpdateRenderers(renderer: Renderer): void;
     removeOnUpdateRenderers(renderer: Renderer): void;
     addDisableScript(component: Script): void;

package/types/DisorderedArray.d.ts

@@ -7,11 +7,12 @@ export declare class DisorderedArray<T> {
     constructor(count?: number);
     add(element: T): void;
     delete(element: T): void;
+    set(index: number, element: T): void;
     get(index: number): T;
     /**
-     *
-     * @param index
-     * @returns The replaced item is used to reset its index.
+     * Delete the element at the specified index.
+     * @param index - The index of the element to be deleted
+     * @returns The replaced item is used to reset its index
      */
     deleteByIndex(index: number): T;
     garbageCollection(): void;

package/types/Engine.d.ts

@@ -1,44 +1,22 @@
-import { Font } from "./2d/text/Font";
-import { ResourceManager } from "./asset/ResourceManager";
-import { EventDispatcher, Time } from "./base";
+import { IPhysics } from "@galacean/engine-design";
 import { Canvas } from "./Canvas";
-import { ComponentsManager } from "./ComponentsManager";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
+import { SceneManager } from "./SceneManager";
+import { ResourceManager } from "./asset/ResourceManager";
+import { EventDispatcher, Time } from "./base";
+import { ColorSpace } from "./enums/ColorSpace";
 import { InputManager } from "./input";
-import { LightManager } from "./lighting/LightManager";
-import { Material } from "./material/Material";
 import { PhysicsManager } from "./physics";
 import { IHardwareRenderer } from "./renderingHardwareInterface";
-import { ClassPool } from "./RenderPipeline/ClassPool";
-import { MeshRenderElement } from "./RenderPipeline/MeshRenderElement";
-import { RenderContext } from "./RenderPipeline/RenderContext";
-import { SpriteElement } from "./RenderPipeline/SpriteElement";
-import { SpriteMaskElement } from "./RenderPipeline/SpriteMaskElement";
-import { TextRenderElement } from "./RenderPipeline/TextRenderElement";
-import { Scene } from "./Scene";
-import { SceneManager } from "./SceneManager";
-import { RenderState } from "./shader/state/RenderState";
 /**
  * Engine.
  */
 export declare class Engine extends EventDispatcher {
     /** Physics manager of Engine. */
     readonly physicsManager: PhysicsManager;
+    /** Input manager of Engine. */
     readonly inputManager: InputManager;
-    _lightManager: LightManager;
-    _componentsManager: ComponentsManager;
-    _hardwareRenderer: IHardwareRenderer;
-    _lastRenderState: RenderState;
-    _renderElementPool: ClassPool<MeshRenderElement>;
-    _spriteElementPool: ClassPool<SpriteElement>;
-    _spriteMaskElementPool: ClassPool<SpriteMaskElement>;
-    _textElementPool: ClassPool<TextRenderElement>;
-    _spriteDefaultMaterial: Material;
-    _spriteMaskDefaultMaterial: Material;
-    _textDefaultFont: Font;
-    _renderContext: RenderContext;
-    protected _canvas: Canvas;
     private _settings;
     private _resourceManager;
     private _sceneManager;
@@ -52,7 +30,9 @@ export declare class Engine extends EventDispatcher {
     private _targetFrameInterval;
     private _destroyed;
     private _frameInProcess;
-    private _waittingDestroy;
+    private _waitingDestroy;
+    private _isDeviceLost;
+    private _waitingGC;
     private _animate;
     /**
      * Settings of Engine.
@@ -63,15 +43,15 @@ export declare class Engine extends EventDispatcher {
      */
     get canvas(): Canvas;
     /**
-     * Get the resource manager.
+     * The resource manager.
      */
     get resourceManager(): ResourceManager;
     /**
-     * Get the scene manager.
+     * The scene manager.
      */
     get sceneManager(): SceneManager;
     /**
-     * Get the Time class.
+     * The time information of the engine.
      */
     get time(): Time;
     /**
@@ -96,13 +76,7 @@ export declare class Engine extends EventDispatcher {
      * Indicates whether the engine is destroyed.
      */
     get destroyed(): boolean;
-    /**
-     * Create engine.
-     * @param canvas - The canvas to use for rendering
-     * @param hardwareRenderer - Graphics API renderer
-     * @param settings - Engine Settings
-     */
-    constructor(canvas: Canvas, hardwareRenderer: IHardwareRenderer, settings?: EngineSettings);
+    protected constructor(canvas: Canvas, hardwareRenderer: IHardwareRenderer, configuration: EngineConfiguration);
     /**
      * Create an entity.
      * @param name - The name of the entity
@@ -125,16 +99,34 @@ export declare class Engine extends EventDispatcher {
      * Execution engine loop.
      */
     run(): void;
+    /**
+     * Force lose graphic device.
+     * @remarks Used to simulate the phenomenon after the real loss of device.
+     */
+    forceLoseDevice(): void;
+    /**
+     * Force restore graphic device.
+     * @remarks Used to simulate the phenomenon after the real restore of device.
+     */
+    forceRestoreDevice(): void;
     private _destroy;
     /**
      * Destroy engine.
      * @remarks If call during frame execution will delay until the end of the frame
      */
     destroy(): void;
-    /**
-     * @intenral
-     */
-    _render(scene: Scene): void;
     private _createSpriteMaterial;
     private _createSpriteMaskMaterial;
+    private _onDeviceLost;
+    private _onDeviceRestored;
+    private _gc;
+}
+/**
+ * Engine configuration.
+ */
+export interface EngineConfiguration {
+    /** Physics. */
+    physics?: IPhysics;
+    /** Color space. */
+    colorSpace?: ColorSpace;
 }