LabelBMFont Class Reference

LabelBMFont is a subclass of SpriteBatchNode. More...

#include <CCLabelBMFont.h>

Inheritance diagram for LabelBMFont:

Public Member Functions
	LabelBMFont ()
virtual	~LabelBMFont ()
bool	init ()
bool	initWithString (const std::string &str, const std::string &fntFile, float width=kLabelAutomaticWidth, TextHAlignment alignment=TextHAlignment::LEFT, Point imageOffset=Point::ZERO)
	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 std::string &newString) override
	Sets a new label using a string. More...
virtual void	setString (const std::string &newString, bool needUpdateLabel)
virtual const std::string &	getString () const override
	Returns the string that is currently being used in this label. More...
virtual void	setCString (const char *label)
virtual void	setAnchorPoint (const Point &var) override
	Sets the anchor point in percent. More...
virtual void	updateLabel ()
virtual void	setAlignment (TextHAlignment 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 () const
virtual void	setOpacityModifyRGB (bool isOpacityModifyRGB)
void	setFntFile (const std::string &fntFile)
const std::string &	getFntFile () const
virtual std::string	getDescription () const override
	Gets the description string. More...
Public Member Functions inherited from SpriteBatchNode
	SpriteBatchNode ()
virtual	~SpriteBatchNode ()
bool	initWithTexture (Texture2D *tex, ssize_t capacity)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...
bool	initWithFile (const std::string &fileImage, ssize_t capacity)
	initializes a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and a capacity of children. More...
bool	init ()
TextureAtlas *	getTextureAtlas (void)
	returns the TextureAtlas object More...
local	getTextureAtlas ()
	returns the TextureAtlas object More...
void	setTextureAtlas (TextureAtlas *textureAtlas)
	sets the TextureAtlas object More...
const std::vector< Sprite * > &	getDescendants () const
	returns an array with the descendants (children, gran children, etc.). More...
void	increaseAtlasCapacity ()
void	removeChildAtIndex (ssize_t 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	appendChild (Sprite *sprite)
void	removeSpriteFromAtlas (Sprite *sprite)
var	removeSpriteFromAtlas ( var sprite)
local	removeSpriteFromAtlas ( local sprite)
ssize_t	rebuildIndexInOrder (Sprite *parent, ssize_t index)
local	rebuildIndexInOrder ( local parent, local index)
ssize_t	highestAtlasIndexInChild (Sprite *sprite)
ssize_t	lowestAtlasIndexInChild (Sprite *sprite)
ssize_t	atlasIndexForChild (Sprite *sprite, int z)
local	atlasIndexForChild ( local sprite, local z)
void	reorderBatch (bool reorder)
virtual Texture2D *	getTexture () const override
	Returns the currently used texture. More...
virtual void	setTexture (Texture2D *texture) override
	Sets a new texuture. More...
local	setTexture ( local texture)
	Sets a new texuture. More...
virtual void	setBlendFunc (const BlendFunc &blendFunc) override
virtual const BlendFunc &	getBlendFunc () const override
	Returns the blending function that is currently being used. More...
virtual void	visit () override
	Visits this node's children and draw them recursively. More...
virtual void	addChild (Node *child, int zOrder, int tag) override
	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 (Node *child, int zOrder) override
	Reorders a child according to a new z value. More...
local	reorderChild ( local child, local zOrder)
	Reorders a child according to a new z value. More...
virtual void	removeChild (Node *child, bool cleanup) override
	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) override
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
local	removeAllChildrenWithCleanup ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
virtual void	sortAllChildren () override
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
virtual void	draw (void) override
	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 Node
virtual bool	isRunning () const
	Returns whether or not the node accepts event callbacks. More...
void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script. More...
local	scheduleUpdateWithPriorityLua ( local handler, local priority)
	Schedules for lua script. More...
virtual void	cleanup ()
	Stops all running actions and schedulers. More...
var	cleanup ()
	Stops all running actions and schedulers. More...
local	cleanup ()
	Stops all running actions and schedulers. More...
virtual Scene *	getScene ()
	Returns the Scene that contains the Node. More...
local	getScene ()
	Returns the Scene that contains the Node. More...
virtual Rect	getBoundingBox () const
	Returns a "local" axis aligned bounding box of the node. More...
virtual CC_DEPRECATED_ATTRIBUTE Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
var	setEventDispatcher ( var dispatcher)
local	setEventDispatcher ( local dispatcher)
virtual EventDispatcher *	getEventDispatcher () const
local	getEventDispatcher ()
void	setPhysicsBody (PhysicsBody *body)
	set the PhysicsBody that let the sprite effect with physics More...
var	setPhysicsBody ( var body)
	set the PhysicsBody that let the sprite effect with physics More...
local	setPhysicsBody ( local body)
	set the PhysicsBody that let the sprite effect with physics More...
PhysicsBody *	getPhysicsBody () const
	get the PhysicsBody the sprite have More...
var	getPhysicsBody ()
	get the PhysicsBody the sprite have More...
local	getPhysicsBody ()
	get the PhysicsBody the sprite have More...
virtual bool	updatePhysicsTransform ()
	update rotation and position from physics body More...
var	updatePhysicsTransform ()
	update rotation and position from physics body More...
local	updatePhysicsTransform ()
	update rotation and position from physics body More...
virtual GLubyte	getOpacity () const
virtual GLubyte	getDisplayedOpacity () const
var	getDisplayedOpacity ()
local	getDisplayedOpacity ()
virtual void	setOpacity (GLubyte opacity)
local	setOpacity ( local opacity)
virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
var	updateDisplayedOpacity ( var parentOpacity)
local	updateDisplayedOpacity ( local parentOpacity)
virtual bool	isCascadeOpacityEnabled () const
var	isCascadeOpacityEnabled ()
local	isCascadeOpacityEnabled ()
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3B &	getColor (void) const
local	getColor ()
virtual const Color3B &	getDisplayedColor () const
local	getDisplayedColor ()
virtual void	setColor (const Color3B &color)
var	setColor ( var color)
local	setColor ( local color)
virtual void	updateDisplayedColor (const Color3B &parentColor)
var	updateDisplayedColor ( var parentColor)
local	updateDisplayedColor ( local parentColor)
virtual bool	isCascadeColorEnabled () const
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
virtual CC_DEPRECATED_ATTRIBUTE void	setZOrder (int localZOrder)
local	setZOrder ( local localZOrder)
virtual void	_setLocalZOrder (int z)
virtual int	getLocalZOrder () const
	Gets the local Z order of this node. More...
var	getLocalZOrder ()
	Gets the local Z order of this node. More...
local	getLocalZOrder ()
	Gets the local Z order of this node. More...
virtual CC_DEPRECATED_ATTRIBUTE int	getZOrder () const
var	getZOrder ()
local	getZOrder ()
virtual void	setGlobalZOrder (float globalZOrder)
	Defines the oder in which the nodes are renderer. More...
local	setGlobalZOrder ( local globalZOrder)
	Defines the oder in which the nodes are renderer. More...
virtual float	getGlobalZOrder () const
	Returns the Node's Global Z Order. More...
virtual void	setVertexZ (float vertexZ)
	Sets the 'z' value in the OpenGL Depth Buffer. More...
var	setVertexZ ( var vertexZ)
	Sets the 'z' value in the OpenGL Depth Buffer. More...
local	setVertexZ ( local vertexZ)
	Sets the 'z' value in the OpenGL Depth Buffer. More...
virtual float	getVertexZ () const
	Gets OpenGL Z vertex of this node. More...
virtual float	getScaleX () const
	Returns the scale factor on X axis of this node. More...
var	getScaleX ()
	Returns the scale factor on X axis of this node. More...
local	getScaleX ()
	Returns the scale factor on X axis of this node. More...
virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node. More...
virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor. More...
virtual void	setScale (float scaleX, float scaleY)
	Changes both X and Y scale factor of the node. More...
local	setScale ( local scaleX, local scaleY)
	Changes both X and Y scale factor of the node. More...
virtual void	setPosition (const Point &position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...
virtual const Point &	getPosition () const
	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...
local	setPosition ( local x, local y)
	Sets position in a more efficient way. More...
virtual void	getPosition (float *x, float *y) const
	Gets position in a more efficient way, returns two number instead of a Point object. More...
var	getPosition ( var x, var y)
	Gets position in a more efficient way, returns two number instead of a Point object. More...
local	getPosition ( local x, local y)
	Gets position in a more efficient way, returns two number instead of a Point object. More...
virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...
virtual float	getPositionX (void) const
virtual void	setPositionY (float y)
local	setPositionY ( local y)
virtual float	getPositionY (void) const
local	getPositionY ()
virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...
local	setSkewX ( local fSkewX)
	Changes the X skew angle of the node in degrees. More...
virtual float	getSkewX () const
	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...
local	setSkewY ( local fSkewY)
	Changes the Y skew angle of the node in degrees. More...
virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...
virtual const Point &	getAnchorPoint () const
	Returns the anchor point in percent. More...
local	getAnchorPoint ()
	Returns the anchor point in percent. More...
virtual const Point &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...
virtual void	setContentSize (const Size &contentSize)
	Sets the untransformed size of the node. More...
local	setContentSize ( local contentSize)
	Sets the untransformed size of the node. More...
virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...
virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...
local	setVisible ( local visible)
	Sets whether the node is visible. More...
virtual bool	isVisible () const
	Determines if the node is visible. More...
virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...
local	setRotation ( local rotation)
	Sets the rotation (angle) of the node in degrees. More...
virtual float	getRotation () const
	Returns the rotation of the node in degrees. More...
virtual void	setRotationX (float rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
local	setRotationX ( local rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
virtual float	getRotationX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
virtual void	setRotationY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
var	setRotationY ( var rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
local	setRotationY ( local rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
virtual float	getRotationY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...
int	getOrderOfArrival () const
	Returns the arrival order, indecates which children is added previously. More...
CC_DEPRECATED_ATTRIBUTE void	setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int	getGLServerState () const
virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...
virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. More...
virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...
var	addChild ( var child)
	Adds a child to the container with z-order as 0. More...
local	addChild ( local child)
	Adds a child to the container with z-order as 0. More...
virtual void	addChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order. More...
var	addChild ( var child, var localZOrder)
	Adds a child to the container with a local z-order. More...
local	addChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...
virtual Node *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...
virtual Vector< Node * > &	getChildren ()
	Return an array of children. More...
local	getChildren ()
	Return an array of children. More...
virtual const Vector< Node * > &	getChildren () const
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Get the amount of children. More...
virtual void	setParent (Node *parent)
	Sets the parent node. More...
local	setParent ( local parent)
	Sets the parent node. More...
virtual Node *	getParent ()
	Returns a pointer to the parent node. More...
virtual const Node *	getParent () const
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...
local	removeFromParent ( local cleanup)
	Removes this node itself from its parent node. More...
virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...
virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...
virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...
local	getTag ()
	Returns a tag that is used to identify the node easily. More...
virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily. More...
local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...
virtual void *	getUserData ()
	Returns a custom user data pointer. More...
virtual const void *	getUserData () const
virtual void	setUserData (void *userData)
	Sets a custom user data pointer. More...
virtual Object *	getUserObject ()
	Returns a user assigned Object. More...
virtual const Object *	getUserObject () const
virtual void	setUserObject (Object *userObject)
	Returns a user assigned Object. More...
local	setUserObject ( local userObject)
	Returns a user assigned Object. More...
virtual GLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...
virtual const GLProgram *	getShaderProgram () const
local	getShaderProgram ()
virtual void	setShaderProgram (GLProgram *shaderProgram)
	Sets the shader program for this node. More...
local	setShaderProgram ( local shaderProgram)
	Sets the shader program for this node. More...
virtual void	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'. More...
virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the Node enters in the 'stage'. More...
virtual void	onExit ()
	Event callback that is invoked every time the Node leaves the 'stage'. More...
virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the Node leaves the 'stage'. More...
virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions. More...
virtual ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...
virtual const ActionManager *	getActionManager () const
local	getActionManager ()
Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed. More...
var	runAction ( var action)
	Executes an action, and returns the action that is executed. More...
local	runAction ( local action)
	Executes an action, and returns the action that is executed. More...
void	stopAllActions ()
	Stops and removes all actions from the running action list . More...
void	stopAction (Action *action)
	Stops and removes an action from the running action list. More...
var	stopAction ( var action)
	Stops and removes an action from the running action list. More...
local	stopAction ( local 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...
var	stopActionByTag ( var tag)
	Removes an action from the running action list by its tag. More...
local	stopActionByTag ( local tag)
	Removes an action from the running action list by its tag. More...
Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...
var	getActionByTag ( var tag)
	Gets an action from the running action list by its tag. More...
local	getActionByTag ( local tag)
	Gets an action from the running action list by its tag. More...
ssize_t	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
CC_DEPRECATED_ATTRIBUTE ssize_t	numberOfRunningActions () const
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...
virtual Scheduler *	getScheduler ()
	Gets a Sheduler object. More...
virtual const Scheduler *	getScheduler () const
local	getScheduler ()
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)
var	unscheduleUpdate ()
local	unscheduleUpdate ()
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...
var	unscheduleAllSelectors ()
	Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...
void	pause (void)
	Pauses all scheduled selectors, actions and event listeners. More...
var	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...
local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...
CC_DEPRECATED_ATTRIBUTE void	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors, actions and event listeners. More...
local	resumeSchedulerAndActions ()
	Resumes all scheduled selectors, actions and event listeners. More...
CC_DEPRECATED_ATTRIBUTE void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors, actions and event listeners. More...
local	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
virtual void	update (float delta)
var	update ( var delta)
local	update ( local delta)
void	transform ()
	Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
void	transformAncestors ()
	Performs OpenGL view-matrix transformation of it's ancestors. More...
virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...
var	updateTransform ()
	Calls children's updateTransform() method recursively. More...
local	updateTransform ()
	Calls children's updateTransform() method recursively. More...
virtual const kmMat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual void	setNodeToParentTransform (const kmMat4 &transform)
	Sets the Transformation matrix manually. More...
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const kmMat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
local	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
virtual AffineTransform	getParentToNodeAffineTransform () const
local	getParentToNodeAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual kmMat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...
virtual AffineTransform	getNodeToWorldAffineTransform () const
local	getNodeToWorldAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual kmMat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...
local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...
virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Point	convertToNodeSpace (const Point &worldPoint) const
	Converts a Point to node (local) space coordinates. More...
Point	convertToWorldSpace (const Point &nodePoint) const
	Converts a Point to world space coordinates. More...
Point	convertToNodeSpaceAR (const Point &worldPoint) const
	Converts a Point to node (local) space coordinates. More...
var	convertToNodeSpaceAR ( var worldPoint)
	Converts a Point to node (local) space coordinates. More...
local	convertToNodeSpaceAR ( local worldPoint)
	Converts a Point to node (local) space coordinates. More...
Point	convertToWorldSpaceAR (const Point &nodePoint) const
	Converts a local Point to world space coordinates.The result is in Points. More...
Point	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Point More...
Point	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate. More...
var	convertTouchToNodeSpaceAR ( var touch)
	converts a Touch (world coordinates) into a local coordinate. More...
local	convertTouchToNodeSpaceAR ( local touch)
	converts a Touch (world coordinates) into a local coordinate. More...
void	setAdditionalTransform (const AffineTransform &additionalTransform)
	Sets an additional transform matrix to the node. More...
var	setAdditionalTransform ( var additionalTransform)
	Sets an additional transform matrix to the node. More...
local	setAdditionalTransform ( local additionalTransform)
	Sets an additional transform matrix to the node. More...
void	setAdditionalTransform (const kmMat4 &additionalTransform)
Component *	getComponent (const std::string &pName)
	gets a component by its name More...
var	getComponent ( var pName)
	gets a component by its name More...
local	getComponent ( local pName)
	gets a component by its name More...
virtual bool	addComponent (Component *pComponent)
	adds a component More...
var	addComponent ( var pComponent)
	adds a component More...
local	addComponent ( local pComponent)
	adds a component More...
virtual bool	removeComponent (const std::string &pName)
	removes a component by its name More...
var	removeComponent ( var pName)
	removes a component by its name More...
local	removeComponent ( local pName)
	removes a component by its name More...
virtual void	removeAllComponents ()
	removes all components More...
Public Member Functions inherited from Object
	Object ()
	Constructor. More...
virtual	~Object ()
void	release ()
	Release the ownership immediately. More...
void	retain ()
	Retains the ownership. More...
Object *	autorelease ()
	Release the ownership sometime soon automatically. More...
bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...
unsigned int	retainCount () const
	Returns the object's current reference count. More...
unsigned int	getReferenceCount () const
virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...
virtual void	acceptVisitor (DataVisitor &visitor)
Public Member Functions inherited from TextureProtocol
virtual	~TextureProtocol ()
Public Member Functions inherited from BlendProtocol
virtual	~BlendProtocol ()
var	~BlendProtocol ()
local	~BlendProtocol ()
Public Member Functions inherited from LabelProtocol
virtual	~LabelProtocol ()
var	~LabelProtocol ()
local	~LabelProtocol ()

Static Public Member Functions
static void	purgeCachedData ()
	Purges the cached data. More...
static LabelBMFont *	create (const std::string &str, const std::string &fntFile, float width, TextHAlignment alignment, Point imageOffset)
	creates a bitmap font atlas with an initial string and the FNT file More...
static LabelBMFont *	create (const std::string &str, const std::string &fntFile, float width, TextHAlignment alignment)
static LabelBMFont *	create (const std::string &str, const std::string &fntFile, float width)
static LabelBMFont *	create (const std::string &str, const std::string &fntFile)
static LabelBMFont *	create ()
	Creates an label. More...
Static Public Member Functions inherited from SpriteBatchNode
static SpriteBatchNode *	createWithTexture (Texture2D *tex, ssize_t capacity=DEFAULT_CAPACITY)
	creates a SpriteBatchNode with a texture2d and capacity of children. More...
var	createWithTexture ( var tex, var DEFAULT_CAPACITY)
	creates a SpriteBatchNode with a texture2d and capacity of children. More...
local	createWithTexture ( local tex, local DEFAULT_CAPACITY)
	creates a SpriteBatchNode with a texture2d and capacity of children. More...
static SpriteBatchNode *	create (const std::string &fileImage, ssize_t capacity=DEFAULT_CAPACITY)
	creates a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...
local	create ( local fileImage, local DEFAULT_CAPACITY)
	creates a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...
Static Public Member Functions inherited from Node
static Node *	create (void)
	Allocates and initializes a node. More...

Protected Member Functions
char *	atlasNameFromFntFile (const std::string &fntFile)
int	kerningAmountForFirst (unsigned short first, unsigned short second)
float	getLetterPosXLeft (Sprite *characterSprite)
float	getLetterPosXRight (Sprite *characterSprite)
virtual void	setString (unsigned short *newString, bool needUpdateLabel)
Protected Member Functions inherited from SpriteBatchNode
void	insertQuadFromSprite (Sprite *sprite, ssize_t index)
	Inserts a quad at a certain index into the texture atlas. More...
void	updateQuadFromSprite (Sprite *sprite, ssize_t index)
	Updates a quad at a certain index into the texture atlas. More...
SpriteBatchNode *	addSpriteWithoutQuad (Sprite *child, int z, int aTag)
var	addSpriteWithoutQuad ( var child, var z, var aTag)
void	updateAtlasIndex (Sprite *sprite, ssize_t *curIndex)
void	swap (ssize_t oldIndex, ssize_t newIndex)
void	updateBlendFunc ()
Protected Member Functions inherited from Node
	Node ()
	Node ()
	Node ()
virtual	~Node ()
local	~Node ()
void	childrenAlloc (void)
	lazy allocs More...
var	childrenAlloc ()
	lazy allocs More...
local	childrenAlloc ()
	lazy allocs More...
void	insertChild (Node *child, int z)
	helper that reorder a child More...
var	insertChild ( var child, var z)
	helper that reorder a child More...
local	insertChild ( local child, local z)
	helper that reorder a child More...
void	detachChild (Node *child, ssize_t index, bool doCleanup)
	Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
var	detachChild ( var child, var index, var doCleanup)
	Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
local	detachChild ( local child, local index, local doCleanup)
	Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
Point	convertToWindowSpace (const Point &nodePoint) const
	Convert cocos2d coordinates to UI windows coordinate. More...
var	convertToWindowSpace ( var nodePoint)
	Convert cocos2d coordinates to UI windows coordinate. More...
local	convertToWindowSpace ( local nodePoint)
	Convert cocos2d coordinates to UI windows coordinate. More...
virtual void	updateCascadeOpacity ()
virtual void	disableCascadeOpacity ()
virtual void	updateCascadeColor ()
virtual void	disableCascadeColor ()
virtual void	updateColor ()
var	updateColor ()
local	updateColor ()

Protected Attributes
unsigned short *	_string
std::string	_fntFile
unsigned short *	_initialString
std::string	_initialStringUTF8
TextHAlignment	_alignment
float	_width
CCBMFontConfiguration *	_configuration
bool	_lineBreakWithoutSpaces
Point	_imageOffset
Sprite *	_reusedChar
bool	_isOpacityModifyRGB
Protected Attributes inherited from SpriteBatchNode
TextureAtlas *	_textureAtlas
BlendFunc	_blendFunc
var	_blendFunc
local	_blendFunc
BatchCommand	_batchCommand
var	_batchCommand
local	_batchCommand
std::vector< Sprite * >	_descendants
var	_descendants
local	_descendants
Protected Attributes inherited from Node
float	_rotationX
	rotation angle on x-axis More...
float	_rotationY
	rotation angle on y-axis More...
var	_rotationY
	rotation angle on y-axis More...
local	_rotationY
	rotation angle on y-axis More...
float	_scaleX
	scaling factor on x-axis More...
var	_scaleX
	scaling factor on x-axis More...
local	_scaleX
	scaling factor on x-axis More...
float	_scaleY
	scaling factor on y-axis More...
var	_scaleY
	scaling factor on y-axis More...
local	_scaleY
	scaling factor on y-axis More...
Point	_position
	position of the node More...
var	_position
	position of the node More...
local	_position
	position of the node More...
float	_skewX
	skew angle on x-axis More...
var	_skewX
	skew angle on x-axis More...
local	_skewX
	skew angle on x-axis More...
float	_skewY
	skew angle on y-axis More...
var	_skewY
	skew angle on y-axis More...
local	_skewY
	skew angle on y-axis More...
Point	_anchorPointInPoints
	anchor point in points More...
var	_anchorPointInPoints
	anchor point in points More...
local	_anchorPointInPoints
	anchor point in points More...
Point	_anchorPoint
	anchor point normalized (NOT in points) More...
var	_anchorPoint
	anchor point normalized (NOT in points) More...
local	_anchorPoint
	anchor point normalized (NOT in points) More...
Size	_contentSize
	untransformed size of the node More...
var	_contentSize
	untransformed size of the node More...
local	_contentSize
	untransformed size of the node More...
kmMat4	_modelViewTransform
	ModelView transform of the Node. More...
var	_modelViewTransform
	ModelView transform of the Node. More...
local	_modelViewTransform
	ModelView transform of the Node. More...
kmMat4	_additionalTransform
	transform More...
var	_additionalTransform
	transform More...
local	_additionalTransform
	transform More...
kmMat4	_transform
	transform More...
var	_transform
	transform More...
local	_transform
	transform More...
kmMat4	_inverse
	inverse transform More...
var	_inverse
	inverse transform More...
local	_inverse
	inverse transform More...
bool	_useAdditionalTransform
	The flag to check whether the additional transform is dirty. More...
var	_useAdditionalTransform
	The flag to check whether the additional transform is dirty. More...
local	_useAdditionalTransform
	The flag to check whether the additional transform is dirty. More...
bool	_transformDirty
	transform dirty flag More...
var	_transformDirty
	transform dirty flag More...
local	_transformDirty
	transform dirty flag More...
bool	_inverseDirty
	inverse transform dirty flag More...
var	_inverseDirty
	inverse transform dirty flag More...
local	_inverseDirty
	inverse transform dirty flag More...
int	_localZOrder
	Local order (relative to its siblings) used to sort the node. More...
var	_localZOrder
	Local order (relative to its siblings) used to sort the node. More...
local	_localZOrder
	Local order (relative to its siblings) used to sort the node. More...
float	_globalZOrder
	Global order used to sort the node. More...
var	_globalZOrder
	Global order used to sort the node. More...
local	_globalZOrder
	Global order used to sort the node. More...
float	_vertexZ
	OpenGL real Z vertex. More...
var	_vertexZ
	OpenGL real Z vertex. More...
local	_vertexZ
	OpenGL real Z vertex. More...
Vector< Node * >	_children
	array of children nodes More...
var	_children
	array of children nodes More...
local	_children
	array of children nodes More...
Node *	_parent
	weak reference to parent node More...
var	_parent
	weak reference to parent node More...
local	_parent
	weak reference to parent node More...
int	_tag
	a tag. Can be any number you assigned just to identify this node More...
var	_tag
	a tag. Can be any number you assigned just to identify this node More...
local	_tag
	a tag. Can be any number you assigned just to identify this node More...
void *	_userData
	A user assingned void pointer, Can be point to any cpp object. More...
var	_userData
	A user assingned void pointer, Can be point to any cpp object. More...
local	_userData
	A user assingned void pointer, Can be point to any cpp object. More...
Object *	_userObject
	A user assigned Object. More...
var	_userObject
	A user assigned Object. More...
local	_userObject
	A user assigned Object. More...
GLProgram *	_shaderProgram
	OpenGL shader. More...
var	_shaderProgram
	OpenGL shader. More...
local	_shaderProgram
	OpenGL shader. More...
int	_orderOfArrival
	used to preserve sequence while sorting children with the same localZOrder More...
var	_orderOfArrival
	used to preserve sequence while sorting children with the same localZOrder More...
local	_orderOfArrival
	used to preserve sequence while sorting children with the same localZOrder More...
Scheduler *	_scheduler
	scheduler used to schedule timers and updates More...
var	_scheduler
	scheduler used to schedule timers and updates More...
local	_scheduler
	scheduler used to schedule timers and updates More...
ActionManager *	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...
var	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...
local	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...
EventDispatcher *	_eventDispatcher
	event dispatcher used to dispatch all kinds of events More...
var	_eventDispatcher
	event dispatcher used to dispatch all kinds of events More...
local	_eventDispatcher
	event dispatcher used to dispatch all kinds of events More...
bool	_running
	is running More...
bool	_visible
	is this node visible More...
var	_visible
	is this node visible More...
local	_visible
	is this node visible More...
bool	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
var	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
local	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
bool	_reorderChildDirty
	children order dirty flag More...
bool	_isTransitionFinished
	flag to indicate whether the transition was finished More...
var	_isTransitionFinished
	flag to indicate whether the transition was finished More...
local	_isTransitionFinished
	flag to indicate whether the transition was finished More...
int	_scriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
var	_scriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
local	_scriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
int	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...
var	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...
local	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...
ccScriptType	_scriptType
	type of script binding, lua or javascript More...
var	_scriptType
	type of script binding, lua or javascript More...
local	_scriptType
	type of script binding, lua or javascript More...
ComponentContainer *	_componentContainer
	Dictionary of components. More...
var	_componentContainer
	Dictionary of components. More...
local	_componentContainer
	Dictionary of components. More...
PhysicsBody *	_physicsBody
	the physicsBody the node have More...
var	_physicsBody
	the physicsBody the node have More...
local	_physicsBody
	the physicsBody the node have More...
GLubyte	_displayedOpacity
var	_displayedOpacity
local	_displayedOpacity
GLubyte	_realOpacity
var	_realOpacity
local	_realOpacity
Color3B	_displayedColor
var	_displayedColor
local	_displayedColor
Color3B	_realColor
var	_realColor
local	_realColor
bool	_cascadeColorEnabled
var	_cascadeColorEnabled
local	_cascadeColorEnabled
bool	_cascadeOpacityEnabled
var	_cascadeOpacityEnabled
local	_cascadeOpacityEnabled
Protected Attributes inherited from Object
unsigned int	_referenceCount
	count of references More...

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...
int	_luaID
	Lua reference id. More...
Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes. More...
var	INVALID_TAG = -1
	Default tag used for all the nodes. More...
local	INVALID_TAG = -1
	Default tag used for all the nodes. More...

Detailed Description

LabelBMFont is a subclass of SpriteBatchNode.

Features:

• Treats each character like a Sprite. This means that each individual character can be:
• rotated
• scaled
• translated
• tinted
• change 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

LabelBMFont implements the protocol LabelProtocol, like Label and LabelAtlas. LabelBMFont has the flexibility of Label, the speed of LabelAtlas and all the features of Sprite. If in doubt, use LabelBMFont instead of LabelAtlas / Label.

Supported editors: 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)

Since

v0.8

Constructor & Destructor Documentation

LabelBMFont

(

)

virtual ~LabelBMFont ( )

virtual

Member Function Documentation

char* atlasNameFromFntFile ( const std::string &  fntFile)

protected

static LabelBMFont* create ( const std::string &  str, const std::string &  fntFile, float  width, TextHAlignment  alignment, Point  imageOffset  )

static

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

static LabelBMFont* create ( const std::string &  str, const std::string &  fntFile, float  width, TextHAlignment  alignment  )

static

static LabelBMFont* create ( const std::string &  str, const std::string &  fntFile, float  width  )

static

static LabelBMFont* create ( const std::string &  str, const std::string &  fntFile  )

static

static LabelBMFont* create ( )

static

Creates an label.

void createFontChars

(

)

updates the font chars based on the string to render

virtual std::string getDescription ( ) const

overridevirtual

Gets the description string.

It makes debugging easier.

Returns

A string

Reimplemented from SpriteBatchNode.

const std::string& getFntFile

(

)

const

float getLetterPosXLeft ( Sprite *  characterSprite)

protected

float getLetterPosXRight ( Sprite *  characterSprite)

protected

virtual const std::string& getString ( ) const

overridevirtual

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

Returns

The string that is currently being used in this label

Implements LabelProtocol.

bool init ( )

virtual

Reimplemented from Node.

bool initWithString	(	const std::string &	str,
		const std::string &	fntFile,
		float	width = kLabelAutomaticWidth,
		TextHAlignment	alignment = TextHAlignment::LEFT,
		Point	imageOffset = Point::ZERO
	)

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

virtual bool isOpacityModifyRGB ( ) const

virtual

Reimplemented from Node.

int kerningAmountForFirst ( unsigned short  first, unsigned short  second  )

protected

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 ( TextHAlignment  alignment)

virtual

virtual void setAnchorPoint ( const Point &  anchorPoint)

overridevirtual

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 Node.

virtual void setCString ( const char *  label)

virtual

void setFntFile

(

const std::string &

fntFile)

virtual void setLineBreakWithoutSpace ( bool  breakWithoutSpace)

virtual

virtual void setOpacityModifyRGB ( bool  isOpacityModifyRGB)

virtual

Reimplemented from Node.

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 Node.

virtual void setScaleX ( float  scaleX)

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

scaleX

The scale factor on X axis.

Reimplemented from Node.

virtual void setScaleY ( float  scaleY)

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

scaleY

The scale factor on Y axis.

Reimplemented from Node.

virtual void setString ( const std::string &  label)

overridevirtual

Sets a new label using a string.

Parameters

label

A null terminated string

Implements LabelProtocol.

virtual void setString ( const std::string &  newString, bool  needUpdateLabel  )

virtual

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

protectedvirtual

virtual void setWidth ( float  width)

virtual

virtual void updateLabel ( )

virtual

Member Data Documentation

TextHAlignment _alignment

protected

CCBMFontConfiguration* _configuration

protected

std::string _fntFile

protected

Point _imageOffset

protected

unsigned short* _initialString

protected

std::string _initialStringUTF8

protected

bool _isOpacityModifyRGB

protected

bool _lineBreakWithoutSpaces

protected

Sprite* _reusedChar

protected

unsigned short* _string

protected

float _width

protected

---

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

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/CCLabelBMFont.h