cocos2d-x  3.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Node Class Reference

Node is the base element of the Scene Graph. More...

#include <CCNode.h>

Inheritance diagram for Node:
Ref ActionTimelineNode __NodeRGBA AtlasNode AttachNode BaseLight Camera ClippingNode ClippingRectangleNode DrawNode TMXLayer TMXTiledMap AssetsManager TableViewCell LabelBMFont LabelTTF Layer MenuItem MotionStreak NodeGrid ParallaxNode ParticleBatchNode ParticleSystem ProgressTimer ProtectedNode RenderTexture Scene Sprite Sprite3D SpriteBatchNode TMXTiledMap Scale9Sprite CCBFile Armature BatchNode Bone GLNode SkeletonRenderer

Public Types

enum  { FLAGS_TRANSFORM_DIRTY = (1 << 0), FLAGS_CONTENT_SIZE_DIRTY = (1 << 1), FLAGS_RENDER_AS_3D = (1 << 3), FLAGS_DIRTY_MASK = (FLAGS_TRANSFORM_DIRTY | FLAGS_CONTENT_SIZE_DIRTY) }
 

Public Member Functions

virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
var isRunning ()
 Returns whether or not the node is "running". More...
 
local isRunning ()
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
virtual void 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...
 
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...
 
var getScene ()
 Returns the Scene that contains the Node. More...
 
local getScene ()
 Returns the Scene that contains the Node. More...
 
virtual Rect getBoundingBox () const
 Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
 
virtual Rect boundingBox () const
local boundingBox ()
virtual void setEventDispatcher (EventDispatcher *dispatcher)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBodygetPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
var getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
local getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
void removeFromPhysicsWorld ()
 remove this node from physics world. More...
 
var removeFromPhysicsWorld ()
 remove this node from physics world. More...
 
local removeFromPhysicsWorld ()
 remove this node from physics world. More...
 
void updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
virtual void updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
var updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
local updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
virtual GLubyte getOpacity () const
virtual GLubyte getDisplayedOpacity () const
var getDisplayedOpacity ()
local getDisplayedOpacity ()
virtual void setOpacity (GLubyte opacity)
local setOpacity ( local opacity)
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual bool isCascadeOpacityEnabled () const
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual const Color3BgetColor () const
local getColor ()
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual void setColor (const Color3B &color)
var setColor ( var color)
local setColor ( local color)
virtual void updateDisplayedColor (const Color3B &parentColor)
local updateDisplayedColor ( local parentColor)
virtual bool isCascadeColorEnabled () const
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
local setCascadeColorEnabled ( local cascadeColorEnabled)
virtual void setOpacityModifyRGB (bool value)
var setOpacityModifyRGB ( var value)
local setOpacityModifyRGB ( local value)
virtual bool isOpacityModifyRGB () const
void setOnEnterCallback (const std::function< void()> &callback)
var setOnEnterCallback ( var callback)
local setOnEnterCallback ( local callback)
const std::function< void()> & getOnEnterCallback () const
local getOnEnterCallback ()
void setOnExitCallback (const std::function< void()> &callback)
var setOnExitCallback ( var callback)
local setOnExitCallback ( local callback)
const std::function< void()> & getOnExitCallback () const
local getOnExitCallback ()
void setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
var setonEnterTransitionDidFinishCallback ( var callback)
local setonEnterTransitionDidFinishCallback ( local callback)
const std::function< void()> & getonEnterTransitionDidFinishCallback () const
local getonEnterTransitionDidFinishCallback ()
void setonExitTransitionDidStartCallback (const std::function< void()> &callback)
var setonExitTransitionDidStartCallback ( var callback)
local setonExitTransitionDidStartCallback ( local callback)
const std::function< void()> & getonExitTransitionDidStartCallback () const
local getonExitTransitionDidStartCallback ()
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true More...
 
