CCLabel.js

/****************************************************************************
 Copyright (c) 2013-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://www.cocos.com/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated engine source code (the "Software"), a limited,
  worldwide, royalty-free, non-assignable, revocable and non-exclusive license
 to use Cocos Creator solely to develop games on your target platforms. You shall
  not use Cocos Creator software for developing other software or tools that's
  used for developing games. You are not granted to publish, distribute,
  sublicense, and/or sell copies of Cocos Creator.

 The software or tools in this License Agreement are licensed, not sold.
 Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/

const macro = require('../platform/CCMacro');
const RenderComponent = require('./CCRenderComponent');
const Material = require('../assets/material/CCMaterial');
const LabelFrame = require('../renderer/utils/label/label-frame');
const BlendFunc = require('../utils/blend-func');
const deleteFromDynamicAtlas = require('../renderer/utils/utils').deleteFromDynamicAtlas;

/**
 * !#en Enum for text alignment.
 * !#zh 文本横向对齐类型
 * @enum Label.HorizontalAlign
 */
/**
 * !#en Alignment left for text.
 * !#zh 文本内容左对齐。
 * @property {Number} LEFT
 */
/**
 * !#en Alignment center for text.
 * !#zh 文本内容居中对齐。
 * @property {Number} CENTER
 */
/**
 * !#en Alignment right for text.
 * !#zh 文本内容右边对齐。
 * @property {Number} RIGHT
 */
const HorizontalAlign = macro.TextAlignment;

/**
 * !#en Enum for vertical text alignment.
 * !#zh 文本垂直对齐类型
 * @enum Label.VerticalAlign
 */
/**
 * !#en Vertical alignment top for text.
 * !#zh 文本顶部对齐。
 * @property {Number} TOP
 */
/**
 * !#en Vertical alignment center for text.
 * !#zh 文本居中对齐。
 * @property {Number} CENTER
 */
/**
 * !#en Vertical alignment bottom for text.
 * !#zh 文本底部对齐。
 * @property {Number} BOTTOM
 */
const VerticalAlign = macro.VerticalTextAlignment;

/**
 * !#en Enum for Overflow.
 * !#zh Overflow 类型
 * @enum Label.Overflow
 */
/**
 * !#en NONE.
 * !#zh 不做任何限制。
 * @property {Number} NONE
 */
/**
 * !#en In CLAMP mode, when label content goes out of the bounding box, it will be clipped.
 * !#zh CLAMP 模式中，当文本内容超出边界框时，多余的会被截断。
 * @property {Number} CLAMP
 */
/**
 * !#en In SHRINK mode, the font size will change dynamically to adapt the content size. This mode may takes up more CPU resources when the label is refreshed.
 * !#zh SHRINK 模式，字体大小会动态变化，以适应内容大小。这个模式在文本刷新的时候可能会占用较多 CPU 资源。
 * @property {Number} SHRINK
 */
/**
 * !#en In RESIZE_HEIGHT mode, you can only change the width of label and the height is changed automatically.
 * !#zh 在 RESIZE_HEIGHT 模式下，只能更改文本的宽度，高度是自动改变的。
 * @property {Number} RESIZE_HEIGHT
 */
const Overflow = cc.Enum({
    NONE: 0,
    CLAMP: 1,
    SHRINK: 2,
    RESIZE_HEIGHT: 3
});

/**
 * !#en Enum for font type.
 * !#zh Type 类型
 * @enum Label.Type
 */
/**
 * !#en The TTF font type.
 * !#zh TTF字体
 * @property {Number} TTF
 */
/**
 * !#en The bitmap font type.
 * !#zh 位图字体
 * @property {Number} BMFont
 */
/**
 * !#en The system font type.
 * !#zh 系统字体
 * @property {Number} SystemFont
 */

/**
 * !#en Enum for cache mode.
 * !#zh CacheMode 类型
 * @enum Label.CacheMode
 */
 /**
 * !#en Do not do any caching.
 * !#zh 不做任何缓存。
 * @property {Number} NONE
 */
