@galacean/engine-core 1.1.0-alpha.1 → 1.1.0-alpha.2

package/types/particle/modules/VelocityOverLifetimeModule.d.ts

@@ -0,0 +1,34 @@
+import { ShaderMacro } from "../../shader";
+import { ShaderProperty } from "../../shader/ShaderProperty";
+import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
+import { ParticleCompositeCurve } from "./ParticleCompositeCurve";
+import { ParticleGeneratorModule } from "./ParticleGeneratorModule";
+/**
+ * Velocity over lifetime module.
+ */
+export declare class VelocityOverLifetimeModule extends ParticleGeneratorModule {
+    static readonly _constantMacro: ShaderMacro;
+    static readonly _curveMacro: ShaderMacro;
+    static readonly _randomConstantMacro: ShaderMacro;
+    static readonly _randomCurveMacro: ShaderMacro;
+    static readonly _minConstantProperty: ShaderProperty;
+    static readonly _maxConstantProperty: ShaderProperty;
+    static readonly _minGradientXProperty: ShaderProperty;
+    static readonly _minGradientYProperty: ShaderProperty;
+    static readonly _minGradientZProperty: ShaderProperty;
+    static readonly _maxGradientXProperty: ShaderProperty;
+    static readonly _maxGradientYProperty: ShaderProperty;
+    static readonly _maxGradientZProperty: ShaderProperty;
+    static readonly _spaceProperty: ShaderProperty;
+    /** Velocity over lifetime for x axis. */
+    velocityX: ParticleCompositeCurve;
+    /** Velocity over lifetime for z axis. */
+    velocityY: ParticleCompositeCurve;
+    /** Velocity over lifetime for z axis. */
+    velocityZ: ParticleCompositeCurve;
+    /** Velocity space. */
+    space: ParticleSimulationSpace;
+    private _velocityMinConstant;
+    private _velocityMaxConstant;
+    private _velocityMacro;
+}

package/types/particle/modules/shape/BaseShape.d.ts

@@ -0,0 +1,12 @@
+import { ParticleShapeType } from "./enums/ParticleShapeType";
+/**
+ * Base class for all particle shapes.
+ */
+export declare abstract class BaseShape {
+    /** The type of shape to emit particles from. */
+    shapeType: ParticleShapeType;
+    /** Specifies whether the ShapeModule is enabled or disabled. */
+    enable: boolean;
+    /** Randomizes the starting direction of particles. */
+    randomDirectionAmount: number;
+}

package/types/particle/modules/shape/BoxShape.d.ts

@@ -0,0 +1,11 @@
+import { Vector3 } from "@galacean/engine-math";
+import { BaseShape } from "./BaseShape";
+/**
+ * Particle shape that emits particles from a box.
+ */
+export declare class BoxShape extends BaseShape {
+    private static _tempVector30;
+    /** The size of the box. */
+    size: Vector3;
+    constructor();
+}

package/types/particle/modules/shape/CircleShape.d.ts

@@ -0,0 +1,17 @@
+import { BaseShape } from "./BaseShape";
+import { ParticleShapeArcMode } from "./enums/ParticleShapeArcMode";
+/**
+ * Particle shape that emits particles from a circle.
+ */
+export declare class CircleShape extends BaseShape {
+    private static _tempPositionPoint;
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    /** Angle of the circle arc to emit particles from. */
+    arc: number;
+    /** The mode to generate particles around the arc. */
+    arcMode: ParticleShapeArcMode;
+    /** The speed of complete 360 degree rotation. */
+    arcSpeed: number;
+    constructor();
+}

package/types/particle/modules/shape/ConeShape.d.ts

@@ -0,0 +1,28 @@
+import { BaseShape } from "./BaseShape";
+/**
+ * Cone shape.
+ */
+export declare class ConeShape extends BaseShape {
+    private static _tempVector20;
+    private static _tempVector21;
+    private static _tempVector30;
+    private static _tempVector31;
+    /** Angle of the cone to emit particles from. */
+    angle: number;
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    /** Length of the cone to emit particles from. */
+    length: number;
+    /** Cone emitter type. */
+    emitType: ConeEmitType;
+    constructor();
+}
+/**
+ * Cone emitter type.
+ */
+export declare enum ConeEmitType {
+    /** Emit particles from the base of the cone. */
+    Base = 0,
+    /** Emit particles from the volume of the cone. */
+    Volume = 1
+}

package/types/particle/modules/shape/HemisphereShape.d.ts

@@ -0,0 +1,9 @@
+import { BaseShape } from "./BaseShape";
+/**
+ * Particle shape that emits particles from a hemisphere.
+ */
+export declare class HemisphereShape extends BaseShape {
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    constructor();
+}

