Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
Label Class Reference

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

Inherits Node, LabelProtocol, and BlendProtocol.

Inherited by TextFieldTTF.

Public Types

enum  Overflow { , SHRINK, CLAMP, RESIZE_HEIGHT }
 

Public Member Functions

virtual void setString (const std::string &text) override
 Sets the text that this Label is to display.
 
local setString ( local text)
 Sets the text that this Label is to display.
 
virtual const std::string & getString () const override
 Return the text the Label is displaying.
 
local getString ()
 Return the text the Label is displaying.
 
int getStringNumLines ()
 Get the string's display line number. More...
 
local getStringNumLines ()
 Get the string's display line number. More...
 
int getStringLength ()
 Get the string length. More...
 
local getStringLength ()
 Get the string length. More...
 
virtual void setTextColor (const Color4B &color)
 Sets the text color of Label. More...
 
local setTextColor ( local color)
 Sets the text color of Label. More...
 
const Color4BgetTextColor () const
 Returns the text color of the Label.
 
virtual void enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Size &offset=Size(2,-2), int blurRadius=0)
 Enable shadow effect to Label.
 
local enableShadow ( local BLACK, local 2, local 0)
 Enable shadow effect to Label.
 
virtual void enableOutline (const Color4B &outlineColor, int outlineSize=-1)
 Enable outline effect to Label. More...
 
virtual void enableGlow (const Color4B &glowColor)
 Enable glow effect to Label. More...
 
virtual void disableEffect ()
 Disable all effect to Label. More...
 
virtual void disableEffect (LabelEffect effect)
 Disable effect to Label.
 
bool isShadowEnabled () const
 Return whether the shadow effect is enabled.
 
local isShadowEnabled ()
 Return whether the shadow effect is enabled.
 
Size getShadowOffset () const
 Return shadow effect offset value.
 
local getShadowOffset ()
 Return shadow effect offset value.
 
float getShadowBlurRadius () const
 Return the shadow effect blur radius.
 
local getShadowBlurRadius ()
 Return the shadow effect blur radius.
 
Color4F getShadowColor () const
 Return the shadow effect color value.
 
int getOutlineSize () const
 Return the outline effect size value.
 
local getOutlineSize ()
 Return the outline effect size value.
 
LabelEffect getLabelEffectType () const
 Return current effect type.
 
local getLabelEffectType ()
 Return current effect type.
 
Color4F getEffectColor () const
 Return current effect color vlaue.
 
local getEffectColor ()
 Return current effect color vlaue.
 
void setAlignment (TextHAlignment hAlignment)
 Sets the Label's text horizontal alignment. More...
 
local setAlignment ( local hAlignment)
 Sets the Label's text horizontal alignment. More...
 
TextHAlignment getTextAlignment () const
 Returns the Label's text horizontal alignment.
 
void setAlignment (TextHAlignment hAlignment, TextVAlignment vAlignment)
 Sets the Label's text alignment.
 
local setAlignment ( local hAlignment, local vAlignment)
 Sets the Label's text alignment.
 
void setHorizontalAlignment (TextHAlignment hAlignment)
 Sets the Label's text horizontal alignment.
 
TextHAlignment getHorizontalAlignment () const
 Returns the Label's text horizontal alignment.
 
local getHorizontalAlignment ()
 Returns the Label's text horizontal alignment.
 
void setVerticalAlignment (TextVAlignment vAlignment)
 Sets the Label's text vertical alignment.
 
local setVerticalAlignment ( local vAlignment)
 Sets the Label's text vertical alignment.
 
TextVAlignment getVerticalAlignment () const
 Returns the Label's text vertical alignment.
 
void setLineBreakWithoutSpace (bool breakWithoutSpace)
 Specify what happens when a line is too long for Label. More...
 
void setMaxLineWidth (float maxLineWidth)
 Makes the Label at most this line untransformed width. More...
 
float getMaxLineWidth ()
 Return the maximize line width. More...
 
void setBMFontSize (float fontSize)
 Change font size of label type BMFONT Note: This function only scale the BMFONT letter to mimic the font size change effect. More...
 
float getBMFontSize () const
 Return the user define BMFont size. More...
 
void enableWrap (bool enable)
 Toggle wrap option of the label. More...
 
bool isWrapEnabled () const
 Query the wrap is enabled or not. More...
 
void setOverflow (Overflow overflow)
 Change the label's Overflow type, currently only TTF and BMFont support all the valid Overflow type. More...
 
