Label Class Reference

#include <CCLabel.h>

Inheritance diagram for Label:

Public Member Functions
bool	setText (const std::string &stringToRender, float lineWidth, TextHAlignment alignment=TextHAlignment::LEFT, bool lineBreakWithoutSpaces=false)
virtual void	setString (const std::string &stringToRender) override
	Sets a new label using a string. More...
virtual void	setAlignment (TextHAlignment alignment)
virtual void	setWidth (float width)
virtual void	setLineBreakWithoutSpace (bool breakWithoutSpace)
virtual void	setScale (float scale) override
	Changes both X and Y scale factor of the node. More...
virtual void	setScaleX (float scaleX) override
	Changes the scale factor on X axis of this node. More...
virtual void	setScaleY (float scaleY) override
	Changes the scale factor on Y axis of this node. More...
virtual bool	isOpacityModifyRGB () const override
	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) override
	Changes the OpacityModifyRGB property. More...
virtual void	setOpacity (GLubyte opacity) override
	Changes the opacity. More...
virtual void	updateDisplayedOpacity (GLubyte parentOpacity) override
	recursive method that updates the displayed opacity. More...
virtual bool	isCascadeOpacityEnabled () const override
	whether or not opacity should be propagated to its children. More...
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled) override
virtual void	setColor (const Color3B &color) override
	Changes the color with R,G,B bytes. More...
virtual void	updateDisplayedColor (const Color3B &parentColor) override
	recursive method that updates display color More...
virtual bool	isCascadeColorEnabled () const override
	whether or not color should be propagated to its children. More...
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled) override
virtual const Color3B &	getColor (void) const override
	Returns color that is currently used. More...
virtual const Color3B &	getDisplayedColor () const override
	Returns the displayed color. More...
virtual unsigned char	getOpacity () const override
	Returns the opacity. More...
virtual unsigned char	getDisplayedOpacity () const override
	Returns the displayed opacity. More...
virtual std::vector< LetterInfo > *	getLettersInfo () override
virtual bool	recordLetterInfo (const cocos2d::Point &point, unsigned short int theChar, int spriteIndex) override
virtual bool	recordPlaceholderInfo (int spriteIndex) override
virtual float	getLetterPosXLeft (int index) const override
virtual float	getLetterPosXRight (int index) const override
virtual Sprite *	getLetter (int ID) override
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
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
virtual float	getMaxLineWidth () const override
virtual bool	breakLineWithoutSpace () const override
virtual Size	getLabelContentSize () const override
virtual void	setLabelContentSize (const Size &newSize) override
virtual const std::string &	getString () const override
	Returns the string that is currently being used in this label. More...
void	addChild (Node *child, int zOrder=0, int tag=0) override
	Adds a child to the container with z order and tag. More...
Public Member Functions inherited from SpriteBatchNode
	SpriteBatchNode ()
virtual	~SpriteBatchNode ()
bool	initWithTexture (Texture2D *tex, long capacity)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...
bool	initWithFile (const char *fileImage, long capacity)
	initializes a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and a capacity of children. More...
bool	init ()
	Initializes the instance of Node. More...
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 (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	appendChild (Sprite *sprite)
void	removeSpriteFromAtlas (Sprite *sprite)
var	removeSpriteFromAtlas ( var sprite)
local	removeSpriteFromAtlas ( local sprite)
int	rebuildIndexInOrder (Sprite *parent, int index)
int	highestAtlasIndexInChild (Sprite *sprite)
int	lowestAtlasIndexInChild (Sprite *sprite)
int	atlasIndexForChild (Sprite *sprite, int z)
void	reorderBatch (bool reorder)
virtual Texture2D *	getTexture (void) const override
	Returns the currently used texture. More...
virtual void	setTexture (Texture2D *texture) override
	Sets a new texuture. More...
virtual void	setBlendFunc (const BlendFunc &blendFunc) override
var	setBlendFunc ( var blendFunc)
virtual const BlendFunc &	getBlendFunc (void) const override
	Returns the blending function that is currently being used. More...
virtual void	visit (void) override
	Visits this node's children and draw them recursively. More...
virtual void	addChild (Node *child) override
	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 zOrder) override
	Adds a child to the container with a z-order. More...
var	addChild ( var child, var 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	reorderChild (Node *child, int zOrder) override
	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...
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) override
	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 Camera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...
local	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...
virtual bool	isRunning () const
	Returns whether or not the node accepts event callbacks. More...
local	isRunning ()
	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 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)
virtual EventDispatcher *	getEventDispatcher () const
local	getEventDispatcher ()
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)
var	_setZOrder ( var z)
local	_setZOrder ( local z)
virtual int	getZOrder () const
	Gets the Z order of this node. More...