package/types/particle/modules/shape/ShapeUtils.d.ts

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

package/types/particle/modules/shape/SphereShape.d.ts

@@ -0,0 +1,9 @@
+import { BaseShape } from "./BaseShape";
+/**
+ * Particle shape that emits particles from a sphere.
+ */
+export declare class SphereShape extends BaseShape {
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    constructor();
+}

package/types/particle/modules/shape/enums/ParticleShapeArcMode.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Particle shape multi mode value.
+ */
+export declare enum ParticleShapeArcMode {
+    /** Generate points randomly. */
+    Random = 0,
+    /** Animate the emission point around the shape. */
+    Loop = 1
+}

package/types/particle/modules/shape/enums/ParticleShapeMultiModeValue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The mode used to generate new points in a shape.
+ */
+export declare enum ParticleShapeMultiModeValue {
+    /** Generate points randomly. (Default) */
+    Random = 0,
+    /** Animate the emission point around the shape. */
+    Loop = 1
+}

package/types/particle/modules/shape/enums/ParticleShapeType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The emission shape.
+ */
+export declare enum ParticleShapeType {
+    /** Emit from the volume of a box. */
+    Box = 0,
+    /** Emit from a circle. */
+    Circle = 1,
+    /** Emit from the base of a cone. */
+    Cone = 2,
+    /** Emit from a half-sphere. */
+    Hemisphere = 3,
+    /** Emit from a sphere. */
+    Sphere = 4
+}

package/types/particle/modules/shape/index.d.ts

@@ -0,0 +1,6 @@
+export { BoxShape } from "./BoxShape";
+export { CircleShape } from "./CircleShape";
+export { ConeShape, ConeEmitType } from "./ConeShape";
+export { HemisphereShape } from "./HemisphereShape";
+export { SphereShape } from "./SphereShape";
+export { ParticleShapeArcMode } from "./enums/ParticleShapeArcMode";

package/types/particle/moudules/Burst.d.ts

@@ -0,0 +1,25 @@
+import { IClone } from "@galacean/engine-design";
+import { ParticleCurve } from "./ParticleCurve";
+/**
+ * A burst is a particle emission event, where a number of particles are all emitted at the same time
+ */
+export declare class Burst implements IClone {
+    time: number;
+    count: ParticleCurve;
+    /**
+     * Create burst object.
+     * @param time - Time to emit the burst
+     * @param count - Count of particles to emit
+     */
+    constructor(time: number, count: ParticleCurve);
+    /**
+     * clone to
+     * @param  destBurst - The dest
+     */
+    cloneTo(destBurst: Burst): void;
+    /**
+     * clone
+     * @return The copy
+     */
+    clone(): Burst;
+}

package/types/particle/moudules/Emission.d.ts

@@ -0,0 +1,47 @@
+import { IClone } from "@galacean/engine-design";
+import { Burst } from "./Burst";
+import { ParticleCurve } from "./ParticleCurve";
+/**
+ * The EmissionModule of a Particle System.
+ */
+export declare class EmissionModule implements IClone {
+    /** Specifies whether the EmissionModule is enabled or disabled. */
+    enable: boolean;
+    /**  The rate of particle emission. */
+    rateOverTime: ParticleCurve;
+    /**  The rate at which the emitter spawns new particles over distance. */
+    rateOverDistance: ParticleCurve;
+    private _bursts;
+    /**
+     * Gets the burst array.
+     */
+    get bursts(): ReadonlyArray<Burst>;
+    constructor();
+    /**
+     * Add a single burst.
+     * @param burst - The burst
+     */
+    addBurst(burst: Burst): void;
+    /**
+     * Remove a single burst from the array of bursts.
+     * @param burst - The burst data
+     */
+    removeBurst(burst: Burst): void;
+    /**
+     * Remove a single burst from the array of bursts.
+     * @param index - The burst data index
+     */
+    removeBurstByIndex(index: number): void;
+    /**
+     * Clear burst data.
+     */
+    clearBurst(): void;
+    /**
+     * @override
+     */
+    cloneTo(destEmission: EmissionModule): void;
+    /**
+     * @override
+     */
+    clone(): EmissionModule;
+}

package/types/particle/moudules/EmissionModule.d.ts

