cocos2d-x  3.2
 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 Types inherited from Node
enum  { FLAGS_TRANSFORM_DIRTY = (1 << 0), FLAGS_CONTENT_SIZE_DIRTY = (1 << 1), FLAGS_DIRTY_MASK = (FLAGS_TRANSFORM_DIRTY | FLAGS_CONTENT_SIZE_DIRTY) }
 

Public Member Functions

void alignItemsVertically ()
 align items vertically More...
 
var alignItemsVertically ()
 align items vertically More...
 
local 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)
var alignItemsInColumns ( var columns, var args)
local alignItemsInColumns ( local columns, local args)
void alignItemsInColumnsWithArray (const ValueVector &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)
local setEnabled ( local value)
virtual bool onTouchBegan (Touch *touch, Event *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)
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 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...
 
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...
 
var onExit ()
 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
local isOpacityModifyRGB ()
virtual std::string getDescription () const override
 Gets the description string. More...
 
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...
 
- Public Member Functions inherited from Layer
virtual bool ccTouchBegan (Touch *pTouch, Event *pEvent) final
local ccTouchBegan ( local pTouch, local pEvent)
virtual void ccTouchMoved (Touch *pTouch, Event *pEvent) final
local ccTouchMoved ( local pTouch, local pEvent)
virtual void ccTouchEnded (Touch *pTouch, Event *pEvent) final
local ccTouchEnded ( local pTouch, local pEvent)
virtual void ccTouchCancelled (Touch *pTouch, Event *pEvent) final
local ccTouchCancelled ( local pTouch, local pEvent)
virtual void ccTouchesBegan (__Set *pTouches, Event *pEvent) final
var ccTouchesBegan ( var pTouches, var pEvent)
local ccTouchesBegan ( local pTouches, local pEvent)
virtual void ccTouchesMoved (__Set *pTouches, Event *pEvent) final
local ccTouchesMoved ( local pTouches, local pEvent)
virtual void ccTouchesEnded (__Set *pTouches, Event *pEvent) final
local ccTouchesEnded ( local pTouches, local pEvent)
virtual void ccTouchesCancelled (__Set *pTouches, Event *pEvent) final
local ccTouchesCancelled ( local pTouches, local pEvent)
virtual void onTouchesBegan (const std::vector< Touch * > &touches, Event *unused_event)
var onTouchesBegan ( var touches, var unused_event)
local onTouchesBegan ( local touches, local unused_event)
virtual void onTouchesMoved (const std::vector< Touch * > &touches, Event *unused_event)
var onTouchesMoved ( var touches, var unused_event)
local onTouchesMoved ( local touches, local unused_event)
virtual void onTouchesEnded (const std::vector< Touch * > &touches, Event *unused_event)
var onTouchesEnded ( var touches, var unused_event)
local onTouchesEnded ( local touches, local unused_event)
virtual void onTouchesCancelled (const std::vector< Touch * > &touches, Event *unused_event)
local onTouchesCancelled ( local touches, local unused_event)
virtual 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 void registerWithTouchDispatcher () final
 If isTouchEnabled, this method is called onEnter. More...
 
local registerWithTouchDispatcher ()
 If isTouchEnabled, this method is called onEnter. More...
 
bool isTouchEnabled () const
 whether or not it will receive Touch events. More...
 
var isTouchEnabled ()
 whether or not it will receive Touch events. More...
 
local isTouchEnabled ()
 whether or not it will receive Touch events. More...
 
void setTouchEnabled (bool value)
var setTouchEnabled ( var value)
local setTouchEnabled ( local value)
virtual void setTouchMode (Touch::DispatchMode mode)
local setTouchMode ( local mode)
virtual Touch::DispatchMode getTouchMode () const
local getTouchMode ()
virtual void setSwallowsTouches (bool swallowsTouches)
 swallowsTouches of the touch events. More...
 
var setSwallowsTouches ( var swallowsTouches)
 swallowsTouches of the touch events. More...
 
local setSwallowsTouches ( local swallowsTouches)
 swallowsTouches of the touch events. More...
 
virtual bool isSwallowsTouches () const
var isSwallowsTouches ()
local isSwallowsTouches ()
virtual 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 void setAccelerometerEnabled (bool value)
var setAccelerometerEnabled ( var value)
local setAccelerometerEnabled ( local value)
virtual void setAccelerometerInterval (double interval)
var setAccelerometerInterval ( var interval)
local setAccelerometerInterval ( local interval)
virtual 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 void setKeyboardEnabled (bool value)
local setKeyboardEnabled ( local value)
virtual void keyPressed (int keyCode) final
 Please use onKeyPressed instead. More...
 
virtual void keyReleased (int keyCode) final
 Please use onKeyReleased instead. More...
 
var keyReleased ( var keyCode)
 Please use onKeyReleased instead. More...
 
local keyReleased ( local keyCode)
 Please use onKeyReleased instead. More...
 
virtual void onKeyPressed (EventKeyboard::KeyCode keyCode, Event *event)
local onKeyPressed ( local keyCode, local event)
virtual void onKeyReleased (EventKeyboard::KeyCode keyCode, Event *event)
var onKeyReleased ( var keyCode, var event)
local onKeyReleased ( local keyCode, local event)
virtual bool isKeypadEnabled () const final
var isKeypadEnabled ()
local isKeypadEnabled ()
virtual void setKeypadEnabled (bool value)
virtual void keyBackClicked () final
local keyBackClicked ()
virtual void keyMenuClicked () final
local keyMenuClicked ()
virtual ~Layer ()
var ~Layer ()
local ~Layer ()
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops all running actions and schedulers. More...
 
virtual void draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
 Override this method to draw your own node. More...
 
var draw ( var renderer, var transform, var flags)
 Override this method to draw your own node. More...
 
local draw ( local renderer, local transform, local flags)
 Override this method to draw your own node. More...
 
virtual void draw () final
var draw ()
local draw ()
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
 Visits this node's children and draw them recursively. More...
 
virtual void visit () final
virtual ScenegetScene () const
 Returns the Scene that contains the Node. More...
 
local getScene ()
 Returns the Scene that contains the Node. More...
 
virtual Rect getBoundingBox () const
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual Rect boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
var setEventDispatcher ( var dispatcher)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
var setPhysicsBody ( var body)
 set the PhysicsBody that let the sprite effect with physics More...
 
local setPhysicsBody ( local body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBodygetPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
virtual GLubyte getOpacity () const
var getOpacity ()
local getOpacity ()
virtual GLubyte getDisplayedOpacity () const
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
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3BgetColor () const
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
var isCascadeColorEnabled ()
local isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
void setOnEnterCallback (const std::function< void()> &callback)
var setOnEnterCallback ( var callback)
local setOnEnterCallback ( local callback)
const std::function< void()> & getOnEnterCallback () const
local getOnEnterCallback ()
void setOnExitCallback (const std::function< void()> &callback)
var setOnExitCallback ( var callback)
local setOnExitCallback ( local callback)
const std::function< void()> & getOnExitCallback () const
local getOnExitCallback ()
void setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
var setonEnterTransitionDidFinishCallback ( var callback)
local setonEnterTransitionDidFinishCallback ( local callback)
const std::function< void()> & getonEnterTransitionDidFinishCallback () const
local getonEnterTransitionDidFinishCallback ()
void setonExitTransitionDidStartCallback (const std::function< void()> &callback)
var setonExitTransitionDidStartCallback ( var callback)
local setonExitTransitionDidStartCallback ( local callback)
const std::function< void()> & getonExitTransitionDidStartCallback () const
local getonExitTransitionDidStartCallback ()
virtual ~Node ()
var ~Node ()
local ~Node ()
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
local setLocalZOrder ( local localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void setZOrder (int localZOrder)
virtual void _setLocalZOrder (int z)
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
var getZOrder ()
local getZOrder ()
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void 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...
 
var setScaleY ( var 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. 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...
 
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...
 
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...
 
local getNormalizedPosition ()
 returns the normalized position More...
 
virtual void setPosition (float x, float y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
local setPosition ( local x, local y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
var getPositionX ()
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual void setPosition3D (const Vec3 &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 Vec3 getPosition3D () const
 returns the position (X,Y,Z) in its parent's coordinate system More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual void setVertexZ (float vertexZ)
var setVertexZ ( var vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
virtual float getVertexZ () const
var 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...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
var setSkewY ( var skewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local skewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
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...
 
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...
 
var setRotation ( var rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
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 setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationX (float rotationX)
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
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 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)
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
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indicates which children is added previously. More...
 
void setGLServerState (int serverState)
int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local 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) const
 Gets a child from the container with its tag. More...
 
var getChildByTag ( var tag)
 Gets a child from the container with its tag. More...
 
local getChildByTag ( local tag)
 Gets a child from the container with its tag. More...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
var getChildByName ( var name)
 Gets a child from the container with its name. More...
 
local getChildByName ( local name)
 Gets a child from the container with its name. More...
 
template<typename T >
getChildByName (const std::string &name) const
 Gets a child from the container with its name that can be cast to Type T. More...
 
virtual void enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
 Search the children of the receiving node to perform processing for nodes which share a name. More...
 
virtual Vector< Node * > & getChildren ()
 Returns the array of the node's children. More...
 
local getChildren ()
 Returns the array of the node's children. More...
 
virtual const Vector< Node * > & getChildren () const
local getChildren ()
virtual ssize_t getChildrenCount () const
 Returns the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
local getParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
var removeChildByName ( var name, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByName ( local name, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
var removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int localZOrder)
 Reorders a child according to a new z value. More...
 
var reorderChild ( var child, var localZOrder)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child, local localZOrder)
 Reorders a child according to a new z value. More...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual std::string getName () const
 Returns a string that is used to identify the node. More...
 
local getName ()
 Returns a string that is used to identify the node. More...
 
virtual void setName (const std::string &name)
 Changes the name that is used to identify the node easily. More...
 
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 ()
GLProgramStategetGLProgramState () const
var getGLProgramState ()
local getGLProgramState ()
void setGLProgramState (GLProgramState *glProgramState)
var setGLProgramState ( var glProgramState)
local setGLProgramState ( local glProgramState)
void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
void setShaderProgram (GLProgram *glprogram)
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...
 
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 ()
ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
var stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
local 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...
 
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...
 
local getNumberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
ssize_t numberOfRunningActions () const
var numberOfRunningActions ()
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
local getScheduler ()
 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...
 
void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
var resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resume ()
 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...
 
void resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
var resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
local 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...
 
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 Mat4 &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...
 
virtual AffineTransform getParentToNodeAffineTransform () const
local getParentToNodeAffineTransform ()
virtual AffineTransform parentToNodeTransform () const
local parentToNodeTransform ()
virtual Mat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
var getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
local getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
local getNodeToWorldAffineTransform ()
virtual AffineTransform nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
var getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
local getWorldToNodeAffineTransform ()
virtual AffineTransform worldToNodeTransform () const
local worldToNodeTransform ()
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
var convertToNodeSpace ( var worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
var convertToWorldSpace ( var nodePoint)
 Converts a Vec2 to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 Converts a Vec2 to world space coordinates. More...
 
Vec2 convertToNodeSpaceAR (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpaceAR (const Vec2 &nodePoint) const
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
Vec2 convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Vec2 More...
 
Vec2 convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
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)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
ComponentgetComponent (const std::string &name)
 gets a component by its name More...
 
local getComponent ( local name)
 gets a component by its name More...
 
virtual bool addComponent (Component *component)
 adds a component More...
 
local addComponent ( local component)
 adds a component More...
 
virtual bool removeComponent (const std::string &name)
 removes a component by its name More...
 
local removeComponent ( local name)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
var removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases 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)
local create ( local m1, local listEnd)
static Menucreate (M m1, M m2, std::nullptr_t 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)
var create ( var m1, var m2, var m3, var m4, var m5, var 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)
var create ( var m1, var m2, var m3, var m4, var m5, var m6, var 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)
var create ( var m1, var m2, var m3, var m4, var m5, var m6, var m7, var 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)
local create ( local m1, local m2, local m3, local m4, local m5, local m6, local m7, local m8, local 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)
local create ( local m1, local m2, local m3, local m4, local m5, local m6, local m7, local m8, local m9, local 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)
local create ( local m1, local m2, local m3, local m4, local m5, local m6, local m7, local m8, local m9, local m10, local listEnd)
static MenuvariadicCreate (MenuItem *item,...)
local variadicCreate ( local item)
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...
 
var createWithItem ( var 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...
 
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...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Menu() : _selectedItem(nullptr) {} virtual ~Menu()
var __pad0__: Menu() : _selectedItem(nullptr) {} virtual ~Menu()
local __pad0__: Menu() : _selectedItem(nullptr) {} virtual ~Menu()
- Public Attributes inherited from Layer
CC_CONSTRUCTOR_ACCESS __pad0__: Layer()
var __pad0__: Layer()
local __pad0__: Layer()
- Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS __pad0__: Node()

Protected Member Functions

MenuItemgetItemForTouch (Touch *touch)
var getItemForTouch ( var touch)
local getItemForTouch ( local touch)
- Protected Member Functions inherited from Layer
void _addTouchListener ()
var _addTouchListener ()
local _addTouchListener ()
void addTouchListener ()
var addTouchListener ()
local addTouchListener ()
int executeScriptTouchHandler (EventTouch::EventCode eventType, Touch *touch, Event *event)
var executeScriptTouchHandler ( var eventType, var touch, var event)
local executeScriptTouchHandler ( local eventType, local touch, local event)
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
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...
 
Vec2 convertToWindowSpace (const Vec2 &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
Mat4 transform (const Mat4 &parentTransform)
var transform ( var parentTransform)
local transform ( local parentTransform)
uint32_t processParentFlags (const Mat4 &parentTransform, uint32_t parentFlags)
var processParentFlags ( var parentTransform, var parentFlags)
local processParentFlags ( local parentTransform, local parentFlags)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
local disableCascadeOpacity ()
virtual void updateCascadeColor ()
local updateCascadeColor ()
virtual void disableCascadeColor ()
var disableCascadeColor ()
local disableCascadeColor ()
virtual void updateColor ()
var updateColor ()
local updateColor ()
bool doEnumerate (std::string name, std::function< bool(Node *)> callback) const
var doEnumerate ( var name, var callback)
local doEnumerate ( local name, local callback)
bool doEnumerateRecursive (const Node *node, const std::string &name, std::function< bool(Node *)> callback) const
var doEnumerateRecursive ( var node, var name, var callback)
local doEnumerateRecursive ( local node, local name, local callback)
void updatePhysicsBodyTransform (Scene *layer)
var updatePhysicsBodyTransform ( var layer)
local updatePhysicsBodyTransform ( local layer)
virtual void updatePhysicsBodyPosition (Scene *layer)
local updatePhysicsBodyPosition ( local layer)
virtual void updatePhysicsBodyRotation (Scene *layer)
var updatePhysicsBodyRotation ( var layer)
local updatePhysicsBodyRotation ( local layer)
virtual void updatePhysicsBodyScale (Scene *scene)
var updatePhysicsBodyScale ( var scene)
local updatePhysicsBodyScale ( local scene)
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Protected Attributes

bool _enabled
 whether or not the menu will receive events More...
 
local _enabled
 whether or not the menu will receive events More...
 
State _state
var _state
local _state
MenuItem_selectedItem
var _selectedItem
local _selectedItem
- Protected Attributes inherited from Layer
bool _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
Touch::DispatchMode _touchMode
local _touchMode
bool _swallowsTouches
var _swallowsTouches
local _swallowsTouches
- Protected Attributes inherited from Node
float _rotationX
 rotation on the X-axis More...
 
local _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...
 
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...
 
Vec2 _position
 position of the node More...
 
var _position
 position of the node More...
 
local _position
 position of the node More...
 
float _positionZ
 OpenGL real Z position. More...
 
var _positionZ
 OpenGL real Z position. More...
 
local _positionZ
 OpenGL real Z position. More...
 
Vec2 _normalizedPosition
var _normalizedPosition
local _normalizedPosition
bool _usingNormalizedPosition
var _usingNormalizedPosition
local _usingNormalizedPosition
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Vec2 _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Vec2 _anchorPoint
 anchor point normalized (NOT in points) More...
 
var _anchorPoint
 anchor point normalized (NOT in points) More...
 
local _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
var _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
bool _contentSizeDirty
 whether or not the contentSize is dirty More...
 
var _contentSizeDirty
 whether or not the contentSize is dirty More...
 
local _contentSizeDirty
 whether or not the contentSize is dirty More...
 
Mat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
Mat4 _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
Mat4 _inverse
 inverse transform More...
 
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...
 
Mat4 _additionalTransform
 transform More...
 
var _additionalTransform
 transform More...
 
local _additionalTransform
 transform More...
 
bool _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
var _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
local _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
bool _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
var _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
local _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
int _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
float _globalZOrder
 Global order used to sort the node. More...
 
var _globalZOrder
 Global order used to sort the node. More...
 
local _globalZOrder
 Global order used to sort the node. More...
 
Vector< Node * > _children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
var _parent
 weak reference to parent node More...
 
local _parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
std::string _name
 a string label, an user defined string to identify this node More...
 
var _name
 a string label, an user defined string to identify this node More...
 
local _name
 a string label, an user defined string to identify this node More...
 
size_t _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
var _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
local _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Ref_userObject
 A user assigned Object. More...
 
var _userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgramState_glProgramState
 OpenGL Program State. More...
 
var _glProgramState
 OpenGL Program State. More...
 
local _glProgramState
 OpenGL Program State. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
EventDispatcher_eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
var _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
local _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
bool _running
 is running More...
 
var _running
 is running More...
 
local _running
 is running More...
 
bool _visible
 is this node visible More...
 
var _visible
 is this node visible More...
 
local _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
var _reorderChildDirty
 children order dirty flag More...
 
local _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
PhysicsBody_physicsBody
 the physicsBody the node have More...
 
var _physicsBody
 the physicsBody the node have More...
 
local _physicsBody
 the physicsBody the node have More...
 
float _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
var _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
local _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
float _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
var _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
local _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
GLubyte _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
std::function< void()> _onEnterCallback
var _onEnterCallback
local _onEnterCallback
std::function< void()> _onExitCallback
var _onExitCallback
local _onExitCallback
std::function< void()> _onEnterTransitionDidFinishCallback
std::function< void()> _onExitTransitionDidStartCallback
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

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

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.

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)

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.

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)

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
nameA 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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
nameA 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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
nameA string to identify the node easily. Please refer to setName(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 ( )
virtual

initializes an empty Menu

Reimplemented from Layer.

var init ( )
virtual

initializes an empty Menu

Reimplemented from Layer.

local init ( )
virtual

initializes an empty Menu

Reimplemented from Layer.

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

initializes a Menu with a NSArray of MenuItem objects

var initWithArray ( var  arrayOfItems)

initializes a Menu with a NSArray of MenuItem objects

local initWithArray ( local  arrayOfItems)

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

var __pad0__
local __pad0__
bool _enabled
protected

whether or not the menu will receive events

var _enabled
protected

whether or not the menu will receive events

local _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: