Improve bmfont api

cocos/2d/CCFontAtlasCache.cpp

@@ -88,22 +88,53 @@ FontAtlas* FontAtlasCache::getFontAtlasTTF(const _ttfConfig* config)
  return nullptr;
 }
 
-FontAtlas* FontAtlasCache::getFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset /* = Vec2::ZERO */)
+FontAtlas* FontAtlasCache::getFontAtlasFNT(const std::string& fontFileName)
 {
- auto realFontFilename = FileUtils::getInstance()->getNewFilename(fontFileName); // resolves real file path, to prevent storing multiple atlases for the same file.
+ return getFontAtlasFNT(fontFileName, Rect::ZERO, false);
+}
+
+FontAtlas* FontAtlasCache::getFontAtlasFNT(const std::string& fontFileName, const std::string& subTextureKey)
+{
+ const auto realFontFilename = FileUtils::getInstance()->getNewFilename(fontFileName); // resolves real file path, to prevent storing multiple atlases for the same file.
+ std::string atlasName = subTextureKey + " " + realFontFilename;
+
+ const auto it = _atlasMap.find(atlasName);
+ if (it == _atlasMap.end())
+ {
+ const auto font = FontFNT::create(realFontFilename, subTextureKey);
+
+ if (font)
+ {
+ const auto tempAtlas = font->createFontAtlas();
+ if (tempAtlas)
+ {
+ _atlasMap[atlasName] = tempAtlas;
+ return _atlasMap[atlasName];
+ }
+ }
+ }
+ else
+ return it->second;
+
+ return nullptr;
+}
+
+FontAtlas* FontAtlasCache::getFontAtlasFNT(const std::string& fontFileName, const Rect& imageRect, bool imageRotated)
+{
+ const auto realFontFilename = FileUtils::getInstance()->getNewFilename(fontFileName); // resolves real file path, to prevent storing multiple atlases for the same file.
  char keyPrefix[ATLAS_MAP_KEY_PREFIX_BUFFER_SIZE];
- snprintf(keyPrefix, ATLAS_MAP_KEY_PREFIX_BUFFER_SIZE, "%.2f %.2f ", imageOffset.x, imageOffset.y);
+ snprintf(keyPrefix, ATLAS_MAP_KEY_PREFIX_BUFFER_SIZE, "%.2f %.2f ", imageRect.origin.x, imageRect.origin.y);
  std::string atlasName(keyPrefix);
  atlasName += realFontFilename;
 
- auto it = _atlasMap.find(atlasName);
+ const auto it = _atlasMap.find(atlasName);
  if ( it == _atlasMap.end() )
  {
- auto font = FontFNT::create(realFontFilename, imageOffset);
+ const auto font = FontFNT::create(realFontFilename, imageRect, imageRotated);
 
  if(font)
  {
- auto tempAtlas = font->createFontAtlas();
+ const auto tempAtlas = font->createFontAtlas();
  if (tempAtlas)
  {
  _atlasMap[atlasName] = tempAtlas;
@@ -117,6 +148,11 @@ FontAtlas* FontAtlasCache::getFontAtlasFNT(const std::string& fontFileName, cons
  return nullptr;
 }
 
+FontAtlas* FontAtlasCache::getFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset)
+{
+ return getFontAtlasFNT(fontFileName, Rect(imageOffset.x, imageOffset.y, 0, 0), false);
+}
+
 FontAtlas* FontAtlasCache::getFontAtlasCharMap(const std::string& plistFile)
 {
  const std::string& atlasName = plistFile;
@@ -220,10 +256,10 @@ bool FontAtlasCache::releaseFontAtlas(FontAtlas *atlas)
  return false;
 }
 
-void FontAtlasCache::reloadFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset/* = Vec2::ZERO*/)
+void FontAtlasCache::reloadFontAtlasFNT(const std::string& fontFileName, const Rect& imageRect, bool imageRotated)
 {
  char keyPrefix[ATLAS_MAP_KEY_PREFIX_BUFFER_SIZE];
- snprintf(keyPrefix, ATLAS_MAP_KEY_PREFIX_BUFFER_SIZE, "%.2f %.2f ", imageOffset.x, imageOffset.y);
+ snprintf(keyPrefix, ATLAS_MAP_KEY_PREFIX_BUFFER_SIZE, "%.2f %.2f ", imageRect.origin.x, imageRect.origin.y);
  std::string atlasName(keyPrefix);
  atlasName += fontFileName;
 
@@ -234,7 +270,7 @@ void FontAtlasCache::reloadFontAtlasFNT(const std::string& fontFileName, const V
  _atlasMap.erase(it);
  }
  FontFNT::reloadBMFontResource(fontFileName);
- auto font = FontFNT::create(fontFileName, imageOffset);
+ auto font = FontFNT::create(fontFileName, imageRect, imageRotated);
  if (font)
  {
  auto tempAtlas = font->createFontAtlas();
@@ -243,7 +279,11 @@ void FontAtlasCache::reloadFontAtlasFNT(const std::string& fontFileName, const V
  _atlasMap[atlasName] = tempAtlas;
  }
  }
+}
 
+void FontAtlasCache::reloadFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset)
+{
+ reloadFontAtlasFNT(fontFileName, Rect(imageOffset.x, imageOffset.y, 0, 0), false);
 }
 
 void FontAtlasCache::unloadFontAtlasTTF(const std::string& fontFileName)

cocos/2d/CCFontAtlasCache.h

@@ -42,7 +42,11 @@ class CC_DLL FontAtlasCache
 { 
 public:
  static FontAtlas* getFontAtlasTTF(const _ttfConfig* config);
- static FontAtlas* getFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset = Vec2::ZERO);
+
+ static FontAtlas* getFontAtlasFNT(const std::string& fontFileName);
+ static FontAtlas* getFontAtlasFNT(const std::string& fontFileName, const std::string& subTextureKey);
+ static FontAtlas* getFontAtlasFNT(const std::string& fontFileName, const Rect& imageRect, bool imageRotated);
+ CC_DEPRECATED_ATTRIBUTE static FontAtlas* getFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset);
 
  static FontAtlas* getFontAtlasCharMap(const std::string& charMapFile, int itemWidth, int itemHeight, int startCharMap);
  static FontAtlas* getFontAtlasCharMap(Texture2D* texture, int itemWidth, int itemHeight, int startCharMap);
