/**************************************************************************** Copyright (c) 2013 Zynga Inc. Copyright (c) 2013-2014 Chukong Technologies Inc. http://www.cocos2d-x.org Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 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. ****************************************************************************/ #include "2d/CCLabel.h" #include "2d/CCFont.h" #include "2d/CCFontAtlasCache.h" #include "2d/CCFontAtlas.h" #include "2d/CCSprite.h" #include "2d/CCSpriteBatchNode.h" #include "2d/CCDrawNode.h" #include "base/ccUTF8.h" #include "platform/CCFileUtils.h" #include "renderer/CCRenderer.h" #include "renderer/ccGLStateCache.h" #include "base/CCDirector.h" #include "base/CCEventListenerCustom.h" #include "base/CCEventDispatcher.h" #include "base/CCEventCustom.h" NS_CC_BEGIN const int Label::DistanceFieldFontSize = 50; /** * LabelLetter used to update the quad in texture atlas without SpriteBatchNode. */ class LabelLetter : public Sprite { public: LabelLetter() { _textureAtlas = nullptr; } static LabelLetter* createWithTexture(Texture2D *texture, const Rect& rect, bool rotated = false) { auto letter = new (std::nothrow) LabelLetter(); if (letter && letter->initWithTexture(texture, rect, rotated)) { letter->setVisible(false); letter->autorelease(); return letter; } CC_SAFE_DELETE(letter); return nullptr; } virtual void updateTransform() override { if (isDirty()) { _transformToBatch = getNodeToParentTransform(); Size &size = _rect.size; float x1 = _offsetPosition.x; float y1 = _offsetPosition.y; float x2 = x1 + size.width; float y2 = y1 + size.height; float x = _transformToBatch.m[12]; float y = _transformToBatch.m[13]; float cr = _transformToBatch.m[0]; float sr = _transformToBatch.m[1]; float cr2 = _transformToBatch.m[5]; float sr2 = -_transformToBatch.m[4]; float ax = x1 * cr - y1 * sr2 + x; float ay = x1 * sr + y1 * cr2 + y; float bx = x2 * cr - y1 * sr2 + x; float by = x2 * sr + y1 * cr2 + y; float cx = x2 * cr - y2 * sr2 + x; float cy = x2 * sr + y2 * cr2 + y; float dx = x1 * cr - y2 * sr2 + x; float dy = x1 * sr + y2 * cr2 + y; _quad.bl.vertices.set(SPRITE_RENDER_IN_SUBPIXEL(ax), SPRITE_RENDER_IN_SUBPIXEL(ay), _positionZ); _quad.br.vertices.set(SPRITE_RENDER_IN_SUBPIXEL(bx), SPRITE_RENDER_IN_SUBPIXEL(by), _positionZ); _quad.tl.vertices.set(SPRITE_RENDER_IN_SUBPIXEL(dx), SPRITE_RENDER_IN_SUBPIXEL(dy), _positionZ); _quad.tr.vertices.set(SPRITE_RENDER_IN_SUBPIXEL(cx), SPRITE_RENDER_IN_SUBPIXEL(cy), _positionZ); if (_textureAtlas) { _textureAtlas->updateQuad(&_quad, _atlasIndex); } _recursiveDirty = false; setDirty(false); } Node::updateTransform(); } virtual void updateColor() { if (_textureAtlas == nullptr) { return; } Color4B color4(_displayedColor.r, _displayedColor.g, _displayedColor.b, _displayedOpacity); // special opacity for premultiplied textures if (_opacityModifyRGB) { color4.r *= _displayedOpacity / 255.0f; color4.g *= _displayedOpacity / 255.0f; color4.b *= _displayedOpacity / 255.0f; } _quad.bl.colors = color4; _quad.br.colors = color4; _quad.tl.colors = color4; _quad.tr.colors = color4; _textureAtlas->updateQuad(&_quad, _atlasIndex); } }; Label* Label::create() { auto ret = new (std::nothrow) Label(); if (ret) { ret->autorelease(); } return ret; } Label* Label::create(const std::string& text, const std::string& font, float fontSize, const Size& dimensions /* = Size::ZERO */, TextHAlignment hAlignment /* = TextHAlignment::LEFT */, TextVAlignment vAlignment /* = TextVAlignment::TOP */) { if (FileUtils::getInstance()->isFileExist(font)) { return createWithTTF(text,font,fontSize,dimensions,hAlignment,vAlignment); } else { return createWithSystemFont(text,font,fontSize,dimensions,hAlignment,vAlignment); } } Label* Label::createWithSystemFont(const std::string& text, const std::string& font, float fontSize, const Size& dimensions /* = Size::ZERO */, TextHAlignment hAlignment /* = TextHAlignment::LEFT */, TextVAlignment vAlignment /* = TextVAlignment::TOP */) { auto ret = new (std::nothrow) Label(hAlignment,vAlignment); if (ret) { ret->setSystemFontName(font); ret->setSystemFontSize(fontSize); ret->setDimensions(dimensions.width, dimensions.height); ret->setString(text); ret->autorelease(); return ret; } delete ret; return nullptr; } Label* Label::createWithTTF(const std::string& text, const std::string& fontFile, float fontSize, const Size& dimensions /* = Size::ZERO */, TextHAlignment hAlignment /* = TextHAlignment::LEFT */, TextVAlignment vAlignment /* = TextVAlignment::TOP */) { auto ret = new (std::nothrow) Label(hAlignment,vAlignment); if (ret && FileUtils::getInstance()->isFileExist(fontFile)) { TTFConfig ttfConfig(fontFile.c_str(),fontSize,GlyphCollection::DYNAMIC); if (ret->setTTFConfig(ttfConfig)) { ret->setDimensions(dimensions.width,dimensions.height); ret->setString(text); ret->autorelease(); return ret; } } delete ret; return nullptr; } Label* Label::createWithTTF(const TTFConfig& ttfConfig, const std::string& text, TextHAlignment hAlignment /* = TextHAlignment::CENTER */, int maxLineWidth /* = 0 */) { auto ret = new (std::nothrow) Label(hAlignment); if (ret && FileUtils::getInstance()->isFileExist(ttfConfig.fontFilePath) && ret->setTTFConfig(ttfConfig)) { ret->setMaxLineWidth(maxLineWidth); ret->setString(text); ret->autorelease(); return ret; } delete ret; return nullptr; } Label* Label::createWithBMFont(const std::string& bmfontFilePath, const std::string& text,const TextHAlignment& hAlignment /* = TextHAlignment::LEFT */, int maxLineWidth /* = 0 */, const Vec2& imageOffset /* = Vec2::ZERO */) { auto ret = new (std::nothrow) Label(hAlignment); if (ret && ret->setBMFontFilePath(bmfontFilePath,imageOffset)) { ret->setMaxLineWidth(maxLineWidth); ret->setString(text); ret->autorelease(); return ret; } delete ret; return nullptr; } Label* Label::createWithCharMap(const std::string& plistFile) { auto ret = new (std::nothrow) Label(); if (ret && ret->setCharMap(plistFile)) { ret->autorelease(); return ret; } delete ret; return nullptr; } Label* Label::createWithCharMap(Texture2D* texture, int itemWidth, int itemHeight, int startCharMap) { auto ret = new (std::nothrow) Label(); if (ret && ret->setCharMap(texture,itemWidth,itemHeight,startCharMap)) { ret->autorelease(); return ret; } delete ret; return nullptr; } Label* Label::createWithCharMap(const std::string& charMapFile, int itemWidth, int itemHeight, int startCharMap) { auto ret = new (std::nothrow) Label(); if (ret && ret->setCharMap(charMapFile,itemWidth,itemHeight,startCharMap)) { ret->autorelease(); return ret; } delete ret; return nullptr; } bool Label::setCharMap(const std::string& plistFile) { auto newAtlas = FontAtlasCache::getFontAtlasCharMap(plistFile); if (!newAtlas) { reset(); return false; } _currentLabelType = LabelType::CHARMAP; setFontAtlas(newAtlas); return true; } bool Label::setCharMap(Texture2D* texture, int itemWidth, int itemHeight, int startCharMap) { auto newAtlas = FontAtlasCache::getFontAtlasCharMap(texture,itemWidth,itemHeight,startCharMap); if (!newAtlas) { reset(); return false; } _currentLabelType = LabelType::CHARMAP; setFontAtlas(newAtlas); return true; } bool Label::setCharMap(const std::string& charMapFile, int itemWidth, int itemHeight, int startCharMap) { auto newAtlas = FontAtlasCache::getFontAtlasCharMap(charMapFile,itemWidth,itemHeight,startCharMap); if (!newAtlas) { reset(); return false; } _currentLabelType = LabelType::CHARMAP; setFontAtlas(newAtlas); return true; } Label::Label(TextHAlignment hAlignment /* = TextHAlignment::LEFT */, TextVAlignment vAlignment /* = TextVAlignment::TOP */) : _textSprite(nullptr) , _shadowNode(nullptr) , _fontAtlas(nullptr) , _reusedLetter(nullptr) , _horizontalKernings(nullptr) { setAnchorPoint(Vec2::ANCHOR_MIDDLE); reset(); _hAlignment = hAlignment; _vAlignment = vAlignment; #if CC_LABEL_DEBUG_DRAW _debugDrawNode = DrawNode::create(); addChild(_debugDrawNode); #endif _purgeTextureListener = EventListenerCustom::create(FontAtlas::CMD_PURGE_FONTATLAS, [this](EventCustom* event){ if (_fontAtlas && _currentLabelType == LabelType::TTF && event->getUserData() == _fontAtlas) { for (auto&& it : _letters) { it.second->setTexture(nullptr); } _batchNodes.clear(); if (_fontAtlas) { FontAtlasCache::releaseFontAtlas(_fontAtlas); } } }); _eventDispatcher->addEventListenerWithFixedPriority(_purgeTextureListener, 1); _resetTextureListener = EventListenerCustom::create(FontAtlas::CMD_RESET_FONTATLAS, [this](EventCustom* event){ if (_fontAtlas && _currentLabelType == LabelType::TTF && event->getUserData() == _fontAtlas) { _fontAtlas = nullptr; this->setTTFConfig(_fontConfig); for (auto&& it : _letters) { getLetter(it.first); } } }); _eventDispatcher->addEventListenerWithFixedPriority(_resetTextureListener, 2); } Label::~Label() { delete [] _horizontalKernings; if (_fontAtlas) { Node::removeAllChildrenWithCleanup(true); CC_SAFE_RELEASE_NULL(_reusedLetter); _batchNodes.clear(); FontAtlasCache::releaseFontAtlas(_fontAtlas); } _eventDispatcher->removeEventListener(_purgeTextureListener); _eventDispatcher->removeEventListener(_resetTextureListener); CC_SAFE_RELEASE_NULL(_textSprite); CC_SAFE_RELEASE_NULL(_shadowNode); } void Label::reset() { CC_SAFE_RELEASE_NULL(_textSprite); CC_SAFE_RELEASE_NULL(_shadowNode); Node::removeAllChildrenWithCleanup(true); CC_SAFE_RELEASE_NULL(_reusedLetter); _letters.clear(); _batchNodes.clear(); _lettersInfo.clear(); if (_fontAtlas) { FontAtlasCache::releaseFontAtlas(_fontAtlas); _fontAtlas = nullptr; } _currentLabelType = LabelType::STRING_TEXTURE; _currLabelEffect = LabelEffect::NORMAL; _contentDirty = false; _numberOfLines = 0; _lengthOfString = 0; _utf16Text.clear(); _utf8Text.clear(); TTFConfig temp; _fontConfig = temp; _outlineSize = 0.f; _bmFontPath = ""; _systemFontDirty = false; _systemFont = "Helvetica"; _systemFontSize = 12; if (_horizontalKernings) { delete[] _horizontalKernings; _horizontalKernings = nullptr; } _additionalKerning = 0.f; _lineHeight = 0.f; _maxLineWidth = 0.f; _labelDimensions.width = 0.f; _labelDimensions.height = 0.f; _labelWidth = 0.f; _labelHeight = 0.f; _lineBreakWithoutSpaces = false; _hAlignment = TextHAlignment::LEFT; _vAlignment = TextVAlignment::TOP; _effectColorF = Color4F::BLACK; _textColor = Color4B::WHITE; _textColorF = Color4F::WHITE; setColor(Color3B::WHITE); _shadowDirty = false; _shadowEnabled = false; _shadowBlurRadius = 0.f; _correctionScale = 1.f; _useDistanceField = false; _useA8Shader = false; _clipEnabled = false; _blendFuncDirty = false; _blendFunc = BlendFunc::ALPHA_PREMULTIPLIED; _isOpacityModifyRGB = false; _insideBounds = true; } void Label::updateShaderProgram() { switch (_currLabelEffect) { case cocos2d::LabelEffect::NORMAL: if (_useDistanceField) setGLProgramState(GLProgramState::getOrCreateWithGLProgramName(GLProgram::SHADER_NAME_LABEL_DISTANCEFIELD_NORMAL)); else if (_useA8Shader) setGLProgramState(GLProgramState::getOrCreateWithGLProgramName(GLProgram::SHADER_NAME_LABEL_NORMAL)); else setGLProgramState(GLProgramState::getOrCreateWithGLProgramName(GLProgram::SHADER_NAME_POSITION_TEXTURE_COLOR)); break; case cocos2d::LabelEffect::OUTLINE: setGLProgramState(GLProgramState::getOrCreateWithGLProgramName(GLProgram::SHADER_NAME_LABEL_OUTLINE)); _uniformEffectColor = glGetUniformLocation(getGLProgram()->getProgram(), "u_effectColor"); break; case cocos2d::LabelEffect::GLOW: if (_useDistanceField) { setGLProgramState(GLProgramState::getOrCreateWithGLProgramName(GLProgram::SHADER_NAME_LABEL_DISTANCEFIELD_GLOW)); _uniformEffectColor = glGetUniformLocation(getGLProgram()->getProgram(), "u_effectColor"); } break; default: return; } _uniformTextColor = glGetUniformLocation(getGLProgram()->getProgram(), "u_textColor"); } void Label::setFontAtlas(FontAtlas* atlas,bool distanceFieldEnabled /* = false */, bool useA8Shader /* = false */) { if (atlas == _fontAtlas) { FontAtlasCache::releaseFontAtlas(atlas); return; } if (_fontAtlas) { _batchNodes.clear(); FontAtlasCache::releaseFontAtlas(_fontAtlas); _fontAtlas = nullptr; } _fontAtlas = atlas; if (_reusedLetter == nullptr) { _reusedLetter = Sprite::create(); _reusedLetter->setOpacityModifyRGB(_isOpacityModifyRGB); _reusedLetter->retain(); _reusedLetter->setAnchorPoint(Vec2::ANCHOR_TOP_LEFT); } if (_fontAtlas) { _lineHeight = _fontAtlas->getLineHeight(); _contentDirty = true; } _useDistanceField = distanceFieldEnabled; _useA8Shader = useA8Shader; if (_currentLabelType != LabelType::TTF) { _currLabelEffect = LabelEffect::NORMAL; updateShaderProgram(); } } bool Label::setTTFConfig(const TTFConfig& ttfConfig) { FontAtlas *newAtlas = FontAtlasCache::getFontAtlasTTF(ttfConfig); if (!newAtlas) { reset(); return false; } _systemFontDirty = false; _currentLabelType = LabelType::TTF; setFontAtlas(newAtlas,ttfConfig.distanceFieldEnabled,true); _fontConfig = ttfConfig; if (_fontConfig.outlineSize > 0) { _fontConfig.distanceFieldEnabled = false; _useDistanceField = false; _useA8Shader = false; _currLabelEffect = LabelEffect::OUTLINE; updateShaderProgram(); } else { _currLabelEffect = LabelEffect::NORMAL; updateShaderProgram(); if(ttfConfig.distanceFieldEnabled) { this->setCorrectionScale(1.0f * ttfConfig.fontSize / DistanceFieldFontSize); } } return true; } bool Label::setBMFontFilePath(const std::string& bmfontFilePath, const Vec2& imageOffset /* = Vec2::ZERO */) { FontAtlas *newAtlas = FontAtlasCache::getFontAtlasFNT(bmfontFilePath,imageOffset); if (!newAtlas) { reset(); return false; } _bmFontPath = bmfontFilePath; _currentLabelType = LabelType::BMFONT; setFontAtlas(newAtlas); return true; } void Label::setString(const std::string& text) { if (text.compare(_utf8Text)) { _utf8Text = text; _contentDirty = true; std::u16string utf16String; if (StringUtils::UTF8ToUTF16(_utf8Text, utf16String)) { _utf16Text = utf16String; } } } void Label::setAlignment(TextHAlignment hAlignment,TextVAlignment vAlignment) { if (hAlignment != _hAlignment || vAlignment != _vAlignment) { _hAlignment = hAlignment; _vAlignment = vAlignment; _contentDirty = true; } } void Label::setMaxLineWidth(float maxLineWidth) { if (_labelWidth == 0 && _maxLineWidth != maxLineWidth) { _maxLineWidth = maxLineWidth; _contentDirty = true; } } void Label::setDimensions(float width, float height) { if (height != _labelHeight || width != _labelWidth) { _labelWidth = width; _labelHeight = height; _labelDimensions.width = width; _labelDimensions.height = height; _maxLineWidth = width; _contentDirty = true; } } void Label::setLineBreakWithoutSpace(bool breakWithoutSpace) { if (breakWithoutSpace != _lineBreakWithoutSpaces) { _lineBreakWithoutSpaces = breakWithoutSpace; _contentDirty = true; } } void Label::setScale(float scale) { if (_useDistanceField) { scale *= _correctionScale; } Node::setScale(scale); } void Label::setScaleX(float scaleX) { if (_useDistanceField) { scaleX *= _correctionScale; } Node::setScaleX(scaleX); } void Label::setScaleY(float scaleY) { if (_useDistanceField) { scaleY *= _correctionScale; } Node::setScaleY(scaleY); } float Label::getScaleY() const { if (_useDistanceField) { return _scaleY / _correctionScale; } else { return _scaleY; } } float Label::getScaleX() const { if (_useDistanceField) { return _scaleX / _correctionScale; } else { return _scaleX; } } void Label::alignText() { if (_fontAtlas == nullptr || _utf16Text.empty()) { setContentSize(Size::ZERO); return; } _fontAtlas->prepareLetterDefinitions(_utf16Text); auto& textures = _fontAtlas->getTextures(); if (textures.size() > _batchNodes.size()) { for (auto index = _batchNodes.size(); index < textures.size(); ++index) { auto batchNode = SpriteBatchNode::createWithTexture(textures.at(index)); if (batchNode) { _isOpacityModifyRGB = batchNode->getTexture()->hasPremultipliedAlpha(); _blendFunc = batchNode->getBlendFunc(); batchNode->setAnchorPoint(Vec2::ANCHOR_TOP_LEFT); batchNode->setPosition(Vec2::ZERO); _batchNodes.pushBack(batchNode); } } } if (_batchNodes.empty()) { return; } _reusedLetter->setBatchNode(_batchNodes.at(0)); _lengthOfString = 0; _textDesiredHeight = 0.f; _linesWidth.clear(); if (_maxLineWidth > 0.f && !_lineBreakWithoutSpaces) { multilineTextWrapByWord(); } else { multilineTextWrapByChar(); } computeAlignmentOffset(); if (!_letters.empty()) { Rect uvRect; Sprite* letterSprite; int letterIndex; for (auto it = _letters.begin(); it != _letters.end();) { letterIndex = it->first; letterSprite = it->second; if (letterIndex >= _lengthOfString) { Node::removeChild(letterSprite, true); it = _letters.erase(it); } else { auto& letterInfo = _lettersInfo[letterIndex]; auto& letterDef = _fontAtlas->_letterDefinitions[letterInfo.utf16Char]; uvRect.size.height = letterDef.height; uvRect.size.width = letterDef.width; uvRect.origin.x = letterDef.U; uvRect.origin.y = letterDef.V; letterSprite->setBatchNode(_batchNodes.at(letterDef.textureID)); letterSprite->setTextureRect(uvRect, false, uvRect.size); auto px = letterInfo.positionX + letterDef.width / 2 + _linesOffsetX[letterInfo.lineIndex]; auto py = letterInfo.positionY - letterDef.height / 2 + _letterOffsetY; letterSprite->setPosition(px,py); ++it; } } } updateQuads(); updateColor(); } bool Label::computeHorizontalKernings(const std::u16string& stringToRender) { if (_horizontalKernings) { delete [] _horizontalKernings; _horizontalKernings = nullptr; } int letterCount = 0; _horizontalKernings = _fontAtlas->getFont()->getHorizontalKerningForTextUTF16(stringToRender, letterCount); if(!_horizontalKernings) return false; else return true; } void Label::updateQuads() { for (auto&& batchNode : _batchNodes) { batchNode->getTextureAtlas()->removeAllQuads(); } for (int ctr = 0; ctr < _lengthOfString; ++ctr) { auto& letterDef = _fontAtlas->_letterDefinitions[_lettersInfo[ctr].utf16Char]; if (letterDef.validDefinition) { _reusedRect.size.height = letterDef.height; _reusedRect.size.width = letterDef.width; _reusedRect.origin.x = letterDef.U; _reusedRect.origin.y = letterDef.V; auto py = _lettersInfo[ctr].positionY + _letterOffsetY; if (py > _tailoredTopY) { auto clipTop = py - _tailoredTopY; _reusedRect.origin.y += clipTop; _reusedRect.size.height -= clipTop; py -= clipTop; } if (py - letterDef.height < _tailoredBottomY) { _reusedRect.size.height = (py < _tailoredBottomY) ? 0.f : (py - _tailoredBottomY); } if (_reusedRect.size.height > 0.f && _reusedRect.size.width > 0.f) { _reusedLetter->setTextureRect(_reusedRect, false, _reusedRect.size); _reusedLetter->setPosition(_lettersInfo[ctr].positionX + _linesOffsetX[_lettersInfo[ctr].lineIndex], py); auto index = static_cast(_batchNodes.at(letterDef.textureID)->getTextureAtlas()->getTotalQuads()); _lettersInfo[ctr].atlasIndex = index; _batchNodes.at(letterDef.textureID)->insertQuadFromSprite(_reusedLetter, index); } } } } void Label::enableGlow(const Color4B& glowColor) { if (_currentLabelType == LabelType::TTF) { if (_fontConfig.distanceFieldEnabled == false) { auto config = _fontConfig; config.outlineSize = 0; config.distanceFieldEnabled = true; setTTFConfig(config); _contentDirty = true; } _currLabelEffect = LabelEffect::GLOW; _effectColorF.r = glowColor.r / 255.0f; _effectColorF.g = glowColor.g / 255.0f; _effectColorF.b = glowColor.b / 255.0f; _effectColorF.a = glowColor.a / 255.0f; updateShaderProgram(); } } void Label::enableOutline(const Color4B& outlineColor,int outlineSize /* = -1 */) { CCASSERT(_currentLabelType == LabelType::STRING_TEXTURE || _currentLabelType == LabelType::TTF, "Only supported system font and TTF!"); if (outlineSize > 0 || _currLabelEffect == LabelEffect::OUTLINE) { if (_currentLabelType == LabelType::TTF) { _effectColorF.r = outlineColor.r / 255.0f; _effectColorF.g = outlineColor.g / 255.0f; _effectColorF.b = outlineColor.b / 255.0f; _effectColorF.a = outlineColor.a / 255.0f; if (outlineSize > 0 && _fontConfig.outlineSize != outlineSize) { _fontConfig.outlineSize = outlineSize; setTTFConfig(_fontConfig); } } else if (_effectColorF != outlineColor || _outlineSize != outlineSize) { _effectColorF.r = outlineColor.r / 255.f; _effectColorF.g = outlineColor.g / 255.f; _effectColorF.b = outlineColor.b / 255.f; _effectColorF.a = outlineColor.a / 255.f; _outlineSize = outlineSize; _currLabelEffect = LabelEffect::OUTLINE; _contentDirty = true; } } } void Label::enableShadow(const Color4B& shadowColor /* = Color4B::BLACK */,const Size &offset /* = Size(2 ,-2)*/, int blurRadius /* = 0 */) { _shadowEnabled = true; _shadowDirty = true; auto contentScaleFactor = CC_CONTENT_SCALE_FACTOR(); _shadowOffset.width = offset.width * contentScaleFactor; _shadowOffset.height = offset.height * contentScaleFactor; //TODO: support blur for shadow _shadowColor3B.r = shadowColor.r; _shadowColor3B.g = shadowColor.g; _shadowColor3B.b = shadowColor.b; _shadowOpacity = shadowColor.a; if (!_systemFontDirty && !_contentDirty && _textSprite) { auto fontDef = _getFontDefinition(); if (_shadowNode) { if (shadowColor != _shadowColor4F) { _shadowNode->release(); _shadowNode = nullptr; createShadowSpriteForSystemFont(fontDef); } else { _shadowNode->setPosition(_shadowOffset.width, _shadowOffset.height); } } else { createShadowSpriteForSystemFont(fontDef); } } _shadowColor4F.r = shadowColor.r / 255.0f; _shadowColor4F.g = shadowColor.g / 255.0f; _shadowColor4F.b = shadowColor.b / 255.0f; _shadowColor4F.a = shadowColor.a / 255.0f; } void Label::disableEffect() { disableEffect(LabelEffect::GLOW); disableEffect(LabelEffect::OUTLINE); disableEffect(LabelEffect::SHADOW); } void Label::disableEffect(LabelEffect effect) { switch (effect) { case cocos2d::LabelEffect::NORMAL: break; case cocos2d::LabelEffect::OUTLINE: if (_currLabelEffect == LabelEffect::OUTLINE) { if (_currentLabelType == LabelType::TTF) { _fontConfig.outlineSize = 0; setTTFConfig(_fontConfig); } _currLabelEffect = LabelEffect::NORMAL; _contentDirty = true; } break; case cocos2d::LabelEffect::SHADOW: if (_shadowEnabled) { _shadowEnabled = false; CC_SAFE_RELEASE_NULL(_shadowNode); } break; case cocos2d::LabelEffect::GLOW: if (_currLabelEffect == LabelEffect::GLOW) { _currLabelEffect = LabelEffect::NORMAL; updateShaderProgram(); } break; case LabelEffect::ALL: { disableEffect(LabelEffect::SHADOW); disableEffect(LabelEffect::GLOW); disableEffect(LabelEffect::OUTLINE); } break; default: break; } } void Label::setCorrectionScale(float correctionScale) { _correctionScale = correctionScale * CC_CONTENT_SCALE_FACTOR(); Node::setScale(_correctionScale); } void Label::createSpriteForSystemFont(const FontDefinition& fontDef) { _currentLabelType = LabelType::STRING_TEXTURE; auto texture = new (std::nothrow) Texture2D; texture->initWithString(_utf8Text.c_str(), fontDef); _textSprite = Sprite::createWithTexture(texture); //set camera mask using label's camera mask, because _textSprite may be null when setting camera mask to label _textSprite->setCameraMask(getCameraMask()); _textSprite->setAnchorPoint(Vec2::ANCHOR_BOTTOM_LEFT); this->setContentSize(_textSprite->getContentSize()); texture->release(); if (_blendFuncDirty) { _textSprite->setBlendFunc(_blendFunc); } _textSprite->retain(); _textSprite->updateDisplayedColor(_displayedColor); _textSprite->updateDisplayedOpacity(_displayedOpacity); } void Label::createShadowSpriteForSystemFont(const FontDefinition& fontDef) { if (!fontDef._stroke._strokeEnabled && fontDef._fontFillColor == _shadowColor3B && (fontDef._fontAlpha == _shadowOpacity)) { _shadowNode = Sprite::createWithTexture(_textSprite->getTexture()); } else { FontDefinition shadowFontDefinition = fontDef; shadowFontDefinition._fontFillColor.r = _shadowColor3B.r; shadowFontDefinition._fontFillColor.g = _shadowColor3B.g; shadowFontDefinition._fontFillColor.b = _shadowColor3B.b; shadowFontDefinition._fontAlpha = _shadowOpacity; shadowFontDefinition._stroke._strokeColor = shadowFontDefinition._fontFillColor; shadowFontDefinition._stroke._strokeAlpha = shadowFontDefinition._fontAlpha; auto texture = new (std::nothrow) Texture2D; texture->initWithString(_utf8Text.c_str(), shadowFontDefinition); _shadowNode = Sprite::createWithTexture(texture); texture->release(); } if (_shadowNode) { if (_blendFuncDirty) { _shadowNode->setBlendFunc(_blendFunc); } _shadowNode->setCameraMask(getCameraMask()); _shadowNode->setAnchorPoint(Vec2::ANCHOR_BOTTOM_LEFT); _shadowNode->setPosition(_shadowOffset.width, _shadowOffset.height); _shadowNode->retain(); _shadowNode->updateDisplayedColor(_displayedColor); _shadowNode->updateDisplayedOpacity(_displayedOpacity); } } void Label::setCameraMask(unsigned short mask, bool applyChildren) { Node::setCameraMask(mask, applyChildren); if (_textSprite) { _textSprite->setCameraMask(mask, applyChildren); } if (_shadowNode) { _shadowNode->setCameraMask(mask, applyChildren); } } void Label::setFontDefinition(const FontDefinition& textDefinition) { _systemFont = textDefinition._fontName; _systemFontSize = textDefinition._fontSize; _hAlignment = textDefinition._alignment; _vAlignment = textDefinition._vertAlignment; setDimensions(textDefinition._dimensions.width, textDefinition._dimensions.height); Color4B textColor = Color4B(textDefinition._fontFillColor); textColor.a = textDefinition._fontAlpha; setTextColor(textColor); #if (CC_TARGET_PLATFORM != CC_PLATFORM_ANDROID) && (CC_TARGET_PLATFORM != CC_PLATFORM_IOS) if (textDefinition._stroke._strokeEnabled) { CCLOGERROR("Currently only supported on iOS and Android!"); } _outlineSize = 0.f; #else if (textDefinition._stroke._strokeEnabled && textDefinition._stroke._strokeSize > 0.f) { Color4B outlineColor = Color4B(textDefinition._stroke._strokeColor); outlineColor.a = textDefinition._stroke._strokeAlpha; enableOutline(outlineColor, textDefinition._stroke._strokeSize); } #endif if (textDefinition._shadow._shadowEnabled) { enableShadow(Color4B(0, 0, 0, 255 * textDefinition._shadow._shadowOpacity), textDefinition._shadow._shadowOffset, textDefinition._shadow._shadowBlur); } } void Label::updateContent() { if (_systemFontDirty) { if (_fontAtlas) { _batchNodes.clear(); FontAtlasCache::releaseFontAtlas(_fontAtlas); _fontAtlas = nullptr; } _systemFontDirty = false; } CC_SAFE_RELEASE_NULL(_textSprite); CC_SAFE_RELEASE_NULL(_shadowNode); if (_fontAtlas) { std::u16string utf16String; if (StringUtils::UTF8ToUTF16(_utf8Text, utf16String)) { _utf16Text = utf16String; } computeHorizontalKernings(_utf16Text); alignText(); } else { auto fontDef = _getFontDefinition(); createSpriteForSystemFont(fontDef); if (_shadowEnabled) { createShadowSpriteForSystemFont(fontDef); } } _contentDirty = false; #if CC_LABEL_DEBUG_DRAW _debugDrawNode->clear(); Vec2 vertices[4] = { Vec2::ZERO, Vec2(_contentSize.width, 0), Vec2(_contentSize.width, _contentSize.height), Vec2(0, _contentSize.height) }; _debugDrawNode->drawPoly(vertices, 4, true, Color4F::WHITE); #endif } void Label::onDrawShadow(GLProgram* glProgram) { if (_currentLabelType == LabelType::TTF) { glProgram->setUniformLocationWith4f(_uniformTextColor, _shadowColor4F.r, _shadowColor4F.g, _shadowColor4F.b, _shadowColor4F.a); if (_currLabelEffect == LabelEffect::OUTLINE || _currLabelEffect == LabelEffect::GLOW) { glProgram->setUniformLocationWith4f(_uniformEffectColor, _shadowColor4F.r, _shadowColor4F.g, _shadowColor4F.b, _shadowColor4F.a); } glProgram->setUniformsForBuiltins(_shadowTransform); for (auto&& it : _letters) { it.second->updateTransform(); } for (auto&& batchNode : _batchNodes) { batchNode->getTextureAtlas()->drawQuads(); } } else { Color3B oldColor = _realColor; GLubyte oldOPacity = _displayedOpacity; _displayedOpacity = _shadowOpacity; setColor(_shadowColor3B); glProgram->setUniformsForBuiltins(_shadowTransform); for (auto&& it : _letters) { it.second->updateTransform(); } for (auto&& batchNode : _batchNodes) { batchNode->getTextureAtlas()->drawQuads(); } _displayedOpacity = oldOPacity; setColor(oldColor); } } void Label::onDraw(const Mat4& transform, bool transformUpdated) { auto glprogram = getGLProgram(); glprogram->use(); GL::blendFunc(_blendFunc.src, _blendFunc.dst); if (_shadowEnabled) { onDrawShadow(glprogram); } glprogram->setUniformsForBuiltins(transform); for (auto&& it : _letters) { it.second->updateTransform(); } if (_currentLabelType == LabelType::TTF) { switch (_currLabelEffect) { case LabelEffect::OUTLINE: //draw text with outline glprogram->setUniformLocationWith4f(_uniformTextColor, _textColorF.r, _textColorF.g, _textColorF.b, _textColorF.a); glprogram->setUniformLocationWith4f(_uniformEffectColor, _effectColorF.r, _effectColorF.g, _effectColorF.b, _effectColorF.a); for (auto&& batchNode : _batchNodes) { batchNode->getTextureAtlas()->drawQuads(); } //draw text without outline glprogram->setUniformLocationWith4f(_uniformEffectColor, _effectColorF.r, _effectColorF.g, _effectColorF.b, 0.f); break; case LabelEffect::GLOW: glprogram->setUniformLocationWith4f(_uniformEffectColor, _effectColorF.r, _effectColorF.g, _effectColorF.b, _effectColorF.a); case LabelEffect::NORMAL: glprogram->setUniformLocationWith4f(_uniformTextColor, _textColorF.r, _textColorF.g, _textColorF.b, _textColorF.a); break; default: break; } } for (auto&& batchNode : _batchNodes) { batchNode->getTextureAtlas()->drawQuads(); } } void Label::draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) { if (_batchNodes.empty() || _lengthOfString <= 0) { return; } // Don't do calculate the culling if the transform was not updated bool transformUpdated = flags & FLAGS_TRANSFORM_DIRTY; #if CC_USE_CULLING _insideBounds = transformUpdated ? renderer->checkVisibility(transform, _contentSize) : _insideBounds; if (_insideBounds) #endif { _customCommand.init(_globalZOrder, transform, flags); _customCommand.func = CC_CALLBACK_0(Label::onDraw, this, transform, transformUpdated); renderer->addCommand(&_customCommand); } } void Label::visit(Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) { if (! _visible || (_utf8Text.empty() && _children.empty()) ) { return; } if (_systemFontDirty || _contentDirty) { updateContent(); } uint32_t flags = processParentFlags(parentTransform, parentFlags); if (!_utf8Text.empty() && _shadowEnabled && (_shadowDirty || (flags & FLAGS_DIRTY_MASK))) { _position.x += _shadowOffset.width; _position.y += _shadowOffset.height; _transformDirty = _inverseDirty = true; _shadowTransform = transform(parentTransform); _position.x -= _shadowOffset.width; _position.y -= _shadowOffset.height; _transformDirty = _inverseDirty = true; _shadowDirty = false; } bool visibleByCamera = isVisitableByVisitingCamera(); if (_children.empty() && !_textSprite && !visibleByCamera) { return; } // IMPORTANT: // To ease the migration to v3.0, we still support the Mat4 stack, // but it is deprecated and your code should not rely on it _director->pushMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW); _director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW, _modelViewTransform); if (!_children.empty()) { sortAllChildren(); int i = 0; // draw children zOrder < 0 for (; i < _children.size(); i++) { auto node = _children.at(i); if (node && node->getLocalZOrder() < 0) node->visit(renderer, _modelViewTransform, flags); else break; } this->drawSelf(visibleByCamera, renderer, flags); for (auto it = _children.cbegin() + i; it != _children.cend(); ++it) { (*it)->visit(renderer, _modelViewTransform, flags); } } else { this->drawSelf(visibleByCamera, renderer, flags); } _director->popMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW); } void Label::drawSelf(bool visibleByCamera, Renderer* renderer, uint32_t flags) { if (_textSprite) { if (_shadowNode) { _shadowNode->visit(renderer, _modelViewTransform, flags); } _textSprite->visit(renderer, _modelViewTransform, flags); } else if (visibleByCamera && !_utf8Text.empty()) { draw(renderer, _modelViewTransform, flags); } } void Label::setSystemFontName(const std::string& systemFont) { if (systemFont != _systemFont) { _systemFont = systemFont; _systemFontDirty = true; } } void Label::setSystemFontSize(float fontSize) { if (_systemFontSize != fontSize) { _systemFontSize = fontSize; _systemFontDirty = true; } } ///// PROTOCOL STUFF Sprite * Label::getLetter(int letterIndex) { Sprite* letter = nullptr; do { if (_systemFontDirty || _currentLabelType == LabelType::STRING_TEXTURE) { break; } auto contentDirty = _contentDirty; if (contentDirty) { updateContent(); } if (_textSprite == nullptr && letterIndex < _lengthOfString) { const auto &letterInfo = _lettersInfo[letterIndex]; if (!letterInfo.valid) { break; } if (_letters.find(letterIndex) != _letters.end()) { letter = _letters[letterIndex]; } auto& letterDef = _fontAtlas->_letterDefinitions[letterInfo.utf16Char]; auto textureID = letterDef.textureID; Rect uvRect; uvRect.size.height = letterDef.height; uvRect.size.width = letterDef.width; uvRect.origin.x = letterDef.U; uvRect.origin.y = letterDef.V; if (letter == nullptr) { letter = LabelLetter::createWithTexture(_fontAtlas->getTexture(textureID), uvRect); letter->setTextureAtlas(_batchNodes.at(textureID)->getTextureAtlas()); letter->setAtlasIndex(letterInfo.atlasIndex); auto px = letterInfo.positionX + uvRect.size.width / 2 + _linesOffsetX[letterInfo.lineIndex]; auto py = letterInfo.positionY - uvRect.size.height / 2 + _letterOffsetY; letter->setPosition(px,py); letter->setOpacity(_realOpacity); addChild(letter); _letters[letterIndex] = letter; } else if (contentDirty) { letter->setTexture(_fontAtlas->getTexture(textureID)); letter->setTextureRect(uvRect, false, uvRect.size); letter->setTextureAtlas(_batchNodes.at(textureID)->getTextureAtlas()); } } } while (false); return letter; } void Label::setLineHeight(float height) { CCASSERT(_currentLabelType != LabelType::STRING_TEXTURE, "Not supported system font!"); if (_lineHeight != height) { _lineHeight = height; _contentDirty = true; } } float Label::getLineHeight() const { CCASSERT(_currentLabelType != LabelType::STRING_TEXTURE, "Not supported system font!"); return _textSprite ? 0.0f : _lineHeight; } void Label::setAdditionalKerning(float space) { CCASSERT(_currentLabelType != LabelType::STRING_TEXTURE, "Not supported system font!"); if (_additionalKerning != space) { _additionalKerning = space; _contentDirty = true; } } float Label::getAdditionalKerning() const { CCASSERT(_currentLabelType != LabelType::STRING_TEXTURE, "Not supported system font!"); return _additionalKerning; } void Label::computeStringNumLines() { int quantityOfLines = 1; if (_utf16Text.empty()) { _numberOfLines = 0; return; } // count number of lines size_t stringLen = _utf16Text.length(); for (size_t i = 0; i < stringLen - 1; ++i) { if (_utf16Text[i] == '\n') { quantityOfLines++; } } _numberOfLines = quantityOfLines; } int Label::getStringNumLines() { if (_contentDirty) { updateContent(); } if (_currentLabelType == LabelType::STRING_TEXTURE) { computeStringNumLines(); } return _numberOfLines; } int Label::getStringLength() { _lengthOfString = static_cast(_utf16Text.length()); return _lengthOfString; } // RGBA protocol void Label::setOpacityModifyRGB(bool isOpacityModifyRGB) { if (isOpacityModifyRGB != _isOpacityModifyRGB) { _isOpacityModifyRGB = isOpacityModifyRGB; updateColor(); } } void Label::updateDisplayedColor(const Color3B& parentColor) { Node::updateDisplayedColor(parentColor); if (_textSprite) { _textSprite->updateDisplayedColor(_displayedColor); if (_shadowNode) { _shadowNode->updateDisplayedColor(_displayedColor); } } for (auto&& it : _letters) { it.second->updateDisplayedColor(_displayedColor);; } } void Label::updateDisplayedOpacity(GLubyte parentOpacity) { Node::updateDisplayedOpacity(parentOpacity); if (_textSprite) { _textSprite->updateDisplayedOpacity(_displayedOpacity); if (_shadowNode) { _shadowNode->updateDisplayedOpacity(_displayedOpacity); } } for (auto&& it : _letters) { it.second->updateDisplayedOpacity(_displayedOpacity);; } } void Label::setTextColor(const Color4B &color) { CCASSERT(_currentLabelType == LabelType::TTF || _currentLabelType == LabelType::STRING_TEXTURE, "Only supported system font and ttf!"); if (_currentLabelType == LabelType::STRING_TEXTURE && _textColor != color) { _contentDirty = true; } _textColor = color; _textColorF.r = _textColor.r / 255.0f; _textColorF.g = _textColor.g / 255.0f; _textColorF.b = _textColor.b / 255.0f; _textColorF.a = _textColor.a / 255.0f; } void Label::updateColor() { if (_batchNodes.empty()) { return; } Color4B color4( _displayedColor.r, _displayedColor.g, _displayedColor.b, _displayedOpacity ); // special opacity for premultiplied textures if (_isOpacityModifyRGB) { color4.r *= _displayedOpacity/255.0f; color4.g *= _displayedOpacity/255.0f; color4.b *= _displayedOpacity/255.0f; } cocos2d::TextureAtlas* textureAtlas; V3F_C4B_T2F_Quad *quads; for (auto&& batchNode:_batchNodes) { textureAtlas = batchNode->getTextureAtlas(); quads = textureAtlas->getQuads(); auto count = textureAtlas->getTotalQuads(); for (int index = 0; index < count; ++index) { quads[index].bl.colors = color4; quads[index].br.colors = color4; quads[index].tl.colors = color4; quads[index].tr.colors = color4; textureAtlas->updateQuad(&quads[index], index); } } } std::string Label::getDescription() const { char tmp[50]; sprintf(tmp, "