/**************************************************************************** Copyright (c) 2013 Zynga 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 "CCLabel.h" #include "CCFontDefinition.h" #include "CCFontAtlasCache.h" #include "CCLabelTextFormatter.h" #define DISTANCEFIELD_ATLAS_FONTSIZE 50 NS_CC_BEGIN Label* Label::createWithTTF(const std::string& label, const std::string& fontFilePath, int fontSize, int lineSize, TextHAlignment alignment, GlyphCollection glyphs, const char *customGlyphs, bool useDistanceField) { FontAtlas *tmpAtlas = nullptr; if(useDistanceField) tmpAtlas = FontAtlasCache::getFontAtlasTTF(fontFilePath.c_str(), DISTANCEFIELD_ATLAS_FONTSIZE, glyphs, customGlyphs,true); else tmpAtlas = FontAtlasCache::getFontAtlasTTF(fontFilePath.c_str(), fontSize, glyphs, customGlyphs,false); if (!tmpAtlas) return nullptr; // create the actual label Label* templabel = Label::createWithAtlas(tmpAtlas, alignment, lineSize, useDistanceField,true); if (templabel) { if(useDistanceField) templabel->setFontSize(fontSize); templabel->setText(label, lineSize, alignment, false); return templabel; } return nullptr; } Label* Label::createWithBMFont(const std::string& label, const std::string& bmfontFilePath, TextHAlignment alignment, int lineSize) { FontAtlas *tmpAtlas = FontAtlasCache::getFontAtlasFNT(bmfontFilePath.c_str()); if (!tmpAtlas) return 0; Label* templabel = Label::createWithAtlas(tmpAtlas, alignment, lineSize); if (templabel) { templabel->setText(label, lineSize, alignment, false); return templabel; } else { return 0; } return 0; } Label* Label::createWithAtlas(FontAtlas *atlas, TextHAlignment alignment, int lineSize, bool useDistanceField,bool useA8Shader) { Label *ret = new Label(atlas, alignment, useDistanceField,useA8Shader); if (!ret) return 0; if( ret->init() ) { ret->autorelease(); return ret; } else { delete ret; return 0; } return ret; } Label::Label(FontAtlas *atlas, TextHAlignment alignment, bool useDistanceField,bool useA8Shader) : _reusedLetter(nullptr) , _lineBreakWithoutSpaces(false) ,_multilineEnable(true) , _alignment(alignment) , _currentUTF16String(0) , _originalUTF16String(0) , _advances(0) , _fontAtlas(atlas) , _displayedColor(Color3B::WHITE) , _realColor(Color3B::WHITE) , _cascadeColorEnabled(true) , _cascadeOpacityEnabled(true) , _displayedOpacity(255) , _realOpacity(255) , _isOpacityModifyRGB(true) ,_useDistanceField(useDistanceField) ,_useA8Shader(useA8Shader) { } Label::~Label() { delete [] _currentUTF16String; delete [] _originalUTF16String; delete [] _advances; if (_fontAtlas) FontAtlasCache::releaseFontAtlas(_fontAtlas); _reusedLetter->release(); } bool Label::init() { bool ret = true; if(_fontAtlas) { _reusedLetter = Sprite::createWithTexture(&_fontAtlas->getTexture(0)); _reusedLetter->setOpacityModifyRGB(_isOpacityModifyRGB); ret = SpriteBatchNode::initWithTexture(&_fontAtlas->getTexture(0), 30); _reusedLetter->retain(); } if (_useDistanceField) setLabelEffect(LabelEffect::NORMAL,Color3B::BLACK); else if(_useA8Shader) setShaderProgram(ShaderCache::getInstance()->getProgram(GLProgram::SHADER_NAME_POSITION_TEXTURE_A8_COLOR)); return ret; } void Label::setString(const std::string &stringToRender) { _multilineEnable = true; setText(stringToRender, _width, TextHAlignment::CENTER, false); } void Label::setString(const std::string &stringToRender,bool multilineEnable) { _multilineEnable = multilineEnable; setText(stringToRender, _width, TextHAlignment::CENTER, false); } bool Label::setText(const std::string& stringToRender, float lineWidth, TextHAlignment alignment, bool lineBreakWithoutSpaces) { if (!_fontAtlas) return false; // carloX // reset the string resetCurrentString(); _width = lineWidth; _alignment = alignment; _lineBreakWithoutSpaces = lineBreakWithoutSpaces; // store locally common line height _commonLineHeight = _fontAtlas->getCommonLineHeight(); if (_commonLineHeight <= 0) return false; // int numLetter = 0; unsigned short* utf16String = cc_utf8_to_utf16(stringToRender.c_str()); if(!utf16String) return false; _cascadeColorEnabled = true; setCurrentString(utf16String); setOriginalString(utf16String); // align text alignText(); // done here return true; } void Label::setAlignment(TextHAlignment alignment) { // store the new alignment if (alignment != _alignment) { // store _alignment = alignment; // reset the string resetCurrentString(); // need to align text again alignText(); } } void Label::setWidth(float width) { if (width != _width) { // store _width = width; // reset the string resetCurrentString(); // need to align text again alignText(); } } void Label::setLineBreakWithoutSpace(bool breakWithoutSpace) { if (breakWithoutSpace != _lineBreakWithoutSpaces) { // store _lineBreakWithoutSpaces = breakWithoutSpace; // need to align text again alignText(); } } void Label::setScale(float scale) { if (_useDistanceField) { scale *= 1.0f * _fontSize / DISTANCEFIELD_ATLAS_FONTSIZE; } Node::setScale(scale); } void Label::setScaleX(float scaleX) { if (_useDistanceField) { scaleX *= 1.0f * _fontSize / DISTANCEFIELD_ATLAS_FONTSIZE; } Node::setScaleX(scaleX); } void Label::setScaleY(float scaleY) { if (_useDistanceField) { scaleY *= 1.0f * _fontSize / DISTANCEFIELD_ATLAS_FONTSIZE; } Node::setScaleY(scaleY); } float Label::getScaleY() const { if (_useDistanceField) { return _scaleY / (1.0f * _fontSize / DISTANCEFIELD_ATLAS_FONTSIZE); } else { return _scaleY; } } float Label::getScaleX() const { if (_useDistanceField) { return _scaleX / (1.0f * _fontSize / DISTANCEFIELD_ATLAS_FONTSIZE); } else { return _scaleX; } } void Label::alignText() { if(_textureAtlas) _textureAtlas->removeAllQuads(); _fontAtlas->prepareLetterDefinitions(_currentUTF16String); LabelTextFormatter::createStringSprites(this); if(_multilineEnable && LabelTextFormatter::multilineText(this) ) LabelTextFormatter::createStringSprites(this); LabelTextFormatter::alignText(this); int strLen = cc_wcslen(_currentUTF16String); std::for_each(_children.begin(), _children.end(), [this,&strLen](Node* child){ if (child) { int tag = child->getTag(); if(tag < 0 || tag >= strLen) SpriteBatchNode::removeChild(child, true); } }); _reusedLetter->setBatchNode(nullptr); int vaildIndex = 0; Sprite* child = nullptr; Rect uvRect; for (int ctr = 0; ctr < strLen; ++ctr) { if (_lettersInfo[ctr].def.validDefinition) { child = static_cast( this->getChildByTag(ctr) ); if (child) { uvRect.size.height = _lettersInfo[ctr].def.height; uvRect.size.width = _lettersInfo[ctr].def.width; uvRect.origin.x = _lettersInfo[ctr].def.U; uvRect.origin.y = _lettersInfo[ctr].def.V; child->setTexture(&_fontAtlas->getTexture(_lettersInfo[ctr].def.textureID)); child->setTextureRect(uvRect); } updateSpriteWithLetterDefinition(_reusedLetter,_lettersInfo[ctr].def,&_fontAtlas->getTexture(_lettersInfo[ctr].def.textureID)); _reusedLetter->setPosition(_lettersInfo[ctr].position); insertQuadFromSprite(_reusedLetter,vaildIndex++); } } } bool Label::computeAdvancesForString(unsigned short int *stringToRender) { if (_advances) { delete [] _advances; _advances = 0; } int letterCount = 0; _advances = _fontAtlas->getFont()->getAdvancesForTextUTF16(stringToRender, letterCount); if(!_advances) return false; else return true; } bool Label::setOriginalString(unsigned short *stringToSet) { if (_originalUTF16String) { delete [] _originalUTF16String; _originalUTF16String = 0; } int newStringLenght = cc_wcslen(stringToSet); _originalUTF16String = new unsigned short int [newStringLenght + 1]; memset(_originalUTF16String, 0, (newStringLenght + 1) * 2); memcpy(_originalUTF16String, stringToSet, (newStringLenght * 2)); _originalUTF16String[newStringLenght] = 0; return true; } bool Label::setCurrentString(unsigned short *stringToSet) { // set the new string if (_currentUTF16String) { delete [] _currentUTF16String; _currentUTF16String = 0; } // _currentUTF16String = stringToSet; // compute the advances return computeAdvancesForString(stringToSet); } void Label::resetCurrentString() { if ((!_currentUTF16String) && (!_originalUTF16String)) return; // set the new string if (_currentUTF16String) { delete [] _currentUTF16String; _currentUTF16String = 0; } int stringLenght = cc_wcslen(_originalUTF16String); _currentUTF16String = new unsigned short int [stringLenght + 1]; memcpy(_currentUTF16String, _originalUTF16String, stringLenght * 2); _currentUTF16String[stringLenght] = 0; } Sprite * Label::updateSpriteWithLetterDefinition(Sprite *spriteToUpdate, const FontLetterDefinition &theDefinition, Texture2D *theTexture) { if (!spriteToUpdate) { return 0; } else { Rect uvRect; uvRect.size.height = theDefinition.height; uvRect.size.width = theDefinition.width; uvRect.origin.x = theDefinition.U; uvRect.origin.y = theDefinition.V; SpriteFrame *frame = SpriteFrame::createWithTexture(theTexture, uvRect); if (frame) { spriteToUpdate->setBatchNode(this); spriteToUpdate->setTexture(theTexture); spriteToUpdate->setSpriteFrame(frame); spriteToUpdate->setAnchorPoint(Point(theDefinition.anchorX, theDefinition.anchorY)); } return spriteToUpdate; } } bool Label::recordLetterInfo(const cocos2d::Point& point,unsigned short int theChar, int spriteIndex) { if (static_cast(spriteIndex) >= _lettersInfo.size()) { LetterInfo tmpInfo; _lettersInfo.push_back(tmpInfo); } _fontAtlas->getLetterDefinitionForChar(theChar, _lettersInfo[spriteIndex].def); _lettersInfo[spriteIndex].position = point; _lettersInfo[spriteIndex].contentSize.width = _lettersInfo[spriteIndex].def.width; _lettersInfo[spriteIndex].contentSize.height = _lettersInfo[spriteIndex].def.height; return _lettersInfo[spriteIndex].def.validDefinition; } bool Label::recordPlaceholderInfo(int spriteIndex) { if (static_cast(spriteIndex) >= _lettersInfo.size()) { LetterInfo tmpInfo; _lettersInfo.push_back(tmpInfo); } _lettersInfo[spriteIndex].def.validDefinition = false; return false; } void Label::addChild(Node * child, int zOrder/* =0 */, int tag/* =0 */) { CCASSERT(0, "addChild: is not supported on Label."); } void Label::setLabelEffect(LabelEffect effect,const Color3B& effectColor) { if(_useDistanceField == false) return; _currLabelEffect = effect; _effectColor = effectColor; switch (_currLabelEffect) { case cocos2d::LabelEffect::NORMAL: setShaderProgram(ShaderCache::getInstance()->getProgram(GLProgram::SHADER_NAME_LABEL_DISTANCEFIELD_NORMAL)); break; case cocos2d::LabelEffect::OUTLINE: setShaderProgram(ShaderCache::getInstance()->getProgram(GLProgram::SHADER_NAME_LABEL_DISTANCEFIELD_OUTLINE)); break; case cocos2d::LabelEffect::SHADOW: setShaderProgram(ShaderCache::getInstance()->getProgram(GLProgram::SHADER_NAME_LABEL_DISTANCEFIELD_SHADOW)); break; case cocos2d::LabelEffect::GLOW: setShaderProgram(ShaderCache::getInstance()->getProgram(GLProgram::SHADER_NAME_LABEL_DISTANCEFIELD_GLOW)); break; default: return; } _uniformEffectColor = glGetUniformLocation(_shaderProgram->getProgram(), "v_effectColor"); } void Label::setFontSize(int fontSize) { _fontSize = fontSize; Node::setScale(1.0f*_fontSize/DISTANCEFIELD_ATLAS_FONTSIZE); } void Label::draw() { CC_PROFILER_START("CCSpriteBatchNode - draw"); // Optimization: Fast Dispatch if( _textureAtlas->getTotalQuads() == 0 ) { return; } CC_NODE_DRAW_SETUP(); if (_useDistanceField && _currLabelEffect != LabelEffect::NORMAL) { _shaderProgram->setUniformLocationWith3f(_uniformEffectColor, _effectColor.r/255.0f,_effectColor.g/255.0f,_effectColor.b/255.0f); } std::for_each(_children.begin(), _children.end(), [](Node* child){ child->updateTransform(); }); GL::blendFunc( _blendFunc.src, _blendFunc.dst ); _textureAtlas->drawQuads(); CC_PROFILER_STOP("CCSpriteBatchNode - draw"); } ///// PROTOCOL STUFF Sprite * Label::getLetter(int ID) { if (ID < getStringLenght()) { if(_lettersInfo[ID].def.validDefinition == false) return nullptr; Sprite* sp = static_cast(this->getChildByTag(ID)); if (!sp) { Rect uvRect; uvRect.size.height = _lettersInfo[ID].def.height; uvRect.size.width = _lettersInfo[ID].def.width; uvRect.origin.x = _lettersInfo[ID].def.U; uvRect.origin.y = _lettersInfo[ID].def.V; sp = Sprite::createWithTexture(&_fontAtlas->getTexture(_lettersInfo[ID].def.textureID),uvRect); sp->setBatchNode(this); sp->setAnchorPoint(Point(_lettersInfo[ID].def.anchorX, _lettersInfo[ID].def.anchorY)); sp->setPosition(_lettersInfo[ID].position); sp->setOpacity(_realOpacity); this->addSpriteWithoutQuad(sp, ID, ID); } return sp; } return nullptr; } float Label::getLetterPosXLeft( int index ) const { return _lettersInfo[index].position.x * _scaleX - (_lettersInfo[index].contentSize.width * _scaleX * _lettersInfo[index].def.anchorX); } float Label::getLetterPosXRight( int index ) const { return _lettersInfo[index].position.x * _scaleX + (_lettersInfo[index].contentSize.width * _scaleX * _lettersInfo[index].def.anchorX); } int Label::getCommonLineHeight() const { return _commonLineHeight; } int Label::getKerningForCharsPair(unsigned short first, unsigned short second) const { return 0; } int Label::getXOffsetForChar(unsigned short c) const { FontLetterDefinition tempDefinition; bool validDefinition = _fontAtlas->getLetterDefinitionForChar(c, tempDefinition); if (!validDefinition) return -1; return (tempDefinition.offsetX); } int Label::getYOffsetForChar(unsigned short c) const { FontLetterDefinition tempDefinition; bool validDefinition = _fontAtlas->getLetterDefinitionForChar(c, tempDefinition); if (!validDefinition) return -1; return (tempDefinition.offsetY); } int Label::getAdvanceForChar(unsigned short c, int hintPositionInString) const { if (_advances) { // not that advance contains the X offset already FontLetterDefinition tempDefinition; bool validDefinition = _fontAtlas->getLetterDefinitionForChar(c, tempDefinition); if (!validDefinition) return -1; return (_advances[hintPositionInString].width); } else { return -1; } } Rect Label::getRectForChar(unsigned short c) const { return _fontAtlas->getFont()->getRectForChar(c); } // string related stuff int Label::getStringNumLines() const { int quantityOfLines = 1; unsigned int stringLen = _currentUTF16String ? cc_wcslen(_currentUTF16String) : 0; if (stringLen == 0) return (-1); // count number of lines for (unsigned int i = 0; i < stringLen - 1; ++i) { unsigned short c = _currentUTF16String[i]; if (c == '\n') { quantityOfLines++; } } return quantityOfLines; } int Label::getStringLenght() const { return _currentUTF16String ? cc_wcslen(_currentUTF16String) : 0; } unsigned short Label::getCharAtStringPosition(int position) const { return _currentUTF16String[position]; } unsigned short * Label::getUTF8String() const { return _currentUTF16String; } void Label::assignNewUTF8String(unsigned short *newString) { setCurrentString(newString); } TextHAlignment Label::getTextAlignment() const { return _alignment; } // label related stuff float Label::getMaxLineWidth() const { return _width; } bool Label::breakLineWithoutSpace() const { return _lineBreakWithoutSpaces; } Size Label::getLabelContentSize() const { return getContentSize(); } void Label::setLabelContentSize(const Size &newSize) { setContentSize(newSize); } // RGBA protocol bool Label::isOpacityModifyRGB() const { return _isOpacityModifyRGB; } void Label::setOpacityModifyRGB(bool isOpacityModifyRGB) { _isOpacityModifyRGB = isOpacityModifyRGB; std::for_each(_children.begin(), _children.end(), [this](Node* child){ if (child) { RGBAProtocol *pRGBAProtocol = dynamic_cast(child); if (pRGBAProtocol) { pRGBAProtocol->setOpacityModifyRGB(_isOpacityModifyRGB); } } }); _reusedLetter->setOpacityModifyRGB(true); } unsigned char Label::getOpacity() const { return _realOpacity; } unsigned char Label::getDisplayedOpacity() const { return _displayedOpacity; } void Label::setOpacity(GLubyte opacity) { _displayedOpacity = _realOpacity = opacity; _reusedLetter->setOpacity(opacity); if( _cascadeOpacityEnabled ) { GLubyte parentOpacity = 255; RGBAProtocol* pParent = dynamic_cast(_parent); if (pParent && pParent->isCascadeOpacityEnabled()) { parentOpacity = pParent->getDisplayedOpacity(); } this->updateDisplayedOpacity(parentOpacity); } } void Label::updateDisplayedOpacity(GLubyte parentOpacity) { _displayedOpacity = _realOpacity * parentOpacity/255.0; std::for_each(_children.begin(), _children.end(), [this](Node* child){ Sprite *item = static_cast( child ); item->updateDisplayedOpacity(_displayedOpacity); }); V3F_C4B_T2F_Quad *quads = _textureAtlas->getQuads(); auto count = _textureAtlas->getTotalQuads(); Color4B color4( _displayedColor.r, _displayedColor.g, _displayedColor.b, _displayedOpacity ); if (_isOpacityModifyRGB) { color4.r *= _displayedOpacity/255.0f; color4.g *= _displayedOpacity/255.0f; color4.b *= _displayedOpacity/255.0f; } 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); } } bool Label::isCascadeOpacityEnabled() const { return false; } void Label::setCascadeOpacityEnabled(bool cascadeOpacityEnabled) { _cascadeOpacityEnabled = cascadeOpacityEnabled; } const Color3B& Label::getColor(void) const { return _realColor; } const Color3B& Label::getDisplayedColor() const { return _displayedColor; } void Label::setColor(const Color3B& color) { _displayedColor = _realColor = color; _reusedLetter->setColor(color); if( _cascadeColorEnabled ) { Color3B parentColor = Color3B::WHITE; RGBAProtocol* pParent = dynamic_cast(_parent); if (pParent && pParent->isCascadeColorEnabled()) parentColor = pParent->getDisplayedColor(); updateDisplayedColor(parentColor); } } void Label::updateDisplayedColor(const Color3B& parentColor) { _displayedColor.r = _realColor.r * parentColor.r/255.0; _displayedColor.g = _realColor.g * parentColor.g/255.0; _displayedColor.b = _realColor.b * parentColor.b/255.0; std::for_each(_children.begin(), _children.end(), [this](Node* child){ Sprite *item = static_cast( child ); item->updateDisplayedColor(_displayedColor); }); V3F_C4B_T2F_Quad *quads = _textureAtlas->getQuads(); auto count = _textureAtlas->getTotalQuads(); 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; } for (int index=0; indexupdateQuad(&quads[index], index); } } bool Label::isCascadeColorEnabled() const { return false; } void Label::setCascadeColorEnabled(bool cascadeColorEnabled) { _cascadeColorEnabled = cascadeColorEnabled; } std::string Label::getDescription() const { return StringUtils::format("