axmol/cocos/2d/CCTextImage.h

/****************************************************************************
 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.
 ****************************************************************************/

#ifndef _TextImage_h_
#define _TextImage_h_

//#include "CCFont.h"
#include <vector>

NS_CC_BEGIN

class Font;

/** @brief GlyphDef defines one single glyph (character) in a text image
 *
 * it defines the bounding box for the glyph in the texture page, the character the padding (spacing) between characters
 *
 */

class CC_DLL GlyphDef
{
public:
    
    GlyphDef() : _validGlyph(false)                                     {   /*do nothing*/                              }
    GlyphDef(unsigned short int letterUTF8, const Rect &rect)           { _gliphRect = rect; _uTF16Letter = letterUTF8; }
    
    void setUTF16Letter(unsigned short int letterUTF8)                  { _uTF16Letter  = letterUTF8;   }
    void setRect(const Rect & theRect)                                  { _gliphRect = theRect;         }
    unsigned short int getUTF8Letter()                                  { return _uTF16Letter;          }
    const Rect &  getRect() const                                       { return _gliphRect;            }
    void    setPadding(float padding)                                   { _padding = padding;           }
    float   getPadding()                                                { return _padding;              }
    void    setCommonHeight(float commonHeight)                         { _commonHeight = commonHeight; }
    float   getCommonHeight()                                           { return _commonHeight;         }
    void    setValid(bool isValid)                                      { _validGlyph = isValid;        }
    bool    isValid()                                                   { return _validGlyph;           }
    
private:
    
    Rect                _gliphRect;
    unsigned short int  _uTF16Letter;
    float               _padding;
    float               _commonHeight;
    bool                _validGlyph;
    
};

/** @brief TextLineDef define a line of text in a text image texture page
 *
 * conllects all the GlyphDef for a text line plus line size and line position in text image space
 *
 */
class CC_DLL TextLineDef
{
public:
    
    TextLineDef(float x, float y, float width, float height);
    
    float getX() const        { return _x;        }
    float getY() const        { return _y;        }
    float getWidth() const    { return _width;    }
    float getHeight() const   { return _height;   }
    
    void  addGlyph(GlyphDef theGlyph)               { _glyphs.push_back(theGlyph);  }
    int   getNumGlyph()  const                      { return  static_cast<int>(_glyphs.size()); }
    const GlyphDef & getGlyphAt(int index) const    { return _glyphs[index];        }
    
private:
    
    float                   _x;
    float                   _y;
    float                   _width;
    float                   _height;
    std::vector<GlyphDef>   _glyphs;
    
};

/** @brief TextPageDef defines one text image page (a TextImage can have/use more than one page)
 *
 * collects all the TextLineDef for one page, the witdh and height of the page and the  graphics (texture) for the page
 *
 */
class CC_DLL TextPageDef
{
public:
    /**
     * @js NA
     */
     TextPageDef(int pageNum, int width, int height);
    /**
     * @js NA
     * @lua NA
     */
    ~TextPageDef();
    
    void addLine(TextLineDef *theLine)      { _lines.push_back(theLine); }
    int  getNumLines() const                { return  static_cast<int>(_lines.size());      }
    TextLineDef * getLineAt(int index) const        { return _lines[index];      }
    int getWidth() const                            { return _width;             }
    int getHeight() const                           { return _height;            }
    int getPageNumber() const                       { return _pageNum;           }
    void setPageData(unsigned char *data)           { _pageData = data;          }
    const unsigned char * getPageData() const       { return _pageData;          }
    Texture2D     *getPageTexture();
    void preparePageTexture(bool releaseRAWData = true);
    
private:
    
    bool generatePageTexture(bool releasePageData = false);
    
    int                         _pageNum;
    int                         _width;
    int                         _height;
    unsigned char *             _pageData;
    Texture2D   *               _pageTexture;
    std::vector<TextLineDef *>  _lines;
    
};

/** @brief CCTextFontPages collection of pages (TextPageDef)
 *
 *  A TextImage is composed by one or more text pages. This calss collects all of those pages
 */
class CC_DLL TextFontPagesDef
{
public:
    /**
     * @js ctor
     */
    TextFontPagesDef();
    /**
     * @js NA
     * @lua NA
     */
   ~TextFontPagesDef();
    
    void addPage(TextPageDef *newPage)         { _pages.push_back(newPage);    }
    int  getNumPages()  const                  { return static_cast<int>(_pages.size());         }
    TextPageDef* getPageAt(int index) const    { return _pages[index];         }
    
private:
    
    std::vector<TextPageDef *>    _pages;
    
};

/** @brief TextImage 
 *
 */
class CC_DLL TextImage
{
public:
    /**
     * @js ctor
     */
    TextImage();
    /**
     * @js NA
     * @lua NA
     */
   ~TextImage();
    
    bool initWithString(const char *text, int width, int height, Font* font, bool releaseRAWData = true);
    
    TextFontPagesDef  * getPages()  const  { return _fontPages; }
    Font              * getFont() const    { return _font;      }
    
private:
    
    bool createImageDataFromPages(TextFontPagesDef *thePages, bool releaseRAWData = true);
    bool addGlyphsToLine(TextLineDef *line, const char *lineText, bool textIsUTF16 = false);
    bool generateTextGlyphs(const char * text);
    int  getNumGlyphsFittingInSize(std::map<unsigned short int, GlyphDef> &glyphDefs, unsigned short int *strUTF8, Font *font, Size *constrainSize, int &outNewSize);
    bool createPageDefinitions(unsigned short int *inText, int imageWidth, int imageHeight, int lineHeight);
    unsigned char * preparePageGlyphData(TextPageDef *thePage);
    
    // glyph rendering
    unsigned char * renderGlyphData(TextPageDef *thePage);
    
    std::map<unsigned short int, GlyphDef>      _textGlyphs;
    TextFontPagesDef *                          _fontPages;
    Font             *                          _font;
};


NS_CC_END


#endif