@galacean/effects-plugin-rich-text 2.8.0-alpha.0 → 2.8.0-alpha.2

package/dist/index.mjs

@@ -3,11 +3,11 @@
  * Description: Galacean Effects player rich text plugin
  * Author: Ant Group CO., Ltd.
  * Contributors: 云垣
- * Version: v2.8.0-alpha.0
+ * Version: v2.8.0-alpha.2
  */
 
 import * as EFFECTS from '@galacean/effects';
-import { AbstractPlugin, spec, effectsClass, applyMixins, TextComponentBase, TextStyle, math, assertExist, MaskableGraphic, registerPlugin, VFXItem, logger } from '@galacean/effects';
+import { AbstractPlugin, spec, effectsClass, applyMixins, TextComponentBase, TextStyle, math, assertExist, MaskableGraphic, registerPlugin, logger } from '@galacean/effects';
 
 function _set_prototype_of(o, p) {
     _set_prototype_of = Object.setPrototypeOf || function setPrototypeOf(o, p) {
@@ -337,7 +337,7 @@ var RichTextLayout = /*#__PURE__*/ function() {
         var size = options.size, _options_textOverflow = options.textOverflow, textOverflow = _options_textOverflow === void 0 ? spec.TextOverflow.clip : _options_textOverflow, _options_textVerticalAlign = options.textVerticalAlign, textVerticalAlign = _options_textVerticalAlign === void 0 ? spec.TextVerticalAlign.middle : _options_textVerticalAlign, _options_textAlign = options.textAlign, textAlign = _options_textAlign === void 0 ? spec.TextAlignment.left : _options_textAlign, _options_letterSpace = options.letterSpace, letterSpace = _options_letterSpace === void 0 ? 0 : _options_letterSpace, _options_lineHeight = options.lineHeight, lineHeight = _options_lineHeight === void 0 ? 0.571 : _options_lineHeight, _options_wrapEnabled = options.wrapEnabled, wrapEnabled = _options_wrapEnabled === void 0 ? false : _options_wrapEnabled, _options_maxTextWidth = options.maxTextWidth, maxTextWidth = _options_maxTextWidth === void 0 ? 350 : _options_maxTextWidth, _options_maxTextHeight = options.maxTextHeight, maxTextHeight = _options_maxTextHeight === void 0 ? 1000 : _options_maxTextHeight, _options_sizeMode = options.sizeMode, sizeMode = _options_sizeMode === void 0 ? spec.TextSizeMode.autoWidth : _options_sizeMode, _options_useLegacyRichText = options.// @ts-expect-error 兼容旧版
         useLegacyRichText, useLegacyRichText = _options_useLegacyRichText === void 0 ? false : _options_useLegacyRichText;
         this.letterSpace = letterSpace;
-        this.lineHeight = lineHeight * 300;
+        this.lineHeight = lineHeight;
         this.useLegacyRichText = useLegacyRichText;
         this.overflow = textOverflow;
         this.textVerticalAlign = textVerticalAlign;
@@ -356,6 +356,7 @@ var RichTextLayout = /*#__PURE__*/ function() {
         var offsetY = (lineHeight - fontSize) / 3;
         // 计算基础偏移量
         var baseOffset = fontSize + outlineWidth * fontScale;
+        // 除去首行之外的总高度，用于 bottom 对齐时将第一行向上偏移
         var commonCalculation = totalLineHeight !== undefined ? totalLineHeight : lineHeight * (lineCount - 1);
         var offsetResult = 0;
         switch(this.textVerticalAlign){
@@ -436,7 +437,10 @@ var RichTextLayout = /*#__PURE__*/ function() {
                 return 0;
         }
     };
-    _proto.setSize = function setSize(width, height) {
+    /**
+   * 设置文本框尺寸
+   * - 不包含 fontScale 缩放
+   */ _proto.setSize = function setSize(width, height) {
         this.width = width;
         this.height = height;
     };
@@ -1159,7 +1163,9 @@ var RichTextComponent = /*#__PURE__*/ function(MaskableGraphic) {
         });
         program(text);
     };
-    _proto.updateWithOptions = function updateWithOptions(options) {
+    /**
+   * 根据配置更新文本样式和布局
+   */ _proto.updateWithOptions = function updateWithOptions(options) {
         this.textStyle = new TextStyle(options);
         this.textLayout = new RichTextLayout(options);
         this.text = options.text ? options.text.toString() : " ";
@@ -1177,7 +1183,10 @@ var RichTextComponent = /*#__PURE__*/ function(MaskableGraphic) {
         }
         this.updateTexture();
     };
-    _proto.updateTexture = function updateTexture(flipY) {
+    /**
+   * 更新文本
+   * @returns
+   */ _proto.updateTexture = function updateTexture(flipY) {
         if (flipY === void 0) flipY = true;
         if (!this.isDirty || !this.context || !this.canvas || !this.textStyle || !this.textLayout) {
             return;
@@ -1578,6 +1587,12 @@ var RichTextComponent = /*#__PURE__*/ function(MaskableGraphic) {
    */ _proto.setFontSize = function setFontSize(value) {
         this.unsupported("setFontSize");
     };
+    /**
+   * @deprecated 2.8.0 本方法已废弃，请使用 setTextVerticalAlign 替代。
+   */ _proto.setTextBaseline = function setTextBaseline(value) {
+        console.warn("setTextBaseline 已废弃，请改用 setTextVerticalAlign。" + "本次调用将转调用 setTextVerticalAlign。");
+        this.setTextVerticalAlign(value);
+    };
     return RichTextComponent;
 }(MaskableGraphic);
 RichTextComponent = __decorate([
@@ -1589,8 +1604,8 @@ applyMixins(RichTextComponent, [
 
 /**
  * 插件版本号
- */ var version = "2.8.0-alpha.0";
-registerPlugin("rich-text", RichTextLoader, VFXItem);
+ */ var version = "2.8.0-alpha.2";
+registerPlugin("rich-text", RichTextLoader);
 logger.info("Plugin rich text version: " + version + ".");
 if (version !== EFFECTS.version) {
     console.error("注意：请统一 RichText 插件与 Player 版本，不统一的版本混用会有不可预知的后果！", "\nAttention: Please ensure the RichText plugin is synchronized with the Player version. Mixing and matching incompatible versions may result in unpredictable consequences!");