Overflow getOverflow () const
 Query the label's Overflow type. More...
 
void setWidth (float width)
 Makes the Label exactly this untransformed width. More...
 
float getWidth () const
 Get the label width. More...
 
void setHeight (float height)
 Makes the Label exactly this untransformed height. More...
 
local setHeight ( local height)
 Makes the Label exactly this untransformed height. More...
 
float getHeight () const
 Get the label height. More...
 
local getHeight ()
 Get the label height. More...
 
void setDimensions (float width, float height)
 Sets the untransformed size of the Label in a more efficient way.
 
local setDimensions ( local width, local height)
 Sets the untransformed size of the Label in a more efficient way.
 
const SizegetDimensions () const
 Get the dimension of label. More...
 
virtual void updateContent ()
 Update content immediately.
 
local updateContent ()
 Update content immediately.
 
virtual SpritegetLetter (int lettetIndex)
 Provides a way to treats each character like a Sprite. More...
 
void setClipMarginEnabled (bool clipEnabled)
 Makes the Label to clip upper and lower margin for reduce height of Label.
 
bool isClipMarginEnabled () const
 Determines whether clipping upper and lower margin of label. More...
 
local isClipMarginEnabled ()
 Determines whether clipping upper and lower margin of label. More...
 
void setLineHeight (float height)
 Sets the line height of the Label. More...
 
local setLineHeight ( local height)
 Sets the line height of the Label. More...
 
float getLineHeight () const
 Returns the line height of this Label. More...
 
local getLineHeight ()
 Returns the line height of this Label. More...
 
void setAdditionalKerning (float space)
 Sets the additional kerning of the Label. More...
 
local setAdditionalKerning ( local space)
 Sets the additional kerning of the Label. More...
 
float getAdditionalKerning () const
 Returns the additional kerning of the Label. More...
 
local getAdditionalKerning ()
 Returns the additional kerning of the Label. More...
 
FontAtlas * getFontAtlas ()
 Get the font atlas A FontAtlas pointer.
 
local getFontAtlas ()
 Get the font atlas A FontAtlas pointer.
 
virtual std::string getDescription () const override
 Gets the description string. More...
 
local getDescription ()
 Gets the description string. More...
 
virtual const SizegetContentSize () const override
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual Rect getBoundingBox () const override
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
local getBoundingBox ()
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
 Visits this node's children and send their render command recursively. More...
 
local visit ( local renderer, local parentTransform, local parentFlags)
 Visits this node's children and send their render command recursively. More...
 
virtual void draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) override
 Override this method to draw your own node. More...
 
local draw ( local renderer, local transform, local flags)
 Override this method to draw your own node. More...
 
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 removeChild (Node *child, bool cleanup=true) override
 Removes a child from the container. More...
 
local removeChild ( local child, local true)
 Removes a child from the container. More...
 
virtual void setGlobalZOrder (float globalZOrder) override
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
Font methods
virtual bool setTTFConfig (const TTFConfig &ttfConfig)
 Sets a new TTF configuration to Label.
 
virtual const TTFConfiggetTTFConfig () const
 Returns the TTF configuration object used by the Label.
 
virtual bool setBMFontFilePath (const std::string &bmfontFilePath, const Vec2 &imageOffset=Vec2::ZERO, float fontSize=0)
 Sets a new bitmap font to Label.
 
const std::string & getBMFontFilePath () const
 Returns the bitmap font used by the Label.
 
virtual bool setCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
 Sets a new char map configuration to Label.
 
virtual bool setCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
 Sets a new char map configuration to Label.
 
local setCharMap ( local texture, local itemWidth, local itemHeight, local startCharMap)
 Sets a new char map configuration to Label.
 
virtual bool setCharMap (const std::string &plistFile)
 Sets a new char map configuration to Label.
 
virtual void setSystemFontName (const std::string &font)
 Sets a new system font to Label. More...
 
local setSystemFontName ( local font)
 Sets a new system font to Label. More...
 
virtual const std::string & getSystemFontName () const
 Returns the system font used by the Label.
 
local getSystemFontName ()
 Returns the system font used by the Label.
 
virtual void setSystemFontSize (float fontSize)
local setSystemFontSize ( local fontSize)
virtual float getSystemFontSize () const
 Returns the bitmap font path used by the Label.
 
local getSystemFontSize ()
 Returns the bitmap font path used by the Label.
 
virtual void requestSystemFontRefresh ()
local requestSystemFontRefresh ()
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
var isRunning ()
 Returns whether or not the node is "running". More...
 
