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

#include <TextFieldTTF.h>

Public Member Functions
	TextFieldTTF ()
	Default constructor.

virtual	~TextFieldTTF ()
	Default destructor.

bool	initWithPlaceHolder (std::string_view placeholder, const Vec2 &dimensions, TextHAlignment alignment, std::string_view fontName, float fontSize)
	Initializes the TextFieldTTF with a font name, alignment, dimension and font size.

bool	initWithPlaceHolder (std::string_view placeholder, std::string_view fontName, float fontSize)
	Initializes the TextFieldTTF with a font name and font size.

virtual bool	attachWithIME () override
	Open keyboard and receive input text.

virtual bool	detachWithIME () override
	End text input and close keyboard.

TextFieldDelegate *	getDelegate () const
	@lua NA

void	setDelegate (TextFieldDelegate *delegate)
	@lua NA

std::size_t	getCharCount () const
	Query the currently inputed character count.

virtual const Color4B &	getColorSpaceHolder ()
	Query the color of place holder.

virtual void	setColorSpaceHolder (const Color3B &color)
	Change input placeholder color.

virtual void	setColorSpaceHolder (const Color4B &color)
	Change the placeholder color.

virtual void	setTextColor (const Color4B &textColor) override
	Change the color of input text.

virtual void	setString (std::string_view text) override
	Change input text of TextField.

virtual void	appendString (std::string_view text)
	Append to input text of TextField.

virtual std::string_view	getString () const override
	Query the input text of TextField.

virtual void	setPlaceHolder (std::string_view text)
	Change placeholder text.

virtual std::string_view	getPlaceHolder () const
	Query the placeholder string.

virtual void	setSecureTextEntry (bool value)
	Set enable secure text entry representation.

virtual bool	isSecureTextEntry () const
	Query whether the currently display mode is secure text entry or not.

virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
	Visits this node's children and draw them recursively.

virtual void	update (float delta) override
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

void	setCursorEnabled (bool enabled)
	Set enable cursor use.

void	setCursorChar (char cursor)
	Set char showing cursor.

void	setCursorPosition (std::size_t cursorPosition)
	Set cursor position, if enabled @js NA.

void	setCursorFromPoint (const Vec2 &point, const Camera *camera)
	Set cursor position to hit letter, if enabled @js NA.

Public Member Functions inherited from Label
int	getStringNumLines ()
	Return the number of lines of text.

int	getStringLength ()
	Return length of string.

const Color4B &	getTextColor () const
	Returns the text color of the Label.

virtual void	enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Vec2 &offset=Vec2(2, -2), int blurRadius=0)
	Enable shadow effect to Label.

virtual void	enableOutline (const Color4B &outlineColor, int outlineSize=-1)
	Enable outline effect to Label.

virtual void	enableGlow (const Color4B &glowColor)
	Enable glow effect to Label.

void	enableItalics ()
	Enable italics rendering.

void	enableBold ()
	Enable bold rendering.

void	enableUnderline ()
	Enable underline.

void	enableStrikethrough ()
	Enables strikethrough.

virtual void	disableEffect ()
	Disable all effect applied to Label.

virtual void	disableEffect (LabelEffect effect)
	Disable effect to Label.

bool	isShadowEnabled () const
	Return whether the shadow effect is enabled.

Vec2	getShadowOffset () const
	Return shadow effect offset value.

float	getShadowBlurRadius () const
	Return the shadow effect blur radius.

Color4F	getShadowColor () const
	Return the shadow effect color value.

float	getOutlineSize () const
	Return the outline effect size value.

LabelEffect	getLabelEffectType () const
	Return current effect type.

Color4F	getEffectColor () const
	Return current effect color value.

void	setAlignment (TextHAlignment hAlignment)
	Sets the Label's text horizontal alignment.

TextHAlignment	getTextAlignment () const
	Returns the Label's text horizontal alignment.

