@galacean/engine-core 0.9.20 → 0.9.21

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

@@ -3,6 +3,5 @@ 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/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/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

@@ -0,0 +1,60 @@
+export declare enum RenderStateElementKey {
+    /** Blend state enabled for target 0 key. */
+    BlendStateEnabled0 = 0,
+    /** Blend state color blend operation for target 0 key. */
+    BlendStateColorBlendOperation0 = 1,
+    /** Blend state alpha blend operation for target 0 key. */
+    BlendStateAlphaBlendOperation0 = 2,
+    /** Blend state source color blend factor for target 0 key. */
+    BlendStateSourceColorBlendFactor0 = 3,
+    /** Blend state source alpha blend factor for target 0 key. */
+    BlendStateSourceAlphaBlendFactor0 = 4,
+    /** Blend state destination color blend factor for target 0 key. */
+    BlendStateDestinationColorBlendFactor0 = 5,
+    /** Blend state destination alpha blend factor for target 0 key. */
+    BlendStateDestinationAlphaBlendFactor0 = 6,
+    /** Blend state color write mask for target 0 key. */
+    BlendStateColorWriteMask0 = 7,
+    /** Blend state blend color key. */
+    BlendStateBlendColor = 8,
+    /** Blend state alpha to coverage key. */
+    BlendStateAlphaToCoverage = 9,
+    /** Depth state enabled key. */
+    DepthStateEnabled = 10,
+    /** Depth state write enabled key. */
+    DepthStateWriteEnabled = 11,
+    /** Depth state compare function key. */
+    DepthStateCompareFunction = 12,
+    /** Stencil state enabled key. */
+    StencilStateEnabled = 13,
+    /** Stencil state reference value key. */
+    StencilStateReferenceValue = 14,
+    /** Stencil state read mask key. */
+    StencilStateMask = 15,
+    /** Stencil state write mask key. */
+    StencilStateWriteMask = 16,
+    /** Stencil state compare function front key. */
+    StencilStateCompareFunctionFront = 17,
+    /** Stencil state compare function back key. */
+    StencilStateCompareFunctionBack = 18,
+    /** Stencil state pass operation front key. */
+    StencilStatePassOperationFront = 19,
+    /** Stencil state pass operation back key. */
+    StencilStatePassOperationBack = 20,
+    /** Stencil state fail operation front key. */
+    StencilStateFailOperationFront = 21,
+    /** Stencil state fail operation back key. */
+    StencilStateFailOperationBack = 22,
+    /** Stencil state z fail operation front key. */
+    StencilStateZFailOperationFront = 23,
+    /** Stencil state z fail operation back key. */
+    StencilStateZFailOperationBack = 24,
+    /** Raster state fill mode key. */
+    RasterStateCullMode = 25,
+    /** Raster state cull mode key. */
+    RasterStateDepthBias = 26,
+    /** Raster state depth bias key. */
+    RasterStateSlopeScaledDepthBias = 27,
+    /** Render queue type key. */
+    RenderQueueType = 28
+}

package/types/shaderlib/particle/index.d.ts

@@ -0,0 +1,14 @@
+declare const _default: {
+    particle_common: string;
+    velocity_over_lifetime_module: string;
+    rotation_over_lifetime_module: string;
+    size_over_lifetime_module: string;
+    color_over_lifetime_module: string;
+    texture_sheet_animation_module: string;
+    sphere_billboard: string;
+    stretched_billboard: string;
+    vertical_billboard: string;
+    horizontal_billboard: string;
+    particle_mesh: string;
+};
+export default _default;

package/types/shadow/PipelinePass.d.ts

@@ -0,0 +1,16 @@
+import { Engine } from "../Engine";
+import { CullingResults } from "../RenderPipeline/CullingResults";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+/**
+ * PipelinePass is a base class for all pipeline passes.
+ */
+export declare abstract class PipelinePass {
+    protected _engine: Engine;
+    constructor(engine: Engine);
+    /**
+     * Called before rendering a camera, override this method to configure the camera If you need to configure the camera clear flag or render target.
+     * @param context - Rendering context
+     * @param cullingResults - Culling results
+     */
+    abstract onRender(context: RenderContext, cullingResults: CullingResults): void;
+}

package/types/utils/BoolUpdateFlag.d.ts

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

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