@@ -0,0 +1,49 @@
+import { ParticleSystem } from "../ParticleSystem";
+import { Burst } from "./Burst";
+import { ParticleCurve } from "./ParticleCurve";
+/**
+ * The EmissionModule of a Particle System.
+ */
+export declare class EmissionModule {
+    /** Specifies whether the EmissionModule is enabled or disabled. */
+    enabled: boolean;
+    /**  The rate of particle emission. */
+    rateOverTime: ParticleCurve;
+    /**  The rate at which the emitter spawns new particles over distance. */
+    rateOverDistance: ParticleCurve;
+    private _bursts;
+    private _frameRateTime;
+    private _currentBurstIndex;
+    private _particleSystem;
+    /**
+     * Gets the burst array.
+     */
+    get bursts(): ReadonlyArray<Burst>;
+    constructor(particleSystem: ParticleSystem);
+    /**
+     * Add a single burst.
+     * @param burst - The burst
+     */
+    addBurst(burst: Burst): void;
+    /**
+     * Remove a single burst from the array of bursts.
+     * @param burst - The burst data
+     */
+    removeBurst(burst: Burst): void;
+    /**
+     * Remove a single burst from the array of bursts.
+     * @param index - The burst data index
+     */
+    removeBurstByIndex(index: number): void;
+    /**
+     * Clear burst data.
+     */
+    clearBurst(): void;
+    /**
+     * @override
+     */
+    cloneTo(destEmission: EmissionModule): void;
+    private _emitByRateOverTime;
+    private _emitByBurst;
+    private _emitBySubBurst;
+}

package/types/particle/moudules/MainModule.d.ts

@@ -0,0 +1,59 @@
+import { ParticleSystem } from "../ParticleSystem";
+import { ParticleScaleMode } from "../enums/ParticleScaleMode";
+import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
+import { ParticleCurve } from "./ParticleCurve";
+import { ParticleGradient } from "./ParticleGradient";
+export declare class MainModule {
+    /** The duration of the Particle System in seconds. */
+    duration: number;
+    /** Specifies whether the Particle System is looping. */
+    loop: boolean;
+    /** Start delay in seconds. */
+    startDelay: ParticleCurve;
+    /** The initial lifetime of particles when emitted. */
+    startLifetime: ParticleCurve;
+    /** The initial speed of particles when the Particle System first spawns them. */
+    startSpeed: ParticleCurve;
+    /** A flag to enable specifying particle size individually for each axis. */
+    startSize3D: boolean;
+    /** The initial size of particles when the Particle System first spawns them. */
+    startSize: ParticleCurve;
+    /** The initial size of particles along the x-axis when the Particle System first spawns them. */
+    startSizeX: ParticleCurve;
+    /** The initial size of particles along the y-axis when the Particle System first spawns them. */
+    startSizeY: ParticleCurve;
+    /** The initial size of particles along the z-axis when the Particle System first spawns them. */
+    startSizeZ: ParticleCurve;
+    /** A flag to enable 3D particle rotation. */
+    startRotation3D: boolean;
+    /** The initial rotation of particles when the Particle System first spawns them. */
+    startRotation: ParticleCurve;
+    /** The initial rotation of particles around the x-axis when emitted.*/
+    startRotationX: ParticleCurve;
+    /** The initial rotation of particles around the y-axis when emitted. */
+    startRotationY: ParticleCurve;
+    /** The initial rotation of particles around the z-axis when emitted. */
+    startRotationZ: ParticleCurve;
+    /** Makes some particles spin in the opposite direction. */
+    flipRotation: number;
+    /** The mode of start color */
+    startColor: ParticleGradient;
+    /** A scale that this Particle System applies to gravity, defined by Physics.gravity. */
+    gravityModifier: ParticleCurve;
+    /** This selects the space in which to simulate particles. It can be either world or local space. */
+    simulationSpace: ParticleSimulationSpace;
+    /** Override the default playback speed of the Particle System. */
+    simulationSpeed: number;
+    /** Control how the Particle System applies its Transform component to the particles it emits. */
+    scalingMode: ParticleScaleMode;
+    /** If set to true, the Particle System automatically begins to play on startup. */
+    playOnAwake: boolean;
+    private _bufferMaxParticles;
+    private _particleSystem;
+    /**
+     * Max particles count.
+     */
+    get maxParticles(): number;
+    set maxParticles(value: number);
+    constructor(particleSystem: ParticleSystem);
+}

package/types/particle/moudules/ParticleCurve.d.ts

