cocos2dx3.2技术之新字体标签Label浅析

【Label的属性与方法】

Label继承于：

> SpriteBatchNode : 用于加快字体的渲染速度。

> LabelProtocol   : 用于设置Label的字符串内容。

主要函数如下：

//

classCC_DLL Label : publicSpriteBatchNode, publicLabelProtocol

{

/**

 * 字体设置

 *     – setSystemFontName : 字体（字体名字、字体文件）

 *     – setSystemFontSize : 字体大小

 *     – setString         : 字符串内容

 *     – setTextColor      : 文字内容颜色

 **/

    //设置System Font类型的字体（字体名字、字体文件）

    //设置System Font类型的字体大小

    //请不要用于其他Label类型！（TTF、CharMap、BMFont）

    virtualvoidsetSystemFontName(conststd::string& systemFont);

    virtualvoidsetSystemFontSize(floatfontSize);

    virtualconststd::string& getSystemFontName() const{ return_systemFont;}

    virtualfloatgetSystemFontSize() const{ return_systemFontSize;}

    //改变字符串内容并重新渲染

    //注：如果你没有为Label设置TTF/BMFont/CharMap，会产生很大的开销

    virtualvoidsetString(conststd::string& text) override;

    virtualconststd::string& getString() constoverride {  return_originalUTF8String; }

    //设置文字颜色，仅支持TTF和System Font

    //注：区别 Node节点的颜色

    //      Node ::setColor     : Color3B

    //      Label::setTextColor : Color4B

    virtualvoidsetTextColor(constColor4B &color);

    constColor4B& getTextColor() const{ return_textColor; }

/**

 * 获取Label的某个字符

 *     – getLetter

 *     – 不支持System Font

 **/

    //不支持System Font

    virtualSprite* getLetter(intlettetIndex);

/**

 * 文字渲染效果

 *     – Shadow  : 阴影

 *     – Outline : 轮廓，仅支持TTF

 *     – Glow    : 发光，仅支持TTF

 **/

    //阴影Shadow（阴影颜色，相对Label的偏移，模糊度）

    //注: 其中blurRadius在3.2中并未实现

    virtualvoidenableShadow(constColor4B& shadowColor = Color4B::BLACK,constSize &offset = Size(2,-2), intblurRadius = 0);

    //轮廓Outline，仅支持TTF（轮廓颜色，轮廓粗细）

    virtualvoidenableOutline(constColor4B& outlineColor,intoutlineSize = -1);

    //发光Glow，仅支持TTF

    virtualvoidenableGlow(constColor4B& glowColor);

    //取消阴影/轮廓/发光渲染效果

    virtualvoiddisableEffect();

/**

 * 对齐方式

 *    > TextHAlignment : 水平对齐方式

 *        – TextHAlignmentEFT    : 左对齐

 *        – TextHAlignment:CENTER  : 居中对齐，默认

 *        – TextHAlignment:RIGHT   : 右对齐

 *    > TextVAlignment : 垂直对齐方式

 *        – TextVAlignment::TOP    : 顶部，默认

 *        – TextVAlignment::CENTER : 中心

 *        – TextVAlignment::BOTTOM : 底部

 **/

    //设置对齐方式

    voidsetAlignment(TextHAlignment hAlignment) { setAlignment(hAlignment,_vAlignment);}

    voidsetAlignment(TextHAlignment hAlignment,TextVAlignment vAlignment);

    TextHAlignment getTextAlignment() const{ return_hAlignment;}

    //设置水平对齐方式

    voidsetHorizontalAlignment(TextHAlignment hAlignment) { setAlignment(hAlignment,_vAlignment); }

    TextHAlignment getHorizontalAlignment() const{ return_hAlignment; }

    //设置垂直对齐方式

    voidsetVerticalAlignment(TextVAlignment vAlignment) { setAlignment(_hAlignment,vAlignment); }

    TextVAlignment getVerticalAlignment() const{ return_vAlignment; }

/**

 * Label尺寸大小

 *     – setLineBreakWithoutSpace : 开启自动换行功能

 *     – setMaxLineWidth          : 文字内容的最大行宽

 *     – setWidth                 : Label尺寸大小，宽

 *     – setHeight                : Label尺寸大小，高

 *     – setDimensions            : Label尺寸大小

 **/

    //是否开启自动换行功能

    voidsetLineBreakWithoutSpace(boolbreakWithoutSpace);

    //最大行宽，内容超过MaxLineWidth，就会自动换行

    //前提条件: 仅在width==0时，起作用。

    //  > width == 0;

    //  > setMaxLineWidth(lineWidth);

    //  > setLineBreakWithoutSpace(true);

    //它的效果与下面是类似的.

    //  > setWidth(lineWidth);

    //  > setLineBreakWithoutSpace(true);

    //只是width==0时，就无法设置文本的对齐方式了.

    voidsetMaxLineWidth(unsigned intmaxLineWidth);

    unsigned intgetMaxLineWidth() { return_maxLineWidth;}

    //设置Label的尺寸大小

    //可以理解为Label的文本框大小

    //当setLineBreakWithoutSpace(true)时，内容超过width，会自动换行

    //并且内容支持文本的对齐方式

    //注：设置尺寸大小，使用的是setDimensions，而不是setContentSize ！

    voidsetWidth(unsigned intwidth) { setDimensions(width,_labelHeight); }

    voidsetHeight(unsigned intheight){ setDimensions(_labelWidth,height); }

    voidsetDimensions(unsigned intwidth,unsigned intheight);

    unsigned intgetWidth() const{ return_labelWidth; }

    unsigned intgetHeight() const{ return_labelHeight; }

    constSize& getDimensions() const{ return_labelDimensions; }

/**

 * v3.2 新增

 *     – setLineHeight        : 设置行间距

 *     – setAdditionalKerning : 设置文字间距

 *     – getStringLength      : 字符串内容长度

 */

    //设置行间距，不支持system font

    voidsetLineHeight(floatheight);

    floatgetLineHeight() const;

    //设置文字间距，不支持system font

    voidsetAdditionalKerning(floatspace);

    floatgetAdditionalKerning() const;

    //获取Label的字符串内容长度

    intgetStringLength() const;

/**

 * 重写Node父类的方法

 *     – setBlendFunc   : 混合模式

 *     – setScale       : 放缩字体大小

 *     – addChild       : 添加子节点

 *     – getDescription : 显示Label的描述

 **/

    //设置颜色混合模式

    virtualvoidsetBlendFunc(constBlendFunc &blendFunc) override;

    //放缩字体大小（一般用于CharMap、BMFont）

    virtualvoidsetScale(floatscale) override;

    virtualvoidsetScaleX(floatscaleX) override;

    virtualvoidsetScaleY(floatscaleY) override;

    virtualfloatgetScaleX() constoverride;

    virtualfloatgetScaleY() constoverride;

    //添加子节点

    virtualvoidaddChild(Node * child, intzOrder=0, inttag=0) override;

    virtualvoidsortAllChildren() override;

    //Label描述

    virtualstd::string getDescription() constoverride;

};

//