@galacean/engine-ui 2.0.0-alpha.46 → 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/module.js CHANGED
@@ -1,4 +1,4 @@
1
- import { EntityModifyFlags, ignoreClone, DisorderedArray, Component, Matrix, BoundingBox, Utils as Utils$1, TransformModifyFlags, Transform, Vector2, Rect, MathUtil, Vector3, Plane, ShaderProperty, dependentComponents, DependentMode, VertexMergeBatcher, ShaderMacroCollection, Renderer, Vector4, Color, RendererUpdateFlags, Script, CameraModifyFlags, Logger, Signal, SpriteDrawMode, SpriteModifyFlags, SpriteTileMode, TiledSpriteAssembler, SlicedSpriteAssembler, SimpleSpriteAssembler, ShaderData, ShaderDataGroup, TextUtils, Engine, TextVerticalAlignment, TextHorizontalAlignment, OverflowMode, CharRenderInfo, FontStyle, ReferResource, DataObject, registerPointerEventEmitter, PointerEventEmitter, CameraClearFlags, Material, Entity, Loader, Shader } from '@galacean/engine';
1
+ import { EntityModifyFlags, ignoreClone, DisorderedArray, Component, Matrix, BoundingBox, Utils as Utils$1, TransformModifyFlags, Transform, Vector2, Rect, MathUtil, Vector3, Plane, ShaderProperty, dependentComponents, DependentMode, VertexMergeBatcher, ShaderMacroCollection, Renderer, Vector4, Color, RendererUpdateFlags, Script, CameraModifyFlags, Logger, Signal, SpriteDrawMode, SpriteModifyFlags, SpriteTileMode, TiledSpriteAssembler, SlicedSpriteAssembler, SimpleSpriteAssembler, ShaderData, ShaderDataGroup, TextUtils, Engine, TextVerticalAlignment, TextHorizontalAlignment, OverflowMode, CharRenderInfo, FontStyle, ReferResource, DataObject, registerPointerEventEmitter, PointerEventEmitter, Layer, CameraClearFlags, Material, Entity, Loader, Shader } from '@galacean/engine';
2
2
 
