Label is a subclass of SpriteBatchNode that knows how to render text labels. More...

Inherits SpriteBatchNode, and LabelProtocol.

Public Member Functions
virtual void	setString (const std::string &text) override
	Sets the text that this Label is to display. More...

local	setString ( local text)
	Sets the text that this Label is to display. More...

virtual const std::string &	getString () const override
	Return the text the Label is displaying. More...

local	getString ()
	Return the text the Label is displaying. More...

virtual void	setTextColor (const Color4B &color)
	Sets the text color of Label. More...

local	setTextColor ( local color)
	Sets the text color of Label. More...

const Color4B &	getTextColor () const
	Returns the text color of the Label. More...

local	getTextColor ()
	Returns the text color of the Label. More...

virtual void	enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Size &offset=Size(2,-2), int blurRadius=0)
	Enable shadow effect to Label. More...

virtual void	enableOutline (const Color4B &outlineColor, int outlineSize=-1)
	Enable outline effect to Label. More...

local	enableOutline ( local outlineColor, local 1)
	Enable outline effect to Label. More...

virtual void	enableGlow (const Color4B &glowColor)
	Enable glow effect to Label. More...

local	enableGlow ( local glowColor)
	Enable glow effect to Label. More...

virtual void	disableEffect ()
	Disable all effect to Label. More...

virtual void	disableEffect (LabelEffect effect)
	Disable effect to Label. More...

local	disableEffect ( local effect)
	Disable effect to Label. More...

void	setAlignment (TextHAlignment hAlignment)
	Sets the Label's text horizontal alignment. More...

local	setAlignment ( local hAlignment)
	Sets the Label's text horizontal alignment. More...

TextHAlignment	getTextAlignment () const
	Returns the Label's text horizontal alignment. More...

local	getTextAlignment ()
	Returns the Label's text horizontal alignment. More...

void	setAlignment (TextHAlignment hAlignment, TextVAlignment vAlignment)
	Sets the Label's text alignment. More...

local	setAlignment ( local hAlignment, local vAlignment)
	Sets the Label's text alignment. More...

void	setHorizontalAlignment (TextHAlignment hAlignment)
	Sets the Label's text horizontal alignment. More...

local	setHorizontalAlignment ( local hAlignment)
	Sets the Label's text horizontal alignment. More...

TextHAlignment	getHorizontalAlignment () const
	Returns the Label's text horizontal alignment. More...

local	getHorizontalAlignment ()
	Returns the Label's text horizontal alignment. More...

void	setVerticalAlignment (TextVAlignment vAlignment)
	Sets the Label's text vertical alignment. More...

local	setVerticalAlignment ( local vAlignment)
	Sets the Label's text vertical alignment. More...

TextVAlignment	getVerticalAlignment () const
	Returns the Label's text vertical alignment. More...

local	getVerticalAlignment ()
	Returns the Label's text vertical alignment. More...

void	setLineBreakWithoutSpace (bool breakWithoutSpace)
	Specify what happens when a line is too long for Label. More...

void	setMaxLineWidth (float maxLineWidth)
	Makes the Label at most this line untransformed width. More...

void	setWidth (float width)
	Makes the Label exactly this untransformed width. More...

local	setWidth ( local width)
	Makes the Label exactly this untransformed width. More...

void	setHeight (float height)
	Makes the Label exactly this untransformed height. More...

void	setDimensions (float width, float height)
	Sets the untransformed size of the Label in a more efficient way. More...

virtual void	updateContent ()
	Update content immediately. More...

virtual Sprite *	getLetter (int lettetIndex)
	Provides a way to treats each character like a Sprite. More...

local	getLetter ( local lettetIndex)
	Provides a way to treats each character like a Sprite. More...

void	setClipMarginEnabled (bool clipEnabled)
	Makes the Label to clip upper and lower margin for reduce height of Label. More...

local	setClipMarginEnabled ( local clipEnabled)
	Makes the Label to clip upper and lower margin for reduce height of Label. More...

void	setLineHeight (float height)
	Sets the line height of the Label. More...

float	getLineHeight () const
	Returns the line height of this Label. More...

void	setAdditionalKerning (float space)
	Sets the additional kerning of the Label. More...