var	getZOrder ()
	Gets the Z order of this node. More...
local	getZOrder ()
	Gets the Z order of this node. More...
virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...
local	setVertexZ ( local vertexZ)
	Sets the real OpenGL Z vertex. More...
virtual float	getVertexZ () const
	Gets OpenGL Z vertex of this node. More...
var	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...
local	getVertexZ ()
	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 void	setAnchorPoint (const Point &anchorPoint)
	Sets the anchor point in percent. More...
virtual const Point &	getAnchorPoint () const
	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...
virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...
local	getContentSize ()
	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...
virtual void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...
local	setOrderOfArrival ( local orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...
virtual int	getOrderOfArrival () const
	Returns the arrival order, indecates which children is added previously. More...
local	getOrderOfArrival ()
	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...
Node *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...
var	getChildByTag ( var tag)
	Gets a child from the container with its tag. More...
local	getChildByTag ( local tag)
	Gets a child from the container with its tag. More...
virtual Array *	getChildren ()
	Return an array of children. More...
virtual const Array *	getChildren () const
var	getChildren ()
local	getChildren ()
long	getChildrenCount () const
	Get the amount of children. More...
var	getChildrenCount ()
	Get the amount of children. More...
local	getChildrenCount ()
	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...
local	removeChildByTag ( local tag, local 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 GridBase *	getGrid ()
	Returns a grid object that is used when applying effects. More...
local	getGrid ()
	Returns a grid object that is used when applying effects. More...
virtual const GridBase *	getGrid () const
local	getGrid ()
virtual void	setGrid (GridBase *grid)
	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 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...
unsigned int	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...
local	getNumberOfRunningActions ()
	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 unsigned int	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...
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)
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 AffineTransform &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
local	getNodeToParentTransform ()
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const AffineTransform &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual AffineTransform	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...
local	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual AffineTransform	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...
local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...
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...
var	convertToWorldSpace ( var nodePoint)
	Converts a Point to world space coordinates. More...
local	convertToWorldSpace ( local nodePoint)
	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 the additional transform. More...
var	setAdditionalTransform ( var additionalTransform)
	Sets the additional transform. More...
local	setAdditionalTransform ( local additionalTransform)
	Sets the additional transform. More...
Component *	getComponent (const char *pName)
	gets a component by its name More...
virtual bool	addComponent (Component *pComponent)
	adds a component More...
local	addComponent ( local pComponent)
	adds a component More...
virtual bool	removeComponent (const char *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...
var	removeAllComponents ()
	removes all components More...
local	removeAllComponents ()
	removes all components More...
	Node (void)
	Default constructor. More...
virtual	~Node (void)
	Default destructor. More...
const char *	description (void) const
	Gets the description string. 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...
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 ()
Public Member Functions inherited from LabelProtocol
virtual	~LabelProtocol ()
Public Member Functions inherited from RGBAProtocol
virtual	~RGBAProtocol ()
Public Member Functions inherited from LabelTextFormatProtocol
virtual	~LabelTextFormatProtocol ()

Static Public Member Functions
static Label *	createWithTTF (const std::string &label, const std::string &fontFilePath, int fontSize, int lineSize=0, TextHAlignment alignment=TextHAlignment::CENTER, GlyphCollection glyphs=GlyphCollection::NEHE, const char *customGlyphs=0)
static Label *	createWithBMFont (const std::string &label, const std::string &bmfontFilePath, TextHAlignment alignment=TextHAlignment::CENTER, int lineSize=0)
Static Public Member Functions inherited from SpriteBatchNode
static SpriteBatchNode *	createWithTexture (Texture2D *tex, int capacity=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 char *fileImage, long capacity=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...
var	create ()
	Allocates and initializes a node. More...
local	create ()
	Allocates and initializes a node. 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...
Protected Member Functions inherited from SpriteBatchNode
void	insertQuadFromSprite (Sprite *sprite, 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 (Sprite *sprite, int 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, int *curIndex)
void	swap (int oldIndex, int newIndex)
void	updateBlendFunc ()
Protected Attributes inherited from SpriteBatchNode
TextureAtlas *	_textureAtlas
BlendFunc	_blendFunc
var	_blendFunc
local	_blendFunc
std::vector< Sprite * >	_descendants
var	_descendants
local	_descendants

Member Function Documentation

void addChild ( Node *  child, int  zOrder = 0, int  tag = 0  )

overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters

child	A child node
zOrder	Z order for drawing priority. Please refer to setZOrder(int)
tag	A interger to identify the node easily. Please refer to setTag(int)

Reimplemented from SpriteBatchNode.

virtual void assignNewUTF8String ( unsigned short *  newString)

overridevirtual

Implements LabelTextFormatProtocol.

virtual bool breakLineWithoutSpace ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

static Label* createWithBMFont ( const std::string &  label, const std::string &  bmfontFilePath, TextHAlignment  alignment = TextHAlignment::CENTER, int  lineSize = 0  )

static

static Label* createWithTTF ( const std::string &  label, const std::string &  fontFilePath, int  fontSize, int  lineSize = 0, TextHAlignment  alignment = TextHAlignment::CENTER, GlyphCollection  glyphs = GlyphCollection::NEHE, const char *  customGlyphs = 0  )

static

virtual int getAdvanceForChar ( unsigned short  c, int  hintPositionInString  ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual unsigned short getCharAtStringPosition ( int  position) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual const Color3B& getColor ( void  ) const

overridevirtual

Returns color that is currently used.

Returns

The Color3B contains R,G,B bytes.

Implements RGBAProtocol.

virtual int getCommonLineHeight ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual const Color3B& getDisplayedColor ( ) const

overridevirtual

Returns the displayed color.

Returns

The Color3B contains R,G,B bytes.

Implements RGBAProtocol.

virtual unsigned char getDisplayedOpacity ( ) const

overridevirtual

Returns the displayed opacity.

Returns

The opacity of sprite, from 0 ~ 255

Implements RGBAProtocol.

virtual int getKerningForCharsPair ( unsigned short  first, unsigned short  second  ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual Size getLabelContentSize ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual Sprite* getLetter ( int  ID)

overridevirtual

Implements LabelTextFormatProtocol.

virtual float getLetterPosXLeft ( int  index) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual float getLetterPosXRight ( int  index) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual std::vector<LetterInfo> * getLettersInfo ( )

inlineoverridevirtual

Implements LabelTextFormatProtocol.

virtual float getMaxLineWidth ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual unsigned char getOpacity ( ) const

overridevirtual

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

virtual Rect getRectForChar ( unsigned short  c) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual const std::string& getString ( ) const

inlineoverridevirtual

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

Returns

The string that is currently being used in this label

Implements LabelProtocol.

virtual int getStringLenght ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual int getStringNumLines ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual TextHAlignment getTextAlignment ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual unsigned short* getUTF8String ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual int getXOffsetForChar ( unsigned short  c) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual int getYOffsetForChar ( unsigned short  c) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual bool isCascadeColorEnabled ( ) const

overridevirtual

whether or not color should be propagated to its children.

Implements RGBAProtocol.

virtual bool isCascadeOpacityEnabled ( ) const

overridevirtual

whether or not opacity should be propagated to its children.

Implements RGBAProtocol.

virtual bool isOpacityModifyRGB ( ) const

overridevirtual

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

virtual bool recordLetterInfo ( const cocos2d::Point &  point, unsigned short int  theChar, int  spriteIndex  )

overridevirtual

Implements LabelTextFormatProtocol.

virtual bool recordPlaceholderInfo ( int  spriteIndex)

overridevirtual

Implements LabelTextFormatProtocol.

virtual void setAlignment ( TextHAlignment  alignment)

virtual

virtual void setCascadeColorEnabled ( bool  cascadeColorEnabled)

overridevirtual

Implements RGBAProtocol.

virtual void setCascadeOpacityEnabled ( bool  cascadeOpacityEnabled)

overridevirtual

Implements RGBAProtocol.

virtual void setColor ( const Color3B &  color)

overridevirtual

Changes the color with R,G,B bytes.

Parameters

color

Example: Color3B(255,100,0) means R=255, G=100, B=0

Implements RGBAProtocol.

virtual void setLabelContentSize ( const Size &  newSize)

overridevirtual

Implements LabelTextFormatProtocol.

virtual void setLineBreakWithoutSpace ( bool  breakWithoutSpace)

virtual

virtual void setOpacity ( GLubyte  opacity)

overridevirtual

Changes the opacity.

Parameters

opacity

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

Implements RGBAProtocol.

virtual void setOpacityModifyRGB ( bool  value)

overridevirtual

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

value

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

Implements RGBAProtocol.

virtual void setScale ( float  scale)

overridevirtual

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)

overridevirtual

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)

overridevirtual

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.

bool setText	(	const std::string &	stringToRender,
		float	lineWidth,
		TextHAlignment	alignment = TextHAlignment::LEFT,
		bool	lineBreakWithoutSpaces = false
	)

virtual void setWidth ( float  width)

virtual

virtual void updateDisplayedColor ( const Color3B &  color)

overridevirtual

recursive method that updates display color

Implements RGBAProtocol.

virtual void updateDisplayedOpacity ( GLubyte  opacity)

overridevirtual

recursive method that updates the displayed opacity.

Implements RGBAProtocol.

---

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

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