@@ -0,0 +1,41 @@
+export declare class SafeLoopArray<T> {
+    private _array;
+    private _loopArray;
+    private _loopArrayDirty;
+    /**
+     * Get the length of the array.
+     */
+    get length(): number;
+    /**
+     * Push item to the array.
+     * @param item - The item which want to be pushed
+     */
+    push(item: T): void;
+    /**
+     * Add item to the array.
+     * @param index - The index of the array
+     * @param item - The item which want to be added
+     */
+    add(index: number, item: T): void;
+    /**
+     * Remove item from the array.
+     * @param index - The index of the array
+     */
+    removeByIndex(index: number): void;
+    /**
+     * The index of the item.
+     * @param item - The item which want to get the index
+     * @returns Index of the item
+     */
+    indexOf(item: T): number;
+    /**
+     * Get the array.
+     * @returns The array
+     */
+    getArray(): ReadonlyArray<T>;
+    /**
+     * Get the array use for loop.
+     * @returns The array use for loop
+     */
+    getLoopArray(): ReadonlyArray<T>;
+}

package/types/utils/UpdateFlag.d.ts

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

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

package/types/utils/Utils.d.ts

@@ -0,0 +1,31 @@
+export declare class Utils {
+    /**
+     * Fast remove an element from array.
+     * @param array - Array
+     * @param item - Element
+     */
+    static removeFromArray(array: any[], item: any): boolean;
+    /**
+     * Decodes a given Uint8Array into a string.
+     */
+    static decodeText(array: Uint8Array): string;
+    /**
+     * Judge whether the url is absolute url.
+     * @param url - The url to be judged.
+     * @returns Whether the url is absolute url.
+     */
+    static isAbsoluteUrl(url: string): boolean;
+    /**
+     * Get the values of an object.
+     */
+    static objectValues(obj: any): any[];
+    /**
+     * Convert a relative URL to an absolute URL based on a given base URL.
+     * @param baseUrl - The base url.
+     * @param relativeUrl - The relative url.
+     * @returns The resolved url.
+     */
+    static resolveAbsoluteUrl(baseUrl: string, relativeUrl: string): string;
+    private static _stringToPath;
+    private static _formatRelativePath;
+}

package/types/xr/XRManager.d.ts

@@ -0,0 +1,31 @@
+import { Engine } from "../Engine";
+import { EnumXRMode } from "./enum/EnumXRMode";
+import { EnumXRFeature } from "./enum/EnumXRFeature";
+import { EnumXRTrackingMode } from "./enum/EnumXRTrackingMode";
+import { XRFeature } from "./feature/XRFeature";
+import { EnumXRSubsystem } from "./enum/EnumXRSubsystem";
+import { XRProvider } from "./provider/XRProvider";
+import { XRSubsystem } from "./subsystem/XRSubsystem";
+type FeatureConstructor = new (engine: Engine) => XRFeature;
+export declare class XRManager {
+    private _engine;
+    private _provider;
+    private _features;
+    private _subsystems;
+    private _isPaused;
+    isSupportedMode(mode: EnumXRMode): Promise<void>;
+    isSupportedTrackingMode(mode: EnumXRTrackingMode): Promise<void>;
+    isSupportedFeature(feature: EnumXRFeature): Promise<void>;
+    getFeature<T extends XRFeature>(feature: EnumXRFeature): T;
+    enableFeature(feature: EnumXRFeature): void;
+    disableFeature(feature: EnumXRFeature): void;
+    getSubsystem<T extends XRSubsystem>(subsystem: EnumXRSubsystem): T;
+    initialize(mode: EnumXRMode, trackingMode: EnumXRTrackingMode, requestFeatures?: EnumXRFeature[]): Promise<void>;
+    start(): Promise<void>;
+    pause(): void;
+    resume(): void;
+    destroy(): void;
+    constructor(engine: Engine, type: new (engine: Engine) => XRProvider);
+}
+export declare function registerFeature(feature: EnumXRFeature, dependentSubsystem?: EnumXRSubsystem[]): (featureConstructor: FeatureConstructor) => void;
+export {};

package/types/xr/component/XRPoseDriver.d.ts

@@ -0,0 +1,10 @@
+import { Script } from "../../Script";
+import { EnumXRInputSource } from "../enum/EnumXRInputSource";
+import { EnumXRTrackingMode } from "../enum/EnumXRTrackingMode";
+export declare class XRPoseDriver extends Script {
+    source: EnumXRInputSource;
+    updateType: EnumXRTrackingMode;
+    private _xrManager;
+    onLateUpdate(): void;
+    onAwake(): void;
+}