3
3
  function _defineProperties(target, props) {
4
4
  for (var i = 0; i < props.length; i++) {
@@ -565,14 +565,16 @@ var SortEntry = function SortEntry() {
565
565
  }({});
566
566
 
567
567
  /**
568
- * Resolution adaptation mode.
569
- * @remarks Only effective in screen space.
568
+ * Resolution adaptation in screen space.
569
+ * Scale ratios are available size / `referenceResolution` per axis.
570
+ * Available size comes from the canvas in Overlay mode or the camera's standard projection at `distance`
571
+ * in Camera mode; a custom `Camera.projectionMatrix` is not reflected.
570
572
  */ var ResolutionAdaptationMode = /*#__PURE__*/ function(ResolutionAdaptationMode) {
571
573
  /** Adapt based on width.(`referenceResolution.x`) */ ResolutionAdaptationMode[ResolutionAdaptationMode["WidthAdaptation"] = 0] = "WidthAdaptation";
572
574
  /** Adapt based on height.(`referenceResolution.y`) */ ResolutionAdaptationMode[ResolutionAdaptationMode["HeightAdaptation"] = 1] = "HeightAdaptation";
573
575
  /** Adapt based on both width and height.(`referenceResolution`) */ ResolutionAdaptationMode[ResolutionAdaptationMode["BothAdaptation"] = 2] = "BothAdaptation";
574
- /** Adapt to the side with a larger ratio. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ExpandAdaptation"] = 3] = "ExpandAdaptation";
575
- /** Adapt to the side with smaller ratio. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ShrinkAdaptation"] = 4] = "ShrinkAdaptation";
576
+ /** Use the smaller scale ratio to fit the reference rectangle; the UICanvas expands on the other axis. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ExpandAdaptation"] = 3] = "ExpandAdaptation";
577
+ /** Use the larger scale ratio to cover the available area; the reference rectangle may overflow. */ ResolutionAdaptationMode[ResolutionAdaptationMode["ShrinkAdaptation"] = 4] = "ShrinkAdaptation";
576
578
  return ResolutionAdaptationMode;
577
579
  }({});
578
580
 
@@ -773,7 +775,8 @@ var SortEntry = function SortEntry() {
773
775
  {
774
776
  key: "size",
775
777
  get: /**
776
- * Width and height of UI element.
778
+ * Width and height in local units, before transform scaling.
779
+ * Screen-space units are pixels at the root canvas's {@link UICanvas.referenceResolution}; world-space units are scene units.
777
780
  */ function get() {
778
781
  return this._size;
779
782
  },
@@ -1102,7 +1105,6 @@ var UIRenderer = /*#__PURE__*/ function(Renderer) {
1102
1105
  /**
1103
1106
  * @internal
1104
1107
  */ _proto._raycast = function _raycast(ray, out, distance) {
1105
- if (distance === void 0) distance = Number.MAX_SAFE_INTEGER;
1106
1108
  var plane = UIRenderer._tempPlane;
1107
1109
  var transform = this._transformEntity.transform;
1108
1110
  var normal = plane.normal.copyFrom(transform.worldForward);
@@ -1469,12 +1471,11 @@ var UICanvas = /*#__PURE__*/ function(Component) {
1469
1471
  var _proto = UICanvas.prototype;
1470
1472
  /**
1471
1473
  * @internal
1472
- */ _proto._raycast = function _raycast(ray, out, distance) {
1473
- if (distance === void 0) distance = Number.MAX_SAFE_INTEGER;
1474
+ */ _proto._raycast = function _raycast(ray, out, distance, cullingMask) {
1474
1475
  var renderers = this._getRenderers();
1475
1476
  for(var i = renderers.length - 1; i >= 0; i--){
1476
1477
  var element = renderers[i];
1477
- if (element.raycastEnabled && element._raycast(ray, out, distance)) {
1478
+ if ((cullingMask & element.entity.layer) !== 0 && element.raycastEnabled && element._raycast(ray, out, distance)) {
1478
1479
  return true;
1479
1480
  }
1480
1481
  }
@@ -1498,10 +1499,12 @@ var UICanvas = /*#__PURE__*/ function(Component) {
1498
1499
  /**
1499
1500
  * @internal
1500
1501
  */ _proto._canDispatchEvent = function _canDispatchEvent(camera) {
1501
- var realMode = this._realRenderMode;
1502
- if (realMode === CanvasRenderMode.ScreenSpaceOverlay) {
1502
+ if (this._realRenderMode === CanvasRenderMode.ScreenSpaceOverlay) {
1503
1503
  return true;
1504
1504
  }
1505
+ if (!(camera.cullingMask & this.entity.layer)) {
1506
+ return false;
1507
+ }
1505
1508
  var assignedCamera = this._camera;
1506
1509
  // @ts-ignore
1507
1510
  return !assignedCamera || !assignedCamera._phasedActiveInScene || assignedCamera === camera;
@@ -1520,11 +1523,9 @@ var UICanvas = /*#__PURE__*/ function(Component) {
1520
1523
  var renderers = this._getRenderers();
1521
1524
  for(var i = 0, n = renderers.length; i < n; i++){
1522
1525
  var renderer = renderers[i];
1523
- // Filter by camera culling mask
1524
1526
  if (!(cullingMask & renderer.entity.layer)) {
1525
1527
  continue;
1526
1528
  }
1527
- // Filter by camera frustum
1528
1529
  if (enableFrustumCulling) {
1529
1530
  switch(mode){
1530
1531
  case CanvasRenderMode.ScreenSpaceOverlay:
@@ -1865,7 +1866,8 @@ var UICanvas = /*#__PURE__*/ function(Component) {
1865
1866
  {
1866
1867
  key: "referenceResolutionPerUnit",
1867
1868
  get: /**
1868
- * The conversion ratio between reference resolution and unit for UI elements in this canvas.
1869
+ * Local UI units per sprite world unit for sliced borders and tile sizing.
1870
+ * One glyph pixel maps to `referenceResolutionPerUnit / 100` local UI units.
1869
1871
  */ function get() {
1870
1872
  return this._referenceResolutionPerUnit;
1871
1873
  },
@@ -1881,7 +1883,8 @@ var UICanvas = /*#__PURE__*/ function(Component) {
1881
1883
  {
1882
1884
  key: "referenceResolution",
1883
1885
  get: /**
1884
- * The reference resolution of the UI canvas in `ScreenSpaceCamera` and `ScreenSpaceOverlay` mode.
1886
+ * Design resolution in pixels for {@link CanvasRenderMode.ScreenSpaceCamera} and {@link CanvasRenderMode.ScreenSpaceOverlay}.
1887
+ * The root canvas adapts it to the camera viewport or engine canvas using {@link UICanvas.resolutionAdaptationMode}.
1885
1888
  */ function get() {
1886
1889
  return this._referenceResolution;
1887
1890
  },
@@ -1969,7 +1972,7 @@ var UICanvas = /*#__PURE__*/ function(Component) {
1969
1972
  {
1970
1973
  key: "sortOrder",
1971
1974
  get: /**
1972
- * The rendering order priority of the UI canvas in `ScreenSpaceOverlay` mode.
1975
+ * The rendering priority of the canvas.
1973
1976
  */ function get() {
1974
1977
  return this._sortOrder;
1975
1978
  },
@@ -2741,7 +2744,9 @@ __decorate([
2741
2744
  {
2742
2745
  key: "fontSize",
2743
2746
  get: /**
2744
- * The font size of the Text.
2747
+ * Font size in pixels, used for glyph rasterization.
2748
+ * Glyph pixel dimensions are converted to local UI units using the root canvas's
2749
+ * {@link UICanvas.referenceResolutionPerUnit}.
2745
2750
  */ function get() {
2746
2751
  return this._fontSize;
2747
2752
  },
@@ -3268,13 +3273,12 @@ var UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
3268
3273
  var scene = scenes[i];
3269
3274
  if (!scene.isActive || scene.destroyed) continue;
3270
3275
  var componentsManager = scene._componentsManager;
3271
- // Overlay Canvas
3272
3276
  var canvasElements = componentsManager._overlayCanvases;
3273
- // Screen to world ( Assume that world units have a one-to-one relationship with pixel units )
3277
+ // Convert screen coordinates to overlay coordinates.
3274
3278
  ray.origin.set(position.x, scene.engine.canvas.height - position.y, 1);
3275
3279
  ray.direction.set(0, 0, -1);
3276
3280
  for(var j = canvasElements.length - 1; j >= 0; j--){
3277
- if (canvasElements.get(j)._raycast(ray, hitResult)) {
3281
+ if (canvasElements.get(j)._raycast(ray, hitResult, Number.MAX_SAFE_INTEGER, Layer.Everything)) {
3278
3282
  this._updateRaycast(hitResult.component, pointer);
3279
3283
  return;
3280
3284
  }
@@ -3288,26 +3292,22 @@ var UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
3288
3292
  continue;
3289
3293
  }
3290
3294
  camera.screenPointToRay(pointer.position, ray);
3291
- // Other canvases
3292
- var isOrthographic = camera.isOrthographic;
3293
- var _camera_entity_transform = camera.entity.transform, cameraPosition = _camera_entity_transform.worldPosition, cameraForward = _camera_entity_transform.worldForward;
3294
- // Sort by rendering order
3295
3295
  canvasElements = componentsManager._canvases;
3296
+ var isOrthographic = camera.isOrthographic, farClipPlane = camera.farClipPlane, cullingMask = camera.cullingMask;
3297
+ var _camera_entity_transform = camera.entity.transform, worldPosition = _camera_entity_transform.worldPosition, worldForward = _camera_entity_transform.worldForward;
3296
3298
  for(var k = 0, n = canvasElements.length; k < n; k++){
3297
- canvasElements.get(k)._updateSortDistance(isOrthographic, cameraPosition, cameraForward);
3299
+ canvasElements.get(k)._updateSortDistance(isOrthographic, worldPosition, worldForward);
3298
3300
  }
3299
- canvasElements.sort(function(a, b) {
3300
- return a.sortOrder - b.sortOrder || a._sortDistance - b._sortDistance;
3301
- });
3301
+ canvasElements.sort(UIPointerEventEmitter._compareRaycastOrder);
3302
+ // Update registry indices after sorting.
3302
3303
  for(var k1 = 0, n1 = canvasElements.length; k1 < n1; k1++){
3303
3304
  canvasElements.get(k1)._canvasIndex = k1;
3304
3305
  }
3305
- var farClipPlane = camera.farClipPlane;
3306
- // Post-rendering first detection
3306
+ // Fully tied canvases may differ in hit and draw order.
3307
3307
  for(var k2 = 0, n2 = canvasElements.length; k2 < n2; k2++){
3308
3308
  var canvas = canvasElements.get(k2);
3309
3309
  if (!canvas._canDispatchEvent(camera)) continue;
3310
- if (canvas._raycast(ray, hitResult, farClipPlane)) {
3310
+ if (canvas._raycast(ray, hitResult, farClipPlane, cullingMask)) {
3311
3311
  this._updateRaycast(hitResult.component, pointer);
3312
3312
  return;
3313
3313
  }
@@ -3468,6 +3468,9 @@ var UIPointerEventEmitter = /*#__PURE__*/ function(PointerEventEmitter1) {
3468
3468
  fireEvent(path[i], eventData);
3469
3469
  }
3470
3470
  };
3471
+ UIPointerEventEmitter._compareRaycastOrder = function _compareRaycastOrder(a, b) {
3472
+ return b.sortOrder - a.sortOrder || a._sortDistance - b._sortDistance;
3473
+ };
3471
3474
  return UIPointerEventEmitter;
3472
3475
  }(PointerEventEmitter);
3473
3476
  UIPointerEventEmitter._MAX_PATH_DEPTH = 2048;