@galacean/engine-core 1.6.8 → 1.6.10

package/package.json

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

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

@@ -0,0 +1,11 @@
+import { Matrix, Vector2 } from "@galacean/engine-math";
+import { ISpriteRenderer } from "./ISpriteRenderer";
+/**
+ * Interface for sprite assembler.
+ */
+export interface ISpriteAssembler {
+    resetData(renderer: ISpriteRenderer, vertexCount?: number): void;
+    updatePositions(renderer: ISpriteRenderer, worldMatrix: Matrix, width: number, height: number, pivot: Vector2, flipX: boolean, flipY: boolean, referenceResolutionPerUnit?: number): void;
+    updateUVs(renderer: ISpriteRenderer): void;
+    updateColor(renderer: ISpriteRenderer, alpha: number): void;
+}

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

@@ -0,0 +1,16 @@
+import { Color } from "@galacean/engine-math";
+import { PrimitiveChunkManager } from "../../RenderPipeline/PrimitiveChunkManager";
+import { SubPrimitiveChunk } from "../../RenderPipeline/SubPrimitiveChunk";
+import { SpriteTileMode } from "../enums/SpriteTileMode";
+import { Sprite } from "../sprite";
+/**
+ * Interface for sprite renderer.
+ */
+export interface ISpriteRenderer {
+    sprite: Sprite;
+    color?: Color;
+    tileMode?: SpriteTileMode;
+    tiledAdaptiveThreshold?: number;
+    _subChunk: SubPrimitiveChunk;
+    _getChunkManager(): PrimitiveChunkManager;
+}

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

@@ -0,0 +1,13 @@
+import { Matrix, Vector2 } from "@galacean/engine-math";
+import { ISpriteRenderer } from "./ISpriteRenderer";
+/**
+ * Assemble vertex data for the sprite renderer in simple mode.
+ */
+export declare class SimpleSpriteAssembler {
+    private static _rectangleTriangles;
+    private static _matrix;
+    static resetData(renderer: ISpriteRenderer): void;
+    static updatePositions(renderer: ISpriteRenderer, worldMatrix: Matrix, width: number, height: number, pivot: Vector2, flipX: boolean, flipY: boolean): void;
+    static updateUVs(renderer: ISpriteRenderer): void;
+    static updateColor(renderer: ISpriteRenderer, alpha: number): void;
+}

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

@@ -0,0 +1,15 @@
+import { Matrix, Vector2 } from "@galacean/engine-math";
+import { ISpriteRenderer } from "./ISpriteRenderer";
+/**
+ * Assemble vertex data for the sprite renderer in sliced mode.
+ */
+export declare class SlicedSpriteAssembler {
+    private static _rectangleTriangles;
+    private static _matrix;
+    private static _row;
+    private static _column;
+    static resetData(renderer: ISpriteRenderer): void;
+    static updatePositions(renderer: ISpriteRenderer, worldMatrix: Matrix, width: number, height: number, pivot: Vector2, flipX: boolean, flipY: boolean, referenceResolutionPerUnit?: number): void;
+    static updateUVs(renderer: ISpriteRenderer): void;
+    static updateColor(renderer: ISpriteRenderer, alpha: number): void;
+}

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

@@ -0,0 +1,17 @@
+import { Matrix, Vector2 } from "@galacean/engine-math";
+import { ISpriteRenderer } from "./ISpriteRenderer";
+/**
+ * Assemble vertex data for the sprite renderer in tiled mode.
+ */
+export declare class TiledSpriteAssembler {
+    private static _matrix;
+    private static _posRow;
+    private static _posColumn;
+    private static _uvRow;
+    private static _uvColumn;
+    static resetData(renderer: ISpriteRenderer, vertexCount: number): void;
+    static updatePositions(renderer: ISpriteRenderer, worldMatrix: Matrix, width: number, height: number, pivot: Vector2, flipX: boolean, flipY: boolean, referenceResolutionPerUnit?: number): void;
+    static updateUVs(renderer: ISpriteRenderer): void;
+    static updateColor(renderer: ISpriteRenderer, alpha: number): void;
+    private static _calculateDividing;
+}

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

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

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