local	setAdditionalKerning ( local space)
	Sets the additional kerning of the Label. More...

float	getAdditionalKerning () const
	Returns the additional kerning of the Label. More...

local	getAdditionalKerning ()
	Returns the additional kerning of the Label. More...

virtual void	setBlendFunc (const BlendFunc &blendFunc) override
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...

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

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

virtual void	sortAllChildren () override
	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, uint32_t parentFlags) override
	Visits this node's children and draw them recursively. More...

virtual void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) override
	Override this method to draw your own node. More...

local	draw ( local renderer, local transform, local flags)
	Override this method to draw your own node. More...

int	getCommonLineHeight () const
local	getCommonLineHeight ()
Font methods
virtual bool	setTTFConfig (const TTFConfig &ttfConfig)
	Sets a new TTF configuration to Label. More...

virtual const TTFConfig &	getTTFConfig () const
	Returns the TTF configuration object used by the Label. More...

virtual bool	setBMFontFilePath (const std::string &bmfontFilePath, const Vec2 &imageOffset=Vec2::ZERO)
	Sets a new bitmap font to Label.

const std::string &	getBMFontFilePath () const
	Returns the bitmap font used by the Label. More...

local	getBMFontFilePath ()
	Returns the bitmap font used by the Label. More...

virtual bool	setCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
	Sets a new char map configuration to Label. More...

virtual bool	setCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
	Sets a new char map configuration to Label. More...

local	setCharMap ( local texture, local itemWidth, local itemHeight, local startCharMap)
	Sets a new char map configuration to Label. More...

virtual bool	setCharMap (const std::string &plistFile)
	Sets a new char map configuration to Label. More...

virtual void	setSystemFontName (const std::string &font)
	Sets a new system font to Label. More...

local	setSystemFontName ( local font)
	Sets a new system font to Label. More...

virtual const std::string &	getSystemFontName () const
	Returns the system font used by the Label. More...

local	getSystemFontName ()
	Returns the system font used by the Label. More...

virtual void	setSystemFontSize (float fontSize)
local	setSystemFontSize ( local fontSize)
virtual float	getSystemFontSize () const
	Returns the bitmap font path used by the Label. More...

local	getSystemFontSize ()
	Returns the bitmap font path used by the Label. More...

virtual void	requestSystemFontRefresh ()
local	requestSystemFontRefresh ()
Public Member Functions inherited from SpriteBatchNode
TextureAtlas *	getTextureAtlas ()
	Returns the TextureAtlas object. More...

var	getTextureAtlas ()
	Returns the TextureAtlas object. More...

local	getTextureAtlas ()
	Returns the TextureAtlas object. More...

void	setTextureAtlas (TextureAtlas *textureAtlas)
	Sets the TextureAtlas object. More...

const std::vector< Sprite * > &	getDescendants () const
	Returns an array with the descendants (children, gran children, etc.). More...

void	increaseAtlasCapacity ()
	Increase the Atlas Capacity. More...

void	removeChildAtIndex (ssize_t index, bool doCleanup)
	Removes a child given a certain index. More...

void	appendChild (Sprite *sprite)
	Append the child. More...

void	removeSpriteFromAtlas (Sprite *sprite)
	Remove a sprite from Atlas. More...

local	removeSpriteFromAtlas ( local sprite)
	Remove a sprite from Atlas. More...

ssize_t	rebuildIndexInOrder (Sprite *parent, ssize_t index)
	Rebuild index with a sprite all child. More...

var	rebuildIndexInOrder ( var parent, var index)
	Rebuild index with a sprite all child. More...

local	rebuildIndexInOrder ( local parent, local index)
	Rebuild index with a sprite all child. More...

ssize_t	highestAtlasIndexInChild (Sprite *sprite)
	Get the Max image block index,in all child. More...

ssize_t	lowestAtlasIndexInChild (Sprite *sprite)
	Get the Min image block index,in all child. More...

local	lowestAtlasIndexInChild ( local sprite)
	Get the Min image block index,in all child. More...

ssize_t	atlasIndexForChild (Sprite *sprite, int z)
	Get the nearest index from the sprite in z. More...

var	atlasIndexForChild ( var sprite, var z)
	Get the nearest index from the sprite in z. More...

local	atlasIndexForChild ( local sprite, local z)
	Get the nearest index from the sprite in z. More...

virtual void	addChild (Node *child, int zOrder, const std::string &name) override
	Adds a child to the container with z order and tag. More...

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

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

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

local	reorderChild ( local child, local zOrder)
	Reorders a child according to a new z value. More...

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

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

Public Member Functions inherited from Node
virtual bool	isRunning () const
	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.

virtual Scene *	getScene () const
	Returns the Scene that contains the Node. More...

local	getScene ()
	Returns the Scene that contains the Node. More...

virtual Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
	Set event dispatcher for scene. More...

local	setEventDispatcher ( local dispatcher)
	Set event dispatcher for scene. More...

virtual EventDispatcher *	getEventDispatcher () const
	Get the event dispatcher of scene. More...

local	getEventDispatcher ()
	Get the event dispatcher of scene. More...

void	setPhysicsBody (PhysicsBody *body)
	Set the PhysicsBody that let the sprite effect with physics. More...

PhysicsBody *	getPhysicsBody () const
	Get the PhysicsBody the sprite have. More...

var	getPhysicsBody ()
	Get the PhysicsBody the sprite have. More...

local	getPhysicsBody ()
	Get the PhysicsBody the sprite have. More...

void	removeFromPhysicsWorld ()
	Remove this node from physics world. More...

var	removeFromPhysicsWorld ()
	Remove this node from physics world. More...

local	removeFromPhysicsWorld ()
	Remove this node from physics world. More...

void	updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
	Update the transform matrix from physics.

var	updateTransformFromPhysics ( var parentTransform, var parentFlags)
	Update the transform matrix from physics.

local	updateTransformFromPhysics ( local parentTransform, local parentFlags)
	Update the transform matrix from physics.

virtual void	updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
	Update physics body transform matrix.

var	updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
	Update physics body transform matrix.

local	updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
	Update physics body transform matrix.

unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true

virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...

virtual void	setZOrder (int 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...

var	getLocalZOrder ()
	Gets the local Z order of this node. More...

local	getLocalZOrder ()
	Gets the local Z order of this node. More...

virtual int	getZOrder () const
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...

var	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...

local	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...

virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...

var	setScaleZ ( var 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...

local	setPosition ( local position)
	Sets the position (x,y) of the node in its parent's coordinate system. More...

virtual void	setNormalizedPosition (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...

var	setNormalizedPosition ( var position)
	Sets the position (x,y) using values between 0 and 1. More...

local	setNormalizedPosition ( local position)
	Sets the position (x,y) using values between 0 and 1. More...

virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...

virtual const Vec2 &	getNormalizedPosition () const
	Returns the normalized position. More...

local	getNormalizedPosition ()
	Returns the normalized position. More...

virtual void	setPosition (float x, float y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...

var	setPosition ( var x, var 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...

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

virtual float	getPositionX (void) const
	Gets the x coordinate of the node in its parent's coordinate system. More...

virtual void	setPositionY (float y)
	Sets the y coordinate of the node in its parent's coordinate system. More...

virtual float	getPositionY (void) const
	Gets the y coordinate of the node in its parent's coordinate system. More...

virtual void	setPosition3D (const Vec3 &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...

var	setVertexZ ( var positionZ)
	Sets the 'z' coordinate in the position. More...

local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. More...

virtual void	setVertexZ (float vertexZ)
var	setVertexZ ( var vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...

var	getVertexZ ()
	Gets position Z coordinate of this node. More...

local	getPositionZ ()
	Gets position Z coordinate of this node. More...

virtual float	getVertexZ () const
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...

var	getSkewX ()
	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...

var	setSkewY ( var 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...

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

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

local	getAnchorPoint ()
	Returns the anchor point in percent. More...

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

local	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...

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

var	setContentSize ( var 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...

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

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

virtual void	setRotationQuat (const Quaternion &quat)
	Set rotation by quaternion. More...

local	setRotationQuat ( local quat)
	Set rotation by quaternion. More...

virtual Quaternion	getRotationQuat () const
	Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. 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 void	setRotationX (float rotationX)
var	setRotationX ( var 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...

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

local	getRotationSkewX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual float	getRotationX () const
var	getRotationX ()
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 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...

local	getRotationSkewY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY () const
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...

void	setGLServerState (int serverState)
var	setGLServerState ( var serverState)
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) const
	Gets a child from the container with its tag. More...

var	getChildByTag ( var tag)
	Gets a child from the container with its tag. More...

local	getChildByTag ( local tag)
	Gets a child from the container with its tag. More...

virtual Node *	getChildByName (const std::string &name) const
	Gets a child from the container with its name. More...

local	getChildByName ( local name)
	Gets a child from the container with its name. More...

template<typename T >
T	getChildByName (const std::string &name) const
	Gets a child from the container with its name that can be cast to Type T. More...

virtual void	enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
	Search the children of the receiving node to perform processing for nodes which share a name. 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...

var	getChildrenCount ()
	Returns the amount of children. More...

local	getChildrenCount ()
	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	removeChildByName (const std::string &name, bool cleanup=true)
	Removes a child from the container by tag value. More...

var	removeChildByName ( var name, var true)
	Removes a child from the container by tag value. More...

local	removeChildByName ( local name, 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...

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 std::string	getName () const
	Returns a string that is used to identify the node. More...

local	getName ()
	Returns a string that is used to identify the node. More...

virtual void	setName (const std::string &name)
	Changes the name that is used to identify the node easily. More...

var	setName ( var name)
	Changes the name that is used to identify the node easily. More...

local	setName ( local name)
	Changes the name 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 () const
	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...

GLProgram *	getShaderProgram () const
var	getShaderProgram ()
local	getShaderProgram ()
virtual void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...

var	setGLProgram ( var glprogram)
	Sets the shader program for this node. More...

local	setGLProgram ( local glprogram)
	Sets the shader program for this node. More...

void	setShaderProgram (GLProgram *glprogram)
var	setShaderProgram ( var glprogram)
local	setShaderProgram ( local glprogram)
GLProgramState *	getGLProgramState () const
	Return the GLProgramState currently used for this node. More...

var	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...

local	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...

virtual void	setGLProgramState (GLProgramState *glProgramState)
	Set the GLProgramState for this node. More...

var	setGLProgramState ( var glProgramState)
	Set the GLProgramState for this node. More...

local	setGLProgramState ( local glProgramState)
	Set the GLProgramState for this node. More...

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

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

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

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

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

var	setActionManager ( var 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
virtual Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed. More...

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

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

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

var	stopAction ( var action)
	Stops and removes an action from the running action list. More...

local	stopAction ( local action)
	Stops and removes an action from the running action list. More...

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

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

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

void	stopAllActionsByTag (int tag)
	Removes all actions from the running action list by its tag. More...

var	stopAllActionsByTag ( var tag)
	Removes all actions from the running action list by its tag. More...

local	stopAllActionsByTag ( local tag)
	Removes all actions 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...

ssize_t	numberOfRunningActions () const
var	numberOfRunningActions ()
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...

local	getScheduler ()
	Gets a Sheduler object. More...

virtual const Scheduler *	getScheduler () const
bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

bool	isScheduled (const std::string &key)
	Checks whether a lambda function is scheduled. More...

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

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

var	scheduleUpdateWithPriority ( var 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...

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

void	scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
	Schedules a lambda function 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	schedule (const std::function< void(float)> &callback, const std::string &key)
	Schedules a lambda function. More...

void	schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
	Schedules a lambda function. More...

void	schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
	Schedules a lambda function. More...

var	schedule ( var callback, var interval, var repeat, var delay, var key)
	Schedules a lambda function. More...

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

var	unschedule ( var selector)
	Unschedules a custom selector. More...

void	unschedule (const std::string &key)
	Unschedules a lambda function. More...

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

void	unscheduleAllSelectors ()
var	unscheduleAllSelectors ()
local	unscheduleAllSelectors ()
virtual void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...

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

virtual void	pause (void)
	Pauses all scheduled selectors, actions and event listeners. More...

local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...

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

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

var	pauseSchedulerAndActions ()
	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)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

var	update ( var delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

local	update ( local delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

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

var	updateTransform ()
	Calls children's updateTransform() method recursively. More...

local	updateTransform ()
	Calls children's updateTransform() method recursively. More...

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

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

var	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

local	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual AffineTransform	getParentToNodeAffineTransform () const
local	getParentToNodeAffineTransform ()
virtual AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...

virtual AffineTransform	getNodeToWorldAffineTransform () const
local	getNodeToWorldAffineTransform ()
virtual AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...

var	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...

var	convertToNodeSpace ( var worldPoint)
	Converts a Vec2 to node (local) space coordinates. More...

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

void	setAdditionalTransform (Mat4 *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 &name)
	Gets a component by its name. More...

var	getComponent ( var name)
	Gets a component by its name. More...

local	getComponent ( local name)
	Gets a component by its name. More...

virtual bool	addComponent (Component *component)
	Adds a component. More...

virtual bool	removeComponent (const std::string &name)
	Removes a component by its name. More...

virtual bool	removeComponent (Component *component)
	Removes a component by its pointer. More...

virtual void	removeAllComponents ()
	Removes all components.

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 ()
	Destructor. More...

Static Public Member Functions
Creators
static Label *	create ()
	Allocates and initializes a Label, with default settings. More...

local	create ()
	Allocates and initializes a Label, with default settings. More...

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)
	Allocates and initializes a Label, base on platform-dependent API. More...

local	createWithSystemFont ( local text, local font, local fontSize, local ZERO, local LEFT, local TOP)
	Allocates and initializes a Label, base on platform-dependent API. More...

static Label *	createWithTTF (const std::string &text, const std::string &fontFilePath, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
	Allocates and initializes a Label, base on FreeType2. More...

local	createWithTTF ( local text, local fontFilePath, local fontSize, local ZERO, local LEFT, local TOP)
	Allocates and initializes a Label, base on FreeType2. More...

static Label *	createWithTTF (const TTFConfig &ttfConfig, const std::string &text, TextHAlignment hAlignment=TextHAlignment::LEFT, int maxLineWidth=0)
	Allocates and initializes a Label, base on FreeType2. More...

local	createWithTTF ( local ttfConfig, local text, local LEFT, local 0)
	Allocates and initializes a Label, base on FreeType2. More...

static Label *	createWithBMFont (const std::string &bmfontPath, const std::string &text, const TextHAlignment &hAlignment=TextHAlignment::LEFT, int maxLineWidth=0, const Vec2 &imageOffset=Vec2::ZERO)
	Allocates and initializes a Label, with a bitmap font file. More...

local	createWithBMFont ( local bmfontPath, local text, local LEFT, local 0, local ZERO)
	Allocates and initializes a Label, with a bitmap font file. More...

static Label *	createWithCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
	Allocates and initializes a Label, with char map configuration. More...

static Label *	createWithCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
	Allocates and initializes a Label, with char map configuration. More...

static Label *	createWithCharMap (const std::string &plistFile)
	Allocates and initializes a Label, with char map configuration. More...

Static Public Member Functions inherited from SpriteBatchNode
static SpriteBatchNode *	createWithTexture (Texture2D *tex, ssize_t capacity=DEFAULT_CAPACITY)
	Creates a SpriteBatchNode with a texture2d and capacity of children. More...

local	createWithTexture ( local tex, local DEFAULT_CAPACITY)
	Creates a SpriteBatchNode with a texture2d and capacity of children. More...

static SpriteBatchNode *	create (const std::string &fileImage, ssize_t capacity=DEFAULT_CAPACITY)
	Creates a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...

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

Static Public Member Functions inherited from Node
static Node *	create ()
	Allocates and initializes a node. More...

var	create ()
	Allocates and initializes a node. More...

local	create ()
	Allocates and initializes a node. More...

Protected Member Functions
	Label (FontAtlas *atlas=nullptr, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP, bool useDistanceField=false, bool useA8Shader=false)
	Constructor of Label.

	Label ( local nullptr, local LEFT, local TOP, local false, local false)
	Constructor of Label.

virtual	~Label ()
	Destructor of Label.

Protected Member Functions inherited from SpriteBatchNode
bool	initWithTexture (Texture2D *tex, ssize_t capacity=DEFAULT_CAPACITY)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...

var	initWithTexture ( var tex, var DEFAULT_CAPACITY)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...

local	initWithTexture ( local tex, local DEFAULT_CAPACITY)
	initializes a SpriteBatchNode with a texture2d and capacity of children. More...

bool	initWithFile (const std::string &fileImage, ssize_t capacity=DEFAULT_CAPACITY)
	initializes a SpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and a capacity of children. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes.

var	INVALID_TAG = -1
	Default tag used for all the nodes.

local	INVALID_TAG = -1
	Default tag used for all the nodes.

Detailed Description

Label is a subclass of SpriteBatchNode that knows how to render text labels.

Label can be created with:

A true type font file.
A bitmap font file.
A char map file.
The built in system font.

Bitmap Font supported editors:

http://glyphdesigner.71squared.com/ (Commercial, Mac OS X)
http://www.n4te.com/hiero/hiero.jnlp (Free, Java)
http://slick.cokeandcode.com/demos/hiero.jnlp (Free, Java)
http://www.angelcode.com/products/bmfont/ (Free, Windows only)

Member Function Documentation

static Label* create ( )

static

Allocates and initializes a Label, with default settings.

Returns: An automatically released Label object.

local create ( )

static

Allocates and initializes a Label, with default settings.

Returns: An automatically released Label object.

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

Allocates and initializes a Label, base on platform-dependent API.

Parameters

text	The initial text.
font	A font file or a font family name.
fontSize	The font size. This value must be > 0.
dimensions
hAlignment	The text horizontal alignment.
vAlignment	The text vertical alignment.

Warning: It will generate texture by the platform-dependent code.

Returns: An automatically released Label object.

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

static

Allocates and initializes a Label, base on platform-dependent API.

Parameters

text	The initial text.
font	A font file or a font family name.
fontSize	The font size. This value must be > 0.
dimensions
hAlignment	The text horizontal alignment.
vAlignment	The text vertical alignment.

Warning: It will generate texture by the platform-dependent code.

Returns: An automatically released Label object.

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

static

Allocates and initializes a Label, base on FreeType2.

Parameters

text	The initial text.
fontFilePath	A font file.
fontSize	The font size. This value must be > 0.
dimensions
hAlignment	The text horizontal alignment.
vAlignment	The text vertical alignment.

Returns: An automatically released Label object.

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

static

Allocates and initializes a Label, base on FreeType2.

Parameters

text	The initial text.
fontFilePath	A font file.
fontSize	The font size. This value must be > 0.
dimensions
hAlignment	The text horizontal alignment.
vAlignment	The text vertical alignment.

Returns: An automatically released Label object.

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

static

Allocates and initializes a Label, base on FreeType2.

Parameters

ttfConfig	A pointer to a TTFConfig object.
text	The initial text.
hAlignment	The text horizontal alignment.
maxLineWidth	The max line width.

Returns: An automatically released Label object.

See also: TTFConfig setTTFConfig setMaxLineWidth

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

static

Allocates and initializes a Label, base on FreeType2.

Parameters

ttfConfig	A pointer to a TTFConfig object.
text	The initial text.
hAlignment	The text horizontal alignment.
maxLineWidth	The max line width.

Returns: An automatically released Label object.

See also: TTFConfig setTTFConfig setMaxLineWidth

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

static

Allocates and initializes a Label, with a bitmap font file.

Parameters

bmfontPath	A bitmap font file, it's a FNT format.
text	The initial text.
hAlignment	Text horizontal alignment.
maxLineWidth	The max line width.
imageOffset

Returns: An automatically released Label object.

See also: setBMFontFilePath setMaxLineWidth

local createWithBMFont	(	local	bmfontPath,
		local	text,
		local	hAlignment = `TextHAlignment::LEFT`,
		local	maxLineWidth = `0`,
		local	imageOffset = `Vec2::ZERO`
	)

static

Allocates and initializes a Label, with a bitmap font file.

Parameters

bmfontPath	A bitmap font file, it's a FNT format.
text	The initial text.
hAlignment	Text horizontal alignment.
maxLineWidth	The max line width.
imageOffset

Returns: An automatically released Label object.

See also: setBMFontFilePath setMaxLineWidth

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

static