void setCameraMask (unsigned short mask, bool applyChildren=true)
local setCameraMask ( local mask, local true)
virtual ~Node ()
var ~Node ()
local ~Node ()
virtual bool init ()
var init ()
local init ()
Setters & Getters for Graphic Peroperties
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
local setLocalZOrder ( local localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void setZOrder (int localZOrder)
virtual void _setLocalZOrder (int z)
var _setLocalZOrder ( var z)
local _setLocalZOrder ( local z)
virtual int getLocalZOrder () const
 Gets the local Z order of this node. More...
 
var getLocalZOrder ()
 Gets the local Z order of this node. More...
 
local getLocalZOrder ()
 Gets the local Z order of this node. More...
 
virtual int getZOrder () const
virtual void setGlobalZOrder (float globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
local setGlobalZOrder ( local globalZOrder)
 Defines the oder in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual void 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. More...
 
var getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float scaleY)
 Sets the scale (y) of the node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. More...
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
var setScaleZ ( var scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
local setScaleZ ( local scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
virtual float getScaleZ () const
 Returns the scale factor on Z axis of this node. More...
 
virtual void 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...
 
local setPosition ( local 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...
 
local setPosition ( local x, local y)
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
var setPositionX ( var x)
 Gets/Sets x or y coordinate individually for position. More...
 
local setPositionX ( local x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
var getPositionY ()
local getPositionY ()
virtual void setPosition3D (const Vec3 &position)
 Sets the position (X, Y, and Z) in its parent's coordinate system. More...
 
virtual Vec3 getPosition3D () const
 returns the position (X,Y,Z) in its parent's coordinate system More...
 
virtual void setPositionZ (float positionZ)
 Sets the 'z' coordinate in the position. More...
 
local setPositionZ ( local positionZ)
 Sets the 'z' coordinate in the position. More...
 
virtual void setVertexZ (float vertexZ)
var setVertexZ ( var vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
var getPositionZ ()
 Gets position Z coordinate of this node. More...
 
local getPositionZ ()
 Gets position Z coordinate of this node. More...
 
virtual float getVertexZ () const
virtual void setSkewX (float skewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local skewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
var getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
local getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float skewY)
 Changes the Y skew angle of the node in degrees. More...
 
var setSkewY ( var skewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local skewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
var getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
local getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const Vec2 &anchorPoint)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
local getAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const Size &contentSize)
 Sets the untransformed size of the node. More...
 
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...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
var setVisible ( var visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
var setRotation3D ( var rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
local setRotation3D ( local rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vec3 getRotation3D () const
 returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationQuat (const Quaternion &quat)
 set rotation by quaternion More...
 
var setRotationQuat ( var quat)
 set rotation by quaternion More...
 
local setRotationQuat ( local quat)
 set rotation by quaternion More...
 
virtual Quaternion getRotationQuat () const
 return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise More...
 
local getRotationQuat ()
 return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise More...
 
virtual void setRotationSkewX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationSkewX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationX (float rotationX)
var setRotationX ( var rotationX)
local setRotationX ( local rotationX)
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
local getRotationSkewX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationX () const
var getRotationX ()
local getRotationX ()
virtual void setRotationSkewY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationSkewY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setRotationY (float rotationY)
var setRotationY ( var rotationY)
local setRotationY ( local rotationY)
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local getRotationSkewY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY () const
var getRotationY ()
local getRotationY ()
void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
int getOrderOfArrival () const
 Returns the arrival order, indicates which children is added previously. More...
 
void setGLServerState (int serverState)
int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
Children and Parent
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
var addChild ( var child)
 Adds a child to the container with z-order as 0. More...
 
local addChild ( local child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int localZOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local localZOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual void addChild (Node *child, int localZOrder, const std::string &name)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local localZOrder, local name)
 Adds a child to the container with z order and tag. More...
 
virtual 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...
 
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...
 
var setParent ( var parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (Node *child, bool cleanup=true)
 Removes a child from the container. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
var removeChildByName ( var name, var true)
 Removes a child from the container by tag value. More...
 
local removeChildByName ( local name, local true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
var removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
var removeAllChildren ( var cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildren ( local cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int localZOrder)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child, local localZOrder)
 Reorders a child according to a new z value. More...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
Tag & User data
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual std::string getName () const
 Returns a string that is used to identify the node. More...
 
local getName ()
 Returns a string that is used to identify the node. More...
 
virtual void setName (const std::string &name)
 Changes the name that is used to identify the node easily. More...
 
var setName ( var name)
 Changes the name that is used to identify the node easily. More...
 
local setName ( local name)
 Changes the name that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual 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...
 
GLProgram
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
local getShaderProgram ()
GLProgramStategetGLProgramState () const
var getGLProgramState ()
local getGLProgramState ()
virtual void setGLProgramState (GLProgramState *glProgramState)
local setGLProgramState ( local glProgramState)
virtual void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
var setGLProgram ( var glprogram)
 Sets the shader program for this node. More...
 
local setGLProgram ( local glprogram)
 Sets the shader program for this node. More...
 
void setShaderProgram (GLProgram *glprogram)
var setShaderProgram ( var glprogram)
local setShaderProgram ( local glprogram)
Event Callbacks
virtual void onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
Actions
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
var getActionManager ()
virtual ActionrunAction (Action *action)
 Executes an action, and returns the action that is executed. More...
 
var runAction ( var action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (Action *action)
 Stops and removes an action from the running action list. More...
 
var stopAction ( var action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
var stopActionByTag ( var tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
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...
 
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 ()
Scheduler and Timer
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
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
bool isScheduled (const std::string &key)
 Checks whether a lambda function is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
var unscheduleUpdate ()
local unscheduleUpdate ()
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
var scheduleOnce ( var selector, var delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
 Schedules a lambda function that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void schedule (const std::function< void(float)> &callback, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
 Schedules a lambda function. More...
 
var schedule ( var callback, var interval, var repeat, var delay, var key)
 Schedules a lambda function. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
var unschedule ( var selector)
 Unschedules a custom selector. More...
 
void unschedule (const std::string &key)
 Unschedules a lambda function. More...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions Actions are not affected by this method. More...
 
void unscheduleAllSelectors ()
var unscheduleAllSelectors ()
local unscheduleAllSelectors ()
virtual void resume (void)
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
virtual void pause (void)
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pause ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
void resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
void pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
var pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
local pauseSchedulerAndActions ()
 Pauses all scheduled selectors, actions and event listeners. More...
 
virtual void update (float delta)
var update ( var delta)
local update ( local delta)
Transformations
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
var updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const 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 void setNodeToParentTransform (const Mat4 &transform)
 Sets the Transformation matrix manually. More...
 
virtual AffineTransform nodeToParentTransform () const
var nodeToParentTransform ()
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 ()
Coordinate Converters
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
var convertToNodeSpace ( var worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
var convertToWorldSpace ( var nodePoint)
 Converts a Vec2 to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 Converts a Vec2 to world space coordinates. More...
 
Vec2 convertToNodeSpaceAR (const Vec2 &worldPoint) const
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpaceAR (const Vec2 &nodePoint) const
 Converts a local Vec2 to world space coordinates.The result is in Points. More...
 
Vec2 convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Vec2 More...
 
var convertTouchToNodeSpace ( var touch)
 convenience methods which take a Touch instead of Vec2 More...
 
local convertTouchToNodeSpace ( local touch)
 convenience methods which take a Touch instead of Vec2 More...
 
Vec2 convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
component functions
ComponentgetComponent (const std::string &name)
 gets a component by its name More...
 
var getComponent ( var name)
 gets a component by its name More...
 
local getComponent ( local name)
 gets a component by its name More...
 
virtual bool addComponent (Component *component)
 adds a component More...
 
local addComponent ( local component)
 adds a component More...
 
virtual bool removeComponent (const std::string &name)
 removes a component by its name More...
 
var removeComponent ( var name)
 removes a component by its name More...
 
local removeComponent ( local name)
 removes a component by its name More...
 
virtual bool removeComponent (Component *component)
 removes a component by its pointer More...
 
local removeComponent ( local component)
 removes a component by its pointer More...
 
virtual void removeAllComponents ()
 removes all components More...
 
var removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Node()

Static Public Attributes

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

Protected Member Functions

void childrenAlloc (void)
 lazy allocs More...
 
var childrenAlloc ()
 lazy allocs More...
 
local childrenAlloc ()
 lazy allocs More...
 
void insertChild (Node *child, int z)
 helper that reorder a child More...
 
var insertChild ( var child, var z)
 helper that reorder a child More...
 
local insertChild ( local child, local z)
 helper that reorder a child More...
 
void detachChild (Node *child, ssize_t index, bool doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
local detachChild ( local child, local index, local doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
Vec2 convertToWindowSpace (const Vec2 &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
var convertToWindowSpace ( var nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
local convertToWindowSpace ( local nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
Mat4 transform (const Mat4 &parentTransform)
var transform ( var parentTransform)
local transform ( local parentTransform)
uint32_t processParentFlags (const Mat4 &parentTransform, uint32_t parentFlags)
var processParentFlags ( var parentTransform, var parentFlags)
local processParentFlags ( local parentTransform, local parentFlags)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void disableCascadeOpacity ()
local disableCascadeOpacity ()
virtual void updateCascadeColor ()
var 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)
bool isVisitableByVisitingCamera () const
void updateRotationQuat ()
var updateRotationQuat ()
local updateRotationQuat ()
void updateRotation3D ()
var updateRotation3D ()
local updateRotation3D ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Protected Attributes

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

Static Protected Attributes

static int s_globalOrderOfArrival
var s_globalOrderOfArrival
local s_globalOrderOfArrival

Friends

class Layer

Constructor, Destructor and Initializers

static Nodecreate ()
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 
virtual std::string getDescription () const
 Gets the description string. More...
 

Detailed Description

Node is the base element of the Scene Graph.

Elements of the Scene Graph must be Node objects or subclasses of it. The most common Node objects are: Scene, Layer, Sprite, Menu, Label.

The main features of a Node are:

  • They can contain other Node objects (addChild, getChildByTag, removeChild, etc)
  • They can schedule periodic callback (schedule, unschedule, etc)
  • They can execute actions (runAction, stopAction, etc)

Subclassing a Node usually means (one/all) of:

  • overriding init to initialize resources and schedule callbacks
  • create callbacks to handle the advancement of time
  • overriding draw to render the node

Properties of Node:

  • position (default: x=0, y=0)
  • scale (default: x=1, y=1)
  • rotation (in degrees, clockwise) (default: 0)
  • anchor point (default: x=0, y=0)
  • contentSize (default: width=0, height=0)
  • visible (default: true)

Limitations:

  • A Node is a "void" object. If you want to draw something on the screen, you should use a Sprite instead. Or subclass Node and override draw.

Constructor & Destructor Documentation

virtual ~Node ( )
virtual
var ~Node ( )
virtual
local ~Node ( )
virtual

Member Function Documentation

virtual void _setLocalZOrder ( int  z)
virtual
var _setLocalZOrder ( var  z)
virtual
local _setLocalZOrder ( local  z)
virtual
virtual void addChild ( Node child)
virtual

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 in ScrollView, Layout, ListView, and Menu.

var addChild ( var  child)
virtual

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 in ScrollView, Layout, ListView, and Menu.

local addChild ( local  child)
virtual

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 in ScrollView, Layout, ListView, and Menu.

virtual void addChild ( Node child,
int  localZOrder 
)
virtual

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 in ScrollView, Layout, ListView, and Menu.

var addChild ( var  child,
var  localZOrder 
)
virtual

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 in ScrollView, Layout, ListView, and Menu.

local addChild ( local  child,
local  localZOrder 
)
virtual

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 in ScrollView, Layout, ListView, and Menu.

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

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 in Sprite, ScrollView, Label, ScrollView, Layout, TMXLayer, ListView, SpriteBatchNode, Menu, Scene, ParticleBatchNode, ParallaxNode, and BatchNode.

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

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 in Sprite, ScrollView, Label, ScrollView, Layout, TMXLayer, ListView, SpriteBatchNode, Menu, Scene, ParticleBatchNode, ParallaxNode, and BatchNode.

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

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 in Sprite, ScrollView, Label, ScrollView, Layout, TMXLayer, ListView, SpriteBatchNode, Menu, Scene, ParticleBatchNode, ParallaxNode, and BatchNode.

virtual void addChild ( Node child,
int  localZOrder,
const std::string &  name 
)
virtual

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 in Sprite, ScrollView, ScrollView, Layout, ListView, SpriteBatchNode, Menu, Scene, ParticleBatchNode, ParallaxNode, and BatchNode.

var addChild ( var  child,
var  localZOrder,
var  name 
)
virtual

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 in Sprite, ScrollView, ScrollView, Layout, ListView, SpriteBatchNode, Menu, Scene, ParticleBatchNode, ParallaxNode, and BatchNode.

local addChild ( local  child,
local  localZOrder,
local  name 
)
virtual

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 in Sprite, ScrollView, ScrollView, Layout, ListView, SpriteBatchNode, Menu, Scene, ParticleBatchNode, ParallaxNode, and BatchNode.

virtual bool addComponent ( Component component)
virtual

adds a component

var addComponent ( var  component)
virtual

adds a component

local addComponent ( local  component)
virtual

adds a component

virtual Rect boundingBox ( ) const
inlinevirtual
Deprecated:
Use getBoundingBox instead
var boundingBox ( )
inlinevirtual
Deprecated:
Use getBoundingBox instead
local boundingBox ( )
inlinevirtual
Deprecated:
Use getBoundingBox instead
void childrenAlloc ( void  )
protected

lazy allocs

var childrenAlloc (   )
protected

lazy allocs

local childrenAlloc (   )
protected

lazy allocs

virtual void cleanup ( )
virtual

Stops all running actions and schedulers.

Reimplemented in Scale9Sprite, ProtectedNode, and TransitionScene.

var cleanup ( )
virtual

Stops all running actions and schedulers.

Reimplemented in Scale9Sprite, ProtectedNode, and TransitionScene.

local cleanup ( )
virtual

Stops all running actions and schedulers.

Reimplemented in Scale9Sprite, ProtectedNode, and TransitionScene.

Vec2 convertToNodeSpace ( const Vec2 worldPoint) const

Converts a Vec2 to node (local) space coordinates.

The result is in Points.

var convertToNodeSpace ( var  worldPoint)

Converts a Vec2 to node (local) space coordinates.

The result is in Points.

local convertToNodeSpace ( local  worldPoint)

Converts a Vec2 to node (local) space coordinates.

The result is in Points.

Vec2 convertToNodeSpaceAR ( const Vec2 worldPoint) const

Converts a Vec2 to node (local) space coordinates.

The result is in Points. treating the returned/received node point as anchor relative.

var convertToNodeSpaceAR ( var  worldPoint)

Converts a Vec2 to node (local) space coordinates.

The result is in Points. treating the returned/received node point as anchor relative.

local convertToNodeSpaceAR ( local  worldPoint)

Converts a Vec2 to node (local) space coordinates.

The result is in Points. treating the returned/received node point as anchor relative.

Vec2 convertTouchToNodeSpace ( Touch touch) const

convenience methods which take a Touch instead of Vec2

var convertTouchToNodeSpace ( var  touch)

convenience methods which take a Touch instead of Vec2

local convertTouchToNodeSpace ( local  touch)

convenience methods which take a Touch instead of Vec2

Vec2 convertTouchToNodeSpaceAR ( Touch touch) const

converts a Touch (world coordinates) into a local coordinate.

This method is AR (Anchor Relative).

var convertTouchToNodeSpaceAR ( var  touch)

converts a Touch (world coordinates) into a local coordinate.

This method is AR (Anchor Relative).

local convertTouchToNodeSpaceAR ( local  touch)

converts a Touch (world coordinates) into a local coordinate.

This method is AR (Anchor Relative).

Vec2 convertToWindowSpace ( const Vec2 nodePoint) const
protected

Convert cocos2d coordinates to UI windows coordinate.

var convertToWindowSpace ( var  nodePoint)
protected

Convert cocos2d coordinates to UI windows coordinate.

local convertToWindowSpace ( local  nodePoint)
protected

Convert cocos2d coordinates to UI windows coordinate.

Vec2 convertToWorldSpace ( const Vec2 nodePoint) const

Converts a Vec2 to world space coordinates.

The result is in Points.

var convertToWorldSpace ( var  nodePoint)

Converts a Vec2 to world space coordinates.

The result is in Points.

local convertToWorldSpace ( local  nodePoint)

Converts a Vec2 to world space coordinates.

The result is in Points.

Vec2 convertToWorldSpaceAR ( const Vec2 nodePoint) const

Converts a local Vec2 to world space coordinates.The result is in Points.

treating the returned/received node point as anchor relative.

var convertToWorldSpaceAR ( var  nodePoint)

Converts a local Vec2 to world space coordinates.The result is in Points.

treating the returned/received node point as anchor relative.

local convertToWorldSpaceAR ( local  nodePoint)

Converts a local Vec2 to world space coordinates.The result is in Points.

treating the returned/received node point as anchor relative.

static Node* create ( )
static

Allocates and initializes a node.

Returns
A initialized node which is marked as "autorelease".
var create ( )
static

Allocates and initializes a node.

Returns
A initialized node which is marked as "autorelease".
local create ( )
static

Allocates and initializes a node.

Returns
A initialized node which is marked as "autorelease".
void detachChild ( Node child,
ssize_t  index,
bool  doCleanup 
)
protected

Removes a child, call child->onExit(), do cleanup, remove it from children array.

var detachChild ( var  child,
var  index,
var  doCleanup 
)
protected

Removes a child, call child->onExit(), do cleanup, remove it from children array.

local detachChild ( local  child,
local  index,
local  doCleanup 
)
protected

Removes a child, call child->onExit(), do cleanup, remove it from children array.

virtual void disableCascadeColor ( )
protectedvirtual

Reimplemented in Scale9Sprite, and ProtectedNode.

var disableCascadeColor ( )
protectedvirtual

Reimplemented in Scale9Sprite, and ProtectedNode.

local disableCascadeColor ( )
protectedvirtual

Reimplemented in Scale9Sprite, and ProtectedNode.

virtual void disableCascadeOpacity ( )
protectedvirtual

Reimplemented in Scale9Sprite, and ProtectedNode.

var disableCascadeOpacity ( )
protectedvirtual

Reimplemented in Scale9Sprite, and ProtectedNode.

local disableCascadeOpacity ( )
protectedvirtual

Reimplemented in Scale9Sprite, and ProtectedNode.

bool doEnumerate ( std::string  name,
std::function< bool(Node *)>  callback 
) const
protected
var doEnumerate ( var  name,
var  callback 
)
protected
local doEnumerate ( local  name,
local  callback 
)
protected
bool doEnumerateRecursive ( const Node node,
const std::string &  name,
std::function< bool(Node *)>  callback 
) const
protected
var doEnumerateRecursive ( var  node,
var  name,
var  callback 
)
protected
local doEnumerateRecursive ( local  node,
local  name,
local  callback 
)
protected
virtual void draw ( Renderer renderer,
const Mat4 transform,
uint32_t  flags 
)
virtual

Override this method to draw your own node.

The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented in TransitionFadeTR, TransitionSplitCols, TransitionTurnOffTiles, TransitionCrossFade, Sprite, Label, LayerColor, Sprite3D, TMXLayer, RenderTexture, SpriteBatchNode, DrawNode, ProgressTimer, ParticleSystemQuad, ParticleBatchNode, BillBoard, TransitionScene, MotionStreak, VideoPlayer, AtlasNode, TransitionPageTurn, and PhysicsDebugNode.

var draw ( var  renderer,
var  transform,
var  flags 
)
virtual

Override this method to draw your own node.

The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented in TransitionFadeTR, TransitionSplitCols, TransitionTurnOffTiles, TransitionCrossFade, Sprite, Label, LayerColor, Sprite3D, TMXLayer, RenderTexture, SpriteBatchNode, DrawNode, ProgressTimer, ParticleSystemQuad, ParticleBatchNode, BillBoard, TransitionScene, MotionStreak, VideoPlayer, AtlasNode, TransitionPageTurn, and PhysicsDebugNode.

local draw ( local  renderer,
local  transform,
local  flags 
)
virtual

Override this method to draw your own node.

The following GL states will be enabled by default:

  • glEnableClientState(GL_VERTEX_ARRAY);
  • glEnableClientState(GL_COLOR_ARRAY);
  • glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  • glEnable(GL_TEXTURE_2D); AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.

Reimplemented in TransitionFadeTR, TransitionSplitCols, TransitionTurnOffTiles, TransitionCrossFade, Sprite, Label, LayerColor, Sprite3D, TMXLayer, RenderTexture, SpriteBatchNode, DrawNode, ProgressTimer, ParticleSystemQuad, ParticleBatchNode, BillBoard, TransitionScene, MotionStreak, VideoPlayer, AtlasNode, TransitionPageTurn, and PhysicsDebugNode.

virtual void draw ( )
finalvirtual
var draw ( )
finalvirtual
local draw ( )
finalvirtual
virtual void enumerateChildren ( const std::string &  name,
std::function< bool(Node *node)>  callback 
) const
virtual

Search the children of the receiving node to perform processing for nodes which share a name.

Parameters
nameThe name to search for, supports c++11 regular expression. Search syntax options: //: Can only be placed at the begin of the search string. This indicates that it will search recursively. ..: The search should move up to the node's parent. Can only be placed at the end of string / : When placed anywhere but the start of the search string, this indicates that the search should move to the node's children.
enumerateChildren("//MyName", ...): This searches the children recursively and matches any node with the name `MyName`.
enumerateChildren("[[:alnum:]]+", ...): This search string matches every node of its children.
enumerateChildren("A[[:digit:]]", ...): This searches the node's children and returns any child named `A0`, `A1`, ..., `A9`
enumerateChildren("Abby/Normal", ...): This searches the node's grandchildren and returns any node whose name is `Normal`
and whose parent is named `Abby`.
enumerateChildren("//Abby/Normal", ...): This searches recursively and returns any node whose name is `Normal` and whose
parent is named `Abby`.
Warning
Only support alpha or number for name, and not support unicode
Parameters
callbackA callback function to execute on nodes that match the name parameter. The function takes the following arguments: node A node that matches the name And returns a boolean result. Your callback can return true to terminate the enumeration.
Since
v3.2
var enumerateChildren ( var  name,
var  callback 
)
virtual

Search the children of the receiving node to perform processing for nodes which share a name.

Parameters
nameThe name to search for, supports c++11 regular expression. Search syntax options: //: Can only be placed at the begin of the search string. This indicates that it will search recursively. ..: The search should move up to the node's parent. Can only be placed at the end of string / : When placed anywhere but the start of the search string, this indicates that the search should move to the node's children.
enumerateChildren("//MyName", ...): This searches the children recursively and matches any node with the name `MyName`.
enumerateChildren("[[:alnum:]]+", ...): This search string matches every node of its children.
enumerateChildren("A[[:digit:]]", ...): This searches the node's children and returns any child named `A0`, `A1`, ..., `A9`
enumerateChildren("Abby/Normal", ...): This searches the node's grandchildren and returns any node whose name is `Normal`
and whose parent is named `Abby`.
enumerateChildren("//Abby/Normal", ...): This searches recursively and returns any node whose name is `Normal` and whose
parent is named `Abby`.
Warning
Only support alpha or number for name, and not support unicode
Parameters
callbackA callback function to execute on nodes that match the name parameter. The function takes the following arguments: node A node that matches the name And returns a boolean result. Your callback can return true to terminate the enumeration.
Since
v3.2
local enumerateChildren ( local  name,
local  callback 
)
virtual

Search the children of the receiving node to perform processing for nodes which share a name.

Parameters
nameThe name to search for, supports c++11 regular expression. Search syntax options: //: Can only be placed at the begin of the search string. This indicates that it will search recursively. ..: The search should move up to the node's parent. Can only be placed at the end of string / : When placed anywhere but the start of the search string, this indicates that the search should move to the node's children.
enumerateChildren("//MyName", ...): This searches the children recursively and matches any node with the name `MyName`.
enumerateChildren("[[:alnum:]]+", ...): This search string matches every node of its children.
enumerateChildren("A[[:digit:]]", ...): This searches the node's children and returns any child named `A0`, `A1`, ..., `A9`
enumerateChildren("Abby/Normal", ...): This searches the node's grandchildren and returns any node whose name is `Normal`
and whose parent is named `Abby`.
enumerateChildren("//Abby/Normal", ...): This searches recursively and returns any node whose name is `Normal` and whose
parent is named `Abby`.
Warning
Only support alpha or number for name, and not support unicode
Parameters
callbackA callback function to execute on nodes that match the name parameter. The function takes the following arguments: node A node that matches the name And returns a boolean result. Your callback can return true to terminate the enumeration.
Since
v3.2
Action* getActionByTag ( int  tag)

Gets an action from the running action list by its tag.

See also
setTag(int), getTag().
Returns
The action object with the given tag.
var getActionByTag ( var  tag)

Gets an action from the running action list by its tag.

See also
setTag(int), getTag().
Returns
The action object with the given tag.
local getActionByTag ( local  tag)

Gets an action from the running action list by its tag.

See also
setTag(int), getTag().
Returns
The action object with the given tag.
virtual ActionManager*
getActionManager
( )
inlinevirtual

Gets the ActionManager object that is used by all actions.

See also
setActionManager(ActionManager*)
Returns
A ActionManager object.
var getActionManager ( )
inlinevirtual

Gets the ActionManager object that is used by all actions.

See also
setActionManager(ActionManager*)
Returns
A ActionManager object.
local getActionManager ( )
inlinevirtual

Gets the ActionManager object that is used by all actions.

See also
setActionManager(ActionManager*)
Returns
A ActionManager object.
virtual const ActionManager*
getActionManager
( ) const
inlinevirtual
var getActionManager ( )
inlinevirtual
local getActionManager ( )
inlinevirtual
virtual const Vec2& getAnchorPoint ( ) const
virtual

Returns the anchor point in percent.

See also
setAnchorPoint(const Vec2&)
Returns
The anchor point of node.
var getAnchorPoint ( )
virtual

Returns the anchor point in percent.

See also
setAnchorPoint(const Vec2&)
Returns
The anchor point of node.
local getAnchorPoint ( )
virtual

Returns the anchor point in percent.

See also
setAnchorPoint(const Vec2&)
Returns
The anchor point of node.
virtual const Vec2&
getAnchorPointInPoints
( ) const
virtual

Returns the anchorPoint in absolute pixels.

Warning
You can only read it. If you wish to modify it, use anchorPoint instead.
See also
getAnchorPoint()
Returns
The anchor point in absolute pixels.

Reimplemented in Armature.

var getAnchorPointInPoints ( )
virtual

Returns the anchorPoint in absolute pixels.

Warning
You can only read it. If you wish to modify it, use anchorPoint instead.
See also
getAnchorPoint()
Returns
The anchor point in absolute pixels.

Reimplemented in Armature.

local getAnchorPointInPoints ( )
virtual

Returns the anchorPoint in absolute pixels.

Warning
You can only read it. If you wish to modify it, use anchorPoint instead.
See also
getAnchorPoint()
Returns
The anchor point in absolute pixels.

Reimplemented in Armature.

virtual Rect getBoundingBox ( ) const
virtual

Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

Returns
An AABB (axis-aligned bounding-box) in its parent's coordinate system

Reimplemented in Label, LabelTTF, Armature, Sprite3D, LabelBMFont, and SkeletonRenderer.

var getBoundingBox ( )
virtual

Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

Returns
An AABB (axis-aligned bounding-box) in its parent's coordinate system

Reimplemented in Label, LabelTTF, Armature, Sprite3D, LabelBMFont, and SkeletonRenderer.

local getBoundingBox ( )
virtual

Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.

Returns
An AABB (axis-aligned bounding-box) in its parent's coordinate system

Reimplemented in Label, LabelTTF, Armature, Sprite3D, LabelBMFont, and SkeletonRenderer.

unsigned short getCameraMask ( ) const
inline

get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true

var getCameraMask ( )
inline

get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true

local getCameraMask ( )
inline

get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true

virtual Node* getChildByName ( const std::string &  name) const
virtual

Gets a child from the container with its name.

Parameters
nameAn identifier to find the child node.
Returns
a Node object whose name equals to the input parameter
Since
v3.2

Reimplemented in ScrollView.

var getChildByName ( var  name)
virtual

Gets a child from the container with its name.

Parameters
nameAn identifier to find the child node.
Returns
a Node object whose name equals to the input parameter
Since
v3.2

Reimplemented in ScrollView.

local getChildByName ( local  name)
virtual

Gets a child from the container with its name.

Parameters
nameAn identifier to find the child node.
Returns
a Node object whose name equals to the input parameter
Since
v3.2

Reimplemented in ScrollView.

T getChildByName ( const std::string &  name) const
inline

Gets a child from the container with its name that can be cast to Type T.

Parameters
nameAn identifier to find the child node.
Returns
a Node with the given name that can be cast to Type T
var getChildByName ( var  name)
inline

Gets a child from the container with its name that can be cast to Type T.

Parameters
nameAn identifier to find the child node.
Returns
a Node with the given name that can be cast to Type T
local getChildByName ( local  name)
inline

Gets a child from the container with its name that can be cast to Type T.

Parameters
nameAn identifier to find the child node.
Returns
a Node with the given name that can be cast to Type T
virtual Node* getChildByTag ( int  tag) const
virtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Please use getChildByName() instead

Reimplemented in ScrollView, and LabelBMFont.

var getChildByTag ( var  tag)
virtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Please use getChildByName() instead

Reimplemented in ScrollView, and LabelBMFont.

local getChildByTag ( local  tag)
virtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Please use getChildByName() instead

Reimplemented in ScrollView, and LabelBMFont.

virtual Vector<Node*>& getChildren ( )
inlinevirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented in ScrollView.

var getChildren ( )
inlinevirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented in ScrollView.

local getChildren ( )
inlinevirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented in ScrollView.

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

Reimplemented in ScrollView.

var getChildren ( )
inlinevirtual

Reimplemented in ScrollView.

local getChildren ( )
inlinevirtual

Reimplemented in ScrollView.

virtual ssize_t getChildrenCount ( ) const
virtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented in ScrollView.

var getChildrenCount ( )
virtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented in ScrollView.

local getChildrenCount ( )
virtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented in ScrollView.

virtual const Color3B& getColor ( ) const
virtual

Reimplemented in __NodeRGBA, __LayerRGBA, ProgressTimer, and AtlasNode.

var getColor ( )
virtual

Reimplemented in __NodeRGBA, __LayerRGBA, ProgressTimer, and AtlasNode.

local getColor ( )
virtual

Reimplemented in __NodeRGBA, __LayerRGBA, ProgressTimer, and AtlasNode.

Component* getComponent ( const std::string &  name)

gets a component by its name

var getComponent ( var  name)

gets a component by its name

local getComponent ( local  name)

gets a component by its name

virtual const Size& getContentSize ( ) const
virtual

Returns the untransformed size of the node.

See also
setContentSize(const Size&)
Returns
The untransformed size of the node.

Reimplemented in Label, ScrollView, LabelTTF, and LabelBMFont.

var getContentSize ( )
virtual

Returns the untransformed size of the node.

See also
setContentSize(const Size&)
Returns
The untransformed size of the node.

Reimplemented in Label, ScrollView, LabelTTF, and LabelBMFont.

local getContentSize ( )
virtual

Returns the untransformed size of the node.

See also
setContentSize(const Size&)
Returns
The untransformed size of the node.

Reimplemented in Label, ScrollView, LabelTTF, and LabelBMFont.

virtual std::string getDescription ( ) const
virtual
virtual const Color3B&
getDisplayedColor
( ) const
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

var getDisplayedColor ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

local getDisplayedColor ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

virtual GLubyte getDisplayedOpacity ( ) const
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

var getDisplayedOpacity ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

local getDisplayedOpacity ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

virtual EventDispatcher*
getEventDispatcher
( ) const
inlinevirtual
var getEventDispatcher ( )
inlinevirtual
local getEventDispatcher ( )
inlinevirtual
virtual float getGlobalZOrder ( ) const
inlinevirtual

Returns the Node's Global Z Order.

See also
setGlobalZOrder(int)
Returns
The node's global Z order
var getGlobalZOrder ( )
inlinevirtual

Returns the Node's Global Z Order.

See also
setGlobalZOrder(int)
Returns
The node's global Z order
local getGlobalZOrder ( )
inlinevirtual

Returns the Node's Global Z Order.

See also
setGlobalZOrder(int)
Returns
The node's global Z order
GLProgram* getGLProgram ( ) const

Return the GLProgram (shader) currently used for this node.

Returns
The GLProgram (shader) currently used for this node
var getGLProgram ( )

Return the GLProgram (shader) currently used for this node.

Returns
The GLProgram (shader) currently used for this node
local getGLProgram ( )

Return the GLProgram (shader) currently used for this node.

Returns
The GLProgram (shader) currently used for this node
GLProgramState* getGLProgramState ( ) const
var getGLProgramState ( )
local getGLProgramState ( )
int getGLServerState ( ) const
inline
Deprecated:
No longer needed
virtual int getLocalZOrder ( ) const
inlinevirtual

Gets the local Z order of this node.

See also
setLocalZOrder(int)
Returns
The local (relative to its siblings) Z order.
var getLocalZOrder ( )
inlinevirtual

Gets the local Z order of this node.

See also
setLocalZOrder(int)
Returns
The local (relative to its siblings) Z order.
local getLocalZOrder ( )
inlinevirtual

Gets the local Z order of this node.

See also
setLocalZOrder(int)
Returns
The local (relative to its siblings) Z order.
virtual std::string getName ( ) const
virtual

Returns a string that is used to identify the node.

Returns
A string that identifies the node.
Since
v3.2
var getName ( )
virtual

Returns a string that is used to identify the node.

Returns
A string that identifies the node.
Since
v3.2
local getName ( )
virtual

Returns a string that is used to identify the node.

Returns
A string that identifies the node.
Since
v3.2
virtual AffineTransform
getNodeToParentAffineTransform
( ) const
virtual
var getNodeToParentAffineTransform ( )
virtual
local
getNodeToParentAffineTransform
( )
virtual
virtual const Mat4&
getNodeToParentTransform
( ) const
virtual

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

The matrix is in Pixels.

Reimplemented in Armature.

var getNodeToParentTransform ( )
virtual

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

The matrix is in Pixels.

Reimplemented in Armature.

local getNodeToParentTransform ( )
virtual

Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.

The matrix is in Pixels.

Reimplemented in Armature.

virtual AffineTransform
getNodeToWorldAffineTransform
( ) const
virtual
var getNodeToWorldAffineTransform ( )
virtual
local getNodeToWorldAffineTransform ( )
virtual
virtual Mat4
getNodeToWorldTransform
( ) const
virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Reimplemented in Bone, Skin, and AttachNode.

var getNodeToWorldTransform ( )
virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Reimplemented in Bone, Skin, and AttachNode.

local getNodeToWorldTransform ( )
virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Reimplemented in Bone, Skin, and AttachNode.

virtual const Vec2&
getNormalizedPosition
( ) const
virtual

returns the normalized position

var getNormalizedPosition ( )
virtual

returns the normalized position

local getNormalizedPosition ( )
virtual

returns the normalized position

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

Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

Todo:
Rename to getNumberOfRunningActions()
Returns
The number of actions that are running plus the ones that are schedule to run
var getNumberOfRunningActions ( )

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

Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

Todo:
Rename to getNumberOfRunningActions()
Returns
The number of actions that are running plus the ones that are schedule to run
local getNumberOfRunningActions ( )

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

Composable actions are counted as 1 action. Example: If you are running 1 Sequence of 7 actions, it will return 1. If you are running 7 Sequences of 2 actions, it will return 7.

Todo:
Rename to getNumberOfRunningActions()
Returns
The number of actions that are running plus the ones that are schedule to run
const std::function<void()>
& getOnEnterCallback
( ) const
inline
var getOnEnterCallback ( )
inline
local getOnEnterCallback ( )
inline
const std::function<void()>
& getonEnterTransitionDidFinishCallback
( ) const
inline
var
getonEnterTransitionDidFinishCallback
( )
inline
local
getonEnterTransitionDidFinishCallback
( )
inline
const std::function<void()>
& getOnExitCallback
( ) const
inline
var getOnExitCallback ( )
inline
local getOnExitCallback ( )
inline
const std::function<void()>
& getonExitTransitionDidStartCallback
( ) const
inline
var
getonExitTransitionDidStartCallback
( )
inline
local
getonExitTransitionDidStartCallback
( )
inline
virtual GLubyte getOpacity ( ) const
virtual
var getOpacity ( )
virtual
local getOpacity ( )
virtual
int getOrderOfArrival ( ) const

Returns the arrival order, indicates which children is added previously.

See also
setOrderOfArrival(unsigned int)
Returns
The arrival order.
var getOrderOfArrival ( )

Returns the arrival order, indicates which children is added previously.

See also
setOrderOfArrival(unsigned int)
Returns
The arrival order.
local getOrderOfArrival ( )

Returns the arrival order, indicates which children is added previously.

See also
setOrderOfArrival(unsigned int)
Returns
The arrival order.
virtual Node* getParent ( )
inlinevirtual

Returns a pointer to the parent node.

See also
setParent(Node*)
Returns
A pointer to the parent node
var getParent ( )
inlinevirtual

Returns a pointer to the parent node.

See also
setParent(Node*)
Returns
A pointer to the parent node
local getParent ( )
inlinevirtual

Returns a pointer to the parent node.

See also
setParent(Node*)
Returns
A pointer to the parent node
virtual const Node* getParent ( ) const
inlinevirtual
var getParent ( )
inlinevirtual
local getParent ( )
inlinevirtual
virtual AffineTransform
getParentToNodeAffineTransform
( ) const
virtual
var getParentToNodeAffineTransform ( )
virtual
local
getParentToNodeAffineTransform
( )
virtual
virtual const Mat4&
getParentToNodeTransform
( ) const
virtual

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

The matrix is in Pixels.

var getParentToNodeTransform ( )
virtual

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

The matrix is in Pixels.

local getParentToNodeTransform ( )
virtual

Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.

The matrix is in Pixels.

PhysicsBody* getPhysicsBody ( ) const
inline

get the PhysicsBody the sprite have

var getPhysicsBody ( )
inline

get the PhysicsBody the sprite have

local getPhysicsBody ( )
inline

get the PhysicsBody the sprite have

virtual const Vec2& getPosition ( ) const
virtual

Gets the position (x,y) of the node in its parent's coordinate system.

See also
setPosition(const Vec2&)
Returns
The position (x,y) of the node in OpenGL coordinates
In js and lua return value is table which contains x,y

Reimplemented in MotionStreak.

var getPosition ( )
virtual

Gets the position (x,y) of the node in its parent's coordinate system.

See also
setPosition(const Vec2&)
Returns
The position (x,y) of the node in OpenGL coordinates
In js and lua return value is table which contains x,y

Reimplemented in MotionStreak.

local getPosition ( )
virtual

Gets the position (x,y) of the node in its parent's coordinate system.

See also
setPosition(const Vec2&)
Returns
The position (x,y) of the node in OpenGL coordinates
In js and lua return value is table which contains x,y

Reimplemented in MotionStreak.

virtual void getPosition ( float *  x,
float *  y 
) const
virtual

Gets position in a more efficient way, returns two number instead of a Vec2 object.

See also
setPosition(float, float) In js,out value not return

Reimplemented in MotionStreak.

var getPosition ( var  x,
var  y 
)
virtual

Gets position in a more efficient way, returns two number instead of a Vec2 object.

See also
setPosition(float, float) In js,out value not return

Reimplemented in MotionStreak.

local getPosition ( local  x,
local  y 
)
virtual

Gets position in a more efficient way, returns two number instead of a Vec2 object.

See also
setPosition(float, float) In js,out value not return

Reimplemented in MotionStreak.

virtual Vec3 getPosition3D ( ) const
virtual

returns the position (X,Y,Z) in its parent's coordinate system

var getPosition3D ( )
virtual

returns the position (X,Y,Z) in its parent's coordinate system

local getPosition3D ( )
virtual

returns the position (X,Y,Z) in its parent's coordinate system

virtual float getPositionX ( void  ) const
virtual

Reimplemented in MotionStreak.

var getPositionX (   )
virtual

Reimplemented in MotionStreak.

local getPositionX (   )
virtual

Reimplemented in MotionStreak.

virtual float getPositionY ( void  ) const
virtual

Reimplemented in MotionStreak.

var getPositionY (   )
virtual

Reimplemented in MotionStreak.

local getPositionY (   )
virtual

Reimplemented in MotionStreak.

virtual float getPositionZ ( ) const
virtual

Gets position Z coordinate of this node.

See also
setPositionZ(float)
Returns
the position Z coordinate of this node.
var getPositionZ ( )
virtual

Gets position Z coordinate of this node.

See also
setPositionZ(float)
Returns
the position Z coordinate of this node.
local getPositionZ ( )
virtual

Gets position Z coordinate of this node.

See also
setPositionZ(float)
Returns
the position Z coordinate of this node.
virtual float getRotation ( ) const
virtual

Returns the rotation of the node in degrees.

See also
setRotation(float)
Returns
The rotation of the node in degrees.
var getRotation ( )
virtual

Returns the rotation of the node in degrees.

See also
setRotation(float)
Returns
The rotation of the node in degrees.
local getRotation ( )
virtual

Returns the rotation of the node in degrees.

See also
setRotation(float)
Returns
The rotation of the node in degrees.
virtual Vec3 getRotation3D ( ) const
virtual

returns the rotation (X,Y,Z) in degrees.

var getRotation3D ( )
virtual

returns the rotation (X,Y,Z) in degrees.

local getRotation3D ( )
virtual

returns the rotation (X,Y,Z) in degrees.

virtual Quaternion getRotationQuat ( ) const
virtual

return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise

var getRotationQuat ( )
virtual

return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise

local getRotationQuat ( )
virtual

return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise

virtual float getRotationSkewX ( ) const
virtual

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

See also
setRotationSkewX(float)
Returns
The X rotation in degrees.
var getRotationSkewX ( )
virtual

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

See also
setRotationSkewX(float)
Returns
The X rotation in degrees.
local getRotationSkewX ( )
virtual

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

See also
setRotationSkewX(float)
Returns
The X rotation in degrees.
virtual float getRotationSkewY ( ) const
virtual

Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

See also
setRotationSkewY(float)
Returns
The Y rotation in degrees.
var getRotationSkewY ( )
virtual

Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

See also
setRotationSkewY(float)
Returns
The Y rotation in degrees.
local getRotationSkewY ( )
virtual

Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

See also
setRotationSkewY(float)
Returns
The Y rotation in degrees.
virtual float getRotationX ( ) const
inlinevirtual
var getRotationX ( )
inlinevirtual
local getRotationX ( )
inlinevirtual
virtual float getRotationY ( ) const
inlinevirtual
var getRotationY ( )
inlinevirtual
local getRotationY ( )
inlinevirtual
virtual float getScale ( ) const
virtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning
Assert when _scaleX != _scaleY
See also
setScale(float)
Returns
The scale factor of the node.

Reimplemented in Scale9Sprite, and Widget.

var getScale ( )
virtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning
Assert when _scaleX != _scaleY
See also
setScale(float)
Returns
The scale factor of the node.

Reimplemented in Scale9Sprite, and Widget.

local getScale ( )
virtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning
Assert when _scaleX != _scaleY
See also
setScale(float)
Returns
The scale factor of the node.

Reimplemented in Scale9Sprite, and Widget.

virtual float getScaleX ( ) const
virtual

Returns the scale factor on X axis of this node.

See also
setScaleX(float)
Returns
The scale factor on X axis.

Reimplemented in Scale9Sprite, Widget, and Label.

var getScaleX ( )
virtual

Returns the scale factor on X axis of this node.

See also
setScaleX(float)
Returns
The scale factor on X axis.

Reimplemented in Scale9Sprite, Widget, and Label.

local getScaleX ( )
virtual

Returns the scale factor on X axis of this node.

See also
setScaleX(float)
Returns
The scale factor on X axis.

Reimplemented in Scale9Sprite, Widget, and Label.

virtual float getScaleY ( ) const
virtual

Returns the scale factor on Y axis of this node.

See also
setScaleY(float)
Returns
The scale factor on Y axis.

Reimplemented in Scale9Sprite, Widget, and Label.

var getScaleY ( )
virtual

Returns the scale factor on Y axis of this node.

See also
setScaleY(float)
Returns
The scale factor on Y axis.

Reimplemented in Scale9Sprite, Widget, and Label.

local getScaleY ( )
virtual

Returns the scale factor on Y axis of this node.

See also
setScaleY(float)
Returns
The scale factor on Y axis.

Reimplemented in Scale9Sprite, Widget, and Label.

virtual float getScaleZ ( ) const
virtual

Returns the scale factor on Z axis of this node.

See also
setScaleZ(float)
Returns
The scale factor on Z axis.
var getScaleZ ( )
virtual

Returns the scale factor on Z axis of this node.

See also
setScaleZ(float)
Returns
The scale factor on Z axis.
local getScaleZ ( )
virtual

Returns the scale factor on Z axis of this node.

See also
setScaleZ(float)
Returns
The scale factor on Z axis.
virtual Scene* getScene ( ) const
virtual

Returns the Scene that contains the Node.

It returns nullptr if the node doesn't belong to any Scene. This function recursively calls parent->getScene() until parent is a Scene object. The results are not cached. It is that the user caches the results in case this functions is being used inside a loop.

var getScene ( )
virtual

Returns the Scene that contains the Node.

It returns nullptr if the node doesn't belong to any Scene. This function recursively calls parent->getScene() until parent is a Scene object. The results are not cached. It is that the user caches the results in case this functions is being used inside a loop.

local getScene ( )
virtual

Returns the Scene that contains the Node.

It returns nullptr if the node doesn't belong to any Scene. This function recursively calls parent->getScene() until parent is a Scene object. The results are not cached. It is that the user caches the results in case this functions is being used inside a loop.

virtual Scheduler* getScheduler ( )
inlinevirtual

Gets a Sheduler object.

See also
setScheduler(Scheduler*)
Returns
A Scheduler object.
var getScheduler ( )
inlinevirtual

Gets a Sheduler object.

See also
setScheduler(Scheduler*)
Returns
A Scheduler object.
local getScheduler ( )
inlinevirtual

Gets a Sheduler object.

See also
setScheduler(Scheduler*)
Returns
A Scheduler object.
virtual const Scheduler*
getScheduler
( ) const
inlinevirtual
var getScheduler ( )
inlinevirtual
local getScheduler ( )
inlinevirtual
GLProgram* getShaderProgram ( ) const
inline
var getShaderProgram ( )
inline
local getShaderProgram ( )
inline
virtual float getSkewX ( ) const
virtual

Returns the X skew angle of the node in degrees.

See also
setSkewX(float)
Returns
The X skew angle of the node in degrees.
var getSkewX ( )
virtual

Returns the X skew angle of the node in degrees.

See also
setSkewX(float)
Returns
The X skew angle of the node in degrees.
local getSkewX ( )
virtual

Returns the X skew angle of the node in degrees.

See also
setSkewX(float)
Returns
The X skew angle of the node in degrees.
virtual float getSkewY ( ) const
virtual

Returns the Y skew angle of the node in degrees.

See also
setSkewY(float)
Returns
The Y skew angle of the node in degrees.
var getSkewY ( )
virtual

Returns the Y skew angle of the node in degrees.

See also
setSkewY(float)
Returns
The Y skew angle of the node in degrees.
local getSkewY ( )
virtual

Returns the Y skew angle of the node in degrees.

See also
setSkewY(float)
Returns
The Y skew angle of the node in degrees.
virtual int getTag ( ) const
virtual

Returns a tag that is used to identify the node easily.

Returns
An integer that identifies the node.

Please use getTag() instead.

var getTag ( )
virtual

Returns a tag that is used to identify the node easily.

Returns
An integer that identifies the node.

Please use getTag() instead.

local getTag ( )
virtual

Returns a tag that is used to identify the node easily.

Returns
An integer that identifies the node.

Please use getTag() instead.

virtual void* getUserData ( )
inlinevirtual

Returns a custom user data pointer.

You can set everything in UserData pointer, a data block, a structure or an object.

Returns
A custom user data pointer
virtual const void* getUserData ( ) const
inlinevirtual
virtual Ref* getUserObject ( )
inlinevirtual

Returns a user assigned Object.

Similar to userData, but instead of holding a void* it holds an object

Returns
A user assigned Object
virtual const Ref* getUserObject ( ) const
inlinevirtual
virtual float getVertexZ ( ) const
inlinevirtual
var getVertexZ ( )
inlinevirtual
local getVertexZ ( )
inlinevirtual
virtual AffineTransform
getWorldToNodeAffineTransform
( ) const
virtual
var getWorldToNodeAffineTransform ( )
virtual
local getWorldToNodeAffineTransform ( )
virtual
virtual Mat4
getWorldToNodeTransform
( ) const
virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

Reimplemented in AttachNode.

var getWorldToNodeTransform ( )
virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

Reimplemented in AttachNode.

local getWorldToNodeTransform ( )
virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

Reimplemented in AttachNode.

virtual int getZOrder ( ) const
inlinevirtual
var getZOrder ( )
inlinevirtual
local getZOrder ( )
inlinevirtual
virtual void
ignoreAnchorPointForPosition
( bool  ignore)
virtual

Sets whether the anchor point will be (0,0) when you position this node.

This is an internal method, only used by Layer and Scene. Don't call it outside framework. The default value is false, while in Layer and Scene are true

Parameters
ignoretrue if anchor point will be (0,0) when you position this node
Todo:
This method should be renamed as setIgnoreAnchorPointForPosition(bool) or something with "set"

Reimplemented in Sprite.

var ignoreAnchorPointForPosition ( var  ignore)
virtual

Sets whether the anchor point will be (0,0) when you position this node.

This is an internal method, only used by Layer and Scene. Don't call it outside framework. The default value is false, while in Layer and Scene are true

Parameters
ignoretrue if anchor point will be (0,0) when you position this node
Todo:
This method should be renamed as setIgnoreAnchorPointForPosition(bool) or something with "set"

Reimplemented in Sprite.

local ignoreAnchorPointForPosition ( local  ignore)
virtual

Sets whether the anchor point will be (0,0) when you position this node.

This is an internal method, only used by Layer and Scene. Don't call it outside framework. The default value is false, while in Layer and Scene are true

Parameters
ignoretrue if anchor point will be (0,0) when you position this node
Todo:
This method should be renamed as setIgnoreAnchorPointForPosition(bool) or something with "set"

Reimplemented in Sprite.

void insertChild ( Node child,
int  z 
)
protected

helper that reorder a child

var insertChild ( var  child,
var  z 
)
protected

helper that reorder a child

local insertChild ( local  child,
local  z 
)
protected

helper that reorder a child

virtual bool isCascadeColorEnabled ( ) const
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

var isCascadeColorEnabled ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

local isCascadeColorEnabled ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

virtual bool
isCascadeOpacityEnabled
( ) const
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

var isCascadeOpacityEnabled ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

local isCascadeOpacityEnabled ( )
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

virtual bool
isIgnoreAnchorPointForPosition
( ) const
virtual

Gets whether the anchor point will be (0,0) when you position this node.

See also
ignoreAnchorPointForPosition(bool)
Returns
true if the anchor point will be (0,0) when you position this node.
var isIgnoreAnchorPointForPosition ( )
virtual

Gets whether the anchor point will be (0,0) when you position this node.

See also
ignoreAnchorPointForPosition(bool)
Returns
true if the anchor point will be (0,0) when you position this node.
local
isIgnoreAnchorPointForPosition
( )
virtual

Gets whether the anchor point will be (0,0) when you position this node.

See also
ignoreAnchorPointForPosition(bool)
Returns
true if the anchor point will be (0,0) when you position this node.
virtual bool isOpacityModifyRGB ( void  ) const
inlinevirtual
var isOpacityModifyRGB (   )
inlinevirtual
local isOpacityModifyRGB (   )
inlinevirtual
virtual bool isRunning ( ) const
virtual

Returns whether or not the node is "running".

If the node is running it will accept event callbacks like onEnter(), onExit(), update()

Returns
Whether or not the node is running.
var isRunning ( )
virtual

Returns whether or not the node is "running".

If the node is running it will accept event callbacks like onEnter(), onExit(), update()

Returns
Whether or not the node is running.
local isRunning ( )
virtual

Returns whether or not the node is "running".

If the node is running it will accept event callbacks like onEnter(), onExit(), update()

Returns
Whether or not the node is running.
bool isScheduled ( SEL_SCHEDULE  selector)

Checks whether a selector is scheduled.

Parameters
selectorA function selector
Returns
Whether the funcion selector is scheduled.
bool isScheduled ( const std::string &  key)

Checks whether a lambda function is scheduled.

Parameters
keykey of the callback
Returns
Whether the lambda function selector is scheduled.
virtual bool isVisible ( ) const
virtual

Determines if the node is visible.

See also
setVisible(bool)
Returns
true if the node is visible, false if the node is hidden.
var isVisible ( )
virtual

Determines if the node is visible.

See also
setVisible(bool)
Returns
true if the node is visible, false if the node is hidden.
local isVisible ( )
virtual

Determines if the node is visible.

See also
setVisible(bool)
Returns
true if the node is visible, false if the node is hidden.
bool isVisitableByVisitingCamera ( ) const
protected
var isVisitableByVisitingCamera ( )
protected
local isVisitableByVisitingCamera ( )
protected
virtual AffineTransform
nodeToParentTransform
( ) const
inlinevirtual
var nodeToParentTransform ( )
inlinevirtual
local nodeToParentTransform ( )
inlinevirtual
virtual AffineTransform
nodeToWorldTransform
( ) const
inlinevirtual
var nodeToWorldTransform ( )
inlinevirtual
local nodeToWorldTransform ( )
inlinevirtual
ssize_t numberOfRunningActions ( ) const
inline
var numberOfRunningActions ( )
inline
local numberOfRunningActions ( )
inline
virtual void onEnter ( )
virtual

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 in TransitionFadeTR, TransitionSplitCols, TransitionTurnOffTiles, TransitionCrossFade, TransitionFade, TransitionZoomFlipAngular, TransitionZoomFlipY, Widget, TransitionZoomFlipX, TransitionFlipAngular, TransitionFlipY, TransitionFlipX, EditBox, TransitionShrinkGrow, ParticleSystem, ScrollView, Scale9Sprite, TransitionSlideInL, Layout, TransitionMoveInL, TextField, TransitionJumpZoom, PageView, Armature, TransitionRotoZoom, Camera, Menu, ProtectedNode, TransitionScene, ClippingNode, BaseLight, TransitionPageTurn, TransitionProgress, and UICCTextField.

virtual void
onEnterTransitionDidFinish
( )
virtual

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

If the Node enters the 'stage' with a transition, this event is called when the transition finishes. If you override onEnterTransitionDidFinish, you shall call its parent's one, e.g. Node::onEnterTransitionDidFinish()

Reimplemented in Scale9Sprite, ProtectedNode, and ClippingNode.

virtual void onExit ( )
virtual

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 in TransitionFadeTR, TransitionSplitCols, TransitionTurnOffTiles, TransitionCrossFade, TransitionFade, Widget, EditBox, ParticleSystem, Scale9Sprite, Layout, Armature, ProtectedNode, Camera, Menu, ClippingNode, TransitionScene, MenuItem, BaseLight, TransitionPageTurn, and TransitionProgress.

virtual void
onExitTransitionDidStart
( )
virtual

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

If the Node leaves the 'stage' with a transition, this callback is called when the transition starts.

Reimplemented in Scale9Sprite, ProtectedNode, and ClippingNode.

virtual AffineTransform
parentToNodeTransform
( ) const
inlinevirtual
var parentToNodeTransform ( )
inlinevirtual
local parentToNodeTransform ( )
inlinevirtual
virtual void pause ( void  )
virtual

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit

Reimplemented in VideoPlayer.

var pause (   )
virtual

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit

Reimplemented in VideoPlayer.

local pause (   )
virtual

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit

Reimplemented in VideoPlayer.

void pauseSchedulerAndActions ( )

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit

var pauseSchedulerAndActions ( )

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit

local pauseSchedulerAndActions ( )

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit

uint32_t processParentFlags ( const Mat4 parentTransform,
uint32_t  parentFlags 
)
protected
var processParentFlags ( var  parentTransform,
var  parentFlags 
)
protected
local processParentFlags ( local  parentTransform,
local  parentFlags 
)
protected
virtual void removeAllChildren ( )
virtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented in ScrollView, Layout, and ListView.

var removeAllChildren ( )
virtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented in ScrollView, Layout, and ListView.

local removeAllChildren ( )
virtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented in ScrollView, Layout, and ListView.

virtual void
removeAllChildrenWithCleanup
( bool  cleanup)
virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters
cleanuptrue if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented in Sprite, Layout, ScrollView, ListView, SpriteBatchNode, ParticleBatchNode, and ParallaxNode.

var removeAllChildren ( var  cleanup)
virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters
cleanuptrue if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented in Sprite, Layout, ScrollView, ListView, SpriteBatchNode, ParticleBatchNode, and ParallaxNode.

local removeAllChildren ( local  cleanup)
virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters
cleanuptrue if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented in Sprite, Layout, ScrollView, ListView, SpriteBatchNode, ParticleBatchNode, and ParallaxNode.

virtual void removeAllComponents ( )
virtual

removes all components

var removeAllComponents ( )
virtual

removes all components

local removeAllComponents ( )
virtual

removes all components

virtual void removeChild ( Node child,
bool  cleanup = true 
)
virtual

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 in Sprite, ScrollView, Layout, TMXLayer, TMXLayer, ListView, SpriteBatchNode, Menu, ParticleBatchNode, ParallaxNode, and BatchNode.

var removeChild ( var  child,
var  cleanup = true 
)
virtual

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 in Sprite, ScrollView, Layout, TMXLayer, TMXLayer, ListView, SpriteBatchNode, Menu, ParticleBatchNode, ParallaxNode, and BatchNode.

local removeChild ( local  child,
local  cleanup = true 
)
virtual

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 in Sprite, ScrollView, Layout, TMXLayer, TMXLayer, ListView, SpriteBatchNode, Menu, ParticleBatchNode, ParallaxNode, and BatchNode.

virtual void removeChildByName ( const std::string &  name,
bool  cleanup = true 
)
virtual

Removes a child from the container by tag value.

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

Parameters
nameA string that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.
var removeChildByName ( var  name,
var  cleanup = true 
)
virtual

Removes a child from the container by tag value.

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

Parameters
nameA string that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.
local removeChildByName ( local  name,
local  cleanup = true 
)
virtual

Removes a child from the container by tag value.

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

Parameters
nameA string that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.
virtual void removeChildByTag ( int  tag,
bool  cleanup = true 
)
virtual

Removes a child from the container by tag value.

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

Parameters
tagAn interger number that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Please use removeChildByName instead.

var removeChildByTag ( var  tag,
var  cleanup = true 
)
virtual

Removes a child from the container by tag value.

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

Parameters
tagAn interger number that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Please use removeChildByName instead.

local removeChildByTag ( local  tag,
local  cleanup = true 
)
virtual

Removes a child from the container by tag value.

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

Parameters
tagAn interger number that identifies a child node
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Please use removeChildByName instead.

virtual bool removeComponent ( const std::string &  name)
virtual

removes a component by its name

var removeComponent ( var  name)
virtual

removes a component by its name

local removeComponent ( local  name)
virtual

removes a component by its name

virtual bool removeComponent ( Component component)
virtual

removes a component by its pointer

var removeComponent ( var  component)
virtual

removes a component by its pointer

local removeComponent ( local  component)
virtual

removes a component by its pointer

virtual void removeFromParent ( )
virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See also
removeFromParentAndCleanup(bool)
var removeFromParent ( )
virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See also
removeFromParentAndCleanup(bool)
local removeFromParent ( )
virtual

Removes this node itself from its parent node with a cleanup.

If the node orphan, then nothing happens.

See also
removeFromParentAndCleanup(bool)
virtual void
removeFromParentAndCleanup
( bool  cleanup)
virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters
cleanuptrue if all actions and callbacks on this node should be removed, false otherwise.
var removeFromParent ( var  cleanup)
virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters
cleanuptrue if all actions and callbacks on this node should be removed, false otherwise.
local removeFromParent ( local  cleanup)
virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters
cleanuptrue if all actions and callbacks on this node should be removed, false otherwise.
void removeFromPhysicsWorld ( )

remove this node from physics world.

it will remove all the physics bodies in it's children too.

var removeFromPhysicsWorld ( )

remove this node from physics world.

it will remove all the physics bodies in it's children too.

local removeFromPhysicsWorld ( )

remove this node from physics world.

it will remove all the physics bodies in it's children too.

virtual void reorderChild ( Node child,
int  localZOrder 
)
virtual

Reorders a child according to a new z value.

Parameters
childAn already added child node. It MUST be already added.
localZOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented in Sprite, SpriteBatchNode, and ParticleBatchNode.

var reorderChild ( var  child,
var  localZOrder 
)
virtual

Reorders a child according to a new z value.

Parameters
childAn already added child node. It MUST be already added.
localZOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented in Sprite, SpriteBatchNode, and ParticleBatchNode.

local reorderChild ( local  child,
local  localZOrder 
)
virtual

Reorders a child according to a new z value.

Parameters
childAn already added child node. It MUST be already added.
localZOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented in Sprite, SpriteBatchNode, and ParticleBatchNode.

virtual void resume ( void  )
virtual

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter

Reimplemented in VideoPlayer.

var resume (   )
virtual

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter

Reimplemented in VideoPlayer.

local resume (   )
virtual

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter

Reimplemented in VideoPlayer.

void resumeSchedulerAndActions ( )

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter

var resumeSchedulerAndActions ( )

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter

local resumeSchedulerAndActions ( )

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter

virtual Action* runAction ( Action action)
virtual

Executes an action, and returns the action that is executed.

This node becomes the action's target. Refer to Action::getTarget()

Warning
Actions don't retain their target.
Returns
An Action pointer

Reimplemented in Sprite3D.

var runAction ( var  action)
virtual

Executes an action, and returns the action that is executed.

This node becomes the action's target. Refer to Action::getTarget()

Warning
Actions don't retain their target.
Returns
An Action pointer

Reimplemented in Sprite3D.

local runAction ( local  action)
virtual

Executes an action, and returns the action that is executed.

This node becomes the action's target. Refer to Action::getTarget()

Warning
Actions don't retain their target.
Returns
An Action pointer

Reimplemented in Sprite3D.

void schedule ( SEL_SCHEDULE  selector,
float  interval,
unsigned int  repeat,
float  delay 
)

Schedules a custom selector.

If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

// firstly, implement a schedule function
void MyNode::TickMe(float dt);
// wrap this function into a selector via schedule_selector marco.
this->schedule(CC_SCHEDULE_SELECTOR(MyNode::TickMe), 0, 0, 0);
Parameters
selectorThe SEL_SCHEDULE selector to be scheduled.
intervalTick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.
repeatThe selector will be excuted (repeat + 1) times, you can use CC_REPEAT_FOREVER for tick infinitely.
delayThe amount of time that the first tick will wait before execution.
var schedule ( var  selector,
var  interval,
var  repeat,
var  delay 
)

Schedules a custom selector.

If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

// firstly, implement a schedule function
void MyNode::TickMe(float dt);
// wrap this function into a selector via schedule_selector marco.
this->schedule(CC_SCHEDULE_SELECTOR(MyNode::TickMe), 0, 0, 0);
Parameters
selectorThe SEL_SCHEDULE selector to be scheduled.
intervalTick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.
repeatThe selector will be excuted (repeat + 1) times, you can use CC_REPEAT_FOREVER for tick infinitely.
delayThe amount of time that the first tick will wait before execution.
void schedule ( SEL_SCHEDULE  selector,
float  interval 
)

Schedules a custom selector with an interval time in seconds.

See also
schedule(SEL_SCHEDULE, float, unsigned int, float)
Parameters
selectorThe SEL_SCHEDULE selector to be scheduled.
intervalCallback interval time in seconds. 0 means tick every frame,
var schedule ( var  selector,
var  interval 
)

Schedules a custom selector with an interval time in seconds.

See also
schedule(SEL_SCHEDULE, float, unsigned int, float)
Parameters
selectorThe SEL_SCHEDULE selector to be scheduled.
intervalCallback interval time in seconds. 0 means tick every frame,
void schedule ( SEL_SCHEDULE  selector)

Schedules a custom selector, the scheduled selector will be ticked every frame.

See also
schedule(SEL_SCHEDULE, float, unsigned int, float)
Parameters
selectorA function wrapped as a selector
var schedule ( var  selector)

Schedules a custom selector, the scheduled selector will be ticked every frame.

See also
schedule(SEL_SCHEDULE, float, unsigned int, float)
Parameters
selectorA function wrapped as a selector
void schedule ( const std::function< void(float)> &  callback,
const std::string &  key 
)

Schedules a lambda function.

The scheduled lambda function will be called every frame

Parameters
callbackThe lambda function to be scheduled
keyThe key of the lambda function. To be used if you want to unschedule it
var schedule ( var  callback,
var  key 
)

Schedules a lambda function.

The scheduled lambda function will be called every frame

Parameters
callbackThe lambda function to be scheduled
keyThe key of the lambda function. To be used if you want to unschedule it
void schedule ( const std::function< void(float)> &  callback,
float  interval,
const std::string &  key 
)

Schedules a lambda function.

The scheduled lambda function will be called every "interval" seconds

Parameters
callbackThe lambda function to be scheduled
intervalCallback interval time in seconds. 0 means every frame,
keyThe key of the lambda function. To be used if you want to unschedule it
var schedule ( var  callback,
var  interval,
var  key 
)

Schedules a lambda function.

The scheduled lambda function will be called every "interval" seconds

Parameters
callbackThe lambda function to be scheduled
intervalCallback interval time in seconds. 0 means every frame,
keyThe key of the lambda function. To be used if you want to unschedule it
void schedule ( const std::function< void(float)> &  callback,
float  interval,
unsigned int  repeat,
float  delay,
const std::string &  key 
)

Schedules a lambda function.

Parameters
callbackThe lambda function to be schedule
intervalTick interval in seconds. 0 means tick every frame.
repeatThe selector will be executed (repeat + 1) times, you can use CC_REPEAT_FOREVER for tick infinitely.
delayThe amount of time that the first tick will wait before execution.
keyThe key of the lambda function. To be used if you want to unschedule it
var schedule ( var  callback,
var  interval,
var  repeat,
var  delay,
var  key 
)

Schedules a lambda function.

Parameters
callbackThe lambda function to be schedule
intervalTick interval in seconds. 0 means tick every frame.
repeatThe selector will be executed (repeat + 1) times, you can use CC_REPEAT_FOREVER for tick infinitely.
delayThe amount of time that the first tick will wait before execution.
keyThe key of the lambda function. To be used if you want to unschedule it
void scheduleOnce ( SEL_SCHEDULE  selector,
float  delay 
)

Schedules a selector that runs only once, with a delay of 0 or larger.

See also
schedule(SEL_SCHEDULE, float, unsigned int, float)
Parameters
selectorThe SEL_SCHEDULE selector to be scheduled.
delayThe amount of time that the first tick will wait before execution.
var scheduleOnce ( var  selector,
var  delay 
)

Schedules a selector that runs only once, with a delay of 0 or larger.

See also
schedule(SEL_SCHEDULE, float, unsigned int, float)
Parameters
selectorThe SEL_SCHEDULE selector to be scheduled.
delayThe amount of time that the first tick will wait before execution.
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.

Parameters
callbackThe lambda function to be scheduled
delayThe amount of time that the first tick will wait before execution.
keyThe key of the lambda function. To be used if you want to unschedule it
var scheduleOnce ( var  callback,
var  delay,
var  key 
)

Schedules a lambda function that runs only once, with a delay of 0 or larger.

Parameters
callbackThe lambda function to be scheduled
delayThe amount of time that the first tick will wait before execution.
keyThe key of the lambda function. To be used if you want to unschedule it
void scheduleUpdate ( void  )

Schedules the "update" method.

It will use the order number 0. This method will be called every frame. Scheduled methods with a lower order value will be called before the ones that have a higher order value. Only one "update" method could be scheduled per node.

void scheduleUpdateWithPriority ( int  priority)

Schedules the "update" method with a custom priority.

This selector will be called every frame. Scheduled methods with a lower priority will be called before the ones that have a higher value. Only one "update" selector could be scheduled per node (You can't have 2 'update' selectors).

void scheduleUpdateWithPriorityLua ( int  handler,
int  priority 
)

Schedules for lua script.

local scheduleUpdateWithPriorityLua ( local  handler,
local  priority 
)

Schedules for lua script.

virtual void setActionManager ( ActionManager actionManager)
virtual

Sets the ActionManager object that is used by all actions.

Warning
If you set a new ActionManager, then previously created actions will be removed.
Parameters
actionManagerA ActionManager object that is used by all actions.
var setActionManager ( var  actionManager)
virtual

Sets the ActionManager object that is used by all actions.

Warning
If you set a new ActionManager, then previously created actions will be removed.
Parameters
actionManagerA ActionManager object that is used by all actions.
local setActionManager ( local  actionManager)
virtual

Sets the ActionManager object that is used by all actions.

Warning
If you set a new ActionManager, then previously created actions will be removed.
Parameters
actionManagerA ActionManager object that is used by all actions.
void setAdditionalTransform ( Mat4 additionalTransform)

Sets an additional transform matrix to the node.

In order to remove it, call it again with the argument nullptr

Note
The additional transform will be concatenated at the end of getNodeToParentTransform. It could be used to simulate parent-child relationship between two nodes (e.g. one is in BatchNode, another isn't).
var setAdditionalTransform ( var  additionalTransform)

Sets an additional transform matrix to the node.

In order to remove it, call it again with the argument nullptr

Note
The additional transform will be concatenated at the end of getNodeToParentTransform. It could be used to simulate parent-child relationship between two nodes (e.g. one is in BatchNode, another isn't).
local setAdditionalTransform ( local  additionalTransform)

Sets an additional transform matrix to the node.

In order to remove it, call it again with the argument nullptr

Note
The additional transform will be concatenated at the end of getNodeToParentTransform. It could be used to simulate parent-child relationship between two nodes (e.g. one is in BatchNode, another isn't).
void setAdditionalTransform ( const AffineTransform additionalTransform)
var setAdditionalTransform ( var  additionalTransform)
local setAdditionalTransform ( local  additionalTransform)
virtual void setAnchorPoint ( const Vec2 anchorPoint)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Note
If node has a physics body, the anchor must be in the middle, you cann't change this to other value.
Parameters
anchorPointThe anchor point of node.

Reimplemented in Sprite, EditBox, Scale9Sprite, ProgressTimer, and RichText.

var setAnchorPoint ( var  anchorPoint)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Note
If node has a physics body, the anchor must be in the middle, you cann't change this to other value.
Parameters
anchorPointThe anchor point of node.

Reimplemented in Sprite, EditBox, Scale9Sprite, ProgressTimer, and RichText.

local setAnchorPoint ( local  anchorPoint)
virtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Note
If node has a physics body, the anchor must be in the middle, you cann't change this to other value.
Parameters
anchorPointThe anchor point of node.

Reimplemented in Sprite, EditBox, Scale9Sprite, ProgressTimer, and RichText.

void setCameraMask ( unsigned short  mask,
bool  applyChildren = true 
)
var setCameraMask ( var  mask,
var  applyChildren = true 
)
local setCameraMask ( local  mask,
local  applyChildren = true 
)
virtual void setCascadeColorEnabled ( bool  cascadeColorEnabled)
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

var setCascadeColorEnabled ( var  cascadeColorEnabled)
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

local setCascadeColorEnabled ( local  cascadeColorEnabled)
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

virtual void
setCascadeOpacityEnabled
( bool  cascadeOpacityEnabled)
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

var setCascadeOpacityEnabled ( var  cascadeOpacityEnabled)
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

local setCascadeOpacityEnabled ( local  cascadeOpacityEnabled)
virtual

Reimplemented in __NodeRGBA, and __LayerRGBA.

virtual void setColor ( const Color3B color)
virtual
var setColor ( var  color)
virtual
local setColor ( local  color)
virtual
virtual void setContentSize ( const Size contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented in EditBox, Widget, LayerColor, Scale9Sprite, and ScrollView.

var setContentSize ( var  contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented in EditBox, Widget, LayerColor, Scale9Sprite, and ScrollView.

local setContentSize ( local  contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented in EditBox, Widget, LayerColor, Scale9Sprite, and ScrollView.

virtual void setEventDispatcher ( EventDispatcher dispatcher)
virtual
var setEventDispatcher ( var  dispatcher)
virtual
local setEventDispatcher ( local  dispatcher)
virtual
virtual void setGlobalZOrder ( float  globalZOrder)
virtual

Defines the oder in which the nodes are renderer.

Nodes that have a Global Z Order lower, are renderer first.

In case two or more nodes have the same Global Z Order, the oder is not guaranteed. The only exception if the Nodes have a Global Z Order == 0. In that case, the Scene Graph order is used.

By default, all nodes have a Global Z Order = 0. That means that by default, the Scene Graph order is used to render the nodes.

Global Z Order is useful when you need to render nodes in an order different than the Scene Graph order.

Limitations: Global Z Order can't be used used by Nodes that have SpriteBatchNode as one of their acenstors. And if ClippingNode is one of the ancestors, then "global Z order" will be relative to the ClippingNode.

See also
setLocalZOrder()
setVertexZ()
Since
v3.0
var setGlobalZOrder ( var  globalZOrder)
virtual

Defines the oder in which the nodes are renderer.

Nodes that have a Global Z Order lower, are renderer first.

In case two or more nodes have the same Global Z Order, the oder is not guaranteed. The only exception if the Nodes have a Global Z Order == 0. In that case, the Scene Graph order is used.

By default, all nodes have a Global Z Order = 0. That means that by default, the Scene Graph order is used to render the nodes.

Global Z Order is useful when you need to render nodes in an order different than the Scene Graph order.

Limitations: Global Z Order can't be used used by Nodes that have SpriteBatchNode as one of their acenstors. And if ClippingNode is one of the ancestors, then "global Z order" will be relative to the ClippingNode.

See also
setLocalZOrder()
setVertexZ()
Since
v3.0
local setGlobalZOrder ( local  globalZOrder)
virtual

Defines the oder in which the nodes are renderer.

Nodes that have a Global Z Order lower, are renderer first.

In case two or more nodes have the same Global Z Order, the oder is not guaranteed. The only exception if the Nodes have a Global Z Order == 0. In that case, the Scene Graph order is used.

By default, all nodes have a Global Z Order = 0. That means that by default, the Scene Graph order is used to render the nodes.

Global Z Order is useful when you need to render nodes in an order different than the Scene Graph order.

Limitations: Global Z Order can't be used used by Nodes that have SpriteBatchNode as one of their acenstors. And if ClippingNode is one of the ancestors, then "global Z order" will be relative to the ClippingNode.

See also
setLocalZOrder()
setVertexZ()
Since
v3.0
virtual void setGLProgram ( GLProgram glprogram)
virtual

Sets the shader program for this node.

Since v2.0, each rendering node must set its shader program. It should be set in initialize phase.

Parameters
shaderProgramThe shader program

Reimplemented in Sprite3D.

var setGLProgram ( var  glprogram)
virtual

Sets the shader program for this node.

Since v2.0, each rendering node must set its shader program. It should be set in initialize phase.

Parameters
shaderProgramThe shader program

Reimplemented in Sprite3D.

local setGLProgram ( local  glprogram)
virtual

Sets the shader program for this node.

Since v2.0, each rendering node must set its shader program. It should be set in initialize phase.

Parameters
shaderProgramThe shader program

Reimplemented in Sprite3D.

virtual void setGLProgramState ( GLProgramState glProgramState)
virtual

Reimplemented in Sprite3D.

var setGLProgramState ( var  glProgramState)
virtual

Reimplemented in Sprite3D.

local setGLProgramState ( local  glProgramState)
virtual

Reimplemented in Sprite3D.

void setGLServerState ( int  serverState)
inline
Deprecated:
No longer needed
virtual void setLocalZOrder ( int  localZOrder)
virtual

LocalZOrder is the 'key' used to sort the node relative to its siblings.

The Node's parent will sort all its children based ont the LocalZOrder value. If two nodes have the same LocalZOrder, then the node that was added first to the children's array will be in front of the other node in the array.

Also, the Scene Graph is traversed using the "In-Order" tree traversal algorithm ( http://en.wikipedia.org/wiki/Tree_traversal#In-order ) And Nodes that have LocalZOder values < 0 are the "left" subtree While Nodes with LocalZOder >=0 are the "right" subtree.

See also
setGlobalZOrder
setVertexZ

Reimplemented in Bone.

var setLocalZOrder ( var  localZOrder)
virtual

LocalZOrder is the 'key' used to sort the node relative to its siblings.

The Node's parent will sort all its children based ont the LocalZOrder value. If two nodes have the same LocalZOrder, then the node that was added first to the children's array will be in front of the other node in the array.

Also, the Scene Graph is traversed using the "In-Order" tree traversal algorithm ( http://en.wikipedia.org/wiki/Tree_traversal#In-order ) And Nodes that have LocalZOder values < 0 are the "left" subtree While Nodes with LocalZOder >=0 are the "right" subtree.

See also
setGlobalZOrder
setVertexZ

Reimplemented in Bone.

local setLocalZOrder ( local  localZOrder)
virtual

LocalZOrder is the 'key' used to sort the node relative to its siblings.

The Node's parent will sort all its children based ont the LocalZOrder value. If two nodes have the same LocalZOrder, then the node that was added first to the children's array will be in front of the other node in the array.

Also, the Scene Graph is traversed using the "In-Order" tree traversal algorithm ( http://en.wikipedia.org/wiki/Tree_traversal#In-order ) And Nodes that have LocalZOder values < 0 are the "left" subtree While Nodes with LocalZOder >=0 are the "right" subtree.

See also
setGlobalZOrder
setVertexZ

Reimplemented in Bone.

virtual void setName ( const std::string &  name)
virtual

Changes the name that is used to identify the node easily.

Parameters
nameA string that identifies the node.
Since
v3.2
var setName ( var  name)
virtual

Changes the name that is used to identify the node easily.

Parameters
nameA string that identifies the node.
Since
v3.2
local setName ( local  name)
virtual

Changes the name that is used to identify the node easily.

Parameters
nameA string that identifies the node.
Since
v3.2
virtual void
setNodeToParentTransform
( const Mat4 transform)
virtual

Sets the Transformation matrix manually.

var setNodeToParentTransform ( var  transform)
virtual

Sets the Transformation matrix manually.

local setNodeToParentTransform ( local  transform)
virtual

Sets the Transformation matrix manually.

virtual void setNormalizedPosition ( const Vec2 position)
virtual

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

The positions in pixels is calculated like the following:

// pseudo code
Size s = getParent()->getContentSize();
_position = pos * s;
}
var setNormalizedPosition ( var  position)
virtual

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

The positions in pixels is calculated like the following:

// pseudo code
Size s = getParent()->getContentSize();
_position = pos * s;
}
local setNormalizedPosition ( local  position)
virtual

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

The positions in pixels is calculated like the following:

// pseudo code
Size s = getParent()->getContentSize();
_position = pos * s;
}
void setOnEnterCallback ( const std::function< void()> &  callback)
inline
var setOnEnterCallback ( var  callback)
inline
local setOnEnterCallback ( local  callback)
inline
void
setonEnterTransitionDidFinishCallback
( const std::function< void()> &  callback)
inline
var
setonEnterTransitionDidFinishCallback
( var  callback)
inline
local
setonEnterTransitionDidFinishCallback
( local  callback)
inline
void setOnExitCallback ( const std::function< void()> &  callback)
inline
var setOnExitCallback ( var  callback)
inline
local setOnExitCallback ( local  callback)
inline
void
setonExitTransitionDidStartCallback
( const std::function< void()> &  callback)
inline
var
setonExitTransitionDidStartCallback
( var  callback)
inline
local
setonExitTransitionDidStartCallback
( local  callback)
inline
virtual void setOpacity ( GLubyte  opacity)
virtual
var setOpacity ( var  opacity)
virtual
local setOpacity ( local  opacity)
virtual
virtual void setOpacityModifyRGB ( bool  value)
inlinevirtual
var setOpacityModifyRGB ( var  value)
inlinevirtual
local setOpacityModifyRGB ( local  value)
inlinevirtual
void setOrderOfArrival ( int  orderOfArrival)

Sets the arrival order when this node has a same ZOrder with other children.

A node which called addChild subsequently will take a larger arrival order, If two children have the same Z order, the child with larger arrival order will be drawn later.

Warning
This method is used internally for localZOrder sorting, don't change this manually
Parameters
orderOfArrivalThe arrival order.
var setOrderOfArrival ( var  orderOfArrival)

Sets the arrival order when this node has a same ZOrder with other children.

A node which called addChild subsequently will take a larger arrival order, If two children have the same Z order, the child with larger arrival order will be drawn later.

Warning
This method is used internally for localZOrder sorting, don't change this manually
Parameters
orderOfArrivalThe arrival order.
local setOrderOfArrival ( local  orderOfArrival)

Sets the arrival order when this node has a same ZOrder with other children.

A node which called addChild subsequently will take a larger arrival order, If two children have the same Z order, the child with larger arrival order will be drawn later.

Warning
This method is used internally for localZOrder sorting, don't change this manually
Parameters
orderOfArrivalThe arrival order.
virtual void setParent ( Node parent)
virtual

Sets the parent node.

Parameters
parentA pointer to the parent node
var setParent ( var  parent)
virtual

Sets the parent node.

Parameters
parentA pointer to the parent node
local setParent ( local  parent)
virtual

Sets the parent node.

Parameters
parentA pointer to the parent node
void setPhysicsBody ( PhysicsBody body)

set the PhysicsBody that let the sprite effect with physics

Note
This method will set anchor point to Vec2::ANCHOR_MIDDLE if body not null, and you cann't change anchor point if node has a physics body.
var setPhysicsBody ( var  body)

set the PhysicsBody that let the sprite effect with physics

Note
This method will set anchor point to Vec2::ANCHOR_MIDDLE if body not null, and you cann't change anchor point if node has a physics body.
local setPhysicsBody ( local  body)

set the PhysicsBody that let the sprite effect with physics

Note
This method will set anchor point to Vec2::ANCHOR_MIDDLE if body not null, and you cann't change anchor point if node has a physics body.
virtual void setPosition ( const Vec2 position)
virtual

Sets the position (x,y) of the node in its parent's coordinate system.

Usually we use Vec2(x,y) to compose Vec2 object. This code snippet sets the node in the center of screen.

node->setPosition(size.width/2, size.height/2)
Parameters
positionThe position (x,y) of the node in OpenGL coordinates

Reimplemented in Sprite, EditBox, Widget, and MotionStreak.

var setPosition ( var  position)
virtual

Sets the position (x,y) of the node in its parent's coordinate system.

Usually we use Vec2(x,y) to compose Vec2 object. This code snippet sets the node in the center of screen.

node->setPosition(size.width/2, size.height/2)
Parameters
positionThe position (x,y) of the node in OpenGL coordinates

Reimplemented in Sprite, EditBox, Widget, and MotionStreak.

local setPosition ( local  position)
virtual

Sets the position (x,y) of the node in its parent's coordinate system.

Usually we use Vec2(x,y) to compose Vec2 object. This code snippet sets the node in the center of screen.

node->setPosition(size.width/2, size.height/2)
Parameters
positionThe position (x,y) of the node in OpenGL coordinates

Reimplemented in Sprite, EditBox, Widget, and MotionStreak.

virtual void setPosition ( float  x,
float  y 
)
virtual

Sets the position (x,y) of the node in its parent's coordinate system.

Passing two numbers (x,y) is much efficient than passing Vec2 object. This method is bound to Lua and JavaScript. Passing a number is 10 times faster than passing a object from Lua to c++

// sample code in Lua
local pos = node::getPosition() -- returns Vec2 object from C++
node:setPosition(x, y) -- pass x, y coordinate to C++
Parameters
xX coordinate for position
yY coordinate for position

Reimplemented in Sprite, and MotionStreak.

var setPosition ( var  x,
var  y 
)
virtual

Sets the position (x,y) of the node in its parent's coordinate system.

Passing two numbers (x,y) is much efficient than passing Vec2 object. This method is bound to Lua and JavaScript. Passing a number is 10 times faster than passing a object from Lua to c++

// sample code in Lua
local pos = node::getPosition() -- returns Vec2 object from C++
node:setPosition(x, y) -- pass x, y coordinate to C++
Parameters
xX coordinate for position
yY coordinate for position

Reimplemented in Sprite, and MotionStreak.

local setPosition ( local  x,
local  y 
)
virtual

Sets the position (x,y) of the node in its parent's coordinate system.

Passing two numbers (x,y) is much efficient than passing Vec2 object. This method is bound to Lua and JavaScript. Passing a number is 10 times faster than passing a object from Lua to c++

// sample code in Lua
local pos = node::getPosition() -- returns Vec2 object from C++
node:setPosition(x, y) -- pass x, y coordinate to C++
Parameters
xX coordinate for position
yY coordinate for position

Reimplemented in Sprite, and MotionStreak.

virtual void setPosition3D ( const Vec3 position)
virtual

Sets the position (X, Y, and Z) in its parent's coordinate system.

var setPosition3D ( var  position)
virtual

Sets the position (X, Y, and Z) in its parent's coordinate system.

local setPosition3D ( local  position)
virtual

Sets the position (X, Y, and Z) in its parent's coordinate system.

virtual void setPositionX ( float  x)
virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings

Reimplemented in MotionStreak.

var setPositionX ( var  x)
virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings

Reimplemented in MotionStreak.

local setPositionX ( local  x)
virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings

Reimplemented in MotionStreak.

virtual void setPositionY ( float  y)
virtual

Reimplemented in MotionStreak.

var setPositionY ( var  y)
virtual

Reimplemented in MotionStreak.

local setPositionY ( local  y)
virtual

Reimplemented in MotionStreak.

virtual void setPositionZ ( float  positionZ)
virtual

Sets the 'z' coordinate in the position.

It is the OpenGL Z vertex value.

The OpenGL depth buffer and depth testing are disabled by default. You need to turn them on in order to use this property correctly.

setPositionZ() also sets the setGlobalZValue() with the positionZ as value.

See also
setGlobalZValue()
Parameters
vertexZOpenGL Z vertex of this node.

Reimplemented in Sprite.

var setPositionZ ( var  positionZ)
virtual

Sets the 'z' coordinate in the position.

It is the OpenGL Z vertex value.

The OpenGL depth buffer and depth testing are disabled by default. You need to turn them on in order to use this property correctly.

setPositionZ() also sets the setGlobalZValue() with the positionZ as value.

See also
setGlobalZValue()
Parameters
vertexZOpenGL Z vertex of this node.

Reimplemented in Sprite.

local setPositionZ ( local  positionZ)
virtual

Sets the 'z' coordinate in the position.

It is the OpenGL Z vertex value.

The OpenGL depth buffer and depth testing are disabled by default. You need to turn them on in order to use this property correctly.

setPositionZ() also sets the setGlobalZValue() with the positionZ as value.

See also
setGlobalZValue()
Parameters
vertexZOpenGL Z vertex of this node.

Reimplemented in Sprite.

virtual void setRotation ( float  rotation)
virtual

Sets the rotation (angle) of the node in degrees.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationThe rotation of the node in degrees.

Reimplemented in Sprite, and ParticleSystem.

var setRotation ( var  rotation)
virtual

Sets the rotation (angle) of the node in degrees.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationThe rotation of the node in degrees.

Reimplemented in Sprite, and ParticleSystem.

local setRotation ( local  rotation)
virtual

Sets the rotation (angle) of the node in degrees.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationThe rotation of the node in degrees.

Reimplemented in Sprite, and ParticleSystem.

virtual void setRotation3D ( const Vec3 rotation)
virtual

Sets the rotation (X,Y,Z) in degrees.

Useful for 3d rotations

Warning
The physics body doesn't support this.
var setRotation3D ( var  rotation)
virtual

Sets the rotation (X,Y,Z) in degrees.

Useful for 3d rotations

Warning
The physics body doesn't support this.
local setRotation3D ( local  rotation)
virtual

Sets the rotation (X,Y,Z) in degrees.

Useful for 3d rotations

Warning
The physics body doesn't support this.
virtual void setRotationQuat ( const Quaternion quat)
virtual

set rotation by quaternion

var setRotationQuat ( var  quat)
virtual

set rotation by quaternion

local setRotationQuat ( local  quat)
virtual

set rotation by quaternion

virtual void setRotationSkewX ( float  rotationX)
virtual

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

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationXThe X rotation in degrees which performs a horizontal rotational skew.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

var setRotationSkewX ( var  rotationX)
virtual

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

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationXThe X rotation in degrees which performs a horizontal rotational skew.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

local setRotationSkewX ( local  rotationX)
virtual

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

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationXThe X rotation in degrees which performs a horizontal rotational skew.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

virtual void setRotationSkewY ( float  rotationY)
virtual

Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationYThe Y rotation in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

var setRotationSkewY ( var  rotationY)
virtual

Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationYThe Y rotation in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

local setRotationSkewY ( local  rotationY)
virtual

Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

0 is the default rotation angle. Positive values rotate node clockwise, and negative values for anti-clockwise.

Parameters
rotationYThe Y rotation in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

virtual void setRotationX ( float  rotationX)
inlinevirtual
var setRotationX ( var  rotationX)
inlinevirtual
local setRotationX ( local  rotationX)
inlinevirtual
virtual void setRotationY ( float  rotationY)
inlinevirtual
var setRotationY ( var  rotationY)
inlinevirtual
local setRotationY ( local  rotationY)
inlinevirtual
virtual void setScale ( float  scale)
virtual

Sets the scale (x,y,z) of the node.

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters
scaleThe scale factor for both X and Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

var setScale ( var  scale)
virtual

Sets the scale (x,y,z) of the node.

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters
scaleThe scale factor for both X and Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

local setScale ( local  scale)
virtual

Sets the scale (x,y,z) of the node.

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters
scaleThe scale factor for both X and Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

virtual void setScale ( float  scaleX,
float  scaleY 
)
virtual

Sets the scale (x,y) of the node.

It is a scaling factor that multiplies the width and height of the node and its children.

Parameters
scaleXThe scale factor on X axis.
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, and Widget.

var setScale ( var  scaleX,
var  scaleY 
)
virtual

Sets the scale (x,y) of the node.

It is a scaling factor that multiplies the width and height of the node and its children.

Parameters
scaleXThe scale factor on X axis.
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, and Widget.

local setScale ( local  scaleX,
local  scaleY 
)
virtual

Sets the scale (x,y) of the node.

It is a scaling factor that multiplies the width and height of the node and its children.

Parameters
scaleXThe scale factor on X axis.
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, and Widget.

virtual void setScaleX ( float  scaleX)
virtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters
scaleXThe scale factor on X axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

var setScaleX ( var  scaleX)
virtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters
scaleXThe scale factor on X axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

local setScaleX ( local  scaleX)
virtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters
scaleXThe scale factor on X axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

virtual void setScaleY ( float  scaleY)
virtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

var setScaleY ( var  scaleY)
virtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

local setScaleY ( local  scaleY)
virtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.

Reimplemented in Sprite, Scale9Sprite, Widget, Label, and ParticleSystem.

virtual void setScaleZ ( float  scaleZ)
virtual

Changes the scale factor on Z axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.
var setScaleZ ( var  scaleZ)
virtual

Changes the scale factor on Z axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.
local setScaleZ ( local  scaleZ)
virtual

Changes the scale factor on Z axis of this node.

The Default value is 1.0 if you haven't changed it before.

Parameters
scaleYThe scale factor on Y axis.
Warning
The physics body doesn't support this.
virtual void setScheduler ( Scheduler scheduler)
virtual

Sets a Scheduler object that is used to schedule all "updates" and timers.

Warning
If you set a new Scheduler, then previously created timers/update are going to be removed.
Parameters
schedulerA Shdeduler object that is used to schedule all "update" and timers.
var setScheduler ( var  scheduler)
virtual

Sets a Scheduler object that is used to schedule all "updates" and timers.

Warning
If you set a new Scheduler, then previously created timers/update are going to be removed.
Parameters
schedulerA Shdeduler object that is used to schedule all "update" and timers.
local setScheduler ( local  scheduler)
virtual

Sets a Scheduler object that is used to schedule all "updates" and timers.

Warning
If you set a new Scheduler, then previously created timers/update are going to be removed.
Parameters
schedulerA Shdeduler object that is used to schedule all "update" and timers.
void setShaderProgram ( GLProgram glprogram)
inline
var setShaderProgram ( var  glprogram)
inline
local setShaderProgram ( local  glprogram)
inline
virtual void setSkewX ( float  skewX)
virtual

Changes the X skew angle of the node in degrees.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y coordinate and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

Parameters
skewXThe X skew angle of the node in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

var setSkewX ( var  skewX)
virtual

Changes the X skew angle of the node in degrees.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y coordinate and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

Parameters
skewXThe X skew angle of the node in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

local setSkewX ( local  skewX)
virtual

Changes the X skew angle of the node in degrees.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

This angle describes the shear distortion in the X direction. Thus, it is the angle between the Y coordinate and the left edge of the shape The default skewX angle is 0. Positive values distort the node in a CW direction.

Parameters
skewXThe X skew angle of the node in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

virtual void setSkewY ( float  skewY)
virtual

Changes the Y skew angle of the node in degrees.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X coordinate and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

Parameters
skewYThe Y skew angle of the node in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

var setSkewY ( var  skewY)
virtual

Changes the Y skew angle of the node in degrees.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X coordinate and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

Parameters
skewYThe Y skew angle of the node in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

local setSkewY ( local  skewY)
virtual

Changes the Y skew angle of the node in degrees.

The difference between setRotationalSkew() and setSkew() is that the first one simulate Flash's skew functionality while the second one uses the real skew function.

This angle describes the shear distortion in the Y direction. Thus, it is the angle between the X coordinate and the bottom edge of the shape The default skewY angle is 0. Positive values distort the node in a CCW direction.

Parameters
skewYThe Y skew angle of the node in degrees.
Warning
The physics body doesn't support this.

Reimplemented in Sprite.

virtual void setTag ( int  tag)
virtual

Changes the tag that is used to identify the node easily.

Please refer to getTag for the sample code.

Parameters
tagA integer that identifies the node.

Please use setName() instead.

var setTag ( var  tag)
virtual

Changes the tag that is used to identify the node easily.

Please refer to getTag for the sample code.

Parameters
tagA integer that identifies the node.

Please use setName() instead.

local setTag ( local  tag)
virtual

Changes the tag that is used to identify