@@ -0,0 +1,32 @@
+import { ReferResource } from "../../asset/ReferResource";
+import { Engine } from "../../Engine";
+import { Sprite } from "../sprite/Sprite";
+/**
+ * Sprite Atlas.
+ */
+export declare class SpriteAtlas extends ReferResource {
+    private _sprites;
+    private _spriteNamesToIndex;
+    /**
+     * All the sprites in the atlas.
+     */
+    get sprites(): Readonly<Sprite[]>;
+    /**
+     * Get the last sprite named 'name' from the atlas.
+     * @param name - The name of the sprite you want to find
+     * @returns The sprite you want to find
+     */
+    getSprite(name: string): Sprite;
+    /**
+     * Get all the sprite named 'name' from the atlas.
+     * @param name - The name of the sprites you want to find
+     * @param outSprites - This array holds the sprites found
+     * @returns The sprites you want to find
+     */
+    getSprites(name: string, outSprites: Sprite[]): Sprite[];
+    /**
+     * Constructor a SpriteAtlas.
+     * @param engine - Engine to which the SpriteAtlas belongs
+     */
+    constructor(engine: Engine);
+}

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

@@ -0,0 +1,69 @@
+import { AssetType } from "../../asset/AssetType";
+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. */
+    format: TextureFormat;
+    /** The sub atlas array, each sub atlas contains multiple sprites. */
+    atlasItems: {
+        /** The url of the sub atlas. */
+        img: string;
+        /** Image type. */
+        type: AssetType;
+        /** Sprites contained in the sub atlas. */
+        sprites: AtlasSprite[];
+    }[];
+}
+/**
+ * The original data type of each sprite.
+ */
+export interface AtlasSprite {
+    /** Temp solution. */
+    id: number;
+    /** The name the sprite. */
+    name: string;
+    /** Whether to rotate 90 degrees clockwise. */
+    atlasRotated: boolean;
+    /** The range of the sprites on the big picture. */
+    atlasRegion: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    };
+    /** If there is trimming, the size of the blank area on the four sides. */
+    atlasRegionOffset: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    region: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    };
+    pivot: {
+        x: number;
+        y: number;
+    };
+    border: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    pixelsPerUnit: number;
+    width: number;
+    height: number;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * The style of the font.
+ */
+export declare enum FontStyle {
+    /** Set font without style */
+    None = 0,
+    /** Set font bold */
+    Bold = 1,
+    /** Set font italic */
+    Italic = 2
+}

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

