@galacean/engine-core 0.0.0-experimental-shaderlab.2 → 0.0.0-experimental-1.2-xr.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "0.0.0-experimental-shaderlab.2",
+  "version": "0.0.0-experimental-1.2-xr.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "0.0.0-experimental-shaderlab.2"
+    "@galacean/engine-math": "0.0.0-experimental-1.2-xr.0"
   },
   "devDependencies": {
-    "@galacean/engine-design": "0.0.0-experimental-shaderlab.2"
+    "@galacean/engine-design": "0.0.0-experimental-1.2-xr.0"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/assembler/ISpriteAssembler.d.ts

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

package/types/2d/text/CharRenderInfo.d.ts

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

package/types/DisorderedArray.d.ts

@@ -18,10 +18,10 @@ export declare class DisorderedArray<T> {
      */
     deleteByIndex(index: number): T;
     forEach(callbackFn: (element: T) => void, swapFn: (element: T, index: number) => void): void;
-    forEachAndClean(callbackFn: (e: T) => void): void;
+    forEachAndClean(callbackFn: (e: T) => void, swapFn: (element: T, index: number) => void): void;
     sort(compareFn: (a: T, b: T) => number): void;
     garbageCollection(): void;
     private _startLoop;
     private _endLoop;
-    private _endLoopAndClear;
+    private _endLoopAndClean;
 }

package/types/Entity.d.ts

@@ -58,9 +58,10 @@ export declare class Entity extends EngineObject {
     /**
      * Add component based on the component type.
      * @param type - The type of the component
+     * @param args - The arguments of the component
      * @returns	The component which has been added
      */
-    addComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    addComponent<T extends new (entity: Entity, ...args: any[]) => Component>(type: T, ...args: ComponentArguments<T>): InstanceType<T>;
     /**
      * Get component which match the type.
      * @param type - The type of the component
@@ -127,7 +128,7 @@ export declare class Entity extends EngineObject {
      */
     clearChildren(): void;
     /**
-     * Clone.
+     * Clone this entity include children and components.
      * @returns Cloned entity
      */
     clone(): Entity;
@@ -152,3 +153,5 @@ export declare class Entity extends EngineObject {
      */
     getInvModelMatrix(): Matrix;
 }
+type ComponentArguments<T extends new (entity: Entity, ...args: any[]) => Component> = T extends new (entity: Entity, ...args: infer P) => Component ? P : never;
+export {};

package/types/RenderPipeline/BatchUtils.d.ts

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

package/types/RenderPipeline/BatcherManager.d.ts

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

package/types/RenderPipeline/DynamicGeometryData.d.ts

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

package/types/RenderPipeline/DynamicGeometryDataManager.d.ts

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

package/types/RenderPipeline/MaskManager.d.ts

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

package/types/RenderPipeline/PrimitiveChunk.d.ts

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

package/types/RenderPipeline/PrimitiveChunkManager.d.ts

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

package/types/RenderPipeline/RenderData2D.d.ts

@@ -0,0 +1,14 @@
+import { Primitive, SubMesh } from "../graphic";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "../utils/Pool";
+import { Chunk } from "./DynamicGeometryData";
+import { RenderData } from "./RenderData";
+export declare class RenderData2D extends RenderData implements IPoolElement {
+    texture: Texture2D;
+    chunk: Chunk;
+    constructor();
+    set(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh, texture?: Texture2D, chunk?: Chunk): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SubPrimitiveChunk.d.ts

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

package/types/RenderPipeline/SubRenderElement.d.ts

@@ -0,0 +1,22 @@
+import { Renderer } from "../Renderer";
+import { Primitive, SubMesh } from "../graphic";
+import { Material } from "../material";
+import { ShaderData, ShaderPass } from "../shader";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "../utils/ObjectPool";
+import { RenderQueueFlags } from "./BasicRenderPipeline";
+import { SubPrimitiveChunk } from "./SubPrimitiveChunk";
+export declare class SubRenderElement implements IPoolElement {
+    component: Renderer;
+    primitive: Primitive;
+    material: Material;
+    subPrimitive: SubMesh;
+    shaderPasses: ReadonlyArray<ShaderPass>;
+    shaderData?: ShaderData;
+    batched: boolean;
+    renderQueueFlags: RenderQueueFlags;
+    texture?: Texture2D;
+    subChunk?: SubPrimitiveChunk;
+    set(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh, texture?: Texture2D, subChunk?: SubPrimitiveChunk): void;
+    dispose(): void;
+}

package/types/RenderPipeline/VertexArea.d.ts

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

package/types/RenderPipeline/enums/ForceUploadShaderDataFlag.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Force upload shader data flag.
+ */
+export declare enum ForceUploadShaderDataFlag {
+    /** Upload nothing. */
+    None = 0,
+    /** Upload scene shader data. */
+    Scene = 1,
+    /** Upload camera shader data. */
+    Camera = 2,
+    /** Upload renderer shader data. */
+    Renderer = 4,
+    /** Upload material shader data. */
+    Material = 8
+}

package/types/RenderPipeline/enums/RenderDataUsage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * RenderData usage.
+ */
+export declare enum RenderDataUsage {
+    /** Usage for mesh. */
+    Mesh = 0,
+    /** Usage for sprite. */
+    Sprite = 1,
+    /** Usage for sprite mask. */
+    SpriteMask = 2,
+    /** Usage for text. */
+    Text = 3
+}

package/types/animation/AnimatorCondition.d.ts

@@ -0,0 +1,13 @@
+import { AnimatorControllerParameterValueType } from "./AnimatorControllerParameter";
+import { AnimatorConditionMode } from "./enums/AnimatorConditionMode";
+/**
+ * Condition that is used to determine if a transition must be taken.
+ */
+export declare class AnimatorCondition {
+    /** The mode of the condition. */
+    mode: AnimatorConditionMode;
+    /** The name of the parameter used in the condition. */
+    parameterName: string;
+    /** The AnimatorParameter's threshold value for the condition to be true. */
+    threshold?: AnimatorControllerParameterValueType;
+}

package/types/animation/AnimatorControllerParameter.d.ts

@@ -0,0 +1,10 @@
+export type AnimatorControllerParameterValueType = number | string | boolean;
+/**
+ * Used to communicate between scripting and the controller, parameters can be set in scripting and used by the controller.
+ */
+export declare class AnimatorControllerParameter {
+    /** The name of the parameter. */
+    name: string;
+    /** The value of the parameter. */
+    value: AnimatorControllerParameterValueType;
+}

package/types/animation/AnimatorStateTransition.d.ts

@@ -0,0 +1,51 @@
+import { AnimatorControllerParameterValueType } from "./AnimatorControllerParameter";
+import { AnimatorConditionMode } from "./enums/AnimatorConditionMode";
+import { AnimatorCondition } from "./AnimatorCondition";
+import { AnimatorState } from "./AnimatorState";
+/**
+ * Transitions define when and how the state machine switch from on state to another. AnimatorTransition always originate from a StateMachine or a StateMachine entry.
+ */
+export declare class AnimatorStateTransition {
+    /** The duration of the transition. This is represented in normalized time. */
+    duration: number;
+    /** The time at which the destination state will start. This is represented in normalized time. */
+    offset: number;
+    /** ExitTime represents the exact time at which the transition can take effect. This is represented in normalized time. */
+    exitTime: number;
+    /** The destination state of the transition. */
+    destinationState: AnimatorState;
+    /** Mutes the transition. The transition will never occur. */
+    mute: boolean;
+    private _conditions;
+    private _solo;
+    /**
+     * Is the transition destination the exit of the current state machine.
+     */
+    get isExit(): Readonly<boolean>;
+    /**
+     * Mutes all other transitions in the source state.
+     */
+    get solo(): boolean;
+    set solo(value: boolean);
+    /**
+     * The conditions in the transition.
+     */
+    get conditions(): Readonly<AnimatorCondition[]>;
+    /**
+     * Add a condition to a transition.
+     * @param mode - The AnimatorCondition mode of the condition
+     * @param parameterName - The name of the parameter
+     * @param threshold - The threshold value of the condition
+     */
+    addCondition(mode: AnimatorConditionMode, parameterName: string, threshold?: AnimatorControllerParameterValueType): AnimatorCondition;
+    /**
+     * Add a condition to a transition.
+     * @param animatorCondition - The condition to add
+     */
+    addCondition(animatorCondition: AnimatorCondition): AnimatorCondition;
+    /**
+     * Remove a condition from the transition.
+     * @param condition - The condition to remove
+     */
+    removeCondition(condition: AnimatorCondition): void;
+}

package/types/asset/AssetType.d.ts

@@ -23,10 +23,6 @@ export declare enum AssetType {
     TextureCube = "TextureCube",
     /** Material. */
     Material = "Material",
-    /** Shader */
-    Shader = "Shader",
-    /** Shader Chunk */
-    ShaderChunk = "ShaderChunk",
     /** Mesh. */
     Mesh = "Mesh",
     /** AnimationClip. */

package/types/asset/ResourceManager.d.ts

@@ -102,11 +102,13 @@ export declare class ResourceManager {
     addContentRestorer<T extends EngineObject>(restorer: ContentRestorer<T>): void;
     private _assignDefaultOptions;
     private _loadSingleItem;
-    private _pushSubAssetPromiseCallback;
+    private _loadMainAsset;
+    private _createSubAssetPromiseCallback;
     private _gc;
     private _getResolveResource;
     private _parseURL;
     private _parseQueryPath;
+    private _releaseSubAssetPromiseCallback;
 }
 /**
  * Declare ResourceLoader's decorator.

package/types/clone/ComponentCloner.d.ts

@@ -13,5 +13,5 @@ export declare class ComponentCloner {
      * @param source - Clone source
      * @param target - Clone target
      */
-    static cloneComponent(source: Component, target: Component, srcRoot: Entity, targetRoot: Entity): void;
+    static cloneComponent(source: Component, target: Component, srcRoot: Entity, targetRoot: Entity, deepInstanceMap: Map<Object, Object>): void;
 }

package/types/input/pointer/PointerEvent.d.ts

@@ -0,0 +1,4 @@
+import { Pointer } from "./Pointer";
+export declare class PointerEvent {
+    pointer: Pointer;
+}

package/types/input/pointer/PointerEventType.d.ts

@@ -0,0 +1,7 @@
+export declare enum PointerEventType {
+    Down = 0,
+    Up = 1,
+    Click = 2,
+    Enter = 3,
+    Exit = 4
+}

package/types/mesh/Skin.d.ts

@@ -1,19 +1,35 @@
 import { Matrix } from "@galacean/engine-math";
-import { EngineObject } from "../base/EngineObject";
 import { Entity } from "../Entity";
+import { EngineObject } from "../base/EngineObject";
+import { IComponentCustomClone } from "../clone/ComponentCloner";
 /**
- * Mesh skin data, equal glTF skins define
+ * Skin used for skinned mesh renderer.
  */
-export declare class Skin extends EngineObject {
+export declare class Skin extends EngineObject implements IComponentCustomClone {
     name: string;
+    /** Inverse bind matrices. */
     inverseBindMatrices: Matrix[];
-    joints: string[];
-    skeleton: string;
-    _rootBone: Entity;
-    _bones: Entity[];
+    private _rootBone;
+    private _bones;
+    private _updateMark;
     /**
-     * Constructor of skin
-     * @param name - name
+     * Root bone.
      */
+    get rootBone(): Entity;
+    set rootBone(value: Entity);
+    /**
+     * Bones of the skin.
+     */
+    get bones(): ReadonlyArray<Entity>;
+    set bones(value: ReadonlyArray<Entity>);
     constructor(name: string);
+    /** @deprecated Please use `bones` instead. */
+    joints: string[];
+    /** @deprecated Please use `rootBone` instead. */
+    get skeleton(): string;
+    set skeleton(value: string);
+}
+export declare enum SkinUpdateFlag {
+    BoneCountChanged = 0,
+    RootBoneChanged = 1
 }

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -14,10 +14,13 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
     private _jointDataCreateCache;
     private _blendShapeWeights;
     private _maxVertexUniformVectors;
-    private _rootBone;
-    private _jointMatrices;
     private _jointTexture;
-    private _bones;
+    private _skin;
+    /**
+     * Skin of the SkinnedMeshRenderer.
+     */
+    get skin(): Skin;
+    set skin(value: Skin);
     /**
      * The weights of the BlendShapes.
      * @remarks Array index is BlendShape index.
@@ -29,31 +32,19 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get localBounds(): BoundingBox;
     set localBounds(value: BoundingBox);
+    _updateShaderData(context: RenderContext, onlyMVP: boolean): void;
+    private _checkBlendShapeWeightLength;
+    private _onLocalBoundsChanged;
+    private _onSkinUpdated;
+    private _applySkin;
     /**
-     * Root bone.
+     * @deprecated use {@link SkinnedMeshRenderer.skin.rootBone} instead.
      */
     get rootBone(): Entity;
     set rootBone(value: Entity);
     /**
-     * Bones of the SkinnedMeshRenderer.
+     * @deprecated use {@link SkinnedMeshRenderer.skin.bones} instead.
      */
-    get bones(): ReadonlyArray<Entity>;
-    set bones(value: ReadonlyArray<Entity>);
-    _updateShaderData(context: RenderContext, onlyMVP: boolean): void;
-    private _checkBlendShapeWeightLength;
-    private _onLocalBoundsChanged;
-    private _getEntityHierarchyPath;
-    private _skin;
-    /**
-     * @deprecated
-     * Skin Object.
-     *
-     * If you want get `skeleton`, use {@link SkinnedMeshRenderer.rootBone} instead.
-     * If you want get `bones`, use {@link SkinnedMeshRenderer.bones} instead.
-     * `inverseBindMatrices` will migrate to mesh in the future.
-     *
-     * @remarks `rootBone` and `bones` will not update when `skin` changed.
-     */
-    get skin(): Skin;
-    set skin(value: Skin);
+    get bones(): Readonly<Entity[]>;
+    set bones(value: Readonly<Entity[]>);
 }

package/types/ui/Image.d.ts

@@ -0,0 +1,38 @@
+import { Color } from "@galacean/engine-math";
+import { Sprite, SpriteDrawMode, SpriteTileMode } from "../2d";
+import { UIRenderer } from "./UIRenderer";
+export declare class Image extends UIRenderer {
+    private _color;
+    private _sprite;
+    private _drawMode;
+    private _assembler;
+    private _tileMode;
+    private _tiledAdaptiveThreshold;
+    /**
+     * The draw mode of the sprite renderer.
+     */
+    get drawMode(): SpriteDrawMode;
+    set drawMode(value: SpriteDrawMode);
+    /**
+     * The tiling mode of the sprite renderer. (Only works in tiled mode.)
+     */
+    get tileMode(): SpriteTileMode;
+    set tileMode(value: SpriteTileMode);
+    /**
+     * Stretch Threshold in Tile Adaptive Mode, specified in normalized. (Only works in tiled adaptive mode.)
+     */
+    get tiledAdaptiveThreshold(): number;
+    set tiledAdaptiveThreshold(value: number);
+    /**
+     * The Sprite to render.
+     */
+    get sprite(): Sprite;
+    set sprite(value: Sprite | null);
+    /**
+     * Rendering color for the Sprite graphic.
+     */
+    get color(): Color;
+    set color(value: Color);
+    protected _onDestroy(): void;
+    private _onSpriteChange;
+}

package/types/ui/RedBlackTree.d.ts

@@ -0,0 +1,2 @@
+export declare class RedBlackTree {
+}

package/types/ui/UICanvas.d.ts

@@ -0,0 +1,55 @@
+import { Vector2 } from "@galacean/engine-math";
+import { Camera } from "../Camera";
+import { Component } from "../Component";
+import { Entity } from "../Entity";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { CanvasRenderMode } from "./enums/CanvasRenderMode";
+import { ResolutionAdaptationStrategy } from "./enums/ResolutionAdaptationStrategy";
+export declare class UICanvas extends Component {
+    private _renderMode;
+    private _renderCamera;
+    private _resolutionAdaptationStrategy;
+    private _sortOrder;
+    private _distance;
+    private _renderers;
+    private _transform;
+    private _uiTransform;
+    private _referenceResolution;
+    private _isRootCanvas;
+    private _enableBlocked;
+    private _parents;
+    private _hierarchyDirty;
+    get enableBlocked(): boolean;
+    set enableBlocked(value: boolean);
+    get referenceResolution(): Vector2;
+    set referenceResolution(val: Vector2);
+    get renderMode(): CanvasRenderMode;
+    set renderMode(mode: CanvasRenderMode);
+    get renderCamera(): Camera;
+    set renderCamera(val: Camera);
+    get resolutionAdaptationStrategy(): ResolutionAdaptationStrategy;
+    set resolutionAdaptationStrategy(val: ResolutionAdaptationStrategy);
+    get sortOrder(): number;
+    set sortOrder(val: number);
+    get distance(): number;
+    set distance(val: number);
+    constructor(entity: Entity);
+    _prepareRender(context: RenderContext): void;
+    private _adapterPoseInScreenSpace;
+    private _adapterSizeInScreenSpace;
+    private _walk;
+    private _addCameraListener;
+    private _removeCameraListener;
+    private _onCameraPropertyListener;
+    private _onCameraTransformListener;
+    private _addCanvasListener;
+    private _removeCanvasListener;
+    private _onCanvasSizeListener;
+    private _addParentListener;
+    private _removeParentListener;
+    private _onEntityListener;
+    private _onParentListener;
+    private _onReferenceResolutionChanged;
+    private _checkIsRootCanvas;
+    private _setIsRootCanvas;
+}

package/types/ui/UIRenderer.d.ts

@@ -0,0 +1,14 @@
+import { BoundingBox, Vector4 } from "@galacean/engine-math";
+import { Renderer } from "../Renderer";
+import { UITransform, UITransformModifyFlags } from "./UITransform";
+export declare class UIRenderer extends Renderer {
+    protected _uiTransform: UITransform;
+    protected _localBounds: BoundingBox;
+    protected _rayCastTarget: boolean;
+    protected _rayCastPadding: Vector4;
+    get rayCastTarget(): boolean;
+    set rayCastTarget(value: boolean);
+    get rayCastPadding(): Vector4;
+    set rayCastPadding(value: Vector4);
+    protected _onUITransformChanged(flag: UITransformModifyFlags): void;
+}

package/types/ui/UITransform.d.ts

@@ -0,0 +1,20 @@
+import { Vector2 } from "@galacean/engine-math";
+import { Component } from "../Component";
+import { Entity } from "../Entity";
+export declare class UITransform extends Component {
+    private _rect;
+    private _pivot;
+    get rect(): Vector2;
+    set rect(val: Vector2);
+    get pivot(): Vector2;
+    set pivot(val: Vector2);
+    constructor(entity: Entity);
+    private _onRectChange;
+    private _onPivotChange;
+}
+export declare enum UITransformModifyFlags {
+    /** Rect. */
+    Rect = 1,
+    /** Pivot. */
+    Pivot = 2
+}

package/types/ui/enums/BlockingObjects.d.ts

@@ -0,0 +1,6 @@
+export declare enum BlockingObjects {
+    None = 0,
+    TwoDimensional = 1,
+    ThreeDimensional = 2,
+    All = 3
+}

package/types/ui/enums/CanvasRenderMode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Render mode for ui canvas.
+ */
+export declare enum CanvasRenderMode {
+    ScreenSpaceOverlay = 0,
+    ScreenSpaceCamera = 1,
+    WorldSpace = 2
+}

package/types/ui/enums/ResolutionAdaptationStrategy.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Resolution adaptation strategy.
+ */
+export declare enum ResolutionAdaptationStrategy {
+    WidthAdaptation = 0,
+    HeightAdaptation = 1,
+    BothAdaptation = 2,
+    ExpandAdaptation = 3,
+    ShrinkAdaptation = 4
+}

package/types/ui/index.d.ts

@@ -0,0 +1,6 @@
+export { CanvasRenderMode } from "./enums/CanvasRenderMode";
+export { ResolutionAdaptationStrategy } from "./enums/ResolutionAdaptationStrategy";
+export { UICanvas } from "./UICanvas";
+export { UIRenderer } from "./UIRenderer";
+export { Image } from "./Image";
+export { UITransform } from "./UITransform";

package/types/utils/ClearableObjectPool.d.ts

@@ -0,0 +1,10 @@
+import { IPoolElement, ObjectPool } from "./ObjectPool";
+/**
+ * Clearable Object Pool.
+ */
+export declare class ClearableObjectPool<T extends IPoolElement> extends ObjectPool<T> {
+    private _usedElementCount;
+    constructor(type: new () => T);
+    get(): T;
+    clear(): void;
+}

package/types/utils/ObjectPool.d.ts

@@ -0,0 +1,10 @@
+export declare abstract class ObjectPool<T extends IPoolElement> {
+    protected _type: new () => T;
+    protected _elements: T[];
+    constructor(type: new () => T);
+    garbageCollection(): void;
+    abstract get(): T;
+}
+export interface IPoolElement {
+    dispose?(): void;
+}

package/types/utils/Pool.d.ts

@@ -0,0 +1,12 @@
+export interface IPoolElement {
+    dispose?(): void;
+}
+export declare class Pool<T extends IPoolElement> {
+    private _type;
+    private _elementPool;
+    private _elementPoolIndex;
+    constructor(type: new () => T, count?: number);
+    alloc(): T;
+    free(element: T): void;
+    dispose(): void;
+}

package/types/utils/ReturnableObjectPool.d.ts

@@ -0,0 +1,10 @@
+import { IPoolElement, ObjectPool } from "./ObjectPool";
+/**
+ * Returnable Object Pool.
+ */
+export declare class ReturnableObjectPool<T extends IPoolElement> extends ObjectPool<T> {
+    private _lastElementIndex;
+    constructor(type: new () => T, initializeCount?: number);
+    get(): T;
+    return(element: T): void;
+}

package/types/RenderPipeline/MeshRenderData.d.ts

@@ -1,17 +0,0 @@
-import { Mesh } from "../graphic/Mesh";
-import { SubMesh } from "../graphic/SubMesh";
-import { Material } from "../material/Material";
-import { Renderer } from "../Renderer";
-import { IPoolElement } from "./IPoolElement";
-import { RenderData } from "./RenderData";
-/**
- * Render element.
- */
-export declare class MeshRenderData extends RenderData implements IPoolElement {
-    /** Mesh. */
-    mesh: Mesh;
-    /** Sub mesh. */
-    subMesh: SubMesh;
-    set(component: Renderer, material: Material, mesh: Mesh, subMesh: SubMesh): void;
-    dispose(): void;
-}