@@ -59,7 +63,9 @@ class CC_DLL FontAtlasCache
  CAUTION : All component use this font texture should be reset font name, though the file name is same!
  otherwise, it will cause program crash!
  */
- static void reloadFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset = Vec2::ZERO);
+ static void reloadFontAtlasFNT(const std::string& fontFileName, const Rect& imageRect, bool imageRotated);
+
+ CC_DEPRECATED_ATTRIBUTE static void reloadFontAtlasFNT(const std::string& fontFileName, const Vec2& imageOffset = Vec2::ZERO);
 
  /** Unload all texture atlas texture create by special file name.
  CAUTION : All component use this font texture should be reset font name, though the file name is same!

cocos/2d/CCFontFNT.cpp

@@ -26,6 +26,7 @@
 
 #include "2d/CCFontFNT.h"
 #include "2d/CCFontAtlas.h"
+#include "2d/CCSpriteFrameCache.h"
 #include "platform/CCFileUtils.h"
 #include "base/CCConfiguration.h"
 #include "base/CCDirector.h"
@@ -393,9 +394,10 @@ void BMFontConfiguration::parseImageFileName(const char* line, const std::string
  int pageId;
  sscanf(line, "page id=%d", &pageId);
  CCASSERT(pageId == 0, "LabelBMFont file could not be found");
+
  // file 
  char fileName[255];
- sscanf(strchr(line,'"') + 1, "%[^\"]", fileName);
+ sscanf(strstr(line, "file=\"") + 6, "%[^\"]", fileName);
  _atlasName = FileUtils::getInstance()->fullPathFromRelativeFile(fileName, fntFile);
 }
 
@@ -508,20 +510,59 @@ void BMFontConfiguration::parseKerningEntry(const char* line)
  _kerningDictionary[key] = amount;
 }
 
-FontFNT * FontFNT::create(const std::string& fntFilePath, const Vec2& imageOffset /* = Vec2::ZERO */)
+FontFNT * FontFNT::create(const std::string& fntFilePath, const Rect& imageRect, bool imageRotated)
 {
- BMFontConfiguration *newConf = FNTConfigLoadFile(fntFilePath);
+ const auto newConf = FNTConfigLoadFile(fntFilePath);
  if (!newConf)
  return nullptr;
 
+ const auto tempFont = new FontFNT(newConf, imageRect, imageRotated);
+
+ if (!tempFont)
+ {
+ return nullptr;
+ }
+ tempFont->setFontSize(newConf->_fontSize);
+ tempFont->autorelease();
+ return tempFont;
+}
+
+FontFNT* FontFNT::create(const std::string& fntFilePath, const std::string& subTextureKey)
+{
+ const auto newConf = FNTConfigLoadFile(fntFilePath);
+ if (!newConf)
+ return nullptr;
+
+ const auto frame = SpriteFrameCache::getInstance()->getSpriteFrameByName(subTextureKey);
+ if (!frame)
+ {
+ return nullptr;
+ }
+ auto tempFont = new FontFNT(newConf, frame->getRectInPixels(), frame->isRotated());
+
+ if (!tempFont)
+ {
+ return nullptr;
+ }
+ tempFont->setFontSize(newConf->_fontSize);
+ tempFont->autorelease();
+ return tempFont;
+}
+
+FontFNT* FontFNT::create(const std::string& fntFilePath)
+{
+ const auto newConf = FNTConfigLoadFile(fntFilePath);
+ if (!newConf)
+ return nullptr;
+
  // add the texture
- Texture2D *tempTexture = Director::getInstance()->getTextureCache()->addImage(newConf->getAtlasName());
+ const auto tempTexture = Director::getInstance()->getTextureCache()->addImage(newConf->getAtlasName());
  if (!tempTexture)
  {
  return nullptr;
  }
-
- FontFNT *tempFont = new FontFNT(newConf,imageOffset);
+ FontFNT* tempFont = new FontFNT(newConf);
+
  tempFont->setFontSize(newConf->_fontSize);
  if (!tempFont)
  {
@@ -531,13 +572,26 @@ FontFNT * FontFNT::create(const std::string& fntFilePath, const Vec2& imageOffse
  return tempFont;
 }
 
-FontFNT::FontFNT(BMFontConfiguration *theContfig, const Vec2& imageOffset /* = Vec2::ZERO */)
-:_configuration(theContfig)
-,_imageOffset(CC_POINT_PIXELS_TO_POINTS(imageOffset))
+FontFNT* FontFNT::create(const std::string& fntFilePath, const Vec2& imageOffset)
+{
+ return create(fntFilePath, Rect(imageOffset.x, imageOffset.y, 0, 0), false);
+}
+
+FontFNT::FontFNT(BMFontConfiguration *theContfig, const Rect& imageRect, bool imageRotated)
+: _configuration(theContfig)
+, _imageRectInPoints(CC_RECT_PIXELS_TO_POINTS(imageRect))
+, _imageRotated(imageRotated)
 {
  _configuration->retain();
 }
 
+FontFNT::FontFNT(BMFontConfiguration* theContfig)
+: _configuration(theContfig)
+, _imageRectInPoints(Rect::ZERO)
+, _imageRotated(false)
+{
+}
+
 FontFNT::~FontFNT()
 {
  _configuration->release();
@@ -627,24 +681,39 @@ FontAtlas * FontFNT::createFontAtlas()
  }
 
  tempAtlas->setLineHeight(originalLineHeight * factor);
-
+
+ auto rw = _imageRectInPoints.size.width;
+ auto rh = _imageRectInPoints.size.height;
+
+ if (_imageRotated)
+ std::swap(rw, rh);
+
+ const auto left = _imageRectInPoints.origin.x;
+ const auto right = _imageRectInPoints.origin.x + rw;
+ const auto top = _imageRectInPoints.origin.y;
+
  for (auto&& e : _configuration->_fontDefDictionary)
  {
  BMFontDef& fontDef = e.second;
- 
+
  FontLetterDefinition tempDefinition;
 
- Rect tempRect;
-
- tempRect = fontDef.rect;
- tempRect = CC_RECT_PIXELS_TO_POINTS(tempRect);
+ const auto tempRect = CC_RECT_PIXELS_TO_POINTS(fontDef.rect);
 
  tempDefinition.offsetX = fontDef.xOffset;
  tempDefinition.offsetY = fontDef.yOffset;
-
- tempDefinition.U = tempRect.origin.x + _imageOffset.x;
- tempDefinition.V = tempRect.origin.y + _imageOffset.y;
-
+
+ if (_imageRotated)
+ {
+ tempDefinition.U = right - tempRect.origin.y - tempRect.size.height;
+ tempDefinition.V = tempRect.origin.x + top;
+ }
+ else
+ {
+ tempDefinition.U = tempRect.origin.x + left;
+ tempDefinition.V = tempRect.origin.y + top;
+ }
+
  tempDefinition.width = tempRect.size.width;
  tempDefinition.height = tempRect.size.height;
 
@@ -653,7 +722,7 @@ FontAtlas * FontFNT::createFontAtlas()
 
  tempDefinition.validDefinition = true;
  tempDefinition.xAdvance = fontDef.xAdvance;
- tempDefinition.rotated = false;
+ tempDefinition.rotated = _imageRotated;
 
  // add the new definition
  if (65535 < fontDef.charID) {
@@ -690,12 +759,12 @@ void FontFNT::reloadBMFontResource(const std::string& fntFilePath)
  {
  s_configurations->erase(fntFilePath);
  }
+
  ret = BMFontConfiguration::create(fntFilePath);
  if (ret)
  {
  s_configurations->insert(fntFilePath, ret);
  Director::getInstance()->getTextureCache()->reloadTexture(ret->getAtlasName());
-
  }
 }
 

cocos/2d/CCFontFNT.h

@@ -79,15 +79,19 @@ class CC_DLL BMFontConfiguration : public Ref
 
  //! FNTConfig: Common Height Should be signed (issue #1343)
  int _commonHeight;
+
  //! Padding
  BMFontPadding _padding;
+
  //! atlas name
  std::string _atlasName;
+
  //! values for kerning
  std::unordered_map<uint64_t /* key */, int /* amount */> _kerningDictionary;
 
  // Character Set defines the letters that actually exist in the font
  std::set<unsigned int>* _characterSet;
+
  //! Font Size
  int _fontSize;
 public:
@@ -136,7 +140,12 @@ class CC_DLL FontFNT : public Font
 
 public:
 
- static FontFNT * create(const std::string& fntFilePath, const Vec2& imageOffset = Vec2::ZERO);
+ static FontFNT* create(const std::string& fntFilePath, const Rect& imageRect, bool imageRotated);
+ static FontFNT* create(const std::string& fntFilePath, const std::string& subTextureKey);
+ static FontFNT* create(const std::string& fntFilePath);
+
+ CC_DEPRECATED_ATTRIBUTE static FontFNT* create(const std::string& fntFilePath, const Vec2& imageOffset = Vec2::ZERO);
+
  /** Purges the cached data.
  Removes from memory the cached configurations and the atlas name dictionary.
  */
@@ -153,17 +162,22 @@ class CC_DLL FontFNT : public Font
 
 protected:
 
- FontFNT(BMFontConfiguration *theContfig, const Vec2& imageOffset = Vec2::ZERO);
+ FontFNT(BMFontConfiguration* theContfig, const Rect& imageRect, bool imageRotated);
+ FontFNT(BMFontConfiguration* theContfig);
+
  /**
  * @js NA
  * @lua NA
  */
  virtual ~FontFNT();
 
  BMFontConfiguration* _configuration;
+
  int getHorizontalKerningForChars(char32_t firstChar, char32_t secondChar) const;
-
- Vec2 _imageOffset;
+
+ Rect _imageRectInPoints;
+ bool _imageRotated;
+
  //User defined font size
  float _fontSize;
 };