@@ -0,0 +1,11 @@
+/**
+ * Sprite's drawing mode enumeration.
+ */
+export declare enum SpriteDrawMode {
+    /** Overall scaling when modifying size. */
+    Simple = 0,
+    /** 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/SpriteMaskInteraction.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sprite mask interaction.
+ */
+export declare enum SpriteMaskInteraction {
+    /** The sprite will not interact with the masking system. */
+    None = 0,
+    /** The sprite will be visible only in areas where a mask is present. */
+    VisibleInsideMask = 1,
+    /** The sprite will be visible only in areas where no mask is present. */
+    VisibleOutsideMask = 2
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Sprite Property Dirty Flag.
+ */
+export declare enum SpriteModifyFlags {
+    /** The texture of sprite changes. */
+    texture = 1,
+    /** The size of sprite changes. */
+    size = 2,
+    /** The rotation of sprite changes. */
+    atlasRotate = 4,
+    /** The atlasRegion of sprite changes. */
+    atlasRegion = 8,
+    /** The atlasRegionOffset of sprite changes. */
+    atlasRegionOffset = 16,
+    /** The region of sprite changes. */
+    region = 32,
+    /** The pivot of sprite changes. */
+    pivot = 64,
+    /** The border of sprite changes. */
+    border = 128,
+    /** The sprite destroyed. */
+    destroy = 256
+}

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/enums/TextAlignment.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The horizontal alignment of the text.
+ */
+export declare enum TextHorizontalAlignment {
+    /** Align left horizontally */
+    Left = 0,
+    /** Align center horizontally */
+    Center = 1,
+    /** Align right horizontally */
+    Right = 2
+}
+/**
+ * The vertical alignment of the text.
+ */
+export declare enum TextVerticalAlignment {
+    /** Align top vertically */
+    Top = 0,
+    /** Align center vertically */
+    Center = 1,
+    /** Align bottom vertically */
+    Bottom = 2
+}

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

@@ -0,0 +1,9 @@
+/**
+ * The way to handle the situation where wrapped text is too tall to fit in the height.
+ */
+export declare enum OverflowMode {
+    /** Overflow when the text is too tall */
+    Overflow = 0,
+    /** Truncate with height when the text is too tall */
+    Truncate = 1
+}

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

@@ -0,0 +1,16 @@
+export type { ISpriteAssembler } from "./assembler/ISpriteAssembler";
+export type { ISpriteRenderer } from "./assembler/ISpriteRenderer";
+export { SimpleSpriteAssembler } from "./assembler/SimpleSpriteAssembler";
+export { SlicedSpriteAssembler } from "./assembler/SlicedSpriteAssembler";
+export { TiledSpriteAssembler } from "./assembler/TiledSpriteAssembler";
+export { SpriteAtlas } from "./atlas/SpriteAtlas";
+export { FontStyle } from "./enums/FontStyle";
+export { SpriteDrawMode } from "./enums/SpriteDrawMode";
+export { SpriteMaskInteraction } from "./enums/SpriteMaskInteraction";
+export { SpriteModifyFlags } from "./enums/SpriteModifyFlags";
+export { SpriteTileMode } from "./enums/SpriteTileMode";
+export { TextHorizontalAlignment, TextVerticalAlignment } from "./enums/TextAlignment";
+export { OverflowMode } from "./enums/TextOverflow";
+export * from "./sprite/index";
+export * from "./text/index";
+export type { ITextRenderer } from "./text/ITextRenderer";

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

@@ -0,0 +1,106 @@
+import { Rect, Vector2, Vector4 } from "@galacean/engine-math";
+import { Engine } from "../../Engine";
+import { ReferResource } from "../../asset/ReferResource";
+import { Texture2D } from "../../texture/Texture2D";
+/**
+ * 2D sprite.
+ */
+export declare class Sprite extends ReferResource {
+    /** The name of sprite. */
+    name: string;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
+    private _positions;
+    private _uvs;
+    private _bounds;
+    private _texture;
+    private _atlasRotated;
+    private _atlasRegion;
+    private _atlasRegionOffset;
+    private _region;
+    private _pivot;
+    private _border;
+    private _dirtyUpdateFlag;
+    /**
+     * The reference to the used texture.
+     */
+    get texture(): Texture2D;
+    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` and `Sprite.atlasRegionOffset`.
+     */
+    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` and `Sprite.atlasRegionOffset`.
+     */
+    get height(): number;
+    set height(value: number);
+    /**
+     * Is it rotated 90 degrees clockwise when packing.
+     */
+    get atlasRotated(): boolean;
+    set atlasRotated(value: boolean);
+    /**
+     * The rectangle region of the original texture on its atlas texture, specified in normalized.
+     */
+    get atlasRegion(): Rect;
+    set atlasRegion(value: Rect);
+    /**
+     * The rectangle region offset of the original texture on its atlas texture, specified in normalized.
+     */
+    get atlasRegionOffset(): Vector4;
+    set atlasRegionOffset(value: Vector4);
+    /**
+     * The rectangle region of the sprite, specified in normalized.
+     */
+    get region(): Rect;
+    set region(value: Rect);
+    /**
+     * Location of the sprite's center point in the rectangle region, specified in normalized.
+     * The origin is at the bottom left and the default value is (0.5, 0.5).
+     */
+    get pivot(): Vector2;
+    set pivot(value: Vector2);
+    /**
+     * Get the border of the sprite.
+     *  x      y       z     w
+     *  |      |       |     |
+     * Left, bottom, right, top.
+     * @remarks only use in sliced mode.
+     */
+    get border(): Vector4;
+    set border(value: Vector4);
+    /**
+     * Constructor a Sprite.
+     * @param engine - Engine to which the sprite belongs
+     * @param texture - Texture from which to obtain the Sprite
+     * @param region - Rectangle region of the texture to use for the Sprite, specified in normalized
+     * @param pivot - Sprite's pivot point relative to its graphic rectangle, specified in normalized
+     * @param border - Boundaries when using Slice DrawMode, specified in normalized
+     * @param name - The name of Sprite
+     */
+    constructor(engine: Engine, texture?: Texture2D, region?: Rect, pivot?: Vector2, border?: Vector4, name?: string);
+    /**
+     * Clone.
+     * @returns Cloned sprite
+     */
+    clone(): Sprite;
+    private _calDefaultSize;
+    private _updatePositions;
+    private _updateUVs;
+    private _dispatchSpriteChange;
+    private _onRegionChange;
+    private _onPivotChange;
+    private _onBorderChange;
+}

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

@@ -0,0 +1,70 @@
+import { BoundingBox } from "@galacean/engine-math";
+import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Renderer } from "../../Renderer";
+import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
+import { ISpriteRenderer } from "../assembler/ISpriteRenderer";
+import { Sprite } from "./Sprite";
+/**
+ * A component for masking Sprites.
+ */
+export declare class SpriteMask extends Renderer implements ISpriteRenderer {
+    /** The mask layers the sprite mask influence to. */
+    influenceLayers: SpriteMaskLayer;
+    private _sprite;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
+    private _flipX;
+    private _flipY;
+    private _alphaCutoff;
+    /**
+     * 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 (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return `SpriteMask.sprite.height`.
+     */
+    get height(): number;
+    set height(value: number);
+    /**
+     * Flips the sprite on the X axis.
+     */
+    get flipX(): boolean;
+    set flipX(value: boolean);
+    /**
+     * Flips the sprite on the Y axis.
+     */
+    get flipY(): boolean;
+    set flipY(value: boolean);
+    /**
+     * The Sprite to render.
+     */
+    get sprite(): Sprite;
+    set sprite(value: Sprite | null);
+    /**
+     * The minimum alpha value used by the mask to select the area of influence defined over the mask's sprite. Value between 0 and 1.
+     */
+    get alphaCutoff(): number;
+    set alphaCutoff(value: number);
+    protected _updateBounds(worldBounds: BoundingBox): void;
+    /**
+     * @inheritdoc
+     */
+    protected _render(context: RenderContext): void;
+    /**
+     * @inheritdoc
+     */
+    protected _onDestroy(): void;
+    private _calDefaultSize;
+    private _onSpriteChange;
+}

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

@@ -0,0 +1,95 @@
+import { BoundingBox, Color } from "@galacean/engine-math";
+import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Renderer } from "../../Renderer";
+import { ISpriteRenderer } from "../assembler/ISpriteRenderer";
+import { SpriteDrawMode } from "../enums/SpriteDrawMode";
+import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
+import { SpriteTileMode } from "../enums/SpriteTileMode";
+import { Sprite } from "./Sprite";
+import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
+/**
+ * Renders a Sprite for 2D graphics.
+ */
+export declare class SpriteRenderer extends Renderer implements ISpriteRenderer {
+    private _drawMode;
+    private _assembler;
+    private _tileMode;
+    private _tiledAdaptiveThreshold;
+    private _color;
+    private _sprite;
+    private _automaticWidth;
+    private _automaticHeight;
+    private _customWidth;
+    private _customHeight;
+    private _flipX;
+    private _flipY;
+    /**
+     * The draw mode of the sprite renderer.
+     */
+    get 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.
+     */
+    get sprite(): Sprite;
+    set sprite(value: Sprite | null);
+    /**
+     * Rendering color for the Sprite graphic.
+     */
+    get color(): Color;
+    set color(value: Color);
+    /**
+     * 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 (in world coordinates).
+     *
+     * @remarks
+     * If height is set, return the set value,
+     * otherwise return `SpriteRenderer.sprite.height`.
+     */
+    get height(): number;
+    set height(value: number);
+    /**
+     * Flips the sprite on the X axis.
+     */
+    get flipX(): boolean;
+    set flipX(value: boolean);
+    /**
+     * Flips the sprite on the Y axis.
+     */
+    get flipY(): boolean;
+    set flipY(value: boolean);
+    /**
+     * The mask layer the sprite renderer belongs to.
+     */
+    get maskLayer(): SpriteMaskLayer;
+    set maskLayer(value: SpriteMaskLayer);
+    /**
+     * Interacts with the masks.
+     */
+    get maskInteraction(): SpriteMaskInteraction;
+    set maskInteraction(value: SpriteMaskInteraction);
+    protected _updateBounds(worldBounds: BoundingBox): void;
+    protected _render(context: RenderContext): void;
+    protected _onDestroy(): void;
+    private _calDefaultSize;
+    private _onSpriteChange;
+    private _onColorChanged;
+}

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

@@ -0,0 +1,3 @@
+export { Sprite } from "./Sprite";
+export { SpriteMask } from "./SpriteMask";
+export { SpriteRenderer } from "./SpriteRenderer";

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

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

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

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

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

@@ -0,0 +1,21 @@
+import { ReferResource } from "../../asset/ReferResource";
+import { Engine } from "../../Engine";
+/**
+ * Font.
+ */
+export declare class Font extends ReferResource {
+    /**
+     * Create a system font.
+     * @param engine - Engine to which the font belongs
+     * @param name - The name of font want to create
+     * @returns The font object has been create
+     */
+    static createFromOS(engine: Engine, name: string): Font;
+    private _name;
+    private _subFontMap;
+    /**
+     * The name of the font object.
+     */
+    get name(): string;
+    constructor(engine: Engine, name?: string);
+}

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

@@ -0,0 +1,8 @@
+import { OverflowMode } from "../enums/TextOverflow";
+import { SubFont } from "./SubFont";
+export interface ITextRenderer {
+    text: string;
+    overflowMode: OverflowMode;
+    lineSpacing: number;
+    _getSubFont(): SubFont;
+}

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

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