#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)
void	setLabelEffect (LabelEffect effect, const Color3B &effectColor)
virtual void	setString (const std::string &stringToRender) override
	Sets a new label using a string. More...

void	setString (const std::string &stringToRender, bool multilineEnable)
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 float	getScaleX () const
	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 bool	isOpacityModifyRGB () const override
virtual void	setOpacityModifyRGB (bool isOpacityModifyRGB) override
virtual void	setColor (const Color3B &color) override
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...

virtual std::string	getDescription () const override
	Gets the description string. More...

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

virtual void	onDraw ()
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	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...

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
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
var	setCascadeOpacityEnabled ( var cascadeOpacityEnabled)
local	setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual const Color3B &	getColor (void) const
local	getColor ()
virtual const Color3B &	getDisplayedColor () const
local	getDisplayedColor ()
virtual void	updateDisplayedColor (const Color3B &parentColor)
local	updateDisplayedColor ( local parentColor)
virtual bool	isCascadeColorEnabled () const
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
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...

local	setZOrder ( local 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)
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...

local	getVertexZ ()
	Gets OpenGL Z vertex 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...

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 zOrder)
	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 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 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...

var	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...

local	resume ()
	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)
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...

local	getNodeToParentTransform ()
	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...

var	getWorldToNodeTransform ()
	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 the additional transform. More...

var	setAdditionalTransform ( var additionalTransform)
	Sets the additional transform. More...

local	setAdditionalTransform ( local additionalTransform)
	Sets the additional transform. 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...

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

local	retainCount ()
	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 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, bool useDistanceField=false)
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, ssize_t capacity=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...

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

var	_luaID
	Lua reference id. More...

local	_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, 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 Attributes inherited from SpriteBatchNode
TextureAtlas *	_textureAtlas
BlendFunc	_blendFunc
var	_blendFunc
local	_blendFunc
QuadCommand	_quadCommand
var	_quadCommand
local	_quadCommand
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`,
		bool	useDistanceField = `false`
	)

static

virtual void draw ( void )

overridevirtual

Override this method to draw your own node.

The following GL states will be enabled by default:

glEnableClientState(GL_VERTEX_ARRAY);
glEnableClientState(GL_COLOR_ARRAY);
glEnableClientState(GL_TEXTURE_COORD_ARRAY);
glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented from SpriteBatchNode.

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

overridevirtual

Implements LabelTextFormatProtocol.

virtual unsigned short
getCharAtStringPosition ( int position) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual int getCommonLineHeight ( ) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual std::string getDescription ( ) const

overridevirtual

Gets the description string.

It makes debugging easier.

Returns: A string

Reimplemented from SpriteBatchNode.

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 Rect getRectForChar ( unsigned short c) const

overridevirtual

Implements LabelTextFormatProtocol.

virtual float getScaleX ( ) const

virtual

Returns the scale factor on X axis of this node.

See Also: setScaleX(float)

Returns: The scale factor on X axis.

Reimplemented from Node.

virtual float getScaleY ( ) const

virtual

Returns the scale factor on Y axis of this node.

See Also: setScaleY(float)

Returns: The scale factor on Y axis.

Reimplemented from Node.

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 isOpacityModifyRGB ( ) const

overridevirtual

Reimplemented from Node.

virtual void onDraw ( )

virtual

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 setColor ( const Color3B & color)

overridevirtual

Reimplemented from Node.

virtual void setLabelContentSize ( const Size & newSize)

overridevirtual

Implements LabelTextFormatProtocol.

void setLabelEffect	(	LabelEffect	effect,
		const Color3B &	effectColor
	)

virtual void
setLineBreakWithoutSpace ( bool breakWithoutSpace)

virtual

virtual void setOpacityModifyRGB ( bool isOpacityModifyRGB)

overridevirtual

Reimplemented from Node.

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.

void setString	(	const std::string &	stringToRender,
		bool	multilineEnable
	)

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

virtual void setWidth ( float width)

virtual

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation