CCBitmapFontAtlas Class Reference

#import <CCBitmapFontAtlas.h>

Inherits CCSpriteSheet, CCLabelProtocol-p, and CCRGBAProtocol-p.

Collaboration diagram for CCBitmapFontAtlas:

List of all members.

Public Member Functions
(id)	- initWithString:fntFile:
(void)	- createFontChars
Static Public Member Functions
(void)	+ purgeCachedData
(id)	+ bitmapFontAtlasWithString:fntFile:
Properties
GLubyte	opacity
ccColor3B	color

---

Detailed Description

CCBitmapFontAtlas is a subclass of CCSpriteSheet.

Features:

• Treats each character like a CCSprite. This means that each individual character can be:
  • rotated
  • scaled
  • translated
  • tinted
  • chage the opacity
• It can be used as part of a menu item.
• anchorPoint can be used to align the "label"
• Supports AngelCode text format

Limitations:

• All inner characters are using an anchorPoint of (0.5f, 0.5f) and it is not recommend to change it because it might affect the rendering

CCBitmapFontAtlas implements the protocol CCLabelProtocol, like CCLabel and CCLabelAtlas. CCBitmapFontAtlas has the flexibility of CCLabel, the speed of CCLabelAtlas and all the features of CCSprite. If in doubt, use CCBitmapFontAtlas instead of CCLabelAtlas / CCLabel.

Supported editors:

• http://www.n4te.com/hiero/hiero.jnlp
• http://slick.cokeandcode.com/demos/hiero.jnlp
• http://www.angelcode.com/products/bmfont/

Since:

v0.8

Definition at line 136 of file CCBitmapFontAtlas.h.

---

Member Function Documentation

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

creates a bitmap font altas with an initial string and the FNT file

- (void) createFontChars

updates the font chars based on the string to render

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

init a bitmap font altas with an initial string and the FNT file

+ (void) purgeCachedData

Purges the cached data. Removes from memory the cached configurations and the atlas name dictionary.

Since:

v0.99.3

---

Property Documentation

- (ccColor3B) color [read, write, assign]

conforms to CCRGBAProtocol protocol

Definition at line 159 of file CCBitmapFontAtlas.h.

- (GLubyte) opacity [read, write, assign]

conforms to CCRGBAProtocol protocol

Definition at line 157 of file CCBitmapFontAtlas.h.

---

The documentation for this class was generated from the following file:

• /Users/ricardoquesada/progs/cocos2d-iphone/cocos2d/CCBitmapFontAtlas.h