@galacean/engine-core 1.1.0-alpha.3 → 1.1.0-beta.0

package/package.json

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

package/types/Camera.d.ts

@@ -15,6 +15,8 @@ import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
 export declare class Camera extends Component {
     private static _inverseViewMatrixProperty;
     private static _cameraPositionProperty;
+    private static _cameraForwardProperty;
+    private static _cameraUpProperty;
     private static _cameraDepthBufferParamsProperty;
     /** Whether to enable frustum culling, it is enabled by default. */
     enableFrustumCulling: boolean;

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.
  */
@@ -25,8 +26,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;
     addPendingDestroyScript(component: Script): void;

package/types/DisorderedArray.d.ts

@@ -11,14 +11,16 @@ export declare class DisorderedArray<T> {
     delete(element: T): void;
     set(index: number, element: T): void;
     get(index: number): T;
-    startLoop(): void;
     /**
      * 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;
-    endLoop(): void;
-    endLoopAndClear(): void;
+    forEach(callbackFn: (e: T) => void): void;
+    forEachAndClean(callbackFn: (e: T) => void): void;
     garbageCollection(): void;
+    private _startLoop;
+    private _endLoop;
+    private _endLoopAndClear;
 }

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -61,7 +61,7 @@ export declare class BasicRenderPipeline {
      * @param data - Render data
      */
     pushRenderData(context: RenderContext, data: RenderData): void;
-    private pushRenderDataWihShader;
+    private pushRenderDataWithShader;
     private _drawBackgroundTexture;
     private _callRender;
 }

package/types/RenderPipeline/RenderData.d.ts

@@ -1,7 +1,14 @@
+import { SubMesh } from "../graphic";
+import { Primitive } from "../graphic/Primitive";
 import { Material } from "../material";
 import { Renderer } from "../Renderer";
-export declare class RenderData {
+import { IPoolElement } from "./IPoolElement";
+export declare class RenderData implements IPoolElement {
     component: Renderer;
     material: Material;
+    primitive: Primitive;
+    subPrimitive: SubMesh;
     multiRenderData: boolean;
+    setX(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh): void;
+    dispose(): void;
 }

package/types/RenderPipeline/RenderQueue.d.ts

@@ -1,6 +1,7 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
 import { Layer } from "../Layer";
+import { RenderQueueType } from "../shader";
 import { RenderElement } from "./RenderElement";
 /**
  * Render queue.
@@ -8,7 +9,8 @@ import { RenderElement } from "./RenderElement";
 export declare class RenderQueue {
     readonly elements: RenderElement[];
     private _spriteBatcher;
-    constructor(engine: Engine);
+    private readonly _renderQueueType;
+    constructor(engine: Engine, renderQueueType: RenderQueueType);
     /**
      * Push a render element.
      */

package/types/Renderer.d.ts

@@ -1,13 +1,13 @@
 import { BoundingBox, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
-import { ICustomClone } from "./clone/ComponentCloner";
+import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
 /**
  * Basis for all renderers.
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
-export declare class Renderer extends Component implements ICustomClone {
+export declare class Renderer extends Component implements IComponentCustomClone {
     private static _tempVector0;
     private static _receiveShadowMacro;
     private static _localMatrixProperty;

package/types/animation/Animator.d.ts

@@ -75,6 +75,8 @@ export declare class Animator extends Component {
     private _updateCrossFadeData;
     private _preparePlay;
     private _checkTransition;
+    private _checkSubTransition;
+    private _checkBackwardsSubTransition;
     private _crossFadeByTransition;
     private _fireAnimationEvents;
     private _fireSubAnimationEvents;

package/types/animation/Keyframe.d.ts

@@ -1,9 +1,10 @@
-import { Color, Quaternion, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
+import { Color, Quaternion, Rect, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
+import { ReferResource } from "../asset/ReferResource";
 /**
  * Keyframe.
  * @typeParam V - Type of Keyframe value
  */
-export declare class Keyframe<V extends KeyframeValueType, T = V extends number ? number : V extends Vector2 ? Vector2 : V extends Vector3 ? Vector3 : V extends Vector4 | Color | Quaternion ? Vector4 : V extends number[] | Float32Array ? number[] : never> {
+export declare class Keyframe<V extends KeyframeValueType, T = V extends number ? number : V extends Vector2 ? Vector2 : V extends Vector3 ? Vector3 : V extends Vector4 | Color | Quaternion | Rect ? Vector4 : V extends number[] | Float32Array ? number[] : V extends ReferResource ? ReferResource : never> {
     /** The time of the Keyframe. */
     time: number;
     /** The value of the Keyframe. */
@@ -16,4 +17,4 @@ export declare class Keyframe<V extends KeyframeValueType, T = V extends number
 /**
  * Type of Keyframe value.
  */
-export type KeyframeValueType = number | Vector2 | Vector3 | Vector4 | number[] | Float32Array | Quaternion | Color | boolean;
+export type KeyframeValueType = number | Vector2 | Vector3 | Vector4 | number[] | Float32Array | Quaternion | Color | Rect | boolean | ReferResource;

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

@@ -0,0 +1,8 @@
+import { Rect } from "@galacean/engine-math";
+import { AnimationCurve } from "./AnimationCurve";
+/**
+ * Store a collection of Keyframes that can be evaluated over time.
+ */
+export declare class AnimationRectCurve extends AnimationCurve<Rect> {
+    constructor();
+}

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

@@ -0,0 +1,8 @@
+import { ReferResource } from "../../asset/ReferResource";
+import { AnimationCurve } from "./AnimationCurve";
+/**
+ * Store a collection of Keyframes that can be evaluated over time.
+ */
+export declare class AnimationRefCurve extends AnimationCurve<ReferResource> {
+    constructor();
+}

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

@@ -8,3 +8,5 @@ export { AnimationQuaternionCurve } from "./AnimationQuaternionCurve";
 export { AnimationVector2Curve } from "./AnimationVector2Curve";
 export { AnimationVector3Curve } from "./AnimationVector3Curve";
 export { AnimationVector4Curve } from "./AnimationVector4Curve";
+export { AnimationRefCurve } from "./AnimationRefCurve";
+export { AnimationRectCurve } from "./AnimationRectCurve";

package/types/asset/AssetType.d.ts

@@ -50,5 +50,7 @@ export declare enum AssetType {
     /** Font. */
     Font = "Font",
     /** Source Font, include ttf、 otf and woff. */
-    SourceFont = "SourceFont"
+    SourceFont = "SourceFont",
+    /** Project asset. */
+    Project = "project"
 }

package/types/asset/GraphicsResource.d.ts

@@ -1,5 +1,9 @@
 import { Engine } from "../Engine";
 import { ReferResource } from "./ReferResource";
 export declare abstract class GraphicsResource extends ReferResource {
+    /**
+     * Whether the content of the resource is lost.
+     */
+    get isContentLost(): boolean;
     protected constructor(engine: Engine);
 }

package/types/clone/ComponentCloner.d.ts

@@ -5,6 +5,8 @@ import { Entity } from "../Entity";
  */
 export interface ICustomClone {
 }
+export interface IComponentCustomClone {
+}
 export declare class ComponentCloner {
     /**
      * Clone component.

package/types/graphic/Mesh.d.ts

@@ -1,12 +1,12 @@
 import { BoundingBox } from "@galacean/engine-math";
 import { Engine } from "../Engine";
-import { GraphicsResource } from "../asset/GraphicsResource";
+import { ReferResource } from "../asset/ReferResource";
 import { SubMesh } from "../graphic/SubMesh";
 import { MeshTopology } from "../graphic/enums/MeshTopology";
 /**
  * Mesh.
  */
-export declare abstract class Mesh extends GraphicsResource {
+export declare abstract class Mesh extends ReferResource {
     /** Name. */
     name: string;
     private _bounds;
@@ -54,6 +54,5 @@ export declare abstract class Mesh extends GraphicsResource {
      */
     clearSubMesh(): void;
     _addReferCount(value: number): void;
-    _rebuild(): void;
     private _onBoundsChanged;
 }

package/types/graphic/index.d.ts

@@ -11,3 +11,4 @@ export { Mesh } from "./Mesh";
 export { SubMesh } from "./SubMesh";
 export { VertexBufferBinding } from "./VertexBufferBinding";
 export { VertexElement } from "./VertexElement";
+export { Primitive } from "./Primitive";

package/types/mesh/ModelMesh.d.ts

@@ -5,6 +5,7 @@ import { Mesh } from "../graphic/Mesh";
 import { VertexBufferBinding } from "../graphic/VertexBufferBinding";
 import { VertexElement } from "../graphic/VertexElement";
 import { BlendShape } from "./BlendShape";
+import { VertexAttribute } from "./enums/VertexAttribute";
 /**
  * Mesh containing common vertex elements of the model.
  */
@@ -54,7 +55,7 @@ export declare class ModelMesh extends Mesh {
     /**
      * Vertex buffer binding collection.
      */
-    get vertexBufferBindings(): Readonly<VertexBufferBinding[]>;
+    get vertexBufferBindings(): ReadonlyArray<VertexBufferBinding>;
     /**
      * BlendShapes of this ModelMesh.
      */
@@ -187,6 +188,12 @@ export declare class ModelMesh extends Mesh {
      * @param firstIndex - First vertex buffer index, the default value is 0
      */
     setVertexBufferBindings(vertexBufferBindings: VertexBufferBinding[], firstIndex?: number): void;
+    /**
+     * Get `VertexElement` by attribute.
+     * @param attribute - Vertex attribute
+     * @returns Vertex element
+     */
+    getVertexElement(attribute: VertexAttribute): VertexElement | null;
     /**
      * Add a BlendShape for this ModelMesh.
      * @param blendShape - The BlendShape

package/types/particle/ParticleRenderer.d.ts

@@ -1,235 +1,45 @@
-import { Color, Vector3 } from "@galacean/engine-math";
-import { MeshRenderer } from "../mesh/MeshRenderer";
-import { Texture } from "../texture";
-/**
- * Blend mode enums of the particle renderer's material.
- */
-export declare enum ParticleRendererBlendMode {
-    Transparent = 0,
-    Additive = 1
-}
+import { Vector3 } from "@galacean/engine-math";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { Renderer } from "../Renderer";
+import { ModelMesh } from "../mesh/ModelMesh";
+import { ParticleGenerator } from "./ParticleGenerator";
+import { ParticleRenderMode } from "./enums/ParticleRenderMode";
 /**
  * Particle Renderer Component.
  */
-export declare class ParticleRenderer extends MeshRenderer {
-    /** The max number of indices that Uint16Array can support. */
-    private static _uint16VertexLimit;
-    private static _getRandom;
-    private _vertexStride;
-    private _vertices;
-    private _vertexBuffer;
-    private _maxCount;
-    private _position;
-    private _positionRandomness;
-    private _positionArray;
-    private _velocity;
-    private _velocityRandomness;
-    private _acceleration;
-    private _accelerationRandomness;
-    private _color;
-    private _colorRandomness;
-    private _size;
-    private _sizeRandomness;
-    private _alpha;
-    private _alphaRandomness;
-    private _startAngle;
-    private _startAngleRandomness;
-    private _rotateVelocity;
-    private _rotateVelocityRandomness;
-    private _lifetime;
-    private _startTimeRandomness;
-    private _scale;
-    private _isOnce;
-    private _onceTime;
-    private _time;
-    private _isInit;
-    private _isStart;
-    private _updateDirtyFlag;
-    private _isRotateToVelocity;
-    private _isUseOriginColor;
-    private _isScaleByLifetime;
-    private _is2d;
-    private _isFadeIn;
-    private _isFadeOut;
-    private _playOnEnable;
-    private _blendMode;
-    /**
-     * Sprite sheet of texture.
-     */
-    spriteSheet: {
-        x: number;
-        y: number;
-        w: number;
-        h: number;
-    }[];
-    /**
-     * Texture of particle.
-     */
-    get texture(): Texture;
-    set texture(texture: Texture);
-    /**
-     * Position of particles.
-     */
-    get position(): Vector3;
-    set position(value: Vector3);
-    /**
-     * Random range of positions.
-     */
-    get positionRandomness(): Vector3;
-    set positionRandomness(value: Vector3);
-    /**
-     * Array of fixed positions.
-     */
-    get positionArray(): Vector3[];
-    set positionArray(value: Vector3[]);
-    /**
-     * Velocity of particles.
-     */
-    get velocity(): Vector3;
-    set velocity(value: Vector3);
-    /**
-     * Random range of velocity.
-     */
-    get velocityRandomness(): Vector3;
-    set velocityRandomness(value: Vector3);
-    /**
-     * Acceleration of particles.
-     */
-    get acceleration(): Vector3;
-    set acceleration(value: Vector3);
-    /**
-     * Random range of acceleration.
-     */
-    get accelerationRandomness(): Vector3;
-    set accelerationRandomness(value: Vector3);
-    /**
-     * Color of particles.
-     */
-    get color(): Color;
-    set color(value: Color);
-    /**
-     * Random range of color.
-     */
-    get colorRandomness(): number;
-    set colorRandomness(value: number);
-    /**
-     * Size of particles.
-     */
-    get size(): number;
-    set size(value: number);
-    /**
-     * Random range of size.
-     */
-    get sizeRandomness(): number;
-    set sizeRandomness(value: number);
-    /**
-     * Alpha of particles.
-     */
-    get alpha(): number;
-    set alpha(value: number);
-    /**
-     * Random range of alpha.
-     */
-    get alphaRandomness(): number;
-    set alphaRandomness(value: number);
-    /**
-     * Angle of particles.
-     */
-    get angle(): number;
-    set angle(value: number);
-    /**
-     * Random range of angle.
-     */
-    get angleRandomness(): number;
-    set angleRandomness(value: number);
-    /**
-     * Rotate velocity of particles.
-     */
-    get rotateVelocity(): number;
-    set rotateVelocity(value: number);
-    /**
-     * Random range of rotate velocity.
-     */
-    get rotateVelocityRandomness(): number;
-    set rotateVelocityRandomness(value: number);
-    /**
-     * Lifetime of particles.
-     */
-    get lifetime(): number;
-    set lifetime(value: number);
-    /**
-     * Random range of start time.
-     */
-    get startTimeRandomness(): number;
-    set startTimeRandomness(value: number);
-    /**
-     * Scale factor of particles.
-     */
-    get scale(): number;
-    set scale(value: number);
-    /**
-     * Max count of particles.
-     */
-    get maxCount(): number;
-    set maxCount(value: number);
-    /**
-     * Whether play once.
-     */
-    get isOnce(): boolean;
-    set isOnce(value: boolean);
-    /**
-     * Whether follow the direction of velocity.
-     */
-    get isRotateToVelocity(): boolean;
-    set isRotateToVelocity(value: boolean);
-    /**
-     * Whether use origin color.
-     */
-    get isUseOriginColor(): boolean;
-    set isUseOriginColor(value: boolean);
-    /**
-     * Whether scale by lifetime.
-     */
-    get isScaleByLifetime(): boolean;
-    set isScaleByLifetime(value: boolean);
-    /**
-     * Whether 2D rendering.
-     */
-    get is2d(): boolean;
-    set is2d(value: boolean);
-    /**
-     * Whether fade in.
-     */
-    get isFadeIn(): boolean;
-    set isFadeIn(value: boolean);
-    /**
-     * Whether fade out.
-     */
-    get isFadeOut(): boolean;
-    set isFadeOut(value: boolean);
-    /**
-     * Whether play on enable.
-     */
-    get playOnEnable(): boolean;
-    set playOnEnable(value: boolean);
-    /**
-     * Blend mode of the particle renderer's material.
-     */
-    get blendMode(): ParticleRendererBlendMode;
-    set blendMode(value: ParticleRendererBlendMode);
-    constructor(props: any);
-    /**
-     * Start emitting.
-     */
-    start(): void;
-    /**
-     * Stop emitting.
-     */
-    stop(): void;
-    private _createMaterial;
-    private _createMesh;
-    private _updateBuffer;
-    private _updateSingleBuffer;
-    private _updateSingleUv;
-    private _onColorChanged;
+export declare class ParticleRenderer extends Renderer {
+    private static readonly _billboardModeMacro;
+    private static readonly _stretchedBillboardModeMacro;
+    private static readonly _horizontalBillboardModeMacro;
+    private static readonly _verticalBillboardModeMacro;
+    private static readonly _renderModeMeshMacro;
+    private static readonly _pivotOffsetProperty;
+    private static readonly _lengthScale;
+    private static readonly _speedScale;
+    private static readonly _currentTime;
+    /** Particle generator. */
+    readonly generator: ParticleGenerator;
+    /** Specifies how much particles stretch depending on their velocity. */
+    velocityScale: number;
+    /** How much are the particles stretched in their direction of motion, defined as the length of the particle compared to its width. */
+    lengthScale: number;
+    /** The pivot of particle. */
+    pivot: Vector3;
+    private _renderMode;
+    private _currentRenderModeMacro;
+    private _mesh;
+    private _supportInstancedArrays;
+    /**
+     * Specifies how particles are rendered.
+     */
+    get renderMode(): ParticleRenderMode;
+    set renderMode(value: ParticleRenderMode);
+    /**
+     * The mesh of particle.
+     * @remarks Valid when `renderMode` is `Mesh`.
+     */
+    get mesh(): ModelMesh;
+    set mesh(value: ModelMesh);
+    protected _render(context: RenderContext): void;
+    protected _onDestroy(): void;
 }

package/types/particle/index.d.ts

@@ -1 +1,12 @@
-export { ParticleRenderer, ParticleRendererBlendMode } from "./ParticleRenderer";
+export { ParticleMaterial } from "./ParticleMaterial";
+export { ParticleRenderer } from "./ParticleRenderer";
+export { ParticleCurveMode } from "./enums/ParticleCurveMode";
+export { ParticleGradientMode } from "./enums/ParticleGradientMode";
+export { ParticleRenderMode } from "./enums/ParticleRenderMode";
+export { ParticleScaleMode } from "./enums/ParticleScaleMode";
+export { ParticleSimulationSpace } from "./enums/ParticleSimulationSpace";
+export { ParticleStopMode } from "./enums/ParticleStopMode";
+export { Burst } from "./modules/Burst";
+export { ParticleCompositeCurve } from "./modules/ParticleCompositeCurve";
+export { CurveKey, ParticleCurve } from "./modules/ParticleCurve";
+export * from "./modules/shape/index";

package/types/physics/PhysicsManager.d.ts

@@ -9,6 +9,7 @@ export declare class PhysicsManager {
     private static _collision;
     private _engine;
     private _restTime;
+    private _fixedTimeStep;
     private _colliders;
     private _gravity;
     private _nativePhysicsManager;
@@ -19,13 +20,14 @@ export declare class PhysicsManager {
     private _onTriggerEnter;
     private _onTriggerExit;
     private _onTriggerStay;
-    /** The fixed time step in seconds at which physics are performed. */
-    fixedTimeStep: number;
     /**
      * The gravity of physics scene.
      */
     get gravity(): Vector3;
     set gravity(value: Vector3);
+    /** The fixed time step in seconds at which physics are performed. */
+    get fixedTimeStep(): number;
+    set fixedTimeStep(value: number);
     constructor(engine: Engine);
     /**
      * Casts a ray through the Scene and returns the first hit.

package/types/shader/ShaderPart.d.ts

@@ -3,7 +3,12 @@ import { ShaderTagKey } from "./ShaderTagKey";
  * Base class for shader structure.
  */
 export declare abstract class ShaderPart {
+    protected _name: string;
     private _tagsMap;
+    /**
+     * Name.
+     */
+    get name(): string;
     /**
      * Set tag by key name.
      * @param keyName - Key name of the tag

package/types/shader/ShaderPass.d.ts

@@ -6,6 +6,14 @@ export declare class ShaderPass extends ShaderPart {
     private static _shaderPassCounter;
     private _vertexSource;
     private _fragmentSource;
+    /**
+     * Create a shader pass.
+     * @param name - Shader pass name
+     * @param vertexSource - Vertex shader source
+     * @param fragmentSource - Fragment shader source
+     * @param tags - Tags
+     */
+    constructor(name: string, vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
     /**
      * Create a shader pass.
      * @param vertexSource - Vertex shader source

package/types/shader/SubShader.d.ts

@@ -4,7 +4,6 @@ import { ShaderPass } from "./ShaderPass";
  * Sub shader.
  */
 export declare class SubShader extends ShaderPart {
-    readonly name: string;
     private _passes;
     /**
      * Sub shader passes.

package/types/shader/enums/RenderStateElementKey.d.ts

@@ -54,5 +54,7 @@ export declare enum RenderStateElementKey {
     /** Raster state cull mode key. */
     RasterStateDepthBias = 26,
     /** Raster state depth bias key. */
-    RasterStateSlopeScaledDepthBias = 27
+    RasterStateSlopeScaledDepthBias = 27,
+    /** Render queue type key. */
+    RenderQueueType = 28
 }

package/types/shaderlib/ShaderFactory.d.ts

@@ -1,11 +1,7 @@
-declare class ShaderFactory {
+export declare class ShaderFactory {
     static parseCustomMacros(macros: string[]): string;
+    static registerInclude(includeName: string, includeSource: string): void;
     static parseIncludes(src: string): string;
-    /**
-     * GLSL extension.
-     * @param extensions - such as ["GL_EXT_shader_texture_lod"]
-     * */
-    static parseExtension(extensions: string[]): string;
     /**
      * Convert lower GLSL version to GLSL 300 es.
      * @param shader - code
@@ -14,4 +10,3 @@ declare class ShaderFactory {
     static convertTo300(shader: string, isFrag?: boolean): string;
     private static _replaceMRTShader;
 }
-export { ShaderFactory };