@galacean/engine-core 0.0.0-experimental-animator-additive.1

package/types/Renderer.d.ts

@@ -0,0 +1,119 @@
+import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
+import { Component } from "./Component";
+import { RenderContext } from "./RenderPipeline/RenderContext";
+import { TransformModifyFlags } from "./Transform";
+import { Material } from "./material/Material";
+import { ShaderData } from "./shader/ShaderData";
+/**
+ * Basis for all renderers.
+ * @decorator `@dependentComponents(Transform)`
+ */
+export declare class Renderer extends Component {
+    private static _tempVector0;
+    private static _receiveShadowMacro;
+    private static _localMatrixProperty;
+    private static _worldMatrixProperty;
+    private static _mvMatrixProperty;
+    private static _mvpMatrixProperty;
+    private static _mvInvMatrixProperty;
+    private static _normalMatrixProperty;
+    private static _rendererLayerProperty;
+    /** ShaderData related to renderer. */
+    readonly shaderData: ShaderData;
+    _renderFrameCount: number;
+    protected _overrideUpdate: boolean;
+    protected _materials: Material[];
+    protected _dirtyUpdateFlag: number;
+    private _mvMatrix;
+    private _mvpMatrix;
+    private _mvInvMatrix;
+    private _normalMatrix;
+    private _materialsInstanced;
+    private _priority;
+    private _receiveShadows;
+    protected _rendererLayer: Vector4;
+    /**
+     * Whether it is culled in the current frame and does not participate in rendering.
+     */
+    get isCulled(): boolean;
+    /**
+     * Whether receive shadow.
+     */
+    get receiveShadows(): boolean;
+    set receiveShadows(value: boolean);
+    /** Whether cast shadow. */
+    castShadows: boolean;
+    /**
+     * Material count.
+     */
+    get materialCount(): number;
+    set materialCount(value: number);
+    /**
+     * The bounding volume of the renderer.
+     */
+    get bounds(): BoundingBox;
+    /**
+     * The render priority of the renderer, lower values are rendered first and higher values are rendered last.
+     */
+    get priority(): number;
+    set priority(value: number);
+    /**
+     * Get the first instance material.
+     * @returns The first instance material
+     */
+    getInstanceMaterial(): Material | null;
+    /**
+     * Get the first instance material by index.
+     * @remarks Calling this function for the first time after the material is set will create an instance material to ensure that it is unique to the renderer.
+     * @param index - Material index
+     * @returns Instance material
+     */
+    getInstanceMaterial(index: number): Material | null;
+    /**
+     * Get the first material.
+     * @returns The first material
+     */
+    getMaterial(): Material | null;
+    /**
+     * Get the first material by index.
+     * @param index - Material index
+     * @returns Material
+     */
+    getMaterial(index: number): Material | null;
+    /**
+     * Set the first material.
+     * @param material - The first material
+     */
+    setMaterial(material: Material): void;
+    /**
+     * Set material by index.
+     * @param index - Material index
+     * @param material - The material
+     */
+    setMaterial(index: number, material: Material): void;
+    /**
+     * Get all instance materials.
+     * @remarks Calling this function for the first time after the material is set will create an instance material to ensure that it is unique to the renderer.
+     * @returns All instance materials
+     */
+    getInstanceMaterials(): Readonly<Material[]>;
+    /**
+     * Get all materials.
+     * @returns All materials
+     */
+    getMaterials(): Readonly<Material[]>;
+    /**
+     * Set all materials.
+     * @param materials - All materials
+     */
+    setMaterials(materials: Material[]): void;
+    update(deltaTime: number): void;
+    protected _updateShaderData(context: RenderContext): void;
+    protected _updateTransformShaderData(context: RenderContext, worldMatrix: Matrix): void;
+    protected _registerEntityTransformListener(): void;
+    protected _updateBounds(worldBounds: BoundingBox): void;
+    protected _render(context: RenderContext): void;
+    private _createInstanceMaterial;
+    private _setMaterial;
+    protected _onTransformChanged(type: TransformModifyFlags): void;
+}

package/types/Scene.d.ts

@@ -0,0 +1,142 @@
+import { Color, Vector3 } from "@galacean/engine-math";
+import { Background } from "./Background";
+import { EngineObject } from "./base";
+import { Engine } from "./Engine";
+import { Entity } from "./Entity";
+import { FogMode } from "./enums/FogMode";
+import { AmbientLight } from "./lighting/AmbientLight";
+import { ShaderData } from "./shader/ShaderData";
+import { ShadowCascadesMode } from "./shadow/enum/ShadowCascadesMode";
+import { ShadowResolution } from "./shadow/enum/ShadowResolution";
+/**
+ * Scene.
+ */
+export declare class Scene extends EngineObject {
+    private static _fogColorProperty;
+    private static _fogParamsProperty;
+    /** Scene name. */
+    name: string;
+    /** The background of the scene. */
+    readonly background: Background;
+    /** Scene-related shader data. */
+    readonly shaderData: ShaderData;
+    /** If cast shadows. */
+    castShadows: boolean;
+    /** The resolution of the shadow maps. */
+    shadowResolution: ShadowResolution;
+    /** The splits of two cascade distribution. */
+    shadowTwoCascadeSplits: number;
+    /** The splits of four cascade distribution. */
+    shadowFourCascadeSplits: Vector3;
+    /** Max Shadow distance. */
+    shadowDistance: number;
+    private _shadowCascades;
+    private _ambientLight;
+    private _fogMode;
+    private _fogColor;
+    private _fogStart;
+    private _fogEnd;
+    private _fogDensity;
+    private _fogParams;
+    /**
+     *  Number of cascades to use for directional light shadows.
+     */
+    get shadowCascades(): ShadowCascadesMode;
+    set shadowCascades(value: ShadowCascadesMode);
+    /**
+     * Ambient light.
+     */
+    get ambientLight(): AmbientLight;
+    set ambientLight(value: AmbientLight);
+    /**
+     * Fog mode.
+     * @remarks
+     * If set to `FogMode.None`, the fog will be disabled.
+     * If set to `FogMode.Linear`, the fog will be linear and controlled by `fogStart` and `fogEnd`.
+     * If set to `FogMode.Exponential`, the fog will be exponential and controlled by `fogDensity`.
+     * If set to `FogMode.ExponentialSquared`, the fog will be exponential squared and controlled by `fogDensity`.
+     */
+    get fogMode(): FogMode;
+    set fogMode(value: FogMode);
+    /**
+     * Fog color.
+     */
+    get fogColor(): Color;
+    set fogColor(value: Color);
+    /**
+     * Fog start.
+     */
+    get fogStart(): number;
+    set fogStart(value: number);
+    /**
+     * Fog end.
+     */
+    get fogEnd(): number;
+    set fogEnd(value: number);
+    /**
+     * Fog density.
+     */
+    get fogDensity(): number;
+    set fogDensity(value: number);
+    /**
+     * Count of root entities.
+     */
+    get rootEntitiesCount(): number;
+    /**
+     * Root entity collection.
+     */
+    get rootEntities(): Readonly<Entity[]>;
+    /**
+     * Create scene.
+     * @param engine - Engine
+     * @param name - Name
+     */
+    constructor(engine: Engine, name?: string);
+    /**
+     * Create root entity.
+     * @param name - Entity name
+     * @returns Entity
+     */
+    createRootEntity(name?: string): Entity;
+    /**
+     * Append an entity.
+     * @param entity - The root entity to add
+     */
+    addRootEntity(entity: Entity): void;
+    /**
+     * Append an entity.
+     * @param index - specified index
+     * @param entity - The root entity to add
+     */
+    addRootEntity(index: number, entity: Entity): void;
+    /**
+     * Remove an entity.
+     * @param entity - The root entity to remove
+     */
+    removeRootEntity(entity: Entity): void;
+    /**
+     * Get root entity from index.
+     * @param index - Index
+     * @returns Entity
+     */
+    getRootEntity(index?: number): Entity | null;
+    /**
+     * Find entity globally by name.
+     * @param name - Entity name
+     * @returns Entity
+     */
+    findEntityByName(name: string): Entity | null;
+    /**
+     * Find entity globally by name,use ‘/’ symbol as a path separator.
+     * @param path - Entity's path
+     * @returns Entity
+     */
+    findEntityByPath(path: string): Entity | null;
+    /**
+     * Destroy this scene.
+     */
+    destroy(): void;
+    private _addToRootEntityList;
+    private _computeLinearFogParams;
+    private _computeExponentialFogParams;
+}

package/types/SceneManager.d.ts

@@ -0,0 +1,28 @@
+import { AssetPromise } from "./asset/AssetPromise";
+import { Engine } from "./Engine";
+import { Scene } from "./Scene";
+/**
+ * Scene manager.
+ */
+export declare class SceneManager {
+    readonly engine: Engine;
+    /**
+     * Get the activated scene.
+     */
+    get activeScene(): Scene;
+    set activeScene(scene: Scene);
+    /**
+     * Load and activate scene.
+     * @param url - the path of the scene
+     * @param destroyOldScene - whether to destroy old scene information
+     * @returns scene promise
+     */
+    loadScene(url: string, destroyOldScene?: boolean): AssetPromise<Scene>;
+    /**
+     * Merge the source scene into the target scene.
+     * @remarks the global information of destScene will be used after the merge, and the lightingMap information will be merged.
+     * @param sourceScene - source scene
+     * @param destScene - target scene
+     */
+    mergeScenes(sourceScene: Scene, destScene: Scene): void;
+}

package/types/Script.d.ts

@@ -0,0 +1,118 @@
+import { Camera } from "./Camera";
+import { Component } from "./Component";
+import { Pointer } from "./input";
+import { ColliderShape } from "./physics";
+/**
+ * Script class, used for logic writing.
+ */
+export declare class Script extends Component {
+    _entityScriptsIndex: number;
+    _waitHandlingInValid: boolean;
+    /**
+     * Called when be enabled first time, only once.
+     */
+    onAwake(): void;
+    /**
+     * Called when be enabled.
+     */
+    onEnable(): void;
+    /**
+     * Called before the frame-level loop start for the first time, only once.
+     */
+    onStart(): void;
+    /**
+     * The main loop, called frame by frame.
+     * @param deltaTime - The deltaTime when the script update.
+     */
+    onUpdate(deltaTime: number): void;
+    /**
+     * Called after the onUpdate finished, called frame by frame.
+     * @param deltaTime - The deltaTime when the script update.
+     */
+    onLateUpdate(deltaTime: number): void;
+    /**
+     * Called before camera rendering, called per camera.
+     * @param camera - Current camera.
+     */
+    onBeginRender(camera: Camera): void;
+    /**
+     * Called after camera rendering, called per camera.
+     * @param camera - Current camera.
+     */
+    onEndRender(camera: Camera): void;
+    /**
+     * Called before physics calculations, the number of times is related to the physical update frequency.
+     */
+    onPhysicsUpdate(): void;
+    /**
+     * Called when the collision enter.
+     * @param other - ColliderShape
+     */
+    onTriggerEnter(other: ColliderShape): void;
+    /**
+     * Called when the collision stay.
+     * @remarks onTriggerStay is called every frame while the collision stay.
+     * @param other - ColliderShape
+     */
+    onTriggerExit(other: ColliderShape): void;
+    /**
+     * Called when the collision exit.
+     * @param other - ColliderShape
+     */
+    onTriggerStay(other: ColliderShape): void;
+    /**
+     * Called when the collision enter.
+     * @param other - ColliderShape
+     */
+    onCollisionEnter(other: ColliderShape): void;
+    /**
+     * Called when the collision stay.
+     * @remarks onTriggerStay is called every frame while the collision stay.
+     * @param other - ColliderShape
+     */
+    onCollisionExit(other: ColliderShape): void;
+    /**
+     * Called when the collision exit.
+     * @param other - ColliderShape
+     */
+    onCollisionStay(other: ColliderShape): void;
+    /**
+     * Called when the pointer is down while over the ColliderShape.
+     * @param pointer - The pointer that triggered
+     */
+    onPointerDown(pointer: Pointer): void;
+    /**
+     * Called when the pointer is up while over the ColliderShape.
+     * @param pointer - The pointer that triggered
+     */
+    onPointerUp(pointer: Pointer): void;
+    /**
+     * Called when the pointer is down and up with the same collider.
+     * @param pointer - The pointer that triggered
+     */
+    onPointerClick(pointer: Pointer): void;
+    /**
+     * Called when the pointer is enters the ColliderShape.
+     * @param pointer - The pointer that triggered
+     */
+    onPointerEnter(pointer: Pointer): void;
+    /**
+     * Called when the pointer is no longer over the ColliderShape.
+     * @param pointer - The pointer that triggered
+     */
+    onPointerExit(pointer: Pointer): void;
+    /**
+     * Called when the pointer is down while over the ColliderShape and is still holding down.
+     * @param pointer - The pointer that triggered
+     * @remarks onPointerDrag is called every frame while the pointer is down.
+     */
+    onPointerDrag(pointer: Pointer): void;
+    /**
+     * Called when be disabled.
+     */
+    onDisable(): void;
+    /**
+     * Called at the end of the destroyed frame.
+     */
+    onDestroy(): void;
+}

