Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
TextFieldTTF Class Reference

A simple text input field with TTF font. More...

Inherits Label, and IMEDelegate.

Inherited by UICCTextField.

Public Member Functions

 TextFieldTTF ()
 Default constructor.
 
 ctor ()
 Default constructor.
 
 TextFieldTTF ()
 Default constructor.
 
virtual ~TextFieldTTF ()
 Default destructor.
 
bool initWithPlaceHolder (const std::string &placeholder, const Size &dimensions, TextHAlignment alignment, const std::string &fontName, float fontSize)
 Initializes the TextFieldTTF with a font name, alignment, dimension and font size. More...
 
var initWithPlaceHolder ( var placeholder, var dimensions, var alignment, var fontName, var fontSize)
 Initializes the TextFieldTTF with a font name, alignment, dimension and font size. More...
 
local initWithPlaceHolder ( local placeholder, local dimensions, local alignment, local fontName, local fontSize)
 Initializes the TextFieldTTF with a font name, alignment, dimension and font size. More...
 
bool initWithPlaceHolder (const std::string &placeholder, const std::string &fontName, float fontSize)
 Initializes the TextFieldTTF with a font name and font size. More...
 
virtual bool attachWithIME () override
 Open keyboard and receive input text.
 
virtual bool detachWithIME () override
 End text input and close keyboard.
 
var detachWithIME ()
 End text input and close keyboard.
 
local detachWithIME ()
 End text input and close keyboard.
 
std::size_t getCharCount () const
 Query the currently inputed character count. More...
 
local getCharCount ()
 Query the currently inputed character count. More...
 
virtual const Color4BgetColorSpaceHolder ()
 Query the color of place holder. More...
 
var getColorSpaceHolder ()
 Query the color of place holder. More...
 
local getColorSpaceHolder ()
 Query the color of place holder. More...
 
virtual void setColorSpaceHolder (const Color3B &color)
 Change input placeholder color. More...
 
local setColorSpaceHolder ( local color)
 Change input placeholder color. More...
 
virtual void setColorSpaceHolder (const Color4B &color)
 Change the placeholder color. More...
 
local setColorSpaceHolder ( local color)
 Change the placeholder color. More...
 
virtual void setTextColor (const Color4B &textColor) override
 Change the color of input text. More...
 
local setTextColor ( local textColor)
 Change the color of input text. More...
 
virtual void setString (const std::string &text) override
 Change input text of TextField. More...
 
var setString ( var text)
 Change input text of TextField. More...
 
local setString ( local text)
 Change input text of TextField. More...
 
virtual void appendString (const std::string &text)
 Append to input text of TextField. More...
 
virtual const std::string & getString () const override
 Query the input text of TextField. More...
 
local getString ()
 Query the input text of TextField. More...
 
virtual void setPlaceHolder (const std::string &text)
 Change placeholder text. More...
 
var setPlaceHolder ( var text)
 Change placeholder text. More...
 
local setPlaceHolder ( local text)
 Change placeholder text. More...
 
virtual const std::string & getPlaceHolder () const
 Query the placeholder string. More...
 
virtual void setSecureTextEntry (bool value)
 Set enable secure text entry representation. More...
 
local setSecureTextEntry ( local value)
 Set enable secure text entry representation. More...
 
virtual bool isSecureTextEntry () const
 Query whether the currently display mode is secure text entry or not. More...
 
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
 Visits this node's children and draw them recursively. More...
 
virtual void update (float delta) override
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
 
