@galacean/engine-core 1.0.0 → 1.0.1

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/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

@@ -3,7 +3,7 @@ import { Component } from "../Component";
 import { ColliderShape } from "./shape/ColliderShape";
 /**
  * Base class for all colliders.
- * @decorator `@dependentComponents(Transform)`
+ * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 export declare class Collider extends Component {
     protected _updateFlag: BoolUpdateFlag;

package/types/physics/Collision.d.ts

@@ -0,0 +1,4 @@
+import { ColliderShape } from "./shape";
+export declare class Collision {
+    shape: ColliderShape;
+}

package/types/physics/PhysicsManager.d.ts

@@ -1,4 +1,3 @@
-import { IPhysics } from "@galacean/engine-design";
 import { Ray, Vector3 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Layer } from "../Layer";
@@ -7,8 +6,10 @@ import { HitResult } from "./HitResult";
  * A physics manager is a collection of colliders and constraints which can interact.
  */
 export declare class PhysicsManager {
+    private static _collision;
     private _engine;
     private _restTime;
+    private _fixedTimeStep;
     private _colliders;
     private _gravity;
     private _nativePhysicsManager;
@@ -19,33 +20,15 @@ export declare class PhysicsManager {
     private _onTriggerEnter;
     private _onTriggerExit;
     private _onTriggerStay;
-    /** The fixed time step in seconds at which physics are performed. */
-    fixedTimeStep: number;
-    /**
-     * The max allowed time step in seconds one frame.
-     *
-     * @remarks
-     * When the frame rate is low or stutter occurs, the maximum execution time of physics will not exceed this value.
-     * So physics will slow down a bit when performance hitch occurs.
-     */
-    maxAllowedTimeStep: number;
     /**
      * The gravity of physics scene.
      */
     get gravity(): Vector3;
     set gravity(value: Vector3);
-    /**
-     * @deprecated
-     * Please use `maxAllowedTimeStep` instead.
-     */
-    get maxSumTimeStep(): number;
-    set maxSumTimeStep(value: number);
+    /** The fixed time step in seconds at which physics are performed. */
+    get fixedTimeStep(): number;
+    set fixedTimeStep(value: number);
     constructor(engine: Engine);
-    /**
-     * initialize PhysicsManager.
-     * @param physics - Physics Engine
-     */
-    initialize(physics: IPhysics): void;
     /**
      * Casts a ray through the Scene and returns the first hit.
      * @param ray - The ray

package/types/physics/PhysicsScene.d.ts

@@ -0,0 +1,79 @@
+import { Ray, Vector3 } from "@galacean/engine-math";
+import { Layer } from "../Layer";
+import { Scene } from "../Scene";
+import { HitResult } from "./HitResult";
+/**
+ * A physics scene is a collection of colliders and constraints which can interact.
+ */
+export declare class PhysicsScene {
+    private static _collision;
+    private _scene;
+    private _restTime;
+    private _fixedTimeStep;
+    private _colliders;
+    private _gravity;
+    private _nativePhysicsScene;
+    private _onContactEnter;
+    private _onContactExit;
+    private _onContactStay;
+    private _onTriggerEnter;
+    private _onTriggerExit;
+    private _onTriggerStay;
+    /**
+     * 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.
+     * @param ray - The ray
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, outHitResult: HitResult): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, distance: number): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, distance: number, outHitResult: HitResult): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when casting
+     * @returns Returns True if the ray intersects with a collider, otherwise false
+     */
+    raycast(ray: Ray, distance: number, layerMask: Layer): boolean;
+    /**
+     * Casts a ray through the Scene and returns the first hit.
+     * @param ray - The ray
+     * @param distance - The max distance the ray should check
+     * @param layerMask - Layer mask that is used to selectively ignore Colliders when casting
+     * @param outHitResult - If true is returned, outHitResult will contain more detailed collision information
+     * @returns Returns True if the ray intersects with a collider, otherwise false.
+     */
+    raycast(ray: Ray, distance: number, layerMask: Layer, outHitResult: HitResult): boolean;
+    private _setGravity;
+}

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

@@ -1,11 +1,11 @@
 import { IJoint } from "@galacean/engine-design";
 import { Vector3 } from "@galacean/engine-math";
 import { Component } from "../../Component";
-import { Collider } from "../Collider";
 import { Entity } from "../../Entity";
+import { Collider } from "../Collider";
 /**
  * A base class providing common functionality for joints.
- * @decorator `@dependentComponents(Collider)`
+ * @decorator `@dependentComponents(Collider, DependentMode.CheckOnly)`
  */
 export declare class Joint extends Component {
     protected _connectedCollider: JointCollider;

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/renderingHardwareInterface/IPlatformBuffer.d.ts

@@ -0,0 +1,8 @@
+import { SetDataOptions } from "../graphic";
+export interface IPlatformBuffer {
+    bind(): void;
+    setData(byteLength: number, data: ArrayBuffer | ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number, options?: SetDataOptions): void;
+    getData(data: ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number): void;
+    resize(byteLength: number): void;
+    destroy(): void;
+}

package/types/renderingHardwareInterface/index.d.ts

@@ -1,4 +1,5 @@
 export type { IHardwareRenderer } from "./IHardwareRenderer";
+export type { IPlatformBuffer } from "./IPlatformBuffer";
 export type { IPlatformRenderTarget } from "./IPlatformRenderTarget";
 export type { IPlatformTexture } from "./IPlatformTexture";
 export type { IPlatformTexture2D } from "./IPlatformTexture2D";

package/types/shader/Shader.d.ts

@@ -2,15 +2,13 @@ import { Engine } from "../Engine";
 import { ShaderMacro } from "./ShaderMacro";
 import { ShaderPass } from "./ShaderPass";
 import { ShaderProperty } from "./ShaderProperty";
+import { SubShader } from "./SubShader";
 /**
  * Shader for rendering.
  */
 export declare class Shader {
+    readonly name: string;
     private static _shaderMap;
-    private static _propertyNameMap;
-    private static _macroMaskMap;
-    private static _macroCounter;
-    private static _macroMap;
     /**
      * Create a shader.
      * @param name - Name of the shader
@@ -26,18 +24,46 @@ export declare class Shader {
      * @returns Shader
      */
     static create(name: string, shaderPasses: ShaderPass[]): Shader;
+    /**
+     * Create a shader.
+     * @param name - Name of the shader
+     * @param subShaders - Sub shaders
+     * @returns Shader
+     */
+    static create(name: string, subShaders: SubShader[]): Shader;
     /**
      * Find a shader by name.
      * @param name - Name of the shader
      */
     static find(name: string): Shader;
+    private _subShaders;
+    /**
+     * Sub shaders of the shader.
+     */
+    get subShaders(): ReadonlyArray<SubShader>;
+    private constructor();
+    /**
+     * Compile shader variant by macro name list.
+     *
+     * @remarks
+     * Usually a shader contains some macros,any combination of macros is called shader variant.
+     *
+     * @param engine - Engine to which the shader variant belongs
+     * @param macros - Macro name list
+     * @returns Is the compiled shader variant valid
+     */
+    compileVariant(engine: Engine, macros: string[]): boolean;
     /**
+     * @deprecated Please use `ShaderMacro.getByName` instead
+     *
      * Get shader macro by name.
      * @param name - Name of the shader macro
      * @returns Shader macro
      */
     static getMacroByName(name: string): ShaderMacro;
     /**
+     * @deprecated Please use `ShaderMacro.getByName` instead
+     *
      * Get shader macro by name.
      * @param name - Name of the shader macro
      * @param value - Value of the shader macro
@@ -45,28 +71,11 @@ export declare class Shader {
      */
     static getMacroByName(name: string, value: string): ShaderMacro;
     /**
+     * @deprecated Please use `ShaderProperty.getByName` instead
+     *
      * Get shader property by name.
      * @param name - Name of the shader property
      * @returns Shader property
      */
     static getPropertyByName(name: string): ShaderProperty;
-    /** The name of shader. */
-    readonly name: string;
-    /**
-     *  Shader passes.
-     */
-    get passes(): ReadonlyArray<ShaderPass>;
-    private _passes;
-    private constructor();
-    /**
-     * Compile shader variant by macro name list.
-     *
-     * @remarks
-     * Usually a shader contains some macros,any combination of macros is called shader variant.
-     *
-     * @param engine - Engine to which the shader variant belongs
-     * @param macros - Macro name list
-     * @returns Is the compiled shader variant valid
-     */
-    compileVariant(engine: Engine, macros: string[]): boolean;
 }