package/types/xr/data/XRCamera.d.ts

@@ -0,0 +1,6 @@
+import { Matrix, Vector4 } from "@galacean/engine-math";
+import { XRDevice } from "./XRDevice";
+export declare class XRCamera extends XRDevice {
+    project: Matrix;
+    viewport: Vector4;
+}

package/types/xr/data/XRDevice.d.ts

@@ -0,0 +1,9 @@
+import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
+import { EnumXRDevicePhase } from "../enum/EnumXRDevicePhase";
+export declare class XRDevice {
+    matrix: Matrix;
+    position: Vector3;
+    linearVelocity: Vector3;
+    quaternion: Quaternion;
+    phase: EnumXRDevicePhase;
+}

package/types/xr/data/XRHandle.d.ts

@@ -0,0 +1,10 @@
+import { XRDevice } from "./XRDevice";
+import { EnumXRButton } from "../enum/EnumXRButton";
+import { DisorderedArray } from "../../DisorderedArray";
+export declare class XRHandle extends XRDevice {
+    pressedButtons: EnumXRButton;
+    upMap: number[];
+    downMap: number[];
+    upList: DisorderedArray<EnumXRButton>;
+    downList: DisorderedArray<EnumXRButton>;
+}

package/types/xr/enum/EnumXRButton.d.ts

@@ -0,0 +1,5 @@
+export declare enum EnumXRButton {
+    None = 0,
+    Select = 1,
+    Squeeze = 2
+}

package/types/xr/enum/EnumXRDevicePhase.d.ts

@@ -0,0 +1,4 @@
+export declare enum EnumXRDevicePhase {
+    active = 0,
+    leave = 1
+}

package/types/xr/enum/EnumXRFeature.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ */
+export declare enum EnumXRFeature {
+    input = 0,
+    camera = 1,
+    imageTracking = 2,
+    objectTracking = 3
+}

package/types/xr/enum/EnumXRInputSource.d.ts

@@ -0,0 +1,8 @@
+export declare enum EnumXRInputSource {
+    Handler = 0,
+    LeftHandle = 1,
+    RightHandle = 2,
+    Eye = 3,
+    LeftEye = 4,
+    RightEye = 5
+}

package/types/xr/enum/EnumXRMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Modes for XR
+ */
+export declare enum EnumXRMode {
+    AR = 0,
+    VR = 1
+}

package/types/xr/enum/EnumXRSubsystem.d.ts

@@ -0,0 +1,4 @@
+export declare enum EnumXRSubsystem {
+    input = 0,
+    imageTracking = 1
+}

package/types/xr/enum/EnumXRTrackingMode.d.ts

@@ -0,0 +1,7 @@
+export declare enum EnumXRTrackingMode {
+    None = 0,
+    RotationOnly = 1,
+    PositionOnly = 2,
+    RotationAndPosition = 3,
+    Auto = 4
+}

package/types/xr/feature/XRCameraManager.d.ts