local isRunning ()
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local handler, local priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops and removes all running actions and schedulers.
 
var cleanup ()
 Stops and removes all running actions and schedulers.
 
local cleanup ()
 Stops and removes all running actions and schedulers.
 
virtual ScenegetScene () const
 Returns the Scene that contains the Node. More...
 
virtual Rect boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
 Set event dispatcher for node. More...
 
virtual EventDispatchergetEventDispatcher () const
 Get the event dispatcher. More...
 
local getEventDispatcher ()
 Get the event dispatcher. More...
 
void setPhysicsBody (PhysicsBody *body)
 Set the PhysicsBody that let the sprite effect with physics. More...
 
PhysicsBodygetPhysicsBody () const
 Get the PhysicsBody the sprite have. More...
 
void removeFromPhysicsWorld ()
 Remove this node from physics world. More...
 
var removeFromPhysicsWorld ()
 Remove this node from physics world. More...
 
local removeFromPhysicsWorld ()
 Remove this node from physics world. More...
 
void updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
 Update the transform matrix from physics.
 
var updateTransformFromPhysics ( var parentTransform, var parentFlags)
 Update the transform matrix from physics.
 
local updateTransformFromPhysics ( local parentTransform, local parentFlags)
 Update the transform matrix from physics.
 
virtual void updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
 Update physics body transform matrix.
 
var updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
 Update physics body transform matrix.
 
local updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
 Update physics body transform matrix.
 
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
 
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void setZOrder (int localZOrder)
virtual void _setLocalZOrder (int z)
local _setLocalZOrder ( local z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual int getZOrder () const
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void setScaleX (float scaleX)
 Sets the scale (x) of the node. More...
 
local setScaleX ( local scaleX)
 Sets the scale (x) of the node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node The scale factor on X axis.
 
virtual void setScaleY (float scaleY)
 Sets the scale (y) of the node. More...
 
local setScaleY ( local scaleY)
 Sets the scale (y) of the node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node The scale factor on Y axis.
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
local setScaleZ ( local scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
virtual float getScaleZ () const
 Returns the scale factor on Z axis of this node The scale factor on Z axis.
 
virtual void setScale (float scale)
 Sets the scale (x,y,z) of the node. More...
 
local setScale ( local scale)
 Sets the scale (x,y,z) of the node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float scaleX, float scaleY)
 Sets the scale (x,y) of the node. More...
 
local setScale ( local scaleX, local scaleY)
 Sets the scale (x,y) of the node. More...
 
virtual void setPosition (const Vec2 &position)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void setNormalizedPosition (const Vec2 &position)
 Sets the position (x,y) using values between 0 and 1. More...
 
var setNormalizedPosition ( var position)
 Sets the position (x,y) using values between 0 and 1. More...
 
local setNormalizedPosition ( local position)
 Sets the position (x,y) using values between 0 and 1. More...
 
virtual const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getNormalizedPosition () const
 Returns the normalized position. More...
 
virtual void setPosition (float x, float y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
var setPosition ( var x, var y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
local setPosition ( local x, local y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Sets the x coordinate of the node in its parent's coordinate system. More...
 
virtual float getPositionX (void) const
 Gets the x coordinate of the node in its parent's coordinate system. More...
 
virtual void setPositionY (float y)
 Sets the y coordinate of the node in its parent's coordinate system. More...
 
virtual float getPositionY (void) const
 Gets the y coordinate of the node in its parent's coordinate system. More...
 
virtual void setPosition3D (const Vec3 &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
virtual Vec3 getPosition3D () const
 Returns the position (X,Y,Z) in its parent's coordinate system. More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual void setVertexZ (float vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
var getVertexZ ()
 Gets position Z coordinate of this node. More...
 
local getPositionZ ()
 Gets position Z coordinate of this node. More...
 
virtual float getVertexZ () const
virtual void setSkewX (float skewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local skewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
var getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local skewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
var getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const Vec2 &anchorPoint)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
var setContentSize ( var contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
var getRotation ()
 Returns the rotation of the node in degrees. More...
 
local getRotation ()
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
local setRotation3D ( local rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vec3 getRotation3D () const
 Returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationQuat (const Quaternion &quat)
 Set rotation by quaternion. More...
 
local setRotationQuat ( local quat)
 Set rotation by quaternion. More...
 
virtual Quaternion getRotationQuat () const
 Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, The rotation in quaternion.
 
virtual void setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationSkewX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationX (float rotationX)
var setRotationX ( var rotationX)
local setRotationX ( local rotationX)
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationX () const
virtual void setRotationSkewY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationSkewY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setRotationY (float rotationY)
local setRotationY ( local rotationY)
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local getRotationSkewY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY () const
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indicates which children is added previously. More...
 
void setGLServerState (int serverState)
var setGLServerState ( var serverState)
int getGLServerState () const
var getGLServerState ()
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
var addChild ( var child)
 Adds a child to the container with z-order as 0. More...
 
local addChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int localZOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local localZOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual void addChild (Node *child, int localZOrder, const std::string &name)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local localZOrder, local name)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetChildByTag (int tag) const
 Gets a child from the container with its tag. More...
 
template<typename T >
getChildByTag (int tag) const
 Gets a child from the container with its tag that can be cast to Type T. More...
 
template<typename T >
var getChildByTag ( var tag)
 Gets a child from the container with its tag that can be cast to Type T. More...
 
template<typename T >
local getChildByTag ( local tag)
 Gets a child from the container with its tag that can be cast to Type T. More...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
template<typename T >
getChildByName (const std::string &name) const
 Gets a child from the container with its name that can be cast to Type T. More...
 
virtual void enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
 Search the children of the receiving node to perform processing for nodes which share a name. More...
 
virtual Vector< Node * > & getChildren ()
 Returns the array of the node's children. More...
 
local getChildren ()
 Returns the array of the node's children. More...
 
virtual const Vector< Node * > & getChildren () const
local getChildren ()
virtual ssize_t getChildrenCount () const
 Returns the amount of children. More...
 
var getChildrenCount ()
 Returns the amount of children. More...
 
local getChildrenCount ()
 Returns the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
var getParent ()
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
var removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
local 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...
 
var removeChildByTag ( var tag, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
var removeChildByName ( var name, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByName ( local name, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup.
 
var removeAllChildren ()
 Removes all children from the container with a cleanup.
 
local removeAllChildren ()
 Removes all children from the container with a cleanup.
 
virtual void reorderChild (Node *child, int localZOrder)
 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...
 
local sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
var getTag ()
 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 const std::string & getName () const
 Returns a string that is used to identify the node. More...
 
local getName ()
 Returns a string that is used to identify the node. More...
 
virtual void setName (const std::string &name)
 Changes the name that is used to identify the node easily. More...
 
var setName ( var name)
 Changes the name that is used to identify the node easily. More...
 
local setName ( local name)
 Changes the name that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
GLProgramgetGLProgram () const
 Return the GLProgram (shader) currently used for this node. More...
 
var getGLProgram ()
 Return the GLProgram (shader) currently used for this node. More...
 
local getGLProgram ()
 Return the GLProgram (shader) currently used for this node. More...
 
GLProgramgetShaderProgram () const
var getShaderProgram ()
local getShaderProgram ()
virtual void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
local setGLProgram ( local glprogram)
 Sets the shader program for this node. More...
 
void setShaderProgram (GLProgram *glprogram)
var setShaderProgram ( var glprogram)
local setShaderProgram ( local glprogram)
GLProgramStategetGLProgramState () const
 Return the GLProgramState currently used for this node. More...
 
var getGLProgramState ()
 Return the GLProgramState currently used for this node. More...
 
local getGLProgramState ()
 Return the GLProgramState currently used for this node. More...
 
virtual void setGLProgramState (GLProgramState *glProgramState)
 Set the GLProgramState for this node. More...
 
local setGLProgramState ( local glProgramState)
 Set the GLProgramState for this node. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
var setActionManager ( var actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
local setActionManager ( local actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
local getActionManager ()
virtual 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 .
 
var stopAllActions ()
 Stops and removes all actions from the running action list .
 
local stopAllActions ()
 Stops and removes all actions from the running action list .
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
void stopAllActionsByTag (int tag)
 Removes all actions from the running action list by its tag. More...
 
var stopAllActionsByTag ( var tag)
 Removes all actions from the running action list by its tag. More...
 
local stopAllActionsByTag ( local tag)
 Removes all actions from the running action list by its tag. More...
 
void stopActionsByFlags (unsigned int flags)
 Removes all actions from the running action list by its flags. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
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...
 
bool isScheduled (const std::string &key)
 Checks whether a lambda function is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger The SEL_SCHEDULE selector to be scheduled. More...
 
void scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
 Schedules a lambda function that runs only once, with a delay of 0 or larger The lambda function to be scheduled. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void schedule (const std::function< void(float)> &callback, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
 Schedules a lambda function. More...
 
var schedule ( var callback, var interval, var repeat, var delay, var key)
 Schedules a lambda function. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
var unschedule ( var selector)
 Unschedules a custom selector. More...
 
void unschedule (const std::string &key)
 Unschedules a lambda function. More...
 
var unschedule ( var key)
 Unschedules a lambda function. More...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.
 
var unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.
 
void unscheduleAllSelectors ()
var unscheduleAllSelectors ()
local unscheduleAllSelectors ()
virtual void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
virtual void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
void resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
 
var update ( var delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
 
local update ( local delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
 
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const Mat4getNodeToParentTransform () 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 Mat4 getNodeToParentTransform (Node *ancestor) const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentTransform ( local ancestor)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform (Node *ancestor) const
 Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentAffineTransform ( local ancestor)
 Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual void setNodeToParentTransform (const Mat4 &transform)
 Sets the transformation matrix manually. More...
 
var setNodeToParentTransform ( var transform)
 Sets the transformation matrix manually. More...
 
local setNodeToParentTransform ( local transform)
 Sets the transformation matrix manually. More...
 
virtual AffineTransform nodeToParentTransform () const
local nodeToParentTransform ()
virtual const Mat4getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
var getParentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local getParentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual AffineTransform parentToNodeTransform () const
local parentToNodeTransform ()
virtual Mat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
var getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
local getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual AffineTransform nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
var getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual AffineTransform worldToNodeTransform () const
local worldToNodeTransform ()
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
Vec2 convertToNodeSpaceAR (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpaceAR (const Vec2 &nodePoint) const
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
Vec2 convertTouchToNodeSpace (Touch *touch) const
 Convenience methods which take a Touch instead of Vec2. More...
 
var convertTouchToNodeSpace ( var touch)
 Convenience methods which take a Touch instead of Vec2. More...
 
local convertTouchToNodeSpace ( local touch)
 Convenience methods which take a Touch instead of Vec2. More...
 
Vec2 convertTouchToNodeSpaceAR (Touch *touch) const
 Converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
Component * getComponent (const std::string &name)
 Gets a component by its name. More...
 
var getComponent ( var name)
 Gets a component by its name. More...
 
local getComponent ( local name)
 Gets a component by its name. More...
 
virtual bool addComponent (Component *component)
 Adds a component. More...
 
virtual bool removeComponent (const std::string &name)
 Removes a component by its name. More...
 
local removeComponent ( local name)
 Removes a component by its name. More...
 
virtual bool removeComponent (Component *component)
 Removes a component by its pointer. More...
 
local removeComponent ( local component)
 Removes a component by its pointer. More...
 
virtual void removeAllComponents ()
 Removes all components.
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Static Public Member Functions

Creators
static Labelcreate ()
 Allocates and initializes a Label, with default settings. More...
 
local create ()
 Allocates and initializes a Label, with default settings. More...
 
static LabelcreateWithSystemFont (const std::string &text, const std::string &font, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
 Allocates and initializes a Label, base on platform-dependent API. More...
 
static LabelcreateWithTTF (const std::string &text, const std::string &fontFilePath, float fontSize, const Size &dimensions=Size::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
 Allocates and initializes a Label, based on FreeType2. More...
 
local createWithTTF ( local text, local fontFilePath, local fontSize, local ZERO, local LEFT, local TOP)
 Allocates and initializes a Label, based on FreeType2. More...
 
static LabelcreateWithTTF (const TTFConfig &ttfConfig, const std::string &text, TextHAlignment hAlignment=TextHAlignment::LEFT, int maxLineWidth=0)
 Allocates and initializes a Label, base on FreeType2. More...
 
local createWithTTF ( local ttfConfig, local text, local LEFT, local 0)
 Allocates and initializes a Label, base on FreeType2. More...
 
static LabelcreateWithBMFont (const std::string &bmfontPath, const std::string &text, const TextHAlignment &hAlignment=TextHAlignment::LEFT, int maxLineWidth=0, const Vec2 &imageOffset=Vec2::ZERO)
 Allocates and initializes a Label, with a bitmap font file. More...
 
local createWithBMFont ( local bmfontPath, local text, local LEFT, local 0, local ZERO)
 Allocates and initializes a Label, with a bitmap font file. More...
 
static LabelcreateWithCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
 Allocates and initializes a Label, with char map configuration. More...
 
static LabelcreateWithCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
 Allocates and initializes a Label, with char map configuration. More...
 
static LabelcreateWithCharMap (const std::string &plistFile)
 Allocates and initializes a Label, with char map configuration. More...
 
- Static Public Member Functions inherited from Node
static Nodecreate ()
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Protected Member Functions

 Label (TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
 Constructor of Label.
 
 Label ( local LEFT, local TOP)
 Constructor of Label.
 
virtual ~Label ()
 Destructor of Label.
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes.
 
var INVALID_TAG = -1
 Default tag used for all the nodes.
 
local INVALID_TAG = -1
 Default tag used for all the nodes.
 

Detailed Description

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

Label can be created with:

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

Bitmap Font supported editors:

Member Function Documentation

static Label* create ( )
static

Allocates and initializes a Label, with default settings.

An automatically released Label object.

local create ( )
static

Allocates and initializes a Label, with default settings.

An automatically released Label object.

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

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

The initial text. A font file or a font family name. The font size. This value must be > 0. dimensions of the label node The text horizontal alignment. The text vertical alignment.

It will generate texture by the platform-dependent code.

An automatically released Label object.

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

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

The initial text. A font file or a font family name. The font size. This value must be > 0. dimensions of the label node The text horizontal alignment. The text vertical alignment.

It will generate texture by the platform-dependent code.

An automatically released Label object.

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

Allocates and initializes a Label, based on FreeType2.

The initial text. A font file. The font size. This value must be > 0. dimensions of the label node The text horizontal alignment. The text vertical alignment.

An automatically released Label object.

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

Allocates and initializes a Label, based on FreeType2.

The initial text. A font file. The font size. This value must be > 0. dimensions of the label node The text horizontal alignment. The text vertical alignment.

An automatically released Label object.

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

Allocates and initializes a Label, base on FreeType2.

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

An automatically released Label object.

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

Allocates and initializes a Label, base on FreeType2.

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

An automatically released Label object.

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

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

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

An automatically released Label object.

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

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

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

An automatically released Label object.

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

Allocates and initializes a Label, with char map configuration.

A char map file, it's a PNG format. The width in points of each element. The height in points of each element. The starting char of the char map.

An automatically released Label object.

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

Allocates and initializes a Label, with char map configuration.

A char map file, it's a PNG format. The width in points of each element. The height in points of each element. The starting char of the char map.

An automatically released Label object.

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

Allocates and initializes a Label, with char map configuration.

A pointer to an existing Texture2D object. The width in points of each element. The height in points of each element. The starting char of the char map.

An automatically released Label object.

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

Allocates and initializes a Label, with char map configuration.

A pointer to an existing Texture2D object. The width in points of each element. The height in points of each element. The starting char of the char map.

An automatically released Label object.

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

Allocates and initializes a Label, with char map configuration.

A configuration file of char map.

An automatically released Label object.

local createWithCharMap ( local  plistFile)
static

Allocates and initializes a Label, with char map configuration.

A configuration file of char map.

An automatically released Label object.

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

Sets a new system font to Label.

A font file or a font family name.

local setSystemFontName ( local  font)
virtual

Sets a new system font to Label.

A font file or a font family name.

virtual void
requestSystemFontRefresh
( )
inlinevirtual
Warning
This method is not recommended for game developers.
local requestSystemFontRefresh ( )
inlinevirtual
Warning
This method is not recommended for game developers.
int getStringNumLines ( )

Get the string's display line number.

Label line number.

local getStringNumLines ( )

Get the string's display line number.

Label line number.

int getStringLength ( )

Get the string length.

Label string length.

local getStringLength ( )

Get the string length.

Label string length.

virtual void setTextColor ( const Color4B color)
virtual

Sets the text color of Label.

The text color is different from the color of Node.

Limiting usage when the Label created with true type font or system font.

Reimplemented in TextFieldTTF.

local setTextColor ( local  color)
virtual

Sets the text color of Label.

The text color is different from the color of Node.

Limiting usage when the Label created with true type font or system font.

Reimplemented in TextFieldTTF.

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

Enable outline effect to Label.

Limiting use to only when the Label created with true type font or system font.

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

Enable outline effect to Label.

Limiting use to only when the Label created with true type font or system font.

virtual void enableGlow ( const Color4B glowColor)
virtual

Enable glow effect to Label.

Limiting use to only when the Label created with true type font.

local enableGlow ( local  glowColor)
virtual

Enable glow effect to Label.

Limiting use to only when the Label created with true type font.

virtual void disableEffect ( )
virtual

Disable all effect to Label.

Please use disableEffect(LabelEffect::ALL) instead of this API.

local disableEffect ( )
virtual

Disable all effect to Label.

Please use disableEffect(LabelEffect::ALL) instead of this API.

void setAlignment ( TextHAlignment  hAlignment)
inline

Sets the Label's text horizontal alignment.

local setAlignment ( local  hAlignment)
inline

Sets the Label's text horizontal alignment.

void setLineBreakWithoutSpace ( bool  breakWithoutSpace)

Specify what happens when a line is too long for Label.

Lines are automatically broken between words if this value is false.

local setLineBreakWithoutSpace ( local  breakWithoutSpace)

Specify what happens when a line is too long for Label.

Lines are automatically broken between words if this value is false.

void setMaxLineWidth ( float  maxLineWidth)

Makes the Label at most this line untransformed width.

The Label's max line width be used for force line breaks if the value not equal zero.

local setMaxLineWidth ( local  maxLineWidth)

Makes the Label at most this line untransformed width.

The Label's max line width be used for force line breaks if the value not equal zero.

float getMaxLineWidth ( )
inline

Return the maximize line width.

The maximize line width.

local getMaxLineWidth ( )
inline

Return the maximize line width.

The maximize line width.

void setBMFontSize ( float  fontSize)

Change font size of label type BMFONT Note: This function only scale the BMFONT letter to mimic the font size change effect.

Parameters
fontSizeThe desired font size in float.
local setBMFontSize ( local  fontSize)

Change font size of label type BMFONT Note: This function only scale the BMFONT letter to mimic the font size change effect.

Parameters
fontSizeThe desired font size in float.
float getBMFontSize ( ) const

Return the user define BMFont size.

Returns
The BMFont size in float value.
local getBMFontSize ( )

Return the user define BMFont size.

Returns
The BMFont size in float value.
void enableWrap ( bool  enable)

Toggle wrap option of the label.

Note: System font doesn't support manually toggle wrap.

Parameters
enableSet true to enable wrap and false to disable wrap.
local enableWrap ( local  enable)

Toggle wrap option of the label.

Note: System font doesn't support manually toggle wrap.

Parameters
enableSet true to enable wrap and false to disable wrap.
bool isWrapEnabled ( ) const

Query the wrap is enabled or not.

Note: System font will always return true.

local isWrapEnabled ( )

Query the wrap is enabled or not.

Note: System font will always return true.

void setOverflow ( Overflow  overflow)

Change the label's Overflow type, currently only TTF and BMFont support all the valid Overflow type.

Char Map font supports all the Overflow type except for SHRINK, because we can't measure it's font size. System font only support Overflow::Normal and Overflow::RESIZE_HEIGHT.

Parameters
overflowsee Overflow
local setOverflow ( local  overflow)

Change the label's Overflow type, currently only TTF and BMFont support all the valid Overflow type.

Char Map font supports all the Overflow type except for SHRINK, because we can't measure it's font size. System font only support Overflow::Normal and Overflow::RESIZE_HEIGHT.

Parameters
overflowsee Overflow
Overflow getOverflow ( ) const

Query the label's Overflow type.

Returns
see Overflow
local getOverflow ( )

Query the label's Overflow type.

Returns
see Overflow
void setWidth ( float  width)
inline

Makes the Label exactly this untransformed width.

The Label's width be used for text align if the value not equal zero.

local setWidth ( local  width)
inline

Makes the Label exactly this untransformed width.

The Label's width be used for text align if the value not equal zero.

float getWidth ( ) const
inline

Get the label width.

The line width.

local getWidth ( )
inline

Get the label width.

The line width.

void setHeight ( float  height)
inline

Makes the Label exactly this untransformed height.

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

local setHeight ( local  height)
inline

Makes the Label exactly this untransformed height.

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

float getHeight ( ) const
inline

Get the label height.

The line height.

local getHeight ( )
inline

Get the label height.

The line height.

const Size& getDimensions ( ) const
inline

Get the dimension of label.

the dimension in Size.

local getDimensions ( )
inline

Get the dimension of label.

the dimension in Size.

virtual Sprite* getLetter ( int  lettetIndex)
virtual

Provides a way to treats each character like a Sprite.

No support system font.

local getLetter ( local  lettetIndex)
virtual

Provides a way to treats each character like a Sprite.

No support system font.

bool isClipMarginEnabled ( ) const
inline

Determines whether clipping upper and lower margin of label.

Retuen true if enable clipping margin, otherwise return false.

local isClipMarginEnabled ( )
inline

Determines whether clipping upper and lower margin of label.

Retuen true if enable clipping margin, otherwise return false.

void setLineHeight ( float  height)

Sets the line height of the Label.

Not support system font.

local setLineHeight ( local  height)

Sets the line height of the Label.

Not support system font.

float getLineHeight ( ) const

Returns the line height of this Label.

Not support system font.

local getLineHeight ( )

Returns the line height of this Label.

Not support system font.

void setAdditionalKerning ( float  space)

Sets the additional kerning of the Label.

Not support system font.

local setAdditionalKerning ( local  space)

Sets the additional kerning of the Label.

Not support system font.

float getAdditionalKerning ( ) const

Returns the additional kerning of the Label.

Not support system font.

local getAdditionalKerning ( )

Returns the additional kerning of the Label.

Not support system font.

virtual std::string getDescription ( ) const
overridevirtual

Gets the description string.

It makes debugging easier. A string

Reimplemented from Node.

local getDescription ( )
overridevirtual

Gets the description string.

It makes debugging easier. A string

Reimplemented from Node.

virtual const Size& getContentSize ( ) const
overridevirtual

Returns the untransformed size of the node.

The untransformed size of the node.

Reimplemented from Node.

local getContentSize ( )
overridevirtual

Returns the untransformed size of the node.

The untransformed size of the node.

Reimplemented from Node.

virtual Rect getBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from Node.

local getBoundingBox ( )
overridevirtual

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

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

Reimplemented from Node.

virtual void visit ( Renderer *  renderer,
const Mat4 parentTransform,
uint32_t  parentFlags 
)
overridevirtual

Visits this node's children and send their render command recursively.

A given renderer. A transform matrix. Renderer flag.

Reimplemented from Node.

Reimplemented in TextFieldTTF.

local visit ( local  renderer,
local  parentTransform,
local  parentFlags 
)
overridevirtual

Visits this node's children and send their render command recursively.

A given renderer. A transform matrix. Renderer flag.

Reimplemented from Node.

Reimplemented in TextFieldTTF.

virtual void draw ( Renderer *  renderer,
const Mat4 transform,
uint32_t  flags 
)
overridevirtual

Override this method to draw your own node.

The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented from Node.

local draw ( local  renderer,
local  transform,
local  flags 
)
overridevirtual

Override this method to draw your own node.

The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented from Node.

virtual void
removeAllChildrenWithCleanup
( bool  cleanup)
overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

True if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Node.

local removeAllChildrenWithCleanup ( local  cleanup)
overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

True if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Node.

virtual void removeChild ( Node child,
bool  cleanup = true 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter. The child node which will be removed. True if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Node.

local removeChild ( local  child,
local  cleanup = true 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter. The child node which will be removed. True if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Node.

virtual void setGlobalZOrder ( float  globalZOrder)
overridevirtual

Defines the oder in which the nodes are renderer.

Nodes that have a Global Z Order lower, are renderer first.

In case two or more nodes have the same Global Z Order, the oder is not guaranteed. The only exception if the Nodes have a Global Z Order == 0. In that case, the Scene Graph order is used.

By default, all nodes have a Global Z Order = 0. That means that by default, the Scene Graph order is used to render the nodes.

Global Z Order is useful when you need to render nodes in an order different than the Scene Graph order.

Limitations: Global Z Order can't be used by Nodes that have SpriteBatchNode as one of their ancestors. And if ClippingNode is one of the ancestors, then "global Z order" will be relative to the ClippingNode. The global Z order value.

Reimplemented from Node.

local setGlobalZOrder ( local  globalZOrder)
overridevirtual

Defines the oder in which the nodes are renderer.

Nodes that have a Global Z Order lower, are renderer first.

In case two or more nodes have the same Global Z Order, the oder is not guaranteed. The only exception if the Nodes have a Global Z Order == 0. In that case, the Scene Graph order is used.

By default, all nodes have a Global Z Order = 0. That means that by default, the Scene Graph order is used to render the nodes.

Global Z Order is useful when you need to render nodes in an order different than the Scene Graph order.

Limitations: Global Z Order can't be used by Nodes that have SpriteBatchNode as one of their ancestors. And if ClippingNode is one of the ancestors, then "global Z order" will be relative to the ClippingNode. The global Z order value.

Reimplemented from Node.


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