/**
 * !#en In BITMAP mode, cache the label as a static image and add it to the dynamic atlas for batch rendering, and can batching with Sprites using broken images.
 * !#zh BITMAP 模式，将 label 缓存成静态图像并加入到动态图集，以便进行批次合并，可与使用碎图的 Sprite 进行合批（注：动态图集在 Chrome 以及微信小游戏暂时关闭，该功能无效）。
 * @property {Number} BITMAP
 */
/**
 * !#en In CHAR mode, split text into characters and cache characters into a dynamic atlas which the size of 2048*2048. 
 * !#zh CHAR 模式，将文本拆分为字符，并将字符缓存到一张单独的大小为 2048*2048 的图集中进行重复使用，不再使用动态图集（注：当图集满时将不再进行缓存，暂时不支持 SHRINK 自适应文本尺寸（后续完善））。
 * @property {Number} CHAR
 */
const CacheMode = cc.Enum({
    NONE: 0,
    BITMAP: 1,
    CHAR: 2,
});

const BOLD_FLAG = 1 << 0;
const ITALIC_FLAG = 1 << 1;
const UNDERLINE_FLAG = 1 << 2;

/**
 * !#en The Label Component.
 * !#zh 文字标签组件
 * @class Label
 * @extends RenderComponent
 */
