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

#include <CCLabelTTF.h>

Inheritance diagram for CCLabelTTF:

Collaboration diagram for CCLabelTTF:

Public Member Functions
	CCLabelTTF ()
	ctor More...

virtual	~CCLabelTTF ()
	NA NA. More...

const char *	description ()
	NA NA. More...

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

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

ccFontDefinition *	getTextDefinition ()
	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...

void	disableShadow (bool mustUpdateTexture=true)
	disable shadow rendering More...

void	enableStroke (const ccColor3B &strokeColor, float strokeSize, bool mustUpdateTexture=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...

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

void	setHorizontalAlignment (CCTextAlignment alignment)

CCVerticalTextAlignment	getVerticalAlignment ()

void	setVerticalAlignment (CCVerticalTextAlignment verticalAlignment)

CCSize	getDimensions ()

void	setDimensions (const CCSize &dim)

float	getFontSize ()

void	setFontSize (float fontSize)

const char *	getFontName ()

void	setFontName (const char *fontName)

Public Member Functions inherited from CCSprite
	CCSprite (void)
	Default constructor ctor. More...

virtual	~CCSprite (void)
	Default destructor NA NA. More...

virtual bool	initWithTexture (CCTexture2D *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...

virtual bool	initWithSpriteFrame (CCSpriteFrame *pSpriteFrame)
	Initializes a sprite with an SpriteFrame. More...

virtual bool	initWithSpriteFrameName (const char *pszSpriteFrameName)
	Initializes a sprite with an sprite frame name. More...

virtual bool	initWithFile (const char *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...

virtual void	setChildColor (const ccColor3B &)

virtual void	setChildOpacity (GLubyte)

virtual void	setTexture (CCTexture2D *texture)
	NA. More...

virtual CCTexture2D *	getTexture (void)
	NA. More...

void	setBlendFunc (ccBlendFunc blendFunc)
	NA. More...

ccBlendFunc	getBlendFunc (void)
	NA. More...

virtual void	setScaleX (float fScaleX)
	NA. More...

virtual void	setScaleY (float fScaleY)
	NA. More...

virtual void	setPosition (const CCPoint &pos)
	NA. More...

virtual void	setRotation (float fRotation)
	NA. More...

virtual void	setRotationX (float fRotationX)
	NA. More...

virtual void	setRotationY (float fRotationY)
	NA. More...

virtual void	setSkewX (float sx)
	NA. More...

virtual void	setSkewY (float sy)
	NA. More...

virtual void	removeChild (CCNode *pChild, bool bCleanup)
	NA. More...

virtual void	removeAllChildrenWithCleanup (bool bCleanup)
	NA. More...

virtual void	reorderChild (CCNode *pChild, int zOrder)
	NA. More...

virtual void	addChild (CCNode *pChild)
	NA. More...

virtual void	addChild (CCNode *pChild, int zOrder)
	NA. More...

virtual void	addChild (CCNode *pChild, int zOrder, int tag)
	NA. More...

virtual void	sortAllChildren ()
	NA. More...

virtual void	setScale (float fScale)
	NA. More...

virtual void	setVertexZ (float fVertexZ)
	NA. More...

virtual void	setAnchorPoint (const CCPoint &anchor)
	NA. More...

virtual void	ignoreAnchorPointForPosition (bool value)
	NA. More...

virtual void	setVisible (bool bVisible)
	NA. More...

virtual void	draw (void)
	NA. More...

virtual void	setColor (const ccColor3B &color3)
	Changes the color with R,G,B bytes. More...

virtual void	updateDisplayedColor (const ccColor3B &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...

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

virtual void	updateTransform (void)
	Updates the quad according the rotation, position, scale values. More...

virtual CCSpriteBatchNode *	getBatchNode (void)
	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...

virtual void	refreshTextureRect (void)

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

virtual void	setVertexRect (const CCRect &rect)
	Sets the vertex rect. More...

virtual void	setDisplayFrame (CCSpriteFrame *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...

virtual CCSpriteFrame *	displayFrame (void)
	Returns the current displayed frame. More...

virtual void	setDisplayFrameWithAnimationName (const char *animationName, int 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...

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

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 CCRect &	getTextureRect (void)
	Returns the rect of the CCSprite in points. More...

CCTextureAtlas *	getTextureAtlas (void)
	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 CCPoint &	getOffsetPosition (void)
	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...

void	setFlipY (bool bFlipY)
	Sets whether the sprite should be flipped vertically or not. More...

bool	getDontDraw (void)
	Whether the sprite is flipped vertically or not. More...

void	setDontDraw (bool var)
	Whether the sprite is flipped vertically or not. More...

float	getTlVertexMod (void)
	Whether the sprite is flipped vertically or not. More...

void	setTlVertexMod (float var)
	Whether the sprite is flipped vertically or not. More...

float	getTrVertexMod (void)
	Whether the sprite is flipped vertically or not. More...

void	setTrVertexMod (float var)
	Whether the sprite is flipped vertically or not. More...

float	getBlVertexMod (void)
	Whether the sprite is flipped vertically or not. More...

void	setBlVertexMod (float var)
	Whether the sprite is flipped vertically or not. More...

float	getBrVertexMod (void)
	Whether the sprite is flipped vertically or not. More...

void	setBrVertexMod (float var)
	Whether the sprite is flipped vertically or not. More...

Public Member Functions inherited from CCNodeRGBA
	CCNodeRGBA ()
	ctor More...

virtual	~CCNodeRGBA ()
	NA NA. More...

virtual bool	init ()
	Initializes the instance of CCNode. More...

virtual GLubyte	getOpacity ()
	Returns the opacity. More...

virtual GLubyte	getDisplayedOpacity ()
	Returns the displayed opacity. More...

virtual void	setOpacity (GLubyte opacity)
	Changes the opacity. More...

virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
	recursive method that updates 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 ccColor3B &	getColor (void)
	Returns color that is currently used. More...

virtual const ccColor3B &	getDisplayedColor ()
	Returns the displayed color. More...

virtual void	setColor (const ccColor3B &color)
	Changes the color with R,G,B bytes. More...

virtual void	updateDisplayedColor (const ccColor3B &parentColor)
	recursive method that updates display color More...

virtual bool	isCascadeColorEnabled ()
	whether or not color should be propagated to its children. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)

virtual void	setOpacityModifyRGB (bool bValue)
	Changes the OpacityModifyRGB property. More...

virtual bool	isOpacityModifyRGB ()
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

Public Member Functions inherited from CCNode
virtual	~CCNode (void)
	Default destructor NA NA. More...

virtual bool	init ()
	Initializes the instance of CCNode. More...

const char *	description (void)
	Gets the description string. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

virtual bool	isVisible ()
	Determines if the node is visible. More...

virtual void	setRotation (float fRotation)
	Sets the rotation (angle) of the node in degrees. More...

virtual float	getRotation ()
	Returns the rotation of the node in degrees. More...

virtual void	setRotationX (float fRotaionX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

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

virtual void	setRotationY (float fRotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational 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...

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

virtual ccGLServerState	getGLServerState ()
	Returns the state of OpenGL server side. More...

virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition ()
	Gets whether the anchor point will be (0,0) when you position this node. More...

virtual void	removeChild (CCNode *child)
	Removes a child from the container with a cleanup. More...

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

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

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

virtual void	removeAllChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

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

virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

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

virtual void	cleanup (void)
	Stops all running actions and schedulers. More...

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

virtual void	visit (void)
	Visits this node's children and draw them recursively. More...

CCRect	boundingBox (void)
	Returns a "local" axis aligned bounding box of the node. More...

virtual CCAffineTransform	nodeToWorldTransform (void)
	Returns the world affine transform matrix. More...

virtual CCAffineTransform	worldToNodeTransform (void)
	Returns the inverse world affine transform matrix. More...

	CCNode (void)
	Default constructor ctor. More...

	CCNode (const CCNode &)

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

virtual int	getZOrder ()
	Gets the Z order of this node. More...

virtual float	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...

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

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

virtual void	getPosition (float x, float 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...

virtual float	getPositionX (void)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	setPositionY (float y)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual float	getPositionY (void)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

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 CCPoint &	getAnchorPoint ()
	Returns the anchor point in percent. More...

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

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

virtual const CCSize &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual CCSize	getScaledContentSize (void)

virtual CCNode *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual CCArray *	getChildren ()
	Return an array of children. More...

virtual unsigned int	getChildrenCount (void) const
	Get the amount of children. More...

virtual void	setParent (CCNode *parent)
	Sets the parent node. More...

virtual CCNode *	getParent ()
	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...

virtual void	removeMeAndCleanup (void)

virtual CCGridBase *	getGrid ()
	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...

virtual void *	getUserData ()
	Returns a tag that is used to identify the node easily. More...

virtual void	setUserData (void *pUserData)
	Sets a custom user data pointer. More...

virtual CCObject *	getUserObject ()
	Returns a user assigned CCObject. More...

virtual void	setUserObject (CCObject *pUserObject)
	Returns a user assigned CCObject. More...

virtual CCGLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...

virtual void	setShaderProgram (CCGLProgram *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...

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

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

virtual CCActionManager *	getActionManager ()
	Gets the CCActionManager object that is used by all actions. More...

CCAction *	runAction (CCAction *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...

void	stopAction (CCAction *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...

CCAction *	getActionByTag (int 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...

virtual void	setScheduler (CCScheduler *scheduler)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

virtual CCScheduler *	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)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...

void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...

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

void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...

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

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

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

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

virtual void	update (float delta)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

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

virtual const CCAffineTransform	nodeToParentTransform (void)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual const CCAffineTransform	parentToNodeTransform (void)
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

CCPoint	convertToNodeSpace (const CCPoint &worldPoint)
	Converts a Point to node (local) space coordinates. More...

CCPoint	convertToWorldSpace (const CCPoint &nodePoint)
	Converts a Point to world space coordinates. More...

CCPoint	convertToNodeSpaceAR (const CCPoint &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...

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

void	setAdditionalTransform (const CCAffineTransform &additionalTransform)
	Sets the additional transform. More...

CCComponent *	getComponent (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...

virtual bool	removeComponent (CCComponent *pComponent)
	removes a component by its pointer More...

virtual void	removeAllComponents ()
	removes all components More...

virtual void	updateTweenAction (float, const char *)

CCNode &	operator= (const CCNode &)

Public Member Functions inherited from CCObject
	CCObject (void)

virtual	~CCObject (void)
	NA. More...

void	release (void)

void	retain (void)

CCObject *	autorelease (void)

CCObject *	copy (void)

bool	isSingleReference (void) const

unsigned int	retainCount (void) const

virtual bool	isEqual (const CCObject *pObject)

virtual void	acceptVisitor (CCDataVisitor &visitor)

virtual void	update (float dt)

	CCObject (const CCObject &)

CCObject &	operator= (const CCObject &)

virtual void	encodeWithCoder (DS_Dictionary *)

virtual bool	canEncode ()

CCObjectType	getObjType () const

virtual int	getTag () const

virtual void	setTag (int nTag)

void	setObjType (CCObjectType)

Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

virtual void	setColor (const ccColor3B &color)=0
	Changes the color with R,G,B bytes. More...

virtual const ccColor3B &	getColor (void)=0
	Returns color that is currently used. More...

virtual const ccColor3B &	getDisplayedColor (void)=0
	Returns the displayed color. More...

virtual GLubyte	getDisplayedOpacity (void)=0
	Returns the displayed opacity. More...

virtual GLubyte	getOpacity (void)=0
	Returns the opacity. More...

virtual void	setOpacity (GLubyte opacity)=0
	Changes the opacity. More...

virtual void	setOpacityModifyRGB (bool bValue)=0
	Changes the OpacityModifyRGB property. More...

virtual bool	isOpacityModifyRGB (void)=0
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

virtual bool	isCascadeColorEnabled (void)=0
	whether or not color should be propagated to its children. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)=0

virtual void	updateDisplayedColor (const ccColor3B &color)=0
	recursive method that updates display color More...

virtual bool	isCascadeOpacityEnabled (void)=0
	whether or not opacity should be propagated to its children. More...

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)=0

virtual void	updateDisplayedOpacity (GLubyte opacity)=0
	recursive method that updates the displayed opacity. More...

virtual CCTexture2D *	getTexture (void)=0
	Returns the currently used texture. More...

virtual void	setTexture (CCTexture2D *texture)=0
	Sets a new texuture. More...

virtual void	setBlendFunc (ccBlendFunc blendFunc)=0
	Sets the source blending function. More...

virtual ccBlendFunc	getBlendFunc (void)=0
	Returns the blending function that is currently being used. More...

virtual void	setString (const char *label)=0
	Sets a new label using an string. More...

virtual const char *	getString (void)=0
	Returns the string that is currently being used in this label. More...

Static Public Member Functions
static CCLabelTTF *	create (const char string, const char fontName, float fontSize)
	creates a CCLabelTTF with a font name and font size in points More...

static CCLabelTTF *	create (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 CCLabelTTF *	create (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 CCLabelTTF *	createWithFontDefinition (const char *string, ccFontDefinition &textDefinition)
	Create a lable with string and a font definition. More...

static CCLabelTTF *	create ()
	Creates an label. More...

Static Public Member Functions inherited from CCSprite
static CCSprite *	create ()
	Creates an empty sprite without texture. More...

static CCSprite *	create (const char *pszFileName)
	Creates a sprite with an image filename. More...

static CCSprite *	create (const char *pszFileName, const CCRect &rect)
	Creates a sprite with an image filename and a rect. More...

static CCSprite *	createWithTexture (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...

static CCSprite *	createWithTexture (CCTexture2D *pTexture, const CCRect &rect)
	Creates a sprite with a texture and a rect. More...

static CCSprite *	createWithSpriteFrame (CCSpriteFrame *pSpriteFrame)
	Creates a sprite with an sprite frame. More...

static CCSprite *	createWithSpriteFrameName (const char *pszSpriteFrameName)
	Creates a sprite with an sprite frame name. More...

Static Public Member Functions inherited from CCNodeRGBA
static CCNodeRGBA *	create (void)
	Allocates and initializes a nodergba. More...

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

Static Public Member Functions inherited from CCObject
static CCObject *	createWithCoder (DS_Dictionary *)

Protected Member Functions
void	_updateWithTextDefinition (ccFontDefinition &textDefinition, bool mustUpdateTexture=true)
	set the text definition for this label More...

ccFontDefinition	_prepareTextDefinition (bool adjustForResolution=false)

Protected Member Functions inherited from CCSprite
void	updateColor (void)

virtual void	updateBlendFunc (void)

virtual void	setReorderChildDirtyRecursively (void)

virtual void	setDirtyRecursively (bool bValue)

virtual void	setTextureCoords (const CCRect &rect)

Protected Attributes
CCSize	m_tDimensions
	Dimensions of the label in Points. More...

CCTextAlignment	m_hAlignment
	The alignment of the label. More...

CCVerticalTextAlignment	m_vAlignment
	The vertical alignment of the label. More...

std::string *	m_pFontName
	Font name used in the label. More...

float	m_fFontSize
	Font size of the label. More...

std::string	m_string
	label's string More...

bool	m_shadowEnabled
	font shadow More...

CCSize	m_shadowOffset

float	m_shadowOpacity

float	m_shadowBlur

bool	m_strokeEnabled
	font stroke More...

ccColor3B	m_strokeColor

float	m_strokeSize

ccColor3B	m_textFillColor
	font tint More...

Protected Attributes inherited from CCSprite
CCTextureAtlas *	m_pobTextureAtlas

unsigned int	m_uAtlasIndex
	CCSpriteBatchNode texture atlas (weak reference) More...

CCSpriteBatchNode *	m_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...

bool	m_bHasChildren
	Whether all of the sprite's children needs to be updated. More...

bool	m_bShouldBeHidden
	Whether the sprite contains children. More...

CCAffineTransform	m_transformToBatch
	should not be drawn because one of the ancestors is not visible More...

ccBlendFunc	m_sBlendFunc

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

CCPoint	m_obUnflippedOffsetPositionFromCenter

ccV3F_C4B_T2F_Quad	m_sQuad

bool	m_bOpacityModifyRGB

bool	m_bFlipX

bool	m_bFlipY
	Whether the sprite is flipped horizaontally or not. More...

bool	m_bDontDraw
	Whether the sprite is flipped vertically or not. More...

float	m_fTlVertexMod
	Whether the sprite is flipped vertically or not. More...

float	m_fTrVertexMod
	Whether the sprite is flipped vertically or not. More...

float	m_fBlVertexMod
	Whether the sprite is flipped vertically or not. More...

float	m_fBrVertexMod
	Whether the sprite is flipped vertically 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...

float	m_fScaleX
	scaling factor on x-axis More...

float	m_fScaleY
	scaling factor on y-axis More...

float	m_fVertexZ
	OpenGL real Z vertex. More...

CCPoint	m_obPosition
	position of the node More...

float	m_fSkewX
	skew angle on x-axis More...

float	m_fSkewY
	skew angle on y-axis More...

CCPoint	m_obAnchorPointInPoints
	anchor point in points More...

CCPoint	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

CCSize	m_obContentSize
	untransformed size of the node More...

CCAffineTransform	m_sAdditionalTransform
	transform More...

CCAffineTransform	m_sTransform
	transform More...

CCAffineTransform	m_sInverse
	transform More...

CCCamera *	m_pCamera
	a camera More...

CCGridBase *	m_pGrid
	a grid More...

int	m_nZOrder
	z-order value that affects the draw order More...

CCArray *	m_pChildren
	array of children nodes More...

CCNode *	m_pParent
	weak reference to parent node More...

void *	m_pUserData
	A user assingned void pointer, Can be point to any cpp object. More...

CCObject *	m_pUserObject
	A user assigned CCObject. More...

CCGLProgram *	m_pShaderProgram
	OpenGL shader. More...

ccGLServerState	m_eGLServerState
	OpenGL servier side state. More...

unsigned int	m_uOrderOfArrival
	used to preserve sequence while sorting children with the same zOrder More...

CCScheduler *	m_pScheduler
	scheduler used to schedule timers and updates More...

CCActionManager *	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

bool	m_bRunning
	is running More...

bool	m_bTransformDirty
	transform dirty flag More...

bool	m_bInverseDirty
	transform dirty flag More...

bool	m_bAdditionalTransformDirty
	The flag to check whether the additional transform is dirty. More...

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

bool	m_bReorderChildDirty
	children order dirty flag More...

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

ccScriptType	m_eScriptType
	type of script binding, lua or javascript More...

CCComponentContainer *	m_pComponentContainer
	Dictionary of components. More...

Protected Attributes inherited from CCObject
unsigned int	m_uReference

unsigned int	m_uAutoReleaseCount

int	m_nTag

int	m_eObjType

unsigned int	m_uObjectIdxInArray

Additional Inherited Members
Public Attributes inherited from CCSprite
char	m_achPadding [16]

bool	m_bUnknown
	Whether the sprite is flipped vertically or not. More...

int	m_nUnknown
	Whether the sprite is flipped vertically or not. More...

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, 
                                         kCCTextAlignmentLeft, kCCVerticalTextAlignmentCenter);
CCLabelTTF *label2 = CCLabelTTF::create("alignment right", "/mnt/sdcard/Scissor Cuts.ttf", fontSize, blockSize,
                                         kCCTextAlignmentLeft, kCCVerticalTextAlignmentCenter);

Constructor & Destructor Documentation

◆ CCLabelTTF()

CCLabelTTF ( )

ctor

◆ ~CCLabelTTF()

virtual ~CCLabelTTF ( )

virtual

NA NA.

Member Function Documentation

◆ _prepareTextDefinition()

ccFontDefinition _prepareTextDefinition ( bool adjustForResolution = false )

protected

◆ _updateWithTextDefinition()

void _updateWithTextDefinition	(	ccFontDefinition &	textDefinition,
		bool	mustUpdateTexture = `true`
	)

protected

set the text definition for this label

◆ create() [1/4]

static CCLabelTTF * create ( )

static

Creates an label.

◆ create() [2/4]

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

◆ create() [3/4]

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

◆ create() [4/4]

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

◆ createWithFontDefinition()

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

static

Create a lable with string and a font definition.

◆ description()

const char * description ( )

NA NA.

◆ disableShadow()

void disableShadow ( bool mustUpdateTexture = true )

disable shadow rendering

◆ disableStroke()

void disableStroke ( bool mustUpdateTexture = true )

disable stroke

◆ enableShadow()

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

enable or disable shadow for the label

◆ enableStroke()

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

enable or disable stroke

◆ getDimensions()

CCSize getDimensions ( )

◆ getFontName()

const char * getFontName ( )

◆ getFontSize()

float getFontSize ( )

◆ getHorizontalAlignment()

CCTextAlignment getHorizontalAlignment ( )

◆ getString()

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.

◆ getTextDefinition()

ccFontDefinition * getTextDefinition ( )

get the text definition used by this label

◆ getVerticalAlignment()

CCVerticalTextAlignment getVerticalAlignment ( )

◆ init()

bool init ( )

virtual

initializes the CCLabelTTF

Reimplemented from CCSprite.

◆ initWithString() [1/3]

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

initializes the CCLabelTTF with a font name and font size

◆ initWithString() [2/3]

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

◆ initWithString() [3/3]

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

◆ initWithStringAndTextDefinition()

bool initWithStringAndTextDefinition	(	const char *	string,
		ccFontDefinition &	textDefinition
	)

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

◆ setDimensions()

void setDimensions ( const CCSize & dim )

◆ setFontFillColor()

void setFontFillColor	(	const ccColor3B &	tintColor,
		bool	mustUpdateTexture = `true`
	)

set text tinting

◆ setFontName()

void setFontName ( const char * fontName )

◆ setFontSize()

void setFontSize ( float fontSize )

◆ setHorizontalAlignment()

void setHorizontalAlignment ( CCTextAlignment alignment )

◆ setString()

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.

◆ setTextDefinition()

void setTextDefinition ( ccFontDefinition * theDefinition )

set the text definition used by this label

◆ setVerticalAlignment()

void setVerticalAlignment ( CCVerticalTextAlignment verticalAlignment )

Member Data Documentation

◆ m_fFontSize

float m_fFontSize

protected

Font size of the label.

◆ m_hAlignment

CCTextAlignment m_hAlignment

protected

The alignment of the label.

◆ m_pFontName

std::string* m_pFontName

protected

Font name used in the label.

◆ m_shadowBlur

float m_shadowBlur

protected

◆ m_shadowEnabled

bool m_shadowEnabled

protected

font shadow

◆ m_shadowOffset

CCSize m_shadowOffset

protected

◆ m_shadowOpacity

float m_shadowOpacity

protected

◆ m_string

std::string m_string

protected

label's string

◆ m_strokeColor

ccColor3B m_strokeColor

protected

◆ m_strokeEnabled

bool m_strokeEnabled

protected

font stroke

◆ m_strokeSize

float m_strokeSize

protected

◆ m_tDimensions

CCSize m_tDimensions

protected

Dimensions of the label in Points.

◆ m_textFillColor

ccColor3B m_textFillColor

protected

font tint

◆ m_vAlignment

CCVerticalTextAlignment m_vAlignment

protected

The vertical alignment of the label.

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

/home/runner/work/cocos-headers/cocos-headers/cocos2dx/label_nodes/CCLabelTTF.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CCLabelTTF()

◆ ~CCLabelTTF()

Member Function Documentation

◆ _prepareTextDefinition()

◆ _updateWithTextDefinition()

◆ create() [1/4]

◆ create() [2/4]

◆ create() [3/4]

◆ create() [4/4]

◆ createWithFontDefinition()

◆ description()

◆ disableShadow()

◆ disableStroke()

◆ enableShadow()

◆ enableStroke()

◆ getDimensions()

◆ getFontName()

◆ getFontSize()

◆ getHorizontalAlignment()

◆ getString()

◆ getTextDefinition()

◆ getVerticalAlignment()

◆ init()

◆ initWithString() [1/3]

◆ initWithString() [2/3]

◆ initWithString() [3/3]

◆ initWithStringAndTextDefinition()

◆ setDimensions()

◆ setFontFillColor()

◆ setFontName()

◆ setFontSize()

◆ setHorizontalAlignment()

◆ setString()

◆ setTextDefinition()

◆ setVerticalAlignment()

Member Data Documentation

◆ m_fFontSize

◆ m_hAlignment

◆ m_pFontName

◆ m_shadowBlur

◆ m_shadowEnabled

◆ m_shadowOffset

◆ m_shadowOpacity

◆ m_string

◆ m_strokeColor

◆ m_strokeEnabled

◆ m_strokeSize

◆ m_tDimensions

◆ m_textFillColor

◆ m_vAlignment