Label Class Reference

#include <CCLabel.h>

Inheritance diagram for Label:

Classes
struct	LetterInfo

Public Member Functions
virtual bool	setTTFConfig (const TTFConfig &ttfConfig)
	set TTF configuration for Label More...
var	setTTFConfig ( var ttfConfig)
	set TTF configuration for Label More...
local	setTTFConfig ( local ttfConfig)
	set TTF configuration for Label More...
virtual const TTFConfig &	getTTFConfig () const
virtual bool	setBMFontFilePath (const std::string &bmfontFilePath, const Vec2 &imageOffset=Vec2::ZERO)
var	setBMFontFilePath ( var bmfontFilePath, var ZERO)
local	setBMFontFilePath ( local bmfontFilePath, local ZERO)
const std::string &	getBMFontFilePath () const
virtual bool	setCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
local	setCharMap ( local charMapFile, local itemWidth, local itemHeight, local startCharMap)
virtual bool	setCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
local	setCharMap ( local texture, local itemWidth, local itemHeight, local startCharMap)
virtual bool	setCharMap (const std::string &plistFile)
virtual void	setSystemFontName (const std::string &systemFont)
local	setSystemFontName ( local systemFont)
virtual const std::string &	getSystemFontName () const
local	getSystemFontName ()
virtual void	setSystemFontSize (float fontSize)
local	setSystemFontSize ( local fontSize)
virtual float	getSystemFontSize () const
var	getSystemFontSize ()
local	getSystemFontSize ()
virtual void	setString (const std::string &text) override
	changes the string to render More...
var	setString ( var text)
	changes the string to render More...
local	setString ( local text)
	changes the string to render More...
virtual const std::string &	getString () const override
	Returns the string that is currently being used in this label. More...
local	getString ()
	Returns the string that is currently being used in this label. More...
virtual void	enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Size &offset=Size(2,-2), int blurRadius=0)
	Enable shadow for the label. More...
var	enableShadow ( var BLACK, var 2, var 0)
	Enable shadow for the label. More...
virtual void	enableOutline (const Color4B &outlineColor, int outlineSize=-1)
	only support for TTF More...
var	enableOutline ( var outlineColor, var 1)
	only support for TTF More...
local	enableOutline ( local outlineColor, local 1)
	only support for TTF More...
virtual void	enableGlow (const Color4B &glowColor)
	only support for TTF More...
local	enableGlow ( local glowColor)
	only support for TTF More...
virtual void	disableEffect ()
	disable shadow/outline/glow rendering More...
var	disableEffect ()
	disable shadow/outline/glow rendering More...
local	disableEffect ()
	disable shadow/outline/glow rendering More...
void	setAlignment (TextHAlignment hAlignment)
var	setAlignment ( var hAlignment)
local	setAlignment ( local hAlignment)
TextHAlignment	getTextAlignment () const
void	setAlignment (TextHAlignment hAlignment, TextVAlignment vAlignment)
var	setAlignment ( var hAlignment, var vAlignment)
local	setAlignment ( local hAlignment, local vAlignment)
void	setHorizontalAlignment (TextHAlignment hAlignment)
local	setHorizontalAlignment ( local hAlignment)
TextHAlignment	getHorizontalAlignment () const
var	getHorizontalAlignment ()
local	getHorizontalAlignment ()
void	setVerticalAlignment (TextVAlignment vAlignment)
local	setVerticalAlignment ( local vAlignment)
TextVAlignment	getVerticalAlignment () const
var	getVerticalAlignment ()
local	getVerticalAlignment ()
void	setLineBreakWithoutSpace (bool breakWithoutSpace)
var	setLineBreakWithoutSpace ( var breakWithoutSpace)
local	setLineBreakWithoutSpace ( local breakWithoutSpace)
void	setMaxLineWidth (unsigned int maxLineWidth)
	Sets the max line width of the label. More...
var	setMaxLineWidth ( var maxLineWidth)
	Sets the max line width of the label. More...
local	setMaxLineWidth ( local maxLineWidth)
	Sets the max line width of the label. More...
unsigned int	getMaxLineWidth ()
var	getMaxLineWidth ()
local	getMaxLineWidth ()
void	setWidth (unsigned int width)
	Sets the untransformed size of the label. More...
var	setWidth ( var width)
	Sets the untransformed size of the label. More...
local	setWidth ( local width)
	Sets the untransformed size of the label. More...
unsigned int	getWidth () const
var	getWidth ()
local	getWidth ()
void	setHeight (unsigned int height)
	Sets the untransformed size of the label. More...
var	setHeight ( var height)
	Sets the untransformed size of the label. More...
local	setHeight ( local height)
	Sets the untransformed size of the label. More...
unsigned int	getHeight () const
var	getHeight ()
local	getHeight ()
void	setDimensions (unsigned int width, unsigned int height)
	Sets the untransformed size of the label in a more efficient way. More...
var	setDimensions ( var width, var height)
	Sets the untransformed size of the label in a more efficient way. More...
local	setDimensions ( local width, local height)
	Sets the untransformed size of the label in a more efficient way. More...
const Size &	getDimensions () const
var	getDimensions ()
local	getDimensions ()
virtual void	updateContent ()
	update content immediately. More...
local	updateContent ()
	update content immediately. More...
virtual void	setTextColor (const Color4B &color)
	Sets the text color. More...
local	setTextColor ( local color)
	Sets the text color. More...
const Color4B &	getTextColor () const
virtual Sprite *	getLetter (int lettetIndex)
local	getLetter ( local lettetIndex)
void	setClipMarginEnabled (bool clipEnabled)
	clip upper and lower margin for reduce height of label. More...
var	setClipMarginEnabled ( var clipEnabled)
	clip upper and lower margin for reduce height of label. More...
local	setClipMarginEnabled ( local clipEnabled)
	clip upper and lower margin for reduce height of label. More...
bool	isClipMarginEnabled () const
int	getCommonLineHeight () const
var	getCommonLineHeight ()
local	getCommonLineHeight ()
int	getStringNumLines () const
var	getStringNumLines ()
local	getStringNumLines ()
int	getStringLength () const
var	getStringLength ()
local	getStringLength ()
FontAtlas *	getFontAtlas ()
local	getFontAtlas ()
virtual void	setBlendFunc (const BlendFunc &blendFunc) override
virtual bool	isOpacityModifyRGB () const override
var	isOpacityModifyRGB ()
local	isOpacityModifyRGB ()
virtual void	setOpacityModifyRGB (bool isOpacityModifyRGB) override
local	setOpacityModifyRGB ( local isOpacityModifyRGB)
virtual void	updateDisplayedColor (const Color3B &parentColor) override
local	updateDisplayedColor ( local parentColor)
virtual void	updateDisplayedOpacity (GLubyte parentOpacity) override
var	updateDisplayedOpacity ( var parentOpacity)
local	updateDisplayedOpacity ( local parentOpacity)
virtual void	setScale (float scale) override
	Sets the scale (x,y,z) of the node. More...
local	setScale ( local scale)
	Sets the scale (x,y,z) of the node. More...
virtual void	setScaleX (float scaleX) override
	Sets the scale (x) of the node. More...
local	setScaleX ( local scaleX)
	Sets the scale (x) of the node. More...
virtual void	setScaleY (float scaleY) override
	Sets the scale (y) of the node. More...
local	setScaleY ( local scaleY)
	Sets the scale (y) of the node. More...
virtual float	getScaleX () const override
	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 override
	Returns the scale factor on Y axis of this node. More...
var	getScaleY ()
	Returns the scale factor on Y axis of this node. More...
local	getScaleY ()
	Returns the scale factor on Y axis of this node. More...
virtual void	addChild (Node *child, int zOrder=0, int tag=0) override
	Adds a child to the container with z order and tag. More...
var	addChild ( var child, var 0, var 0)
	Adds a child to the container with z order and tag. More...
local	addChild ( local child, local 0, local 0)
	Adds a child to the container with z order and tag. More...
