@galacean/engine-ui 2.0.0-alpha.6 → 2.0.0-alpha.61
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/browser.js +360 -477
- package/dist/browser.js.map +1 -1
- package/dist/browser.min.js +1 -1
- package/dist/browser.min.js.map +1 -1
- package/dist/main.js +360 -477
- package/dist/main.js.map +1 -1
- package/dist/module.js +361 -478
- package/dist/module.js.map +1 -1
- package/package.json +5 -4
- package/types/Utils.d.ts +4 -4
- package/types/component/UIBatchSorter.d.ts +37 -0
- package/types/component/UICanvas.d.ts +83 -6
- package/types/component/UIGroup.d.ts +60 -1
- package/types/component/UIRenderer.d.ts +90 -4
- package/types/component/UITransform.d.ts +23 -2
- package/types/component/advanced/Button.d.ts +7 -10
- package/types/component/advanced/Image.d.ts +16 -2
- package/types/component/advanced/Text.d.ts +31 -5
- package/types/component/interactive/UIInteractive.d.ts +57 -2
- package/types/component/interactive/transition/SpriteTransition.d.ts +4 -4
- package/types/component/interactive/transition/Transition.d.ts +21 -4
- package/types/enums/ResolutionAdaptationMode.d.ts +6 -4
- package/types/index.d.ts +18 -4
- package/types/input/UIHitResult.d.ts +12 -1
- package/types/input/UIPointerEventEmitter.d.ts +27 -1
- package/types/interface/IElement.d.ts +2 -2
- package/types/interface/IGroupAble.d.ts +2 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@galacean/engine-ui",
|
|
3
|
-
"version": "2.0.0-alpha.
|
|
3
|
+
"version": "2.0.0-alpha.61",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"registry": "https://registry.npmjs.org"
|
|
@@ -11,8 +11,9 @@
|
|
|
11
11
|
"license": "MIT",
|
|
12
12
|
"main": "dist/main.js",
|
|
13
13
|
"module": "dist/module.js",
|
|
14
|
+
"unpkg": "dist/browser.min.js",
|
|
15
|
+
"jsdelivr": "dist/browser.min.js",
|
|
14
16
|
"debug": "src/index.ts",
|
|
15
|
-
"browser": "dist/browser.js",
|
|
16
17
|
"types": "types/index.d.ts",
|
|
17
18
|
"umd": {
|
|
18
19
|
"name": "Galacean.UI",
|
|
@@ -26,10 +27,10 @@
|
|
|
26
27
|
"types/**/*"
|
|
27
28
|
],
|
|
28
29
|
"devDependencies": {
|
|
29
|
-
"@galacean/engine": "2.0.0-alpha.
|
|
30
|
+
"@galacean/engine": "2.0.0-alpha.61"
|
|
30
31
|
},
|
|
31
32
|
"peerDependencies": {
|
|
32
|
-
"@galacean/engine": "2.0.0-alpha.
|
|
33
|
+
"@galacean/engine": "2.0.0-alpha.61"
|
|
33
34
|
},
|
|
34
35
|
"scripts": {
|
|
35
36
|
"b:types": "tsc"
|
package/types/Utils.d.ts
CHANGED
|
@@ -4,13 +4,13 @@ import { IElement } from "./interface/IElement";
|
|
|
4
4
|
import { IGroupAble } from "./interface/IGroupAble";
|
|
5
5
|
export declare class Utils {
|
|
6
6
|
static setRootCanvasDirty(element: IElement): void;
|
|
7
|
-
static setRootCanvas(element: IElement, rootCanvas: UICanvas): void;
|
|
7
|
+
static setRootCanvas(element: IElement, rootCanvas: UICanvas | null): void;
|
|
8
8
|
static cleanRootCanvas(element: IElement): void;
|
|
9
|
-
static searchRootCanvasInParents(element: IElement): UICanvas;
|
|
9
|
+
static searchRootCanvasInParents(element: IElement): UICanvas | null;
|
|
10
10
|
static setGroupDirty(element: IGroupAble): void;
|
|
11
|
-
static setGroup(element: IGroupAble, group: UIGroup): void;
|
|
11
|
+
static setGroup(element: IGroupAble, group: UIGroup | null): void;
|
|
12
12
|
static cleanGroup(element: IGroupAble): void;
|
|
13
|
-
static searchGroupInParents(element: IGroupAble): UIGroup;
|
|
13
|
+
static searchGroupInParents(element: IGroupAble): UIGroup | null;
|
|
14
14
|
private static _registerRootCanvas;
|
|
15
15
|
private static _registerGroup;
|
|
16
16
|
private static _registerListener;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Matrix, RenderElement } from "@galacean/engine";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
* Visual-layering driven UI batching: solve visual correctness first, batching falls out for free.
|
|
5
|
+
*
|
|
6
|
+
* Think of it as stacking elements onto numbered shelves (depths):
|
|
7
|
+
* - Non-overlapping elements share shelf 0 — free to cluster regardless of material.
|
|
8
|
+
* - Overlapping + batch-compatible — share the same shelf, still cluster.
|
|
9
|
+
* - Overlapping + batch-incompatible — bumped one shelf higher (drawn on top).
|
|
10
|
+
*
|
|
11
|
+
* `depth` is a global tag, not a spatial group: distant elements at the same visual layer
|
|
12
|
+
* share the same depth and get clustered together. Once depth is assigned, sort by
|
|
13
|
+
* (depth, material, texture, hierarchyIndex) — visual order is locked, batching is the
|
|
14
|
+
* by-product of materials clustering within each depth band.
|
|
15
|
+
*
|
|
16
|
+
* Overlap detection is accelerated by a 10×10 spatial grid. Grid origin and cell size
|
|
17
|
+
* are derived from the union AABB of input elements (the bounds transform itself is the
|
|
18
|
+
* work the loop must do anyway, so the union accumulation just piggybacks). This stays
|
|
19
|
+
* correct across SS/WS canvases, any pivot, and any element distribution — no dependency
|
|
20
|
+
* on canvas configuration.
|
|
21
|
+
*/
|
|
22
|
+
export declare class UIBatchSorter {
|
|
23
|
+
private static readonly _gridDim;
|
|
24
|
+
private static readonly _entries;
|
|
25
|
+
private static readonly _grid;
|
|
26
|
+
private static readonly _dirtyCells;
|
|
27
|
+
private static readonly _localBoundsPool;
|
|
28
|
+
private static readonly _worldToLocal;
|
|
29
|
+
/**
|
|
30
|
+
* Reorders `elements` in place for optimal batching.
|
|
31
|
+
* @param elements - in hierarchy order (depth-first traversal); mutated in place
|
|
32
|
+
* @param canvasWorldMatrix - reduces world bounds to canvas-local for precise overlap
|
|
33
|
+
*/
|
|
34
|
+
static sort(elements: RenderElement[], canvasWorldMatrix: Matrix): void;
|
|
35
|
+
private static _rectOverlap;
|
|
36
|
+
private static _compareEntries;
|
|
37
|
+
}
|
|
@@ -1,16 +1,44 @@
|
|
|
1
|
-
import { Camera, Component, Vector2 } from "@galacean/engine";
|
|
1
|
+
import { Camera, Component, DisorderedArray, Entity, Layer, Ray, RenderElement, Vector2, Vector3 } from "@galacean/engine";
|
|
2
|
+
import type { ICloneHook } from "@galacean/engine";
|
|
2
3
|
import { CanvasRenderMode } from "../enums/CanvasRenderMode";
|
|
3
4
|
import { ResolutionAdaptationMode } from "../enums/ResolutionAdaptationMode";
|
|
5
|
+
import { UIHitResult } from "../input/UIHitResult";
|
|
4
6
|
import { IElement } from "../interface/IElement";
|
|
7
|
+
import { UIRenderer } from "./UIRenderer";
|
|
5
8
|
/**
|
|
6
9
|
* The UI Canvas component serves as the root node for UI elements,
|
|
7
10
|
* handling rendering and events based on it.
|
|
8
11
|
*/
|
|
9
|
-
export declare class UICanvas extends Component implements IElement {
|
|
10
|
-
|
|
12
|
+
export declare class UICanvas extends Component implements IElement, ICloneHook<UICanvas> {
|
|
13
|
+
/** @internal */
|
|
14
|
+
static _hierarchyCounter: number;
|
|
11
15
|
private static _tempGroupAbleList;
|
|
12
16
|
private static _tempVec3;
|
|
13
17
|
private static _tempMat;
|
|
18
|
+
/** @internal */
|
|
19
|
+
_canvasIndex: number;
|
|
20
|
+
/** @internal */
|
|
21
|
+
_rootCanvas: UICanvas | null;
|
|
22
|
+
/** @internal */
|
|
23
|
+
_indexInRootCanvas: number;
|
|
24
|
+
/** @internal */
|
|
25
|
+
_isRootCanvasDirty: boolean;
|
|
26
|
+
/** @internal */
|
|
27
|
+
_rootCanvasListeningEntities: Entity[];
|
|
28
|
+
/** @internal */
|
|
29
|
+
_isRootCanvas: boolean;
|
|
30
|
+
/** @internal */
|
|
31
|
+
_renderElements: RenderElement[];
|
|
32
|
+
/** @internal */
|
|
33
|
+
_batchedRenderElements: RenderElement[];
|
|
34
|
+
/** @internal */
|
|
35
|
+
_sortDistance: number;
|
|
36
|
+
/** @internal */
|
|
37
|
+
_orderedRenderers: UIRenderer[];
|
|
38
|
+
/** @internal */
|
|
39
|
+
_realRenderMode: number;
|
|
40
|
+
/** @internal */
|
|
41
|
+
_disorderedElements: DisorderedArray<IElement>;
|
|
14
42
|
private _renderMode;
|
|
15
43
|
private _camera;
|
|
16
44
|
private _cameraObserver;
|
|
@@ -23,12 +51,14 @@ export declare class UICanvas extends Component implements IElement {
|
|
|
23
51
|
private _center;
|
|
24
52
|
private _centerDirtyFlag;
|
|
25
53
|
/**
|
|
26
|
-
*
|
|
54
|
+
* Local UI units per sprite world unit for sliced borders and tile sizing.
|
|
55
|
+
* One glyph pixel maps to `referenceResolutionPerUnit / 100` local UI units.
|
|
27
56
|
*/
|
|
28
57
|
get referenceResolutionPerUnit(): number;
|
|
29
58
|
set referenceResolutionPerUnit(value: number);
|
|
30
59
|
/**
|
|
31
|
-
*
|
|
60
|
+
* Design resolution in pixels for {@link CanvasRenderMode.ScreenSpaceCamera} and {@link CanvasRenderMode.ScreenSpaceOverlay}.
|
|
61
|
+
* The root canvas adapts it to the camera viewport or engine canvas using {@link UICanvas.resolutionAdaptationMode}.
|
|
32
62
|
*/
|
|
33
63
|
get referenceResolution(): Vector2;
|
|
34
64
|
set referenceResolution(value: Vector2);
|
|
@@ -56,7 +86,7 @@ export declare class UICanvas extends Component implements IElement {
|
|
|
56
86
|
get resolutionAdaptationMode(): ResolutionAdaptationMode;
|
|
57
87
|
set resolutionAdaptationMode(value: ResolutionAdaptationMode);
|
|
58
88
|
/**
|
|
59
|
-
* The rendering
|
|
89
|
+
* The rendering priority of the canvas.
|
|
60
90
|
*/
|
|
61
91
|
get sortOrder(): number;
|
|
62
92
|
set sortOrder(value: number);
|
|
@@ -65,8 +95,55 @@ export declare class UICanvas extends Component implements IElement {
|
|
|
65
95
|
*/
|
|
66
96
|
get distance(): number;
|
|
67
97
|
set distance(value: number);
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
constructor(entity: Entity);
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
_raycast(ray: Ray, out: UIHitResult, distance: number, cullingMask: Layer): boolean;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
_getRootCanvas(): UICanvas | null;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
_canRender(camera: Camera): boolean;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
117
|
+
_canDispatchEvent(camera: Camera): boolean;
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
121
|
+
_prepareRender(context: any): void;
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
125
|
+
_updateSortDistance(isOrthographic: boolean, cameraPosition: Vector3, cameraForward: Vector3): void;
|
|
126
|
+
/**
|
|
127
|
+
* @internal
|
|
128
|
+
*/
|
|
68
129
|
_onEnableInScene(): void;
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
*/
|
|
69
133
|
_onDisableInScene(): void;
|
|
134
|
+
/**
|
|
135
|
+
* @internal
|
|
136
|
+
*/
|
|
137
|
+
_onDisable(): void;
|
|
138
|
+
/**
|
|
139
|
+
* @internal
|
|
140
|
+
*/
|
|
141
|
+
_rootCanvasListener(flag: number, param: any): void;
|
|
142
|
+
/**
|
|
143
|
+
* @internal
|
|
144
|
+
* @inheritdoc
|
|
145
|
+
*/
|
|
146
|
+
_onClone(target: UICanvas): void;
|
|
70
147
|
private _getRenderers;
|
|
71
148
|
private _adapterPoseInScreenSpace;
|
|
72
149
|
private _adapterSizeInScreenSpace;
|
|
@@ -1,9 +1,34 @@
|
|
|
1
|
-
import { Component, Entity } from "@galacean/engine";
|
|
1
|
+
import { Component, DisorderedArray, Entity } from "@galacean/engine";
|
|
2
2
|
import { IGroupAble } from "../interface/IGroupAble";
|
|
3
|
+
import { UICanvas } from "./UICanvas";
|
|
3
4
|
export declare class UIGroup extends Component implements IGroupAble {
|
|
5
|
+
/** @internal */
|
|
6
|
+
_indexInGroup: number;
|
|
7
|
+
/** @internal */
|
|
8
|
+
_indexInRootCanvas: number;
|
|
9
|
+
/** @internal */
|
|
10
|
+
_group: UIGroup | null;
|
|
11
|
+
/** @internal */
|
|
12
|
+
_rootCanvas: UICanvas | null;
|
|
13
|
+
/** @internal */
|
|
14
|
+
_disorderedElements: DisorderedArray<IGroupAble>;
|
|
15
|
+
/** @internal */
|
|
16
|
+
_globalAlpha: number;
|
|
17
|
+
/** @internal */
|
|
18
|
+
_globalInteractive: boolean;
|
|
4
19
|
private _alpha;
|
|
5
20
|
private _interactive;
|
|
6
21
|
private _ignoreParentGroup;
|
|
22
|
+
/** @internal */
|
|
23
|
+
_rootCanvasListeningEntities: Entity[];
|
|
24
|
+
/** @internal */
|
|
25
|
+
_groupListeningEntities: Entity[];
|
|
26
|
+
/** @internal */
|
|
27
|
+
_isRootCanvasDirty: boolean;
|
|
28
|
+
/** @internal */
|
|
29
|
+
_isGroupDirty: boolean;
|
|
30
|
+
/** @internal */
|
|
31
|
+
_groupDirtyFlags: number;
|
|
7
32
|
/**
|
|
8
33
|
* Whether to ignore the parent group.
|
|
9
34
|
* @remarks If this parameter set to `true`,
|
|
@@ -21,9 +46,43 @@ export declare class UIGroup extends Component implements IGroupAble {
|
|
|
21
46
|
*/
|
|
22
47
|
get alpha(): number;
|
|
23
48
|
set alpha(value: number);
|
|
49
|
+
/**
|
|
50
|
+
* @internal
|
|
51
|
+
*/
|
|
52
|
+
_getGlobalAlpha(): number;
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
_getGlobalInteractive(): boolean;
|
|
24
57
|
constructor(entity: Entity);
|
|
58
|
+
/**
|
|
59
|
+
* @internal
|
|
60
|
+
*/
|
|
25
61
|
_onEnableInScene(): void;
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
26
65
|
_onDisableInScene(): void;
|
|
66
|
+
/**
|
|
67
|
+
* @internal
|
|
68
|
+
*/
|
|
69
|
+
_getRootCanvas(): UICanvas | null;
|
|
70
|
+
/**
|
|
71
|
+
* @internal
|
|
72
|
+
*/
|
|
73
|
+
_getGroup(): UIGroup | null;
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
_groupListener(flag: number): void;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
_rootCanvasListener(flag: number): void;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
_onGroupModify(flags: GroupModifyFlags, isPass?: boolean): void;
|
|
27
86
|
private _isContainDirtyFlags;
|
|
28
87
|
private _isContainDirtyFlag;
|
|
29
88
|
private _setDirtyFlagTrue;
|
|
@@ -1,11 +1,43 @@
|
|
|
1
|
-
import { Color, Renderer, Vector3, Vector4 } from "@galacean/engine";
|
|
1
|
+
import { Color, Entity, Matrix, Plane, Ray, Renderer, ShaderProperty, Vector3, Vector4 } from "@galacean/engine";
|
|
2
|
+
import type { PrimitiveChunkManager } from "@galacean/engine";
|
|
3
|
+
import { UIHitResult } from "../input/UIHitResult";
|
|
2
4
|
import { IGraphics } from "../interface/IGraphics";
|
|
5
|
+
import { UICanvas } from "./UICanvas";
|
|
6
|
+
import { GroupModifyFlags, UIGroup } from "./UIGroup";
|
|
3
7
|
export declare class UIRenderer extends Renderer implements IGraphics {
|
|
8
|
+
/** @internal */
|
|
9
|
+
static _tempVec30: Vector3;
|
|
10
|
+
/** @internal */
|
|
11
|
+
static _tempVec31: Vector3;
|
|
12
|
+
/** @internal */
|
|
13
|
+
static _tempMat: Matrix;
|
|
14
|
+
/** @internal */
|
|
15
|
+
static _tempPlane: Plane;
|
|
16
|
+
/** @internal */
|
|
17
|
+
static _textureProperty: ShaderProperty;
|
|
4
18
|
/**
|
|
5
19
|
* Custom boundary for raycast detection.
|
|
6
20
|
* @remarks this is based on `this.entity.transform`.
|
|
7
21
|
*/
|
|
8
22
|
raycastPadding: Vector4;
|
|
23
|
+
/** @internal */
|
|
24
|
+
_rootCanvas: UICanvas | null;
|
|
25
|
+
/** @internal */
|
|
26
|
+
_indexInRootCanvas: number;
|
|
27
|
+
/** @internal */
|
|
28
|
+
_isRootCanvasDirty: boolean;
|
|
29
|
+
/** @internal */
|
|
30
|
+
_rootCanvasListeningEntities: Entity[];
|
|
31
|
+
/** @internal */
|
|
32
|
+
_group: UIGroup | null;
|
|
33
|
+
/** @internal */
|
|
34
|
+
_indexInGroup: number;
|
|
35
|
+
/** @internal */
|
|
36
|
+
_isGroupDirty: boolean;
|
|
37
|
+
/** @internal */
|
|
38
|
+
_groupListeningEntities: Entity[];
|
|
39
|
+
/** @internal */
|
|
40
|
+
_subChunk: any;
|
|
9
41
|
private _raycastEnabled;
|
|
10
42
|
protected _color: Color;
|
|
11
43
|
/**
|
|
@@ -18,13 +50,67 @@ export declare class UIRenderer extends Renderer implements IGraphics {
|
|
|
18
50
|
*/
|
|
19
51
|
get raycastEnabled(): boolean;
|
|
20
52
|
set raycastEnabled(value: boolean);
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
constructor(entity: Entity);
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
*/
|
|
60
|
+
_canBatch(preElement: any, curElement: any): boolean;
|
|
61
|
+
/**
|
|
62
|
+
* @internal
|
|
63
|
+
*/
|
|
64
|
+
_batch(preElement: any, curElement: any): void;
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
_updateTransformShaderData(context: any, onlyMVP: boolean): void;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
24
72
|
_prepareRender(context: any): void;
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
25
76
|
_onEnableInScene(): void;
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
26
80
|
_onDisableInScene(): void;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
_getGlobalAlpha(): number;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
_getRootCanvas(): UICanvas | null;
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
_getGroup(): UIGroup | null;
|
|
93
|
+
/**
|
|
94
|
+
* @internal
|
|
95
|
+
*/
|
|
96
|
+
_groupListener(flag: number): void;
|
|
97
|
+
/**
|
|
98
|
+
* @internal
|
|
99
|
+
*/
|
|
100
|
+
_rootCanvasListener(flag: number, entity: Entity): void;
|
|
101
|
+
/**
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
104
|
+
_onGroupModify(flags: GroupModifyFlags): void;
|
|
27
105
|
private _onColorChanged;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
_getChunkManager(): PrimitiveChunkManager;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
_raycast(ray: Ray, out: UIHitResult, distance: number): boolean;
|
|
28
114
|
protected _hitTest(localPosition: Vector3): boolean;
|
|
29
115
|
protected _onDestroy(): void;
|
|
30
116
|
}
|
|
@@ -17,7 +17,8 @@ export declare class UITransform extends Transform {
|
|
|
17
17
|
private _horizontalAlignment;
|
|
18
18
|
private _verticalAlignment;
|
|
19
19
|
/**
|
|
20
|
-
* Width and height
|
|
20
|
+
* Width and height in local units, before transform scaling.
|
|
21
|
+
* Screen-space units are pixels at the root canvas's {@link UICanvas.referenceResolution}; world-space units are scene units.
|
|
21
22
|
*/
|
|
22
23
|
get size(): Vector2;
|
|
23
24
|
set size(value: Vector2);
|
|
@@ -96,7 +97,19 @@ export declare class UITransform extends Transform {
|
|
|
96
97
|
*/
|
|
97
98
|
get alignMiddle(): number;
|
|
98
99
|
set alignMiddle(value: number);
|
|
99
|
-
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
constructor(entity: Entity);
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
_parentChange(): void;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
* @inheritdoc
|
|
111
|
+
*/
|
|
112
|
+
_onClone(target: UITransform): void;
|
|
100
113
|
protected _onLocalMatrixChanging(): void;
|
|
101
114
|
protected _onWorldMatrixChanging(): void;
|
|
102
115
|
protected _onPositionChanged(): void;
|
|
@@ -109,3 +122,11 @@ export declare class UITransform extends Transform {
|
|
|
109
122
|
private _updateWorldFlagWithSelfRectChange;
|
|
110
123
|
private _updateWorldFlagWithParentRectChange;
|
|
111
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* @internal
|
|
127
|
+
* extends TransformModifyFlags
|
|
128
|
+
*/
|
|
129
|
+
export declare enum UITransformModifyFlags {
|
|
130
|
+
Size = 512,
|
|
131
|
+
Pivot = 1024
|
|
132
|
+
}
|
|
@@ -1,21 +1,18 @@
|
|
|
1
|
-
import { PointerEventData } from "@galacean/engine";
|
|
1
|
+
import { PointerEventData, Signal } from "@galacean/engine";
|
|
2
2
|
import { UIInteractive } from "../interactive/UIInteractive";
|
|
3
3
|
export declare class Button extends UIInteractive {
|
|
4
|
-
|
|
4
|
+
/** Signal emitted when the button is clicked. */
|
|
5
|
+
readonly onClick: Signal<[PointerEventData]>;
|
|
6
|
+
onPointerClick(event: PointerEventData): void;
|
|
7
|
+
onDestroy(): void;
|
|
5
8
|
/**
|
|
6
9
|
* Add a listening function for click.
|
|
7
|
-
* @
|
|
10
|
+
* @deprecated Use `onClick.on(listener, context)` instead.
|
|
8
11
|
*/
|
|
9
12
|
addClicked(listener: (event: PointerEventData) => void): void;
|
|
10
13
|
/**
|
|
11
14
|
* Remove a listening function of click.
|
|
12
|
-
* @
|
|
15
|
+
* @deprecated Use `onClick.off(listener, context)` instead.
|
|
13
16
|
*/
|
|
14
17
|
removeClicked(listener: (event: PointerEventData) => void): void;
|
|
15
|
-
onPointerClick(event: PointerEventData): void;
|
|
16
|
-
onDestroy(): void;
|
|
17
|
-
}
|
|
18
|
-
export interface IUIListener {
|
|
19
|
-
fn: (event: PointerEventData) => void;
|
|
20
|
-
destroyed?: boolean;
|
|
21
18
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { BoundingBox, ISpriteRenderer, Sprite, SpriteDrawMode, SpriteTileMode } from "@galacean/engine";
|
|
1
|
+
import { BoundingBox, Entity, ISpriteRenderer, Sprite, SpriteDrawMode, SpriteTileMode } from "@galacean/engine";
|
|
2
|
+
import { RootCanvasModifyFlags } from "../UICanvas";
|
|
2
3
|
import { UIRenderer } from "../UIRenderer";
|
|
3
4
|
/**
|
|
4
5
|
* UI element that renders an image.
|
|
@@ -27,8 +28,21 @@ export declare class Image extends UIRenderer implements ISpriteRenderer {
|
|
|
27
28
|
/**
|
|
28
29
|
* The Sprite to render.
|
|
29
30
|
*/
|
|
30
|
-
get sprite(): Sprite;
|
|
31
|
+
get sprite(): Sprite | null;
|
|
31
32
|
set sprite(value: Sprite | null);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
constructor(entity: Entity);
|
|
37
|
+
/**
|
|
38
|
+
* @internal
|
|
39
|
+
*/
|
|
40
|
+
_onRootCanvasModify(flag: RootCanvasModifyFlags): void;
|
|
41
|
+
/**
|
|
42
|
+
* @internal
|
|
43
|
+
* @inheritdoc
|
|
44
|
+
*/
|
|
45
|
+
_onClone(target: Image): void;
|
|
32
46
|
protected _updateBounds(worldBounds: BoundingBox): void;
|
|
33
47
|
protected _render(context: any): void;
|
|
34
48
|
protected _onTransformChanged(type: number): void;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { BoundingBox, Entity, Font, FontStyle, ITextRenderer, OverflowMode, TextHorizontalAlignment, TextVerticalAlignment } from "@galacean/engine";
|
|
1
|
+
import { BoundingBox, Entity, Font, FontStyle, ITextRenderer, OverflowMode, SubFont, TextHorizontalAlignment, TextVerticalAlignment } from "@galacean/engine";
|
|
2
|
+
import { RootCanvasModifyFlags } from "../UICanvas";
|
|
2
3
|
import { UIRenderer } from "../UIRenderer";
|
|
3
4
|
/**
|
|
4
5
|
* UI component used to render text.
|
|
@@ -28,10 +29,12 @@ export declare class Text extends UIRenderer implements ITextRenderer {
|
|
|
28
29
|
/**
|
|
29
30
|
* The font of the Text.
|
|
30
31
|
*/
|
|
31
|
-
get font(): Font;
|
|
32
|
-
set font(value: Font);
|
|
32
|
+
get font(): Font | null;
|
|
33
|
+
set font(value: Font | null);
|
|
33
34
|
/**
|
|
34
|
-
*
|
|
35
|
+
* Font size in pixels, used for glyph rasterization.
|
|
36
|
+
* Glyph pixel dimensions are converted to local UI units using the root canvas's
|
|
37
|
+
* {@link UICanvas.referenceResolutionPerUnit}.
|
|
35
38
|
*/
|
|
36
39
|
get fontSize(): number;
|
|
37
40
|
set fontSize(value: number);
|
|
@@ -80,7 +83,30 @@ export declare class Text extends UIRenderer implements ITextRenderer {
|
|
|
80
83
|
*/
|
|
81
84
|
get bounds(): BoundingBox;
|
|
82
85
|
constructor(entity: Entity);
|
|
83
|
-
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
protected _onDestroy(): void;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
_isContainDirtyFlag(type: number): boolean;
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
_setDirtyFlagTrue(type: number): void;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
_setDirtyFlagFalse(type: number): void;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
_getSubFont(): SubFont;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
_onRootCanvasModify(flag: RootCanvasModifyFlags): void;
|
|
84
110
|
protected _updateBounds(worldBounds: BoundingBox): void;
|
|
85
111
|
protected _render(context: any): void;
|
|
86
112
|
private _resetSubFont;
|
|
@@ -1,11 +1,33 @@
|
|
|
1
1
|
import { Entity, Script } from "@galacean/engine";
|
|
2
|
+
import { UIGroup } from "../..";
|
|
2
3
|
import { IGroupAble } from "../../interface/IGroupAble";
|
|
4
|
+
import { UICanvas } from "../UICanvas";
|
|
5
|
+
import { GroupModifyFlags } from "../UIGroup";
|
|
3
6
|
import { Transition } from "./transition/Transition";
|
|
4
7
|
/**
|
|
5
8
|
* Interactive component.
|
|
6
9
|
*/
|
|
7
10
|
export declare class UIInteractive extends Script implements IGroupAble {
|
|
8
|
-
|
|
11
|
+
/** @internal */
|
|
12
|
+
_rootCanvas: UICanvas;
|
|
13
|
+
/** @internal */
|
|
14
|
+
_indexInRootCanvas: number;
|
|
15
|
+
/** @internal */
|
|
16
|
+
_isRootCanvasDirty: boolean;
|
|
17
|
+
/** @internal */
|
|
18
|
+
_rootCanvasListeningEntities: Entity[];
|
|
19
|
+
/** @internal */
|
|
20
|
+
_group: UIGroup;
|
|
21
|
+
/** @internal */
|
|
22
|
+
_indexInGroup: number;
|
|
23
|
+
/** @internal */
|
|
24
|
+
_isGroupDirty: boolean;
|
|
25
|
+
/** @internal */
|
|
26
|
+
_groupListeningEntities: Entity[];
|
|
27
|
+
/** @internal */
|
|
28
|
+
_globalInteractive: boolean;
|
|
29
|
+
/** @internal */
|
|
30
|
+
_globalInteractiveDirty: boolean;
|
|
9
31
|
protected _transitions: Transition[];
|
|
10
32
|
protected _interactive: boolean;
|
|
11
33
|
protected _state: InteractiveState;
|
|
@@ -21,6 +43,10 @@ export declare class UIInteractive extends Script implements IGroupAble {
|
|
|
21
43
|
*/
|
|
22
44
|
get interactive(): boolean;
|
|
23
45
|
set interactive(value: boolean);
|
|
46
|
+
/**
|
|
47
|
+
* @internal
|
|
48
|
+
*/
|
|
49
|
+
constructor(entity: Entity);
|
|
24
50
|
/**
|
|
25
51
|
* Add transition on this interactive.
|
|
26
52
|
* @param transition - The transition
|
|
@@ -41,9 +67,38 @@ export declare class UIInteractive extends Script implements IGroupAble {
|
|
|
41
67
|
onPointerEnter(): void;
|
|
42
68
|
onPointerExit(): void;
|
|
43
69
|
onDestroy(): void;
|
|
44
|
-
|
|
70
|
+
/**
|
|
71
|
+
* @internal
|
|
72
|
+
*/
|
|
73
|
+
_getRootCanvas(): UICanvas;
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
_getGroup(): UIGroup;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
45
81
|
_onEnableInScene(): void;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
46
85
|
_onDisableInScene(): void;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
_groupListener(flag: number): void;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
_rootCanvasListener(flag: number): void;
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
_onGroupModify(flags: GroupModifyFlags): void;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
_getGlobalInteractive(): boolean;
|
|
47
102
|
private _updateState;
|
|
48
103
|
private _getInteractiveState;
|
|
49
104
|
}
|
|
@@ -4,8 +4,8 @@ import { Transition } from "./Transition";
|
|
|
4
4
|
/**
|
|
5
5
|
* Sprite transition.
|
|
6
6
|
*/
|
|
7
|
-
export declare class SpriteTransition extends Transition<Sprite, Image> {
|
|
8
|
-
protected _getTargetValueCopy(): Sprite;
|
|
9
|
-
protected _updateCurrentValue(srcValue: Sprite, destValue: Sprite, weight: number): void;
|
|
10
|
-
protected _applyValue(value: Sprite): void;
|
|
7
|
+
export declare class SpriteTransition extends Transition<Sprite | null, Image> {
|
|
8
|
+
protected _getTargetValueCopy(): Sprite | null;
|
|
9
|
+
protected _updateCurrentValue(srcValue: Sprite | null, destValue: Sprite | null, weight: number): void;
|
|
10
|
+
protected _applyValue(value: Sprite | null): void;
|
|
11
11
|
}
|