#include <UIButton.h>

Inheritance diagram for Button:

Public Member Functions
	Button ()
	Default constructor. More...

virtual	~Button ()
	Default destructor. More...

void	loadTextures (const std::string &normal, const std::string &selected, const std::string &disabled="", TextureResType texType=TextureResType::LOCAL)
	Load textures for button. More...

void	loadTextureNormal (const std::string &normal, TextureResType texType=TextureResType::LOCAL)
	Load normal state texture for button. More...

void	loadTexturePressed (const std::string &selected, TextureResType texType=TextureResType::LOCAL)
	Load selected state texture for button. More...

void	loadTextureDisabled (const std::string &disabled, TextureResType texType=TextureResType::LOCAL)
	Load dark state texture for button. More...

void	setCapInsets (const Rect &capInsets)
	Sets capinsets for button, if button is using scale9 renderer. More...

void	setCapInsetsNormalRenderer (const Rect &capInsets)
	Sets capinsets for button, if button is using scale9 renderer. More...

const Rect &	getCapInsetsNormalRenderer () const

void	setCapInsetsPressedRenderer (const Rect &capInsets)
	Sets capinsets for button, if button is using scale9 renderer. More...

const Rect &	getCapInsetsPressedRenderer () const

void	setCapInsetsDisabledRenderer (const Rect &capInsets)
	Sets capinsets for button, if button is using scale9 renderer. More...

const Rect &	getCapInsetsDisabledRenderer () const

virtual void	setScale9Enabled (bool able)
	Sets if button is using scale9 renderer. More...

bool	isScale9Enabled () const

void	setPressedActionEnabled (bool enabled)
	Changes if button can be clicked zoom effect. More...

virtual void	ignoreContentAdaptWithSize (bool ignore) override
	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...

virtual Size	getVirtualRendererSize () const override

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

Label *	getTitleRenderer () const
	Return the inner title renderer of Button. More...

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

void	setTitleText (const std::string &text)

const std::string &	getTitleText () const

void	setTitleColor (const Color3B &color)

const Color3B &	getTitleColor () const

void	setTitleFontSize (float size)

float	getTitleFontSize () const

void	setTitleFontName (const std::string &fontName)

const std::string &	getTitleFontName () const

void	setZoomScale (float scale)
	When user pressed the button, the button will zoom to a scale. More...

float	getZoomScale () const
	Return a zoom scale. More...

virtual bool	init (const std::string &normalImage, const std::string &selectedImage="", const std::string &disableImage="", TextureResType texType=TextureResType::LOCAL)

Public Member Functions inherited from Widget
	Widget (void)
	Default constructor. More...

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 () const
	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)

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

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

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

virtual void	updateDisplayedColor (const Color3B &parentColor) override

virtual void	disableCascadeColor () override

virtual void	disableCascadeOpacity () override

virtual	~ProtectedNode ()

virtual void	addProtectedChild (Node *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...

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

virtual void	removeProtectedChild (Node *child, bool cleanup=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...

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

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

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

virtual void	draw () final

virtual void	visit () final

virtual Scene *	getScene () const
	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

virtual void	setEventDispatcher (EventDispatcher *dispatcher)

virtual EventDispatcher *	getEventDispatcher () const

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

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

virtual GLubyte	getOpacity () const

virtual GLubyte	getDisplayedOpacity () const

virtual void	setOpacity (GLubyte opacity)

virtual bool	isCascadeOpacityEnabled () const

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)

virtual const Color3B &	getColor () const

virtual const Color3B &	getDisplayedColor () const

virtual void	setColor (const Color3B &color)

virtual bool	isCascadeColorEnabled () const

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)

virtual void	setOpacityModifyRGB (bool value)

virtual bool	isOpacityModifyRGB () const

void	setOnEnterCallback (const std::function< void()> &callback)

const std::function< void()> &	getOnEnterCallback () const

void	setOnExitCallback (const std::function< void()> &callback)

const std::function< void()> &	getOnExitCallback () const

void	setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)

const std::function< void()> &	getonEnterTransitionDidFinishCallback () const

void	setonExitTransitionDidStartCallback (const std::function< void()> &callback)

const std::function< void()> &	getonExitTransitionDidStartCallback () const

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)

virtual	~Node ()

virtual bool	init ()

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

virtual void	setZOrder (int localZOrder)

virtual void	_setLocalZOrder (int z)

virtual int	getLocalZOrder () const
	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...

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

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

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

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

