For creating a system font or a TTF font Text. More...

#include <UIText.h>

Inheritance diagram for Text:

Public Types
enum	Type { SYSTEM, TTF }

Public Types inherited from Widget
enum	FocusDirection { LEFT, RIGHT, UP, DOWN }

enum	PositionType { ABSOLUTE, PERCENT }

enum	SizeType { ABSOLUTE, PERCENT }

enum	TouchEventType { BEGAN, MOVED, ENDED, CANCELED }

enum	TextureResType { LOCAL = 0, PLIST = 1 }

enum	BrightStyle { NONE = -1, NORMAL, HIGHLIGHT }

typedef std::function< void(Ref *, Widget::TouchEventType)>	ccWidgetTouchCallback
typedef std::function< void(Ref *)>	ccWidgetClickCallback
typedef std::function< void(Ref *, int)>	ccWidgetEventCallback
Public Types inherited from Node
enum	{ FLAGS_TRANSFORM_DIRTY = (1 << 0), FLAGS_CONTENT_SIZE_DIRTY = (1 << 1), FLAGS_RENDER_AS_3D = (1 << 3), FLAGS_DIRTY_MASK = (FLAGS_TRANSFORM_DIRTY \| FLAGS_CONTENT_SIZE_DIRTY) }

Public Member Functions
	Text ()
virtual	~Text ()
	Default destructor. More...

void	setText (const std::string &text)
	Changes the string value of label. More...

void	setString (const std::string &text)
const std::string &	getStringValue ()
	Gets the string value of label. More...

var	getStringValue ()
	Gets the string value of label. More...

const std::string &	getString () const
var	getString ()
ssize_t	getStringLength () const
	Gets the string length of the label. More...

void	setFontSize (int size)
	Sets the font size of label. More...

int	getFontSize () const
void	setFontName (const std::string &name)
	Sets the font name of label. More...

const std::string &	getFontName () const
Type	getType () const
var	getType ()
void	setTouchScaleChangeEnabled (bool enabled)
	Sets the touch scale enabled of label. More...

var	setTouchScaleChangeEnabled ( var enabled)
	Sets the touch scale enabled of label. More...

bool	isTouchScaleChangeEnabled () const
	Gets the touch scale enabled of label. More...

virtual Size	getVirtualRendererSize () const override
virtual Node *	getVirtualRenderer () override
	Gets the Virtual Renderer of widget. More...

virtual Size	getAutoRenderSize ()
var	getAutoRenderSize ()
virtual std::string	getDescription () const override
	Returns the "class name" of widget. More...

var	getDescription ()
	Returns the "class name" of widget. More...

void	setTextAreaSize (const Size &size)
	Set the rendering size of the text, you should call this method along with calling `ignoreContentAdaptWithSize(false)`, otherwise the text area size is caculated by the real size of the text content. More...

const Size &	getTextAreaSize () const
var	getTextAreaSize ()
void	setTextHorizontalAlignment (TextHAlignment alignment)
var	setTextHorizontalAlignment ( var alignment)
TextHAlignment	getTextHorizontalAlignment () const
void	setTextVerticalAlignment (TextVAlignment alignment)
TextVAlignment	getTextVerticalAlignment () const
var	getTextVerticalAlignment ()
void	setTextColor (const Color4B color)
var	setTextColor ( var color)
const Color4B &	getTextColor () const
var	getTextColor ()
void	enableShadow (const Color4B &shadowColor=Color4B::BLACK, const Size &offset=Size(2,-2), int blurRadius=0)
	Enable shadow for the label. More...

var	enableShadow ( var BLACK, var 2, var 0)
	Enable shadow for the label. More...

void	enableOutline (const Color4B &outlineColor, int outlineSize=1)
	Enable outline for the label It only works on IOS and Android when you use System fonts. More...

void	enableGlow (const Color4B &glowColor)
	only support for TTF More...

void	disableEffect ()
	disable shadow/outline/glow rendering More...

var	disableEffect ()
	disable shadow/outline/glow rendering More...

virtual bool	init (const std::string &textContent, const std::string &fontName, int fontSize)
var	init ( var textContent, var fontName, var fontSize)
Public Member Functions inherited from Widget
	Widget (void)
virtual	~Widget ()
	Default destructor. More...

virtual void	setEnabled (bool enabled)
	Sets whether the widget is enabled. More...

bool	isEnabled () const
	Determines if the widget is enabled. More...

void	setBright (bool bright)
	Sets whether the widget is bright. More...

bool	isBright () const
	Determines if the widget is bright. More...

virtual void	setTouchEnabled (bool enabled)
	Sets whether the widget is touch enabled. More...

void	setBrightStyle (BrightStyle style)
	To set the bright style of widget. More...

bool	isTouchEnabled () const
	Determines if the widget is touch enabled. More...

bool	isHighlighted () const
	Determines if the widget is highlighted. More...

void	setHighlighted (bool hilight)
	Sets whether the widget is hilighted. More...

float	getLeftInParent ()
	Gets the left boundary position of this widget in parent's coordination system. More...

float	getLeftBoundary () const
float	getBottomInParent ()
	Gets the bottom boundary position of this widget in parent's coordination system. More...

float	getBottomBoundary () const
float	getRightInParent ()
	Gets the right boundary position of this widget in parent's coordination system. More...

float	getRightBoundary () const
float	getTopInParent ()
	Gets the top boundary position of this widget in parent's coordination system. More...

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

void	addTouchEventListener (Ref *target, SEL_TouchEvent selector)
	Sets the touch event target/selector to the widget. More...

void	addTouchEventListener (const ccWidgetTouchCallback &callback)
void	addClickEventListener (const ccWidgetClickCallback &callback)
	Set a click event handler to the widget. More...

virtual void	addCCSEventListener (const ccWidgetEventCallback &callback)
	Set a event handler to the widget in order to use cocostudio editor and framework. More...

virtual void	setPosition (const Vec2 &pos) override
	Changes the position (x,y) of the widget in OpenGL coordinates. More...

void	setPositionPercent (const Vec2 &percent)
	Set the percent(x,y) of the widget in OpenGL coordinates. More...

const Vec2 &	getPositionPercent ()
	Gets the percent (x,y) of the widget in OpenGL coordinates. More...

void	setPositionType (PositionType type)
	Changes the position type of the widget. More...

PositionType	getPositionType () const
	Gets the position type of the widget. More...

virtual void	setFlippedX (bool flippedX)
	Sets whether the widget should be flipped horizontally or not. More...

