@galacean/engine-ui 2.0.0-alpha.2 → 2.0.0-alpha.5

package/dist/module.js

@@ -1498,7 +1498,18 @@ var UICanvas = /*#__PURE__*/ function(Component) {
     /**
    * @internal
    */ _proto._canRender = function _canRender(camera) {
-        return this._renderMode !== CanvasRenderMode.ScreenSpaceCamera || this._renderCamera === camera;
+        return this._realRenderMode !== CanvasRenderMode.ScreenSpaceCamera || this._camera === camera;
+    };
+    /**
+   * @internal
+   */ _proto._canDispatchEvent = function _canDispatchEvent(camera) {
+        var realMode = this._realRenderMode;
+        if (realMode === CanvasRenderMode.ScreenSpaceOverlay) {
+            return true;
+        }
+        var assignedCamera = this._camera;
+        // @ts-ignore
+        return !assignedCamera || !assignedCamera._phasedActiveInScene || assignedCamera === camera;
     };
     /**
    * @internal
@@ -1600,13 +1611,13 @@ var UICanvas = /*#__PURE__*/ function(Component) {
    * @internal
    */ _proto._cloneTo = function _cloneTo(target, srcRoot, targetRoot) {
         target.renderMode = this._renderMode;
-        var renderCamera = this._renderCamera;
-        if (renderCamera) {
+        var camera = this._camera;
+        if (camera) {
             var paths = UICanvas._targetTempPath;
             // @ts-ignore
-            var success = Entity._getEntityHierarchyPath(srcRoot, renderCamera.entity, paths);
+            var success = Entity._getEntityHierarchyPath(srcRoot, camera.entity, paths);
             // @ts-ignore
-            target.renderCamera = success ? Entity._getEntityByHierarchyPath(targetRoot, paths).getComponent(Camera) : renderCamera;
+            target.camera = success ? Entity._getEntityByHierarchyPath(targetRoot, paths).getComponent(Camera) : camera;
         }
     };
     _proto._getRenderers = function _getRenderers() {
@@ -1624,7 +1635,7 @@ var UICanvas = /*#__PURE__*/ function(Component) {
         var transform = this.entity.transform;
         var realRenderMode = this._realRenderMode;
         if (realRenderMode === CanvasRenderMode.ScreenSpaceCamera) {
-            var cameraEntity = this._renderCamera.entity;
+            var cameraEntity = this._camera.entity;
             if (!this._isSameOrChildEntity(cameraEntity)) {
                 var cameraTransform = cameraEntity.transform;
                 var cameraWorldPosition = cameraTransform.worldPosition, cameraWorldForward = cameraTransform.worldForward;
@@ -1645,9 +1656,9 @@ var UICanvas = /*#__PURE__*/ function(Component) {
         var curWidth;
         var curHeight;
         if (realRenderMode === CanvasRenderMode.ScreenSpaceCamera) {
-            var renderCamera = this._renderCamera;
-            curHeight = renderCamera.isOrthographic ? renderCamera.orthographicSize * 2 : 2 * (Math.tan(MathUtil.degreeToRadian(renderCamera.fieldOfView * 0.5)) * this._distance);
-            curWidth = renderCamera.aspectRatio * curHeight;
+            var camera = this._camera;
+            curHeight = camera.isOrthographic ? camera.orthographicSize * 2 : 2 * (Math.tan(MathUtil.degreeToRadian(camera.fieldOfView * 0.5)) * this._distance);
+            curWidth = camera.aspectRatio * curHeight;
         } else {
             var canvas = this.engine.canvas;
             curHeight = canvas.height;
@@ -1717,7 +1728,7 @@ var UICanvas = /*#__PURE__*/ function(Component) {
         return depth;
     };
     _proto._updateCameraObserver = function _updateCameraObserver() {
-        var camera = this._isRootCanvas && this._renderMode === CanvasRenderMode.ScreenSpaceCamera ? this._renderCamera : null;
+        var camera = this._isRootCanvas && this._renderMode === CanvasRenderMode.ScreenSpaceCamera ? this._camera : null;
         var preCamera = this._cameraObserver;
         if (preCamera !== camera) {
             this._cameraObserver = camera;
@@ -1743,10 +1754,10 @@ var UICanvas = /*#__PURE__*/ function(Component) {
                     this._adapterSizeInScreenSpace();
                     break;
                 case CameraModifyFlags.FieldOfView:
-                    !this._renderCamera.isOrthographic && this._adapterSizeInScreenSpace();
+                    !this._camera.isOrthographic && this._adapterSizeInScreenSpace();
                     break;
                 case CameraModifyFlags.OrthographicSize:
-                    this._renderCamera.isOrthographic && this._adapterSizeInScreenSpace();
+                    this._camera.isOrthographic && this._adapterSizeInScreenSpace();
                     break;
                 case CameraModifyFlags.DisableInScene:
                     this._setRealRenderMode(CanvasRenderMode.ScreenSpaceOverlay);
@@ -1817,9 +1828,10 @@ var UICanvas = /*#__PURE__*/ function(Component) {
     };
     _proto._getRealRenderMode = function _getRealRenderMode() {
         if (this._isRootCanvas) {
-            var _this__renderCamera;
+            var _this__camera;
             var mode = this._renderMode;
-            if (mode === CanvasRenderMode.ScreenSpaceCamera && !((_this__renderCamera = this._renderCamera) == null ? void 0 : _this__renderCamera.enabled)) {
+            // @ts-ignore
+            if (mode === CanvasRenderMode.ScreenSpaceCamera && !((_this__camera = this._camera) == null ? void 0 : _this__camera._phasedActiveInScene)) {
                 return CanvasRenderMode.ScreenSpaceOverlay;
             } else {
                 return mode;
@@ -1909,18 +1921,22 @@ var UICanvas = /*#__PURE__*/ function(Component) {
             }
         },
         {
-            key: "renderCamera",
+            key: "camera",
             get: /**
-   * The camera used to render the UI canvas in `ScreenSpaceCamera` mode.
-   * @remarks If set `ScreenSpaceCamera` but no corresponding camera is assigned, the actual rendering mode defaults to `ScreenSpaceOverlay`.
+   * The camera associated with this canvas.
+   * @remarks
+   * - `ScreenSpaceCamera` mode: Used for rendering adaptation. Defaults to `ScreenSpaceOverlay` if not assigned.
+   * - `WorldSpace` mode: Used for event detection. If not assigned, events are handled by the highest-priority camera.
    */ function get() {
-                return this._renderCamera;
+                return this._camera;
             },
             set: function set(value) {
-                var preCamera = this._renderCamera;
+                var preCamera = this._camera;
                 if (preCamera !== value) {
-                    value && this._isSameOrChildEntity(value.entity) && Logger.warn("Camera entity matching or nested within the canvas entity disables canvas auto-adaptation in ScreenSpaceCamera mode.");
-                    this._renderCamera = value;
+                    if (value && this._isSameOrChildEntity(value.entity)) {
+                        Logger.warn("Camera entity matching or nested within the canvas entity disables canvas auto-adaptation in ScreenSpaceCamera mode.");
+                    }
+                    this._camera = value;
                     this._updateCameraObserver();
                     var preRenderMode = this._realRenderMode;
                     var curRenderMode = this._getRealRenderMode();
@@ -1935,6 +1951,17 @@ var UICanvas = /*#__PURE__*/ function(Component) {
                 }
             }
         },
+        {
+            key: "renderCamera",
+            get: /**
+   * @deprecated Use {@link camera} instead.
+   */ function get() {
+                return this.camera;
+            },
+            set: function set(value) {
+                this.camera = value;
+            }
+        },
         {
             key: "resolutionAdaptationMode",
             get: /**
@@ -2030,7 +2057,7 @@ __decorate([
 ], UICanvas.prototype, "_renderMode", void 0);
 __decorate([
     ignoreClone
-], UICanvas.prototype, "_renderCamera", void 0);
+], UICanvas.prototype, "_camera", void 0);
 __decorate([
     ignoreClone
 ], UICanvas.prototype, "_cameraObserver", void 0);
@@ -2142,6 +2169,7 @@ __decorate([
         var _this;
         _this = UIRenderer1.call(this, entity) || this, _this._sprite = null, _this._tileMode = SpriteTileMode.Continuous, _this._tiledAdaptiveThreshold = 0.5;
         _this.drawMode = SpriteDrawMode.Simple;
+        // @ts-ignore
         _this.setMaterial(_this._engine._getUIDefaultMaterial());
         _this._onSpriteChange = _this._onSpriteChange.bind(_this);
         return _this;
@@ -2193,6 +2221,7 @@ __decorate([
         }
         // @todo: This question needs to be raised rather than hidden.
         if (material.destroyed) {
+            // @ts-ignore
             material = this._engine._getUIDefaultMaterial();
         }
         var alpha = this._getGlobalAlpha();
@@ -2400,7 +2429,7 @@ __decorate([
     _inherits(Text, UIRenderer1);
     function Text(entity) {
         var _this;
-        _this = UIRenderer1.call(this, entity) || this, _this._textChunks = Array(), _this._subFont = null, _this._text = "", _this._localBounds = new BoundingBox(), _this._font = null, _this._fontSize = 24, _this._fontStyle = FontStyle.None, _this._lineSpacing = 0, _this._horizontalAlignment = TextHorizontalAlignment.Center, _this._verticalAlignment = TextVerticalAlignment.Center, _this._enableWrapping = false, _this._overflowMode = OverflowMode.Overflow;
+        _this = UIRenderer1.call(this, entity) || this, _this._textChunks = Array(), _this._subFont = null, _this._text = "", _this._localBounds = new BoundingBox(), _this._font = null, _this._fontSize = 24, _this._fontStyle = FontStyle.None, _this._lineSpacing = 0, _this._characterSpacing = 0, _this._horizontalAlignment = TextHorizontalAlignment.Center, _this._verticalAlignment = TextVerticalAlignment.Center, _this._enableWrapping = false, _this._overflowMode = OverflowMode.Overflow;
         var engine = _this.engine;
         // @ts-ignore
         _this.font = engine._textDefaultFont;
@@ -2577,7 +2606,8 @@ __decorate([
         var rendererHeight = size.y;
         var offsetWidth = rendererWidth * (0.5 - pivot.x);
         var offsetHeight = rendererHeight * (0.5 - pivot.y);
-        var textMetrics = this.enableWrapping ? TextUtils.measureTextWithWrap(this, rendererWidth * pixelsPerResolution, rendererHeight * pixelsPerResolution, this._lineSpacing * pixelsPerResolution) : TextUtils.measureTextWithoutWrap(this, rendererHeight * pixelsPerResolution, this._lineSpacing * pixelsPerResolution);
+        var characterSpacing = this._characterSpacing * this._fontSize;
+        var textMetrics = this.enableWrapping ? TextUtils.measureTextWithWrap(this, rendererWidth * pixelsPerResolution, rendererHeight * pixelsPerResolution, this._lineSpacing * this._fontSize, characterSpacing) : TextUtils.measureTextWithoutWrap(this, rendererHeight * pixelsPerResolution, this._lineSpacing * this._fontSize, characterSpacing);
         var height = textMetrics.height, lines = textMetrics.lines, lineWidths = textMetrics.lineWidths, lineHeight = textMetrics.lineHeight, lineMaxSizes = textMetrics.lineMaxSizes;
         // @ts-ignore
         var charRenderInfoPool = this.engine._charRenderInfoPool;
@@ -2649,7 +2679,7 @@ __decorate([
                             j === firstRow && (minX = Math.min(minX, left));
                             maxX = Math.max(maxX, right);
                         }
-                        startX += charInfo.xAdvance + charInfo.offsetX;
+                        startX += charInfo.xAdvance + characterSpacing;
                     }
                 }
                 startY -= lineHeight;
@@ -2821,7 +2851,7 @@ __decorate([
         {
             key: "lineSpacing",
             get: /**
-   * The space between two lines (in pixels).
+   * The space between two lines, in em (ratio of fontSize).
    */ function get() {
                 return this._lineSpacing;
             },
@@ -2832,6 +2862,20 @@ __decorate([
                 }
             }
         },
+        {
+            key: "characterSpacing",
+            get: /**
+   * The space between two characters, in em (ratio of fontSize).
+   */ function get() {
+                return this._characterSpacing;
+            },
+            set: function set(value) {
+                if (this._characterSpacing !== value) {
+                    this._characterSpacing = value;
+                    this._setDirtyFlagTrue(25);
+                }
+            }
+        },
         {
             key: "horizontalAlignment",
             get: /**
@@ -2957,6 +3001,9 @@ __decorate([
 __decorate([
     assignmentClone
 ], Text.prototype, "_lineSpacing", void 0);
+__decorate([
+    assignmentClone
+], Text.prototype, "_characterSpacing", void 0);
 __decorate([
     assignmentClone
 ], Text.prototype, "_horizontalAlignment", void 0);
@@ -3374,7 +3421,7 @@ var UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
                 // Post-rendering first detection
                 for(var k2 = 0, n2 = canvasElements.length; k2 < n2; k2++){
                     var canvas = canvasElements.get(k2);
-                    if (!canvas._canRender(camera)) continue;
+                    if (!canvas._canDispatchEvent(camera)) continue;
                     if (canvas._raycast(ray, hitResult, farClipPlane)) {
                         this._updateRaycast(hitResult.component, pointer);
                         return;