@galacean/engine-ui 2.0.0-alpha.45 → 2.0.0-alpha.47

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/dist/main.js CHANGED
@@ -569,14 +569,16 @@ var SortEntry = function SortEntry() {
569
569
  }({});
570
570
 
571
571
  /**
572
- * Resolution adaptation mode.
573
- * @remarks Only effective in screen space.
572
+ * Resolution adaptation in screen space.
573
+ * Scale ratios are available size / `referenceResolution` per axis.
574
+ * Available size comes from the canvas in Overlay mode or the camera's standard projection at `distance`
575
+ * in Camera mode; a custom `Camera.projectionMatrix` is not reflected.
574
576
  */ var ResolutionAdaptationMode = /*#__PURE__*/ function(ResolutionAdaptationMode) {
575
577
  /** Adapt based on width.(`referenceResolution.x`) */ ResolutionAdaptationMode[ResolutionAdaptationMode["WidthAdaptation"] = 0] = "WidthAdaptation";
576
578
  /** Adapt based on height.(`referenceResolution.y`) */ ResolutionAdaptationMode[ResolutionAdaptationMode["HeightAdaptation"] = 1] = "HeightAdaptation";
577
579
  /** Adapt based on both width and height.(`referenceResolution`) */ ResolutionAdaptationMode[ResolutionAdaptationMode["BothAdaptation"] = 2] = "BothAdaptation";
578
- /** Adapt to the side with a larger ratio. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ExpandAdaptation"] = 3] = "ExpandAdaptation";
579
- /** Adapt to the side with smaller ratio. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ShrinkAdaptation"] = 4] = "ShrinkAdaptation";
580
+ /** Use the smaller scale ratio to fit the reference rectangle; the UICanvas expands on the other axis. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ExpandAdaptation"] = 3] = "ExpandAdaptation";
581
+ /** Use the larger scale ratio to cover the available area; the reference rectangle may overflow. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ShrinkAdaptation"] = 4] = "ShrinkAdaptation";
580
582
  return ResolutionAdaptationMode;
581
583
  }({});
582
584
 
@@ -777,7 +779,8 @@ var SortEntry = function SortEntry() {
777
779
  {
778
780
  key: "size",
779
781
  get: /**
780
- * Width and height of UI element.
782
+ * Width and height in local units, before transform scaling.
783
+ * Screen-space units are pixels at the root canvas's {@link UICanvas.referenceResolution}; world-space units are scene units.
781
784
  */ function get() {
782
785
  return this._size;
783
786
  },
@@ -1106,7 +1109,6 @@ exports.UIRenderer = /*#__PURE__*/ function(Renderer) {
1106
1109
  /**
1107
1110
  * @internal
1108
1111
  */ _proto._raycast = function _raycast(ray, out, distance) {
1109
- if (distance === void 0) distance = Number.MAX_SAFE_INTEGER;
1110
1112
  var plane = UIRenderer._tempPlane;
1111
1113
  var transform = this._transformEntity.transform;
1112
1114
  var normal = plane.normal.copyFrom(transform.worldForward);
@@ -1473,12 +1475,11 @@ exports.UICanvas = /*#__PURE__*/ function(Component) {
1473
1475
  var _proto = UICanvas.prototype;
1474
1476
  /**
1475
1477
  * @internal
1476
- */ _proto._raycast = function _raycast(ray, out, distance) {
1477
- if (distance === void 0) distance = Number.MAX_SAFE_INTEGER;
1478
+ */ _proto._raycast = function _raycast(ray, out, distance, cullingMask) {
1478
1479
  var renderers = this._getRenderers();
1479
1480
  for(var i = renderers.length - 1; i >= 0; i--){
1480
1481
  var element = renderers[i];
1481
- if (element.raycastEnabled && element._raycast(ray, out, distance)) {
1482
+ if ((cullingMask & element.entity.layer) !== 0 && element.raycastEnabled && element._raycast(ray, out, distance)) {
1482
1483
  return true;
1483
1484
  }
1484
1485
  }
@@ -1502,10 +1503,12 @@ exports.UICanvas = /*#__PURE__*/ function(Component) {
1502
1503
  /**
1503
1504
  * @internal
1504
1505
  */ _proto._canDispatchEvent = function _canDispatchEvent(camera) {
1505
- var realMode = this._realRenderMode;
1506
- if (realMode === CanvasRenderMode.ScreenSpaceOverlay) {
1506
+ if (this._realRenderMode === CanvasRenderMode.ScreenSpaceOverlay) {
1507
1507
  return true;
1508
1508
  }
1509
+ if (!(camera.cullingMask & this.entity.layer)) {
1510
+ return false;
1511
+ }
1509
1512
  var assignedCamera = this._camera;
1510
1513
  // @ts-ignore
1511
1514
  return !assignedCamera || !assignedCamera._phasedActiveInScene || assignedCamera === camera;
@@ -1524,11 +1527,9 @@ exports.UICanvas = /*#__PURE__*/ function(Component) {
1524
1527
  var renderers = this._getRenderers();
1525
1528
  for(var i = 0, n = renderers.length; i < n; i++){
1526
1529
  var renderer = renderers[i];
1527
- // Filter by camera culling mask
1528
1530
  if (!(cullingMask & renderer.entity.layer)) {
1529
1531
  continue;
1530
1532
  }
1531
- // Filter by camera frustum
1532
1533
  if (enableFrustumCulling) {
1533
1534
  switch(mode){
1534
1535
  case CanvasRenderMode.ScreenSpaceOverlay:
@@ -1869,7 +1870,8 @@ exports.UICanvas = /*#__PURE__*/ function(Component) {
1869
1870
  {
1870
1871
  key: "referenceResolutionPerUnit",
1871
1872
  get: /**
1872
- * The conversion ratio between reference resolution and unit for UI elements in this canvas.
1873
+ * Local UI units per sprite world unit for sliced borders and tile sizing.
1874
+ * One glyph pixel maps to `referenceResolutionPerUnit / 100` local UI units.
1873
1875
  */ function get() {
1874
1876
  return this._referenceResolutionPerUnit;
1875
1877
  },
@@ -1885,7 +1887,8 @@ exports.UICanvas = /*#__PURE__*/ function(Component) {
1885
1887
  {
1886
1888
  key: "referenceResolution",
1887
1889
  get: /**
1888
- * The reference resolution of the UI canvas in `ScreenSpaceCamera` and `ScreenSpaceOverlay` mode.
1890
+ * Design resolution in pixels for {@link CanvasRenderMode.ScreenSpaceCamera} and {@link CanvasRenderMode.ScreenSpaceOverlay}.
1891
+ * The root canvas adapts it to the camera viewport or engine canvas using {@link UICanvas.resolutionAdaptationMode}.
1889
1892
  */ function get() {
1890
1893
  return this._referenceResolution;
1891
1894
  },
@@ -1973,7 +1976,7 @@ exports.UICanvas = /*#__PURE__*/ function(Component) {
1973
1976
  {
1974
1977
  key: "sortOrder",
1975
1978
  get: /**
1976
- * The rendering order priority of the UI canvas in `ScreenSpaceOverlay` mode.
1979
+ * The rendering priority of the canvas.
1977
1980
  */ function get() {
1978
1981
  return this._sortOrder;
1979
1982
  },
@@ -2745,7 +2748,9 @@ __decorate([
2745
2748
  {
2746
2749
  key: "fontSize",
2747
2750
  get: /**
2748
- * The font size of the Text.
2751
+ * Font size in pixels, used for glyph rasterization.
2752
+ * Glyph pixel dimensions are converted to local UI units using the root canvas's
2753
+ * {@link UICanvas.referenceResolutionPerUnit}.
2749
2754
  */ function get() {
2750
2755
  return this._fontSize;
2751
2756
  },
@@ -3272,13 +3277,12 @@ exports.UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
3272
3277
  var scene = scenes[i];
3273
3278
  if (!scene.isActive || scene.destroyed) continue;
3274
3279
  var componentsManager = scene._componentsManager;
3275
- // Overlay Canvas
3276
3280
  var canvasElements = componentsManager._overlayCanvases;
3277
- // Screen to world ( Assume that world units have a one-to-one relationship with pixel units )
3281
+ // Convert screen coordinates to overlay coordinates.
3278
3282
  ray.origin.set(position.x, scene.engine.canvas.height - position.y, 1);
3279
3283
  ray.direction.set(0, 0, -1);
3280
3284
  for(var j = canvasElements.length - 1; j >= 0; j--){
3281
- if (canvasElements.get(j)._raycast(ray, hitResult)) {
3285
+ if (canvasElements.get(j)._raycast(ray, hitResult, Number.MAX_SAFE_INTEGER, engine.Layer.Everything)) {
3282
3286
  this._updateRaycast(hitResult.component, pointer);
3283
3287
  return;
3284
3288
  }
@@ -3292,26 +3296,22 @@ exports.UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
3292
3296
  continue;
3293
3297
  }
3294
3298
  camera.screenPointToRay(pointer.position, ray);
3295
- // Other canvases
3296
- var isOrthographic = camera.isOrthographic;
3297
- var _camera_entity_transform = camera.entity.transform, cameraPosition = _camera_entity_transform.worldPosition, cameraForward = _camera_entity_transform.worldForward;
3298
- // Sort by rendering order
3299
3299
  canvasElements = componentsManager._canvases;
3300
+ var isOrthographic = camera.isOrthographic, farClipPlane = camera.farClipPlane, cullingMask = camera.cullingMask;
3301
+ var _camera_entity_transform = camera.entity.transform, worldPosition = _camera_entity_transform.worldPosition, worldForward = _camera_entity_transform.worldForward;
3300
3302
  for(var k = 0, n = canvasElements.length; k < n; k++){
3301
- canvasElements.get(k)._updateSortDistance(isOrthographic, cameraPosition, cameraForward);
3303
+ canvasElements.get(k)._updateSortDistance(isOrthographic, worldPosition, worldForward);
3302
3304
  }
3303
- canvasElements.sort(function(a, b) {
3304
- return a.sortOrder - b.sortOrder || a._sortDistance - b._sortDistance;
3305
- });
3305
+ canvasElements.sort(UIPointerEventEmitter._compareRaycastOrder);
3306
+ // Update registry indices after sorting.
3306
3307
  for(var k1 = 0, n1 = canvasElements.length; k1 < n1; k1++){
3307
3308
  canvasElements.get(k1)._canvasIndex = k1;
3308
3309
  }
3309
- var farClipPlane = camera.farClipPlane;
3310
- // Post-rendering first detection
3310
+ // Fully tied canvases may differ in hit and draw order.
3311
3311
  for(var k2 = 0, n2 = canvasElements.length; k2 < n2; k2++){
3312
3312
  var canvas = canvasElements.get(k2);
3313
3313
  if (!canvas._canDispatchEvent(camera)) continue;
3314
- if (canvas._raycast(ray, hitResult, farClipPlane)) {
3314
+ if (canvas._raycast(ray, hitResult, farClipPlane, cullingMask)) {
3315
3315
  this._updateRaycast(hitResult.component, pointer);
3316
3316
  return;
3317
3317
  }
@@ -3472,6 +3472,9 @@ exports.UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
3472
3472
  fireEvent(path[i], eventData);
3473
3473
  }
3474
3474
  };
3475
+ UIPointerEventEmitter._compareRaycastOrder = function _compareRaycastOrder(a, b) {
3476
+ return b.sortOrder - a.sortOrder || a._sortDistance - b._sortDistance;
3477
+ };
3475
3478
  return UIPointerEventEmitter;
3476
3479
  }(engine.PointerEventEmitter);
3477
3480
  exports.UIPointerEventEmitter._MAX_PATH_DEPTH = 2048;