void	setAlignment (TextHAlignment hAlignment, TextVAlignment 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.

void	setVerticalAlignment (TextVAlignment 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.

void	setMaxLineWidth (float maxLineWidth)
	Makes the Label at most this line untransformed width.

void	setTTFFaceSize (int faceSize)
	Set the ttf/ttc font face size to determine how big to generate SDF bitmap since axmol-2.1.0.

int	getTTFFaceSize () const
	Gets ttf/ttc font face size, since axmol-2.1.0.

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.

float	getBMFontSize () const
	Return the user define BMFont size.

void	enableWrap (bool enable)
	Toggle wrap option of the label.

bool	isWrapEnabled () const
	Query the wrap is enabled or not.

void	setOverflow (Overflow overflow)
	Change the label's Overflow type, currently only TTF and BMFont support all the valid Overflow type.

Overflow	getOverflow () const
	Query the label's Overflow type.

void	setWidth (float width)
	Makes the Label exactly this untransformed width.

void	setHeight (float height)
	Makes the Label exactly this untransformed height.

void	setDimensions (float width, float height)
	Sets the untransformed size of the Label in a more efficient way.

virtual void	updateContent ()
	Update content immediately.

virtual Sprite *	getLetter (int lettetIndex)
	Provides a way to treat each character like a Sprite.

void	setClipMarginEnabled (bool clipEnabled)
	Clips upper and lower margin to reduce height of Label.

void	setLineHeight (float height)
	Sets the line height of the Label.

float	getLineHeight () const
	Returns the line height of this Label.

LabelType	getLabelType () const
	Returns type of label.

float	getRenderingFontSize () const
	Returns font size.

void	setAdditionalKerning (float space)
	Sets the additional kerning of the Label.

float	getAdditionalKerning () const
	Returns the additional kerning of the Label.

bool	setProgramState (backend::ProgramState *programState, bool ownPS=false) override
	Sets ProgramState with retain.

virtual bool	isOpacityModifyRGB () const override
	If node opacity will modify the RGB color value, then you should override this method and return true.

virtual void	setOpacityModifyRGB (bool isOpacityModifyRGB) override
	If you want the opacity affect the color property, then set to true.

virtual void	updateDisplayedColor (const Color3B &parentColor) override
	Update node's displayed color with its parent color.

virtual void	updateDisplayedOpacity (uint8_t parentOpacity) override
	Update the displayed opacity of node with it's parent opacity;.

virtual std::string	getDescription () const override
	Gets the description string.

virtual const Vec2 &	getContentSize () const override
	Returns the untransformed size of the node.

virtual Rect	getBoundingBox () const override
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

virtual void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) override
	Override this method to draw your own node.

virtual void	setCameraMask (unsigned short mask, bool applyChildren=true) override
	Modify the camera mask for current node.

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.

virtual void	removeChild (Node *child, bool cleanup=true) override
	Removes a child from the container.

virtual void	setGlobalZOrder (float globalZOrder) override
	Defines the order in which the nodes are renderer.

	Label (TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
	Constructor of Label.

virtual	~Label ()
	Destructor of Label.

virtual bool	setTTFConfig (const TTFConfig &ttfConfig)
	Sets a new TTF configuration to Label.

virtual const TTFConfig &	getTTFConfig () const
	Returns the TTF configuration object used by the Label.

virtual bool	setBMFontFilePath (std::string_view bmfontFilePath, float fontSize=0)
	Sets a new bitmap font to Label.

virtual bool	setBMFontFilePath (std::string_view bmfontFilePath, const Rect &imageRect, bool imageRotated, float fontSize=0)
	Sets a new bitmap font to Label.

virtual bool	setBMFontFilePath (std::string_view bmfontFilePath, std::string_view subTextureKey, float fontSize=0)
	Sets a new bitmap font to Label.

AX_DEPRECATED(2.1) virtual bool setBMFontFilePath(std std::string_view	getBMFontFilePath () const
	Sets a new bitmap font to Label.

virtual bool	setCharMap (std::string_view 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.

virtual bool	setCharMap (std::string_view plistFile)
	Sets a new char map configuration to Label.

virtual void	setSystemFontName (std::string_view font)
	Sets a new system font to Label.

virtual std::string_view	getSystemFontName () const
	Returns the system font used by the Label.

virtual float	getSystemFontSize () const
	Returns the bitmap font path used by the Label.

virtual void	requestSystemFontRefresh ()

Public Member Functions inherited from Node
virtual bool	isRunning () const
	Returns whether or not the node is "running".

void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script.

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

virtual Scene *	getScene () const
	Returns the Scene that contains the Node.

virtual void	setEventDispatcher (EventDispatcher *dispatcher)
	Set event dispatcher for scene.

virtual EventDispatcher *	getEventDispatcher () const
	Get the event dispatcher of scene.

virtual uint8_t	getOpacity () const
	Return the node's opacity.

virtual uint8_t	getDisplayedOpacity () const
	Return the node's display opacity.

virtual void	setOpacity (uint8_t opacity)
	Change node opacity.

virtual bool	isCascadeOpacityEnabled () const
	Whether cascadeOpacity is enabled or not.

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
	Change node's cascadeOpacity property.

virtual const Color3B &	getColor () const
	Query node's color value.

virtual const Color3B &	getDisplayedColor () const
	Query node's displayed color.

virtual void	setColor (const Color3B &color)
	Change the color of node.

virtual bool	isCascadeColorEnabled () const
	Query whether cascadeColor is enabled or not.

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
	If you want node's color affect the children node's color, then set it to true.

void	setOnEnterCallback (const std::function< void()> &callback)
	Set the callback of event onEnter.

const std::function< void()> &	getOnEnterCallback () const
	Get the callback of event onEnter.

void	setOnExitCallback (const std::function< void()> &callback)
	Set the callback of event onExit.

const std::function< void()> &	getOnExitCallback () const
	Get the callback of event onExit.

void	setOnEnterTransitionDidFinishCallback (const std::function< void()> &callback)
	Set the callback of event EnterTransitionDidFinish.

const std::function< void()> &	getOnEnterTransitionDidFinishCallback () const
	Get the callback of event EnterTransitionDidFinish.

void	setOnExitTransitionDidStartCallback (const std::function< void()> &callback)
	Set the callback of event ExitTransitionDidStart.

const std::function< void()> &	getOnExitTransitionDidStartCallback () const
	Get the callback of event ExitTransitionDidStart.

unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true

void	applyMaskOnEnter (bool applyChildren)
	Should addChild() make the child follow it's parent's mask?

backend::ProgramState *	setProgramStateByProgramId (uint64_t progId)
	Sets ProgramState by programId.

virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings.

void	updateOrderOfArrival ()
	!

virtual int	getLocalZOrder () const
	Gets the local Z order of this node.

virtual float	getGlobalZOrder () const
	Returns the Node's Global Z Order.

virtual void	setScaleX (float scaleX)
	Sets the scale (x) of the node.

virtual float	getScaleX () const
	Returns the scale factor on X axis of this node.

virtual void	setScaleY (float scaleY)
	Sets the scale (y) of the node.

virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node.

virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node.

virtual float	getScaleZ () const
	Returns the scale factor on Z axis of this node.

virtual void	setScale (float scale)
	Sets the scale (x,y,z) of the node.

virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor.

virtual void	setScale (float scaleX, float scaleY)
	Sets the scale (x,y) of the node.

virtual void	setPosition (const Vec2 &position)
	Sets the position (x,y) of the node in its parent's coordinate system.

virtual void	setPositionNormalized (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1.

virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system.

virtual const Vec2 &	getPositionNormalized () const
	Returns the normalized position.

virtual void	setPosition (float x, float y)
	Sets the position (x,y) of the node in its parent's coordinate system.

virtual void	getPosition (float x, float y) const
	Gets position in a more efficient way, returns two number instead of a Vec2 object.

virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position.

virtual float	getPositionX () const
	Gets the x coordinate of the node in its parent's coordinate system.

virtual void	setPositionY (float y)
	Sets the y coordinate of the node in its parent's coordinate system.

virtual float	getPositionY () const
	Gets the y coordinate of the node in its parent's coordinate system.

virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system.

virtual Vec3	getPosition3D () const
	Returns the position (X,Y,Z) in its parent's coordinate system.

virtual void	setPositionZ (float positionZ)
	Sets the 'z' coordinate in the position.

virtual float	getPositionZ () const
	Gets position Z coordinate of this node.

virtual void	setSkewX (float skewX)
	Changes the X skew angle of the node in degrees.

virtual float	getSkewX () const
	Returns the X skew angle of the node in degrees.

virtual void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees.

virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees.

virtual void	setAnchorPoint (const Vec2 &anchorPoint)
	Sets the anchor point in percent.

virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent.

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

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

virtual bool	hitTest (const Vec2 &worldPoint) const
	The basic node hit test, since axmol-1.0.

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

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

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

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

virtual void	setRotation3D (const Vec3 &rotation)
	Sets the rotation (X,Y,Z) in degrees.

virtual Vec3	getRotation3D () const
	Returns the rotation (X,Y,Z) in degrees.

virtual void	setRotationQuat (const Quaternion &quat)
	Set rotation by quaternion.

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.

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

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

virtual void	setRotationSkewY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

virtual float	getRotationSkewY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

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

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

virtual int	getTag () const
	Returns a tag that is used to identify the node easily.

virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily.

virtual std::string_view	getName () const
	Returns a string that is used to identify the node.

virtual void	setName (std::string_view name)
	Changes the name that is used to identify the node easily.

virtual void *	getUserData ()
	Returns a custom user data pointer.

virtual const void *	getUserData () const
	@lua NA

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

virtual Object *	getUserObject ()
	Returns a user assigned Object.

virtual const Object *	getUserObject () const
	@lua NA

virtual void	setUserObject (Object *userObject)
	Returns a user assigned Object.

virtual void	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'.

virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the Node enters in the 'stage'.

virtual void	onExit ()
	Event callback that is invoked every time the Node leaves the 'stage'.

virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the Node leaves the 'stage'.

virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions.

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

virtual Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed.

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.

void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag.

void	stopAllActionsByTag (int tag)
	Removes all actions from the running action list by its tag.

void	stopActionsByFlags (unsigned int flags)
	Removes all actions from the running action list by its flags.

Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag.

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

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.

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

virtual Scheduler *	getScheduler ()
	Gets a Scheduler object.

bool	isScheduled (SEL_SCHEDULE selector) const
	Checks whether a selector is scheduled.

bool	isScheduled (std::string_view key) const
	Checks whether a lambda function is scheduled.

void	scheduleUpdate ()
	Schedules the "update" method.

void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority.

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

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

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

void	scheduleOnce (const std::function< void(float)> &callback, float delay, std::string_view key)
	Schedules a lambda function that runs only once, with a delay of 0 or larger.

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

void	schedule (const std::function< void(float)> &callback, std::string_view key)
	Schedules a lambda function.

void	schedule (const std::function< void(float)> &callback, float interval, std::string_view key)
	Schedules a lambda function.

void	schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, std::string_view key)
	Schedules a lambda function.

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector.

void	unschedule (std::string_view key)
	Unschedules a lambda function.

void	unscheduleAllCallbacks ()
	Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.

virtual void	resume ()
	Resumes all scheduled selectors, actions and event listeners.

virtual void	pause ()
	Pauses all scheduled selectors, actions and event listeners.

virtual void	updateTransform ()
	Calls children's updateTransform() method recursively.

virtual const Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

virtual Mat4	getNodeToParentTransform (Node *ancestor) const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

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.

virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually.

virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

virtual Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix.

virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix.

Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates.

Vec2	convertToWorldSpace (const Vec2 &nodePoint) const
	Converts a Vec2 to world space coordinates.

Vec2	convertToNodeSpaceAR (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates.

Vec2	convertToWorldSpaceAR (const Vec2 &nodePoint) const
	Converts a local Vec2 to world space coordinates.The result is in Points.

Vec2	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Vec2.

Vec2	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate.

Vec2	getWorldPosition () const
	Gets position of node in world space.

void	setWorldPosition (const Vec2 &position)
	Sets position of node in world space.

void	setAdditionalTransform (const Mat4 *additionalTransform)
	Sets an additional transform matrix to the node.

Component *	getComponent (std::string_view name)
	Gets a component by its name.

virtual bool	addComponent (Component *component)
	Adds a component.

virtual bool	removeComponent (std::string_view name)
	Removes a component by its name.

virtual bool	removeComponent (Component *component)
	Removes a component by its pointer.

virtual void	removeAllComponents ()
	Removes all components.

virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0.

virtual void	addChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order.

virtual void	addChild (Node *child, int localZOrder, int tag)
	Adds a child to the container with z order and tag.

virtual void	addChild (Node *child, int localZOrder, std::string_view name)
	Adds a child to the container with z order and tag.

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

template<typename T>
T	getChildByTag (int tag) const
	Gets a child from the container with its tag that can be cast to Type T.

virtual Node *	getChildByName (std::string_view name) const
	Gets a child from the container with its name.

template<typename T>
T	getChildByName (std::string_view name) const
	Gets a child from the container with its name that can be cast to Type T.

virtual void	enumerateChildren (std::string_view name, std::function< bool(Node *node)> callback) const
	Search the children of the receiving node to perform processing for nodes which share a name.

virtual Vector< Node * > &	getChildren ()
	Returns the array of the node's children.

virtual ssize_t	getChildrenCount () const
	Returns the amount of children.

virtual void	setParent (Node *parent)
	Sets the parent node.

virtual Node *	getParent ()
	Returns a pointer to the parent node.

virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup.

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node.

virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value.

virtual void	removeChildByName (std::string_view name, bool cleanup=true)
	Removes a child from the container by tag value.

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

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

Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.

void	release ()
	Releases the ownership immediately.

Object *	autorelease ()
	Releases the ownership sometime soon automatically.

unsigned int	getReferenceCount () const
	Returns the Object's current reference count.

virtual	~Object ()
	Destructor.

Public Member Functions inherited from IMEDelegate
virtual	~IMEDelegate ()
	Default constructor.

Static Public Member Functions
static TextFieldTTF *	textFieldWithPlaceHolder (std::string_view placeholder, const Vec2 &dimensions, TextHAlignment alignment, std::string_view fontName, float fontSize)
	Creates a TextFieldTTF from a fontname, alignment, dimension and font size.

static TextFieldTTF *	textFieldWithPlaceHolder (std::string_view placeholder, std::string_view fontName, float fontSize)
	Creates a TextFieldTTF from a fontname and font size.

Static Public Member Functions inherited from Label
static Label *	create ()
	Allocates and initializes a Label, with default settings.

static Label *	createWithSystemFont (std::string_view text, std::string_view font, float fontSize, const Vec2 &dimensions=Vec2::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
	Allocates and initializes a Label, base on platform-dependent API.

static Label *	createWithTTF (std::string_view text, std::string_view fontFilePath, float fontSize, const Vec2 &dimensions=Vec2::ZERO, TextHAlignment hAlignment=TextHAlignment::LEFT, TextVAlignment vAlignment=TextVAlignment::TOP)
	Allocates and initializes a Label, base on FreeType2.

static Label *	createWithTTF (const TTFConfig &ttfConfig, std::string_view text, TextHAlignment hAlignment=TextHAlignment::LEFT, int maxLineWidth=0)
	Allocates and initializes a Label, base on FreeType2.

static Label *	createWithBMFont (std::string_view bmfontPath, std::string_view text, const TextHAlignment &hAlignment=TextHAlignment::LEFT, int maxLineWidth=0)
	Allocates and initializes a Label, with a bitmap font file.

static Label *	createWithBMFont (std::string_view bmfontPath, std::string_view text, const TextHAlignment &hAlignment, int maxLineWidth, const Rect &imageRect, bool imageRotated)
	Allocates and initializes a Label, with a bitmap font file.

static Label *	createWithBMFont (std::string_view bmfontPath, std::string_view text, const TextHAlignment &hAlignment, int maxLineWidth, std::string_view subTextureKey)
	Allocates and initializes a Label, with a bitmap font file.

static AX_DEPRECATED(2.1) static Label createWithBMFont(std Label	createWithCharMap (std::string_view charMapFile, int itemWidth, int itemHeight, int startCharMap)
	Allocates and initializes a Label, with a bitmap font file.

static Label *	createWithCharMap (Texture2D *texture, int itemWidth, int itemHeight, int startCharMap)
	Allocates and initializes a Label, with char map configuration.

static Label *	createWithCharMap (std::string_view plistFile)
	Allocates and initializes a Label, with char map configuration.

static Node *	create ()
	Allocates and initializes a node.

static int	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.

template<typename _T>
static void	sortNodes (ax::Vector< _T * > &nodes)
	Sorts helper function.

Additional Inherited Members
Public Types inherited from Label
enum class	Overflow { }

Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes.

Detailed Description

A simple text input field with TTF font.

Constructor & Destructor Documentation

◆ TextFieldTTF()

TextFieldTTF ( )

Default constructor.

@js ctor

◆ ~TextFieldTTF()

virtual ~TextFieldTTF ( )

virtual

Default destructor.

@js NA @lua NA

Member Function Documentation

◆ textFieldWithPlaceHolder() [1/2]

static TextFieldTTF * textFieldWithPlaceHolder	(	std::string_view	placeholder,
		const Vec2 &	dimensions,
		TextHAlignment	alignment,
		std::string_view	fontName,
		float	fontSize )

static

Creates a TextFieldTTF from a fontname, alignment, dimension and font size.

@js NA

◆ textFieldWithPlaceHolder() [2/2]

static TextFieldTTF * textFieldWithPlaceHolder	(	std::string_view	placeholder,
		std::string_view	fontName,
		float	fontSize )

static

Creates a TextFieldTTF from a fontname and font size.

@js NA

◆ getCharCount()

std::size_t getCharCount ( ) const

inline

Query the currently inputed character count.

Returns: The total input character count.

◆ getColorSpaceHolder()

virtual const Color4B & getColorSpaceHolder ( )

virtual

Query the color of place holder.

Returns: The place holder color.

◆ setColorSpaceHolder() [1/2]

virtual void setColorSpaceHolder ( const Color3B & color )

virtual

Change input placeholder color.

Parameters

color A color value in Color3B.

◆ setColorSpaceHolder() [2/2]

virtual void setColorSpaceHolder ( const Color4B & color )

virtual

Change the placeholder color.

Parameters

color The placeholder color in Color4B.

◆ setTextColor()

virtual void setTextColor ( const Color4B & textColor )

overridevirtual

Change the color of input text.

Parameters

textColor The text color in Color4B.

Reimplemented from Label.

◆ setString()

virtual void setString ( std::string_view text )

overridevirtual

Change input text of TextField.

Parameters

text	The input text of TextField.

Reimplemented from Label.

◆ appendString()

virtual void appendString ( std::string_view text )

virtual

Append to input text of TextField.

Parameters

text	The append text of TextField.

◆ getString()

virtual std::string_view getString ( ) const

overridevirtual

Query the input text of TextField.

Returns: Get the input text of TextField.

Reimplemented from Label.

◆ setPlaceHolder()

virtual void setPlaceHolder ( std::string_view text )

virtual

Change placeholder text.

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

Parameters

text	The placeholder string.

◆ getPlaceHolder()

virtual std::string_view getPlaceHolder ( ) const

virtual

Query the placeholder string.

Returns: The placeholder string.

◆ setSecureTextEntry()

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

value Whether or not to display text with secure text entry. @js NA

◆ isSecureTextEntry()

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. @js NA

◆ visit()

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

overridevirtual

Visits this node's children and draw them recursively.

Parameters

renderer	A given renderer.
parentTransform	A transform matrix.
parentFlags	Renderer flag.

Reimplemented from Label.

◆ update()

virtual void update ( float delta )

overridevirtual

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

Parameters

delta In seconds.

Reimplemented from Node.

◆ setCursorEnabled()

void setCursorEnabled ( bool enabled )

Set enable cursor use.

@js NA

◆ setCursorChar()

void setCursorChar ( char cursor )

Set char showing cursor.

@js NA

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

TextFieldTTF.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextFieldTTF()

◆ ~TextFieldTTF()

Member Function Documentation

◆ textFieldWithPlaceHolder() [1/2]

◆ textFieldWithPlaceHolder() [2/2]

◆ getCharCount()

◆ getColorSpaceHolder()

◆ setColorSpaceHolder() [1/2]

◆ setColorSpaceHolder() [2/2]

◆ setTextColor()

◆ setString()

◆ appendString()

◆ getString()

◆ setPlaceHolder()

◆ getPlaceHolder()

◆ setSecureTextEntry()

◆ isSecureTextEntry()

◆ visit()

◆ update()

◆ setCursorEnabled()

◆ setCursorChar()