virtual bool	isFlippedX () const
	Returns the flag which indicates whether the widget is flipped horizontally or not. More...

virtual void	setFlippedY (bool flippedY)
	Sets whether the widget should be flipped vertically or not. More...

virtual bool	isFlippedY () const
	Return the flag which indicates whether the widget is flipped vertically or not. More...

bool	isFlipX ()
void	setFlipX (bool flipX)
bool	isFlipY ()
void	setFlipY (bool flipY)
virtual void	setScaleX (float scaleX) override
	Sets the scale (x) of the node. More...

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

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

virtual void	setScale (float scalex, float scaley) override
	Sets the scale (x,y) of the node. More...

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

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

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

bool	clippingParentAreaContainPoint (const Vec2 &pt)
bool	isClippingParentContainsPoint (const Vec2 &pt)
const Vec2 &	getTouchStartPos () const
const Vec2 &	getTouchBeganPosition () const
const Vec2 &	getTouchMovePos () const
const Vec2 &	getTouchMovePosition () const
const Vec2 &	getTouchEndPos () const
const Vec2 &	getTouchEndPosition () const
virtual void	setSize (const Size &size)
	Changes the size that is widget's size. More...

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

virtual void	setSizePercent (const Vec2 &percent)
	Changes the percent that is widget's percent size. More...

void	setSizeType (SizeType type)
	Changes the size type of widget. More...

SizeType	getSizeType () const
	Gets the size type of widget. More...

const Size &	getSize () const
	Returns size of widget. More...

const Size &	getCustomSize () const
virtual const Size &	getLayoutSize ()
const Vec2 &	getSizePercent ()
	Returns size percent of widget. More...

virtual bool	hitTest (const Vec2 &pt)
	Checks a point if is in widget's space. More...

virtual bool	onTouchBegan (Touch touch, Event unusedEvent)
virtual void	onTouchMoved (Touch touch, Event unusedEvent)
virtual void	onTouchEnded (Touch touch, Event unusedEvent)
virtual void	onTouchCancelled (Touch touch, Event unusedEvent)
void	setLayoutParameter (LayoutParameter *parameter)
	Sets a LayoutParameter to widget. More...

LayoutParameter *	getLayoutParameter () const override
	Gets LayoutParameter of widget. More...

LayoutParameter *	getLayoutParameter (LayoutParameter::Type type)
virtual void	ignoreContentAdaptWithSize (bool ignore)
	Note: when you set _ignoreSize to true, no matther you call setContentSize or not, the widget size is always equal to the return value of the member function getVirtualRendererSize. More...

bool	isIgnoreContentAdaptWithSize () const
	Query whether the widget ignores user deinfed content size or not. More...

Vec2	getWorldPosition () const
	Gets world position of widget. More...

Widget *	clone ()
virtual void	onEnter () override
	Event callback that is invoked every time when Node enters the 'stage'. More...

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

void	updateSizeAndPosition ()
void	updateSizeAndPosition (const Size &parentSize)
void	setActionTag (int tag)
int	getActionTag () const
void	setPropagateTouchEvents (bool isPropagate)
	Allow widget touch events to propagate to its parents. More...

bool	isPropagateTouchEvents () const
	Return whether the widget is propagate touch events to its parents or not. More...

void	setSwallowTouches (bool swallow)
	Specify widget to swallow touches or not. More...

bool	isSwallowTouches () const
	Return whether the widget is swallowing touch or not. More...

bool	isFocused () const
void	setFocused (bool focus)
bool	isFocusEnabled () const
void	setFocusEnabled (bool enable)
virtual Widget *	findNextFocusedWidget (FocusDirection direction, Widget *current)
	When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More...

void	requestFocus ()
	when a widget calls this method, it will get focus immediately. More...

Widget *	getCurrentFocusedWidget (bool isWidget)
	no matter what widget object you call this method on , it will return you the exact one focused widget More...

Widget *	getCurrentFocusedWidget () const
void	setUnifySizeEnabled (bool enable)
bool	isUnifySizeEnabled () const
void	setCallbackName (const std::string &callbackName)
	callbackName getter and setter. More...

const std::string &	getCallbackName () const
void	setCallbackType (const std::string &callbackType)
	callbackType getter and setter. More...

const std::string &	getCallbackType () const
void	setLayoutComponentEnabled (bool enable)
bool	isLayoutComponentEnabled () const
virtual void	interceptTouchEvent (TouchEventType event, Widget sender, Touch touch)
void	propagateTouchEvent (TouchEventType event, Widget sender, Touch touch)
	Propagate touch events to its parents. More...

void	onFocusChange (Widget widgetLostFocus, Widget widgetGetFocus)
	This method is called when a focus change event happens. More...

void	dispatchFocusEvent (Widget widgetLoseFocus, Widget widgetGetFocus)
	Dispatch a EventFocus through a EventDispatcher. More...

Public Member Functions inherited from ProtectedNode
virtual void	cleanup () override
	Stops all running actions and schedulers. More...

var	cleanup ()
	Stops all running actions and schedulers. More...

local	cleanup ()
	Stops all running actions and schedulers. More...

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

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

virtual void	updateDisplayedOpacity (GLubyte parentOpacity) override
var	updateDisplayedOpacity ( var parentOpacity)
local	updateDisplayedOpacity ( local parentOpacity)
virtual void	updateDisplayedColor (const Color3B &parentColor) override
var	updateDisplayedColor ( var parentColor)
local	updateDisplayedColor ( local parentColor)
virtual void	disableCascadeColor () override
var	disableCascadeColor ()
local	disableCascadeColor ()
virtual void	disableCascadeOpacity () override
local	disableCascadeOpacity ()
virtual	~ProtectedNode ()
local	~ProtectedNode ()
virtual void	addProtectedChild (Node *child)
	Adds a child to the container with z-order as 0. More...

local	addProtectedChild ( local child)
	Adds a child to the container with z-order as 0. More...

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

local	addProtectedChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...

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

local	addProtectedChild ( local child, local localZOrder, local tag)
	Adds a child to the container with z order and tag. More...

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

var	getProtectedChildByTag ( var tag)
	Gets a child from the container with its tag. More...

local	getProtectedChildByTag ( local tag)
	Gets a child from the container with its tag. More...

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

local	removeProtectedChild ( local child, local true)
	Removes a child from the container. More...

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

var	removeProtectedChildByTag ( var tag, var true)
	Removes a child from the container by tag value. More...

local	removeProtectedChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...

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

var	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...

local	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...

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

var	removeAllChildren ( var cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

local	removeAllChildren ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderProtectedChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...

var	reorderProtectedChild ( var child, var localZOrder)
	Reorders a child according to a new z value. More...

local	reorderProtectedChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...

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

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	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
	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	draw () final
var	draw ()
local	draw ()
virtual void	visit () final
virtual Scene *	getScene () const
	Returns the Scene that contains the Node. More...

var	getScene ()
	Returns the Scene that contains the Node. More...

local	getScene ()
	Returns the Scene that contains the Node. More...

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

virtual Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
local	setEventDispatcher ( local dispatcher)
virtual EventDispatcher *	getEventDispatcher () const
local	getEventDispatcher ()
void	setPhysicsBody (PhysicsBody *body)
	set the PhysicsBody that let the sprite effect with physics More...

PhysicsBody *	getPhysicsBody () const
	get the PhysicsBody the sprite have More...

var	getPhysicsBody ()
	get the PhysicsBody the sprite have More...

local	getPhysicsBody ()
	get the PhysicsBody the sprite have More...

void	removeFromPhysicsWorld ()
	remove this node from physics world. More...

var	removeFromPhysicsWorld ()
	remove this node from physics world. More...

local	removeFromPhysicsWorld ()
	remove this node from physics world. More...

void	updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
virtual void	updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
var	updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
local	updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
virtual GLubyte	getOpacity () const
virtual GLubyte	getDisplayedOpacity () const
var	getDisplayedOpacity ()
local	getDisplayedOpacity ()
virtual void	setOpacity (GLubyte opacity)
local	setOpacity ( local opacity)
virtual bool	isCascadeOpacityEnabled () const
var	isCascadeOpacityEnabled ()
local	isCascadeOpacityEnabled ()
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
local	setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual const Color3B &	getColor () const
local	getColor ()
virtual const Color3B &	getDisplayedColor () const
local	getDisplayedColor ()
virtual void	setColor (const Color3B &color)
var	setColor ( var color)
local	setColor ( local color)
virtual bool	isCascadeColorEnabled () const
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
local	setCascadeColorEnabled ( local cascadeColorEnabled)
virtual void	setOpacityModifyRGB (bool value)
var	setOpacityModifyRGB ( var value)
local	setOpacityModifyRGB ( local value)
virtual bool	isOpacityModifyRGB () const
void	setOnEnterCallback (const std::function< void()> &callback)
var	setOnEnterCallback ( var callback)
local	setOnEnterCallback ( local callback)
const std::function< void()> &	getOnEnterCallback () const
local	getOnEnterCallback ()
void	setOnExitCallback (const std::function< void()> &callback)
var	setOnExitCallback ( var callback)
local	setOnExitCallback ( local callback)
const std::function< void()> &	getOnExitCallback () const
local	getOnExitCallback ()
void	setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
var	setonEnterTransitionDidFinishCallback ( var callback)
local	setonEnterTransitionDidFinishCallback ( local callback)
const std::function< void()> &	getonEnterTransitionDidFinishCallback () const
local	getonEnterTransitionDidFinishCallback ()
void	setonExitTransitionDidStartCallback (const std::function< void()> &callback)
var	setonExitTransitionDidStartCallback ( var callback)
local	setonExitTransitionDidStartCallback ( local callback)
const std::function< void()> &	getonExitTransitionDidStartCallback () const
local	getonExitTransitionDidStartCallback ()
unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true More...

void	setCameraMask (unsigned short mask, bool applyChildren=true)
local	setCameraMask ( local mask, local true)
virtual	~Node ()
var	~Node ()
local	~Node ()
virtual bool	init ()
var	init ()
local	init ()
virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...

local	setLocalZOrder ( local localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...

virtual void	setZOrder (int localZOrder)
virtual void	_setLocalZOrder (int z)
var	_setLocalZOrder ( var z)
local	_setLocalZOrder ( local z)
virtual int	getLocalZOrder () const
	Gets the local Z order of this node. More...

var	getLocalZOrder ()
	Gets the local Z order of this node. More...

local	getLocalZOrder ()
	Gets the local Z order of this node. More...

virtual int	getZOrder () const
virtual void	setGlobalZOrder (float globalZOrder)
	Defines the oder in which the nodes are renderer. More...

local	setGlobalZOrder ( local globalZOrder)
	Defines the oder in which the nodes are renderer. More...

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

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

var	setScaleZ ( var 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	setNormalizedPosition (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...

var	setNormalizedPosition ( var position)
	Sets the position (x,y) using values between 0 and 1. More...

local	setNormalizedPosition ( local position)
	Sets the position (x,y) using values between 0 and 1. More...

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

virtual const Vec2 &	getNormalizedPosition () const
	returns the normalized position More...

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

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
local	getPositionX ()
virtual void	setPositionY (float y)
local	setPositionY ( local y)
virtual float	getPositionY (void) const
var	getPositionY ()
local	getPositionY ()
virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...

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

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

local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. More...

virtual void	setVertexZ (float vertexZ)
var	setVertexZ ( var vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...

var	getPositionZ ()
	Gets position Z coordinate of this node. More...

local	getPositionZ ()
	Gets position Z coordinate of this node. More...

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

local	setSkewX ( local skewX)
	Changes the X skew angle of the node in degrees. More...

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

var	getSkewX ()
	Returns the X skew angle of the node in degrees. More...

local	getSkewX ()
	Returns the X skew angle of the node in degrees. More...

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

var	setSkewY ( var skewY)
	Changes the Y skew angle of the node in degrees. More...

local	setSkewY ( local skewY)
	Changes the Y skew angle of the node in degrees. More...

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

var	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...

local	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...

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

local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. More...

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

local	getAnchorPoint ()
	Returns the anchor point in percent. More...

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

local	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...

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

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

var	setVisible ( var 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...

var	setRotation3D ( var 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...

var	setRotationQuat ( var quat)
	set rotation by quaternion More...

local	setRotationQuat ( local quat)
	set rotation by quaternion More...

virtual Quaternion	getRotationQuat () const
	return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, 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...

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

virtual void	setRotationX (float rotationX)
var	setRotationX ( var rotationX)
local	setRotationX ( local rotationX)
virtual float	getRotationSkewX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

local	getRotationSkewX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual float	getRotationX () const
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
var	getRotationY ()
local	getRotationY ()
void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

int	getOrderOfArrival () const
	Returns the arrival order, indicates which children is added previously. More...

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

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

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

var	addChild ( var child)
	Adds a child to the container with z-order as 0. More...

local	addChild ( local child)
	Adds a child to the container with z-order as 0. More...

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

local	addChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...

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

local	addChild ( local child, local localZOrder, local tag)
	Adds a child to the container with z order and tag. More...

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

local	addChild ( local child, local localZOrder, local name)
	Adds a child to the container with z order and tag. More...

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

var	getChildByTag ( var tag)
	Gets a child from the container with its tag. More...

local	getChildByTag ( local tag)
	Gets a child from the container with its tag. More...

virtual Node *	getChildByName (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 >
T	getChildByName (const std::string &name) const
	Gets a child from the container with its name that can be cast to Type T. More...

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

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

local	getChildren ()
	Returns the array of the node's children. More...

virtual const Vector< Node * > &	getChildren () const
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns the amount of children. More...

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

var	setParent ( var parent)
	Sets the parent node. More...

local	setParent ( local parent)
	Sets the parent node. More...

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

virtual const Node *	getParent () 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	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

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

local	removeChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...

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

var	removeChildByName ( var name, var true)
	Removes a child from the container by tag value. More...

local	removeChildByName ( local name, local true)
	Removes a child from the container by tag value. More...

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. 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	removeAllChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

var	removeAllChildren ( var cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

local	removeAllChildren ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderChild (Node *child, int 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...

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

local	getTag ()
	Returns a tag that is used to identify the node easily. More...

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

local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...

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

local	getName ()
	Returns a string that is used to identify the node. More...

virtual void	setName (const std::string &name)
	Changes the name that is used to identify the node easily. More...

var	setName ( var name)
	Changes the name that is used to identify the node easily. More...

local	setName ( local name)
	Changes the name that is used to identify the node easily. More...

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

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

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

virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...

local	setUserObject ( local userObject)
	Returns a user assigned Object. More...

GLProgram *	getGLProgram () 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...

GLProgram *	getShaderProgram () const
local	getShaderProgram ()
GLProgramState *	getGLProgramState () const
var	getGLProgramState ()
local	getGLProgramState ()
virtual void	setGLProgramState (GLProgramState *glProgramState)
local	setGLProgramState ( local glProgramState)
virtual void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...

var	setGLProgram ( var 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)
virtual void	setActionManager (ActionManager *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 ActionManager *	getActionManager ()
	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 ActionManager *	getActionManager () const
var	getActionManager ()
virtual Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed. More...

var	runAction ( var action)
	Executes an action, and returns the action that is executed. More...

local	runAction ( local action)
	Executes an action, and returns the action that is executed. More...

void	stopAllActions ()
	Stops and removes all actions from the running action list . More...

void	stopAction (Action *action)
	Stops and removes an action from the running action list. More...

var	stopAction ( var action)
	Stops and removes an action from the running action list. More...

local	stopAction ( local action)
	Stops and removes an action from the running action list. More...

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

var	stopActionByTag ( var tag)
	Removes an action from the running action list by its tag. More...

local	stopActionByTag ( local tag)
	Removes an action from the running action list by its tag. More...

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

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

local	getNumberOfRunningActions ()
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

ssize_t	numberOfRunningActions () const
var	numberOfRunningActions ()
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...

virtual Scheduler *	getScheduler ()
	Gets a Sheduler object. More...

local	getScheduler ()
	Gets a Sheduler object. More...

virtual const Scheduler *	getScheduler () const
bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

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

void	scheduleUpdate (void)
	Schedules the "update" method. More...

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

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

var	scheduleOnce ( var selector, var 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...

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

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

var	schedule ( var callback, var interval, var repeat, var delay, var key)
	Schedules a lambda function. More...

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

var	unschedule ( var selector)
	Unschedules a custom selector. More...

void	unschedule (const std::string &key)
	Unschedules a lambda function. More...

void	unscheduleAllCallbacks ()
	Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions Actions are not affected by this method. More...

void	unscheduleAllSelectors ()
var	unscheduleAllSelectors ()
local	unscheduleAllSelectors ()
virtual void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...

local	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...

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

local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...

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

local	resumeSchedulerAndActions ()
	Resumes all scheduled selectors, actions and event listeners. More...

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

var	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...

local	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...

virtual void	update (float delta)
var	update ( var delta)
local	update ( local delta)
virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...

var	updateTransform ()
	Calls children's updateTransform() method recursively. More...

local	updateTransform ()
	Calls children's updateTransform() method recursively. More...

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

virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the Transformation matrix manually. More...

virtual AffineTransform	nodeToParentTransform () const
var	nodeToParentTransform ()
local	nodeToParentTransform ()
virtual const Mat4 &	getParentToNodeTransform () 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...

var	convertToWorldSpace ( var nodePoint)
	Converts a Vec2 to world space coordinates. More...

local	convertToWorldSpace ( local nodePoint)
	Converts a Vec2 to world space coordinates. More...

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

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

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

var	convertTouchToNodeSpace ( var touch)
	convenience methods which take a Touch instead of Vec2 More...

local	convertTouchToNodeSpace ( local touch)
	convenience methods which take a Touch instead of Vec2 More...

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

var	convertTouchToNodeSpaceAR ( var touch)
	converts a Touch (world coordinates) into a local coordinate. More...

local	convertTouchToNodeSpaceAR ( local touch)
	converts a Touch (world coordinates) into a local coordinate. More...

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

local	setAdditionalTransform ( local additionalTransform)
	Sets an additional transform matrix to the node. More...

void	setAdditionalTransform (const AffineTransform &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
Component *	getComponent (const std::string &name)
	gets a component by its name More...

var	getComponent ( var name)
	gets a component by its name More...

local	getComponent ( local name)
	gets a component by its name More...

virtual bool	addComponent (Component *component)
	adds a component More...

local	addComponent ( local component)
	adds a component More...

virtual bool	removeComponent (const std::string &name)
	removes a component by its name More...

var	removeComponent ( var 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 More...

var	removeAllComponents ()
	removes all components More...

local	removeAllComponents ()
	removes all components More...

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

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

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

virtual	~Ref ()
Public Member Functions inherited from LayoutParameterProtocol
virtual	~LayoutParameterProtocol ()

Static Public Member Functions
static Text *	create ()
	Allocates and initializes. More...

static Text *	create (const std::string &textContent, const std::string &fontName, int fontSize)
	create a Text object with textContent, fontName and fontSize the fontName could be a system font name or a TTF file path. More...

var	create ( var textContent, var fontName, var fontSize)
	create a Text object with textContent, fontName and fontSize the fontName could be a system font name or a TTF file path. More...

Static Public Member Functions inherited from Widget
static Widget *	create ()
	Allocates and initializes a widget. More...

static void	enableDpadNavigation (bool enable)
Static Public Member Functions inherited from ProtectedNode
static ProtectedNode *	create (void)
Static Public Member Functions inherited from Node
static Node *	create ()
	Allocates and initializes a node. More...

var	create ()
	Allocates and initializes a node. More...

local	create ()
	Allocates and initializes a node. More...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: virtual bool init() override
Public Attributes inherited from Widget
std::function< void(Widget , Widget )>	onFocusChanged
	When a widget lose/get focus, this method will be called. More...

std::function< Widget *(FocusDirection)>	onNextFocusedWidget
	use this function to manually specify the next focused widget regards to each direction More...

CC_CONSTRUCTOR_ACCESS	__pad0__: virtual bool init() override
Public Attributes inherited from ProtectedNode
CC_CONSTRUCTOR_ACCESS	__pad0__: ProtectedNode()
Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS	__pad0__: Node()

Protected Member Functions
virtual void	initRenderer () override
var	initRenderer ()
virtual void	onPressStateChangedToNormal () override
virtual void	onPressStateChangedToPressed () override
var	onPressStateChangedToPressed ()
virtual void	onPressStateChangedToDisabled () override
virtual void	onSizeChanged () override
var	onSizeChanged ()
void	labelScaleChangedWithSize ()
var	labelScaleChangedWithSize ()
virtual Widget *	createCloneInstance () override
var	createCloneInstance ()
virtual void	copySpecialProperties (Widget *model) override
virtual void	adaptRenderers () override
var	adaptRenderers ()
Protected Member Functions inherited from Widget
GLProgramState *	getNormalGLProgramState () const
	Get a normal state GLProgramState. More...

GLProgramState *	getGrayGLProgramState () const
	Get a disabled state GLProgramState. More...

void	pushDownEvent ()
void	moveEvent ()
virtual void	releaseUpEvent ()
virtual void	cancelUpEvent ()
void	updateChildrenDisplayedRGBA ()
void	copyProperties (Widget *model)
virtual void	copyClonedWidgetChildren (Widget *model)
Widget *	getWidgetParent ()
void	updateContentSizeWithTextureSize (const Size &size)
bool	isAncestorsEnabled ()
Widget *	getAncensterWidget (Node *node)
bool	isAncestorsVisible (Node *node)
void	cleanupWidget ()
LayoutComponent *	getOrCreateLayoutComponent ()
Protected Member Functions inherited from ProtectedNode
void	insertProtectedChild (Node *child, int z)
	helper that reorder a child More...

var	insertProtectedChild ( var child, var z)
	helper that reorder a child More...

local	insertProtectedChild ( local child, local z)
	helper that reorder a child More...

Protected Member Functions inherited from Node
void	childrenAlloc (void)
	lazy allocs More...

var	childrenAlloc ()
	lazy allocs More...

local	childrenAlloc ()
	lazy allocs More...

void	insertChild (Node *child, int z)
	helper that reorder a child More...

var	insertChild ( var child, var z)
	helper that reorder a child More...

local	insertChild ( local child, local z)
	helper that reorder a child More...

void	detachChild (Node *child, ssize_t index, bool doCleanup)
	Removes a child, call child->onExit(), do cleanup, remove it from children array. More...

local	detachChild ( local child, local index, local doCleanup)
	Removes a child, call child->onExit(), do cleanup, remove it from children array. More...

Vec2	convertToWindowSpace (const Vec2 &nodePoint) const
	Convert cocos2d coordinates to UI windows coordinate. More...

var	convertToWindowSpace ( var nodePoint)
	Convert cocos2d coordinates to UI windows coordinate. More...

local	convertToWindowSpace ( local nodePoint)
	Convert cocos2d coordinates to UI windows coordinate. More...

Mat4	transform (const Mat4 &parentTransform)
var	transform ( var parentTransform)
local	transform ( local parentTransform)
uint32_t	processParentFlags (const Mat4 &parentTransform, uint32_t parentFlags)
var	processParentFlags ( var parentTransform, var parentFlags)
local	processParentFlags ( local parentTransform, local parentFlags)
virtual void	updateCascadeOpacity ()
var	updateCascadeOpacity ()
local	updateCascadeOpacity ()
virtual void	updateCascadeColor ()
var	updateCascadeColor ()
local	updateCascadeColor ()
virtual void	updateColor ()
var	updateColor ()
local	updateColor ()
bool	doEnumerate (std::string name, std::function< bool(Node *)> callback) const
var	doEnumerate ( var name, var callback)
local	doEnumerate ( local name, local callback)
bool	doEnumerateRecursive (const Node node, const std::string &name, std::function< bool(Node )> callback) const
var	doEnumerateRecursive ( var node, var name, var callback)
local	doEnumerateRecursive ( local node, local name, local callback)
bool	isVisitableByVisitingCamera () const
void	updateRotationQuat ()
var	updateRotationQuat ()
local	updateRotationQuat ()
void	updateRotation3D ()
var	updateRotation3D ()
local	updateRotation3D ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

	Ref ()
	Constructor. More...

Protected Attributes
bool	_touchScaleChangeEnabled
float	_normalScaleValueX
var	_normalScaleValueX
float	_normalScaleValueY
var	_normalScaleValueY
std::string	_fontName
var	_fontName
int	_fontSize
var	_fontSize
float	_onSelectedScaleOffset
var	_onSelectedScaleOffset
Label *	_labelRenderer
var	_labelRenderer
bool	_labelRendererAdaptDirty
var	_labelRendererAdaptDirty
Type	_type
var	_type
Protected Attributes inherited from Widget
bool	_usingLayoutComponent
bool	_unifySize
bool	_enabled
bool	_bright
bool	_touchEnabled
bool	_highlight
bool	_affectByClipping
bool	_ignoreSize
bool	_propagateTouchEvents
BrightStyle	_brightStyle
SizeType	_sizeType
PositionType	_positionType
int	_actionTag
Size	_customSize
Vec2	_sizePercent
Vec2	_positionPercent
bool	_hitted
EventListenerTouchOneByOne *	_touchListener
Vec2	_touchBeganPosition
Vec2	_touchMovePosition
Vec2	_touchEndPosition
bool	_flippedX
bool	_flippedY
Map< int, LayoutParameter * >	_layoutParameterDictionary
LayoutParameter::Type	_layoutParameterType
bool	_focused
bool	_focusEnabled
Ref *	_touchEventListener
SEL_TouchEvent	_touchEventSelector
ccWidgetTouchCallback	_touchEventCallback
ccWidgetClickCallback	_clickEventListener
ccWidgetEventCallback	_ccEventCallback
std::string	_callbackType
std::string	_callbackName
Protected Attributes inherited from ProtectedNode
Vector< Node * >	_protectedChildren
	array of children nodes More...

bool	_reorderProtectedChildDirty
var	_reorderProtectedChildDirty
local	_reorderProtectedChildDirty
Protected Attributes inherited from Node
float	_rotationX
	rotation on the X-axis More...

float	_rotationY
	rotation on the Y-axis More...

var	_rotationY
	rotation on the Y-axis More...

local	_rotationY
	rotation on the Y-axis More...

float	_rotationZ_X
	rotation angle on Z-axis, component X More...

var	_rotationZ_X
	rotation angle on Z-axis, component X More...

local	_rotationZ_X
	rotation angle on Z-axis, component X More...

float	_rotationZ_Y
	rotation angle on Z-axis, component Y More...

var	_rotationZ_Y
	rotation angle on Z-axis, component Y More...

local	_rotationZ_Y
	rotation angle on Z-axis, component Y More...

Quaternion	_rotationQuat
var	_rotationQuat
local	_rotationQuat
float	_scaleX
	rotation using quaternion, if _rotationZ_X == _rotationZ_Y, _rotationQuat = RotationZ_X * RotationY * RotationX, else _rotationQuat = RotationY * RotationX More...

var	_scaleX
	rotation using quaternion, if _rotationZ_X == _rotationZ_Y, _rotationQuat = RotationZ_X * RotationY * RotationX, else _rotationQuat = RotationY * RotationX More...

local	_scaleX
	rotation using quaternion, if _rotationZ_X == _rotationZ_Y, _rotationQuat = RotationZ_X * RotationY * RotationX, else _rotationQuat = RotationY * RotationX More...

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

float	_scaleZ
	scaling factor on z-axis More...

var	_scaleZ
	scaling factor on z-axis More...

local	_scaleZ
	scaling factor on z-axis More...

Vec2	_position
	position of the node More...

var	_position
	position of the node More...

local	_position
	position of the node More...

float	_positionZ
	OpenGL real Z position. More...

var	_positionZ
	OpenGL real Z position. More...

local	_positionZ
	OpenGL real Z position. More...

Vec2	_normalizedPosition
var	_normalizedPosition
local	_normalizedPosition
bool	_usingNormalizedPosition
var	_usingNormalizedPosition
local	_usingNormalizedPosition
bool	_normalizedPositionDirty
var	_normalizedPositionDirty
local	_normalizedPositionDirty
float	_skewX
	skew angle on x-axis More...

var	_skewX
	skew angle on x-axis More...

local	_skewX
	skew angle on x-axis More...

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

var	_skewY
	skew angle on y-axis More...

local	_skewY
	skew angle on y-axis More...

Vec2	_anchorPointInPoints
	anchor point in points More...

var	_anchorPointInPoints
	anchor point in points More...

local	_anchorPointInPoints
	anchor point in points More...

Vec2	_anchorPoint
	anchor point normalized (NOT in points) More...

var	_anchorPoint
	anchor point normalized (NOT in points) More...

local	_anchorPoint
	anchor point normalized (NOT in points) More...

Size	_contentSize
	untransformed size of the node More...

bool	_contentSizeDirty
	whether or not the contentSize is dirty More...

var	_contentSizeDirty
	whether or not the contentSize is dirty More...

local	_contentSizeDirty
	whether or not the contentSize is dirty More...

Mat4	_modelViewTransform
	ModelView transform of the Node. More...

var	_modelViewTransform
	ModelView transform of the Node. More...

local	_modelViewTransform
	ModelView transform of the Node. More...

Mat4	_transform
	transform More...

var	_transform
	transform More...

local	_transform
	transform More...

bool	_transformDirty
	transform dirty flag More...

var	_transformDirty
	transform dirty flag More...

local	_transformDirty
	transform dirty flag More...

Mat4	_inverse
	inverse transform More...

local	_inverse
	inverse transform More...

bool	_inverseDirty
	inverse transform dirty flag More...

var	_inverseDirty
	inverse transform dirty flag More...

local	_inverseDirty
	inverse transform dirty flag More...

Mat4	_additionalTransform
	transform More...

var	_additionalTransform
	transform More...

local	_additionalTransform
	transform More...

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

var	_useAdditionalTransform
	The flag to check whether the additional transform is dirty. More...

local	_useAdditionalTransform
	The flag to check whether the additional transform is dirty. More...

bool	_transformUpdated
	Whether or not the Transform object was updated since the last frame. More...

int	_localZOrder
	Local order (relative to its siblings) used to sort the node. More...

var	_localZOrder
	Local order (relative to its siblings) used to sort the node. More...

local	_localZOrder
	Local order (relative to its siblings) used to sort the node. More...

float	_globalZOrder
	Global order used to sort the node. More...

var	_globalZOrder
	Global order used to sort the node. More...

local	_globalZOrder
	Global order used to sort the node. More...

Vector< Node * >	_children
	array of children nodes More...

var	_children
	array of children nodes More...

local	_children
	array of children nodes More...

Node *	_parent
	weak reference to parent node More...

var	_parent
	weak reference to parent node More...

local	_parent
	weak reference to parent node More...

Director *	_director
var	_director
local	_director
int	_tag
	a tag. Can be any number you assigned just to identify this node More...

var	_tag
	a tag. Can be any number you assigned just to identify this node More...

local	_tag
	a tag. Can be any number you assigned just to identify this node More...

std::string	_name
	a string label, an user defined string to identify this node More...

var	_name
	a string label, an user defined string to identify this node More...

local	_name
	a string label, an user defined string to identify this node More...

size_t	_hashOfName
	hash value of _name, used for speed in getChildByName More...

var	_hashOfName
	hash value of _name, used for speed in getChildByName More...

local	_hashOfName
	hash value of _name, used for speed in getChildByName More...

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

var	_userData
	A user assingned void pointer, Can be point to any cpp object. More...

local	_userData
	A user assingned void pointer, Can be point to any cpp object. More...

Ref *	_userObject
	A user assigned Object. More...

var	_userObject
	A user assigned Object. More...

local	_userObject
	A user assigned Object. More...

GLProgramState *	_glProgramState
	OpenGL Program State. More...

var	_glProgramState
	OpenGL Program State. More...

local	_glProgramState
	OpenGL Program State. More...

int	_orderOfArrival
	used to preserve sequence while sorting children with the same localZOrder More...

var	_orderOfArrival
	used to preserve sequence while sorting children with the same localZOrder More...

local	_orderOfArrival
	used to preserve sequence while sorting children with the same localZOrder More...

Scheduler *	_scheduler
	scheduler used to schedule timers and updates More...

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

EventDispatcher *	_eventDispatcher
	event dispatcher used to dispatch all kinds of events More...

var	_eventDispatcher
	event dispatcher used to dispatch all kinds of events More...

local	_eventDispatcher
	event dispatcher used to dispatch all kinds of events More...

bool	_running
	is running More...

var	_running
	is running More...

local	_running
	is running More...

bool	_visible
	is this node visible More...

var	_visible
	is this node visible More...

local	_visible
	is this node visible More...

bool	_ignoreAnchorPointForPosition
	true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...

var	_ignoreAnchorPointForPosition
	true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...

local	_ignoreAnchorPointForPosition
	true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...

bool	_reorderChildDirty
	children order dirty flag More...

bool	_isTransitionFinished
	flag to indicate whether the transition was finished More...

var	_isTransitionFinished
	flag to indicate whether the transition was finished More...

local	_isTransitionFinished
	flag to indicate whether the transition was finished More...

ComponentContainer *	_componentContainer
	Dictionary of components. More...

var	_componentContainer
	Dictionary of components. More...

local	_componentContainer
	Dictionary of components. More...

PhysicsBody *	_physicsBody
	the physicsBody the node have More...

var	_physicsBody
	the physicsBody the node have More...

local	_physicsBody
	the physicsBody the node have More...

float	_physicsScaleStartX
	the scale x value when setPhysicsBody More...

var	_physicsScaleStartX
	the scale x value when setPhysicsBody More...

local	_physicsScaleStartX
	the scale x value when setPhysicsBody More...

float	_physicsScaleStartY
	the scale y value when setPhysicsBody More...

var	_physicsScaleStartY
	the scale y value when setPhysicsBody More...

local	_physicsScaleStartY
	the scale y value when setPhysicsBody More...

float	_physicsRotation
var	_physicsRotation
local	_physicsRotation
bool	_physicsTransformDirty
var	_physicsTransformDirty
local	_physicsTransformDirty
bool	_updateTransformFromPhysics
var	_updateTransformFromPhysics
local	_updateTransformFromPhysics
GLubyte	_displayedOpacity
var	_displayedOpacity
local	_displayedOpacity
GLubyte	_realOpacity
var	_realOpacity
local	_realOpacity
Color3B	_displayedColor
var	_displayedColor
local	_displayedColor
Color3B	_realColor
var	_realColor
local	_realColor
bool	_cascadeColorEnabled
var	_cascadeColorEnabled
local	_cascadeColorEnabled
bool	_cascadeOpacityEnabled
var	_cascadeOpacityEnabled
local	_cascadeOpacityEnabled
unsigned short	_cameraMask
var	_cameraMask
local	_cameraMask
std::function< void()>	_onEnterCallback
var	_onEnterCallback
local	_onEnterCallback
std::function< void()>	_onExitCallback
var	_onExitCallback
local	_onExitCallback
std::function< void()>	_onEnterTransitionDidFinishCallback
std::function< void()>	_onExitTransitionDidStartCallback
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

var	_referenceCount
	count of references More...

local	_referenceCount
	count of references More...

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

var	INVALID_TAG = -1
	Default tag used for all the nodes. More...

local	INVALID_TAG = -1
	Default tag used for all the nodes. More...

Static Protected Attributes inherited from Widget
static Widget *	_focusedWidget
	store the only one focued widget More...

Static Protected Attributes inherited from Node
static int	s_globalOrderOfArrival
var	s_globalOrderOfArrival
local	s_globalOrderOfArrival

Detailed Description

For creating a system font or a TTF font Text.

Member Enumeration Documentation

enum Type

strong

Enumerator
SYSTEM
TTF

var Type

strong

Enumerator
SYSTEM
TTF

Constructor & Destructor Documentation

Text ( )

virtual ~Text ( )

virtual

Default destructor.

var ~Text ( )

virtual

Default destructor.

Member Function Documentation

virtual void adaptRenderers ( )

overrideprotectedvirtual

Reimplemented from Widget.

var adaptRenderers ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void copySpecialProperties ( Widget * model )

overrideprotectedvirtual

Reimplemented from Widget.

var copySpecialProperties ( var model )

overrideprotectedvirtual

Reimplemented from Widget.

static Text* create ( )

static

Allocates and initializes.

var create ( )

static

Allocates and initializes.

static Text* create	(	const std::string &	textContent,
		const std::string &	fontName,
		int	fontSize
	)

static

create a Text object with textContent, fontName and fontSize the fontName could be a system font name or a TTF file path.

Usage: Text *text = Text::create("Hello", "Arial", 20); //create a system font UIText Text *text = Text::create("Hello", "xxx\xxx.ttf", 20); //create a TTF font UIText

var create	(	var	textContent,
		var	fontName,
		var	fontSize
	)

static

create a Text object with textContent, fontName and fontSize the fontName could be a system font name or a TTF file path.

Usage: Text *text = Text::create("Hello", "Arial", 20); //create a system font UIText Text *text = Text::create("Hello", "xxx\xxx.ttf", 20); //create a TTF font UIText

virtual Widget* createCloneInstance ( )

overrideprotectedvirtual

Reimplemented from Widget.

var createCloneInstance ( )

overrideprotectedvirtual

Reimplemented from Widget.

void disableEffect ( )

disable shadow/outline/glow rendering

var disableEffect ( )

disable shadow/outline/glow rendering

void enableGlow ( const Color4B & glowColor )

only support for TTF

var enableGlow ( var glowColor )

only support for TTF

void enableOutline	(	const Color4B &	outlineColor,
		int	outlineSize = `1`
	)

Enable outline for the label It only works on IOS and Android when you use System fonts.

var enableOutline	(	var	outlineColor,
		var	outlineSize = `1`
	)

Enable outline for the label It only works on IOS and Android when you use System fonts.

void enableShadow	(	const Color4B &	shadowColor = `Color4B::BLACK`,
		const Size &	offset = `Size(2,-2)`,
		int	blurRadius = `0`
	)

Enable shadow for the label.

Todo:: support blur for shadow effect

var enableShadow	(	var	shadowColor = `Color4B::BLACK`,
		var	offset = `Size(2,-2)`,
		var	blurRadius = `0`
	)

Enable shadow for the label.

Todo:: support blur for shadow effect

virtual Size getAutoRenderSize ( )

virtual

var getAutoRenderSize ( )

virtual

virtual std::string getDescription ( ) const

overridevirtual

Returns the "class name" of widget.

Reimplemented from Widget.

var getDescription ( )

overridevirtual

Returns the "class name" of widget.

Reimplemented from Widget.

const std::string& getFontName ( ) const

var getFontName ( )

int getFontSize ( ) const

var getFontSize ( )

const std::string& getString ( ) const

var getString ( )

ssize_t getStringLength ( ) const

Gets the string length of the label.

Note: This length will be larger than the raw string length, if you want to get the raw string length, you should call this->getString().size() instead

Returns: string length.

var getStringLength ( )

Gets the string length of the label.

Note: This length will be larger than the raw string length, if you want to get the raw string length, you should call this->getString().size() instead

Returns: string length.

const std::string& getStringValue ( )

inline

Gets the string value of label.

Returns: string value.

var getStringValue ( )

inline

Gets the string value of label.

Returns: string value.

const Size& getTextAreaSize ( ) const

var getTextAreaSize ( )

const Color4B& getTextColor ( ) const

var getTextColor ( )

TextHAlignment
getTextHorizontalAlignment ( ) const

var getTextHorizontalAlignment ( )

TextVAlignment
getTextVerticalAlignment ( ) const

var getTextVerticalAlignment ( )

Type getType ( ) const

var getType ( )

virtual Node* getVirtualRenderer ( )

overridevirtual

Gets the Virtual Renderer of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns: Node pointer.

Reimplemented from Widget.

var getVirtualRenderer ( )

overridevirtual

Gets the Virtual Renderer of widget.

For example, a button's Virtual Renderer is it's texture renderer.

Returns: Node pointer.

Reimplemented from Widget.

virtual Size getVirtualRendererSize ( ) const

overridevirtual

Reimplemented from Widget.

var getVirtualRendererSize ( )

overridevirtual

Reimplemented from Widget.

virtual bool init	(	const std::string &	textContent,
		const std::string &	fontName,
		int	fontSize
	)

virtual

var init	(	var	textContent,
		var	fontName,
		var	fontSize
	)

virtual

virtual void initRenderer ( )

overrideprotectedvirtual

Reimplemented from Widget.

var initRenderer ( )

overrideprotectedvirtual

Reimplemented from Widget.

bool isTouchScaleChangeEnabled ( ) const

Gets the touch scale enabled of label.

Returns: touch scale enabled of label.

var isTouchScaleChangeEnabled ( )

Gets the touch scale enabled of label.

Returns: touch scale enabled of label.

void labelScaleChangedWithSize ( )

protected

var labelScaleChangedWithSize ( )

protected

virtual void
onPressStateChangedToDisabled ( )

overrideprotectedvirtual

Reimplemented from Widget.

var onPressStateChangedToDisabled ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void
onPressStateChangedToNormal ( )

overrideprotectedvirtual

Reimplemented from Widget.

var onPressStateChangedToNormal ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void
onPressStateChangedToPressed ( )

overrideprotectedvirtual

Reimplemented from Widget.

var onPressStateChangedToPressed ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void onSizeChanged ( )

overrideprotectedvirtual

Reimplemented from Widget.

var onSizeChanged ( )

overrideprotectedvirtual

Reimplemented from Widget.

void setFontName ( const std::string & name )

Sets the font name of label.

If you are trying to use a system font, you could just pass a font name If you are trying to use a TTF, you should pass a file path to the TTF file Usage: Text *text = Text::create("Hello", "Arial", 20); //create a system font UIText text->setFontName("Marfelt"); // it will change the font to system font no matter the previous font type is TTF or system font text->setFontName("xxxx/xxx.ttf"); //it will change the font to TTF font no matter the previous font type is TTF or system font

Parameters

name	font name.

var setFontName ( var name )

Sets the font name of label.

If you are trying to use a system font, you could just pass a font name If you are trying to use a TTF, you should pass a file path to the TTF file Usage: Text *text = Text::create("Hello", "Arial", 20); //create a system font UIText text->setFontName("Marfelt"); // it will change the font to system font no matter the previous font type is TTF or system font text->setFontName("xxxx/xxx.ttf"); //it will change the font to TTF font no matter the previous font type is TTF or system font

Parameters

name	font name.

void setFontSize ( int size )

Sets the font size of label.

Parameters

size	font size.

var setFontSize ( var size )

Sets the font size of label.

Parameters

size	font size.

void setString ( const std::string & text )

var setString ( var text )

void setText ( const std::string & text )

inline

Changes the string value of label.

Parameters

text	string value.

var setText ( var text )

inline

Changes the string value of label.

Parameters

text	string value.

void setTextAreaSize ( const Size & size )

Set the rendering size of the text, you should call this method along with calling ignoreContentAdaptWithSize(false), otherwise the text area size is caculated by the real size of the text content.

Parameters

size	The text rendering area size

var setTextAreaSize ( var size )

Set the rendering size of the text, you should call this method along with calling ignoreContentAdaptWithSize(false), otherwise the text area size is caculated by the real size of the text content.

Parameters

size	The text rendering area size

void setTextColor ( const Color4B color )

var setTextColor ( var color )

void setTextHorizontalAlignment ( TextHAlignment alignment )

var setTextHorizontalAlignment ( var alignment )

void setTextVerticalAlignment ( TextVAlignment alignment )

var setTextVerticalAlignment ( var alignment )

void setTouchScaleChangeEnabled ( bool enabled )

Sets the touch scale enabled of label.

Parameters

enabled touch scale enabled of label.

var setTouchScaleChangeEnabled ( var enabled )

Sets the touch scale enabled of label.

Parameters

enabled touch scale enabled of label.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

std::string _fontName

protected

var _fontName

protected

int _fontSize

protected

var _fontSize

protected

Label* _labelRenderer

protected

var _labelRenderer

protected

bool _labelRendererAdaptDirty

protected

var _labelRendererAdaptDirty

protected

float _normalScaleValueX

protected

var _normalScaleValueX

protected

float _normalScaleValueY

protected

var _normalScaleValueY

protected

float _onSelectedScaleOffset

protected

var _onSelectedScaleOffset

protected

bool _touchScaleChangeEnabled

protected

var _touchScaleChangeEnabled

protected

Type _type

protected

var _type

protected

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

/Users/huabingxu/work/cocos2d-x/cocos/ui/UIText.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation