@galacean/engine-core 1.1.0-beta.2 → 1.1.0-beta.21

package/types/xr/input/XRTrackingState.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Enum for XR tracking state.
+ */
+export declare enum XRTrackingState {
+    /** Not tracking */
+    NotTracking = 0,
+    /** Tracking */
+    Tracking = 1,
+    /** Lost track */
+    TrackingLost = 2
+}

package/types/xr/session/XRSessionManager.d.ts

@@ -0,0 +1,76 @@
+import { IXRFrame, IXRSession, IXRFeatureDescriptor } from "@galacean/engine-design";
+import { Engine } from "../../Engine";
+import { XRSessionType } from "./XRSessionType";
+import { XRSessionState } from "./XRSessionState";
+type TXRSessionStateChangeListener = (from: XRSessionState, to: XRSessionState) => void;
+export declare class XRSessionManager {
+    protected _engine: Engine;
+    protected _session: IXRSession;
+    protected _frame: IXRFrame;
+    protected _state: XRSessionState;
+    private _rhi;
+    private _listeners;
+    /**
+     * Return the current session state.
+     */
+    get state(): XRSessionState;
+    /**
+     * Return the current session.
+     */
+    get session(): IXRSession;
+    /**
+     * Return a list of supported frame rates.(only available in-session)
+     */
+    get supportedFrameRate(): Float32Array;
+    /**
+     * Return the current frame rate as reported by the device.
+     */
+    get frameRate(): number;
+    /**
+     * Returns requestAnimationFrame in XR.
+     */
+    get requestAnimationFrame(): (callback: FrameRequestCallback) => number;
+    /**
+     * Returns cancelAnimationFrame in XR.
+     */
+    get cancelAnimationFrame(): (id: number) => void;
+    /**
+     * Initialize the session.
+     * @param mode - The mode of the session
+     * @param requestFeatures - The requested features
+     * @returns The promise of the session
+     */
+    initialize(mode: XRSessionType, requestFeatures: IXRFeatureDescriptor[]): Promise<IXRSession>;
+    /**
+     * Start the session.
+     * @returns The promise of the session
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the session.
+     * @returns The promise of the session
+     */
+    stop(): Promise<void>;
+    /**
+     * Destroy the session.
+     * @returns The promise of the session
+     */
+    destroy(): Promise<void>;
+    /**
+     * Add a session state change listener.
+     * @param listener - The listener to add
+     */
+    addSessionStateChangeListener(listener: TXRSessionStateChangeListener): void;
+    /**
+     * Remove a session state change listener.
+     * @param listener - The listener to remove
+     */
+    removeSessionStateChangeListener(listener: TXRSessionStateChangeListener): void;
+    /**
+     * Remove all session state change listeners.
+     */
+    removeAllSessionStateChangeListener(): void;
+    constructor(_engine: Engine);
+    private _dispatchSessionStateChange;
+}
+export {};

package/types/xr/session/XRSessionState.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The state of an XRSession.
+ */
+export declare enum XRSessionState {
+    /** Not initialized. */
+    None = 0,
+    /** Initialized but not started. */
+    Initialized = 1,
+    /** Running. */
+    Running = 2,
+    /** Paused. */
+    Paused = 3
+}

package/types/xr/session/XRSessionType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The type of XR session.
+ */
+export declare enum XRSessionType {
+    AR = 0,
+    VR = 1
+}

package/types/RenderPipeline/RenderElementX.d.ts

@@ -1,12 +0,0 @@
-import { Renderer } from "../Renderer";
-import { Primitive } from "../graphic/Primitive";
-import { Material } from "../material/Material";
-import { ShaderPass } from "../shader/ShaderPass";
-import { IPoolElement } from "./IPoolElement";
-export declare class RenderElementX implements IPoolElement {
-    shaderPasses: ReadonlyArray<ShaderPass>;
-    component: Renderer;
-    material: Material;
-    primitive: Primitive;
-    dispose(): void;
-}

package/types/Ticker.d.ts

@@ -1,30 +0,0 @@
-export declare class Ticker {
-    private _vSyncCount;
-    private _vSyncCounter;
-    private _requestId;
-    private _animationLoop;
-    private _requestAnimationFrame;
-    private _cancelAnimationFrame;
-    /**
-     * The number of vertical synchronization means the number of vertical blanking for one frame.
-     * @remarks 0 means that the vertical synchronization is turned off.
-     */
-    get vSyncCount(): number;
-    set vSyncCount(value: number);
-    get requestAnimationFrame(): (...params: any[]) => any;
-    set requestAnimationFrame(func: (...params: any[]) => any);
-    get cancelAnimationFrame(): (...params: any[]) => any;
-    set cancelAnimationFrame(func: (...params: any[]) => any);
-    get animationLoop(): (...params: any[]) => any;
-    set animationLoop(func: (...params: any[]) => any);
-    /**
-     * Pause the engine.
-     */
-    pause(): void;
-    /**
-     * Resume the engine.
-     */
-    resume(): void;
-    private _onAnimationFrame;
-    constructor();
-}