let Label = cc.Class({
    name: 'cc.Label',
    extends: RenderComponent,
    mixins: [BlendFunc],

    ctor () {
        if (CC_EDITOR) {
            this._userDefinedFont = null;
        }

        this._actualFontSize = 0;
        this._assemblerData = null;

        this._frame = null;
        this._ttfTexture = null;
        this._letterTexture = null;

        if (cc.game.renderType === cc.game.RENDER_TYPE_CANVAS) {
            this._updateMaterial = this._updateMaterialCanvas;
        }
        else {
            this._updateMaterial = this._updateMaterialWebgl;
        }
    },

    editor: CC_EDITOR && {
        menu: 'i18n:MAIN_MENU.component.renderers/Label',
        help: 'i18n:COMPONENT.help_url.label',
        inspector: 'packages://inspector/inspectors/comps/label.js',
    },

    properties: {
        /**
         * !#en Content string of label.
         * !#zh 标签显示的文本内容。
         * @property {String} string
         */
        _string: {
            default: '',
            formerlySerializedAs: '_N$string',
        },
        string: {
            get () {
                return this._string;
            },
            set (value) {
                let oldValue = this._string;
                this._string = '' + value;

                if (this.string !== oldValue) {
                    this.setVertsDirty();
                }

                this._checkStringEmpty();
            },
            multiline: true,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.string'
        },

        /**
         * !#en Horizontal Alignment of label.
         * !#zh 文本内容的水平对齐方式。
         * @property {Label.HorizontalAlign} horizontalAlign
         */
        horizontalAlign: {
            default: HorizontalAlign.LEFT,
            type: HorizontalAlign,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.horizontal_align',
            notify  (oldValue) {
                if (this.horizontalAlign === oldValue) return;
                this.setVertsDirty();
            },
            animatable: false
        },

        /**
         * !#en Vertical Alignment of label.
         * !#zh 文本内容的垂直对齐方式。
         * @property {Label.VerticalAlign} verticalAlign
         */
        verticalAlign: {
            default: VerticalAlign.TOP,
            type: VerticalAlign,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.vertical_align',
            notify (oldValue) {
                if (this.verticalAlign === oldValue) return;
                this.setVertsDirty();
            },
            animatable: false
        },


        /**
         * !#en The actual rendering font size in shrink mode
         * !#zh SHRINK 模式下面文本实际渲染的字体大小
         * @property {Number} actualFontSize
         */
        actualFontSize: {
            displayName: 'Actual Font Size',
            animatable: false,
            readonly: true,
            get () {
                return this._actualFontSize;
            },
            tooltip: CC_DEV && 'i18n:COMPONENT.label.actualFontSize',
        },

        _fontSize: 40,
        /**
         * !#en Font size of label.
         * !#zh 文本字体大小。
         * @property {Number} fontSize
         */
        fontSize: {
            get () {
                return this._fontSize;
            },
            set (value) {
                if (this._fontSize === value) return;

                this._fontSize = value;
                this.setVertsDirty();
            },
            range: [0, 512],
            tooltip: CC_DEV && 'i18n:COMPONENT.label.font_size',
        },

        /**
         * !#en Font family of label, only take effect when useSystemFont property is true.
         * !#zh 文本字体名称, 只在 useSystemFont 属性为 true 的时候生效。
         * @property {String} fontFamily
         */
        fontFamily: {
            default: "Arial",
            tooltip: CC_DEV && 'i18n:COMPONENT.label.font_family',
            notify (oldValue) {
                if (this.fontFamily === oldValue) return;
                this.setVertsDirty();
            },
            animatable: false
        },

        _lineHeight: 40,
        /**
         * !#en Line Height of label.
         * !#zh 文本行高。
         * @property {Number} lineHeight
         */
        lineHeight: {
            get () {
                return this._lineHeight;
            },
            set (value) {
                if (this._lineHeight === value) return;
                this._lineHeight = value;
                this.setVertsDirty();
            },
            tooltip: CC_DEV && 'i18n:COMPONENT.label.line_height',
        },
        /**
         * !#en Overflow of label.
         * !#zh 文字显示超出范围时的处理方式。
         * @property {Label.Overflow} overflow
         */
        overflow: {
            default: Overflow.NONE,
            type: Overflow,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.overflow',
            notify (oldValue) {
                if (this.overflow === oldValue) return;
                this.setVertsDirty();
            },
            animatable: false
        },

        _enableWrapText: true,
        /**
         * !#en Whether auto wrap label when string width is large than label width.
         * !#zh 是否自动换行。
         * @property {Boolean} enableWrapText
         */
        enableWrapText: {
            get () {
                return this._enableWrapText;
            },
            set (value) {
                if (this._enableWrapText === value) return;

                this._enableWrapText = value;
                this.setVertsDirty();
            },
            animatable: false,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.wrap',
        },

        // 这个保存了旧项目的 file 数据
        _N$file: null,

        /**
         * !#en The font of label.
         * !#zh 文本字体。
         * @property {Font} font
         */
        font: {
            get () {
                return this._N$file;
            },
            set (value) {
                if (this.font === value) return;
                
                //if delete the font, we should change isSystemFontUsed to true
                if (!value) {
                    this._isSystemFontUsed = true;
                }

                if (CC_EDITOR && value) {
                    this._userDefinedFont = value;
                }
                this._N$file = value;
                if (value && this._isSystemFontUsed)
                    this._isSystemFontUsed = false;

                if (!this.enabledInHierarchy) return;

                this._forceUpdateRenderData();
            },
            type: cc.Font,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.font',
            animatable: false
        },

        _isSystemFontUsed: true,

        /**
         * !#en Whether use system font name or not.
         * !#zh 是否使用系统字体。
         * @property {Boolean} useSystemFont
         */
        useSystemFont: {
            get () {
                return this._isSystemFontUsed;
            },
            set (value) {
                if (this._isSystemFontUsed === value) return;
                this._isSystemFontUsed = !!value;
                if (CC_EDITOR) {
                    if (!value && this._userDefinedFont) {
                        this.font = this._userDefinedFont;
                        this.spacingX = this._spacingX;
                        return;
                    }
                }

                if (value) {
                    this.font = null;

                    if (!this.enabledInHierarchy) return;
                    
                    this._forceUpdateRenderData();
                }
                this.markForValidate();
            },
            animatable: false,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.system_font',
        },

        _bmFontOriginalSize: {
            displayName: 'BMFont Original Size',
            get () {
                if (this._N$file instanceof cc.BitmapFont) {
                    return this._N$file.fontSize;
                }
                else {
                    return -1;
                }
            },
            visible: true,
            animatable: false
        },

        _spacingX: 0,

        /**
         * !#en The spacing of the x axis between characters, only take Effect when using bitmap fonts.
         * !#zh 文字之间 x 轴的间距，仅在使用位图字体时生效。
         * @property {Number} spacingX
         */
        spacingX: {
            get () {
                return this._spacingX;
            },
            set (value) {
                this._spacingX = value;
                this.setVertsDirty();
            },
            tooltip: CC_DEV && 'i18n:COMPONENT.label.spacingX',
        },

        //For compatibility with v2.0.x temporary reservation.
        _batchAsBitmap: false,

        /**
         * !#en The cache mode of label. This mode only supports system fonts.
         * !#zh 文本缓存模式, 该模式只支持系统字体。
         * @property {Label.CacheMode} cacheMode
         */
        cacheMode: {
            default: CacheMode.NONE,
            type: CacheMode,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.cacheMode',
            notify (oldValue) {
                if (this.cacheMode === oldValue) return;
                
                if (oldValue === CacheMode.BITMAP && !(this.font instanceof cc.BitmapFont)) {
                    this._frame && this._frame._resetDynamicAtlasFrame();
                }

                if (oldValue === CacheMode.CHAR) {
                    this._ttfTexture = null;
                }

                if (!this.enabledInHierarchy) return;

                this._forceUpdateRenderData();
            },
            animatable: false
        },

        _styleFlags: 0,

        /**
         * !#en Whether enable bold.
         * !#zh 是否启用黑体。
         * @property {Boolean} enableBold
         */
        enableBold: {
            get () {
                return !!(this._styleFlags & BOLD_FLAG);
            },
            set (value) {
                if (value) {
                    this._styleFlags |= BOLD_FLAG;
                } else {
                    this._styleFlags &= ~BOLD_FLAG;
                }

                this.setVertsDirty();
            },
            animatable: false,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.bold'
        },

        /**
         * !#en Whether enable italic.
         * !#zh 是否启用斜体。
         * @property {Boolean} enableItalic
         */
        enableItalic: {
            get () {
                return !!(this._styleFlags & ITALIC_FLAG);
            },
            set (value) {
                if (value) {
                    this._styleFlags |= ITALIC_FLAG;
                } else {
                    this._styleFlags &= ~ITALIC_FLAG;
                }
                
                this.setVertsDirty();
            },
            animatable: false,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.italic'
        },

        /**
         * !#en Whether enable underline.
         * !#zh 是否启用下划线。
         * @property {Boolean} enableUnderline
         */
        enableUnderline: {
            get () {
                return !!(this._styleFlags & UNDERLINE_FLAG);
            },
            set (value) {
                if (value) {
                    this._styleFlags |= UNDERLINE_FLAG;
                } else {
                    this._styleFlags &= ~UNDERLINE_FLAG;
                }

                this.setVertsDirty();
            },
            animatable: false,
            tooltip: CC_DEV && 'i18n:COMPONENT.label.underline'
        },

        _underlineHeight: 0,
        /**
         * !#en The height of underline.
         * !#zh 下划线高度。
         * @property {Number} underlineHeight
         */
        underlineHeight: {
            get () {
                return this._underlineHeight;
            },
            set (value) {
                if (this._underlineHeight === value) return;
                
                this._underlineHeight = value;
                this.setVertsDirty();
            },
            tooltip: CC_DEV && 'i18n:COMPONENT.label.underline_height',
        },
    },

    statics: {
        HorizontalAlign: HorizontalAlign,
        VerticalAlign: VerticalAlign,
        Overflow: Overflow,
        CacheMode: CacheMode,

        _shareAtlas: null,
        /**
         * !#zh 需要保证当前场景中没有使用CHAR缓存的Label才可以清除，否则已渲染的文字没有重新绘制会不显示
         * !#en It can be cleared that need to ensure there is not use the CHAR cache in the current scene. Otherwise, the rendered text will not be displayed without repainting.
         * @method clearCharCache
         * @static
         */
        clearCharCache () {
            if (Label._shareAtlas) {
                Label._shareAtlas.clearAllCache();
            }
        }
    },

    onLoad () {
        // For compatibility with v2.0.x temporary reservation.
        if (this._batchAsBitmap && this.cacheMode === CacheMode.NONE) {
            this.cacheMode = CacheMode.BITMAP;
            this._batchAsBitmap = false;
        }

        if (cc.game.renderType === cc.game.RENDER_TYPE_CANVAS) {
            // CacheMode is not supported in Canvas.
            this.cacheMode = CacheMode.NONE;
        }
    },

    onEnable () {
        this._super();

        // Keep track of Node size
        this.node.on(cc.Node.EventType.SIZE_CHANGED, this._nodeSizeChanged, this);
        this.node.on(cc.Node.EventType.ANCHOR_CHANGED, this.setVertsDirty, this);
        this.node.on(cc.Node.EventType.COLOR_CHANGED, this._nodeColorChanged, this);

        this._forceUpdateRenderData();
    },

    onDisable () {
        this._super();
        this.node.off(cc.Node.EventType.SIZE_CHANGED, this._nodeSizeChanged, this);
        this.node.off(cc.Node.EventType.ANCHOR_CHANGED, this.setVertsDirty, this);
        this.node.off(cc.Node.EventType.COLOR_CHANGED, this._nodeColorChanged, this);
    },

    onDestroy () {
        this._assembler && this._assembler._resetAssemblerData && this._assembler._resetAssemblerData(this._assemblerData);
        this._assemblerData = null;
        this._letterTexture = null;
        if (this._ttfTexture) {
            this._ttfTexture.destroy();
            this._ttfTexture = null;
        }
        this._super();
    },

    onRestore: CC_EDITOR && function () {
        // Because undo/redo will not call onEnable/onDisable,
        // we need call onEnable/onDisable manually to active/disactive children nodes.
        if (this.enabledInHierarchy) {
            this.node._renderComponent = null;
            this.onEnable();
        }
        else {
            this.onDisable();
        }
    },

    _nodeSizeChanged () {
        // Because the content size is automatically updated when overflow is NONE.
        // And this will conflict with the alignment of the CCWidget.
        if (CC_EDITOR || this.overflow !== Overflow.NONE) {
            this.setVertsDirty();
        }
    },

    _nodeColorChanged () {
        if (!(this.font instanceof cc.BitmapFont)) {
            this.setVertsDirty();
        }
    },

    setVertsDirty() {
        if(CC_JSB && this._nativeTTF()) {
            this._assembler && this._assembler.updateRenderData(this)
        }
        this._super();
    },

    _updateColor () {
        if (!(this.font instanceof cc.BitmapFont)) {
            if (!(this._srcBlendFactor === cc.macro.BlendFactor.SRC_ALPHA && this.node._renderFlag & cc.RenderFlow.FLAG_OPACITY)) {
                this.setVertsDirty();
            }
        }
        RenderComponent.prototype._updateColor.call(this);
    },

    _validateRender () {
        if (!this.string) {
            this.disableRender();
            return;
        }

        if (this._materials[0]) {
            let font = this.font;
            if (font instanceof cc.BitmapFont) {
                let spriteFrame = font.spriteFrame;
                if (spriteFrame && 
                    spriteFrame.textureLoaded() &&
                    font._fntConfig) {
                    return;
                }
            }
            else {
                return;
            }
        }

        this.disableRender();
    },

    _resetAssembler () {
        this._resetFrame();
        RenderComponent.prototype._resetAssembler.call(this);
    },

    _resetFrame () {
        if (this._frame && !(this.font instanceof cc.BitmapFont)) {
            deleteFromDynamicAtlas(this, this._frame);
            this._frame = null;
        }
    },

    _checkStringEmpty () {
        this.markForRender(!!this.string);
    },

    _on3DNodeChanged () {
        this._resetAssembler();
        this._applyFontTexture();
    },

    _onBMFontTextureLoaded () {
        this._frame._texture = this.font.spriteFrame._texture;
        this.markForRender(true);
        this._updateMaterial();
        this._assembler && this._assembler.updateRenderData(this);
    },

    _onBlendChanged () {
        if (!this.useSystemFont || !this.enabledInHierarchy) return;
          
        this._forceUpdateRenderData();
    },

    _applyFontTexture () {
        let font = this.font;
        if (font instanceof cc.BitmapFont) {
            let spriteFrame = font.spriteFrame;
            this._frame = spriteFrame;
            if (spriteFrame) {
                spriteFrame.onTextureLoaded(this._onBMFontTextureLoaded, this);
            }
        }
        else {
            if(!this._nativeTTF()){
                if (!this._frame) {
                    this._frame = new LabelFrame();
                }
    
                if (this.cacheMode === CacheMode.CHAR) {
                    this._letterTexture = this._assembler._getAssemblerData();
                    this._frame._refreshTexture(this._letterTexture);
                } else if (!this._ttfTexture) {
                    this._ttfTexture = new cc.Texture2D();
                    this._assemblerData = this._assembler._getAssemblerData();
                    this._ttfTexture.initWithElement(this._assemblerData.canvas);
                } 

                if (this.cacheMode !== CacheMode.CHAR) {
                    this._frame._resetDynamicAtlasFrame();
                    this._frame._refreshTexture(this._ttfTexture);
                    if (this._srcBlendFactor === cc.macro.BlendFactor.ONE && !CC_NATIVERENDERER) {
                        this._ttfTexture.setPremultiplyAlpha(true);
                    }
                }
                this._updateMaterial();
            }
            this._assembler && this._assembler.updateRenderData(this);
        }
        this.markForValidate();
    },

    _updateMaterialCanvas () {
        if (!this._frame) return;
        this._frame._texture._nativeUrl = this.uuid + '_texture';
    },

    _updateMaterialWebgl () {

        let material = this.getMaterial(0);
        if(this._nativeTTF()) {
            if(material) this._assembler._updateTTFMaterial(this)
            return;
        }

        if (!this._frame) return;
        material && material.setProperty('texture', this._frame._texture);

        BlendFunc.prototype._updateMaterial.call(this);
    },

    _forceUseCanvas: false,
 
    _useNativeTTF() {
        return cc.macro.ENABLE_NATIVE_TTF_RENDERER && !this._forceUseCanvas;
    }, 

    _nativeTTF() {
        return this._useNativeTTF() && !!this._assembler && !!this._assembler._updateTTFMaterial;
    },

    _forceUpdateRenderData () {
        this.setVertsDirty();
        this._resetAssembler();
        this._applyFontTexture();
    },

    /**
     * @deprecated `label._enableBold` is deprecated, use `label.enableBold = true` instead please.
     */
    _enableBold (enabled) {
        if (CC_DEBUG) {
            cc.warn('`label._enableBold` is deprecated, use `label.enableBold = true` instead please');
        }
        this.enableBold = !!enabled;
    },

    /**
     * @deprecated `label._enableItalics` is deprecated, use `label.enableItalics = true` instead please.
     */
    _enableItalics (enabled) {
        if (CC_DEBUG) {
            cc.warn('`label._enableItalics` is deprecated, use `label.enableItalics = true` instead please');
        }
        this.enableItalic = !!enabled;
    },

    /**
     * @deprecated `label._enableUnderline` is deprecated, use `label.enableUnderline = true` instead please.
     */
    _enableUnderline (enabled) {
        if (CC_DEBUG) {
            cc.warn('`label._enableUnderline` is deprecated, use `label.enableUnderline = true` instead please');
        }
        this.enableUnderline = !!enabled;
    },
 });

 cc.Label = module.exports = Label;