@galacean/engine-core 1.6.7 → 1.6.8

package/types/Renderer.d.ts

@@ -1,135 +0,0 @@
-import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
-import { Component } from "./Component";
-import { Entity } from "./Entity";
-import { RenderContext } from "./RenderPipeline/RenderContext";
-import { TransformModifyFlags } from "./Transform";
-import { IComponentCustomClone } from "./clone/ComponentCloner";
-import { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
-import { Material } from "./material";
-import { ShaderData } from "./shader/ShaderData";
-/**
- * Basis for all renderers.
- * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
- */
-export declare class Renderer extends Component implements IComponentCustomClone {
-    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;
-    _renderFrameCount: number;
-    _maskLayer: SpriteMaskLayer;
-    protected _overrideUpdate: boolean;
-    protected _materials: Material[];
-    protected _dirtyUpdateFlag: number;
-    protected _rendererLayer: Vector4;
-    protected _bounds: BoundingBox;
-    protected _transformEntity: Entity;
-    private _shaderData;
-    private _mvMatrix;
-    private _mvpMatrix;
-    private _mvInvMatrix;
-    private _normalMatrix;
-    private _materialsInstanced;
-    private _priority;
-    private _receiveShadows;
-    /**
-     * ShaderData related to renderer.
-     */
-    get shaderData(): ShaderData;
-    /**
-     * 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 world 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;
-    /**
-     * Update once per frame per renderer, not influenced by batched.
-     */
-    protected _update(context: RenderContext): void;
-    protected _updateWorldViewRelatedShaderData(context: RenderContext, worldMatrix: Matrix, batched: boolean): void;
-    protected _updateProjectionRelatedShaderData(context: RenderContext, worldMatrix: Matrix, batched: boolean): void;
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    protected _render(context: RenderContext): void;
-    private _createInstanceMaterial;
-    private _setMaterial;
-    protected _onTransformChanged(type: TransformModifyFlags): void;
-}
-export declare enum RendererUpdateFlags {
-    /** Include world position and world bounds. */
-    WorldVolume = 1
-}

package/types/Scene.d.ts

@@ -1,183 +0,0 @@
-import { Color, Vector3 } from "@galacean/engine-math";
-import { Background } from "./Background";
-import { Engine } from "./Engine";
-import { Entity } from "./Entity";
-import { EngineObject } from "./base";
-import { FogMode } from "./enums/FogMode";
-import { AmbientOcclusion, DirectLight } from "./lighting";
-import { AmbientLight } from "./lighting/AmbientLight";
-import { PhysicsScene } from "./physics/PhysicsScene";
-import { PostProcessManager } from "./postProcess";
-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;
-    private static _prefilterdDFGProperty;
-    /** Scene name. */
-    name: string;
-    /** Physics. */
-    readonly physics: PhysicsScene;
-    /** 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;
-    /**
-     * Last shadow fade distance in percentage, range [0,1].
-     * @remarks Value 0 is used for no shadow fade.
-     */
-    shadowFadeBorder: number;
-    /** Post process manager. */
-    readonly postProcessManager: PostProcessManager;
-    /**
-     * Ambient Occlusion settings.
-     * @remarks
-     * Darkens areas where objects are close together to simulate natural light blocking,
-     * such as corners, crevices, and contact points between surfaces.
-     */
-    readonly ambientOcclusion: AmbientOcclusion;
-    private _background;
-    private _shaderData;
-    private _shadowCascades;
-    private _ambientLight;
-    private _fogMode;
-    private _fogColor;
-    private _fogStart;
-    private _fogEnd;
-    private _fogDensity;
-    private _fogParams;
-    private _isActive;
-    private _sun;
-    private _enableTransparentShadow;
-    /**
-     * Whether the scene is active.
-     */
-    get isActive(): boolean;
-    set isActive(value: boolean);
-    /**
-     * Scene-related shader data.
-     */
-    get shaderData(): ShaderData;
-    /**
-     * The background of the scene.
-     */
-    get background(): Background;
-    /**
-     *  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[]>;
-    /**
-     * Sun light source.
-     * @remarks If set this to null, scene will use the brightest directional light.
-     */
-    get sun(): DirectLight | null;
-    set sun(light: DirectLight | null);
-    /**
-     * Whether to enable transparent shadow.
-     */
-    get enableTransparentShadow(): boolean;
-    set enableTransparentShadow(value: boolean);
-    /**
-     * 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;
-    private _computeLinearFogParams;
-    private _computeExponentialFogParams;
-    private _getSunlight;
-}

package/types/SceneManager.d.ts

@@ -1,51 +0,0 @@
-import { Engine } from "./Engine";
-import { Scene } from "./Scene";
-import { AssetPromise } from "./asset/AssetPromise";
-/**
- * Scene manager.
- */
-export declare class SceneManager {
-    readonly engine: Engine;
-    /**
-     * Get the scene list.
-     */
-    get scenes(): ReadonlyArray<Scene>;
-    /**
-     * Add scene.
-     * @param scene - The scene which want to be added
-     */
-    addScene(scene: Scene): void;
-    /**
-     * Add scene at specified index.
-     * @param index - specified index
-     * @param child - The scene which want to be added
-     */
-    addScene(index: number, scene: Scene): void;
-    /**
-     * Remove scene.
-     * @param scene - The scene which want to be removed
-     */
-    removeScene(scene: Scene): void;
-    /**
-     * Load and activate scene.
-     * @param url - the path of the scene
-     * @param destroyOldScene - whether to destroy old scene
-     * @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;
-    /**
-     * @deprecated
-     * Please use `scenes` instead.
-     *
-     * Get the first scene.
-     */
-    get activeScene(): Scene;
-    set activeScene(scene: Scene);
-}

package/types/Script.d.ts

@@ -1,144 +0,0 @@
-import { Camera } from "./Camera";
-import { Component } from "./Component";
-import { PointerEventData } from "./input/pointer/PointerEventData";
-import { ColliderShape } from "./physics";
-import { Collision } from "./physics/Collision";
-/**
- * Script class, used for logic writing.
- */
-export declare class Script extends Component {
-    /**
-     * 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 delta time since last frame in seconds
-     */
-    onUpdate(deltaTime: number): void;
-    /**
-     * Called after the onUpdate finished, called frame by frame.
-     * @param deltaTime - The delta time since last frame in seconds
-     */
-    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 trigger enter.
-     * @param other - ColliderShape
-     */
-    onTriggerEnter(other: ColliderShape): void;
-    /**
-     * Called when the trigger exit.
-     * @param other - ColliderShape
-     */
-    onTriggerExit(other: ColliderShape): void;
-    /**
-     * Called when the trigger stay.
-     * @remarks onTriggerStay is called every frame while the trigger stay.
-     * @param other - ColliderShape
-     */
-    onTriggerStay(other: ColliderShape): void;
-    /**
-     * Called when the collision enter.
-     * @param other - The Collision data associated with this collision event
-     * @remarks The Collision data will be invalid after this call, you should copy the data if needed.
-     */
-    onCollisionEnter(other: Collision): void;
-    /**
-     * Called when the collision exit.
-     * @param other - The Collision data associated with this collision event
-     * @remarks The Collision data will be invalid after this call, you should copy the data if needed.
-     */
-    onCollisionExit(other: Collision): void;
-    /**
-     * Called when the collision stay.
-     * @param other - The Collision data associated with this collision event
-     * @remarks The Collision data will be invalid after this call, you should copy the data if needed.
-     */
-    onCollisionStay(other: Collision): void;
-    /**
-     * Called when the pointer is down while over the ColliderShape.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerDown(eventData: PointerEventData): void;
-    /**
-     * Called when the pointer is up while over the ColliderShape.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerUp(eventData: PointerEventData): void;
-    /**
-     * Called when the pointer is down and up with the same collider.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerClick(eventData: PointerEventData): void;
-    /**
-     *  Called when the pointer enters the ColliderShape.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerEnter(eventData: PointerEventData): void;
-    /**
-     * Called when the pointer exits the ColliderShape.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerExit(eventData: PointerEventData): void;
-    /**
-     * This function will be called when the pointer is pressed on the collider.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerBeginDrag(eventData: PointerEventData): void;
-    /**
-     *  When a drag collision occurs on the pointer, this function will be called every time it moves.
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerDrag(eventData: PointerEventData): void;
-    /**
-     *  When dragging ends, this function will be called (Dragged object).
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerEndDrag(eventData: PointerEventData): void;
-    /**
-     *  When dragging ends, this function will be called (Receiving object).
-     * @param eventData - The pointer event data that triggered this callback
-     */
-    onPointerDrop(eventData: PointerEventData): void;
-    /**
-     * Called when be disabled.
-     */
-    onDisable(): void;
-    /**
-     * Called at the end of the destroyed frame.
-     */
-    onDestroy(): void;
-}
-export declare enum PointerMethods {
-    onPointerDown = "onPointerDown",
-    onPointerUp = "onPointerUp",
-    onPointerClick = "onPointerClick",
-    onPointerEnter = "onPointerEnter",
-    onPointerExit = "onPointerExit",
-    onPointerBeginDrag = "onPointerBeginDrag",
-    onPointerDrag = "onPointerDrag",
-    onPointerEndDrag = "onPointerEndDrag",
-    onPointerDrop = "onPointerDrop"
-}

package/types/SystemInfo.d.ts

@@ -1,27 +0,0 @@
-import { Engine } from "./Engine";
-import { Platform } from "./Platform";
-import { TextureFormat } from "./texture";
-import { AssetPromise } from "./asset/AssetPromise";
-/**
- * Access operating system, platform and hardware information.
- */
-export declare class SystemInfo {
-    /** The platform is running on. */
-    static platform: Platform;
-    /** The operating system is running on. */
-    static operatingSystem: string;
-    /** Whether the system support SIMD. */
-    private static _simdSupported;
-    private static _webpSupported;
-    /**
-     * The pixel ratio of the device.
-     */
-    static get devicePixelRatio(): number;
-    static _checkWebpSupported(): AssetPromise<boolean>;
-    /**
-     * Checks whether the system supports the given texture format.
-     * @param format - The texture format
-     * @returns Whether support the texture format
-     */
-    static supportsTextureFormat(engine: Engine, format: TextureFormat): boolean;
-}