#include <CCLabelBMFont.h>

Inheritance diagram for CCLabelBMFont:

Public Member Functions
	CCLabelBMFont ()
virtual	~CCLabelBMFont ()
bool	init ()
	Initializes the instance of CCNode. More...

bool	initWithString (const char str, const char fntFile, float width=kCCLabelAutomaticWidth, CCTextAlignment alignment=kCCTextAlignmentLeft, CCPoint imageOffset=CCPointZero)
	init a bitmap font atlas with an initial string and the FNT file More...

void	createFontChars ()
	updates the font chars based on the string to render More...

virtual void	setString (const char *newString)
	Sets a new label using an string. More...

virtual void	setString (const char *newString, bool needUpdateLabel)
virtual const char *	getString (void)
	Returns the string that is currently being used in this label. More...

virtual void	setCString (const char *label)
virtual void	setAnchorPoint (const CCPoint &var)
	Sets the anchor point in percent. More...

virtual void	updateLabel ()
virtual void	setAlignment (CCTextAlignment alignment)
virtual void	setWidth (float width)
virtual void	setLineBreakWithoutSpace (bool breakWithoutSpace)
virtual void	setScale (float scale)
	Changes both X and Y scale factor of the node. More...

virtual void	setScaleX (float scaleX)
	Changes the scale factor on X axis of this node. More...

virtual void	setScaleY (float scaleY)
	Changes the scale factor on Y axis of this node. More...

virtual bool	isOpacityModifyRGB ()
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

virtual void	setOpacityModifyRGB (bool isOpacityModifyRGB)
	Changes the OpacityModifyRGB property. More...

virtual GLubyte	getOpacity ()
	Returns the opacity. More...

virtual GLubyte	getDisplayedOpacity ()
	Returns the displayed opacity. More...

virtual void	setOpacity (GLubyte opacity)
	Changes the opacity. More...

virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
	recursive method that updates the displayed opacity. More...

virtual bool	isCascadeOpacityEnabled ()
	whether or not opacity should be propagated to its children. More...

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const ccColor3B &	getColor (void)
	Returns color that is currently used. More...

virtual const ccColor3B &	getDisplayedColor ()
	Returns the displayed color. More...

virtual void	setColor (const ccColor3B &color)
	@ More...

virtual void	updateDisplayedColor (const ccColor3B &parentColor)
	recursive method that updates display color More...

virtual bool	isCascadeColorEnabled ()
	whether or not color should be propagated to its children. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
void	setFntFile (const char *fntFile)
const char *	getFntFile ()
CCBMFontConfiguration *	getConfiguration () const
Public Member Functions inherited from CCSpriteBatchNode
	CCSpriteBatchNode ()
	~CCSpriteBatchNode ()
CCTextureAtlas *	getTextureAtlas (void)
void	setTextureAtlas (CCTextureAtlas *textureAtlas)
CCArray *	getDescendants (void)
bool	initWithTexture (CCTexture2D *tex, unsigned int capacity)
	initializes a CCSpriteBatchNode with a texture2d and capacity of children. More...

bool	initWithFile (const char *fileImage, unsigned int capacity)
	initializes a CCSpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and a capacity of children. More...

bool	init ()
	Initializes the instance of CCNode. More...

void	increaseAtlasCapacity ()
var	increaseAtlasCapacity ()
local	increaseAtlasCapacity ()
void	removeChildAtIndex (unsigned int index, bool doCleanup)
	removes a child given a certain index. More...

var	removeChildAtIndex ( var index, var doCleanup)
	removes a child given a certain index. More...

local	removeChildAtIndex ( local index, local doCleanup)
	removes a child given a certain index. More...

void	insertChild (CCSprite *child, unsigned int index)
void	appendChild (CCSprite *sprite)
void	removeSpriteFromAtlas (CCSprite *sprite)
var	removeSpriteFromAtlas ( var sprite)
local	removeSpriteFromAtlas ( local sprite)
unsigned int	rebuildIndexInOrder (CCSprite *parent, unsigned int index)
local	rebuildIndexInOrder ( local parent, local index)
unsigned int	highestAtlasIndexInChild (CCSprite *sprite)
unsigned int	lowestAtlasIndexInChild (CCSprite *sprite)
var	lowestAtlasIndexInChild ( var sprite)
local	lowestAtlasIndexInChild ( local sprite)
unsigned int	atlasIndexForChild (CCSprite *sprite, int z)
local	atlasIndexForChild ( local sprite, local z)
void	reorderBatch (bool reorder)
virtual CCTexture2D *	getTexture (void)
	Returns the currently used texture. More...