@@ -0,0 +1,27 @@
+import { IClone } from "@galacean/engine-design";
+import { ParticleCurveMode } from "../enums/ParticleCurveMode";
+/**
+ * Particle curve.
+ */
+export declare class ParticleCurve implements IClone {
+    /** The curve mode. */
+    mode: ParticleCurveMode;
+    constant: number;
+    constantMin: number;
+    constantMax: number;
+    /**
+     * Query the curve value at the specified time.
+     * @param time - Normalized time at which to evaluate the curve, Valid when `mode` is set to `Curve` or `TwoCurves`
+     * @param lerpFactor - Lerp factor between two constants or curves, Valid when `mode` is set to `TwoConstants` or `TwoCurves`
+     * @returns - The result curve value
+     */
+    evaluate(time: number, lerpFactor: number): number;
+    /**
+     * @inheritDoc
+     */
+    cloneTo(destEmission: ParticleCurve): void;
+    /**
+     * @inheritDoc
+     */
+    clone(): ParticleCurve;
+}

package/types/particle/moudules/ParticleGradient.d.ts

@@ -0,0 +1,28 @@
+import { IClone } from "@galacean/engine-design";
+import { Color } from "@galacean/engine-math";
+import { ParticleGradientMode } from "../enums/ParticleGradientMode";
+/**
+ * Particle curve.
+ */
+export declare class ParticleGradient implements IClone {
+    /** The curve mode. */
+    mode: ParticleGradientMode;
+    color: Color;
+    colorMin: Color;
+    colorMax: Color;
+    /**
+     * Query the color at the specified time.
+     * @param time - Normalized time at which to evaluate the gradient, Valid when `mode` is set to `Gradient` or `TwoGradients`
+     * @param lerpFactor - Lerp factor between two colors or gradients, Valid when `mode` is set to `TwoColors` or `TwoGradients`
+     * @param out - The result color
+     */
+    evaluate(time: number, lerpFactor: number, out: Color): void;
+    /**
+     * @inheritDoc
+     */
+    cloneTo(destEmission: ParticleGradient): void;
+    /**
+     * @inheritDoc
+     */
+    clone(): ParticleGradient;
+}

package/types/particle/moudules/ShapeModule.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Shape module of `ParticleSystem`.
+ */
+export declare class ShapeModule {
+    /** Specifies whether the Shape Module is enabled or disabled. */
+    enabled: boolean;
+}

package/types/particle/moudules/shape/BaseShape.d.ts

@@ -0,0 +1,28 @@
+import { IClone } from "@galacean/engine-design";
+import { BoundingBox, Rand } from "@galacean/engine-math";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
+/**
+ * Configures the initial positions and directions of particles.
+ */
+export declare class BaseShape implements IClone {
+    /** The type of shape to emit particles from. */
+    shapeType: ParticleShapeType;
+    /** Specifies whether the ShapeModule is enabled or disabled. */
+    enable: boolean;
+    /** Randomizes the starting direction of particles. */
+    randomDirectionAmount: number;
+    protected _rand: Rand;
+    constructor(randSeed?: number);
+    /**
+     * @override
+     * @inheritDoc
+     */
+    cloneTo(destShape: BaseShape): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    clone(): BaseShape;
+    protected _getShapeBoundBox(boundBox: BoundingBox): void;
+    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+}

package/types/particle/moudules/shape/BoxShape.d.ts

@@ -0,0 +1,20 @@
+import { BoundingBox, Vector3 } from "@galacean/engine-math";
+import { BaseShape } from "./BaseShape";
+/**
+ * Box emitter shape
+ */
+export declare class BoxShape extends BaseShape {
+    /** Thickness of the box to emit particles from. */
+    boxThickness: Vector3;
+    constructor();
+    /**
+     * @inheritDoc
+     */
+    protected _getShapeBoundBox(boundBox: BoundingBox): void;
+    /**
+     * @inheritDoc
+     */
+    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+    cloneTo(destShape: BoxShape): void;
+    clone(): BoxShape;
+}

package/types/particle/moudules/shape/CircleShape.d.ts

@@ -0,0 +1,27 @@
+import { BoundingBox, Vector2, Vector3 } from "@galacean/engine-math";
+import { BaseShape } from "./BaseShape";
+import { ParticleShapeMultiModeValue } from "./enums/ParticleShapeMultiModeValue";
+/**
+ * Circle Particle Emitter
+ */
+export declare class CircleShape extends BaseShape {
+    protected static _tempPositionPoint: Vector2;
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    /** Angle of the circle arc to emit particles from. */
+    arc: number;
+    /** The mode to generate particles around the arc. */
+    arcMode: ParticleShapeMultiModeValue;
+    constructor();
+    /**
+     * @inheritDoc
+     */
+    protected _getShapeBoundBox(boundBox: BoundingBox): void;
+    /**
+     * @inheritDoc
+     */
+    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+    _generatePositionAndDirection(position: Vector3, direction: Vector3): void;
+    cloneTo(destShape: CircleShape): void;
+    clone(): CircleShape;
+}