virtual float	getPositionX (void) const

virtual void	setPositionY (float y)

virtual float	getPositionY (void) const

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

virtual void	setVertexZ (float vertexZ)

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

virtual float	getVertexZ () const

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

virtual float	getSkewX () const
	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...

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

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

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

virtual const Vec2 &	getAnchorPointInPoints () const
	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...

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

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

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

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

virtual void	setRotationX (float rotationX)

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

virtual float	getRotationX () const

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

virtual void	setRotationY (float rotationY)

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

virtual float	getRotationY () const

void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

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

void	setGLServerState (int serverState)

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

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

virtual void	addChild (Node *child, int localZOrder, const std::string &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...

virtual Node *	getChildByName (const std::string &name) const
	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...

virtual const Vector< Node * > &	getChildren () const

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

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

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

virtual const Node *	getParent () const

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

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

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

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

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

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

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

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

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

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

virtual std::string	getName () const
	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...

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

virtual const void *	getUserData () const
	NA NA More...

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

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

GLProgram *	getGLProgram () const
	Return the GLProgram (shader) currently used for this node. More...

GLProgram *	getShaderProgram () const

GLProgramState *	getGLProgramState () const

virtual void	setGLProgramState (GLProgramState *glProgramState)

virtual void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...

void	setShaderProgram (GLProgram *glprogram)

virtual void	setActionManager (ActionManager *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...

virtual const ActionManager *	getActionManager () const

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

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

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

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

ssize_t	numberOfRunningActions () const

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

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)

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

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

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

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

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

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

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

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

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

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

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

void	unscheduleAllSelectors ()

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

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

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

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

virtual void	update (float delta)

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

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

virtual AffineTransform	nodeToParentTransform () const

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

virtual AffineTransform	getParentToNodeAffineTransform () const

virtual AffineTransform	parentToNodeTransform () const

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

virtual AffineTransform	getNodeToWorldAffineTransform () const

virtual AffineTransform	nodeToWorldTransform () const

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

virtual AffineTransform	getWorldToNodeAffineTransform () const

virtual AffineTransform	worldToNodeTransform () const

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

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

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

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

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

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

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

void	setAdditionalTransform (const AffineTransform &additionalTransform)

Component *	getComponent (const std::string &name)
	gets a component by its name More...

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

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

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

virtual void	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 ()
	NA NA More...

Public Member Functions inherited from LayoutParameterProtocol
virtual	~LayoutParameterProtocol ()

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

static Button *	create (const std::string &normalImage, const std::string &selectedImage="", const std::string &disableImage="", TextureResType texType=TextureResType::LOCAL)
	create a button with custom textures normal state texture name selected state texture name disabled state texture name 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...

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

virtual void	onPressStateChangedToNormal () override

virtual void	onPressStateChangedToPressed () override

virtual void	onPressStateChangedToDisabled () override

virtual void	onSizeChanged () override

void	normalTextureScaleChangedWithSize ()

void	pressedTextureScaleChangedWithSize ()

void	disabledTextureScaleChangedWithSize ()

virtual void	adaptRenderers () override

void	updateTitleLocation ()

void	updateContentSize ()

virtual Widget *	createCloneInstance () override

virtual void	copySpecialProperties (Widget *model) override

virtual Size	getNormalSize () const

Protected Member Functions inherited from Widget
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...

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

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

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

Mat4	transform (const Mat4 &parentTransform)

uint32_t	processParentFlags (const Mat4 &parentTransform, uint32_t parentFlags)

virtual void	updateCascadeOpacity ()

virtual void	updateCascadeColor ()

virtual void	updateColor ()

bool	doEnumerate (std::string name, std::function< bool(Node *)> callback) const

bool	doEnumerateRecursive (const Node node, const std::string &name, std::function< bool(Node )> callback) const

bool	isVisitableByVisitingCamera () const

void	updatePhysicsBodyTransform (Scene *layer)

virtual void	updatePhysicsBodyPosition (Scene *layer)

virtual void	updatePhysicsBodyRotation (Scene *layer)

virtual void	updatePhysicsBodyScale (Scene *scene)

Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
Scale9Sprite *	_buttonNormalRenderer

Scale9Sprite *	_buttonClickedRenderer

Scale9Sprite *	_buttonDisableRenderer

Label *	_titleRenderer

float	_zoomScale

std::string	_normalFileName

std::string	_clickedFileName

std::string	_disabledFileName

bool	_prevIgnoreSize

bool	_scale9Enabled

Rect	_capInsetsNormal

Rect	_capInsetsPressed

Rect	_capInsetsDisabled

TextureResType	_normalTexType

TextureResType	_pressedTexType

TextureResType	_disabledTexType

Size	_normalTextureSize

Size	_pressedTextureSize

Size	_disabledTextureSize

bool	_pressedActionEnabled

float	_normalTextureScaleXInSize

float	_normalTextureScaleYInSize

float	_pressedTextureScaleXInSize

float	_pressedTextureScaleYInSize

bool	_normalTextureLoaded

bool	_pressedTextureLoaded

bool	_disabledTextureLoaded

bool	_normalTextureAdaptDirty

bool	_pressedTextureAdaptDirty

bool	_disabledTextureAdaptDirty

Protected Attributes inherited from Widget
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

Protected Attributes inherited from Node
float	_rotationX
	rotation on the X-axis More...

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

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

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

float	_scaleX
	scaling factor on x-axis More...

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

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

Vec2	_position
	position of the node More...

float	_positionZ
	OpenGL real Z position. More...

Vec2	_normalizedPosition

bool	_usingNormalizedPosition

bool	_normalizedPositionDirty

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

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

Vec2	_anchorPointInPoints
	anchor point in points More...

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

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

Mat4	_transform
	transform More...

bool	_transformDirty
	transform dirty flag More...

Mat4	_inverse
	inverse transform More...

bool	_inverseDirty
	inverse transform dirty flag More...

Mat4	_additionalTransform
	transform More...

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

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

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

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

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

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

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

GLProgramState *	_glProgramState
	OpenGL Program State. More...

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

bool	_running
	is running More...

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

bool	_reorderChildDirty
	children order dirty flag More...

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

ComponentContainer *	_componentContainer
	Dictionary of components. More...

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

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

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

GLubyte	_displayedOpacity

GLubyte	_realOpacity

Color3B	_displayedColor

Color3B	_realColor

bool	_cascadeColorEnabled

bool	_cascadeOpacityEnabled

unsigned short	_cameraMask

std::function< void()>	_onEnterCallback

std::function< void()>	_onExitCallback

std::function< void()>	_onEnterTransitionDidFinishCallback

std::function< void()>	_onExitTransitionDidStartCallback

Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Additional Inherited Members
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_DIRTY_MASK = (FLAGS_TRANSFORM_DIRTY \| FLAGS_CONTENT_SIZE_DIRTY) }