var update ( var delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
 
local update ( local delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
 
void setCursorEnabled (bool enabled)
 Set enable cursor use.
 
local setCursorEnabled ( local enabled)
 Set enable cursor use.
 
void setCursorChar (char cursor)
 Set char showing cursor.
 
void setCursorPosition (std::size_t cursorPosition)
 Set cursor position, if enabled. More...
 
local setCursorPosition ( local cursorPosition)
 Set cursor position, if enabled. More...
 
void setCursorFromPoint (const Vec2 &point, const Camera *camera)
 Set cursor position to hit letter, if enabled. More...
 
local setCursorFromPoint ( local point, local camera)
 Set cursor position to hit letter, if enabled. More...
 
- Public Member Functions inherited from Label
int getStringNumLines ()
 Return the number of lines of text.
 
local getStringNumLines ()
 Return the number of lines of text.
 
int getStringLength ()
 Return length of string.
 
local getStringLength ()
 Return length of string.
 
const Color4BgetTextColor () const
 Returns the text color of the Label. More...
 
local getTextColor ()
 Returns the text color of the Label. More...
 
virtual void enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Size &offset=Size(2,-2), int blurRadius=0)
 Enable shadow effect to Label. More...
 
virtual void enableOutline (const Color4B &outlineColor, int outlineSize=-1)
 Enable outline effect to Label. More...
 
local enableOutline ( local outlineColor, local 1)
 Enable outline effect to Label. More...
 
virtual void enableGlow (const Color4B &glowColor)
 Enable glow effect to Label. More...
 
void enableItalics ()
 Enable italics rendering.
 
local enableItalics ()
 Enable italics rendering.
 
void enableBold ()
 Enable bold rendering.
 
local enableBold ()
 Enable bold rendering.
 
void enableUnderline ()
 Enable underline.
 
local enableUnderline ()
 Enable underline.
 
void enableStrikethrough ()
 Enables strikethrough. More...
 
local enableStrikethrough ()
 Enables strikethrough. More...
 
virtual void disableEffect ()
 Disable all effect applied to Label. More...
 
virtual void disableEffect (LabelEffect effect)
 Disable effect to Label. More...
 
local disableEffect ( local effect)
 Disable effect to Label. More...
 
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.
 
local getShadowColor ()
 Return the shadow effect color value.
 
float 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 value.
 
local getEffectColor ()
 Return current effect color value.
 
void setAlignment (TextHAlignment hAlignment)
 Sets the Label's text horizontal alignment. More...
 
TextHAlignment getTextAlignment () const
 Returns the Label's text horizontal alignment. More...
 
local getTextAlignment ()
 Returns the Label's text horizontal alignment. More...
 
void setAlignment (TextHAlignment hAlignment, TextVAlignment vAlignment)
 Sets the Label's text alignment. More...
 
local setAlignment ( local hAlignment, local vAlignment)
 Sets the Label's text alignment. More...
 
void setHorizontalAlignment (TextHAlignment hAlignment)
 Sets the Label's text horizontal alignment. More...
 
local setHorizontalAlignment ( local hAlignment)
 Sets the Label's text horizontal alignment. More...
 
TextHAlignment getHorizontalAlignment () const
 Returns the Label's text horizontal alignment. More...
 
local getHorizontalAlignment ()
 Returns the Label's text horizontal alignment. More...
 
void setVerticalAlignment (TextVAlignment vAlignment)
 Sets the Label's text vertical alignment. More...
 
local setVerticalAlignment ( local vAlignment)
 Sets the Label's text vertical alignment. More...
 
TextVAlignment getVerticalAlignment () const
 Returns the Label's text vertical alignment. More...
 
void setLineBreakWithoutSpace (bool breakWithoutSpace)
 Specify what happens when a line is too long for Label. More...
 
local setLineBreakWithoutSpace ( local breakWithoutSpace)
 Specify what happens when a line is too long for Label. More...
 
void setMaxLineWidth (float maxLineWidth)
 Makes the Label at most this line untransformed width. More...
 
void 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...
 
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. More...
 
float getBMFontSize () const
 Return the user define BMFont size. More...
 
local getBMFontSize ()
 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...
 
void setHeight (float height)
 Makes the Label exactly this untransformed height. More...
 
local setHeight ( local height)
 Makes the Label exactly this untransformed height. More...
 
void setDimensions (float width, float height)
 Sets the untransformed size of the Label in a more efficient way. More...
 
local setDimensions ( local width, local height)
 Sets the untransformed size of the Label in a more efficient way. More...
 
virtual void updateContent ()
 Update content immediately. More...
 
local updateContent ()
 Update content immediately. More...
 
virtual SpritegetLetter (int lettetIndex)
 Provides a way to treat each character like a Sprite. More...
 
void setClipMarginEnabled (bool clipEnabled)
 Clips upper and lower margin to reduce height 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...
 
virtual bool isOpacityModifyRGB () const override
 If node opacity will modify the RGB color value, then you should override this method and return true. More...
 
virtual void setOpacityModifyRGB (bool isOpacityModifyRGB) override
 If you want the opacity affect the color property, then set to true. More...
 
local setOpacityModifyRGB ( local isOpacityModifyRGB)
 If you want the opacity affect the color property, then set to true. More...
 
virtual void updateDisplayedColor (const Color3B &parentColor) override
 Update node's displayed color with its parent color. More...
 
local updateDisplayedColor ( local parentColor)
 Update node's displayed color with its parent color. More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity) override
 Update the displayed opacity of node with it's parent opacity;. More...
 
local updateDisplayedOpacity ( local parentOpacity)
 Update the displayed opacity of node with it's parent opacity;. More...
 
virtual std::string getDescription () const override
 Gets the description string. More...
 
local getDescription ()
 Gets the description string. More...
 
virtual const Size & getContentSize () const override
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual Rect getBoundingBox () const override
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
local getBoundingBox ()
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual void 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 setCameraMask (unsigned short mask, bool applyChildren=true) override
 Modify the camera mask for current node. More...
 
local setCameraMask ( local mask, local true)
 Modify the camera mask for current 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 order in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the order in which the nodes are renderer. More...
 
virtual bool setTTFConfig (const TTFConfig &ttfConfig)
 Sets a new TTF configuration to Label. More...
 
virtual const TTFConfiggetTTFConfig () const
 Returns the TTF configuration object used by the Label. More...
 
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. More...
 
local getBMFontFilePath ()
 Returns the bitmap font used by the Label. More...
 
virtual bool setCharMap (const std::string &charMapFile, int itemWidth, int itemHeight, int startCharMap)
 Sets a new char map configuration to Label. More...
 
virtual bool setCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
 Sets a new char map configuration to Label. More...
 
local setCharMap ( local texture, local itemWidth, local itemHeight, local startCharMap)
 Sets a new char map configuration to Label. More...
 
virtual bool setCharMap (const std::string &plistFile)
 Sets a new char map configuration to Label. More...
 
local setCharMap ( local plistFile)
 Sets a new char map configuration to Label. More...
 
virtual void setSystemFontName (const std::string &font)
 Sets a new system font to Label. More...
 
local setSystemFontName ( local font)
 Sets a new system font to Label. More...
 
virtual const std::string & getSystemFontName () const
 Returns the system font used by the Label. More...
 
local getSystemFontName ()
 Returns the system font used by the Label. More...
 
virtual void setSystemFontSize (float fontSize)
local setSystemFontSize ( local fontSize)
virtual float getSystemFontSize () const
 Returns the bitmap font path used by the Label. More...
 
local getSystemFontSize ()
 Returns the bitmap font path used by the Label. More...
 
virtual void requestSystemFontRefresh ()
local requestSystemFontRefresh ()
- Public Member Functions inherited from 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...
 
virtual void cleanup ()
 Stops all running actions and schedulers.
 
virtual ScenegetScene () const
 Returns the Scene that contains the Node. More...
 
local getScene ()
 Returns the Scene that contains the Node. More...
 
virtual Rect boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
 Set event dispatcher for scene. More...
 
var setEventDispatcher ( var dispatcher)
 Set event dispatcher for scene. More...
 
local setEventDispatcher ( local dispatcher)
 Set event dispatcher for scene. More...
 
virtual EventDispatchergetEventDispatcher () const
 Get the event dispatcher of scene. More...
 
local getEventDispatcher ()
 Get the event dispatcher of scene. More...
 
virtual GLubyte getOpacity () const
 Return the node's opacity. More...
 
local getOpacity ()
 Return the node's opacity. More...
 
virtual GLubyte getDisplayedOpacity () const
 Return the node's display opacity. More...
 
local getDisplayedOpacity ()
 Return the node's display opacity. More...
 
virtual void setOpacity (GLubyte opacity)
 Change node opacity. More...
 
virtual bool isCascadeOpacityEnabled () const
 Whether cascadeOpacity is enabled or not. More...
 
var isCascadeOpacityEnabled ()
 Whether cascadeOpacity is enabled or not. More...
 
local isCascadeOpacityEnabled ()
 Whether cascadeOpacity is enabled or not. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
 Change node's cascadeOpacity property. More...
 
local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
 Change node's cascadeOpacity property. More...
 
virtual const Color3BgetColor () const
 Query node's color value. More...
 
local getColor ()
 Query node's color value. More...
 
virtual const Color3BgetDisplayedColor () const
 Query node's displayed color. More...
 
local getDisplayedColor ()
 Query node's displayed color. More...
 
virtual void setColor (const Color3B &color)
 Change the color of node. More...
 
var setColor ( var color)
 Change the color of node. More...
 
local setColor ( local color)
 Change the color of node. More...
 
virtual bool isCascadeColorEnabled () const
 Query whether cascadeColor is enabled or not. More...
 
var isCascadeColorEnabled ()
 Query whether cascadeColor is enabled or not. More...
 
local isCascadeColorEnabled ()
 Query whether cascadeColor is enabled or not. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
 If you want node's color affect the children node's color, then set it to true. More...
 
void setOnEnterCallback (const std::function< void()> &callback)
 Set the callback of event onEnter. More...
 
const std::function< void()> & getOnEnterCallback () const
 Get the callback of event onEnter. More...
 
void setOnExitCallback (const std::function< void()> &callback)
 Set the callback of event onExit. More...
 
var setOnExitCallback ( var callback)
 Set the callback of event onExit. More...
 
local setOnExitCallback ( local callback)
 Set the callback of event onExit. More...
 
const std::function< void()> & getOnExitCallback () const
 Get the callback of event onExit. More...
 
local getOnExitCallback ()
 Get the callback of event onExit. More...
 
void setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
var setonEnterTransitionDidFinishCallback ( var callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
local setonEnterTransitionDidFinishCallback ( local callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
const std::function< void()> & getonEnterTransitionDidFinishCallback () const
 Get the callback of event EnterTransitionDidFinish. More...
 
void setonExitTransitionDidStartCallback (const std::function< void()> &callback)
 Set the callback of event ExitTransitionDidStart. More...
 
var setonExitTransitionDidStartCallback ( var callback)
 Set the callback of event ExitTransitionDidStart. More...
 
local setonExitTransitionDidStartCallback ( local callback)
 Set the callback of event ExitTransitionDidStart. More...
 
const std::function< void()> & getonExitTransitionDidStartCallback () const
 Get the callback of event ExitTransitionDidStart. More...
 
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 (std::int32_t localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void setZOrder (std::int32_t localZOrder)
virtual void _setLocalZOrder (std::int32_t z)
local _setLocalZOrder ( local z)
void updateOrderOfArrival ()
 !!! ONLY FOR INTERNAL USE Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual std::int32_t getLocalZOrder () const
 Gets the local Z order of this node. More...
 
virtual std::int32_t getZOrder () const
var getZOrder ()
local getZOrder ()
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
var getGlobalZOrder ()
 Returns the Node's Global Z Order. More...
 
local getGlobalZOrder ()
 Returns the Node's Global Z Order. More...
 
virtual void 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. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
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. More...
 
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. More...
 
virtual void setScale (float scale)
 Sets the scale (x,y,z) of the node. More...
 
var setScale ( var 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 setPositionNormalized (const Vec2 &position)
 Sets the position (x,y) using values between 0 and 1. More...
 
virtual void setNormalizedPosition (const Vec2 &position)
local setNormalizedPosition ( local position)
virtual const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
local getPosition ()
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getPositionNormalized () const
 Returns the normalized position. More...
 
virtual const Vec2getNormalizedPosition () const
virtual void setPosition (float x, float y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
local setPosition ( local x, local y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
var setPositionX ( var x)
 Gets/Sets x or y coordinate individually for position. More...
 
local setPositionX ( local x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) 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...
 
local setPositionY ( local 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...
 
var getPositionY ()
 Gets the y coordinate of the node in its parent's coordinate system. More...
 
local getPositionY ()
 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...
 
local setPosition3D ( local 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...
 
local getPosition3D ()
 Returns the position (X,Y,Z) in its parent's coordinate system. More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
var setVertexZ ( var positionZ)
 Sets the 'z' coordinate in the position. More...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual void setVertexZ (float vertexZ)
var setVertexZ ( var vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
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...
 
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...
 
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...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
local setRotation3D ( local rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vec3 getRotation3D () const
 Returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationQuat (const Quaternion &quat)
 Set rotation by quaternion. More...
 
virtual Quaternion getRotationQuat () const
 Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...
 
local getRotationQuat ()
 Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...
 
virtual void setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationX (float 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...
 
virtual float getRotationX () const
var getRotationX ()
local getRotationX ()
virtual void setRotationSkewY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationSkewY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setRotationY (float rotationY)
var setRotationY ( var 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 setGLServerState (int)
var setGLServerState ( var int)
int getGLServerState () const
virtual void setIgnoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local setIgnoreAnchorPointForPosition ( local ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void ignoreAnchorPointForPosition (bool ignore)
local ignoreAnchorPointForPosition ( local ignore)
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual 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...
 
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...
 
var getUserObject ()
 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...
 
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...
 
var 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
virtual ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list .
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
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 getNumberOfRunningActionsByTag (int tag) const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
 
local getNumberOfRunningActionsByTag ( local tag)
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. 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 Scheduler object. More...
 
local getScheduler ()
 Gets a Scheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector) const
 Checks whether a selector is scheduled. More...
 
bool isScheduled (const std::string &key) const
 Checks whether a lambda function is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
var scheduleUpdate ()
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
var scheduleUpdateWithPriority ( var priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
 Schedules a lambda function that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void schedule (const std::function< void(float)> &callback, const std::string &key)
 Schedules a lambda function. More...
 
var schedule ( var callback, var 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...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unschedule (const std::string &key)
 Unschedules a lambda function. More...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More...
 
void unscheduleAllSelectors ()
var unscheduleAllSelectors ()
local unscheduleAllSelectors ()
virtual void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
var resume ()
 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 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...
 
var getNodeToParentTransform ( var ancestor)
 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
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...
 
var convertToNodeSpace ( var worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
Vec2 convertToNodeSpaceAR (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpaceAR (const Vec2 &nodePoint) const
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
var convertToWorldSpaceAR ( var nodePoint)
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
local convertToWorldSpaceAR ( local nodePoint)
 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...
 
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 (const Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const Mat4 &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
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...
 
local getComponent ( local name)
 Gets a component by its name. More...
 
virtual bool addComponent (Component *component)
 Adds a component. More...
 
local addComponent ( local 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.
 
virtual void addChild (Node *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...
 
local getChildByTag ( local tag)
 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...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
local getChildByName ( local name)
 Gets a child from the container with its name. More...
 
template<typename T >
getChildByName (const std::string &name) const
 Gets a child from the container with its name that can be cast to Type T. More...
 
template<typename T >
var getChildByName ( var name)
 Gets a child from the container with its name that can be cast to Type T. More...
 
template<typename T >
local getChildByName ( local name)
 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
var getChildren ()
local getChildren ()
virtual ssize_t getChildrenCount () const
 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
local getParent ()
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...
 
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...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
var removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void reorderChild (Node *child, int localZOrder)
 Reorders a child according to a new z value. More...
 
var reorderChild ( var child, var localZOrder)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child, local 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...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local 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. More...
 
- Public Member Functions inherited from IMEDelegate
virtual ~IMEDelegate ()
 Default constructor.
 

Static Public Member Functions

static TextFieldTTFtextFieldWithPlaceHolder (const std::string &placeholder, const Size &dimensions, TextHAlignment alignment, const std::string &fontName, float fontSize)
 Creates a TextFieldTTF from a fontname, alignment, dimension and font size.
 
static TextFieldTTFtextFieldWithPlaceHolder (const std::string &placeholder, const std::string &fontName, float fontSize)
 Creates a TextFieldTTF from a fontname and font size.
 
local textFieldWithPlaceHolder ( local placeholder, local fontName, local fontSize)
 Creates a TextFieldTTF from a fontname and font size.
 
- Static Public Member Functions inherited from Label
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...
 
local createWithSystemFont ( local text, local font, local fontSize, local ZERO, local LEFT, local TOP)
 Allocates and initializes a Label, base on platform-dependent API. More...
 
static 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, base on FreeType2. More...
 
local createWithTTF ( local text, local fontFilePath, local fontSize, local ZERO, local LEFT, local TOP)
 Allocates and initializes a Label, base on FreeType2. More...
 
static 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...
 
local createWithCharMap ( local texture, local itemWidth, local itemHeight, local 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...
 
static int getAttachedNodeCount ()
 Gets count of nodes those are attached to scene graph.
 
var getAttachedNodeCount ()
 Gets count of nodes those are attached to scene graph.
 
local getAttachedNodeCount ()
 Gets count of nodes those are attached to scene graph.
 
template<typename _T >
static void sortNodes (cocos2d::Vector< _T * > &nodes)
 Sorts helper function. More...
 

Additional Inherited Members

- Public Types inherited from Label
enum  Overflow { , CLAMP, SHRINK, RESIZE_HEIGHT }
 
- 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.
 
- 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.
 
- Protected Member Functions inherited from Label
 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.
 

Detailed Description

A simple text input field with TTF font.

Member Function Documentation

bool initWithPlaceHolder ( const std::string &  placeholder,
const Size &  dimensions,
TextHAlignment  alignment,
const std::string &  fontName,
float  fontSize 
)

Initializes the TextFieldTTF with a font name, alignment, dimension and font size.

var initWithPlaceHolder ( var  placeholder,
var  dimensions,
var  alignment,
var  fontName,
var  fontSize 
)

Initializes the TextFieldTTF with a font name, alignment, dimension and font size.

local initWithPlaceHolder ( local  placeholder,
local  dimensions,
local  alignment,
local  fontName,
local  fontSize 
)

Initializes the TextFieldTTF with a font name, alignment, dimension and font size.

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

Initializes the TextFieldTTF with a font name and font size.

var initWithPlaceHolder ( var  placeholder,
var  fontName,
var  fontSize 
)

Initializes the TextFieldTTF with a font name and font size.

local initWithPlaceHolder ( local  placeholder,
local  fontName,
local  fontSize 
)

Initializes the TextFieldTTF with a font name and font size.

std::size_t getCharCount ( ) const
inline

Query the currently inputed character count.

Returns
The total input character count.
var getCharCount ( )
inline

Query the currently inputed character count.

Returns
The total input character count.
local getCharCount ( )
inline

Query the currently inputed character count.

Returns
The total input character count.
virtual const Color4B&
getColorSpaceHolder
( )
virtual

Query the color of place holder.

Returns
The place holder color.
var getColorSpaceHolder ( )
virtual

Query the color of place holder.

Returns
The place holder color.
local getColorSpaceHolder ( )
virtual

Query the color of place holder.

Returns
The place holder color.
virtual void setColorSpaceHolder ( const Color3B color)
virtual

Change input placeholder color.

Parameters
colorA color value in Color3B.
var setColorSpaceHolder ( var  color)
virtual

Change input placeholder color.

Parameters
colorA color value in Color3B.
local setColorSpaceHolder ( local  color)
virtual

Change input placeholder color.

Parameters
colorA color value in Color3B.
virtual void setColorSpaceHolder ( const Color4B color)
virtual

Change the placeholder color.

Parameters
colorThe placeholder color in Color4B.
var setColorSpaceHolder ( var  color)
virtual

Change the placeholder color.

Parameters
colorThe placeholder color in Color4B.
local setColorSpaceHolder ( local  color)
virtual

Change the placeholder color.

Parameters
colorThe placeholder color in Color4B.
virtual void setTextColor ( const Color4B textColor)
overridevirtual

Change the color of input text.

Parameters
textColorThe text color in Color4B.

Reimplemented from Label.

var setTextColor ( var  textColor)
overridevirtual

Change the color of input text.

Parameters
textColorThe text color in Color4B.

Reimplemented from Label.

local setTextColor ( local  textColor)
overridevirtual

Change the color of input text.

Parameters
textColorThe text color in Color4B.

Reimplemented from Label.

virtual void setString ( const std::string &  text)
overridevirtual

Change input text of TextField.

Parameters
textThe input text of TextField.

Reimplemented from Label.

var setString ( var  text)
overridevirtual

Change input text of TextField.

Parameters
textThe input text of TextField.

Reimplemented from Label.

local setString ( local  text)
overridevirtual

Change input text of TextField.

Parameters
textThe input text of TextField.

Reimplemented from Label.

virtual void appendString ( const std::string &  text)
virtual

Append to input text of TextField.

Parameters
textThe append text of TextField.
var appendString ( var  text)
virtual

Append to input text of TextField.

Parameters
textThe append text of TextField.
local appendString ( local  text)
virtual

Append to input text of TextField.

Parameters
textThe append text of TextField.
virtual const std::string&
getString
( ) const
overridevirtual

Query the input text of TextField.

Returns
Get the input text of TextField.

Reimplemented from Label.

var getString ( )
overridevirtual

Query the input text of TextField.

Returns
Get the input text of TextField.

Reimplemented from Label.

local getString ( )
overridevirtual

Query the input text of TextField.

Returns
Get the input text of TextField.

Reimplemented from Label.

virtual void setPlaceHolder ( const std::string &  text)
virtual

Change placeholder text.

place holder text displayed when there is no text in the text field.

Parameters
textThe placeholder string.
var setPlaceHolder ( var  text)
virtual

Change placeholder text.

place holder text displayed when there is no text in the text field.

Parameters
textThe placeholder string.
local setPlaceHolder ( local  text)
virtual

Change placeholder text.

place holder text displayed when there is no text in the text field.

Parameters
textThe placeholder string.
virtual const std::string&
getPlaceHolder
( ) const
virtual

Query the placeholder string.

Returns
The placeholder string.
var getPlaceHolder ( )
virtual

Query the placeholder string.

Returns
The placeholder string.
local getPlaceHolder ( )
virtual

Query the placeholder string.

Returns
The placeholder string.
virtual void setSecureTextEntry ( bool  value)
virtual

Set enable secure text entry representation.

If you want to display password in TextField, this option is very helpful.

Parameters
valueWhether or not to display text with secure text entry.
local setSecureTextEntry ( local  value)
virtual

Set enable secure text entry representation.

If you want to display password in TextField, this option is very helpful.

Parameters
valueWhether or not to display text with secure text entry.
virtual bool isSecureTextEntry ( ) const
virtual

Query whether the currently display mode is secure text entry or not.

Returns
Whether current text is displayed as secure text entry.
local isSecureTextEntry ( )
virtual

Query whether the currently display mode is secure text entry or not.

Returns
Whether current text is displayed as secure text entry.
virtual void visit ( Renderer *  renderer,
const Mat4 parentTransform,
uint32_t  parentFlags 
)
overridevirtual

Visits this node's children and draw them recursively.

Parameters
rendererA given renderer.
parentTransformA transform matrix.
parentFlagsRenderer flag.

Reimplemented from Label.

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

Visits this node's children and draw them recursively.

Parameters
rendererA given renderer.
parentTransformA transform matrix.
parentFlagsRenderer flag.

Reimplemented from Label.

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

Visits this node's children and draw them recursively.

Parameters
rendererA given renderer.
parentTransformA transform matrix.
parentFlagsRenderer flag.

Reimplemented from Label.

virtual void update ( float  delta)
overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters
deltaIn seconds.

Reimplemented from Node.

var update ( var  delta)
overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters
deltaIn seconds.

Reimplemented from Node.

local update ( local  delta)
overridevirtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters
deltaIn seconds.

Reimplemented from Node.

void setCursorPosition ( std::size_t  cursorPosition)

Set cursor position, if enabled.

local setCursorPosition ( local  cursorPosition)

Set cursor position, if enabled.

void setCursorFromPoint ( const Vec2 point,
const Camera camera 
)

Set cursor position to hit letter, if enabled.

local setCursorFromPoint ( local  point,
local  camera 
)

Set cursor position to hit letter, if enabled.


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