cocos2d-x  2.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CCLabelTTF Class Reference

CCLabelTTF is a subclass of CCTextureNode that knows how to render text labels. More...

#include <CCLabelTTF.h>

Inheritance diagram for CCLabelTTF:
CCSprite CCLabelProtocol CCNodeRGBA CCTextureProtocol CCNode CCRGBAProtocol CCBlendProtocol CCObject CCCopying CCTextFieldTTF UICCTextField

Public Member Functions

 CCLabelTTF ()
virtual ~CCLabelTTF ()
const char * description ()
bool initWithString (const char *string, const char *fontName, float fontSize)
 initializes the CCLabelTTF with a font name and font size More...
 
bool initWithString (const char *string, const char *fontName, float fontSize, const CCSize &dimensions, CCTextAlignment hAlignment)
 initializes the CCLabelTTF with a font name, alignment, dimension and font size More...
 
bool initWithString (const char *string, const char *fontName, float fontSize, const CCSize &dimensions, CCTextAlignment hAlignment, CCVerticalTextAlignment vAlignment)
 initializes the CCLabelTTF with a font name, alignment, dimension and font size More...
 
local initWithString ( local string, local fontName, local fontSize, local dimensions, local hAlignment, local vAlignment)
 initializes the CCLabelTTF with a font name, alignment, dimension and font size More...
 
bool initWithStringAndTextDefinition (const char *string, ccFontDefinition &textDefinition)
 initializes the CCLabelTTF with a font name, alignment, dimension and font size More...
 
void setTextDefinition (ccFontDefinition *theDefinition)
 set the text definition used by this label More...
 
ccFontDefinitiongetTextDefinition ()
 get the text definition used by this label More...
 
void enableShadow (const CCSize &shadowOffset, float shadowOpacity, float shadowBlur, bool mustUpdateTexture=true)
 enable or disable shadow for the label More...
 
local enableShadow ( local shadowOffset, local shadowOpacity, local shadowBlur, local true)
 enable or disable shadow for the label More...
 
void disableShadow (bool mustUpdateTexture=true)
 disable shadow rendering More...
 
void enableStroke (const ccColor3B &strokeColor, float strokeSize, bool mustUpdateTexture=true)
 enable or disable stroke More...
 
local enableStroke ( local strokeColor, local strokeSize, local true)
 enable or disable stroke More...
 
void disableStroke (bool mustUpdateTexture=true)
 disable stroke More...
 
void setFontFillColor (const ccColor3B &tintColor, bool mustUpdateTexture=true)
 set text tinting More...
 
var setFontFillColor ( var tintColor, var true)
 set text tinting More...
 
local setFontFillColor ( local tintColor, local true)
 set text tinting More...
 
bool init ()
 initializes the CCLabelTTF More...
 
virtual void setString (const char *label)
 changes the string to render More...
 
virtual const char * getString (void)
 Returns the string that is currently being used in this label. More...
 
CCTextAlignment getHorizontalAlignment ()
local getHorizontalAlignment ()
void setHorizontalAlignment (CCTextAlignment alignment)
local setHorizontalAlignment ( local alignment)
CCVerticalTextAlignment getVerticalAlignment ()
var getVerticalAlignment ()
local getVerticalAlignment ()
void setVerticalAlignment (CCVerticalTextAlignment verticalAlignment)
CCSize getDimensions ()
void setDimensions (const CCSize &dim)
local setDimensions ( local dim)
float getFontSize ()
void setFontSize (float fontSize)
local setFontSize ( local fontSize)
const char * getFontName ()
void setFontName (const char *fontName)
local setFontName ( local fontName)
- Public Member Functions inherited from CCSprite
 CCSprite (void)
 Default constructor. More...
 
virtual ~CCSprite (void)
 Default destructor. More...
 
virtual bool initWithTexture (CCTexture2D *pTexture)
 Initializes a sprite with a texture. More...
 
local initWithTexture ( local pTexture)
 Initializes a sprite with a texture. More...
 
virtual bool initWithTexture (CCTexture2D *pTexture, const CCRect &rect)
 Initializes a sprite with a texture and a rect. More...
 
virtual bool initWithTexture (CCTexture2D *pTexture, const CCRect &rect, bool rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
local initWithTexture ( local pTexture, local rect, local rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
virtual bool initWithSpriteFrame (CCSpriteFrame *pSpriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 
local initWithSpriteFrame ( local pSpriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 
virtual bool initWithSpriteFrameName (const char *pszSpriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
var initWithSpriteFrameName ( var pszSpriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
local initWithSpriteFrameName ( local pszSpriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
virtual bool initWithFile (const char *pszFilename)
 Initializes a sprite with an image filename. More...
 
local initWithFile ( local pszFilename)
 Initializes a sprite with an image filename. More...
 
virtual bool initWithFile (const char *pszFilename, const CCRect &rect)
 Initializes a sprite with an image filename, and a rect. More...
 
var init ( var pszFilename, var rect)
 Initializes a sprite with an image filename, and a rect. More...
 
local initWithFile ( local pszFilename, local rect)
 Initializes a sprite with an image filename, and a rect. More...
 
virtual void setTexture (CCTexture2D *texture)
 Sets a new texuture. More...
 
virtual CCTexture2DgetTexture (void)
 Returns the currently used texture. More...
 
void setBlendFunc (ccBlendFunc blendFunc)
 Sets the source blending function. More...
 
ccBlendFunc getBlendFunc (void)
 Returns the blending function that is currently being used. More...
 
local getBlendFunc ()
 Returns the blending function that is currently being used. More...
 
virtual void setScaleX (float fScaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual void setScaleY (float fScaleY)
 Changes the scale factor on Y axis of this node. More...
 
local setScaleY ( local fScaleY)
 Changes the scale factor on Y axis of this node. More...
 
virtual void setPosition (const CCPoint &pos)
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setRotation (float fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
var setRotation ( var fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual void setRotationX (float fRotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationX ( local fRotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationY (float fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setSkewX (float sx)
 Changes the X skew angle of the node in degrees. More...
 
var setSkewX ( var sx)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local sx)
 Changes the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float sy)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local sy)
 Changes the Y skew angle of the node in degrees. More...
 
virtual void removeChild (CCNode *pChild, bool bCleanup)
 Removes a child from the container. More...
 
local removeChild ( local pChild, local bCleanup)
 Removes a child from the container. More...
 
virtual void removeAllChildrenWithCleanup (bool bCleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildrenWithCleanup ( local bCleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (CCNode *pChild, int zOrder)
 Reorders a child according to a new z value. More...
 
var reorderChild ( var pChild, var zOrder)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local pChild, local zOrder)
 Reorders a child according to a new z value. More...
 
virtual void addChild (CCNode *pChild)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (CCNode *pChild, int zOrder)
 Adds a child to the container with a z-order. More...
 
local addChild ( local pChild, local zOrder)
 Adds a child to the container with a z-order. More...
 
virtual void addChild (CCNode *pChild, int zOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual void setScale (float fScale)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local fScale)
 Changes both X and Y scale factor of the node. More...
 
virtual void setVertexZ (float fVertexZ)
 Sets the real OpenGL Z vertex. More...
 
local setVertexZ ( local fVertexZ)
 Sets the real OpenGL Z vertex. More...
 
virtual void setAnchorPoint (const CCPoint &anchor)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchor)
 Sets the anchor point in percent. More...
 
virtual void ignoreAnchorPointForPosition (bool value)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local value)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void setVisible (bool bVisible)
 Sets whether the node is visible. More...
 
virtual void draw (void)
 Override this method to draw your own node. More...
 
local draw ()
 Override this method to draw your own node. More...
 
virtual void setColor (const ccColor3B &color3)
 @ More...
 
local setColor ( local color3)
 @ More...
 
virtual void updateDisplayedColor (const ccColor3B &parentColor)
 recursive method that updates display color More...
 
local updateDisplayedColor ( local parentColor)
 recursive method that updates display color More...
 
virtual void setOpacity (GLubyte opacity)
 Changes the opacity. More...
 
virtual void setOpacityModifyRGB (bool modify)
 Changes the OpacityModifyRGB property. More...
 
local setOpacityModifyRGB ( local modify)
 Changes the OpacityModifyRGB property. More...
 
virtual bool isOpacityModifyRGB (void)
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 recursive method that updates the displayed opacity. More...
 
var updateDisplayedOpacity ( var parentOpacity)
 recursive method that updates the displayed opacity. More...
 
local updateDisplayedOpacity ( local parentOpacity)
 recursive method that updates the displayed opacity. More...
 
virtual void updateTransform (void)
 Updates the quad according the rotation, position, scale values. More...
 
virtual CCSpriteBatchNodegetBatchNode (void)
 Returns the batch node object if this sprite is rendered by CCSpriteBatchNode. More...
 
local getBatchNode ()
 Returns the batch node object if this sprite is rendered by CCSpriteBatchNode. More...
 
virtual void setBatchNode (CCSpriteBatchNode *pobSpriteBatchNode)
 Sets the batch node to sprite. More...
 
local setBatchNode ( local pobSpriteBatchNode)
 Sets the batch node to sprite. More...
 
virtual void setTextureRect (const CCRect &rect)
 Updates the texture rect of the CCSprite in points. More...
 
virtual void setTextureRect (const CCRect &rect, bool rotated, const CCSize &untrimmedSize)
 Sets the texture rect, rectRotated and untrimmed size of the CCSprite in points. More...
 
var setTextureRect ( var rect, var rotated, var untrimmedSize)
 Sets the texture rect, rectRotated and untrimmed size of the CCSprite in points. More...
 
local setTextureRect ( local rect, local rotated, local untrimmedSize)
 Sets the texture rect, rectRotated and untrimmed size of the CCSprite in points. More...
 
virtual void setVertexRect (const CCRect &rect)
 Sets the vertex rect. More...
 
var setVertexRect ( var rect)
 Sets the vertex rect. More...
 
local setVertexRect ( local rect)
 Sets the vertex rect. More...
 
virtual void setDisplayFrame (CCSpriteFrame *pNewFrame)
 Sets a new display frame to the CCSprite. More...
 
var setDisplayFrame ( var pNewFrame)
 Sets a new display frame to the CCSprite. More...
 
local setDisplayFrame ( local pNewFrame)
 Sets a new display frame to the CCSprite. More...
 
virtual bool isFrameDisplayed (CCSpriteFrame *pFrame)
 Returns whether or not a CCSpriteFrame is being displayed. More...
 
local isFrameDisplayed ( local pFrame)
 Returns whether or not a CCSpriteFrame is being displayed. More...
 
virtual CCSpriteFramedisplayFrame (void)
 Returns the current displayed frame. More...
 
local displayFrame ()
 Returns the current displayed frame. More...
 
virtual void setDisplayFrameWithAnimationName (const char *animationName, int frameIndex)
 Changes the display frame with animation name and index. More...
 
local setDisplayFrameWithAnimationName ( local animationName, local frameIndex)
 Changes the display frame with animation name and index. More...
 
virtual bool isDirty (void)
 Whether or not the Sprite needs to be updated in the Atlas. More...
 
virtual void setDirty (bool bDirty)
 Makes the Sprite to be updated in the Atlas. More...
 
local setDirty ( local bDirty)
 Makes the Sprite to be updated in the Atlas. More...
 
ccV3F_C4B_T2F_Quad getQuad (void)
 Returns the quad (tex coords, vertex coords and color) information. More...
 
bool isTextureRectRotated (void)
 Returns whether or not the texture rectangle is rotated. More...
 
local isTextureRectRotated ()
 Returns whether or not the texture rectangle is rotated. More...
 
unsigned int getAtlasIndex (void)
 Returns the index used on the TextureAtlas. More...
 
void setAtlasIndex (unsigned int uAtlasIndex)
 Sets the index used on the TextureAtlas. More...
 
const CCRectgetTextureRect (void)
 Returns the rect of the CCSprite in points. More...
 
var getTextureRect ()
 Returns the rect of the CCSprite in points. More...
 
local getTextureRect ()
 Returns the rect of the CCSprite in points. More...
 
CCTextureAtlasgetTextureAtlas (void)
 Gets the weak reference of the CCTextureAtlas when the sprite is rendered using via CCSpriteBatchNode. More...
 
var getTextureAtlas ()
 Gets the weak reference of the CCTextureAtlas when the sprite is rendered using via CCSpriteBatchNode. More...
 
local getTextureAtlas ()
 Gets the weak reference of the CCTextureAtlas when the sprite is rendered using via CCSpriteBatchNode. More...
 
void setTextureAtlas (CCTextureAtlas *pobTextureAtlas)
 Sets the weak reference of the CCTextureAtlas when the sprite is rendered using via CCSpriteBatchNode. More...
 
const CCPointgetOffsetPosition (void)
 Gets the offset position of the sprite. More...
 
local getOffsetPosition ()
 Gets the offset position of the sprite. More...
 
bool isFlipX (void)
 Returns the flag which indicates whether the sprite is flipped horizontally or not. More...
 
void setFlipX (bool bFlipX)
 Sets whether the sprite should be flipped horizontally or not. More...
 
bool isFlipY (void)
 Return the flag which indicates whether the sprite is flipped vertically or not. More...
 
local isFlipY ()
 Return the flag which indicates whether the sprite is flipped vertically or not. More...
 
void setFlipY (bool bFlipY)
 Sets whether the sprite should be flipped vertically or not. More...
 
- Public Member Functions inherited from CCNodeRGBA
 CCNodeRGBA ()
virtual ~CCNodeRGBA ()
virtual GLubyte getOpacity ()
 Returns the opacity. More...
 
virtual GLubyte getDisplayedOpacity ()
 Returns the displayed opacity. More...
 
virtual bool isCascadeOpacityEnabled ()
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const ccColor3BgetColor (void)
 Returns color that is currently used. More...
 
virtual const ccColor3BgetDisplayedColor ()
 Returns the displayed color. More...
 
virtual bool isCascadeColorEnabled ()
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
- Public Member Functions inherited from CCNode
virtual CCCameragetCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
local getCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
virtual bool isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
local isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
virtual void cleanup (void)
 Stops all running actions and schedulers. More...
 
virtual void visit (void)
 Visits this node's children and draw them recursively. More...
 
local visit ()
 Visits this node's children and draw them recursively. More...
 
CCRect boundingBox (void)
 Returns a "local" axis aligned bounding box of the node. More...
 
local boundingBox ()
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual void setZOrder (int zOrder)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void _setZOrder (int z)
 Sets the z order which stands for the drawing order. More...
 
local _setZOrder ( local z)
 Sets the z order which stands for the drawing order. More...
 
virtual int getZOrder ()
 Gets the Z order of this node. More...
 
local getZOrder ()
 Gets the Z order of this node. More...
 
virtual float getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
local getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
virtual float 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 ()
 Returns the scale factor on Y axis of this node. More...
 
virtual float getScale ()
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float fScaleX, float fScaleY)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local fScaleX, local fScaleY)
 Changes both X and Y scale factor of the node. More...
 
virtual const CCPointgetPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
local getPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setPosition (float x, float y)
 Sets position in a more efficient way. More...
 
local setPosition ( local x, local y)
 Sets position in a more efficient way. More...
 
virtual void getPosition (float *x, float *y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
virtual void setPositionX (float 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)
local getPositionX ()
virtual void setPositionY (float y)
virtual float getPositionY (void)
virtual float getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual float getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual const CCPointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const CCPointgetAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const CCSize &contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual const CCSizegetContentSize () const
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual bool isVisible ()
 Determines if the node is visible. More...
 
virtual float getRotation ()
 Returns the rotation of the node in degrees. More...
 
virtual float getRotationX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setOrderOfArrival (unsigned int uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
local setOrderOfArrival ( local uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual unsigned int getOrderOfArrival ()
 Returns the arrival order, indecates which children is added previously. More...
 
virtual void setGLServerState (ccGLServerState glServerState)
 Sets the state of OpenGL server side. More...
 
local setGLServerState ( local glServerState)
 Sets the state of OpenGL server side. More...
 
virtual ccGLServerState getGLServerState ()
 Returns the state of OpenGL server side. More...
 
local getGLServerState ()
 Returns the state of OpenGL server side. More...
 
virtual bool isIgnoreAnchorPointForPosition ()
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual CCNodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual CCArraygetChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual unsigned int getChildrenCount (void) const
 Get the amount of children. More...
 
local getChildrenCount ()
 Get the amount of children. More...
 
virtual void setParent (CCNode *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual CCNodegetParent ()
 Returns a pointer to the parent node. More...
 
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 removeFromParentAndCleanup ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (CCNode *child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeChildByTag (int tag)
 Removes a child from the container by tag value with a cleanup. More...
 
local removeChildByTag ( local tag)
 Removes a child from the container by tag value with a cleanup. More...
 
virtual void removeChildByTag (int tag, bool cleanup)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local cleanup)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual CCGridBasegetGrid ()
 Returns a grid object that is used when applying effects. More...
 
virtual void setGrid (CCGridBase *pGrid)
 Changes a grid object that is used when applying effects. More...
 
local setGrid ( local pGrid)
 Changes a grid object that is used when applying effects. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int nTag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local nTag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual void setUserData (void *pUserData)
 Sets a custom user data pointer. More...
 
local setUserData ( local pUserData)
 Sets a custom user data pointer. More...
 
virtual CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
local getUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *pUserObject)
 Returns a user assigned CCObject. More...
 
local setUserObject ( local pUserObject)
 Returns a user assigned CCObject. More...
 
virtual CCGLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual void setShaderProgram (CCGLProgram *pShaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local pShaderProgram)
 Sets the shader program for this node. More...
 
virtual void registerScriptHandler (int handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
local registerScriptHandler ( local handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
virtual void unregisterScriptHandler (void)
 Unregisters a script function that will be called in onEnter() & onExit() series functions. More...
 
local unregisterScriptHandler ()
 Unregisters a script function that will be called in onEnter() & onExit() series functions. More...
 
int getScriptHandler ()
 Gets script handler for onEnter/onExit event. More...
 
void scheduleUpdateWithPriorityLua (int nHandler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local nHandler, local priority)
 Schedules for lua script. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when CCNode enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the CCNode enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the CCNode leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the CCNode leaves the 'stage'. More...
 
virtual void setActionManager (CCActionManager *actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
local setActionManager ( local actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
virtual CCActionManagergetActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
CCActionrunAction (CCAction *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 (void)
 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 (CCAction *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...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
CCActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
local getActionByTag ( local tag)
 Gets an action from the running action list by its tag. More...
 
unsigned int numberOfRunningActions (void)
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
local numberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
virtual void setScheduler (CCScheduler *scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
local setScheduler ( local scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
virtual CCSchedulergetScheduler ()
 Gets a CCSheduler object. More...
 
local getScheduler ()
 Gets a CCSheduler object. More...
 
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)
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...
 
local unscheduleAllSelectors ()
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors and actions. More...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
void transform (void)
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors (void)
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
local transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual CCAffineTransform nodeToParentTransform (void)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local nodeToParentTransform ()
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual CCAffineTransform parentToNodeTransform (void)
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local parentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual CCAffineTransform nodeToWorldTransform (void)
 Returns the world affine transform matrix. More...
 
local nodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual CCAffineTransform worldToNodeTransform (void)
 Returns the inverse world affine transform matrix. More...
 
CCPoint convertToNodeSpace (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpace (const CCPoint &nodePoint)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 Converts a Point to world space coordinates. More...
 
CCPoint convertToNodeSpaceAR (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpaceAR ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpaceAR (const CCPoint &nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
local convertToWorldSpaceAR ( local nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
CCPoint convertTouchToNodeSpace (CCTouch *touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
CCPoint convertTouchToNodeSpaceAR (CCTouch *touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const CCAffineTransform &additionalTransform)
 Sets the additional transform. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets the additional transform. More...
 
CCComponentgetComponent (const char *pName) const
 gets a component by its name More...
 
virtual bool addComponent (CCComponent *pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *pName)
 removes a component by its name More...
 
local removeComponent ( local pName)
 removes a component by its name More...
 
virtual bool removeComponent (CCComponent *pComponent)
 removes a component by its pointer More...
 
virtual void removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
 CCNode (void)
 Default constructor. More...
 
 CCNode ()
 Default constructor. More...
 
virtual ~CCNode (void)
 Default destructor. More...
 
const char * description (void)
 Gets the description string. More...
 
local description ()
 Gets the description string. More...
 
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)
- Public Member Functions inherited from CCCopying
virtual CCObjectcopyWithZone (CCZone *pZone)

Static Public Member Functions

static CCLabelTTFcreate (const char *string, const char *fontName, float fontSize)
 creates a CCLabelTTF with a font name and font size in points More...
 
static CCLabelTTFcreate (const char *string, const char *fontName, float fontSize, const CCSize &dimensions, CCTextAlignment hAlignment)
 creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. More...
 
static CCLabelTTFcreate (const char *string, const char *fontName, float fontSize, const CCSize &dimensions, CCTextAlignment hAlignment, CCVerticalTextAlignment vAlignment)
 creates a CCLabel from a fontname, alignment, dimension in points and font size in points More...
 
static CCLabelTTFcreateWithFontDefinition (const char *string, ccFontDefinition &textDefinition)
 Create a lable with string and a font definition. More...
 
local createWithFontDefinition ( local string, local textDefinition)
 Create a lable with string and a font definition. More...
 
static CCLabelTTFcreate ()
 Creates an label. More...
 
local create ()
 Creates an label. More...
 
- Static Public Member Functions inherited from CCSprite
static CCSpritecreate ()
 Creates an empty sprite without texture. More...
 
var create ()
 Creates an empty sprite without texture. More...
 
static CCSpritecreate (const char *pszFileName)
 Creates a sprite with an image filename. More...
 
var create ( var pszFileName)
 Creates a sprite with an image filename. More...
 
static CCSpritecreate (const char *pszFileName, const CCRect &rect)
 Creates a sprite with an image filename and a rect. More...
 
local create ( local pszFileName, local rect)
 Creates a sprite with an image filename and a rect. More...
 
static CCSpritecreateWithTexture (CCTexture2D *pTexture)
 Creates a sprite with an exsiting texture contained in a CCTexture2D object After creation, the rect will be the size of the texture, and the offset will be (0,0). More...
 
local createWithTexture ( local pTexture)
 Creates a sprite with an exsiting texture contained in a CCTexture2D object After creation, the rect will be the size of the texture, and the offset will be (0,0). More...
 
static CCSpritecreateWithTexture (CCTexture2D *pTexture, const CCRect &rect)
 Creates a sprite with a texture and a rect. More...
 
var createWithTexture ( var pTexture, var rect)
 Creates a sprite with a texture and a rect. More...
 
static CCSpritecreateWithSpriteFrame (CCSpriteFrame *pSpriteFrame)
 Creates a sprite with an sprite frame. More...
 
static CCSpritecreateWithSpriteFrameName (const char *pszSpriteFrameName)
 Creates a sprite with an sprite frame name. More...
 
var createWithSpriteFrameName ( var pszSpriteFrameName)
 Creates a sprite with an sprite frame name. More...
 
local createWithSpriteFrameName ( local pszSpriteFrameName)
 Creates a sprite with an sprite frame name. More...
 
- Static Public Member Functions inherited from CCNodeRGBA
static CCNodeRGBAcreate (void)
 Allocates and initializes a nodergba. More...
 
- Static Public Member Functions inherited from CCNode
static CCNodecreate (void)
 Allocates and initializes a node. More...
 

Protected Member Functions

void _updateWithTextDefinition (ccFontDefinition &textDefinition, bool mustUpdateTexture=true)
 set the text definition for this label More...
 
var _updateWithTextDefinition ( var textDefinition, var true)
 set the text definition for this label More...
 
local _updateWithTextDefinition ( local textDefinition, local true)
 set the text definition for this label More...
 
ccFontDefinition _prepareTextDefinition (bool adjustForResolution=false)
var _prepareTextDefinition ( var false)
local _prepareTextDefinition ( local false)
- Protected Member Functions inherited from CCSprite
void updateColor (void)
virtual void setTextureCoords (CCRect rect)
local setTextureCoords ( local rect)
virtual void updateBlendFunc (void)
virtual void setReorderChildDirtyRecursively (void)
local setReorderChildDirtyRecursively ()
virtual void setDirtyRecursively (bool bValue)

Protected Attributes

CCSize m_tDimensions
 Dimensions of the label in Points. More...
 
CCTextAlignment m_hAlignment
 The alignment of the label. More...
 
var m_hAlignment
 The alignment of the label. More...
 
local m_hAlignment
 The alignment of the label. More...
 
CCVerticalTextAlignment m_vAlignment
 The vertical alignment of the label. More...
 
var m_vAlignment
 The vertical alignment of the label. More...
 
local m_vAlignment
 The vertical alignment of the label. More...
 
std::string * m_pFontName
 Font name used in the label. More...
 
var m_pFontName
 Font name used in the label. More...
 
local m_pFontName
 Font name used in the label. More...
 
float m_fFontSize
 Font size of the label. More...
 
var m_fFontSize
 Font size of the label. More...
 
local m_fFontSize
 Font size of the label. More...
 
std::string m_string
 label's string More...
 
var m_string
 label's string More...
 
local m_string
 label's string More...
 
bool m_shadowEnabled
 font shadow More...
 
var m_shadowEnabled
 font shadow More...
 
local m_shadowEnabled
 font shadow More...
 
CCSize m_shadowOffset
float m_shadowOpacity
var m_shadowOpacity
local m_shadowOpacity
float m_shadowBlur
var m_shadowBlur
local m_shadowBlur
bool m_strokeEnabled
 font stroke More...
 
var m_strokeEnabled
 font stroke More...
 
local m_strokeEnabled
 font stroke More...
 
ccColor3B m_strokeColor
float m_strokeSize
var m_strokeSize
local m_strokeSize
ccColor3B m_textFillColor
 font tint More...
 
var m_textFillColor
 font tint More...
 
local m_textFillColor
 font tint More...
 
- Protected Attributes inherited from CCSprite
CCTextureAtlasm_pobTextureAtlas
unsigned int m_uAtlasIndex
 CCSpriteBatchNode texture atlas (weak reference) More...
 
var m_uAtlasIndex
 CCSpriteBatchNode texture atlas (weak reference) More...
 
local m_uAtlasIndex
 CCSpriteBatchNode texture atlas (weak reference) More...
 
CCSpriteBatchNodem_pobBatchNode
 Absolute (real) Index on the SpriteSheet. More...
 
bool m_bDirty
 Used batch node (weak reference) More...
 
bool m_bRecursiveDirty
 Whether the sprite needs to be updated. More...
 
var m_bRecursiveDirty
 Whether the sprite needs to be updated. More...
 
local m_bRecursiveDirty
 Whether the sprite needs to be updated. More...
 
bool m_bHasChildren
 Whether all of the sprite's children needs to be updated. More...
 
bool m_bShouldBeHidden
 Whether the sprite contains children. More...
 
var m_bShouldBeHidden
 Whether the sprite contains children. More...
 
local m_bShouldBeHidden
 Whether the sprite contains children. More...
 
CCAffineTransform m_transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
var m_transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
local m_transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
ccBlendFunc m_sBlendFunc
CCTexture2Dm_pobTexture
 It's required for CCTextureProtocol inheritance. More...
 
var m_pobTexture
 It's required for CCTextureProtocol inheritance. More...
 
local m_pobTexture
 It's required for CCTextureProtocol inheritance. More...
 
CCRect m_obRect
 CCTexture2D object that is used to render the sprite. More...
 
bool m_bRectRotated
 Retangle of CCTexture2D. More...
 
CCPoint m_obOffsetPosition
 Whether the texture is rotated. More...
 
var m_obOffsetPosition
 Whether the texture is rotated. More...
 
local m_obOffsetPosition
 Whether the texture is rotated. More...
 
CCPoint m_obUnflippedOffsetPositionFromCenter
var m_obUnflippedOffsetPositionFromCenter
local m_obUnflippedOffsetPositionFromCenter
ccV3F_C4B_T2F_Quad m_sQuad
local m_sQuad
bool m_bOpacityModifyRGB
var m_bOpacityModifyRGB
local m_bOpacityModifyRGB
bool m_bFlipX
bool m_bFlipY
 Whether the sprite is flipped horizaontally or not. More...
 
var m_bFlipY
 Whether the sprite is flipped horizaontally or not. More...
 
local m_bFlipY
 Whether the sprite is flipped horizaontally or not. More...
 
- Protected Attributes inherited from CCNodeRGBA
GLubyte _displayedOpacity
GLubyte _realOpacity
ccColor3B _displayedColor
ccColor3B _realColor
bool _cascadeColorEnabled
bool _cascadeOpacityEnabled
- Protected Attributes inherited from CCNode
float m_fRotationX
 rotation angle on x-axis More...
 
float m_fRotationY
 rotation angle on y-axis More...
 
local m_fRotationY
 rotation angle on y-axis More...
 
float m_fScaleX
 scaling factor on x-axis More...
 
local m_fScaleX
 scaling factor on x-axis More...
 
float m_fScaleY
 scaling factor on y-axis More...
 
local m_fScaleY
 scaling factor on y-axis More...
 
float m_fVertexZ
 OpenGL real Z vertex. More...
 
local m_fVertexZ
 OpenGL real Z vertex. More...
 
CCPoint m_obPosition
 position of the node More...
 
local m_obPosition
 position of the node More...
 
float m_fSkewX
 skew angle on x-axis More...
 
local m_fSkewX
 skew angle on x-axis More...
 
float m_fSkewY
 skew angle on y-axis More...
 
local m_fSkewY
 skew angle on y-axis More...
 
CCPoint m_obAnchorPointInPoints
 anchor point in points More...
 
local m_obAnchorPointInPoints
 anchor point in points More...
 
CCPoint m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
local m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
CCSize m_obContentSize
 untransformed size of the node More...
 
local m_obContentSize
 untransformed size of the node More...
 
CCAffineTransform m_sAdditionalTransform
 transform More...
 
CCAffineTransform m_sTransform
 transform More...
 
local m_sTransform
 transform More...
 
CCAffineTransform m_sInverse
 transform More...
 
local m_sInverse
 transform More...
 
CCCameram_pCamera
 a camera More...
 
local m_pCamera
 a camera More...
 
CCGridBasem_pGrid
 a grid More...
 
local m_pGrid
 a grid More...
 
int m_nZOrder
 z-order value that affects the draw order More...
 
local m_nZOrder
 z-order value that affects the draw order More...
 
CCArraym_pChildren
 array of children nodes More...
 
local m_pChildren
 array of children nodes More...
 
CCNodem_pParent
 weak reference to parent node More...
 
local m_pParent
 weak reference to parent node More...
 
int m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
local m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
void * m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
CCObjectm_pUserObject
 A user assigned CCObject. More...
 
local m_pUserObject
 A user assigned CCObject. More...
 
CCGLProgramm_pShaderProgram
 OpenGL shader. More...
 
local m_pShaderProgram
 OpenGL shader. More...
 
ccGLServerState m_eGLServerState
 OpenGL servier side state. More...
 
local m_eGLServerState
 OpenGL servier side state. More...
 
unsigned int m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
local m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
CCSchedulerm_pScheduler
 scheduler used to schedule timers and updates More...
 
local m_pScheduler
 scheduler used to schedule timers and updates More...
 
CCActionManagerm_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
bool m_bRunning
 is running More...
 
local m_bRunning
 is running More...
 
bool m_bTransformDirty
 transform dirty flag More...
 
local m_bTransformDirty
 transform dirty flag More...
 
bool m_bInverseDirty
 transform dirty flag More...
 
local m_bInverseDirty
 transform dirty flag More...
 
bool m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
local m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool m_bVisible
 is this node visible More...
 
local m_bVisible
 is this node visible More...
 
bool m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
local m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
bool m_bReorderChildDirty
 children order dirty flag More...
 
int m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType m_eScriptType
 type of script binding, lua or javascript More...
 
local m_eScriptType
 type of script binding, lua or javascript More...
 
CCComponentContainerm_pComponentContainer
 Dictionary of components. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Detailed Description

CCLabelTTF is a subclass of CCTextureNode that knows how to render text labels.

All features from CCTextureNode are valid in CCLabelTTF

CCLabelTTF objects are slow. Consider using CCLabelAtlas or CCLabelBMFont instead.

Custom ttf file can be put in assets/ or external storage that the Application can access.

CCLabelTTF *label1 = CCLabelTTF::create("alignment left", "A Damn Mess", fontSize, blockSize,
CCLabelTTF *label2 = CCLabelTTF::create("alignment right", "/mnt/sdcard/Scissor Cuts.ttf", fontSize, blockSize,

Constructor & Destructor Documentation

var ctor ( )
local CCLabelTTF ( )
virtual ~CCLabelTTF ( )
virtual

Member Function Documentation

ccFontDefinition
_prepareTextDefinition
( bool  adjustForResolution = false)
protected
var _prepareTextDefinition ( var  adjustForResolution = false)
protected
local _prepareTextDefinition ( local  adjustForResolution = false)
protected
void _updateWithTextDefinition ( ccFontDefinition textDefinition,
bool  mustUpdateTexture = true 
)
protected

set the text definition for this label

var _updateWithTextDefinition ( var  textDefinition,
var  mustUpdateTexture = true 
)
protected

set the text definition for this label

local _updateWithTextDefinition ( local  textDefinition,
local  mustUpdateTexture = true 
)
protected

set the text definition for this label

static CCLabelTTF* create ( const char *  string,
const char *  fontName,
float  fontSize 
)
static

creates a CCLabelTTF with a font name and font size in points

Since
v2.0.1
var create ( var  string,
var  fontName,
var  fontSize 
)
static

creates a CCLabelTTF with a font name and font size in points

Since
v2.0.1
local create ( local  string,
local  fontName,
local  fontSize 
)
static

creates a CCLabelTTF with a font name and font size in points

Since
v2.0.1
static CCLabelTTF* create ( const char *  string,
const char *  fontName,
float  fontSize,
const CCSize dimensions,
CCTextAlignment  hAlignment 
)
static

creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points.

Since
v2.0.1
var create ( var  string,
var  fontName,
var  fontSize,
var  dimensions,
var  hAlignment 
)
static

creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points.

Since
v2.0.1
local create ( local  string,
local  fontName,
local  fontSize,
local  dimensions,
local  hAlignment 
)
static

creates a CCLabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points.

Since
v2.0.1
static CCLabelTTF* create ( const char *  string,
const char *  fontName,
float  fontSize,
const CCSize dimensions,
CCTextAlignment  hAlignment,
CCVerticalTextAlignment  vAlignment 
)
static

creates a CCLabel from a fontname, alignment, dimension in points and font size in points

Since
v2.0.1
var create ( var  string,
var  fontName,
var  fontSize,
var  dimensions,
var  hAlignment,
var  vAlignment 
)
static

creates a CCLabel from a fontname, alignment, dimension in points and font size in points

Since
v2.0.1
local create ( local  string,
local  fontName,
local  fontSize,
local  dimensions,
local  hAlignment,
local  vAlignment 
)
static

creates a CCLabel from a fontname, alignment, dimension in points and font size in points

Since
v2.0.1
static CCLabelTTF* create ( )
static

Creates an label.

var create ( )
static

Creates an label.

local create ( )
static

Creates an label.

static CCLabelTTF*
createWithFontDefinition
( const char *  string,
ccFontDefinition textDefinition 
)
static

Create a lable with string and a font definition.

var createWithFontDefinition ( var  string,
var  textDefinition 
)
static

Create a lable with string and a font definition.

local createWithFontDefinition ( local  string,
local  textDefinition 
)
static

Create a lable with string and a font definition.

const char* description ( )
void disableShadow ( bool  mustUpdateTexture = true)

disable shadow rendering

var disableShadow ( var  mustUpdateTexture = true)

disable shadow rendering

local disableShadow ( local  mustUpdateTexture = true)

disable shadow rendering

void disableStroke ( bool  mustUpdateTexture = true)

disable stroke

var disableStroke ( var  mustUpdateTexture = true)

disable stroke

local disableStroke ( local  mustUpdateTexture = true)

disable stroke

void enableShadow ( const CCSize shadowOffset,
float  shadowOpacity,
float  shadowBlur,
bool  mustUpdateTexture = true 
)

enable or disable shadow for the label

var enableShadow ( var  shadowOffset,
var  shadowOpacity,
var  shadowBlur,
var  mustUpdateTexture = true 
)

enable or disable shadow for the label

local enableShadow ( local  shadowOffset,
local  shadowOpacity,
local  shadowBlur,
local  mustUpdateTexture = true 
)

enable or disable shadow for the label

void enableStroke ( const ccColor3B strokeColor,
float  strokeSize,
bool  mustUpdateTexture = true 
)

enable or disable stroke

var enableStroke ( var  strokeColor,
var  strokeSize,
var  mustUpdateTexture = true 
)

enable or disable stroke

local enableStroke ( local  strokeColor,
local  strokeSize,
local  mustUpdateTexture = true 
)

enable or disable stroke

CCSize getDimensions ( )
var getDimensions ( )
local getDimensions ( )
const char* getFontName ( )
var getFontName ( )
local getFontName ( )
float getFontSize ( )
var getFontSize ( )
local getFontSize ( )
CCTextAlignment
getHorizontalAlignment
( )
var getHorizontalAlignment ( )
local getHorizontalAlignment ( )
virtual const char* getString ( void  )
virtual

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

Returns
The string that is currently being used in this label

Implements CCLabelProtocol.

Reimplemented in CCTextFieldTTF.

var getString (   )
virtual

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

Returns
The string that is currently being used in this label

Implements CCLabelProtocol.

Reimplemented in CCTextFieldTTF.

local getString (   )
virtual

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

Returns
The string that is currently being used in this label

Implements CCLabelProtocol.

Reimplemented in CCTextFieldTTF.

ccFontDefinition* getTextDefinition ( )

get the text definition used by this label

var getTextDefinition ( )

get the text definition used by this label

local getTextDefinition ( )

get the text definition used by this label

CCVerticalTextAlignment
getVerticalAlignment
( )
var getVerticalAlignment ( )
local getVerticalAlignment ( )
bool init ( )
virtual

initializes the CCLabelTTF

Reimplemented from CCSprite.

var init ( )
virtual

initializes the CCLabelTTF

Reimplemented from CCSprite.

local init ( )
virtual

initializes the CCLabelTTF

Reimplemented from CCSprite.

bool initWithString ( const char *  string,
const char *  fontName,
float  fontSize 
)

initializes the CCLabelTTF with a font name and font size

var initWithString ( var  string,
var  fontName,
var  fontSize 
)

initializes the CCLabelTTF with a font name and font size

local initWithString ( local  string,
local  fontName,
local  fontSize 
)

initializes the CCLabelTTF with a font name and font size

bool initWithString ( const char *  string,
const char *  fontName,
float  fontSize,
const CCSize dimensions,
CCTextAlignment  hAlignment 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

var initWithString ( var  string,
var  fontName,
var  fontSize,
var  dimensions,
var  hAlignment 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

local initWithString ( local  string,
local  fontName,
local  fontSize,
local  dimensions,
local  hAlignment 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

bool initWithString ( const char *  string,
const char *  fontName,
float  fontSize,
const CCSize dimensions,
CCTextAlignment  hAlignment,
CCVerticalTextAlignment  vAlignment 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

var initWithString ( var  string,
var  fontName,
var  fontSize,
var  dimensions,
var  hAlignment,
var  vAlignment 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

local initWithString ( local  string,
local  fontName,
local  fontSize,
local  dimensions,
local  hAlignment,
local  vAlignment 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

bool
initWithStringAndTextDefinition
( const char *  string,
ccFontDefinition textDefinition 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

var initWithStringAndTextDefinition ( var  string,
var  textDefinition 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

local
initWithStringAndTextDefinition
( local  string,
local  textDefinition 
)

initializes the CCLabelTTF with a font name, alignment, dimension and font size

void setDimensions ( const CCSize dim)
var setDimensions ( var  dim)
local setDimensions ( local  dim)
void setFontFillColor ( const ccColor3B tintColor,
bool  mustUpdateTexture = true 
)

set text tinting

var setFontFillColor ( var  tintColor,
var  mustUpdateTexture = true 
)

set text tinting

local setFontFillColor ( local  tintColor,
local  mustUpdateTexture = true 
)

set text tinting

void setFontName ( const char *  fontName)
var setFontName ( var  fontName)
local setFontName ( local  fontName)
void setFontSize ( float  fontSize)
var setFontSize ( var  fontSize)
local setFontSize ( local  fontSize)
void setHorizontalAlignment ( CCTextAlignment  alignment)
var setHorizontalAlignment ( var  alignment)
local setHorizontalAlignment ( local  alignment)
virtual void setString ( const char *  label)
virtual

changes the string to render

Warning
Changing the string is as expensive as creating a new CCLabelTTF. To obtain better performance use CCLabelAtlas

Implements CCLabelProtocol.

Reimplemented in CCTextFieldTTF.

var setString ( var  label)
virtual

changes the string to render

Warning
Changing the string is as expensive as creating a new CCLabelTTF. To obtain better performance use CCLabelAtlas

Implements CCLabelProtocol.

Reimplemented in CCTextFieldTTF.

local setString ( local  label)
virtual

changes the string to render

Warning
Changing the string is as expensive as creating a new CCLabelTTF. To obtain better performance use CCLabelAtlas

Implements CCLabelProtocol.

Reimplemented in CCTextFieldTTF.

void setTextDefinition ( ccFontDefinition theDefinition)

set the text definition used by this label

var setTextDefinition ( var  theDefinition)

set the text definition used by this label

local setTextDefinition ( local  theDefinition)

set the text definition used by this label

void setVerticalAlignment ( CCVerticalTextAlignment  verticalAlignment)
var setVerticalAlignment ( var  verticalAlignment)
local setVerticalAlignment ( local  verticalAlignment)

Member Data Documentation

float m_fFontSize
protected

Font size of the label.

var m_fFontSize
protected

Font size of the label.

local m_fFontSize
protected

Font size of the label.

CCTextAlignment m_hAlignment
protected

The alignment of the label.

var m_hAlignment
protected

The alignment of the label.

local m_hAlignment
protected

The alignment of the label.

std::string* m_pFontName
protected

Font name used in the label.

var m_pFontName
protected

Font name used in the label.

local m_pFontName
protected

Font name used in the label.

float m_shadowBlur
protected
var m_shadowBlur
protected
local m_shadowBlur
protected
bool m_shadowEnabled
protected

font shadow

var m_shadowEnabled
protected

font shadow

local m_shadowEnabled
protected

font shadow

CCSize m_shadowOffset
protected
var m_shadowOffset
protected
local m_shadowOffset
protected
float m_shadowOpacity
protected
var m_shadowOpacity
protected
local m_shadowOpacity
protected
std::string m_string
protected

label's string

var m_string
protected

label's string

local m_string
protected

label's string

ccColor3B m_strokeColor
protected
var m_strokeColor
protected
local m_strokeColor
protected
bool m_strokeEnabled
protected

font stroke

var m_strokeEnabled
protected

font stroke

local m_strokeEnabled
protected

font stroke

float m_strokeSize
protected
var m_strokeSize
protected
local m_strokeSize
protected
CCSize m_tDimensions
protected

Dimensions of the label in Points.

ccColor3B m_textFillColor
protected

font tint

var m_textFillColor
protected

font tint

local m_textFillColor
protected

font tint

CCVerticalTextAlignment
m_vAlignment
protected

The vertical alignment of the label.

var m_vAlignment
protected

The vertical alignment of the label.

local m_vAlignment
protected

The vertical alignment of the label.


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