cocos2d-x  3.0rc1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Menu Class Reference

A Menu. More...

#include <CCMenu.h>

Inheritance diagram for Menu:
Layer Node Ref

Public Types

enum  State { WAITING, TRACKING_TOUCH }
 
typedef MenuItemM

Public Member Functions

void alignItemsVertically ()
 align items vertically More...
 
void alignItemsVerticallyWithPadding (float padding)
 align items vertically with padding More...
 
var alignItemsVerticallyWithPadding ( var padding)
 align items vertically with padding More...
 
local alignItemsVerticallyWithPadding ( local padding)
 align items vertically with padding More...
 
void alignItemsHorizontally ()
 align items horizontally More...
 
var alignItemsHorizontally ()
 align items horizontally More...
 
local alignItemsHorizontally ()
 align items horizontally More...
 
void alignItemsHorizontallyWithPadding (float padding)
 align items horizontally with padding More...
 
var alignItemsHorizontallyWithPadding ( var padding)
 align items horizontally with padding More...
 
local alignItemsHorizontallyWithPadding ( local padding)
 align items horizontally with padding More...
 
void alignItemsInColumns (int columns,...) CC_REQUIRES_NULL_TERMINATION
 align items in rows of columns More...
 
var alignItemsInColumns ( var columns)
 align items in rows of columns More...
 
local alignItemsInColumns ( local columns)
 align items in rows of columns More...
 
void alignItemsInColumns (int columns, va_list args)
void alignItemsInColumnsWithArray (const ValueVector &rows)
var alignItemsInColumnsWithArray ( var rows)
local alignItemsInColumnsWithArray ( local rows)
void alignItemsInRows (int rows,...) CC_REQUIRES_NULL_TERMINATION
 align items in columns of rows More...
 
var alignItemsInRows ( var rows)
 align items in columns of rows More...
 
local alignItemsInRows ( local rows)
 align items in columns of rows More...
 
void alignItemsInRows (int rows, va_list args)
var alignItemsInRows ( var rows, var args)
local alignItemsInRows ( local rows, local args)
void alignItemsInRowsWithArray (const ValueVector &columns)
var alignItemsInRowsWithArray ( var columns)
local alignItemsInRowsWithArray ( local columns)
virtual bool isEnabled () const
var isEnabled ()
local isEnabled ()
virtual void setEnabled (bool value)
var setEnabled ( var value)
local setEnabled ( local value)
virtual bool onTouchBegan (Touch *touch, Event *event)
var onTouchBegan ( var touch, var event)
local onTouchBegan ( local touch, local event)
virtual void onTouchEnded (Touch *touch, Event *event)
local onTouchEnded ( local touch, local event)
virtual void onTouchCancelled (Touch *touch, Event *event)
var onTouchCancelled ( var touch, var event)
local onTouchCancelled ( local touch, local event)
virtual void onTouchMoved (Touch *touch, Event *event)
var onTouchMoved ( var touch, var event)
local onTouchMoved ( local touch, local event)
virtual void removeChild (Node *child, bool cleanup) override
 Removes a child from the container. More...
 
var removeChild ( var child, var cleanup)
 Removes a child from the container. More...
 
local removeChild ( local child, local cleanup)
 Removes a child from the container. More...
 
virtual void addChild (Node *child) override
 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 zOrder) override
 Adds a child to the container with a local z-order. More...
 
var addChild ( var child, var zOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local zOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int zOrder, int tag) override
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual void onEnter () override
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
var onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
local onEnter ()
 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...
 
local onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void setOpacityModifyRGB (bool bValue) override
virtual bool isOpacityModifyRGB (void) const override
var isOpacityModifyRGB ()
local isOpacityModifyRGB ()
virtual std::string getDescription () const override
 Gets the description string. More...
 
local getDescription ()
 Gets the description string. More...
 
- Public Member Functions inherited from Layer
virtual
CC_DEPRECATED_ATTRIBUTE bool 
ccTouchBegan (Touch *pTouch, Event *pEvent) final
local ccTouchBegan ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchMoved (Touch *pTouch, Event *pEvent) final
local ccTouchMoved ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchEnded (Touch *pTouch, Event *pEvent) final
local ccTouchEnded ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchCancelled (Touch *pTouch, Event *pEvent) final
local ccTouchCancelled ( local pTouch, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesBegan (__Set *pTouches, Event *pEvent) final
local ccTouchesBegan ( local pTouches, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesMoved (__Set *pTouches, Event *pEvent) final
local ccTouchesMoved ( local pTouches, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesEnded (__Set *pTouches, Event *pEvent) final
local ccTouchesEnded ( local pTouches, local pEvent)
virtual
CC_DEPRECATED_ATTRIBUTE void 
ccTouchesCancelled (__Set *pTouches, Event *pEvent) final
local ccTouchesCancelled ( local pTouches, local pEvent)
virtual void onTouchesBegan (const std::vector< Touch * > &touches, Event *unused_event)
virtual void onTouchesMoved (const std::vector< Touch * > &touches, Event *unused_event)
local onTouchesMoved ( local touches, local unused_event)
virtual void onTouchesEnded (const std::vector< Touch * > &touches, Event *unused_event)
local onTouchesEnded ( local touches, local unused_event)
virtual void onTouchesCancelled (const std::vector< Touch * > &touches, Event *unused_event)
virtual
CC_DEPRECATED_ATTRIBUTE void 
didAccelerate (Acceleration *accelerationValue) final
local didAccelerate ( local accelerationValue)
virtual void onAcceleration (Acceleration *acc, Event *unused_event)
var onAcceleration ( var acc, var unused_event)
local onAcceleration ( local acc, local unused_event)
virtual
CC_DEPRECATED_ATTRIBUTE void 
registerWithTouchDispatcher () final
 If isTouchEnabled, this method is called onEnter. More...
 
var registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
local registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
CC_DEPRECATED_ATTRIBUTE bool isTouchEnabled () const
 whether or not it will receive Touch events. More...
 
local isTouchEnabled ()
 whether or not it will receive Touch events. More...
 
CC_DEPRECATED_ATTRIBUTE void setTouchEnabled (bool value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
setTouchMode (Touch::DispatchMode mode)
local setTouchMode ( local mode)
virtual
CC_DEPRECATED_ATTRIBUTE
Touch::DispatchMode 
getTouchMode () const
var getTouchMode ()
local getTouchMode ()
virtual
CC_DEPRECATED_ATTRIBUTE void 
setSwallowsTouches (bool swallowsTouches)
 swallowsTouches of the touch events. More...
 
local setSwallowsTouches ( local swallowsTouches)
 swallowsTouches of the touch events. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isSwallowsTouches () const
local isSwallowsTouches ()
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isAccelerometerEnabled () const
 
whether or not it will receive Accelerometer events

You can enable / disable accelerometer events with this property. More...

 
local isAccelerometerEnabled ()
 
whether or not it will receive Accelerometer events

You can enable / disable accelerometer events with this property. More...

 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setAccelerometerEnabled (bool value)
local setAccelerometerEnabled ( local value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
setAccelerometerInterval (double interval)
local setAccelerometerInterval ( local interval)
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isKeyboardEnabled () const
 
whether or not it will receive keyboard or keypad events

You can enable / disable accelerometer events with this property. More...

 
var isKeyboardEnabled ()
 
whether or not it will receive keyboard or keypad events

You can enable / disable accelerometer events with this property. More...

 
local isKeyboardEnabled ()
 
whether or not it will receive keyboard or keypad events

You can enable / disable accelerometer events with this property. More...

 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setKeyboardEnabled (bool value)
var setKeyboardEnabled ( var value)
local setKeyboardEnabled ( local value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyPressed (int keyCode) final
 Please use onKeyPressed instead. More...
 
local keyPressed ( local keyCode)
 Please use onKeyPressed instead. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyReleased (int keyCode) final
 Please use onKeyReleased instead. More...
 
local keyReleased ( local keyCode)
 Please use onKeyReleased instead. More...
 
virtual void onKeyPressed (EventKeyboard::KeyCode keyCode, Event *event)
var onKeyPressed ( var keyCode, var event)
local onKeyPressed ( local keyCode, local event)
virtual void onKeyReleased (EventKeyboard::KeyCode keyCode, Event *event)
local onKeyReleased ( local keyCode, local event)
virtual
CC_DEPRECATED_ATTRIBUTE bool 
isKeypadEnabled () const final
local isKeypadEnabled ()
virtual
CC_DEPRECATED_ATTRIBUTE void 
setKeypadEnabled (bool value)
local setKeypadEnabled ( local value)
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyBackClicked () final
local keyBackClicked ()
virtual
CC_DEPRECATED_ATTRIBUTE void 
keyMenuClicked () final
local keyMenuClicked ()
- 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...
 
local scheduleUpdateWithPriorityLua ( local handler, local priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 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 draw (Renderer *renderer, const kmMat4 &transform, bool transformUpdated)
 Override this method to draw your own node. More...
 
virtual void draw () final
var draw ()
local draw ()
virtual void visit (Renderer *renderer, const kmMat4 &parentTransform, bool parentTransformUpdated)
 Visits this node's children and draw them recursively. More...
 
var visit ( var renderer, var parentTransform, var parentTransformUpdated)
 Visits this node's children and draw them recursively. More...
 
local visit ( local renderer, local parentTransform, local parentTransformUpdated)
 Visits this node's children and draw them recursively. More...
 
virtual void visit () final
var visit ()
local visit ()
virtual ScenegetScene ()
 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...
 
var getBoundingBox ()
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
local getBoundingBox ()
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE Rect 
boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
virtual EventDispatchergetEventDispatcher () 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...
 
virtual GLubyte getOpacity () const
var getOpacity ()
local getOpacity ()
virtual GLubyte getDisplayedOpacity () const
var getDisplayedOpacity ()
local getDisplayedOpacity ()
virtual void setOpacity (GLubyte opacity)
local setOpacity ( local opacity)
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
var updateDisplayedOpacity ( var parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual bool isCascadeOpacityEnabled () const
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3BgetColor (void) const
local getColor ()
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual void setColor (const Color3B &color)
var setColor ( var color)
local setColor ( local color)
virtual void updateDisplayedColor (const Color3B &parentColor)
local updateDisplayedColor ( local parentColor)
virtual bool isCascadeColorEnabled () const
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setZOrder (int localZOrder)
local setZOrder ( local localZOrder)
virtual void _setLocalZOrder (int 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 CC_DEPRECATED_ATTRIBUTE int getZOrder () const
var getZOrder ()
local getZOrder ()
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 setScaleX (float scaleX)
 Sets the scale (x) of the node. More...
 
var setScaleX ( var scaleX)
 Sets the scale (x) of the node. More...
 
local setScaleX ( local scaleX)
 Sets the scale (x) of the node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float scaleY)
 Sets the scale (y) of the node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. More...
 
var getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
local getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
local setScaleZ ( local scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
virtual float getScaleZ () const
 Returns the scale factor on Z axis of this node. More...
 
virtual void setScale (float scale)
 Sets the scale (x,y,z) of the node. More...
 
local setScale ( local scale)
 Sets the scale (x,y,z) of the node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
local getScale ()
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float scaleX, float scaleY)
 Sets the scale (x,y) of the node. More...
 
local setScale ( local scaleX, local scaleY)
 Sets the scale (x,y) of the node. More...
 
virtual void setPosition (const Point &position)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const PointgetPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. 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 Point object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a Point 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)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual void setPosition3D (const Vertex3F &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
var setPosition3D ( var position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
local setPosition3D ( local position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
virtual Vertex3F getPosition3D () const
 returns the position (X,Y,Z) in its parent's coordinate system More...
 
local getPosition3D ()
 returns the position (X,Y,Z) in its parent's coordinate system More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setVertexZ (float 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
CC_DEPRECATED_ATTRIBUTE float 
getVertexZ () const
local getVertexZ ()
virtual void setSkewX (float skewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local skewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
var getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local skewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const Point &anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const PointgetAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const PointgetAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
local getAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local contentSize)
 Sets the untransformed size of the node. More...
 
virtual const SizegetContentSize () const
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vertex3F &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vertex3F getRotation3D () const
 returns the rotation (X,Y,Z) in degrees. More...
 
var getRotation3D ()
 returns the rotation (X,Y,Z) in degrees. More...
 
local getRotation3D ()
 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...
 
local setRotationSkewX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE void 
setRotationX (float rotationX)
local setRotationX ( local rotationX)
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
var getRotationSkewX ()
 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
CC_DEPRECATED_ATTRIBUTE float 
getRotationX () const
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
CC_DEPRECATED_ATTRIBUTE void 
setRotationY (float rotationY)
local setRotationY ( local rotationY)
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE float 
getRotationY () const
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...
 
CC_DEPRECATED_ATTRIBUTE void setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE 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 NodegetChildByTag (int tag)
 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 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 NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
var getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
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...
 
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...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
var sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
local sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
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 void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
virtual GLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual const GLProgramgetShaderProgram () const
local getShaderProgram ()
virtual void setShaderProgram (GLProgram *shaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local shaderProgram)
 Sets the shader program for this node. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
var runAction ( var action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . 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...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE ssize_t numberOfRunningActions () const
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
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...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
var unscheduleAllSelectors ()
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
CC_DEPRECATED_ATTRIBUTE void pauseSchedulerAndActions (void)
 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...
 
virtual const kmMat4 & getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentTransform ()
 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 kmMat4 &transform)
 Sets the Transformation matrix manually. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const kmMat4 & getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
parentToNodeTransform () const
local parentToNodeTransform ()
virtual kmMat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual kmMat4 getWorldToNodeTransform () const
 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
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Point convertToNodeSpace (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpace (const Point &nodePoint) const
 Converts a Point to world space coordinates. More...
 
Point convertToNodeSpaceAR (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
var convertToNodeSpaceAR ( var worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpaceAR ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpaceAR (const Point &nodePoint) const
 Converts a local Point to world space coordinates.The result is in Points. More...
 
Point convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Point More...
 
Point 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 (kmMat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
var setAdditionalTransform ( var 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)
ComponentgetComponent (const std::string &pName)
 gets a component by its name More...
 
var getComponent ( var pName)
 gets a component by its name More...
 
local getComponent ( local pName)
 gets a component by its name More...
 
virtual bool addComponent (Component *pComponent)
 adds a component More...
 
var addComponent ( var pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const std::string &pName)
 removes a component by its name More...
 
var removeComponent ( var pName)
 removes a component by its name More...
 
local removeComponent ( local pName)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
local release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Static Public Member Functions

static Menucreate ()
 creates an empty Menu More...
 
local create ()
 creates an empty Menu More...
 
static Menucreate (M m1, std::nullptr_t listEnd)
var create ( var m1, var listEnd)
local create ( local m1, local listEnd)
static Menucreate (M m1, M m2, std::nullptr_t listEnd)
var create ( var m1, var m2, var listEnd)
local create ( local m1, local m2, local listEnd)
static Menucreate (M m1, M m2, M m3, std::nullptr_t listEnd)
local create ( local m1, local m2, local m3, local listEnd)
static Menucreate (M m1, M m2, M m3, M m4, std::nullptr_t listEnd)
var create ( var m1, var m2, var m3, var m4, var listEnd)
local create ( local m1, local m2, local m3, local m4, local listEnd)
static Menucreate (M m1, M m2, M m3, M m4, M m5, std::nullptr_t listEnd)
local create ( local m1, local m2, local m3, local m4, local m5, local listEnd)
static Menucreate (M m1, M m2, M m3, M m4, M m5, M m6, std::nullptr_t listEnd)
local create ( local m1, local m2, local m3, local m4, local m5, local m6, local listEnd)
static Menucreate (M m1, M m2, M m3, M m4, M m5, M m6, M m7, std::nullptr_t listEnd)
local create ( local m1, local m2, local m3, local m4, local m5, local m6, local m7, local listEnd)
static Menucreate (M m1, M m2, M m3, M m4, M m5, M m6, M m7, M m8, std::nullptr_t listEnd)
static Menucreate (M m1, M m2, M m3, M m4, M m5, M m6, M m7, M m8, M m9, std::nullptr_t listEnd)
static Menucreate (M m1, M m2, M m3, M m4, M m5, M m6, M m7, M m8, M m9, M m10, std::nullptr_t listEnd)
static MenuvariadicCreate (MenuItem *item,...)
static MenucreateWithArray (const Vector< MenuItem * > &arrayOfItems)
 creates a Menu with a Array of MenuItem objects More...
 
var createWithArray ( var arrayOfItems)
 creates a Menu with a Array of MenuItem objects More...
 
local createWithArray ( local arrayOfItems)
 creates a Menu with a Array of MenuItem objects More...
 
static MenucreateWithItem (MenuItem *item)
 creates a Menu with it's item, then use addChild() to add other items. More...
 
local createWithItem ( local item)
 creates a Menu with it's item, then use addChild() to add other items. More...
 
static MenucreateWithItems (MenuItem *firstItem, va_list args)
 creates a Menu with MenuItem objects More...
 
var createWithItems ( var firstItem, var args)
 creates a Menu with MenuItem objects More...
 
local createWithItems ( local firstItem, local args)
 creates a Menu with MenuItem objects More...
 
- Static Public Member Functions inherited from Layer
static Layercreate ()
 creates a fullscreen black layer More...
 
var create ()
 creates a fullscreen black layer More...
 
local create ()
 creates a fullscreen black layer More...
 
- Static Public Member Functions inherited from Node
static Nodecreate (void)
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Protected Member Functions

 Menu ()
 ctor ()
 Menu ()
virtual ~Menu ()
var ~Menu ()
bool init ()
 initializes an empty Menu More...
 
var init ()
 initializes an empty Menu More...
 
local init ()
 initializes an empty Menu More...
 
bool initWithArray (const Vector< MenuItem * > &arrayOfItems)
 initializes a Menu with a NSArray of MenuItem objects More...
 
var initWithArray ( var arrayOfItems)
 initializes a Menu with a NSArray of MenuItem objects More...
 
local initWithArray ( local arrayOfItems)
 initializes a Menu with a NSArray of MenuItem objects More...
 
MenuItemgetItemForTouch (Touch *touch)
- Protected Member Functions inherited from Layer
 Layer ()
 Layer ()
 Layer ()
virtual ~Layer ()
var ~Layer ()
local ~Layer ()
void _addTouchListener ()
var _addTouchListener ()
local _addTouchListener ()
CC_DEPRECATED_ATTRIBUTE void addTouchListener ()
local addTouchListener ()
CC_DEPRECATED_ATTRIBUTE int executeScriptTouchHandler (EventTouch::EventCode eventType, Touch *touch, Event *event)
local executeScriptTouchHandler ( local eventType, local touch, local event)
CC_DEPRECATED_ATTRIBUTE int executeScriptTouchesHandler (EventTouch::EventCode eventType, const std::vector< Touch * > &touches, Event *event)
local executeScriptTouchesHandler ( local eventType, local touches, local event)
- Protected Member Functions inherited from Node
 Node ()
 Node ()
 Node ()
virtual ~Node ()
local ~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...
 
var detachChild ( var child, var index, var 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...
 
Point convertToWindowSpace (const Point &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...
 
kmMat4 transform (const kmMat4 &parentTransform)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
var disableCascadeOpacity ()
local disableCascadeOpacity ()
virtual void updateCascadeColor ()
var updateCascadeColor ()
local updateCascadeColor ()
virtual void disableCascadeColor ()
virtual void updateColor ()
var updateColor ()
local updateColor ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Protected Attributes

bool _enabled
 whether or not the menu will receive events More...
 
State _state
MenuItem_selectedItem
var _selectedItem
local _selectedItem
- Protected Attributes inherited from Layer
bool _touchEnabled
var _touchEnabled
local _touchEnabled
bool _accelerometerEnabled
var _accelerometerEnabled
local _accelerometerEnabled
bool _keyboardEnabled
var _keyboardEnabled
local _keyboardEnabled
EventListener_touchListener
var _touchListener
local _touchListener
EventListenerKeyboard_keyboardListener
var _keyboardListener
local _keyboardListener
EventListenerAcceleration_accelerationListener
var _accelerationListener
local _accelerationListener
Touch::DispatchMode _touchMode
var _touchMode
local _touchMode
bool _swallowsTouches
var _swallowsTouches
local _swallowsTouches
- 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...
 
float _scaleX
 scaling factor on x-axis More...
 
var _scaleX
 scaling factor on x-axis More...
 
local _scaleX
 scaling factor on x-axis More...
 
float _scaleY
 scaling factor on y-axis More...
 
var _scaleY
 scaling factor on y-axis More...
 
local _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...
 
Point _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...
 
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...
 
Point _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Point _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...
 
var _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
kmMat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
kmMat4 _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...
 
kmMat4 _inverse
 inverse transform More...
 
var _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...
 
kmMat4 _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...
 
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...
 
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...
 
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...
 
GLProgram_shaderProgram
 OpenGL shader. More...
 
var _shaderProgram
 OpenGL shader. More...
 
local _shaderProgram
 OpenGL shader. 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...
 
var _scheduler
 scheduler used to schedule timers and updates More...
 
local _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...
 
var _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local _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...
 
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 Point will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Point 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...
 
int _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
var _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType _scriptType
 type of script binding, lua or javascript More...
 
var _scriptType
 type of script binding, lua or javascript More...
 
local _scriptType
 type of script binding, lua or javascript 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...
 
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
- Protected Attributes inherited from Ref
unsigned int _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 Node
static int s_globalOrderOfArrival
var s_globalOrderOfArrival
local s_globalOrderOfArrival

Detailed Description

A Menu.

Features and Limitation:

  • You can add MenuItem objects in runtime using addChild:
  • But the only accepted children are MenuItem objects

Member Typedef Documentation

typedef MenuItem* M
var M
local M

Member Enumeration Documentation

enum State
strong
Enumerator
WAITING 
TRACKING_TOUCH 
var State
strong
Enumerator
WAITING 
TRACKING_TOUCH 
local State
strong
Enumerator
WAITING 
TRACKING_TOUCH 

Constructor & Destructor Documentation

Menu ( )
inlineprotected
var ctor ( )
inlineprotected
local Menu ( )
inlineprotected
virtual ~Menu ( )
protectedvirtual
var ~Menu ( )
protectedvirtual
local ~Menu ( )
protectedvirtual

Member Function Documentation

virtual void addChild ( Node child)
overridevirtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node

Reimplemented from Node.

var addChild ( var  child)
overridevirtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node

Reimplemented from Node.

local addChild ( local  child)
overridevirtual

Adds a child to the container with z-order as 0.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node

Reimplemented from Node.

virtual void addChild ( Node child,
int  localZOrder 
)
overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from Node.

var addChild ( var  child,
var  localZOrder 
)
overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from Node.

local addChild ( local  child,
local  localZOrder 
)
overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from Node.

virtual void addChild ( Node child,
int  localZOrder,
int  tag 
)
overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagAn integer to identify the node easily. Please refer to setTag(int)

Reimplemented from Node.

var addChild ( var  child,
var  localZOrder,
var  tag 
)
overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagAn integer to identify the node easily. Please refer to setTag(int)

Reimplemented from Node.

local addChild ( local  child,
local  localZOrder,
local  tag 
)
overridevirtual

Adds a child to the container with z order and tag.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagAn integer to identify the node easily. Please refer to setTag(int)

Reimplemented from Node.

void alignItemsHorizontally ( )

align items horizontally

var alignItemsHorizontally ( )

align items horizontally

local alignItemsHorizontally ( )

align items horizontally

void
alignItemsHorizontallyWithPadding
( float  padding)

align items horizontally with padding

Since
v0.7.2
var
alignItemsHorizontallyWithPadding
( var  padding)

align items horizontally with padding

Since
v0.7.2
local
alignItemsHorizontallyWithPadding
( local  padding)

align items horizontally with padding

Since
v0.7.2
void alignItemsInColumns ( int  columns,
  ... 
)

align items in rows of columns

var alignItemsInColumns ( var  columns,
  ... 
)

align items in rows of columns

local alignItemsInColumns ( local  columns,
  ... 
)

align items in rows of columns

void alignItemsInColumns ( int  columns,
va_list  args 
)
var alignItemsInColumns ( var  columns,
var  args 
)
local alignItemsInColumns ( local  columns,
local  args 
)
void alignItemsInColumnsWithArray ( const ValueVector rows)
var alignItemsInColumnsWithArray ( var  rows)
local alignItemsInColumnsWithArray ( local  rows)
void alignItemsInRows ( int  rows,
  ... 
)

align items in columns of rows

var alignItemsInRows ( var  rows,
  ... 
)

align items in columns of rows

local alignItemsInRows ( local  rows,
  ... 
)

align items in columns of rows

void alignItemsInRows ( int  rows,
va_list  args 
)
var alignItemsInRows ( var  rows,
var  args 
)
local alignItemsInRows ( local  rows,
local  args 
)
void alignItemsInRowsWithArray ( const ValueVector columns)
var alignItemsInRowsWithArray ( var  columns)
local alignItemsInRowsWithArray ( local  columns)
void alignItemsVertically ( )

align items vertically

var alignItemsVertically ( )

align items vertically

local alignItemsVertically ( )

align items vertically

void
alignItemsVerticallyWithPadding
( float  padding)

align items vertically with padding

Since
v0.7.2
var alignItemsVerticallyWithPadding ( var  padding)

align items vertically with padding

Since
v0.7.2
local
alignItemsVerticallyWithPadding
( local  padding)

align items vertically with padding

Since
v0.7.2
static Menu* create ( )
static

creates an empty Menu

var create ( )
static

creates an empty Menu

local create ( )
static

creates an empty Menu

static Menu* create ( M  m1,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
M  m5,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  m5,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  m5,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
M  m5,
M  m6,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  m5,
var  m6,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  m5,
local  m6,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
M  m5,
M  m6,
M  m7,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  m5,
var  m6,
var  m7,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  m5,
local  m6,
local  m7,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
M  m5,
M  m6,
M  m7,
M  m8,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  m5,
var  m6,
var  m7,
var  m8,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  m5,
local  m6,
local  m7,
local  m8,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
M  m5,
M  m6,
M  m7,
M  m8,
M  m9,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  m5,
var  m6,
var  m7,
var  m8,
var  m9,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  m5,
local  m6,
local  m7,
local  m8,
local  m9,
local  listEnd 
)
inlinestatic
static Menu* create ( M  m1,
M  m2,
M  m3,
M  m4,
M  m5,
M  m6,
M  m7,
M  m8,
M  m9,
M  m10,
std::nullptr_t  listEnd 
)
inlinestatic
var create ( var  m1,
var  m2,
var  m3,
var  m4,
var  m5,
var  m6,
var  m7,
var  m8,
var  m9,
var  m10,
var  listEnd 
)
inlinestatic
local create ( local  m1,
local  m2,
local  m3,
local  m4,
local  m5,
local  m6,
local  m7,
local  m8,
local  m9,
local  m10,
local  listEnd 
)
inlinestatic
static Menu* createWithArray ( const Vector< MenuItem * > &  arrayOfItems)
static

creates a Menu with a Array of MenuItem objects

var createWithArray ( var  arrayOfItems)
static

creates a Menu with a Array of MenuItem objects

local createWithArray ( local  arrayOfItems)
static

creates a Menu with a Array of MenuItem objects

static Menu* createWithItem ( MenuItem item)
static

creates a Menu with it's item, then use addChild() to add other items.

It is used for script, it can't init with undetermined number of variables.

var createWithItem ( var  item)
static

creates a Menu with it's item, then use addChild() to add other items.

It is used for script, it can't init with undetermined number of variables.

local createWithItem ( local  item)
static

creates a Menu with it's item, then use addChild() to add other items.

It is used for script, it can't init with undetermined number of variables.

static Menu* createWithItems ( MenuItem firstItem,
va_list  args 
)
static

creates a Menu with MenuItem objects

var createWithItems ( var  firstItem,
var  args 
)
static

creates a Menu with MenuItem objects

local createWithItems ( local  firstItem,
local  args 
)
static

creates a Menu with MenuItem objects

virtual std::string getDescription ( ) const
overridevirtual

Gets the description string.

It makes debugging easier.

Returns
A string

Reimplemented from Layer.

var getDescription ( )
overridevirtual

Gets the description string.

It makes debugging easier.

Returns
A string

Reimplemented from Layer.

local getDescription ( )
overridevirtual

Gets the description string.

It makes debugging easier.

Returns
A string

Reimplemented from Layer.

MenuItem* getItemForTouch ( Touch touch)
protected
var getItemForTouch ( var  touch)
protected
local getItemForTouch ( local  touch)
protected
bool init ( )
protectedvirtual

initializes an empty Menu

Reimplemented from Layer.

var init ( )
protectedvirtual

initializes an empty Menu

Reimplemented from Layer.

local init ( )
protectedvirtual

initializes an empty Menu

Reimplemented from Layer.

bool initWithArray ( const Vector< MenuItem * > &  arrayOfItems)
protected

initializes a Menu with a NSArray of MenuItem objects

var initWithArray ( var  arrayOfItems)
protected

initializes a Menu with a NSArray of MenuItem objects

local initWithArray ( local  arrayOfItems)
protected

initializes a Menu with a NSArray of MenuItem objects

virtual bool isEnabled ( ) const
inlinevirtual
var isEnabled ( )
inlinevirtual
local isEnabled ( )
inlinevirtual
virtual bool isOpacityModifyRGB ( void  ) const
inlineoverridevirtual

Reimplemented from Node.

var isOpacityModifyRGB (   )
inlineoverridevirtual

Reimplemented from Node.

local isOpacityModifyRGB (   )
inlineoverridevirtual

Reimplemented from Node.

virtual void onEnter ( )
overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Node.

var onEnter ( )
overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Node.

local onEnter ( )
overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Node.

virtual void onExit ( )
overridevirtual

Event callback that is invoked every time the Node leaves the 'stage'.

If the Node leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., Node::onExit().

Reimplemented from Node.

var onExit ( )
overridevirtual

Event callback that is invoked every time the Node leaves the 'stage'.

If the Node leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., Node::onExit().

Reimplemented from Node.

local onExit ( )
overridevirtual

Event callback that is invoked every time the Node leaves the 'stage'.

If the Node leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., Node::onExit().

Reimplemented from Node.

virtual bool onTouchBegan ( Touch touch,
Event event 
)
virtual

Reimplemented from Layer.

var onTouchBegan ( var  touch,
var  event 
)
virtual

Reimplemented from Layer.

local onTouchBegan ( local  touch,
local  event 
)
virtual

Reimplemented from Layer.

virtual void onTouchCancelled ( Touch touch,
Event event 
)
virtual

Reimplemented from Layer.

var onTouchCancelled ( var  touch,
var  event 
)
virtual

Reimplemented from Layer.

local onTouchCancelled ( local  touch,
local  event 
)
virtual

Reimplemented from Layer.

virtual void onTouchEnded ( Touch touch,
Event event 
)
virtual

Reimplemented from Layer.

var onTouchEnded ( var  touch,
var  event 
)
virtual

Reimplemented from Layer.

local onTouchEnded ( local  touch,
local  event 
)
virtual

Reimplemented from Layer.

virtual void onTouchMoved ( Touch touch,
Event event 
)
virtual

Reimplemented from Layer.

var onTouchMoved ( var  touch,
var  event 
)
virtual

Reimplemented from Layer.

local onTouchMoved ( local  touch,
local  event 
)
virtual

Reimplemented from Layer.

virtual void removeChild ( Node child,
bool  cleanup 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Node.

var removeChild ( var  child,
var  cleanup 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Node.

local removeChild ( local  child,
local  cleanup 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Node.

virtual void setEnabled ( bool  value)
inlinevirtual
var setEnabled ( var  value)
inlinevirtual
local setEnabled ( local  value)
inlinevirtual
virtual void setOpacityModifyRGB ( bool  bValue)
inlineoverridevirtual

Reimplemented from Node.

var setOpacityModifyRGB ( var  bValue)
inlineoverridevirtual

Reimplemented from Node.

local setOpacityModifyRGB ( local  bValue)
inlineoverridevirtual

Reimplemented from Node.

static Menu* variadicCreate ( MenuItem item,
  ... 
)
static
var variadicCreate ( var  item,
  ... 
)
static
local variadicCreate ( local  item,
  ... 
)
static

Member Data Documentation

bool _enabled
protected

whether or not the menu will receive events

var _enabled
protected

whether or not the menu will receive events

MenuItem* _selectedItem
protected
var _selectedItem
protected
local _selectedItem
protected
State _state
protected
var _state
protected
local _state
protected

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