package/types/particle/moudules/shape/ConeShape.d.ts

@@ -0,0 +1,35 @@
+import { BoundingBox, Vector2, Vector3 } from "@galacean/engine-math";
+import { BaseShape } from "./BaseShape";
+export declare enum ConeEmitType {
+    Base = 0,
+    BaseShell = 1,
+    Volume = 2,
+    VolumeShell = 3
+}
+/**
+ * Cone particle emitter
+ */
+export declare class ConeShape extends BaseShape {
+    protected static _tempPositionPoint: Vector2;
+    protected static _tempDirectionPoint: Vector2;
+    /** Angle of the cone to emit particles from. */
+    angle: number;
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    /** Length of the cone to emit particles from. */
+    length: number;
+    /** Cone emitter subtype */
+    emitType: ConeEmitType;
+    constructor();
+    /**
+     * @inheritDoc
+     */
+    protected _getShapeBoundBox(boundBox: BoundingBox): void;
+    /**
+     * @inheritDoc
+     */
+    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+    _generatePositionAndDirection(position: Vector3, direction: Vector3): void;
+    cloneTo(destShape: ConeShape): void;
+    clone(): ConeShape;
+}

package/types/particle/moudules/shape/HemisphereShape.d.ts

@@ -0,0 +1,23 @@
+import { BoundingBox, Vector3 } from "@galacean/engine-math";
+import { BaseShape } from "./BaseShape";
+/**
+ * Hemisphere emitter
+ */
+export declare class HemisphereShape extends BaseShape {
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    /** Whether emit from shell */
+    emitFromShell: boolean;
+    constructor();
+    /**
+     * @inheritDoc
+     */
+    protected _getShapeBoundBox(boundBox: BoundingBox): void;
+    /**
+     * @inheritDoc
+     */
+    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+    _generatePositionAndDirection(position: Vector3, direction: Vector3): void;
+    cloneTo(destShape: HemisphereShape): void;
+    clone(): HemisphereShape;
+}

package/types/particle/moudules/shape/ShapeUtils.d.ts

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

package/types/particle/moudules/shape/SphereShape.d.ts

@@ -0,0 +1,23 @@
+import { BoundingBox, Rand, Vector3 } from "@galacean/engine-math";
+import { BaseShape } from "./BaseShape";
+/**
+ * Sphere emitter
+ */
+export declare class SphereShape extends BaseShape {
+    /** Radius of the shape to emit particles from. */
+    radius: number;
+    /** Whether emit from shell */
+    emitFromShell: boolean;
+    constructor();
+    /**
+     * @inheritDoc
+     */
+    protected _getShapeBoundBox(boundBox: BoundingBox): void;
+    /**
+     * @inheritDoc
+     */
+    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+    _generatePositionAndDirection(position: Vector3, direction: Vector3, rand?: Rand, randomSeeds?: Uint32Array): void;
+    cloneTo(destShape: SphereShape): void;
+    clone(): SphereShape;
+}

package/types/particle/moudules/shape/enums/ParticleShapeMultiModeValue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The mode used to generate new points in a shape.
+ */
+export declare enum ParticleShapeMultiModeValue {
+    /** Generate points randomly. (Default) */
+    Random = 0,
+    /** Animate the emission point around the shape. */
+    Loop = 1
+}

package/types/particle/moudules/shape/enums/ParticleShapeType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The emission shape.
+ */
+export declare enum ParticleShapeType {
+    /** Emit from the volume of a box. */
+    Box = 0,
+    /** Emit from a circle. */
+    Circle = 1,
+    /** Emit from the base of a cone. */
+    Cone = 2,
+    /** Emit from a half-sphere. */
+    Hemisphere = 3,
+    /** Emit from a sphere. */
+    Sphere = 4
+}

package/types/particle/moudules/shape/index.d.ts

@@ -0,0 +1,5 @@
+export { BoxShape } from "./BoxShape";
+export { CircleShape } from "./CircleShape";
+export { ConeShape, ConeEmitType } from "./ConeShape";
+export { HemisphereShape } from "./HemisphereShape";
+export { SphereShape } from "./SphereShape";

package/types/physics/PhysicsScene.d.ts

@@ -9,6 +9,7 @@ export declare class PhysicsScene {
     private static _collision;
     private _scene;
     private _restTime;
+    private _fixedTimeStep;
     private _colliders;
     private _gravity;
     private _nativePhysicsScene;
@@ -18,13 +19,16 @@ export declare class PhysicsScene {
     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(scene: Scene);
     /**
      * Casts a ray through the Scene and returns the first hit.