axmol/cocos/2d/CCLabel.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 _COCOS2D_CCLABEL_H_
#define _COCOS2D_CCLABEL_H_

#include "CCSpriteBatchNode.h"
#include "CCLabelTextFormatProtocol.h"
#include "ccTypes.h"

NS_CC_BEGIN

enum class GlyphCollection {
    
    DYNAMIC,
    NEHE,
    ASCII,
    CUSTOM
};

//fwd
struct FontLetterDefinition;
class FontAtlas;



class CC_DLL Label : public SpriteBatchNode, public LabelProtocol, public RGBAProtocol, public LabelTextFormatProtocol
{
public:
    
    // static create
    static Label* createWithTTF(const char* label, const char* fontFilePath, int fontSize, int lineSize = 0, TextHAlignment alignment = TextHAlignment::CENTER, GlyphCollection glyphs = GlyphCollection::NEHE, const char *customGlyphs = 0);
    
    static Label* createWithBMFont(const char* label, const char* bmfontFilePath, TextHAlignment alignment = TextHAlignment::CENTER, int lineSize = 0);
    
    bool setText(const char *stringToRender, float lineWidth, TextHAlignment alignment = TextHAlignment::LEFT, bool lineBreakWithoutSpaces = false);
    
    virtual void setString(const char *stringToRender) override;
    virtual void setAlignment(TextHAlignment alignment);
    virtual void setWidth(float width);
    virtual void setLineBreakWithoutSpace(bool breakWithoutSpace);
    virtual void setScale(float scale) override;
    virtual void setScaleX(float scaleX) override;
    virtual void setScaleY(float scaleY) override;

    // RGBAProtocol
    virtual bool isOpacityModifyRGB() const override;
    virtual void setOpacityModifyRGB(bool isOpacityModifyRGB) override;
    virtual void setOpacity(GLubyte opacity) override;
    virtual void updateDisplayedOpacity(GLubyte parentOpacity) override;
    virtual bool isCascadeOpacityEnabled() const override;
    virtual void setCascadeOpacityEnabled(bool cascadeOpacityEnabled) override;
    virtual void setColor(const Color3B& color) override;
    virtual void updateDisplayedColor(const Color3B& parentColor) override;
    virtual bool isCascadeColorEnabled() const override;
    virtual void setCascadeColorEnabled(bool cascadeColorEnabled) override;
    virtual const Color3B& getColor(void) const override;
    virtual const Color3B& getDisplayedColor() const override;
    virtual unsigned char  getOpacity() const override;
    virtual unsigned char  getDisplayedOpacity() const override;
    
     // CCLabelTextFormat protocol implementation
    virtual Sprite *                    getSpriteChild(int ID) const override;
    virtual Array  *                    getChildrenLetters() const override;
    virtual Sprite *                    getSpriteForChar(unsigned short int theChar, int spriteIndexHint) override;
    virtual float                       getLetterPosXLeft( Sprite* sp ) const override;
    virtual float                       getLetterPosXRight( Sprite* sp ) const override;

    
    // font related stuff
    virtual int                         getCommonLineHeight() const override;
    virtual int                         getKerningForCharsPair(unsigned short first, unsigned short second) const override;
    virtual int                         getXOffsetForChar(unsigned short c) const override;
    virtual int                         getYOffsetForChar(unsigned short c) const override;
    virtual int                         getAdvanceForChar(unsigned short c, int hintPositionInString) const override;
    virtual Rect                        getRectForChar(unsigned short c) const override;
    
    // string related stuff
    virtual int                         getStringNumLines() const override;
    virtual int                         getStringLenght() const override;
    virtual unsigned short              getCharAtStringPosition(int position) const override;
    virtual unsigned short *            getUTF8String() const override;
    virtual void                        assignNewUTF8String(unsigned short *newString) override;
    virtual TextHAlignment              getTextAlignment() const override;
    
    // label related stuff
    virtual float                       getMaxLineWidth() const override;
    virtual bool                        breakLineWithoutSpace() const override;
    virtual Size                        getLabelContentSize() const override;
    virtual void                        setLabelContentSize(const Size &newSize) override;
    
    // carloX
    const char * getString() const { return "not implemented"; }
    
private:
    /**
     * @js NA
     */
    Label(FontAtlas *atlas, TextHAlignment alignment);
    /**
     * @js NA
     * @lua NA
     */
   ~Label();
    
    static Label* createWithAtlas(FontAtlas *atlas, TextHAlignment alignment = TextHAlignment::LEFT, int lineSize = 0);
    
    bool init();
    
    void alignText();
    void hideAllLetters();
    void moveAllSpritesToCache();
    
    bool computeAdvancesForString(unsigned short int *stringToRender);
    bool setCurrentString(unsigned short *stringToSet);
    bool setOriginalString(unsigned short *stringToSet);
    void resetCurrentString();
    
    Sprite * getSprite();
    Sprite * createNewSpriteFromLetterDefinition(const FontLetterDefinition &theDefinition, Texture2D *theTexture);
    Sprite * updateSpriteWithLetterDefinition(Sprite *spriteToUpdate, const FontLetterDefinition &theDefinition, Texture2D *theTexture);
    Sprite * getSpriteForLetter(unsigned short int newLetter);
    Sprite * updateSpriteForLetter(Sprite *spriteToUpdate, unsigned short int newLetter);
    
    Array               *       _spriteArray;
    Array               *       _spriteArrayCache;
    float                       _commonLineHeight;
    bool                        _lineBreakWithoutSpaces;
    float                       _width;
    TextHAlignment              _alignment;
    unsigned short int *        _currentUTF8String;
    unsigned short int *        _originalUTF8String;
    Size               *        _advances;
    FontAtlas          *        _fontAtlas;
    Color3B                     _displayedColor;
    Color3B                     _realColor;
    bool                        _cascadeColorEnabled;
    bool                        _cascadeOpacityEnabled;
    unsigned char               _displayedOpacity;
    unsigned char               _realOpacity;
    bool                        _isOpacityModifyRGB;
    
    
};


NS_CC_END

#endif /*__COCOS2D_CCLABEL_H */