Static Public Attributes inherited from Node
static const int	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

Detailed Description

NA NA

Constructor & Destructor Documentation

Button ( )

Default constructor.

virtual ~Button ( )

virtual

Default destructor.

Member Function Documentation

virtual void adaptRenderers ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void copySpecialProperties ( Widget * model )

overrideprotectedvirtual

Reimplemented from Widget.

static Button* create ( )

static

Allocates and initializes.

static Button* create	(	const std::string &	normalImage,
		const std::string &	selectedImage = `""`,
		const std::string &	disableImage = `""`,
		TextureResType	texType = `TextureResType::LOCAL`
	)

static

create a button with custom textures normal state texture name selected state texture name disabled state texture name

Parameters

texType

See also: UI_TEX_TYPE_LOCAL

virtual Widget* createCloneInstance ( )

overrideprotectedvirtual

Reimplemented from Widget.

void disabledTextureScaleChangedWithSize ( )

protected

const Rect& getCapInsetsDisabledRenderer ( ) const

const Rect& getCapInsetsNormalRenderer ( ) const

const Rect& getCapInsetsPressedRenderer ( ) const

virtual std::string getDescription ( ) const

overridevirtual

Returns the "class name" of widget.

Reimplemented from Widget.

virtual Size getNormalSize ( ) const

protectedvirtual

const Color3B& getTitleColor ( ) const

const std::string& getTitleFontName ( ) const

float getTitleFontSize ( ) const

Label* getTitleRenderer ( ) const

Return the inner title renderer of Button.

Since: v3.3

const std::string& getTitleText ( ) const

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.

virtual Size getVirtualRendererSize ( ) const

overridevirtual

Reimplemented from Widget.

float getZoomScale ( ) const

Return a zoom scale.

Since: v3.3

virtual void ignoreContentAdaptWithSize ( bool ignore )

overridevirtual

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.

Parameters

ignore,set member variabl _ignoreSize to ignore

Reimplemented from Widget.

virtual bool init	(	const std::string &	normalImage,
		const std::string &	selectedImage = `""`,
		const std::string &	disableImage = `""`,
		TextureResType	texType = `TextureResType::LOCAL`
	)

virtual

virtual void initRenderer ( )

overrideprotectedvirtual

Reimplemented from Widget.

bool isScale9Enabled ( ) const

void loadTextureDisabled	(	const std::string &	disabled,
		TextureResType	texType = `TextureResType::LOCAL`
	)

Load dark state texture for button.

Parameters

disabled	dark state texture.
texType

See also: TextureResType

void loadTextureNormal	(	const std::string &	normal,
		TextureResType	texType = `TextureResType::LOCAL`
	)

Load normal state texture for button.

Parameters

normal	normal state texture.
texType

See also: TextureResType

void loadTexturePressed	(	const std::string &	selected,
		TextureResType	texType = `TextureResType::LOCAL`
	)

Load selected state texture for button.

Parameters

selected	selected state texture.
texType

See also: TextureResType

void loadTextures	(	const std::string &	normal,
		const std::string &	selected,
		const std::string &	disabled = `""`,
		TextureResType	texType = `TextureResType::LOCAL`
	)

Load textures for button.

Parameters

normal	normal state texture name.
selected	selected state texture name.
disabled	disabled state texture name.
texType

See also: TextureResType

void normalTextureScaleChangedWithSize ( )

protected

virtual void onPressStateChangedToDisabled ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void onPressStateChangedToNormal ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void onPressStateChangedToPressed ( )

overrideprotectedvirtual

Reimplemented from Widget.

virtual void onSizeChanged ( )

overrideprotectedvirtual

Reimplemented from Widget.

void pressedTextureScaleChangedWithSize ( )

protected

void setCapInsets ( const Rect & capInsets )

Sets capinsets for button, if button is using scale9 renderer.

Parameters

capInsets capinsets for button

void setCapInsetsDisabledRenderer ( const Rect & capInsets )

Sets capinsets for button, if button is using scale9 renderer.

Parameters

capInsets capinsets for button

void setCapInsetsNormalRenderer ( const Rect & capInsets )

Sets capinsets for button, if button is using scale9 renderer.

Parameters

capInsets capinsets for button

void setCapInsetsPressedRenderer ( const Rect & capInsets )

Sets capinsets for button, if button is using scale9 renderer.

Parameters

capInsets capinsets for button

void setPressedActionEnabled ( bool enabled )

Changes if button can be clicked zoom effect.

Parameters

true	that can be clicked zoom effect, false otherwise.

virtual void setScale9Enabled ( bool able )

virtual

Sets if button is using scale9 renderer.

Parameters

true	that using scale9 renderer, false otherwise.

void setTitleColor ( const Color3B & color )

void setTitleFontName ( const std::string & fontName )

void setTitleFontSize ( float size )

void setTitleText ( const std::string & text )

void setZoomScale ( float scale )

When user pressed the button, the button will zoom to a scale.

The final scale of the button equals (button original scale + _zoomScale)

Since: v3.3

void updateContentSize ( )

protected

void updateTitleLocation ( )

protected

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

Scale9Sprite* _buttonClickedRenderer

protected

Scale9Sprite* _buttonDisableRenderer

protected

Scale9Sprite* _buttonNormalRenderer

protected

Rect _capInsetsDisabled

protected

Rect _capInsetsNormal

protected

Rect _capInsetsPressed

protected

std::string _clickedFileName

protected

std::string _disabledFileName

protected

bool _disabledTextureAdaptDirty

protected

bool _disabledTextureLoaded

protected

Size _disabledTextureSize

protected

TextureResType _disabledTexType

protected

std::string _normalFileName

protected

bool _normalTextureAdaptDirty

protected

bool _normalTextureLoaded

protected

float _normalTextureScaleXInSize

protected

float _normalTextureScaleYInSize

protected

Size _normalTextureSize

protected

TextureResType _normalTexType

protected

bool _pressedActionEnabled

protected

bool _pressedTextureAdaptDirty

protected

bool _pressedTextureLoaded

protected

float _pressedTextureScaleXInSize

protected

float _pressedTextureScaleYInSize

protected

Size _pressedTextureSize

protected

TextureResType _pressedTexType

protected

bool _prevIgnoreSize

protected

bool _scale9Enabled

protected

Label* _titleRenderer

protected

float _zoomScale

protected

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

/Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/cocos/ui/UIButton.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation