@galacean/engine-core 0.0.0-experimental-stateMachine.0 → 0.0.0-experimental-1.3-xr.1

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,16 @@
+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 an object.
+     */
+    get(): T;
+    /**
+     * Clear used object count to 0, not destroy any object, just change index.
+     */
+    clear(): void;
+}

package/types/utils/ObjectPool.d.ts

@@ -0,0 +1,16 @@
+export declare abstract class ObjectPool<T extends IPoolElement> {
+    protected _type: new () => T;
+    protected _elements: T[];
+    constructor(type: new () => T);
+    garbageCollection(): void;
+    abstract get(): T;
+}
+/**
+ * The basic interface for Object Pool's element.
+ */
+export interface IPoolElement {
+    /**
+     * Called when the object need be release.
+     */
+    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,16 @@
+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 an object from the pool.
+     */
+    get(): T;
+    /**
+     * Return an object to the pool.
+     */
+    return(element: T): void;
+}

package/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { ClearableObjectPool } from "./ClearableObjectPool";
+export type { IPoolElement } from "./ObjectPool";
+export { ReturnableObjectPool } from "./ReturnableObjectPool";

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) 2020 - present Ant Group
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.