package/types/animation/internal/AnimationCurveOwnerLayerData.d.ts

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

package/types/graphic/PrimitiveVertexBinding.d.ts

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

package/types/particle/ParticleShaderMacro.d.ts

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

package/types/particle/ParticleShaderProperty.d.ts

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

package/types/particle/ParticleSystem.d.ts

@@ -1,41 +0,0 @@
-import { ParticleRenderer } from "./ParticleRenderer";
-import { EmissionModule } from "./modules/EmissionModule";
-import { MainModule } from "./modules/MainModule";
-import { ShapeModule } from "./modules/ShapeModule";
-/**
- * Particle System.
- */
-export declare class ParticleGenerator {
-    /** Use auto random seed. */
-    useAutoRandomSeed: boolean;
-    /** Main module. */
-    readonly main: MainModule;
-    /** Emission module. */
-    readonly emission: EmissionModule;
-    /** Shape module. */
-    readonly shape: ShapeModule;
-    private _waitProcessRetiredElementCount;
-    private _instanceVertexBufferBinding;
-    private _instanceVertices;
-    private readonly _engine;
-    private readonly _renderer;
-    private readonly _particleIncreaseCount;
-    /**
-     * Random seed.
-     * @remarks If `useAutoRandomSeed` is true, this value will be random changed when play.
-     */
-    get randomSeed(): number;
-    set randomSeed(value: number);
-    constructor(renderer: ParticleRenderer);
-    /**
-     * Emit a certain number of particles.
-     * @param count - Number of particles to emit
-     */
-    emit(count: number): void;
-    private _addNewParticle;
-    private _retireActiveParticles;
-    private _freeRetiredParticles;
-    private _addNewParticlesToVertexBuffer;
-    private _createParticleData;
-    private _addVertexBufferBindingsFilterDuplicate;
-}

package/types/particle/ParticleVertexElements.d.ts

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

package/types/particle/ParticleVertexUtils.d.ts

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

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

@@ -1,9 +0,0 @@
-import { ParticleGeneratorModule } from "./ParticleGeneratorModule";
-import { BaseShape } from "./shape/BaseShape";
-/**
- * Shape module of `ParticleGenerator`.
- */
-export declare class ShapeModule extends ParticleGeneratorModule {
-    /** The shape of the emitter. */
-    shape: BaseShape;
-}

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

@@ -1,9 +0,0 @@
-/**
- * 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/EmissionModule.d.ts

@@ -1,49 +0,0 @@
-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

@@ -1,59 +0,0 @@
-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/ParticleGradient.d.ts

@@ -1,28 +0,0 @@
-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

@@ -1,7 +0,0 @@
-/**
- * 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

@@ -1,28 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

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

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

@@ -1,23 +0,0 @@
-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

@@ -1,9 +0,0 @@
-/**
- * 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

@@ -1,15 +0,0 @@
-/**
- * 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

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

package/types/utils/BoolUpdateFlag.d.ts

@@ -1,12 +0,0 @@
-import { UpdateFlag } from "./UpdateFlag";
-/**
- * Bool update flag.
- */
-export declare class BoolUpdateFlag extends UpdateFlag {
-    /** Bool flag. */
-    flag: boolean;
-    /**
-     * @inheritdoc
-     */
-    dispatch(): void;
-}

package/types/utils/DisorderedArray.d.ts

@@ -1,18 +0,0 @@
-/**
- * High-performance unordered array, delete uses exchange method to improve performance, internal capacity only increases.
- */
-export declare class DisorderedArray<T> {
-    _elements: T[];
-    length: number;
-    constructor(count?: number);
-    add(element: T): void;
-    delete(element: T): void;
-    get(index: number): T;
-    /**
-     *
-     * @param index
-     * @returns The replaced item is used to reset its index.
-     */
-    deleteByIndex(index: number): T;
-    garbageCollection(): void;
-}

package/types/utils/UpdateFlag.d.ts

@@ -1,20 +0,0 @@
-/**
- * Used to update tags.
- */
-export declare abstract class UpdateFlag {
-    /**
-     * Dispatch.
-     * @param bit - Bit
-     * @param param - Parameter
-     */
-    abstract dispatch(bit?: number, param?: Object): void;
-    /**
-     * Clear.
-     */
-    clearFromManagers(): void;
-    /**
-     * Destroy.
-     */
-    destroy(): void;
-    private _removeFromManagers;
-}

package/types/utils/UpdateFlagManager.d.ts

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