/Users/rquesada/progs/cocos2d-iphone/cocos2d/CCLabelBMFont.h

/*
 * cocos2d for iPhone: http://www.cocos2d-iphone.org
 *
 * Copyright (c) 2008-2010 Ricardo Quesada
 * Copyright (c) 2011 Zynga Inc.
 * 
 * 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.
 *
 * Portions of this code are based and inspired on:
 *   http://www.71squared.co.uk/2009/04/iphone-game-programming-tutorial-4-bitmap-font-class
 *   by Michael Daley
 * 
 * Use any of these editors to generate BMFonts:
 *   http://glyphdesigner.71squared.com/ (Commercial, Mac OS X)
 *   http://www.n4te.com/hiero/hiero.jnlp (Free, Java)
 *   http://slick.cokeandcode.com/demos/hiero.jnlp (Free, Java)
 *   http://www.angelcode.com/products/bmfont/ (Free, Windows only)
 */

#import "CCSpriteBatchNode.h"
#import "Support/uthash.h"

struct _KerningHashElement;

typedef struct _BMFontDef {
        unsigned int charID;
        CGRect rect;
        int xOffset;
        int yOffset;
        int xAdvance;
} ccBMFontDef;

typedef struct _BMFontPadding {
        int     left;
        int top;
        int right;
        int bottom;
} ccBMFontPadding;

enum {
        // how many characters are supported
        kCCBMFontMaxChars = 2048, //256,
};

@interface CCBMFontConfiguration : NSObject
{
// XXX: Creating a public interface so that the bitmapFontArray[] is accesible
@public
        // The characters building up the font
        ccBMFontDef     BMFontArray_[kCCBMFontMaxChars];
        
        // FNTConfig: Common Height
        NSUInteger              commonHeight_;
        
        // Padding
        ccBMFontPadding padding_;
        
        // atlas name
        NSString                *atlasName_;

        // values for kerning
        struct _KerningHashElement      *kerningDictionary_;
}

+(id) configurationWithFNTFile:(NSString*)FNTfile;
-(id) initWithFNTfile:(NSString*)FNTfile;
@end


@interface CCLabelBMFont : CCSpriteBatchNode <CCLabelProtocol, CCRGBAProtocol>
{
        // string to render
        NSString                *string_;
        
        CCBMFontConfiguration   *configuration_;

        // texture RGBA
        GLubyte         opacity_;
        ccColor3B       color_;
        BOOL opacityModifyRGB_;
}

+(void) purgeCachedData;

@property (nonatomic,readwrite) GLubyte opacity;
@property (nonatomic,readwrite) ccColor3B color;


+(id) labelWithString:(NSString*)string fntFile:(NSString*)fntFile;

+(id) bitmapFontAtlasWithString:(NSString*)string fntFile:(NSString*)fntFile DEPRECATED_ATTRIBUTE;

-(id) initWithString:(NSString*)string fntFile:(NSString*)fntFile;

-(void) createFontChars;
@end

CCBMFontConfiguration * FNTConfigLoadFile( NSString *file );
void FNTConfigRemoveCache( void );



DEPRECATED_ATTRIBUTE @interface CCBitmapFontAtlas : CCLabelBMFont
@end