virtual void	sortAllChildren () override
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
var	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
local	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
virtual std::string	getDescription () const override
	Gets the description string. More...
virtual const Size &	getContentSize () const override
	Returns the untransformed size of the node. More...
local	getContentSize ()
	Returns the untransformed size of the node. More...
virtual Rect	getBoundingBox () const override
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
local	getBoundingBox ()
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, bool parentTransformUpdated) override
	Visits this node's children and draw them recursively. More...
local	visit ( local renderer, local parentTransform, local parentTransformUpdated)
	Visits this node's children and draw them recursively. More...
virtual void	draw (Renderer *renderer, const Mat4 &transform, bool transformUpdated) override
	Override this method to draw your own node. More...
local	draw ( local renderer, local transform, local transformUpdated)
	Override this method to draw your own node. More...
virtual CC_DEPRECATED_ATTRIBUTE void	setFontDefinition (const FontDefinition &textDefinition)
local	setFontDefinition ( local textDefinition)
CC_DEPRECATED_ATTRIBUTE const FontDefinition &	getFontDefinition () const
local	getFontDefinition ()
Public Member Functions inherited from SpriteBatchNode
TextureAtlas *	getTextureAtlas (void)
	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...
local	getDescendants ()
	returns an array with the descendants (children, gran children, etc.). More...
void	increaseAtlasCapacity ()
var	increaseAtlasCapacity ()
local	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)
local	appendChild ( local sprite)
void	removeSpriteFromAtlas (Sprite *sprite)
local	removeSpriteFromAtlas ( local sprite)
ssize_t	rebuildIndexInOrder (Sprite *parent, ssize_t index)
local	rebuildIndexInOrder ( local parent, local index)
ssize_t	highestAtlasIndexInChild (Sprite *sprite)
local	highestAtlasIndexInChild ( local sprite)
ssize_t	lowestAtlasIndexInChild (Sprite *sprite)
var	lowestAtlasIndexInChild ( var sprite)
local	lowestAtlasIndexInChild ( local sprite)
ssize_t	atlasIndexForChild (Sprite *sprite, int z)
local	atlasIndexForChild ( local sprite, local z)
void	reorderBatch (bool reorder)
local	reorderBatch ( local reorder)
virtual Texture2D *	getTexture () const override
	Returns the currently used texture. More...
local	getTexture ()
	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 const BlendFunc &	getBlendFunc () const override
	Returns the blending function that is currently being used. 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...
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...
local	removeAllChildrenWithCleanup ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
void	insertQuadFromSprite (Sprite *sprite, ssize_t 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...
SpriteBatchNode *	addSpriteWithoutQuad (Sprite *child, int z, int aTag)
local	addSpriteWithoutQuad ( local child, local z, local aTag)
virtual	~SpriteBatchNode ()
bool	initWithTexture (Texture2D *tex, ssize_t capacity)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...
var	initWithTexture ( var tex, var capacity)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...
local	initWithTexture ( local tex, local 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 ()
Public Member Functions inherited from Node
virtual bool	isRunning () const
	Returns whether or not the node is "running". More...
var	isRunning ()
	Returns whether or not the node is "running". More...
local	isRunning ()
	Returns whether or not the node is "running". More...
void	scheduleUpdateWithPriorityLua (int handler, int 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 void	draw () final
var	draw ()
local	draw ()
virtual void	visit () final
virtual Scene *	getScene ()
	Returns the Scene that contains the Node. More...
local	getScene ()
	Returns the Scene that contains 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 ()
virtual GLubyte	getOpacity () const
var	getOpacity ()
local	getOpacity ()
virtual GLubyte	getDisplayedOpacity () const
local	getDisplayedOpacity ()
virtual void	setOpacity (GLubyte opacity)
local	setOpacity ( local opacity)
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 bool	isCascadeColorEnabled () const
var	isCascadeColorEnabled ()
local	isCascadeColorEnabled ()
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
virtual	~Node ()
var	~Node ()
local	~Node ()
virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
var	setLocalZOrder ( var localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
local	setLocalZOrder ( local 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)
var	_setLocalZOrder ( var z)
local	_setLocalZOrder ( local z)
virtual int	getLocalZOrder () const
	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
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	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...
local	setScaleZ ( local scaleZ)
	Changes the scale factor on Z axis of this node. More...
virtual float	getScaleZ () const
	Returns the scale factor on Z 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)
	Sets the scale (x,y) of the node. More...
local	setScale ( local scaleX, local scaleY)
	Sets the scale (x,y) of the node. More...
virtual void	setPosition (const Vec2 &position)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...
virtual void	setPosition (float x, float y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
local	setPosition ( local x, local y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
virtual void	getPosition (float *x, float *y) const
	Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
var	getPosition ( var x, var y)
	Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
local	getPosition ( local x, local y)
	Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...
var	setPositionX ( var x)
	Gets/Sets x or y coordinate individually for position. More...
local	setPositionX ( local x)
	Gets/Sets x or y coordinate individually for position. More...
virtual float	getPositionX (void) const
var	getPositionX ()
local	getPositionX ()
virtual void	setPositionY (float y)
local	setPositionY ( local y)
virtual float	getPositionY (void) const
local	getPositionY ()
virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...
local	setPosition3D ( local position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...
virtual Vec3	getPosition3D () const
	returns the position (X,Y,Z) in its parent's coordinate system More...
virtual void	setPositionZ (float positionZ)
	Sets the 'z' coordinate in the position. More...
local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. More...
virtual CC_DEPRECATED_ATTRIBUTE void	setVertexZ (float vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...
virtual CC_DEPRECATED_ATTRIBUTE float	getVertexZ () const
local	getVertexZ ()
virtual void	setSkewX (float skewX)
	Changes the X skew angle of the node in degrees. More...
local	setSkewX ( local skewX)
	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...
local	getSkewX ()
	Returns the X skew angle of the node in degrees. More...
virtual void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees. More...
local	setSkewY ( local skewY)
	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 Vec2 &anchorPoint)
	Sets the anchor point in percent. More...
local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. More...
virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...
virtual const Vec2 &	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 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...
var	setRotation ( var 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	setRotation3D (const Vec3 &rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
var	setRotation3D ( var rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
local	setRotation3D ( local rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
virtual Vec3	getRotation3D () const
	returns the rotation (X,Y,Z) in degrees. More...
var	getRotation3D ()
	returns the rotation (X,Y,Z) in degrees. More...
local	getRotation3D ()
	returns the rotation (X,Y,Z) in degrees. More...
virtual void	setRotationSkewX (float rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
local	setRotationSkewX ( local rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
virtual CC_DEPRECATED_ATTRIBUTE void	setRotationX (float rotationX)
local	setRotationX ( local rotationX)
virtual float	getRotationSkewX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
virtual CC_DEPRECATED_ATTRIBUTE float	getRotationX () const
local	getRotationX ()
virtual void	setRotationSkewY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
local	setRotationSkewY ( local rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
virtual CC_DEPRECATED_ATTRIBUTE void	setRotationY (float rotationY)
local	setRotationY ( local rotationY)
virtual float	getRotationSkewY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
virtual CC_DEPRECATED_ATTRIBUTE float	getRotationY () const
local	getRotationY ()
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, indicates 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...
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 ()
	Returns the array of the node's children. More...
local	getChildren ()
	Returns the array of the node's children. More...
virtual const Vector< Node * > &	getChildren () const
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns 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...
var	removeAllChildren ()
	Removes all children from the container with a cleanup. More...
local	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 Ref *	getUserObject ()
	Returns a user assigned Object. More...
virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...
local	setUserObject ( local userObject)
	Returns a user assigned Object. More...
GLProgram *	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...
var	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...
local	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...
CC_DEPRECATED_ATTRIBUTE GLProgram *	getShaderProgram ()
local	getShaderProgram ()
GLProgramState *	getGLProgramState ()
var	getGLProgramState ()
local	getGLProgramState ()
void	setGLProgramState (GLProgramState *glProgramState)
var	setGLProgramState ( var glProgramState)
local	setGLProgramState ( local glProgramState)
void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...
CC_DEPRECATED_ATTRIBUTE void	setShaderProgram (GLProgram *glprogram)
local	setShaderProgram ( local glprogram)
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...
local	setActionManager ( local 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...
local	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...
void	stopAllActions ()
	Stops and removes all actions from the running action list . More...
var	stopAllActions ()
	Stops and removes all actions from the running action list . More...
local	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...
Action *	getActionByTag (int 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...
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 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...
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)
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 Mat4 &	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 Mat4 &transform)
	Sets the Transformation matrix manually. More...
local	setNodeToParentTransform ( local transform)
	Sets the Transformation matrix manually. More...
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const Mat4 &	getParentToNodeTransform () const
	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 Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...
var	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...
local	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...
virtual AffineTransform	getNodeToWorldAffineTransform () const
local	getNodeToWorldAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...
virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...
Vec2	convertToWorldSpace (const Vec2 &nodePoint) const
	Converts a Vec2 to world space coordinates. More...
Vec2	convertToNodeSpaceAR (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...
Vec2	convertToWorldSpaceAR (const Vec2 &nodePoint) const
	Converts a local Vec2 to world space coordinates.The result is in Points. More...
Vec2	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Vec2 More...
Vec2	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 (Mat4 *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 AffineTransform &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
Component *	getComponent (const std::string &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...
local	addComponent ( local pComponent)
	adds a component More...
virtual bool	removeComponent (const std::string &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...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
Public Member Functions inherited from TextureProtocol
virtual	~TextureProtocol ()
Public Member Functions inherited from BlendProtocol
virtual	~BlendProtocol ()
Public Member Functions inherited from LabelProtocol
virtual	~LabelProtocol ()

Static Public Member Functions
static Label *	create ()
var	create ()
local	create ()
static Label *	createWithSystemFont (const std::string &text, const std::string &font, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
	Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment. More...
var	createWithSystemFont ( var text, var font, var fontSize, var ZERO, var LEFT, var TOP)
	Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment. More...
local	createWithSystemFont ( local text, local font, local fontSize, local ZERO, local LEFT, local TOP)
	Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment. More...
static Label *	createWithTTF (const std::string &text, const std::string &fontFile, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
	Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment. More...
var	createWithTTF ( var text, var fontFile, var fontSize, var ZERO, var LEFT, var TOP)
	Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment. More...
local	createWithTTF ( local text, local fontFile, local fontSize, local ZERO, local LEFT, local TOP)
	Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment. More...
static Label *	createWithTTF (const TTFConfig &ttfConfig, const std::string &text, TextHAlignment alignment=TextHAlignment::LEFT, int maxLineWidth=0)
	Create a label with TTF configuration. More...
var	createWithTTF ( var ttfConfig, var text, var LEFT, var 0)
	Create a label with TTF configuration. More...
local	createWithTTF ( local ttfConfig, local text, local LEFT, local 0)
	Create a label with TTF configuration. More...
static Label *	createWithBMFont (const std::string &bmfontFilePath, const std::string &text, const TextHAlignment &alignment=TextHAlignment::LEFT, int maxLineWidth=0, const Vec2 &imageOffset=Vec2::ZERO)
local	createWithBMFont ( local bmfontFilePath, local text, local LEFT, local 0, local ZERO)
static Label *	createWithCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
static Label *	createWithCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
static Label *	createWithCharMap (const std::string &plistFile)
static CC_DEPRECATED_ATTRIBUTE Label *	create (const std::string &text, const std::string &font, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
local	create ( local text, local font, local fontSize, local ZERO, local LEFT, local TOP)
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...
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...
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...

Static Public Attributes
static const int	DistanceFieldFontSize
var	DistanceFieldFontSize
local	DistanceFieldFontSize
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 Types
enum	LabelType { TTF, BMFONT, CHARMAP, STRING_TEXTURE }

Protected Member Functions
void	onDraw (const Mat4 &transform, bool transformUpdated)
var	onDraw ( var transform, var transformUpdated)
local	onDraw ( local transform, local transformUpdated)
	Label (FontAtlas *atlas=nullptr, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP, bool useDistanceField=false, bool useA8Shader=false)
virtual	~Label ()
virtual void	setFontAtlas (FontAtlas *atlas, bool distanceFieldEnabled=false, bool useA8Shader=false)
bool	recordLetterInfo (const cocos2d::Vec2 &point, const FontLetterDefinition &letterDef, int spriteIndex)
bool	recordPlaceholderInfo (int spriteIndex)
var	recordPlaceholderInfo ( var spriteIndex)
local	recordPlaceholderInfo ( local spriteIndex)
void	setFontScale (float fontScale)
var	setFontScale ( var fontScale)
local	setFontScale ( local fontScale)
virtual void	alignText ()
var	alignText ()
local	alignText ()
bool	computeHorizontalKernings (const std::u16string &stringToRender)
var	computeHorizontalKernings ( var stringToRender)
local	computeHorizontalKernings ( local stringToRender)
void	computeStringNumLines ()
var	computeStringNumLines ()
local	computeStringNumLines ()
void	updateQuads ()
var	updateQuads ()
local	updateQuads ()
virtual void	updateColor () override
local	updateColor ()
virtual void	updateShaderProgram ()
var	updateShaderProgram ()
local	updateShaderProgram ()
void	drawShadowWithoutBlur ()
var	drawShadowWithoutBlur ()
local	drawShadowWithoutBlur ()
void	drawTextSprite (Renderer *renderer, bool parentTransformUpdated)
var	drawTextSprite ( var renderer, var parentTransformUpdated)
local	drawTextSprite ( local renderer, local parentTransformUpdated)
void	createSpriteWithFontDefinition ()
var	createSpriteWithFontDefinition ()
local	createSpriteWithFontDefinition ()
void	updateFont ()
var	updateFont ()
local	updateFont ()
void	reset ()
var	reset ()
local	reset ()
Protected Member Functions inherited from SpriteBatchNode
void	updateQuadFromSprite (Sprite *sprite, ssize_t index)
	Updates a quad at a certain index into the texture atlas. More...
var	updateQuadFromSprite ( var sprite, var index)
	Updates a quad at a certain index into the texture atlas. More...
local	updateQuadFromSprite ( local sprite, local index)
	Updates a quad at a certain index into the texture atlas. More...
void	updateAtlasIndex (Sprite *sprite, ssize_t *curIndex)
local	updateAtlasIndex ( local sprite, local curIndex)
void	swap (ssize_t oldIndex, ssize_t newIndex)
var	swap ( var oldIndex, var newIndex)
local	swap ( local oldIndex, local newIndex)
void	updateBlendFunc ()
var	updateBlendFunc ()
local	updateBlendFunc ()
Protected Member Functions inherited from 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...
Vec2	convertToWindowSpace (const Vec2 &nodePoint) const
	Convert cocos2d coordinates to UI windows coordinate. More...
Mat4	transform (const Mat4 &parentTransform)
var	transform ( var parentTransform)
local	transform ( local parentTransform)
virtual void	updateCascadeOpacity ()
var	updateCascadeOpacity ()
local	updateCascadeOpacity ()
virtual void	disableCascadeOpacity ()
var	disableCascadeOpacity ()
local	disableCascadeOpacity ()
virtual void	updateCascadeColor ()
local	updateCascadeColor ()
virtual void	disableCascadeColor ()
local	disableCascadeColor ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
std::string	_bmFontPath
var	_bmFontPath
bool	_isOpacityModifyRGB
var	_isOpacityModifyRGB
local	_isOpacityModifyRGB
bool	_contentDirty
var	_contentDirty
local	_contentDirty
bool	_systemFontDirty
var	_systemFontDirty
local	_systemFontDirty
std::string	_systemFont
var	_systemFont
local	_systemFont
float	_systemFontSize
var	_systemFontSize
local	_systemFontSize
LabelType	_currentLabelType
var	_currentLabelType
local	_currentLabelType
std::vector< SpriteBatchNode * >	_batchNodes
var	_batchNodes
local	_batchNodes
FontAtlas *	_fontAtlas
var	_fontAtlas
local	_fontAtlas
std::vector< LetterInfo >	_lettersInfo
var	_lettersInfo
local	_lettersInfo
TTFConfig	_fontConfig
var	_fontConfig
local	_fontConfig
Sprite *	_textSprite
var	_textSprite
local	_textSprite
FontDefinition	_fontDefinition
var	_fontDefinition
local	_fontDefinition
bool	_compatibleMode
var	_compatibleMode
local	_compatibleMode
Sprite *	_reusedLetter
	used for optimization More...
var	_reusedLetter
	used for optimization More...
local	_reusedLetter
	used for optimization More...
Rect	_reusedRect
local	_reusedRect
int	_limitShowCount
var	_limitShowCount
local	_limitShowCount
float	_commonLineHeight
var	_commonLineHeight
local	_commonLineHeight
bool	_lineBreakWithoutSpaces
var	_lineBreakWithoutSpaces
local	_lineBreakWithoutSpaces
int *	_horizontalKernings
var	_horizontalKernings
local	_horizontalKernings
unsigned int	_maxLineWidth
var	_maxLineWidth
local	_maxLineWidth
Size	_labelDimensions
var	_labelDimensions
local	_labelDimensions
unsigned int	_labelWidth
var	_labelWidth
local	_labelWidth
unsigned int	_labelHeight
var	_labelHeight
local	_labelHeight
TextHAlignment	_hAlignment
var	_hAlignment
local	_hAlignment
TextVAlignment	_vAlignment
var	_vAlignment
local	_vAlignment
int	_currNumLines
var	_currNumLines
local	_currNumLines
std::u16string	_currentUTF16String
var	_currentUTF16String
local	_currentUTF16String
std::string	_originalUTF8String
var	_originalUTF8String
local	_originalUTF8String
float	_fontScale
var	_fontScale
local	_fontScale
bool	_useDistanceField
var	_useDistanceField
local	_useDistanceField
bool	_useA8Shader
var	_useA8Shader
local	_useA8Shader
LabelEffect	_currLabelEffect
var	_currLabelEffect
local	_currLabelEffect
Color4B	_effectColor
var	_effectColor
local	_effectColor
Color4F	_effectColorF
var	_effectColorF
local	_effectColorF
GLuint	_uniformEffectColor
var	_uniformEffectColor
local	_uniformEffectColor
GLuint	_uniformTextColor
var	_uniformTextColor
local	_uniformTextColor
CustomCommand	_customCommand
var	_customCommand
local	_customCommand
bool	_shadowDirty
var	_shadowDirty
local	_shadowDirty
bool	_shadowEnabled
var	_shadowEnabled
local	_shadowEnabled
Size	_shadowOffset
var	_shadowOffset
local	_shadowOffset
int	_shadowBlurRadius
var	_shadowBlurRadius
local	_shadowBlurRadius
Mat4	_shadowTransform
var	_shadowTransform
local	_shadowTransform
Color3B	_shadowColor
var	_shadowColor
local	_shadowColor
float	_shadowOpacity
var	_shadowOpacity
local	_shadowOpacity
Sprite *	_shadowNode
var	_shadowNode
local	_shadowNode
int	_outlineSize
var	_outlineSize
local	_outlineSize
Color4B	_textColor
var	_textColor
local	_textColor
Color4F	_textColorF
var	_textColorF
local	_textColorF
bool	_clipEnabled
var	_clipEnabled
local	_clipEnabled
bool	_blendFuncDirty
var	_blendFuncDirty
local	_blendFuncDirty
bool	_insideBounds
var	_insideBounds
local	_insideBounds
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 on the X-axis More...
float	_rotationY
	rotation on the Y-axis More...
var	_rotationY
	rotation on the Y-axis More...
local	_rotationY
	rotation on the Y-axis More...
float	_rotationZ_X
	rotation angle on Z-axis, component X More...
var	_rotationZ_X
	rotation angle on Z-axis, component X More...
local	_rotationZ_X
	rotation angle on Z-axis, component X More...
float	_rotationZ_Y
	rotation angle on Z-axis, component Y More...
var	_rotationZ_Y
	rotation angle on Z-axis, component Y More...
local	_rotationZ_Y
	rotation angle on Z-axis, component Y 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...
float	_scaleZ
	scaling factor on z-axis More...
var	_scaleZ
	scaling factor on z-axis More...
local	_scaleZ
	scaling factor on z-axis More...
Vec2	_position
	position of the node More...
var	_position
	position of the node More...
local	_position
	position of the node More...
float	_positionZ
	OpenGL real Z position. More...
var	_positionZ
	OpenGL real Z position. More...
local	_positionZ
	OpenGL real Z position. 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...
Vec2	_anchorPointInPoints
	anchor point in points More...
var	_anchorPointInPoints
	anchor point in points More...
local	_anchorPointInPoints
	anchor point in points More...
Vec2	_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...
Mat4	_modelViewTransform
	ModelView transform of the Node. More...
var	_modelViewTransform
	ModelView transform of the Node. More...
local	_modelViewTransform
	ModelView transform of the Node. More...
Mat4	_transform
	transform More...
var	_transform
	transform More...
local	_transform
	transform More...
bool	_transformDirty
	transform dirty flag More...
var	_transformDirty
	transform dirty flag More...
local	_transformDirty
	transform dirty flag More...
Mat4	_inverse
	inverse transform More...
var	_inverse
	inverse transform More...
local	_inverse
	inverse transform More...
bool	_inverseDirty
	inverse transform dirty flag More...
var	_inverseDirty
	inverse transform dirty flag More...
local	_inverseDirty
	inverse transform dirty flag More...
Mat4	_additionalTransform
	transform More...
var	_additionalTransform
	transform More...
local	_additionalTransform
	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	_transformUpdated
	Whether or not the Transform object was updated since the last frame. More...
var	_transformUpdated
	Whether or not the Transform object was updated since the last frame. More...
local	_transformUpdated
	Whether or not the Transform object was updated since the last frame. 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...
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...
std::string	_name
	a string label, an user defined string to identify this node More...
var	_name
	a string label, an user defined string to identify this node More...
local	_name
	a string label, an user defined string 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...
Ref *	_userObject
	A user assigned Object. More...
var	_userObject
	A user assigned Object. More...
local	_userObject
	A user assigned Object. More...
GLProgramState *	_glProgramState
	OpenGL Program State. More...
var	_glProgramState
	OpenGL Program State. More...
local	_glProgramState
	OpenGL Program State. More...
int	_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...
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...
var	_running
	is running More...
local	_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 Vec2 will be (0,0) when you position the Node, false otherwise. More...
var	_ignoreAnchorPointForPosition
	true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
local	_ignoreAnchorPointForPosition
	true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
bool	_reorderChildDirty
	children order dirty flag More...
var	_reorderChildDirty
	children order dirty flag More...
local	_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...
ComponentContainer *	_componentContainer
	Dictionary of components. More...
var	_componentContainer
	Dictionary of components. More...
local	_componentContainer
	Dictionary of components. 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 Ref
unsigned int	_referenceCount
	count of references More...

Friends
class	LabelTextFormatter

Additional Inherited Members
Public Attributes inherited from SpriteBatchNode
CC_CONSTRUCTOR_ACCESS	__pad0__: SpriteBatchNode()
Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS	__pad0__: Node()
Static Protected Attributes inherited from Node
static int	s_globalOrderOfArrival
var	s_globalOrderOfArrival
local	s_globalOrderOfArrival

Member Enumeration Documentation

enum LabelType

strongprotected

Enumerator
TTF
BMFONT
CHARMAP
STRING_TEXTURE

var LabelType

strongprotected

Enumerator
TTF
BMFONT
CHARMAP
STRING_TEXTURE

local LabelType

strongprotected

Enumerator
TTF
BMFONT
CHARMAP
STRING_TEXTURE

Constructor & Destructor Documentation

Label ( FontAtlas *  atlas = nullptr, TextHAlignment  hAlignment = TextHAlignment::LEFT, TextVAlignment  vAlignment = TextVAlignment::TOP, bool  useDistanceField = false, bool  useA8Shader = false  )

protected

virtual ~Label ( )

protectedvirtual

Member Function Documentation

virtual void addChild ( Node *  child, int  localZOrder = 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 setLocalZOrder(int)
tag	An integer to identify the node easily. Please refer to setTag(int)

Reimplemented from SpriteBatchNode.

var addChild ( var  child, var  localZOrder = 0, var  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 setLocalZOrder(int)
tag	An integer to identify the node easily. Please refer to setTag(int)

Reimplemented from SpriteBatchNode.

local addChild ( local  child, local  localZOrder = 0, local  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 setLocalZOrder(int)
tag	An integer to identify the node easily. Please refer to setTag(int)

Reimplemented from SpriteBatchNode.

virtual void alignText ( )

protectedvirtual

var alignText ( )

protectedvirtual

local alignText ( )

protectedvirtual

bool computeHorizontalKernings ( const std::u16string &  stringToRender )

protected

var computeHorizontalKernings ( var  stringToRender )

protected

local computeHorizontalKernings ( local  stringToRender )

protected

void computeStringNumLines ( )

protected

var computeStringNumLines ( )

protected

local computeStringNumLines ( )

protected

static Label* create ( )

static

var create ( )

static

local create ( )

static

static CC_DEPRECATED_ATTRIBUTE Label* create ( const std::string &  text, const std::string &  font, float  fontSize, const Size &  dimensions = Size::ZERO, TextHAlignment  hAlignment = TextHAlignment::LEFT, TextVAlignment  vAlignment = TextVAlignment::TOP  )

static

var create ( var  text, var  font, var  fontSize, var  dimensions = Size::ZERO, var  hAlignment = TextHAlignment::LEFT, var  vAlignment = TextVAlignment::TOP  )

static

local create ( local  text, local  font, local  fontSize, local  dimensions = Size::ZERO, local  hAlignment = TextHAlignment::LEFT, local  vAlignment = TextVAlignment::TOP  )

static

void createSpriteWithFontDefinition ( )

protected

var createSpriteWithFontDefinition ( )

protected

local createSpriteWithFontDefinition ( )

protected

static Label* createWithBMFont ( const std::string &  bmfontFilePath, const std::string &  text, const TextHAlignment &  alignment = TextHAlignment::LEFT, int  maxLineWidth = 0, const Vec2 &  imageOffset = Vec2::ZERO  )

static

var createWithBMFont ( var  bmfontFilePath, var  text, var  alignment = TextHAlignment::LEFT, var  maxLineWidth = 0, var  imageOffset = Vec2::ZERO  )

static

local createWithBMFont ( local  bmfontFilePath, local  text, local  alignment = TextHAlignment::LEFT, local  maxLineWidth = 0, local  imageOffset = Vec2::ZERO  )

static

static Label* createWithCharMap ( const std::string &  charMapFile, int  itemWidth, int  itemHeight, int  startCharMap  )

static

var createWithCharMap ( var  charMapFile, var  itemWidth, var  itemHeight, var  startCharMap  )

static

local createWithCharMap ( local  charMapFile, local  itemWidth, local  itemHeight, local  startCharMap  )

static

static Label* createWithCharMap ( Texture2D *  texture, int  itemWidth, int  itemHeight, int  startCharMap  )

static

var createWithCharMap ( var  texture, var  itemWidth, var  itemHeight, var  startCharMap  )

static

local createWithCharMap ( local  texture, local  itemWidth, local  itemHeight, local  startCharMap  )

static

static Label* createWithCharMap ( const std::string &  plistFile )

static

var createWithCharMap ( var  plistFile )

static

local createWithCharMap ( local  plistFile )

static

static Label* createWithSystemFont ( const std::string &  text, const std::string &  font, float  fontSize, const Size &  dimensions = Size::ZERO, TextHAlignment  hAlignment = TextHAlignment::LEFT, TextVAlignment  vAlignment = TextVAlignment::TOP  )

static

Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment.

Warning

It will generate texture by the platform-dependent code

var createWithSystemFont ( var  text, var  font, var  fontSize, var  dimensions = Size::ZERO, var  hAlignment = TextHAlignment::LEFT, var  vAlignment = TextVAlignment::TOP  )

static

Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment.

Warning

It will generate texture by the platform-dependent code

local createWithSystemFont ( local  text, local  font, local  fontSize, local  dimensions = Size::ZERO, local  hAlignment = TextHAlignment::LEFT, local  vAlignment = TextVAlignment::TOP  )

static

Creates a label with an initial string,font[font name or font file],font size, dimension in points, horizontal alignment and vertical alignment.

Warning

It will generate texture by the platform-dependent code

static Label* createWithTTF ( const std::string &  text, const std::string &  fontFile, float  fontSize, const Size &  dimensions = Size::ZERO, TextHAlignment  hAlignment = TextHAlignment::LEFT, TextVAlignment  vAlignment = TextVAlignment::TOP  )

static

Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment.

Warning

Not support font name.

var createWithTTF ( var  text, var  fontFile, var  fontSize, var  dimensions = Size::ZERO, var  hAlignment = TextHAlignment::LEFT, var  vAlignment = TextVAlignment::TOP  )

static

Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment.

Warning

Not support font name.

local createWithTTF ( local  text, local  fontFile, local  fontSize, local  dimensions = Size::ZERO, local  hAlignment = TextHAlignment::LEFT, local  vAlignment = TextVAlignment::TOP  )

static

Creates a label with an initial string,font file,font size, dimension in points, horizontal alignment and vertical alignment.

Warning

Not support font name.

static Label* createWithTTF ( const TTFConfig &  ttfConfig, const std::string &  text, TextHAlignment  alignment = TextHAlignment::LEFT, int  maxLineWidth = 0  )

static

Create a label with TTF configuration.

Warning

Not support font name.

var createWithTTF ( var  ttfConfig, var  text, var  alignment = TextHAlignment::LEFT, var  maxLineWidth = 0  )

static

Create a label with TTF configuration.

Warning

Not support font name.

local createWithTTF ( local  ttfConfig, local  text, local  alignment = TextHAlignment::LEFT, local  maxLineWidth = 0  )

static

Create a label with TTF configuration.

Warning

Not support font name.

virtual void disableEffect ( )

virtual

disable shadow/outline/glow rendering

var disableEffect ( )

virtual

disable shadow/outline/glow rendering

local disableEffect ( )

virtual

disable shadow/outline/glow rendering

virtual void draw ( Renderer *  renderer, const Mat4 &  transform, bool  transformUpdated  )

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.

var draw ( var  renderer, var  transform, var  transformUpdated  )

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.

local draw ( local  renderer, local  transform, local  transformUpdated  )

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.

void drawShadowWithoutBlur ( )

protected

var drawShadowWithoutBlur ( )

protected

local drawShadowWithoutBlur ( )

protected

void drawTextSprite ( Renderer *  renderer, bool  parentTransformUpdated  )

protected

var drawTextSprite ( var  renderer, var  parentTransformUpdated  )

protected

local drawTextSprite ( local  renderer, local  parentTransformUpdated  )

protected

virtual void enableGlow ( const Color4B &  glowColor )

virtual

only support for TTF

var enableGlow ( var  glowColor )

virtual

only support for TTF

local enableGlow ( local  glowColor )

virtual

only support for TTF

virtual void enableOutline ( const Color4B &  outlineColor, int  outlineSize = -1  )

virtual

only support for TTF

var enableOutline ( var  outlineColor, var  outlineSize = -1  )

virtual

only support for TTF

local enableOutline ( local  outlineColor, local  outlineSize = -1  )

virtual

only support for TTF

virtual void enableShadow ( const Color4B &  shadowColor = Color4B::BLACK, const Size &  offset = Size(2,-2), int  blurRadius = 0  )

virtual

Enable shadow for the label.

Todo:

support blur for shadow effect

var enableShadow ( var  shadowColor = Color4B::BLACK, var  offset = Size(2,-2), var  blurRadius = 0  )

virtual

Enable shadow for the label.

Todo:

support blur for shadow effect

local enableShadow ( local  shadowColor = Color4B::BLACK, local  offset = Size(2,-2), local  blurRadius = 0  )

virtual

Enable shadow for the label.

Todo:

support blur for shadow effect

const std::string& getBMFontFilePath ( ) const

inline

var getBMFontFilePath ( )

inline

local getBMFontFilePath ( )

inline

virtual Rect getBoundingBox ( ) const

overridevirtual

Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

Returns

An AABB (axis-aligned bounding-box) in its parent's coordinate system

Reimplemented from Node.

var getBoundingBox ( )

overridevirtual

Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

Returns

An AABB (axis-aligned bounding-box) in its parent's coordinate system

Reimplemented from Node.

local getBoundingBox ( )

overridevirtual

Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

Returns

An AABB (axis-aligned bounding-box) in its parent's coordinate system

Reimplemented from Node.

int getCommonLineHeight

(

)

const

var getCommonLineHeight

(

)

local getCommonLineHeight

(

)

virtual const Size& getContentSize ( ) const

overridevirtual

Returns the untransformed size of the node.

See also

setContentSize(const Size&)

Returns

The untransformed size of the node.

Reimplemented from Node.

var getContentSize ( )

overridevirtual

Returns the untransformed size of the node.

See also

setContentSize(const Size&)

Returns

The untransformed size of the node.

Reimplemented from Node.

local getContentSize ( )

overridevirtual

Returns the untransformed size of the node.

See also

setContentSize(const Size&)

Returns

The untransformed size of the node.

Reimplemented from Node.

virtual std::string getDescription ( ) const

overridevirtual

Gets the description string.

It makes debugging easier.

Returns

A string

Reimplemented from SpriteBatchNode.

var getDescription ( )

overridevirtual

Gets the description string.

It makes debugging easier.

Returns

A string

Reimplemented from SpriteBatchNode.

local getDescription ( )

overridevirtual

Gets the description string.

It makes debugging easier.

Returns

A string

Reimplemented from SpriteBatchNode.

const Size& getDimensions ( ) const

inline

var getDimensions ( )

inline

local getDimensions ( )

inline

FontAtlas* getFontAtlas ( )

inline

var getFontAtlas ( )

inline

local getFontAtlas ( )

inline

CC_DEPRECATED_ATTRIBUTE const FontDefinition& getFontDefinition ( ) const

inline

var getFontDefinition ( )

inline

local getFontDefinition ( )

inline

unsigned int getHeight ( ) const

inline

var getHeight ( )

inline

local getHeight ( )

inline

TextHAlignment getHorizontalAlignment ( ) const

inline

var getHorizontalAlignment ( )

inline

local getHorizontalAlignment ( )

inline

virtual Sprite* getLetter ( int  lettetIndex )

virtual

var getLetter ( var  lettetIndex )

virtual

local getLetter ( local  lettetIndex )

virtual

unsigned int getMaxLineWidth ( )

inline

var getMaxLineWidth ( )

inline

local getMaxLineWidth ( )

inline

virtual float getScaleX ( ) const

overridevirtual

Returns the scale factor on X axis of this node.

See also

setScaleX(float)

Returns

The scale factor on X axis.

Reimplemented from Node.

var getScaleX ( )

overridevirtual

Returns the scale factor on X axis of this node.

See also

setScaleX(float)

Returns

The scale factor on X axis.

Reimplemented from Node.

local getScaleX ( )

overridevirtual

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

overridevirtual

Returns the scale factor on Y axis of this node.

See also

setScaleY(float)

Returns

The scale factor on Y axis.

Reimplemented from Node.

var getScaleY ( )

overridevirtual

Returns the scale factor on Y axis of this node.

See also

setScaleY(float)

Returns

The scale factor on Y axis.

Reimplemented from Node.

local getScaleY ( )

overridevirtual

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.

Reimplemented in TextFieldTTF.

var getString ( )

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.

Reimplemented in TextFieldTTF.

local getString ( )

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.

Reimplemented in TextFieldTTF.

int getStringLength

(

)

const

var getStringLength

(

)

local getStringLength

(

)

int getStringNumLines ( ) const

inline

var getStringNumLines ( )

inline

local getStringNumLines ( )

inline

virtual const std::string& getSystemFontName ( ) const

inlinevirtual

var getSystemFontName ( )

inlinevirtual

local getSystemFontName ( )

inlinevirtual

virtual float getSystemFontSize ( ) const

inlinevirtual

var getSystemFontSize ( )

inlinevirtual

local getSystemFontSize ( )

inlinevirtual

TextHAlignment getTextAlignment ( ) const

inline

var getTextAlignment ( )

inline

local getTextAlignment ( )

inline

const Color4B& getTextColor ( ) const

inline

var getTextColor ( )

inline

local getTextColor ( )

inline

virtual const TTFConfig& getTTFConfig ( ) const

inlinevirtual

var getTTFConfig ( )

inlinevirtual

local getTTFConfig ( )

inlinevirtual

TextVAlignment getVerticalAlignment ( ) const

inline

var getVerticalAlignment ( )

inline

local getVerticalAlignment ( )

inline

unsigned int getWidth ( ) const

inline

var getWidth ( )

inline

local getWidth ( )

inline

bool isClipMarginEnabled ( ) const

inline

var isClipMarginEnabled ( )

inline

local isClipMarginEnabled ( )

inline

virtual bool isOpacityModifyRGB ( ) const

overridevirtual

Reimplemented from Node.

var isOpacityModifyRGB ( )

overridevirtual

Reimplemented from Node.

local isOpacityModifyRGB ( )

overridevirtual

Reimplemented from Node.

void onDraw ( const Mat4 &  transform, bool  transformUpdated  )

protected

var onDraw ( var  transform, var  transformUpdated  )

protected

local onDraw ( local  transform, local  transformUpdated  )

protected

bool recordLetterInfo ( const cocos2d::Vec2 &  point, const FontLetterDefinition &  letterDef, int  spriteIndex  )

protected

var recordLetterInfo ( var  point, var  letterDef, var  spriteIndex  )

protected

local recordLetterInfo ( local  point, local  letterDef, local  spriteIndex  )

protected

bool recordPlaceholderInfo ( int  spriteIndex )

protected

var recordPlaceholderInfo ( var  spriteIndex )

protected

local recordPlaceholderInfo ( local  spriteIndex )

protected

void reset ( )

protected

var reset ( )

protected

local reset ( )

protected

void setAlignment ( TextHAlignment  hAlignment )

inline

var setAlignment ( var  hAlignment )

inline

local setAlignment ( local  hAlignment )

inline

void setAlignment	(	TextHAlignment	hAlignment,
		TextVAlignment	vAlignment
	)

var setAlignment	(	var	hAlignment,
		var	vAlignment
	)

local setAlignment	(	local	hAlignment,
		local	vAlignment
	)

virtual void setBlendFunc ( const BlendFunc &  blendFunc )

overridevirtual

*When this function bound into js or lua,the parameter will be changed
*In js: var setBlendFunc(var src, var dst)

Reimplemented from SpriteBatchNode.

var setBlendFunc ( var  blendFunc )

overridevirtual

*When this function bound into js or lua,the parameter will be changed
*In js: var setBlendFunc(var src, var dst)

Reimplemented from SpriteBatchNode.

local setBlendFunc ( local  blendFunc )

overridevirtual

*When this function bound into js or lua,the parameter will be changed
*In js: var setBlendFunc(var src, var dst)

Reimplemented from SpriteBatchNode.

virtual bool setBMFontFilePath ( const std::string &  bmfontFilePath, const Vec2 &  imageOffset = Vec2::ZERO  )

virtual

var setBMFontFilePath ( var  bmfontFilePath, var  imageOffset = Vec2::ZERO  )

virtual

local setBMFontFilePath ( local  bmfontFilePath, local  imageOffset = Vec2::ZERO  )

virtual

virtual bool setCharMap ( const std::string &  charMapFile, int  itemWidth, int  itemHeight, int  startCharMap  )

virtual

var setCharMap ( var  charMapFile, var  itemWidth, var  itemHeight, var  startCharMap  )

virtual

local setCharMap ( local  charMapFile, local  itemWidth, local  itemHeight, local  startCharMap  )

virtual

virtual bool setCharMap ( Texture2D *  texture, int  itemWidth, int  itemHeight, int  startCharMap  )

virtual

var setCharMap ( var  texture, var  itemWidth, var  itemHeight, var  startCharMap  )

virtual

local setCharMap ( local  texture, local  itemWidth, local  itemHeight, local  startCharMap  )

virtual

virtual bool setCharMap ( const std::string &  plistFile )

virtual

var setCharMap ( var  plistFile )

virtual

local setCharMap ( local  plistFile )

virtual

void setClipMarginEnabled ( bool  clipEnabled )

inline

clip upper and lower margin for reduce height of label.

var setClipMarginEnabled ( var  clipEnabled )

inline

clip upper and lower margin for reduce height of label.

local setClipMarginEnabled ( local  clipEnabled )

inline

clip upper and lower margin for reduce height of label.

void setDimensions	(	unsigned int	width,
		unsigned int	height
	)

Sets the untransformed size of the label in a more efficient way.

var setDimensions	(	var	width,
		var	height
	)

Sets the untransformed size of the label in a more efficient way.

local setDimensions	(	local	width,
		local	height
	)

Sets the untransformed size of the label in a more efficient way.

virtual void setFontAtlas ( FontAtlas *  atlas, bool  distanceFieldEnabled = false, bool  useA8Shader = false  )

protectedvirtual

var setFontAtlas ( var  atlas, var  distanceFieldEnabled = false, var  useA8Shader = false  )

protectedvirtual

local setFontAtlas ( local  atlas, local  distanceFieldEnabled = false, local  useA8Shader = false  )

protectedvirtual

virtual CC_DEPRECATED_ATTRIBUTE void setFontDefinition ( const FontDefinition &  textDefinition )

virtual

var setFontDefinition ( var  textDefinition )

virtual

local setFontDefinition ( local  textDefinition )

virtual

void setFontScale ( float  fontScale )

protected

var setFontScale ( var  fontScale )

protected

local setFontScale ( local  fontScale )

protected

void setHeight ( unsigned int  height )

inline

Sets the untransformed size of the label.

The label's height be used for text align if the set value not equal zero. The text will display of incomplete when the size of label not enough to support display all text.

var setHeight ( var  height )

inline

Sets the untransformed size of the label.

The label's height be used for text align if the set value not equal zero. The text will display of incomplete when the size of label not enough to support display all text.

local setHeight ( local  height )

inline

Sets the untransformed size of the label.

The label's height be used for text align if the set value not equal zero. The text will display of incomplete when the size of label not enough to support display all text.

void setHorizontalAlignment ( TextHAlignment  hAlignment )

inline

var setHorizontalAlignment ( var  hAlignment )

inline

local setHorizontalAlignment ( local  hAlignment )

inline

void setLineBreakWithoutSpace

(

bool

breakWithoutSpace

)

var setLineBreakWithoutSpace

(

var

breakWithoutSpace

)

local setLineBreakWithoutSpace

(

local

breakWithoutSpace

)

void setMaxLineWidth

(

unsigned int

maxLineWidth

)

Sets the max line width of the label.

The label's max line width be used for force line breaks if the set value not equal zero. The label's width and max line width has not always to be equal.

var setMaxLineWidth

(

var

maxLineWidth

)

Sets the max line width of the label.

The label's max line width be used for force line breaks if the set value not equal zero. The label's width and max line width has not always to be equal.

local setMaxLineWidth

(

local

maxLineWidth

)

Sets the max line width of the label.

The label's max line width be used for force line breaks if the set value not equal zero. The label's width and max line width has not always to be equal.

virtual void setOpacityModifyRGB ( bool  isOpacityModifyRGB )

overridevirtual

Reimplemented from Node.

var setOpacityModifyRGB ( var  isOpacityModifyRGB )

overridevirtual

Reimplemented from Node.

local setOpacityModifyRGB ( local  isOpacityModifyRGB )

overridevirtual

Reimplemented from Node.

virtual void setScale ( float  scale )

overridevirtual

Sets the scale (x,y,z) of the node.

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters

scale

The scale factor for both X and Y axis.

Reimplemented from Node.

var setScale ( var  scale )

overridevirtual

Sets the scale (x,y,z) of the node.

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters

scale

The scale factor for both X and Y axis.

Reimplemented from Node.

local setScale ( local  scale )

overridevirtual

Sets the scale (x,y,z) of the node.

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters

scale

The scale factor for both X and Y axis.

Reimplemented from Node.

virtual void setScaleX ( float  scaleX )

overridevirtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters

scaleX

The scale factor on X axis.

Reimplemented from Node.

var setScaleX ( var  scaleX )

overridevirtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters

scaleX

The scale factor on X axis.

Reimplemented from Node.

local setScaleX ( local  scaleX )

overridevirtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters

scaleX

The scale factor on X axis.

Reimplemented from Node.

virtual void setScaleY ( float  scaleY )

overridevirtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters

scaleY

The scale factor on Y axis.

Reimplemented from Node.

var setScaleY ( var  scaleY )

overridevirtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters

scaleY

The scale factor on Y axis.

Reimplemented from Node.

local setScaleY ( local  scaleY )

overridevirtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters

scaleY

The scale factor on Y axis.

Reimplemented from Node.

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

overridevirtual

changes the string to render

Warning

It is as expensive as changing the string if you haven't set up TTF/BMFont/CharMap for the label.

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

var setString ( var  text )

overridevirtual

changes the string to render

Warning

It is as expensive as changing the string if you haven't set up TTF/BMFont/CharMap for the label.

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

local setString ( local  text )

overridevirtual

changes the string to render

Warning

It is as expensive as changing the string if you haven't set up TTF/BMFont/CharMap for the label.

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

virtual void setSystemFontName ( const std::string &  systemFont )

virtual

var setSystemFontName ( var  systemFont )

virtual

local setSystemFontName ( local  systemFont )

virtual

virtual void setSystemFontSize ( float  fontSize )

virtual

var setSystemFontSize ( var  fontSize )

virtual

local setSystemFontSize ( local  fontSize )

virtual

virtual void setTextColor ( const Color4B &  color )

virtual

Sets the text color.

Reimplemented in TextFieldTTF.

var setTextColor ( var  color )

virtual

Sets the text color.

Reimplemented in TextFieldTTF.

local setTextColor ( local  color )

virtual

Sets the text color.

Reimplemented in TextFieldTTF.

virtual bool setTTFConfig ( const TTFConfig &  ttfConfig )

virtual

set TTF configuration for Label

var setTTFConfig ( var  ttfConfig )

virtual

set TTF configuration for Label

local setTTFConfig ( local  ttfConfig )

virtual

set TTF configuration for Label

void setVerticalAlignment ( TextVAlignment  vAlignment )

inline

var setVerticalAlignment ( var  vAlignment )

inline

local setVerticalAlignment ( local  vAlignment )

inline

void setWidth ( unsigned int  width )

inline

Sets the untransformed size of the label.

The label's width be used for text align if the set value not equal zero. The label's max line width will be equal to the same value.

var setWidth ( var  width )

inline

Sets the untransformed size of the label.

The label's width be used for text align if the set value not equal zero. The label's max line width will be equal to the same value.

local setWidth ( local  width )

inline

Sets the untransformed size of the label.

The label's width be used for text align if the set value not equal zero. The label's max line width will be equal to the same value.

virtual void sortAllChildren ( )

overridevirtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note

Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented from SpriteBatchNode.

var sortAllChildren ( )

overridevirtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note

Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented from SpriteBatchNode.

local sortAllChildren ( )

overridevirtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This appraoch can improves the performance massively.

Note

Don't call this manually unless a child added needs to be removed in the same frame

Reimplemented from SpriteBatchNode.

virtual void updateColor ( )

overrideprotectedvirtual

Reimplemented from Node.

var updateColor ( )

overrideprotectedvirtual

Reimplemented from Node.

local updateColor ( )

overrideprotectedvirtual

Reimplemented from Node.

virtual void updateContent ( )

virtual

update content immediately.

var updateContent ( )

virtual

update content immediately.

local updateContent ( )

virtual

update content immediately.

virtual void updateDisplayedColor ( const Color3B &  parentColor )

overridevirtual

Reimplemented from Node.

var updateDisplayedColor ( var  parentColor )

overridevirtual

Reimplemented from Node.

local updateDisplayedColor ( local  parentColor )

overridevirtual

Reimplemented from Node.

virtual void updateDisplayedOpacity ( GLubyte  parentOpacity )

overridevirtual

Reimplemented from Node.

var updateDisplayedOpacity ( var  parentOpacity )

overridevirtual

Reimplemented from Node.

local updateDisplayedOpacity ( local  parentOpacity )

overridevirtual

Reimplemented from Node.

void updateFont ( )

protected

var updateFont ( )

protected

local updateFont ( )

protected

void updateQuads ( )

protected

var updateQuads ( )

protected

local updateQuads ( )

protected

virtual void updateShaderProgram ( )

protectedvirtual

var updateShaderProgram ( )

protectedvirtual

local updateShaderProgram ( )

protectedvirtual

virtual void visit ( Renderer *  renderer, const Mat4 &  parentTransform, bool  parentTransformUpdated  )

overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from SpriteBatchNode.

Reimplemented in TextFieldTTF.

var visit ( var  renderer, var  parentTransform, var  parentTransformUpdated  )

overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from SpriteBatchNode.

Reimplemented in TextFieldTTF.

local visit ( local  renderer, local  parentTransform, local  parentTransformUpdated  )

overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from SpriteBatchNode.

Reimplemented in TextFieldTTF.

Friends And Related Function Documentation

friend class LabelTextFormatter

friend

var LabelTextFormatter

friend

local LabelTextFormatter

friend

Member Data Documentation

std::vector<SpriteBatchNode*> _batchNodes

protected

var _batchNodes

protected

local _batchNodes

protected

bool _blendFuncDirty

protected

var _blendFuncDirty

protected

local _blendFuncDirty

protected

std::string _bmFontPath

protected

var _bmFontPath

protected

bool _clipEnabled

protected

var _clipEnabled

protected

local _clipEnabled

protected

float _commonLineHeight

protected

var _commonLineHeight

protected

local _commonLineHeight

protected

bool _compatibleMode

protected

var _compatibleMode

protected

local _compatibleMode

protected

bool _contentDirty

protected

var _contentDirty

protected

local _contentDirty

protected

LabelType _currentLabelType

protected

var _currentLabelType

protected

local _currentLabelType

protected

std::u16string _currentUTF16String

protected

var _currentUTF16String

protected

local _currentUTF16String

protected

LabelEffect _currLabelEffect

protected

var _currLabelEffect

protected

local _currLabelEffect

protected

int _currNumLines

protected

var _currNumLines

protected

local _currNumLines

protected

CustomCommand _customCommand

protected

var _customCommand

protected

local _customCommand

protected

Color4B _effectColor

protected

var _effectColor

protected

local _effectColor

protected

Color4F _effectColorF

protected

var _effectColorF

protected

local _effectColorF

protected

FontAtlas* _fontAtlas

protected

var _fontAtlas

protected

local _fontAtlas

protected

TTFConfig _fontConfig

protected

var _fontConfig

protected

local _fontConfig

protected

FontDefinition _fontDefinition

protected

var _fontDefinition

protected

local _fontDefinition

protected

float _fontScale

protected

var _fontScale

protected

local _fontScale

protected

TextHAlignment _hAlignment

protected

var _hAlignment

protected

local _hAlignment

protected

int* _horizontalKernings

protected

var _horizontalKernings

protected

local _horizontalKernings

protected

bool _insideBounds

protected

var _insideBounds

protected

local _insideBounds

protected

bool _isOpacityModifyRGB

protected

var _isOpacityModifyRGB

protected

local _isOpacityModifyRGB

protected

Size _labelDimensions

protected

var _labelDimensions

protected

local _labelDimensions

protected

unsigned int _labelHeight

protected

var _labelHeight

protected

local _labelHeight

protected

unsigned int _labelWidth

protected

var _labelWidth

protected

local _labelWidth

protected

std::vector<LetterInfo> _lettersInfo

protected

var _lettersInfo

protected

local _lettersInfo

protected

int _limitShowCount

protected

var _limitShowCount

protected

local _limitShowCount

protected

bool _lineBreakWithoutSpaces

protected

var _lineBreakWithoutSpaces

protected

local _lineBreakWithoutSpaces

protected

unsigned int _maxLineWidth

protected

var _maxLineWidth

protected

local _maxLineWidth

protected

std::string _originalUTF8String

protected

var _originalUTF8String

protected

local _originalUTF8String

protected

int _outlineSize

protected

var _outlineSize

protected

local _outlineSize

protected

Sprite* _reusedLetter

protected

used for optimization

var _reusedLetter

protected

used for optimization

local _reusedLetter

protected

used for optimization

Rect _reusedRect

protected

var _reusedRect

protected

local _reusedRect

protected

int _shadowBlurRadius

protected

var _shadowBlurRadius

protected

local _shadowBlurRadius

protected

Color3B _shadowColor

protected

var _shadowColor

protected

local _shadowColor

protected

bool _shadowDirty

protected

var _shadowDirty

protected

local _shadowDirty

protected

bool _shadowEnabled

protected

var _shadowEnabled

protected

local _shadowEnabled

protected

Sprite* _shadowNode

protected

var _shadowNode

protected

local _shadowNode

protected

Size _shadowOffset

protected

var _shadowOffset

protected

local _shadowOffset

protected

float _shadowOpacity

protected

var _shadowOpacity

protected

local _shadowOpacity

protected

Mat4 _shadowTransform

protected

var _shadowTransform

protected

local _shadowTransform

protected

std::string _systemFont

protected

var _systemFont

protected

local _systemFont

protected

bool _systemFontDirty

protected

var _systemFontDirty

protected

local _systemFontDirty

protected

float _systemFontSize

protected

var _systemFontSize

protected

local _systemFontSize

protected

Color4B _textColor

protected

var _textColor

protected

local _textColor

protected

Color4F _textColorF

protected

var _textColorF

protected

local _textColorF

protected

Sprite* _textSprite

protected

var _textSprite

protected

local _textSprite

protected

GLuint _uniformEffectColor

protected

var _uniformEffectColor

protected

local _uniformEffectColor

protected

GLuint _uniformTextColor

protected

var _uniformTextColor

protected

local _uniformTextColor

protected

bool _useA8Shader

protected

var _useA8Shader

protected

local _useA8Shader

protected

bool _useDistanceField

protected

var _useDistanceField

protected

local _useDistanceField

protected

TextVAlignment _vAlignment

protected

var _vAlignment

protected

local _vAlignment

protected

const int DistanceFieldFontSize

static

var DistanceFieldFontSize

static

local DistanceFieldFontSize

static

---

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

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