Cocos2d-x  v3.12
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
Menu Class Reference

A Menu for touch handling. More...

Inherits Layer.

Public Types

enum  State
 Menu state, it's used internally.
 

Public Member Functions

void alignItemsVertically ()
 Align items vertically with default padding.
 
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 with default padding.
 
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)
 Align items in rows of columns. More...
 
void alignItemsInColumnsWithArray (const ValueVector &columns)
 Align items in rows of columns. More...
 
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)
 Align items in columns of rows. More...
 
var alignItemsInRows ( var rows, var args)
 Align items in columns of rows. More...
 
local alignItemsInRows ( local rows, local args)
 Align items in columns of rows. More...
 
void alignItemsInRowsWithArray (const ValueVector &rows)
 Align items in columns of rows. More...
 
virtual bool isEnabled () const
 Determines if the menu is enabled. More...
 
var isEnabled ()
 Determines if the menu is enabled. More...
 
local isEnabled ()
 Determines if the menu is enabled. More...
 
virtual void setEnabled (bool value)
 Set whether the menu is visible. More...
 
local setEnabled ( local value)
 Set whether the menu is visible. More...
 
virtual bool onTouchBegan (Touch *touch, Event *event) override
 Callback function for touch began. More...
 
var onTouchBegan ( var touch, var event)
 Callback function for touch began. More...
 
local onTouchBegan ( local touch, local event)
 Callback function for touch began. More...
 
virtual void onTouchEnded (Touch *touch, Event *event) override
 Callback function for touch ended. More...
 
local onTouchEnded ( local touch, local event)
 Callback function for touch ended. More...
 
virtual void onTouchCancelled (Touch *touch, Event *event) override
 Callback function for touch cancelled. More...
 
var onTouchCancelled ( var touch, var event)
 Callback function for touch cancelled. More...
 
local onTouchCancelled ( local touch, local event)
 Callback function for touch cancelled. More...
 
virtual void onTouchMoved (Touch *touch, Event *event) override
 Callback function for touch moved. More...
 
var onTouchMoved ( var touch, var event)
 Callback function for touch moved. More...
 
local onTouchMoved ( local touch, local event)
 Callback function for touch moved. More...
 
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...
 
virtual void addChild (Node *child, int zOrder, int tag) override
 Adds a child to the container with z order and tag. More...
 
var addChild ( var child, var zOrder, var tag)
 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 addChild (Node *child, int zOrder, const std::string &name) override
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local name)
 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...
 
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
 If you want the opacity affect the color property, then set to true. More...
 
var setOpacityModifyRGB ( var bValue)
 If you want the opacity affect the color property, then set to true. More...
 
local setOpacityModifyRGB ( local bValue)
 If you want the opacity affect the color property, then set to true. More...
 
virtual bool isOpacityModifyRGB (void) const override
 If node opacity will modify the RGB color value, then you should override this method and return true. More...
 
local isOpacityModifyRGB ()
 If node opacity will modify the RGB color value, then you should override this method and return true. More...
 
virtual std::string getDescription () const override
 Gets the description string. More...
 
var getDescription ()
 Gets the description string. More...
 
local getDescription ()
 Gets the description string. More...
 
- Public Member Functions inherited from Layer
virtual void onTouchesBegan (const std::vector< Touch * > &touches, Event *unused_event)
 Callback function for multiple touches began. More...
 
local onTouchesBegan ( local touches, local unused_event)
 Callback function for multiple touches began. More...
 
virtual void onTouchesMoved (const std::vector< Touch * > &touches, Event *unused_event)
 Callback function for multiple touches moved. More...
 
local onTouchesMoved ( local touches, local unused_event)
 Callback function for multiple touches moved. More...
 
virtual void onTouchesEnded (const std::vector< Touch * > &touches, Event *unused_event)
 Callback function for multiple touches ended. More...
 
local onTouchesEnded ( local touches, local unused_event)
 Callback function for multiple touches ended. More...
 
virtual void onTouchesCancelled (const std::vector< Touch * > &touches, Event *unused_event)
 Callback function for multiple touches cancelled. More...
 
local onTouchesCancelled ( local touches, local unused_event)
 Callback function for multiple touches cancelled. More...
 
virtual void didAccelerate (Acceleration *accelerationValue) final
local didAccelerate ( local accelerationValue)
virtual void onAcceleration (Acceleration *acc, Event *unused_event)
 Callback funtion for acceleration. More...
 
local onAcceleration ( local acc, local unused_event)
 Callback funtion for acceleration. More...
 
bool isTouchEnabled () const
 whether or not it will receive Touch events. More...
 
virtual void setSwallowsTouches (bool swallowsTouches)
 swallowsTouches of the touch events. More...
 
virtual bool isAccelerometerEnabled () const
 whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property.
 
local isAccelerometerEnabled ()
 whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property.
 
virtual bool isKeyboardEnabled () const
 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 void keyPressed (int keyCode) final
 Please use onKeyPressed instead.
 
local keyPressed ( local keyCode)
 Please use onKeyPressed instead.
 
virtual void keyReleased (int keyCode) final
 Please use onKeyReleased instead.
 
local keyReleased ( local keyCode)
 Please use onKeyReleased instead.
 
virtual void onKeyPressed (EventKeyboard::KeyCode keyCode, Event *event)
 Callback function for key pressed. More...
 
local onKeyPressed ( local keyCode, local event)
 Callback function for key pressed. More...
 
virtual void onKeyReleased (EventKeyboard::KeyCode keyCode, Event *event)
 Callback function for key released. More...
 
local onKeyReleased ( local keyCode, local event)
 Callback function for key released. More...
 
virtual void keyBackClicked () final
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
var isRunning ()
 Returns whether or not the node is "running". More...
 
local isRunning ()
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local handler, local priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops and removes all running actions and schedulers.
 
var cleanup ()
 Stops and removes all running actions and schedulers.
 
local cleanup ()
 Stops and removes all running actions and schedulers.
 
virtual void draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
 Override this method to draw your own node. More...
 
local draw ( local renderer, local transform, local flags)
 Override this method to draw your own node. More...
 
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
 Visits this node's children and send their render command recursively. More...
 
local visit ( local renderer, local parentTransform, local parentFlags)
 Visits this node's children and send their render command recursively. More...
 
virtual ScenegetScene () 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
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
 Set event dispatcher for node. More...
 
virtual EventDispatchergetEventDispatcher () const
 Get the event dispatcher. More...
 
local getEventDispatcher ()
 Get the event dispatcher. More...
 
void setPhysicsBody (PhysicsBody *body)
 Set the PhysicsBody that let the sprite effect with physics. More...
 
PhysicsBodygetPhysicsBody () const
 Get the PhysicsBody the sprite have. More...
 
void removeFromPhysicsWorld ()
 Remove this node from physics world. More...
 
var removeFromPhysicsWorld ()
 Remove this node from physics world. More...
 
local removeFromPhysicsWorld ()
 Remove this node from physics world. More...
 
void updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
 Update the transform matrix from physics.
 
var updateTransformFromPhysics ( var parentTransform, var parentFlags)
 Update the transform matrix from physics.
 
local updateTransformFromPhysics ( local parentTransform, local parentFlags)
 Update the transform matrix from physics.
 
virtual void updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
 Update physics body transform matrix.
 
var updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
 Update physics body transform matrix.
 
local updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
 Update physics body transform matrix.
 
virtual GLubyte getOpacity () const
 Return the node's opacity. More...
 
virtual GLubyte getDisplayedOpacity () const
 Return the node's display opacity. More...
 
local getDisplayedOpacity ()
 Return the node's display opacity. More...
 
virtual void setOpacity (GLubyte opacity)
 Change node opacity. More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 Update the displayed opacity of node with it's parent opacity;. More...
 
local updateDisplayedOpacity ( local parentOpacity)
 Update the displayed opacity of node with it's parent opacity;. More...
 
virtual bool isCascadeOpacityEnabled () const
 Whether cascadeOpacity is enabled or not. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
 Change node's cascadeOpacity property. More...
 
local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
 Change node's cascadeOpacity property. More...
 
virtual const Color3BgetColor () const
 Query node's color value. More...
 
local getColor ()
 Query node's color value. More...
 
virtual const Color3BgetDisplayedColor () const
 Query node's displayed color. More...
 
local getDisplayedColor ()
 Query node's displayed color. More...
 
virtual void setColor (const Color3B &color)
 Change the color of node. More...
 
local setColor ( local color)
 Change the color of node. More...
 
virtual void updateDisplayedColor (const Color3B &parentColor)
 Update node's displayed color with its parent color. More...
 
local updateDisplayedColor ( local parentColor)
 Update node's displayed color with its parent color. More...
 
virtual bool isCascadeColorEnabled () const
 Query whether cascadeColor is enabled or not. More...
 
var isCascadeColorEnabled ()
 Query whether cascadeColor is enabled or not. More...
 
local isCascadeColorEnabled ()
 Query whether cascadeColor is enabled or not. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
 If you want node's color affect the children node's color, then set it to true. More...
 
void setOnEnterCallback (const std::function< void()> &callback)
 Set the callback of event onEnter. More...
 
var setOnEnterCallback ( var callback)
 Set the callback of event onEnter. More...
 
local setOnEnterCallback ( local callback)
 Set the callback of event onEnter. More...
 
const std::function< void()> & getOnEnterCallback () const
 Get the callback of event onEnter. More...
 
local getOnEnterCallback ()
 Get the callback of event onEnter. More...
 
void setOnExitCallback (const std::function< void()> &callback)
 Set the callback of event onExit. More...
 
var setOnExitCallback ( var callback)
 Set the callback of event onExit. More...
 
local setOnExitCallback ( local callback)
 Set the callback of event onExit. More...
 
const std::function< void()> & getOnExitCallback () const
 Get the callback of event onExit. More...
 
local getOnExitCallback ()
 Get the callback of event onExit. More...
 
void setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
var setonEnterTransitionDidFinishCallback ( var callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
local setonEnterTransitionDidFinishCallback ( local callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
const std::function< void()> & getonEnterTransitionDidFinishCallback () const
 Get the callback of event EnterTransitionDidFinish. More...
 
local getonEnterTransitionDidFinishCallback ()
 Get the callback of event EnterTransitionDidFinish. More...
 
void setonExitTransitionDidStartCallback (const std::function< void()> &callback)
 Set the callback of event ExitTransitionDidStart. More...
 
var setonExitTransitionDidStartCallback ( var callback)
 Set the callback of event ExitTransitionDidStart. More...
 
local setonExitTransitionDidStartCallback ( local callback)
 Set the callback of event ExitTransitionDidStart. More...
 
const std::function< void()> & getonExitTransitionDidStartCallback () const
 Get the callback of event ExitTransitionDidStart. More...
 
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
 
virtual void setCameraMask (unsigned short mask, bool applyChildren=true)
 Modify the camera mask for current node. More...
 
local setCameraMask ( local mask, local true)
 Modify the camera mask for current node. More...
 
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)
local _setLocalZOrder ( local z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual int getZOrder () const
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void setScaleX (float scaleX)
 Sets the scale (x) of the node. More...
 
local setScaleX ( local scaleX)
 Sets the scale (x) of the node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node The scale factor on X axis.
 
virtual void setScaleY (float scaleY)
 Sets the scale (y) of the node. More...
 
local setScaleY ( local scaleY)
 Sets the scale (y) of the node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node The scale factor on Y axis.
 
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 The scale factor on Z axis.
 
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...
 
virtual void setScale (float scaleX, float scaleY)
 Sets the scale (x,y) of the node. More...
 
local setScale ( local scaleX, local scaleY)
 Sets the scale (x,y) of the node. More...
 
virtual void setPosition (const Vec2 &position)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void setNormalizedPosition (const Vec2 &position)
 Sets the position (x,y) using values between 0 and 1. More...
 
var setNormalizedPosition ( var position)
 Sets the position (x,y) using values between 0 and 1. More...
 
local setNormalizedPosition ( local position)
 Sets the position (x,y) using values between 0 and 1. More...
 
virtual const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getNormalizedPosition () 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...
 
var setPosition ( var x, var y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
local setPosition ( local x, local y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Sets the x coordinate of the node in its parent's coordinate system. More...
 
virtual float getPositionX (void) const
 Gets the x coordinate of the node in its parent's coordinate system. More...
 
virtual void setPositionY (float y)
 Sets the y coordinate of the node in its parent's coordinate system. More...
 
virtual float getPositionY (void) const
 Gets the y coordinate of the node in its parent's coordinate system. More...
 
virtual void setPosition3D (const Vec3 &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
virtual Vec3 getPosition3D () const
 Returns the position (X,Y,Z) in its parent's coordinate system. More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual void setVertexZ (float vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
var getVertexZ ()
 Gets position Z coordinate of this node. More...
 
local getPositionZ ()
 Gets position Z coordinate of this node. More...
 
virtual float getVertexZ () const
virtual void setSkewX (float skewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local skewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
var getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local skewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
var getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const Vec2 &anchorPoint)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
var setContentSize ( var 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...
 
var getContentSize ()
 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...
 
var getRotation ()
 Returns the rotation of the node in degrees. More...
 
local getRotation ()
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
local setRotation3D ( local rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vec3 getRotation3D () const
 Returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationQuat (const Quaternion &quat)
 Set rotation by quaternion. More...
 
local setRotationQuat ( local quat)
 Set rotation by quaternion. More...
 
virtual Quaternion getRotationQuat () const
 Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, The rotation in quaternion.
 
virtual void setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationSkewX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationX (float rotationX)
var setRotationX ( var rotationX)
local setRotationX ( local rotationX)
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationX () const
virtual void setRotationSkewY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationSkewY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setRotationY (float rotationY)
local setRotationY ( local rotationY)
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local getRotationSkewY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY () const
var getRotationY ()
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)
var setGLServerState ( var serverState)
int getGLServerState () const
virtual void setIgnoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void ignoreAnchorPointForPosition (bool ignore)
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual NodegetChildByTag (int tag) const
 Gets a child from the container with its tag. More...
 
template<typename T >
getChildByTag (int tag) const
 Gets a child from the container with its tag that can be cast to Type T. More...
 
template<typename T >
var getChildByTag ( var tag)
 Gets a child from the container with its tag that can be cast to Type T. More...
 
template<typename T >
local getChildByTag ( local tag)
 Gets a child from the container with its tag that can be cast to Type T. More...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
template<typename T >
getChildByName (const std::string &name) const
 Gets a child from the container with its name that can be cast to Type T. More...
 
virtual void enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
 Search the children of the receiving node to perform processing for nodes which share a name. More...
 
virtual Vector< Node * > & getChildren ()
 Returns the array of the node's children. More...
 
local getChildren ()
 Returns the array of the node's children. More...
 
virtual const Vector< Node * > & getChildren () const
local getChildren ()
virtual ssize_t getChildrenCount () const
 Returns the amount of children. More...
 
var getChildrenCount ()
 Returns the amount of children. More...
 
local getChildrenCount ()
 Returns the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
var getParent ()
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
var removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
local removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
var removeChildByTag ( var tag, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
var removeChildByName ( var name, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByName ( local name, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup.
 
var removeAllChildren ()
 Removes all children from the container with a cleanup.
 
local removeAllChildren ()
 Removes all children from the container with a cleanup.
 
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...
 
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...
 
var getTag ()
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual const std::string & getName () const
 Returns a string that is used to identify the node. More...
 
local getName ()
 Returns a string that is used to identify the node. More...
 
virtual void setName (const std::string &name)
 Changes the name that is used to identify the node easily. More...
 
var setName ( var name)
 Changes the name that is used to identify the node easily. More...
 
local setName ( local name)
 Changes the name that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual 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...
 
GLProgramgetGLProgram () const
 Return the GLProgram (shader) currently used for this node. More...
 
var getGLProgram ()
 Return the GLProgram (shader) currently used for this node. More...
 
local getGLProgram ()
 Return the GLProgram (shader) currently used for this node. More...
 
GLProgramgetShaderProgram () const
var getShaderProgram ()
local getShaderProgram ()
virtual void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
local setGLProgram ( local glprogram)
 Sets the shader program for this node. More...
 
void setShaderProgram (GLProgram *glprogram)
var setShaderProgram ( var glprogram)
local setShaderProgram ( local glprogram)
GLProgramStategetGLProgramState () const
 Return the GLProgramState currently used for this node. More...
 
var getGLProgramState ()
 Return the GLProgramState currently used for this node. More...
 
local getGLProgramState ()
 Return the GLProgramState currently used for this node. More...
 
virtual void setGLProgramState (GLProgramState *glProgramState)
 Set the GLProgramState for this node. More...
 
local setGLProgramState ( local glProgramState)
 Set the GLProgramState 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...
 
var setActionManager ( var actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
local setActionManager ( local actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
local getActionManager ()
virtual Action * runAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
var runAction ( var action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list .
 
var stopAllActions ()
 Stops and removes all actions from the running action list .
 
local stopAllActions ()
 Stops and removes all actions from the running action list .
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
void stopAllActionsByTag (int tag)
 Removes all actions from the running action list by its tag. More...
 
var stopAllActionsByTag ( var tag)
 Removes all actions from the running action list by its tag. More...
 
local stopAllActionsByTag ( local tag)
 Removes all actions from the running action list by its tag. More...
 
void stopActionsByFlags (unsigned int flags)
 Removes all actions from the running action list by its flags. 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
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...
 
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 The SEL_SCHEDULE selector to be scheduled. 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 The lambda function to be scheduled. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void schedule (const std::function< void(float)> &callback, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
 Schedules a lambda function. More...
 
var schedule ( var callback, var interval, var repeat, var delay, var key)
 Schedules a lambda function. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
var unschedule ( var selector)
 Unschedules a custom selector. More...
 
void unschedule (const std::string &key)
 Unschedules a lambda function. More...
 
var unschedule ( var key)
 Unschedules a lambda function. More...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.
 
var unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.
 
void unscheduleAllSelectors ()
var unscheduleAllSelectors ()
local unscheduleAllSelectors ()
virtual void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
virtual void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
void resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
 
var update ( var delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
 
local update ( local delta)
 Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
 
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const Mat4getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform () const
local getNodeToParentAffineTransform ()
virtual Mat4 getNodeToParentTransform (Node *ancestor) const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentTransform ( local ancestor)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform (Node *ancestor) const
 Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentAffineTransform ( local ancestor)
 Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual void setNodeToParentTransform (const Mat4 &transform)
 Sets the transformation matrix manually. More...
 
var setNodeToParentTransform ( var transform)
 Sets the transformation matrix manually. More...
 
local setNodeToParentTransform ( local transform)
 Sets the transformation matrix manually. More...
 
virtual AffineTransform nodeToParentTransform () const
local nodeToParentTransform ()
virtual const Mat4getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
var getParentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local getParentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual AffineTransform parentToNodeTransform () const
local parentToNodeTransform ()
virtual Mat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
var getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
local getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual AffineTransform nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
var getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual AffineTransform worldToNodeTransform () const
local worldToNodeTransform ()
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
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...
 
var convertTouchToNodeSpace ( var touch)
 Convenience methods which take a Touch instead of Vec2. More...
 
local convertTouchToNodeSpace ( local touch)
 Convenience methods which take a Touch instead of Vec2. More...
 
Vec2 convertTouchToNodeSpaceAR (Touch *touch) const
 Converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const Mat4 &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
void setAdditionalTransform (const AffineTransform &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
Component * getComponent (const std::string &name)
 Gets a component by its name. More...
 
var getComponent ( var name)
 Gets a component by its name. More...
 
local getComponent ( local name)
 Gets a component by its name. More...
 
virtual bool addComponent (Component *component)
 Adds a component. More...
 
var addComponent ( var component)
 Adds a component. More...
 
local addComponent ( local component)
 Adds a component. More...
 
virtual bool removeComponent (const std::string &name)
 Removes a component by its name. More...
 
local removeComponent ( local name)
 Removes a component by its name. More...
 
virtual bool removeComponent (Component *component)
 Removes a component by its pointer. More...
 
local removeComponent ( local component)
 Removes a component by its pointer. More...
 
virtual void removeAllComponents ()
 Removes all components.
 
var removeAllComponents ()
 Removes all components.
 
local removeAllComponents ()
 Removes all components.
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Static Public Member Functions

static Menucreate ()
 Creates an empty Menu. More...
 
static MenucreateWithArray (const Vector< MenuItem * > &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...
 
static MenucreateWithItems (MenuItem *firstItem, va_list 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 ()
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes.
 
var INVALID_TAG = -1
 Default tag used for all the nodes.
 
local INVALID_TAG = -1
 Default tag used for all the nodes.
 

Detailed Description

A Menu for touch handling.

Features and Limitation:

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

Member Function Documentation

static Menu* create ( )
static

Creates an empty Menu.

A initialized empty menu which is marked as "autorelease".

var create ( )
static

Creates an empty Menu.

A initialized empty menu which is marked as "autorelease".

local create ( )
static

Creates an empty Menu.

A initialized empty menu which is marked as "autorelease".

static Menu* createWithArray ( const Vector< MenuItem * > &  arrayOfItems)
static

Creates a Menu with a Array of MenuItem objects.

A array of MenuItem objects. A initialized menu which is marked as "autorelease".

local createWithArray ( local  arrayOfItems)
static

Creates a Menu with a Array of MenuItem objects.

A array of MenuItem objects. A initialized menu which is marked as "autorelease".

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 be initialized with undetermined number of variables. A MenuItem object. A initialized menu which is marked as "autorelease".

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 be initialized with undetermined number of variables. A MenuItem object. A initialized menu which is marked as "autorelease".

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

Creates a Menu with MenuItem objects.

The first MenuItem object. Other MenuItem objects(variadic parameters). A initialized menu which is marked as "autorelease".

local createWithItems ( local  firstItem,
local  args 
)
static

Creates a Menu with MenuItem objects.

The first MenuItem object. Other MenuItem objects(variadic parameters). A initialized menu which is marked as "autorelease".

void
alignItemsVerticallyWithPadding
( float  padding)

Align items vertically with padding.

The padding for align items vertically.

var alignItemsVerticallyWithPadding ( var  padding)

Align items vertically with padding.

The padding for align items vertically.

local
alignItemsVerticallyWithPadding
( local  padding)

Align items vertically with padding.

The padding for align items vertically.

void
alignItemsHorizontallyWithPadding
( float  padding)

Align items horizontally with padding.

The padding for align items horizontally.

var
alignItemsHorizontallyWithPadding
( var  padding)

Align items horizontally with padding.

The padding for align items horizontally.

local
alignItemsHorizontallyWithPadding
( local  padding)

Align items horizontally with padding.

The padding for align items horizontally.

void alignItemsInColumns ( int  columns,
  ... 
)

Align items in rows of columns.

The number of MenuItem on the first column. The numbers of MenuItem on other columns.(variadic parameters).

var alignItemsInColumns ( var  columns,
  ... 
)

Align items in rows of columns.

The number of MenuItem on the first column. The numbers of MenuItem on other columns.(variadic parameters).

local alignItemsInColumns ( local  columns,
  ... 
)

Align items in rows of columns.

The number of MenuItem on the first column. The numbers of MenuItem on other columns.(variadic parameters).

void alignItemsInColumns ( int  columns,
va_list  args 
)

Align items in rows of columns.

The number of MenuItem on the first column. The numbers of MenuItem on other columns.(variadic parameters).

var alignItemsInColumns ( var  columns,
var  args 
)

Align items in rows of columns.

The number of MenuItem on the first column. The numbers of MenuItem on other columns.(variadic parameters).

local alignItemsInColumns ( local  columns,
local  args 
)

Align items in rows of columns.

The number of MenuItem on the first column. The numbers of MenuItem on other columns.(variadic parameters).

void alignItemsInColumnsWithArray ( const ValueVector &  columns)

Align items in rows of columns.

A array of the number of MenuItem on columns.

local alignItemsInColumnsWithArray ( local  columns)

Align items in rows of columns.

A array of the number of MenuItem on columns.

void alignItemsInRows ( int  rows,
  ... 
)

Align items in columns of rows.

The number of MenuItem on the first row. The numbers of MenuItem on other rows.(variadic parameters).

var alignItemsInRows ( var  rows,
  ... 
)

Align items in columns of rows.

The number of MenuItem on the first row. The numbers of MenuItem on other rows.(variadic parameters).

local alignItemsInRows ( local  rows,
  ... 
)

Align items in columns of rows.

The number of MenuItem on the first row. The numbers of MenuItem on other rows.(variadic parameters).

void alignItemsInRows ( int  rows,
va_list  args 
)

Align items in columns of rows.

The number of MenuItem on the first row. The numbers of MenuItem on other rows.(variadic parameters).

var alignItemsInRows ( var  rows,
var  args 
)

Align items in columns of rows.

The number of MenuItem on the first row. The numbers of MenuItem on other rows.(variadic parameters).

local alignItemsInRows ( local  rows,
local  args 
)

Align items in columns of rows.

The number of MenuItem on the first row. The numbers of MenuItem on other rows.(variadic parameters).

void alignItemsInRowsWithArray ( const ValueVector &  rows)

Align items in columns of rows.

A array of the number of MenuItem on rows.

local alignItemsInRowsWithArray ( local  rows)

Align items in columns of rows.

A array of the number of MenuItem on rows.

virtual bool isEnabled ( ) const
inlinevirtual

Determines if the menu is enabled.

whether the menu is enabled or not.

var isEnabled ( )
inlinevirtual

Determines if the menu is enabled.

whether the menu is enabled or not.

local isEnabled ( )
inlinevirtual

Determines if the menu is enabled.

whether the menu is enabled or not.

virtual void setEnabled ( bool  value)
inlinevirtual

Set whether the menu is visible.

If set false, interacting with the menu will have no effect. The default value is true, a menu is default to enable. true if menu is enabled, false if menu is disabled.

var setEnabled ( var  value)
inlinevirtual

Set whether the menu is visible.

If set false, interacting with the menu will have no effect. The default value is true, a menu is default to enable. true if menu is enabled, false if menu is disabled.

local setEnabled ( local  value)
inlinevirtual

Set whether the menu is visible.

If set false, interacting with the menu will have no effect. The default value is true, a menu is default to enable. true if menu is enabled, false if menu is disabled.

virtual bool onTouchBegan ( Touch touch,
Event unused_event 
)
overridevirtual

Callback function for touch began.

Touch infomation. Event information. if return false, onTouchMoved, onTouchEnded, onTouchCancelled will never called.

Reimplemented from Layer.

var onTouchBegan ( var  touch,
var  unused_event 
)
overridevirtual

Callback function for touch began.

Touch infomation. Event information. if return false, onTouchMoved, onTouchEnded, onTouchCancelled will never called.

Reimplemented from Layer.

local onTouchBegan ( local  touch,
local  unused_event 
)
overridevirtual

Callback function for touch began.

Touch infomation. Event information. if return false, onTouchMoved, onTouchEnded, onTouchCancelled will never called.

Reimplemented from Layer.

virtual void onTouchEnded ( Touch touch,
Event unused_event 
)
overridevirtual

Callback function for touch ended.

Touch infomation. Event information.

Reimplemented from Layer.

var onTouchEnded ( var  touch,
var  unused_event 
)
overridevirtual

Callback function for touch ended.

Touch infomation. Event information.

Reimplemented from Layer.

local onTouchEnded ( local  touch,
local  unused_event 
)
overridevirtual

Callback function for touch ended.

Touch infomation. Event information.

Reimplemented from Layer.

virtual void onTouchCancelled ( Touch touch,
Event unused_event 
)
overridevirtual

Callback function for touch cancelled.

Touch infomation. Event information.

Reimplemented from Layer.

var onTouchCancelled ( var  touch,
var  unused_event 
)
overridevirtual

Callback function for touch cancelled.

Touch infomation. Event information.

Reimplemented from Layer.

local onTouchCancelled ( local  touch,
local  unused_event 
)
overridevirtual

Callback function for touch cancelled.

Touch infomation. Event information.

Reimplemented from Layer.

virtual void onTouchMoved ( Touch touch,
Event unused_event 
)
overridevirtual

Callback function for touch moved.

Touch infomation. Event information.

Reimplemented from Layer.

var onTouchMoved ( var  touch,
var  unused_event 
)
overridevirtual

Callback function for touch moved.

Touch infomation. Event information.

Reimplemented from Layer.

local onTouchMoved ( local  touch,
local  unused_event 
)
overridevirtual

Callback function for touch moved.

Touch infomation. Event information.

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. The child node which will be removed. True 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. The child node which will be removed. True 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. The child node which will be removed. True if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Node.

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. A 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. A 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. A 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. A child node. Z 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. A child node. Z 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. A child node. Z 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. A child node. Z order for drawing priority. Please refer to setLocalZOrder(int). An integer to identify the node easily. Please refer to setTag(int). Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

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. A child node. Z order for drawing priority. Please refer to setLocalZOrder(int). An integer to identify the node easily. Please refer to setTag(int). Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

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. A child node. Z order for drawing priority. Please refer to setLocalZOrder(int). An integer to identify the node easily. Please refer to setTag(int). Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

Reimplemented from Node.

virtual void addChild ( Node child,
int  localZOrder,
const std::string &  name 
)
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. A child node. Z order for drawing priority. Please refer to setLocalZOrder(int). A string to identify the node easily. Please refer to setName(int).

Reimplemented from Node.

var addChild ( var  child,
var  localZOrder,
var  name 
)
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. A child node. Z order for drawing priority. Please refer to setLocalZOrder(int). A string to identify the node easily. Please refer to setName(int).

Reimplemented from Node.

local addChild ( local  child,
local  localZOrder,
local  name 
)
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. A child node. Z order for drawing priority. Please refer to setLocalZOrder(int). A string to identify the node easily. Please refer to setName(int).

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 void setOpacityModifyRGB ( bool  value)
inlineoverridevirtual

If you want the opacity affect the color property, then set to true.

Parameters
valueA boolean value.

Reimplemented from Node.

var setOpacityModifyRGB ( var  value)
inlineoverridevirtual

If you want the opacity affect the color property, then set to true.

Parameters
valueA boolean value.

Reimplemented from Node.

local setOpacityModifyRGB ( local  value)
inlineoverridevirtual

If you want the opacity affect the color property, then set to true.

Parameters
valueA boolean value.

Reimplemented from Node.

virtual bool isOpacityModifyRGB ( void  ) const
inlineoverridevirtual

If node opacity will modify the RGB color value, then you should override this method and return true.

Returns
A boolean value, true indicates that opacity will modify color; false otherwise.

Reimplemented from Node.

var isOpacityModifyRGB (   )
inlineoverridevirtual

If node opacity will modify the RGB color value, then you should override this method and return true.

Returns
A boolean value, true indicates that opacity will modify color; false otherwise.

Reimplemented from Node.

local isOpacityModifyRGB (   )
inlineoverridevirtual

If node opacity will modify the RGB color value, then you should override this method and return true.

Returns
A boolean value, true indicates that opacity will modify color; false otherwise.

Reimplemented from Node.

virtual std::string getDescription ( ) const
overridevirtual

Gets the description string.

It makes debugging easier. A string

Reimplemented from Layer.

var getDescription ( )
overridevirtual

Gets the description string.

It makes debugging easier. A string

Reimplemented from Layer.

local getDescription ( )
overridevirtual

Gets the description string.

It makes debugging easier. A string

Reimplemented from Layer.


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