cocos2d-x  3.0-beta2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
LabelTTF Class Reference

LabelTTF is a subclass of TextureNode that knows how to render text labels. More...

#include <CCLabelTTF.h>

Inheritance diagram for LabelTTF:
Sprite LabelProtocol Node TextureProtocol Object BlendProtocol TextFieldTTF UICCTextField

Public Member Functions

 LabelTTF ()
 ctor ()
 LabelTTF ()
virtual ~LabelTTF ()
bool initWithString (const std::string &string, const std::string &fontName, float fontSize)
 initializes the LabelTTF with a font name and font size More...
 
bool initWithString (const std::string &string, const std::string &fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
bool initWithString (const std::string &string, const std::string &fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment, TextVAlignment vAlignment)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
bool initWithStringAndTextDefinition (const std::string &string, FontDefinition &textDefinition)
 initializes the LabelTTF with a font name, alignment, dimension and font size More...
 
void setTextDefinition (const FontDefinition &theDefinition)
 set the text definition used by this label More...
 
FontDefinition getTextDefinition ()
 get the text definition used by this label More...
 
void enableShadow (const Size &shadowOffset, float shadowOpacity, float shadowBlur, bool mustUpdateTexture=true)
 enable or disable shadow for the label More...
 
var enableShadow ( var shadowOffset, var shadowOpacity, var shadowBlur, var 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 Color3B &strokeColor, float strokeSize, bool mustUpdateTexture=true)
 enable or disable stroke More...
 
var enableStroke ( var strokeColor, var strokeSize, var 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...
 
var disableStroke ( var true)
 disable stroke More...
 
local disableStroke ( local true)
 disable stroke More...
 
void setFontFillColor (const Color3B &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 LabelTTF More...
 
virtual void setString (const std::string &label) override
 changes the string to render More...
 
local setString ( local label)
 changes the string to render More...
 
virtual const std::string & getString (void) const override
 Returns the string that is currently being used in this label. More...
 
local getString ()
 Returns the string that is currently being used in this label. More...
 
TextHAlignment getHorizontalAlignment () const
void setHorizontalAlignment (TextHAlignment alignment)
var setHorizontalAlignment ( var alignment)
local setHorizontalAlignment ( local alignment)
TextVAlignment getVerticalAlignment () const
var getVerticalAlignment ()
local getVerticalAlignment ()
void setVerticalAlignment (TextVAlignment verticalAlignment)
var setVerticalAlignment ( var verticalAlignment)
local setVerticalAlignment ( local verticalAlignment)
const SizegetDimensions () const
var getDimensions ()
local getDimensions ()
void setDimensions (const Size &dim)
local setDimensions ( local dim)
float getFontSize () const
void setFontSize (float fontSize)
var setFontSize ( var fontSize)
local setFontSize ( local fontSize)
const std::string & getFontName () const
void setFontName (const std::string &fontName)
var setFontName ( var fontName)
local setFontName ( local fontName)
virtual std::string getDescription () const override
 Gets the description string. More...
 
- Public Member Functions inherited from Sprite
CC_DEPRECATED_ATTRIBUTE bool isFlipY ()
local isFlipY ()
CC_DEPRECATED_ATTRIBUTE void setFlipY (bool flippedY)
local setFlipY ( local flippedY)
virtual void updateTransform (void)
 Updates the quad according the rotation, position, scale values. More...
 
var updateTransform ()
 Updates the quad according the rotation, position, scale values. More...
 
local updateTransform ()
 Updates the quad according the rotation, position, scale values. More...
 
virtual SpriteBatchNodegetBatchNode (void)
 Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...
 
var getBatchNode ()
 Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...
 
local getBatchNode ()
 Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...
 
virtual void setBatchNode (SpriteBatchNode *spriteBatchNode)
 Sets the batch node to sprite. More...
 
virtual void setTexture (const std::string &filename)
 Sets a new texture (from a filename) to the sprite. More...
 
local setTexture ( local filename)
 Sets a new texture (from a filename) to the sprite. More...
 
virtual void setTexture (Texture2D *texture) override
 Sets a new texture to the sprite. More...
 
virtual Texture2DgetTexture () const override
 returns the Texture2D object used by the sprite More...
 
var getTexture ()
 returns the Texture2D object used by the sprite More...
 
local getTexture ()
 returns the Texture2D object used by the sprite More...
 
virtual void setTextureRect (const Rect &rect)
 Updates the texture rect of the Sprite in points. More...
 
var setTextureRect ( var rect)
 Updates the texture rect of the Sprite in points. More...
 
local setTextureRect ( local rect)
 Updates the texture rect of the Sprite in points. More...
 
virtual void setTextureRect (const Rect &rect, bool rotated, const Size &untrimmedSize)
 Sets the texture rect, rectRotated and untrimmed size of the Sprite in points. More...
 
virtual void setVertexRect (const Rect &rect)
 Sets the vertex rect. More...
 
virtual void setSpriteFrame (const std::string &spriteFrameName)
 Sets a new SpriteFrame to the Sprite. More...
 
virtual void setSpriteFrame (SpriteFrame *newFrame)
var setSpriteFrame ( var newFrame)
local setSpriteFrame ( local newFrame)
virtual
CC_DEPRECATED_ATTRIBUTE void 
setDisplayFrame (SpriteFrame *newFrame)
local setDisplayFrame ( local newFrame)
virtual bool isFrameDisplayed (SpriteFrame *pFrame) const
 Returns whether or not a SpriteFrame is being displayed. More...
 
local isFrameDisplayed ( local pFrame)
 Returns whether or not a SpriteFrame is being displayed. More...
 
virtual SpriteFramegetSpriteFrame () const
 Returns the current displayed frame. More...
 
var getSpriteFrame ()
 Returns the current displayed frame. More...
 
local getSpriteFrame ()
 Returns the current displayed frame. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
SpriteFrame
getDisplayFrame () const
local getDisplayFrame ()
virtual
CC_DEPRECATED_ATTRIBUTE
SpriteFrame
displayFrame () const
local displayFrame ()
virtual void setDisplayFrameWithAnimationName (const std::string &animationName, ssize_t frameIndex)
 Changes the display frame with animation name and index. More...
 
var setDisplayFrameWithAnimationName ( var animationName, var 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) const
 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...
 
var setDirty ( var 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...
 
V3F_C4B_T2F_Quad getQuad (void) const
 Returns the quad (tex coords, vertex coords and color) information. More...
 
bool isTextureRectRotated (void) const
 Returns whether or not the texture rectangle is rotated. More...
 
local isTextureRectRotated ()
 Returns whether or not the texture rectangle is rotated. More...
 
ssize_t getAtlasIndex (void) const
 Returns the index used on the TextureAtlas. More...
 
var getAtlasIndex ()
 Returns the index used on the TextureAtlas. More...
 
local getAtlasIndex ()
 Returns the index used on the TextureAtlas. More...
 
void setAtlasIndex (ssize_t atlasIndex)
 Sets the index used on the TextureAtlas. More...
 
const RectgetTextureRect (void)
 Returns the rect of the Sprite in points. More...
 
var getTextureRect ()
 Returns the rect of the Sprite in points. More...
 
local getTextureRect ()
 Returns the rect of the Sprite in points. More...
 
TextureAtlasgetTextureAtlas (void)
 Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
void setTextureAtlas (TextureAtlas *pobTextureAtlas)
 Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
var setTextureAtlas ( var pobTextureAtlas)
 Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
local setTextureAtlas ( local pobTextureAtlas)
 Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode. More...
 
const PointgetOffsetPosition (void) const
 Gets the offset position of the sprite. More...
 
var getOffsetPosition ()
 Gets the offset position of the sprite. More...
 
local getOffsetPosition ()
 Gets the offset position of the sprite. More...
 
bool isFlippedX (void) const
 Returns the flag which indicates whether the sprite is flipped horizontally or not. More...
 
void setFlippedX (bool flippedX)
 Sets whether the sprite should be flipped horizontally or not. More...
 
CC_DEPRECATED_ATTRIBUTE bool isFlipX ()
CC_DEPRECATED_ATTRIBUTE void setFlipX (bool flippedX)
local setFlipX ( local flippedX)
bool isFlippedY (void) const
 Return the flag which indicates whether the sprite is flipped vertically or not. More...
 
void setFlippedY (bool flippedY)
 Sets whether the sprite should be flipped vertically or not. More...
 
void setBlendFunc (const BlendFunc &blendFunc) override
var setBlendFunc ( var blendFunc)
local setBlendFunc ( local blendFunc)
const BlendFuncgetBlendFunc () const override
 Returns the blending function that is currently being used. More...
 
virtual void setScaleX (float scaleX) override
 Changes the scale factor on X axis of this node. More...
 
local setScaleX ( local scaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual void setScaleY (float scaleY) override
 Changes the scale factor on Y axis of this node. More...
 
virtual void setScale (float scaleX, float scaleY) override
 Changes both X and Y scale factor of the node. More...
 
var setScale ( var scaleX, var scaleY)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local scaleX, local scaleY)
 Changes both X and Y scale factor of the node. More...
 
virtual void setPosition (const Point &pos) override
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setPosition (float x, float y) override
 Sets position in a more efficient way. More...
 
var setPosition ( var x, var 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 setRotation (float rotation) override
 Sets the rotation (angle) of the node in degrees. More...
 
var setRotation ( var rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual void setRotationX (float rotationX) override
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationY (float rotationY) override
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setSkewX (float sx) override
 Changes the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float sy) override
 Changes the Y skew angle of the node in degrees. More...
 
virtual void removeChild (Node *child, bool cleanup) override
 Removes a child from the container. More...
 
var removeChild ( var child, var cleanup)
 Removes a child from the container. More...
 
local removeChild ( local child, local cleanup)
 Removes a child from the container. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup) override
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildrenWithCleanup ( local cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int zOrder) override
 Reorders a child according to a new z value. More...
 
var reorderChild ( var child, var zOrder)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child, local zOrder)
 Reorders a child according to a new z value. More...
 
virtual void addChild (Node *child, int zOrder, int tag) override
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual void sortAllChildren () override
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual void setScale (float scale) override
 Changes both X and Y scale factor of the node. More...
 
virtual void setVertexZ (float vertexZ) override
 Sets the 'z' value in the OpenGL Depth Buffer. More...
 
local setVertexZ ( local vertexZ)
 Sets the 'z' value in the OpenGL Depth Buffer. More...
 
virtual void setAnchorPoint (const Point &anchor) override
 Sets the anchor point in percent. More...
 
virtual void ignoreAnchorPointForPosition (bool value) override
 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) override
 Sets whether the node is visible. More...
 
var setVisible ( var bVisible)
 Sets whether the node is visible. More...
 
local setVisible ( local bVisible)
 Sets whether the node is visible. More...
 
virtual void updateQuadVertices ()
var updateQuadVertices ()
local updateQuadVertices ()
virtual void draw (void) override
 Override this method to draw your own node. More...
 
var draw ()
 Override this method to draw your own node. More...
 
local draw ()
 Override this method to draw your own node. More...
 
virtual void setOpacityModifyRGB (bool modify) override
var setOpacityModifyRGB ( var modify)
local setOpacityModifyRGB ( local modify)
virtual bool isOpacityModifyRGB (void) const override
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node accepts event callbacks. More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local handler, local priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops all running actions and schedulers. More...
 
var cleanup ()
 Stops all running actions and schedulers. More...
 
local cleanup ()
 Stops all running actions and schedulers. More...
 
virtual void visit ()
 Visits this node's children and draw them recursively. More...
 
local visit ()
 Visits this node's children and draw them recursively. More...
 
virtual ScenegetScene ()
 Returns the Scene that contains the Node. More...
 
local getScene ()
 Returns the Scene that contains the Node. More...
 
virtual Rect getBoundingBox () const
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE Rect 
boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
var setEventDispatcher ( var dispatcher)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
var setPhysicsBody ( var body)
 set the PhysicsBody that let the sprite effect with physics More...
 
local setPhysicsBody ( local body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBody * getPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
var getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
local getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
virtual bool updatePhysicsTransform ()
 update rotation and position from physics body More...
 
var updatePhysicsTransform ()
 update rotation and position from physics body More...
 
local updatePhysicsTransform ()
 update rotation and position from physics body More...
 
virtual GLubyte getOpacity () const
virtual GLubyte getDisplayedOpacity () const
var getDisplayedOpacity ()
local getDisplayedOpacity ()
virtual void setOpacity (GLubyte opacity)
local setOpacity ( local opacity)
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
var updateDisplayedOpacity ( var parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual bool isCascadeOpacityEnabled () const
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3BgetColor (void) const
local getColor ()
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual void setColor (const Color3B &color)
var setColor ( var color)
local setColor ( local color)
virtual void updateDisplayedColor (const Color3B &parentColor)
var updateDisplayedColor ( var parentColor)
local updateDisplayedColor ( local parentColor)
virtual bool isCascadeColorEnabled () const
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setZOrder (int localZOrder)
local setZOrder ( local localZOrder)
virtual void _setLocalZOrder (int z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual CC_DEPRECATED_ATTRIBUTE int getZOrder () const
var getZOrder ()
local getZOrder ()
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual float getVertexZ () const
 Gets OpenGL Z vertex of this node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node. More...
 
var getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual const PointgetPosition () const
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
var getPosition ( var x, var y)
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
virtual const PointgetAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const PointgetAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual const SizegetContentSize () const
 Returns the untransformed size of the node. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual float getRotationX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indecates which children is added previously. More...
 
CC_DEPRECATED_ATTRIBUTE void setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int getGLServerState () const
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
var addChild ( var child)
 Adds a child to the container with z-order as 0. More...
 
local addChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
var addChild ( var child, var localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual NodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual Vector< Node * > & getChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual const Vector< Node * > & getChildren () const
local getChildren ()
virtual ssize_t getChildrenCount () const
 Get the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual ObjectgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
virtual GLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual const GLProgramgetShaderProgram () const
local getShaderProgram ()
virtual void setShaderProgram (GLProgram *shaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local shaderProgram)
 Sets the shader program for this node. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
local getActionManager ()
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
var runAction ( var action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
var getActionByTag ( var tag)
 Gets an action from the running action list by its tag. More...
 
local getActionByTag ( local tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE ssize_t numberOfRunningActions () const
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
var unscheduleAllSelectors ()
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
void transform ()
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual const kmMat4 & getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform () const
local getNodeToParentAffineTransform ()
virtual void setNodeToParentTransform (const kmMat4 &transform)
 Sets the Transformation matrix manually. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const kmMat4 & getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local getParentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
parentToNodeTransform () const
local parentToNodeTransform ()
virtual kmMat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual kmMat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Point convertToNodeSpace (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpace (const Point &nodePoint) const
 Converts a Point to world space coordinates. More...
 
Point convertToNodeSpaceAR (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
var convertToNodeSpaceAR ( var worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpaceAR ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpaceAR (const Point &nodePoint) const
 Converts a local Point to world space coordinates.The result is in Points. More...
 
Point convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Point More...
 
Point convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
 Sets an additional transform matrix to the node. More...
 
var setAdditionalTransform ( var additionalTransform)
 Sets an additional transform matrix to the node. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const kmMat4 &additionalTransform)
ComponentgetComponent (const std::string &pName)
 gets a component by its name More...
 
var getComponent ( var pName)
 gets a component by its name More...
 
local getComponent ( local pName)
 gets a component by its name More...
 
virtual bool addComponent (Component *pComponent)
 adds a component More...
 
var addComponent ( var pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const std::string &pName)
 removes a component by its name More...
 
var removeComponent ( var pName)
 removes a component by its name More...
 
local removeComponent ( local pName)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
unsigned int getReferenceCount () const
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
- Public Member Functions inherited from TextureProtocol
virtual ~TextureProtocol ()
- Public Member Functions inherited from BlendProtocol
virtual ~BlendProtocol ()
var ~BlendProtocol ()
local ~BlendProtocol ()
- Public Member Functions inherited from LabelProtocol
virtual ~LabelProtocol ()
var ~LabelProtocol ()
local ~LabelProtocol ()

Static Public Member Functions

static LabelTTFcreate (const std::string &string, const std::string &fontName, float fontSize)
 creates a LabelTTF with a font name and font size in points More...
 
var create ( var string, var fontName, var fontSize)
 creates a LabelTTF with a font name and font size in points More...
 
local create ( local string, local fontName, local fontSize)
 creates a LabelTTF with a font name and font size in points More...
 
static LabelTTFcreate (const std::string &string, const std::string &fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment)
 creates a LabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. More...
 
var create ( var string, var fontName, var fontSize, var dimensions, var hAlignment)
 creates a LabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. More...
 
local create ( local string, local fontName, local fontSize, local dimensions, local hAlignment)
 creates a LabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points. More...
 
static LabelTTFcreate (const std::string &string, const std::string &fontName, float fontSize, const Size &dimensions, TextHAlignment hAlignment, TextVAlignment vAlignment)
 creates a Label from a fontname, alignment, dimension in points and font size in points More...
 
var create ( var string, var fontName, var fontSize, var dimensions, var hAlignment, var vAlignment)
 creates a Label from a fontname, alignment, dimension in points and font size in points More...
 
local create ( local string, local fontName, local fontSize, local dimensions, local hAlignment, local vAlignment)
 creates a Label from a fontname, alignment, dimension in points and font size in points More...
 
static LabelTTFcreateWithFontDefinition (const std::string &string, FontDefinition &textDefinition)
 Create a lable with string and a font definition. More...
 
var createWithFontDefinition ( var string, var 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 LabelTTFcreate ()
 Creates an label. More...
 
var create ()
 Creates an label. More...
 
local create ()
 Creates an label. More...
 
- Static Public Member Functions inherited from Sprite
static Spritecreate ()
 Creates an empty sprite without texture. More...
 
var create ()
 Creates an empty sprite without texture. More...
 
local create ()
 Creates an empty sprite without texture. More...
 
static Spritecreate (const std::string &filename)
 Creates a sprite with an image filename. More...
 
local create ( local filename)
 Creates a sprite with an image filename. More...
 
static Spritecreate (const std::string &filename, const Rect &rect)
 Creates a sprite with an image filename and a rect. More...
 
var create ( var filename, var rect)
 Creates a sprite with an image filename and a rect. More...
 
local create ( local filename, local rect)
 Creates a sprite with an image filename and a rect. More...
 
static SpritecreateWithTexture (Texture2D *texture)
 Creates a sprite with an exsiting texture contained in a Texture2D object After creation, the rect will be the size of the texture, and the offset will be (0,0). More...
 
local createWithTexture ( local texture)
 Creates a sprite with an exsiting texture contained in a Texture2D object After creation, the rect will be the size of the texture, and the offset will be (0,0). More...
 
static SpritecreateWithTexture (Texture2D *texture, const Rect &rect, bool rotated=false)
 Creates a sprite with a texture and a rect. More...
 
local createWithTexture ( local texture, local rect, local false)
 Creates a sprite with a texture and a rect. More...
 
static SpritecreateWithSpriteFrame (SpriteFrame *pSpriteFrame)
 Creates a sprite with an sprite frame. More...
 
var createWithSpriteFrame ( var pSpriteFrame)
 Creates a sprite with an sprite frame. More...
 
local createWithSpriteFrame ( local pSpriteFrame)
 Creates a sprite with an sprite frame. More...
 
static SpritecreateWithSpriteFrameName (const std::string &spriteFrameName)
 Creates a sprite with an sprite frame name. More...
 
- Static Public Member Functions inherited from Node
static Nodecreate (void)
 Allocates and initializes a node. More...
 

Protected Member Functions

bool updateTexture ()
var updateTexture ()
local updateTexture ()
void _updateWithTextDefinition (const FontDefinition &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...
 
FontDefinition _prepareTextDefinition (bool adjustForResolution=false)
local _prepareTextDefinition ( local false)
- Protected Member Functions inherited from Sprite
 Sprite (void)
 Sprite ()
 Sprite ()
virtual ~Sprite (void)
var ~Sprite ()
local ~Sprite ()
virtual bool initWithTexture (Texture2D *texture)
 Initializes a sprite with a texture. More...
 
local initWithTexture ( local texture)
 Initializes a sprite with a texture. More...
 
virtual bool initWithTexture (Texture2D *texture, const Rect &rect)
 Initializes a sprite with a texture and a rect. More...
 
var initWithTexture ( var texture, var rect)
 Initializes a sprite with a texture and a rect. More...
 
local initWithTexture ( local texture, local rect)
 Initializes a sprite with a texture and a rect. More...
 
virtual bool initWithTexture (Texture2D *texture, const Rect &rect, bool rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
local initWithTexture ( local texture, local rect, local rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
virtual bool initWithSpriteFrame (SpriteFrame *pSpriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 
local initWithSpriteFrame ( local pSpriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 
virtual bool initWithSpriteFrameName (const std::string &spriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
var initWithSpriteFrameName ( var spriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
local initWithSpriteFrameName ( local spriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
virtual bool initWithFile (const std::string &filename)
 Initializes a sprite with an image filename. More...
 
virtual bool initWithFile (const std::string &filename, const Rect &rect)
 Initializes a sprite with an image filename, and a rect. More...
 
local init ( local filename, local rect)
 Initializes a sprite with an image filename, and a rect. More...
 
void updateColor (void)
var updateColor ()
local updateColor ()
virtual void setTextureCoords (Rect rect)
local setTextureCoords ( local rect)
virtual void updateBlendFunc (void)
virtual void setReorderChildDirtyRecursively (void)
local setReorderChildDirtyRecursively ()
virtual void setDirtyRecursively (bool bValue)
var setDirtyRecursively ( var bValue)
local setDirtyRecursively ( local bValue)
bool culling () const
- Protected Member Functions inherited from Node
 Node ()
 Node ()
 Node ()
virtual ~Node ()
local ~Node ()
void childrenAlloc (void)
 lazy allocs More...
 
var childrenAlloc ()
 lazy allocs More...
 
local childrenAlloc ()
 lazy allocs More...
 
void insertChild (Node *child, int z)
 helper that reorder a child More...
 
var insertChild ( var child, var z)
 helper that reorder a child More...
 
local insertChild ( local child, local z)
 helper that reorder a child More...
 
void detachChild (Node *child, ssize_t index, bool doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
var detachChild ( var child, var index, var doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
local detachChild ( local child, local index, local doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
Point convertToWindowSpace (const Point &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
var convertToWindowSpace ( var nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
local convertToWindowSpace ( local nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
virtual void updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
virtual void updateCascadeColor ()
virtual void disableCascadeColor ()

Protected Attributes

Size _dimensions
 Dimensions of the label in Points. More...
 
TextHAlignment _alignment
 The alignment of the label. More...
 
var _alignment
 The alignment of the label. More...
 
local _alignment
 The alignment of the label. More...
 
TextVAlignment _vAlignment
 The vertical alignment of the label. More...
 
var _vAlignment
 The vertical alignment of the label. More...
 
local _vAlignment
 The vertical alignment of the label. More...
 
std::string _fontName
 Font name used in the label. More...
 
var _fontName
 Font name used in the label. More...
 
local _fontName
 Font name used in the label. More...
 
float _fontSize
 Font size of the label. More...
 
var _fontSize
 Font size of the label. More...
 
local _fontSize
 Font size of the label. More...
 
std::string _string
 label's string More...
 
var _string
 label's string More...
 
local _string
 label's string More...
 
bool _shadowEnabled
 font shadow More...
 
var _shadowEnabled
 font shadow More...
 
local _shadowEnabled
 font shadow More...
 
Size _shadowOffset
float _shadowOpacity
var _shadowOpacity
local _shadowOpacity
float _shadowBlur
var _shadowBlur
local _shadowBlur
bool _strokeEnabled
 font stroke More...
 
var _strokeEnabled
 font stroke More...
 
local _strokeEnabled
 font stroke More...
 
Color3B _strokeColor
float _strokeSize
var _strokeSize
local _strokeSize
Color3B _textFillColor
 font tint More...
 
var _textFillColor
 font tint More...
 
local _textFillColor
 font tint More...
 
- Protected Attributes inherited from Sprite
TextureAtlas_textureAtlas
ssize_t _atlasIndex
 SpriteBatchNode texture atlas (weak reference) More...
 
var _atlasIndex
 SpriteBatchNode texture atlas (weak reference) More...
 
local _atlasIndex
 SpriteBatchNode texture atlas (weak reference) More...
 
SpriteBatchNode_batchNode
 Absolute (real) Index on the SpriteSheet. More...
 
var _batchNode
 Absolute (real) Index on the SpriteSheet. More...
 
local _batchNode
 Absolute (real) Index on the SpriteSheet. More...
 
bool _dirty
 Used batch node (weak reference) More...
 
var _dirty
 Used batch node (weak reference) More...
 
local _dirty
 Used batch node (weak reference) More...
 
bool _recursiveDirty
 Whether the sprite needs to be updated. More...
 
var _recursiveDirty
 Whether the sprite needs to be updated. More...
 
local _recursiveDirty
 Whether the sprite needs to be updated. More...
 
bool _shouldBeHidden
 Whether all of the sprite's children needs to be updated. More...
 
var _shouldBeHidden
 Whether all of the sprite's children needs to be updated. More...
 
local _shouldBeHidden
 Whether all of the sprite's children needs to be updated. More...
 
kmMat4 _transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
var _transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
local _transformToBatch
 should not be drawn because one of the ancestors is not visible More...
 
BlendFunc _blendFunc
var _blendFunc
local _blendFunc
Texture2D_texture
 It's required for TextureProtocol inheritance. More...
 
var _texture
 It's required for TextureProtocol inheritance. More...
 
local _texture
 It's required for TextureProtocol inheritance. More...
 
QuadCommand _quadCommand
 Texture2D object that is used to render the sprite. More...
 
var _quadCommand
 Texture2D object that is used to render the sprite. More...
 
local _quadCommand
 Texture2D object that is used to render the sprite. More...
 
Rect _rect
 quad command More...
 
var _rect
 quad command More...
 
local _rect
 quad command More...
 
bool _rectRotated
 Retangle of Texture2D. More...
 
var _rectRotated
 Retangle of Texture2D. More...
 
local _rectRotated
 Retangle of Texture2D. More...
 
Point _offsetPosition
 Whether the texture is rotated. More...
 
var _offsetPosition
 Whether the texture is rotated. More...
 
local _offsetPosition
 Whether the texture is rotated. More...
 
Point _unflippedOffsetPositionFromCenter
var _unflippedOffsetPositionFromCenter
local _unflippedOffsetPositionFromCenter
V3F_C4B_T2F_Quad _quad
var _quad
local _quad
bool _opacityModifyRGB
var _opacityModifyRGB
local _opacityModifyRGB
bool _flippedX
var _flippedX
local _flippedX
bool _flippedY
 Whether the sprite is flipped horizontally or not. More...
 
var _flippedY
 Whether the sprite is flipped horizontally or not. More...
 
local _flippedY
 Whether the sprite is flipped horizontally or not. More...
 
- Protected Attributes inherited from Node
float _rotationX
 rotation angle on x-axis More...
 
float _rotationY
 rotation angle on y-axis More...
 
var _rotationY
 rotation angle on y-axis More...
 
local _rotationY
 rotation angle on y-axis More...
 
float _scaleX
 scaling factor on x-axis More...
 
var _scaleX
 scaling factor on x-axis More...
 
local _scaleX
 scaling factor on x-axis More...
 
float _scaleY
 scaling factor on y-axis More...
 
var _scaleY
 scaling factor on y-axis More...
 
local _scaleY
 scaling factor on y-axis More...
 
Point _position
 position of the node More...
 
var _position
 position of the node More...
 
local _position
 position of the node More...
 
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Point _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Point _anchorPoint
 anchor point normalized (NOT in points) More...
 
var _anchorPoint
 anchor point normalized (NOT in points) More...
 
local _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
var _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
kmMat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
kmMat4 _additionalTransform
 transform More...
 
var _additionalTransform
 transform More...
 
local _additionalTransform
 transform More...
 
kmMat4 _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
kmMat4 _inverse
 inverse transform More...
 
var _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
var _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
local _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
int _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
var _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
local _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
float _globalZOrder
 Global order used to sort the node. More...
 
var _globalZOrder
 Global order used to sort the node. More...
 
local _globalZOrder
 Global order used to sort the node. More...
 
float _vertexZ
 OpenGL real Z vertex. More...
 
var _vertexZ
 OpenGL real Z vertex. More...
 
local _vertexZ
 OpenGL real Z vertex. More...
 
Vector< Node * > _children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
var _parent
 weak reference to parent node More...
 
local _parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Object_userObject
 A user assigned Object. More...
 
var _userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgram_shaderProgram
 OpenGL shader. More...
 
var _shaderProgram
 OpenGL shader. More...
 
local _shaderProgram
 OpenGL shader. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
var _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
local _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
var _scheduler
 scheduler used to schedule timers and updates More...
 
local _scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
var _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
EventDispatcher_eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
var _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
local _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
bool _running
 is running More...
 
bool _visible
 is this node visible More...
 
var _visible
 is this node visible More...
 
local _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
int _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
var _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType _scriptType
 type of script binding, lua or javascript More...
 
var _scriptType
 type of script binding, lua or javascript More...
 
local _scriptType
 type of script binding, lua or javascript More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
PhysicsBody * _physicsBody
 the physicsBody the node have More...
 
var _physicsBody
 the physicsBody the node have More...
 
local _physicsBody
 the physicsBody the node have More...
 
GLubyte _displayedOpacity
var _displayedOpacity
local _displayedOpacity
GLubyte _realOpacity
var _realOpacity
local _realOpacity
Color3B _displayedColor
var _displayedColor
local _displayedColor
Color3B _realColor
var _realColor
local _realColor
bool _cascadeColorEnabled
var _cascadeColorEnabled
local _cascadeColorEnabled
bool _cascadeOpacityEnabled
var _cascadeOpacityEnabled
local _cascadeOpacityEnabled
- Protected Attributes inherited from Object
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- Static Public Attributes inherited from Sprite
static const int INDEX_NOT_INITIALIZED = -1

Detailed Description

LabelTTF is a subclass of TextureNode that knows how to render text labels.

All features from TextureNode are valid in LabelTTF

LabelTTF objects are slow. Consider using LabelAtlas or LabelBMFont instead.

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

LabelTTF *label1 = LabelTTF::create("alignment left", "A Damn Mess", fontSize, blockSize,
TextHAlignment::LEFT, TextVAlignment::CENTER);
LabelTTF *label2 = LabelTTF::create("alignment right", "/mnt/sdcard/Scissor Cuts.ttf", fontSize, blockSize,
TextHAlignment::LEFT, TextVAlignment::CENTER);

Constructor & Destructor Documentation

LabelTTF ( )
var ctor ( )
local LabelTTF ( )
virtual ~LabelTTF ( )
virtual

Member Function Documentation

FontDefinition
_prepareTextDefinition
( bool  adjustForResolution = false)
protected
var _prepareTextDefinition ( var  adjustForResolution = false)
protected
local _prepareTextDefinition ( local  adjustForResolution = false)
protected
void _updateWithTextDefinition ( const FontDefinition 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 LabelTTF* create ( const std::string &  string,
const std::string &  fontName,
float  fontSize 
)
static

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

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

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

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

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

Since
v2.0.1
static LabelTTF* create ( const std::string &  string,
const std::string &  fontName,
float  fontSize,
const Size dimensions,
TextHAlignment  hAlignment 
)
static

creates a LabelTTF 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 LabelTTF 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 LabelTTF from a fontname, horizontal alignment, dimension in points, and font size in points.

Since
v2.0.1
static LabelTTF* create ( const std::string &  string,
const std::string &  fontName,
float  fontSize,
const Size dimensions,
TextHAlignment  hAlignment,
TextVAlignment  vAlignment 
)
static

creates a Label 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 Label 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 Label from a fontname, alignment, dimension in points and font size in points

Since
v2.0.1
static LabelTTF* create ( )
static

Creates an label.

var create ( )
static

Creates an label.

local create ( )
static

Creates an label.

static LabelTTF*
createWithFontDefinition
( const std::string &  string,
FontDefinition 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.

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 Size 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 Color3B 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

virtual std::string getDescription ( ) const
overridevirtual

Gets the description string.

It makes debugging easier.

Returns
A string

Reimplemented from Sprite.

const Size& getDimensions ( ) const
var getDimensions ( )
local getDimensions ( )
const std::string& getFontName ( ) const
var getFontName ( )
local getFontName ( )
float getFontSize ( ) const
var getFontSize ( )
local getFontSize ( )
TextHAlignment
getHorizontalAlignment
( ) const
var getHorizontalAlignment ( )
local getHorizontalAlignment ( )
virtual const std::string&
getString
( void  ) const
overridevirtual

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

Returns
The string that is currently being used in this label

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

var getString (   )
overridevirtual

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

Returns
The string that is currently being used in this label

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

local getString (   )
overridevirtual

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

Returns
The string that is currently being used in this label

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

FontDefinition 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

TextVAlignment getVerticalAlignment ( ) const
var getVerticalAlignment ( )
local getVerticalAlignment ( )
bool init ( )
virtual

initializes the LabelTTF

Reimplemented from Sprite.

var init ( )
virtual

initializes the LabelTTF

Reimplemented from Sprite.

local init ( )
virtual

initializes the LabelTTF

Reimplemented from Sprite.

bool initWithString ( const std::string &  string,
const std::string &  fontName,
float  fontSize 
)

initializes the LabelTTF with a font name and font size

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

initializes the LabelTTF with a font name and font size

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

initializes the LabelTTF with a font name and font size

bool initWithString ( const std::string &  string,
const std::string &  fontName,
float  fontSize,
const Size dimensions,
TextHAlignment  hAlignment 
)

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

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

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

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

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

bool initWithString ( const std::string &  string,
const std::string &  fontName,
float  fontSize,
const Size dimensions,
TextHAlignment  hAlignment,
TextVAlignment  vAlignment 
)

initializes the LabelTTF 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 LabelTTF 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 LabelTTF with a font name, alignment, dimension and font size

bool
initWithStringAndTextDefinition
( const std::string &  string,
FontDefinition textDefinition 
)

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

var initWithStringAndTextDefinition ( var  string,
var  textDefinition 
)

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

local
initWithStringAndTextDefinition
( local  string,
local  textDefinition 
)

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

void setDimensions ( const Size dim)
var setDimensions ( var  dim)
local setDimensions ( local  dim)
void setFontFillColor ( const Color3B 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 std::string &  fontName)
var setFontName ( var  fontName)
local setFontName ( local  fontName)
void setFontSize ( float  fontSize)
var setFontSize ( var  fontSize)
local setFontSize ( local  fontSize)
void setHorizontalAlignment ( TextHAlignment  alignment)
var setHorizontalAlignment ( var  alignment)
local setHorizontalAlignment ( local  alignment)
virtual void setString ( const std::string &  label)
overridevirtual

changes the string to render

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

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

var setString ( var  label)
overridevirtual

changes the string to render

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

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

local setString ( local  label)
overridevirtual

changes the string to render

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

Implements LabelProtocol.

Reimplemented in TextFieldTTF.

void setTextDefinition ( const FontDefinition 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 ( TextVAlignment  verticalAlignment)
var setVerticalAlignment ( var  verticalAlignment)
local setVerticalAlignment ( local  verticalAlignment)
bool updateTexture ( )
protected
var updateTexture ( )
protected
local updateTexture ( )
protected

Member Data Documentation

TextHAlignment _alignment
protected

The alignment of the label.

var _alignment
protected

The alignment of the label.

local _alignment
protected

The alignment of the label.

Size _dimensions
protected

Dimensions of the label in Points.

std::string _fontName
protected

Font name used in the label.

var _fontName
protected

Font name used in the label.

local _fontName
protected

Font name used in the label.

float _fontSize
protected

Font size of the label.

var _fontSize
protected

Font size of the label.

local _fontSize
protected

Font size of the label.

float _shadowBlur
protected
var _shadowBlur
protected
local _shadowBlur
protected
bool _shadowEnabled
protected

font shadow

var _shadowEnabled
protected

font shadow

local _shadowEnabled
protected

font shadow

Size _shadowOffset
protected
var _shadowOffset
protected
local _shadowOffset
protected
float _shadowOpacity
protected
var _shadowOpacity
protected
local _shadowOpacity
protected
std::string _string
protected

label's string

var _string
protected

label's string

local _string
protected

label's string

Color3B _strokeColor
protected
var _strokeColor
protected
local _strokeColor
protected
bool _strokeEnabled
protected

font stroke

var _strokeEnabled
protected

font stroke

local _strokeEnabled
protected

font stroke

float _strokeSize
protected
var _strokeSize
protected
local _strokeSize
protected
Color3B _textFillColor
protected

font tint

var _textFillColor
protected

font tint

local _textFillColor
protected

font tint

TextVAlignment _vAlignment
protected

The vertical alignment of the label.

var _vAlignment
protected

The vertical alignment of the label.

local _vAlignment
protected

The vertical alignment of the label.


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