virtual void	setTexture (CCTexture2D *texture)
	Sets a new texuture. More...

virtual void	setBlendFunc (ccBlendFunc blendFunc)
	Sets the source blending function. More...

local	setBlendFunc ( local blendFunc)
	Sets the source blending function. More...

virtual ccBlendFunc	getBlendFunc (void)
	Returns the blending function that is currently being used. More...

local	getBlendFunc ()
	Returns the blending function that is currently being used. More...

virtual void	visit (void)
	Visits this node's children and draw them recursively. More...

virtual void	addChild (CCNode *child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (CCNode *child, int zOrder)
	Adds a child to the container with a z-order. More...

local	addChild ( local child, local zOrder)
	Adds a child to the container with a z-order. More...

virtual void	addChild (CCNode *child, int zOrder, int tag)
	Adds a child to the container with z order and tag. More...

local	addChild ( local child, local zOrder, local tag)
	Adds a child to the container with z order and tag. More...

virtual void	reorderChild (CCNode *child, int zOrder)
	Reorders a child according to a new z value. More...

virtual void	removeChild (CCNode *child, bool cleanup)
	Removes a child from the container. More...

var	removeChild ( var child, var cleanup)
	Removes a child from the container. More...

local	removeChild ( local child, local cleanup)
	Removes a child from the container. More...

virtual void	removeAllChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

virtual void	draw (void)
	Override this method to draw your own node. More...

local	draw ()
	Override this method to draw your own node. More...

Public Member Functions inherited from CCNode
virtual CCCamera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...

virtual bool	isRunning ()
	Returns whether or not the node accepts event callbacks. More...

virtual void	cleanup (void)
	Stops all running actions and schedulers. More...

CCRect	boundingBox (void)
	Returns a "local" axis aligned bounding box of the node. More...

virtual void	setZOrder (int zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	_setZOrder (int z)
	Sets the z order which stands for the drawing order. More...

virtual int	getZOrder ()
	Gets the Z order of this node. More...

virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...

virtual float	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...

virtual float	getScaleX ()
	Returns the scale factor on X axis of this node. More...

virtual float	getScaleY ()
	Returns the scale factor on Y axis of this node. More...

virtual float	getScale ()
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

virtual void	setScale (float fScaleX, float fScaleY)
	Changes both X and Y scale factor of the node. More...

virtual void	setPosition (const CCPoint &position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...

virtual const CCPoint &	getPosition ()
	Gets the position (x,y) of the node in OpenGL coordinates. More...

virtual void	setPosition (float x, float y)
	Sets position in a more efficient way. More...

virtual void	getPosition (float x, float y)
	Gets position in a more efficient way, returns two number instead of a CCPoint object. More...

virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...

virtual float	getPositionX (void)
virtual void	setPositionY (float y)
virtual float	getPositionY (void)
virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...

virtual float	getSkewX ()
	Returns the X skew angle of the node in degrees. More...

virtual void	setSkewY (float fSkewY)
	Changes the Y skew angle of the node in degrees. More...

virtual float	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...

virtual const CCPoint &	getAnchorPoint ()
	Returns the anchor point in percent. More...

virtual const CCPoint &	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...

virtual void	setContentSize (const CCSize &contentSize)
	Sets the untransformed size of the node. More...

virtual const CCSize &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

virtual bool	isVisible ()
	Determines if the node is visible. More...

virtual void	setRotation (float fRotation)
	Sets the rotation (angle) of the node in degrees. More...

virtual float	getRotation ()
	Returns the rotation of the node in degrees. More...

virtual void	setRotationX (float fRotaionX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

virtual float	getRotationX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual void	setRotationY (float fRotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual void	setOrderOfArrival (unsigned int uOrderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

virtual unsigned int	getOrderOfArrival ()
	Returns the arrival order, indecates which children is added previously. More...

virtual void	setGLServerState (ccGLServerState glServerState)
	Sets the state of OpenGL server side. More...

virtual ccGLServerState	getGLServerState ()
	Returns the state of OpenGL server side. More...

virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition ()
	Gets whether the anchor point will be (0,0) when you position this node. More...

CCNode *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual CCArray *	getChildren ()
	Return an array of children. More...

unsigned int	getChildrenCount (void) const
	Get the amount of children. More...

virtual void	setParent (CCNode *parent)
	Sets the parent node. More...

virtual CCNode *	getParent ()
	Returns a pointer to the parent node. More...

virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeChild (CCNode *child)
	Removes a child from the container with a cleanup. More...

virtual void	removeChildByTag (int tag)
	Removes a child from the container by tag value with a cleanup. More...

virtual void	removeChildByTag (int tag, bool cleanup)
	Removes a child from the container by tag value. More...

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

virtual CCGridBase *	getGrid ()
	Returns a grid object that is used when applying effects. More...

virtual void	setGrid (CCGridBase *pGrid)
	Changes a grid object that is used when applying effects. More...

virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...

virtual void	setTag (int nTag)
	Changes the tag that is used to identify the node easily. More...

virtual void *	getUserData ()
	Returns a custom user data pointer. More...

virtual void	setUserData (void *pUserData)
	Sets a custom user data pointer. More...

virtual CCObject *	getUserObject ()
	Returns a user assigned CCObject. More...

virtual void	setUserObject (CCObject *pUserObject)
	Returns a user assigned CCObject. More...

virtual CCGLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...

virtual void	setShaderProgram (CCGLProgram *pShaderProgram)
	Sets the shader program for this node. More...

virtual void	registerScriptHandler (int handler)
	Registers a script function that will be called in onEnter() & onExit() seires functions. More...

virtual void	unregisterScriptHandler (void)
	Unregisters a script function that will be called in onEnter() & onExit() series functions. More...

int	getScriptHandler ()
	Gets script handler for onEnter/onExit event. More...

void	scheduleUpdateWithPriorityLua (int nHandler, int priority)
	Schedules for lua script. More...

virtual void	onEnter ()
	Event callback that is invoked every time when CCNode enters the 'stage'. More...

virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the CCNode enters in the 'stage'. More...

virtual void	onExit ()
	Event callback that is invoked every time the CCNode leaves the 'stage'. More...

virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the CCNode leaves the 'stage'. More...

virtual void	setActionManager (CCActionManager *actionManager)
	Sets the CCActionManager object that is used by all actions. More...

virtual CCActionManager *	getActionManager ()
	Gets the CCActionManager object that is used by all actions. More...

CCAction *	runAction (CCAction *action)
	Executes an action, and returns the action that is executed. More...

void	stopAllActions (void)
	Stops and removes all actions from the running action list . More...

void	stopAction (CCAction *action)
	Stops and removes an action from the running action list. More...

void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag. More...

CCAction *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

unsigned int	numberOfRunningActions (void)
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

virtual void	setScheduler (CCScheduler *scheduler)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

virtual CCScheduler *	getScheduler ()
	Gets a CCSheduler object. More...

bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

void	scheduleUpdate (void)
	Schedules the "update" method. More...

void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...

void	unscheduleUpdate (void)
void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...

void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...

void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...

void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...

void	unscheduleAllSelectors (void)
	Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...

void	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors and actions. More...

void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors and actions. More...

virtual void	update (float delta)
void	transform (void)
	Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...

void	transformAncestors (void)
	Performs OpenGL view-matrix transformation of it's ancestors. More...

virtual void	updateTransform (void)
	Calls children's updateTransform() method recursively. More...

virtual CCAffineTransform	nodeToParentTransform (void)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual CCAffineTransform	parentToNodeTransform (void)
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual CCAffineTransform	nodeToWorldTransform (void)
	Returns the world affine transform matrix. More...

virtual CCAffineTransform	worldToNodeTransform (void)
	Returns the inverse world affine transform matrix. More...

CCPoint	convertToNodeSpace (const CCPoint &worldPoint)
	Converts a Point to node (local) space coordinates. More...

CCPoint	convertToWorldSpace (const CCPoint &nodePoint)
	Converts a Point to world space coordinates. More...

CCPoint	convertToNodeSpaceAR (const CCPoint &worldPoint)
	Converts a Point to node (local) space coordinates. More...

CCPoint	convertToWorldSpaceAR (const CCPoint &nodePoint)
	Converts a local Point to world space coordinates.The result is in Points. More...

CCPoint	convertTouchToNodeSpace (CCTouch *touch)
	convenience methods which take a CCTouch instead of CCPoint More...

CCPoint	convertTouchToNodeSpaceAR (CCTouch *touch)
	converts a CCTouch (world coordinates) into a local coordinate. More...

void	setAdditionalTransform (const CCAffineTransform &additionalTransform)
	Sets the additional transform. More...

CCComponent *	getComponent (const char *pName) const
	gets a component by its name More...

virtual bool	addComponent (CCComponent *pComponent)
	adds a component More...

virtual bool	removeComponent (const char *pName)
	removes a component by its name More...

virtual void	removeAllComponents ()
	removes all components More...

	CCNode (void)
	Default constructor. More...

virtual	~CCNode (void)
	Default destructor. More...

const char *	description (void)
	Gets the description string. More...

Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (void)
bool	isSingleReference (void) const
unsigned int	retainCount (void) const
virtual bool	isEqual (const CCObject *pObject)
virtual void	acceptVisitor (CCDataVisitor &visitor)
Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

Static Public Member Functions
static void	purgeCachedData ()
	Purges the cached data. More...

static CCLabelBMFont *	create (const char str, const char fntFile, float width, CCTextAlignment alignment, CCPoint imageOffset)
	creates a bitmap font atlas with an initial string and the FNT file More...

static CCLabelBMFont *	create (const char str, const char fntFile, float width, CCTextAlignment alignment)
static CCLabelBMFont *	create (const char str, const char fntFile, float width)
static CCLabelBMFont *	create (const char str, const char fntFile)
static CCLabelBMFont *	create ()
	Creates an label. More...

Static Public Member Functions inherited from CCSpriteBatchNode
static CCSpriteBatchNode *	createWithTexture (CCTexture2D *tex, unsigned int capacity)
	creates a CCSpriteBatchNode with a texture2d and capacity of children. More...

local	createWithTexture ( local tex, local capacity)
	creates a CCSpriteBatchNode with a texture2d and capacity of children. More...

static CCSpriteBatchNode *	createWithTexture (CCTexture2D *tex)
local	createWithTexture ( local tex)
static CCSpriteBatchNode *	create (const char *fileImage, unsigned int capacity)
	creates a CCSpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...

local	create ( local fileImage, local capacity)
	creates a CCSpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...

static CCSpriteBatchNode *	create (const char *fileImage)
local	create ( local fileImage)
Static Public Member Functions inherited from CCNode
static CCNode *	create (void)
	Allocates and initializes a node. More...

Protected Member Functions
virtual void	setString (unsigned short *newString, bool needUpdateLabel)
Protected Member Functions inherited from CCSpriteBatchNode
void	insertQuadFromSprite (CCSprite *sprite, unsigned int index)
	Inserts a quad at a certain index into the texture atlas. More...

var	insertQuadFromSprite ( var sprite, var index)
	Inserts a quad at a certain index into the texture atlas. More...

local	insertQuadFromSprite ( local sprite, local index)
	Inserts a quad at a certain index into the texture atlas. More...

void	updateQuadFromSprite (CCSprite *sprite, unsigned int index)
	Updates a quad at a certain index into the texture atlas. More...

CCSpriteBatchNode *	addSpriteWithoutQuad (CCSprite *child, unsigned int z, int aTag)

Protected Attributes
unsigned short *	m_sString
std::string	m_sFntFile
unsigned short *	m_sInitialString
std::string	m_sInitialStringUTF8
CCTextAlignment	m_pAlignment
float	m_fWidth
CCBMFontConfiguration *	m_pConfiguration
bool	m_bLineBreakWithoutSpaces
CCPoint	m_tImageOffset
CCSprite *	m_pReusedChar
GLubyte	m_cDisplayedOpacity
GLubyte	m_cRealOpacity
ccColor3B	m_tDisplayedColor
ccColor3B	m_tRealColor
bool	m_bCascadeColorEnabled
bool	m_bCascadeOpacityEnabled
bool	m_bIsOpacityModifyRGB
	conforms to CCRGBAProtocol protocol More...

Protected Attributes inherited from CCSpriteBatchNode
CCTextureAtlas *	m_pobTextureAtlas
ccBlendFunc	m_blendFunc
CCArray *	m_pobDescendants
var	m_pobDescendants
local	m_pobDescendants
Protected Attributes inherited from CCNode
float	m_fRotationX
	rotation angle on x-axis More...

float	m_fRotationY
	rotation angle on y-axis More...

float	m_fScaleX
	scaling factor on x-axis More...

float	m_fScaleY
	scaling factor on y-axis More...

float	m_fVertexZ
	OpenGL real Z vertex. More...

CCPoint	m_obPosition
	position of the node More...

float	m_fSkewX
	skew angle on x-axis More...

float	m_fSkewY
	skew angle on y-axis More...

CCPoint	m_obAnchorPointInPoints
	anchor point in points More...

CCPoint	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

CCSize	m_obContentSize
	untransformed size of the node More...

CCAffineTransform	m_sAdditionalTransform
	transform More...

CCAffineTransform	m_sTransform
	transform More...

CCAffineTransform	m_sInverse
	transform More...

CCCamera *	m_pCamera
	a camera More...

CCGridBase *	m_pGrid
	a grid More...

int	m_nZOrder
	z-order value that affects the draw order More...

CCArray *	m_pChildren
	array of children nodes More...

CCNode *	m_pParent
	weak reference to parent node More...

int	m_nTag
	a tag. Can be any number you assigned just to identify this node More...

void *	m_pUserData
	A user assingned void pointer, Can be point to any cpp object. More...

CCObject *	m_pUserObject
	A user assigned CCObject. More...

CCGLProgram *	m_pShaderProgram
	OpenGL shader. More...

ccGLServerState	m_eGLServerState
	OpenGL servier side state. More...

unsigned int	m_uOrderOfArrival
	used to preserve sequence while sorting children with the same zOrder More...

CCScheduler *	m_pScheduler
	scheduler used to schedule timers and updates More...

CCActionManager *	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

bool	m_bRunning
	is running More...

bool	m_bTransformDirty
	transform dirty flag More...

bool	m_bInverseDirty
	transform dirty flag More...

bool	m_bAdditionalTransformDirty
	The flag to check whether the additional transform is dirty. More...

bool	m_bVisible
	is this node visible More...

bool	m_bIgnoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...

bool	m_bReorderChildDirty
	children order dirty flag More...

int	m_nScriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

int	m_nUpdateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

ccScriptType	m_eScriptType
	type of script binding, lua or javascript More...

CCComponentContainer *	m_pComponentContainer
	Dictionary of components. More...

Protected Attributes inherited from CCObject
unsigned int	m_uReference
unsigned int	m_uAutoReleaseCount

Additional Inherited Members
Public Attributes inherited from CCObject
unsigned int	m_uID
int	m_nLuaID

Detailed Description

@

/

/// //// //// /////

@

Constructor & Destructor Documentation

CCLabelBMFont ( )

virtual ~CCLabelBMFont ( )

virtual

Member Function Documentation

static CCLabelBMFont* create	(	const char *	str,
		const char *	fntFile,
		float	width,
		CCTextAlignment	alignment,
		CCPoint	imageOffset
	)

static

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

static CCLabelBMFont* create	(	const char *	str,
		const char *	fntFile,
		float	width,
		CCTextAlignment	alignment
	)

static

static CCLabelBMFont* create	(	const char *	str,
		const char *	fntFile,
		float	width
	)

static

static CCLabelBMFont* create	(	const char *	str,
		const char *	fntFile
	)

static

static CCLabelBMFont* create ( )

static

Creates an label.

void createFontChars ( )

updates the font chars based on the string to render

virtual const ccColor3B& getColor ( void )

virtual

Returns color that is currently used.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

CCBMFontConfiguration*
getConfiguration ( ) const

virtual const ccColor3B&
getDisplayedColor ( )

virtual

Returns the displayed color.

Returns: The ccColor3B contains R,G,B bytes.

Implements CCRGBAProtocol.

virtual GLubyte getDisplayedOpacity ( )

virtual

Returns the displayed opacity.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

const char* getFntFile ( )

virtual GLubyte getOpacity ( )

virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns: The opacity of sprite, from 0 ~ 255

Implements CCRGBAProtocol.

virtual const char* getString ( void )

virtual

Returns the string that is currently being used in this label.

Returns: The string that is currently being used in this label

Implements CCLabelProtocol.

bool init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented from CCNode.

bool initWithString	(	const char *	str,
		const char *	fntFile,
		float	width = `kCCLabelAutomaticWidth`,
		CCTextAlignment	alignment = `kCCTextAlignmentLeft`,
		CCPoint	imageOffset = `CCPointZero`
	)

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

virtual bool isCascadeColorEnabled ( )

virtual

whether or not color should be propagated to its children.

Implements CCRGBAProtocol.

virtual bool
isCascadeOpacityEnabled ( )

virtual

whether or not opacity should be propagated to its children.

Implements CCRGBAProtocol.

virtual bool isOpacityModifyRGB ( )

virtual

Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity)

Returns: Returns opacity modify flag.

Implements CCRGBAProtocol.

static void purgeCachedData ( )

static

Purges the cached data.

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

Since: v0.99.3

virtual void setAlignment ( CCTextAlignment alignment)

virtual

virtual void setAnchorPoint ( const CCPoint & anchorPoint)

virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Parameters

anchorPoint The anchor point of node.

Reimplemented from CCNode.

virtual void setCascadeColorEnabled ( bool cascadeColorEnabled)

virtual

Implements CCRGBAProtocol.

virtual void
setCascadeOpacityEnabled ( bool cascadeOpacityEnabled)

virtual

Implements CCRGBAProtocol.

virtual void setColor ( const ccColor3B & color)

virtual

@

Implements CCRGBAProtocol.

virtual void setCString ( const char * label)

virtual

void setFntFile ( const char * fntFile)

virtual void
setLineBreakWithoutSpace ( bool breakWithoutSpace)

virtual

virtual void setOpacity ( GLubyte opacity)

virtual

Changes the opacity.

Parameters

value Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Implements CCRGBAProtocol.

virtual void setOpacityModifyRGB ( bool bValue)

virtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters

bValue true then the opacity will be applied as: glColor(R,G,B,opacity); false then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Implements CCRGBAProtocol.

virtual void setScale ( float scale)

virtual

Changes both X and Y scale factor of the node.

1.0 is the default scale factor. It modifies the X and Y scale at the same time.

Parameters

scale The scale factor for both X and Y axis.

Reimplemented from CCNode.

virtual void setScaleX ( float fScaleX)

virtual

Changes the scale factor on X axis of this node.

The deafult value is 1.0 if you haven't changed it before

Parameters

fScaleX The scale factor on X axis.

Reimplemented from CCNode.

virtual void setScaleY ( float fScaleY)

virtual

Changes the scale factor on Y axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters

fScaleY The scale factor on Y axis.

Reimplemented from CCNode.

virtual void setString ( const char * label)

virtual

Sets a new label using an string.

Parameters

A	null terminated string

Implements CCLabelProtocol.

virtual void setString	(	const char *	newString,
		bool	needUpdateLabel
	)

virtual

virtual void setString	(	unsigned short *	newString,
		bool	needUpdateLabel
	)

protectedvirtual

virtual void setWidth ( float width)

virtual

virtual void updateDisplayedColor ( const ccColor3B & color)

virtual

recursive method that updates display color

Implements CCRGBAProtocol.

virtual void updateDisplayedOpacity ( GLubyte opacity)

virtual

recursive method that updates the displayed opacity.

Implements CCRGBAProtocol.

virtual void updateLabel ( )

virtual

Member Data Documentation

bool m_bCascadeColorEnabled

protected

bool m_bCascadeOpacityEnabled

protected

bool m_bIsOpacityModifyRGB

protected

conforms to CCRGBAProtocol protocol

bool m_bLineBreakWithoutSpaces

protected

GLubyte m_cDisplayedOpacity

protected

GLubyte m_cRealOpacity

protected

float m_fWidth

protected

CCTextAlignment m_pAlignment

protected

CCBMFontConfiguration*
m_pConfiguration

protected

CCSprite* m_pReusedChar

protected

std::string m_sFntFile

protected

unsigned short* m_sInitialString

protected

std::string m_sInitialStringUTF8

protected

unsigned short* m_sString

protected

ccColor3B m_tDisplayedColor

protected

CCPoint m_tImageOffset

protected

ccColor3B m_tRealColor

protected

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

/Users/cocos2d/MyWork/cocos2d-x/cocos2dx/label_nodes/CCLabelBMFont.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation