@galacean/engine-core 1.0.0-beta.18 → 1.0.0-beta.20

package/package.json

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

package/types/Entity.d.ts

@@ -65,7 +65,7 @@ export declare class Entity extends EngineObject {
      * @param type - The type of the component
      * @returns	The first component which match type
      */
-    getComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    getComponent<T extends Component>(type: new (entity: Entity) => T): T | null;
     /**
      * Get components which match the type.
      * @param type - The type of the component

package/types/RenderPipeline/CullingResults.d.ts

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

package/types/RenderPipeline/DepthOnlyPass.d.ts

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

package/types/RenderPipeline/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/RenderPipeline/PipelineUtils.d.ts

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

package/types/Transform.d.ts

@@ -195,6 +195,7 @@ export declare class Transform extends Component {
      * @returns Change flag
      */
     registerWorldChangeFlag(): BoolUpdateFlag;
+    protected _onDestroy(): void;
     /**
      * Get worldMatrix: Will trigger the worldMatrix update of itself and all parent entities.
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.

package/types/asset/LoadItem.d.ts

@@ -1,15 +1,12 @@
+type PickOnlyOne<T extends {}, Keys extends keyof T = keyof T> = Keys extends unknown ? {
+    [K in Keys]: T[Keys];
+} & {
+    [K in Exclude<keyof T, Keys>]?: never;
+} : never;
 /**
  * Used to describe loading asset.
  */
 export type LoadItem = {
-    /**
-     * Loading url.
-     */
-    url?: string;
-    /**
-     * Available when AssetType is TextureCube.
-     */
-    urls?: string[];
     /**
      * Asset Type.
      */
@@ -30,4 +27,14 @@ export type LoadItem = {
      * Additional parameters for specified loader.
      */
     params?: Record<string, any>;
-};
+} & PickOnlyOne<{
+    /**
+     * Loading url.
+     */
+    url: string;
+    /**
+     * Available when AssetType is TextureCube.
+     */
+    urls: string[];
+}>;
+export {};

package/types/enums/ActiveChangeFlag.d.ts

@@ -0,0 +1,6 @@
+export declare enum ActiveChangeFlag {
+    None = 0,
+    Scene = 1,
+    Hierarchy = 2,
+    All = 3
+}

package/types/enums/DepthTextureMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Depth texture mode.
+ */
+export declare enum DepthTextureMode {
+    None = 0,
+    PrePass = 1
+}

package/types/index.d.ts

@@ -22,7 +22,7 @@ export { AssetPromise } from "./asset/AssetPromise";
 export type { LoadItem } from "./asset/LoadItem";
 export { AssetType } from "./asset/AssetType";
 export { ReferResource } from "./asset/ReferResource";
-export * from "./RenderPipeline/Index";
+export * from "./RenderPipeline/index";
 export * from "./base";
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";

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

@@ -0,0 +1,75 @@
+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 _colliders;
+    private _gravity;
+    private _nativePhysicsScene;
+    private _onContactEnter;
+    private _onContactExit;
+    private _onContactStay;
+    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);
+    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/shader/enums/RenderStateElementKey.d.ts

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

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>;
+}