@@ -0,0 +1,21 @@
+import { Camera } from "../../Camera";
+import { EnumXRInputSource } from "../enum/EnumXRInputSource";
+import { XRFeature } from "./XRFeature";
+export declare class XRCameraManager extends XRFeature {
+    private _cameras;
+    private _automaticNear;
+    private _customNear;
+    private _automaticFar;
+    private _customFar;
+    get near(): number;
+    set near(value: number);
+    get far(): number;
+    set far(value: number);
+    attachCamera(source: EnumXRInputSource, camera: Camera): void;
+    detachCamera(source: EnumXRInputSource): void;
+    getCamera(source: EnumXRInputSource): Camera;
+    onUpdate(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+}

package/types/xr/feature/XRFeature.d.ts

@@ -0,0 +1,29 @@
+import { Engine } from "../../Engine";
+export declare abstract class XRFeature {
+    protected _engine: Engine;
+    /**
+     * Enable an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onEnable(): void;
+    /**
+     * Disable an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onDisable(): void;
+    /**
+     * Update an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onUpdate(): void;
+    /**
+     * Destroy an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onDestroy(): void;
+    constructor(engine: Engine);
+}

package/types/xr/feature/XRImageTrackManager.d.ts

@@ -0,0 +1,10 @@
+import { Entity } from "../../Entity";
+import { XRFeature } from "./XRFeature";
+export declare class XRImageTrackManager extends XRFeature {
+    addImage(): void;
+    removeImage(): void;
+    getTrackedObject(): Entity;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+}

package/types/xr/feature/XRInputManager.d.ts

@@ -0,0 +1,16 @@
+import { Engine } from "../../Engine";
+import { XRDevice } from "../data/XRDevice";
+import { EnumXRButton } from "../enum/EnumXRButton";
+import { EnumXRInputSource } from "../enum/EnumXRInputSource";
+import { XRFeature } from "./XRFeature";
+export declare class XRInputManager extends XRFeature {
+    private _subSystem;
+    getDevice<T extends XRDevice>(source: EnumXRInputSource): T;
+    isButtonDown(handedness: EnumXRInputSource, button: EnumXRButton): boolean;
+    isButtonUp(handedness: EnumXRInputSource, button: EnumXRButton): boolean;
+    isButtonHeldDown(handedness: EnumXRInputSource, button: EnumXRButton): boolean;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+    constructor(engine: Engine);
+}

package/types/xr/index.d.ts

@@ -0,0 +1,18 @@
+export { XRManager, registerFeature } from "./XRManager";
+export { EnumXRMode } from "./enum/EnumXRMode";
+export { EnumXRButton } from "./enum/EnumXRButton";
+export { EnumXRFeature } from "./enum/EnumXRFeature";
+export { EnumXRSubsystem } from "./enum/EnumXRSubsystem";
+export { EnumXRDevicePhase } from "./enum/EnumXRDevicePhase";
+export { EnumXRInputSource } from "./enum/EnumXRInputSource";
+export { EnumXRTrackingMode } from "./enum/EnumXRTrackingMode";
+export { XRInputManager } from "./feature/XRInputManager";
+export { XRCameraManager } from "./feature/XRCameraManager";
+export { XRImageTrackManager } from "./feature/XRImageTrackManager";
+export { XRSubsystem } from "./subsystem/XRSubsystem";
+export { XRInputSubsystem } from "./subsystem/XRInputSubsystem";
+export { XRProvider } from "./provider/XRProvider";
+export { XRPoseDriver } from "./component/XRPoseDriver";
+export { XRDevice } from "./data/XRDevice";
+export { XRCamera } from "./data/XRCamera";
+export { XRHandle } from "./data/XRHandle";

package/types/xr/provider/XRProvider.d.ts

@@ -0,0 +1,19 @@
+import { EnumXRMode } from "../enum/EnumXRMode";
+import { EnumXRTrackingMode } from "../enum/EnumXRTrackingMode";
+import { XRSubsystem } from "../subsystem/XRSubsystem";
+import { Engine } from "../../Engine";
+import { EnumXRSubsystem } from "../enum/EnumXRSubsystem";
+export declare class XRProvider {
+    name: string;
+    protected _engine: Engine;
+    isSupportedMode(mode: EnumXRMode): Promise<void>;
+    isSupportedTrackingMode(mode: EnumXRTrackingMode): Promise<void>;
+    isSupportedSubsystem(feature: number): Promise<void>;
+    createSubsystem<T extends XRSubsystem>(feature: number): Promise<T>;
+    initialize(mode: EnumXRMode, trackingMode: EnumXRTrackingMode, subsystems: EnumXRSubsystem[]): Promise<XRSubsystem[]>;
+    start(): Promise<void>;
+    onUpdate(): void;
+    onLateUpdate(): void;
+    onDestroy(): void;
+    constructor(engine: Engine);
+}

package/types/xr/subsystem/XRInputSubsystem.d.ts

@@ -0,0 +1,5 @@
+import { XRDevice } from "../data/XRDevice";
+import { XRSubsystem } from "./XRSubsystem";
+export declare abstract class XRInputSubsystem extends XRSubsystem {
+    devices: XRDevice[];
+}

package/types/xr/subsystem/XRSubsystem.d.ts

@@ -0,0 +1,30 @@
+import { Engine } from "../../Engine";
+export declare abstract class XRSubsystem {
+    running: boolean;
+    _engine: Engine;
+    /**
+     * Starts an instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    start(): Promise<void>;
+    /**
+     * Stops an instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    stop(): Promise<void>;
+    /**
+     * Destroys this instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    destroy(): Promise<void>;
+    /**
+     * Update this instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    update(): void;
+    constructor(engine: Engine);
+}