package/types/SystemInfo.d.ts

@@ -0,0 +1,14 @@
+import { Platform } from "./Platform";
+/**
+ * System info.
+ */
+export declare class SystemInfo {
+    /** The platform is running on. */
+    static platform: Platform;
+    /** The operating system is running on. */
+    static operatingSystem: string;
+    /**
+     * The pixel ratio of the device.
+     */
+    static get devicePixelRatio(): number;
+}

package/types/Transform.d.ts

@@ -0,0 +1,258 @@
+import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
+import { BoolUpdateFlag } from "./BoolUpdateFlag";
+import { Component } from "./Component";
+/**
+ * Used to implement transformation related functions.
+ */
+export declare class Transform extends Component {
+    private static _tempQuat0;
+    private static _tempVec30;
+    private static _tempVec31;
+    private static _tempVec32;
+    private static _tempMat30;
+    private static _tempMat31;
+    private static _tempMat32;
+    private static _tempMat41;
+    private static _tempMat42;
+    private _position;
+    private _rotation;
+    private _rotationQuaternion;
+    private _scale;
+    private _worldPosition;
+    private _worldRotation;
+    private _worldRotationQuaternion;
+    private _lossyWorldScale;
+    private _localMatrix;
+    private _worldMatrix;
+    private _isParentDirty;
+    private _parentTransformCache;
+    private _dirtyFlag;
+    /**
+     * Local position.
+     */
+    get position(): Vector3;
+    set position(value: Vector3);
+    /**
+     * World position.
+     */
+    get worldPosition(): Vector3;
+    set worldPosition(value: Vector3);
+    /**
+     * Local rotation, defining the rotation value in degrees.
+     * Rotations are performed around the Y axis, the X axis, and the Z axis, in that order.
+     */
+    get rotation(): Vector3;
+    set rotation(value: Vector3);
+    /**
+     * World rotation, defining the rotation value in degrees.
+     * Rotations are performed around the Y axis, the X axis, and the Z axis, in that order.
+     */
+    get worldRotation(): Vector3;
+    set worldRotation(value: Vector3);
+    /**
+     * Local rotation, defining the rotation by using a unit quaternion.
+     */
+    get rotationQuaternion(): Quaternion;
+    set rotationQuaternion(value: Quaternion);
+    /**
+     * World rotation, defining the rotation by using a unit quaternion.
+     */
+    get worldRotationQuaternion(): Quaternion;
+    set worldRotationQuaternion(value: Quaternion);
+    /**
+     * Local scaling.
+     */
+    get scale(): Vector3;
+    set scale(value: Vector3);
+    /**
+     * Local lossy scaling.
+     * @remarks The value obtained may not be correct under certain conditions(for example, the parent node has scaling,
+     * and the child node has a rotation), the scaling will be tilted. Vector3 cannot be used to correctly represent the scaling. Must use Matrix3x3.
+     */
+    get lossyWorldScale(): Vector3;
+    /**
+     * Local matrix.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get localMatrix(): Matrix;
+    set localMatrix(value: Matrix);
+    /**
+     * World matrix.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get worldMatrix(): Matrix;
+    set worldMatrix(value: Matrix);
+    /**
+     * Set local position by X, Y, Z value.
+     * @param x - X coordinate
+     * @param y - Y coordinate
+     * @param z - Z coordinate
+     */
+    setPosition(x: number, y: number, z: number): void;
+    /**
+     * Set local rotation by the X, Y, Z components of the euler angle, unit in degrees.
+     * Rotations are performed around the Y axis, the X axis, and the Z axis, in that order.
+     * @param x - The angle of rotation around the X axis
+     * @param y - The angle of rotation around the Y axis
+     * @param z - The angle of rotation around the Z axis
+     */
+    setRotation(x: number, y: number, z: number): void;
+    /**
+     * Set local rotation by the X, Y, Z, and W components of the quaternion.
+     * @param x - X component of quaternion
+     * @param y - Y component of quaternion
+     * @param z - Z component of quaternion
+     * @param w - W component of quaternion
+     */
+    setRotationQuaternion(x: number, y: number, z: number, w: number): void;
+    /**
+     * Set local scaling by scaling values along X, Y, Z axis.
+     * @param x - Scaling along X axis
+     * @param y - Scaling along Y axis
+     * @param z - Scaling along Z axis
+     */
+    setScale(x: number, y: number, z: number): void;
+    /**
+     * Set world position by X, Y, Z value.
+     * @param x - X coordinate
+     * @param y - Y coordinate
+     * @param z - Z coordinate
+     */
+    setWorldPosition(x: number, y: number, z: number): void;
+    /**
+     * Set world rotation by the X, Y, Z components of the euler angle, unit in degrees, Yaw/Pitch/Roll sequence.
+     * @param x - The angle of rotation around the X axis
+     * @param y - The angle of rotation around the Y axis
+     * @param z - The angle of rotation around the Z axis
+     */
+    setWorldRotation(x: number, y: number, z: number): void;
+    /**
+     * Set local rotation by the X, Y, Z, and W components of the quaternion.
+     * @param x - X component of quaternion
+     * @param y - Y component of quaternion
+     * @param z - Z component of quaternion
+     * @param w - W component of quaternion
+     */
+    setWorldRotationQuaternion(x: number, y: number, z: number, w: number): void;
+    /**
+     * Get the forward direction in world space.
+     * @param forward - Forward vector
+     * @returns Forward vector
+     */
+    getWorldForward(forward: Vector3): Vector3;
+    /**
+     * Get the right direction in world space.
+     * @param right - Right vector
+     * @returns Right vector
+     */
+    getWorldRight(right: Vector3): Vector3;
+    /**
+     * Get the up direction in world space.
+     * @param up - Up vector
+     * @returns Up vector
+     */
+    getWorldUp(up: Vector3): Vector3;
+    /**
+     * Translate in the direction and distance of the translation.
+     * @param translation - Direction and distance of translation
+     * @param relativeToLocal = `true` - Is relative to the local coordinate system
+     */
+    translate(translation: Vector3, relativeToLocal?: boolean): void;
+    /**
+     * Translate some distance by x along the x axis, y along the y axis, and z along the z axis.
+     * @param x - Distance along the x axis
+     * @param y - Distance along the y axis
+     * @param z - Distance along the z axis
+     * @param relativeToLocal = `true` - Is relative to the local coordinate system
+     */
+    translate(x: number, y: number, z: number, relativeToLocal?: boolean): void;
+    /**
+     * Rotate around the passed Vector3.
+     * @param rotation - Euler angle in degrees
+     * @param relativeToLocal = `true` - Is relative to the local coordinate system
+     */
+    rotate(rotation: Vector3, relativeToLocal?: boolean): void;
+    /**
+     * Rotate around the passed Vector3.
+     * @param x - Rotation along x axis, in degrees
+     * @param y - Rotation along y axis, in degrees
+     * @param z - Rotation along z axis, in degrees
+     * @param relativeToLocal = `true` - Is relative to the local coordinate system
+     */
+    rotate(x: number, y: number, z: number, relativeToLocal?: boolean): void;
+    /**
+     * Rotate around the specified axis according to the specified angle.
+     * @param axis - Rotate axis
+     * @param angle - Rotate angle in degrees
+     * @param relativeToLocal = `true` - Relative to local space
+     */
+    rotateByAxis(axis: Vector3, angle: number, relativeToLocal?: boolean): void;
+    /**
+     * Rotate and ensure that the world front vector points to the target world position.
+     * @param targetPosition - Target world position
+     * @param worldUp - Up direction in world space, default is Vector3(0, 1, 0)
+     */
+    lookAt(targetPosition: Vector3, worldUp?: Vector3): void;
+    /**
+     * Register world transform change flag.
+     * @returns Change flag
+     */
+    registerWorldChangeFlag(): BoolUpdateFlag;
+    /**
+     * 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.
+     * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix or worldRotationQuaternion) to be false.
+     */
+    private _updateWorldPositionFlag;
+    /**
+     * 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.
+     * Get worldRotationQuaternion: Will trigger the world rotation (in quaternion) update of itself and all parent entities.
+     * Get worldRotation: Will trigger the world rotation(in euler and quaternion) update of itself and world rotation(in quaternion) update of all parent entities.
+     * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix or worldRotationQuaternion) to be false.
+     */
+    private _updateWorldRotationFlag;
+    /**
+     * 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.
+     * Get worldRotationQuaternion: Will trigger the world rotation (in quaternion) update of itself and all parent entities.
+     * Get worldRotation: Will trigger the world rotation(in euler and quaternion) update of itself and world rotation(in quaternion) update of all parent entities.
+     * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix or worldRotationQuaternion) to be false.
+     */
+    private _updateWorldPositionAndRotationFlag;
+    /**
+     * 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.
+     * Get worldScale: Will trigger the scaling update of itself and all parent entities.
+     * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix) to be false.
+     */
+    private _updateWorldScaleFlag;
+    /**
+     * 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.
+     * Get worldScale: Will trigger the scaling update of itself and all parent entities.
+     * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix) to be false.
+     */
+    private _updateWorldPositionAndScaleFlag;
+    /**
+     * Update all world transform property dirty flag, the principle is the same as above.
+     */
+    private _updateAllWorldFlag;
+    private _getParentTransform;
+    private _getScaleMatrix;
+    private _isContainDirtyFlags;
+    private _isContainDirtyFlag;
+    private _setDirtyFlagTrue;
+    private _setDirtyFlagFalse;
+    private _worldAssociatedChange;
+    private _rotateByQuat;
+    private _translate;
+    private _rotateXYZ;
+    private _onPositionChanged;
+    private _onWorldPositionChanged;
+    private _onRotationChanged;
+    private _onWorldRotationChanged;
+    private _onRotationQuaternionChanged;
+    private _onWorldRotationQuaternionChanged;
+    private _onScaleChanged;
+}