ProtectedNode Class Reference

A inner node type mainly used for UI module. More...

Inherits Node.

Inherited by PageViewIndicator, ScrollViewBar, and Widget.

Public Member Functions
virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
	Visits this node's children and draw them recursively. More...
local	visit ( local renderer, local parentTransform, local parentFlags)
	Visits this node's children and draw them recursively. More...
virtual void	cleanup () override
	Stops all running actions and schedulers.
virtual void	onEnter () override
	Event callback that is invoked every time when Node enters the 'stage'. More...
var	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'. More...
local	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'. More...
virtual void	onEnterTransitionDidFinish () override
	Event callback that is invoked when the Node enters in the 'stage'. More...
virtual void	onExit () override
	Event callback that is invoked every time the Node leaves the 'stage'. More...
virtual void	onExitTransitionDidStart () override
	Event callback that is called every time the Node leaves the 'stage'. More...
virtual void	updateDisplayedOpacity (GLubyte parentOpacity) override
	Update the displayed opacity of node with it's parent opacity;. More...
var	updateDisplayedOpacity ( var parentOpacity)
	Update the displayed opacity of node with it's parent opacity;. More...
local	updateDisplayedOpacity ( local parentOpacity)
	Update the displayed opacity of node with it's parent opacity;. More...
virtual void	updateDisplayedColor (const Color3B &parentColor) override
	Update node's displayed color with its parent color. More...
local	updateDisplayedColor ( local parentColor)
	Update node's displayed color with its parent color. More...
virtual void	setCameraMask (unsigned short mask, bool applyChildren=true) override
	Modify the camera mask for current node. More...
virtual void	setGlobalZOrder (float globalZOrder) override
	Defines the order in which the nodes are renderer. More...
local	setGlobalZOrder ( local globalZOrder)
	Defines the order in which the nodes are renderer. More...
Children and Parent
virtual void	addProtectedChild (Node *child)
	Adds a child to the container with z-order as 0. More...
local	addProtectedChild ( local child)
	Adds a child to the container with z-order as 0. More...
virtual void	addProtectedChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order. More...
local	addProtectedChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...
virtual void	addProtectedChild (Node *child, int localZOrder, int tag)
	Adds a child to the container with z order and tag. More...
var	addProtectedChild ( var child, var localZOrder, var tag)
	Adds a child to the container with z order and tag. More...
local	addProtectedChild ( local child, local localZOrder, local tag)
	Adds a child to the container with z order and tag. More...
virtual Node *	getProtectedChildByTag (int tag)
	Gets a child from the container with its tag. More...
var	getProtectedChildByTag ( var tag)
	Gets a child from the container with its tag. More...
local	getProtectedChildByTag ( local tag)
	Gets a child from the container with its tag. More...
virtual void	removeProtectedChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...
local	removeProtectedChild ( local child, local true)
	Removes a child from the container. More...
virtual void	removeProtectedChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...
var	removeProtectedChildByTag ( var tag, var true)
	Removes a child from the container by tag value. More...
local	removeProtectedChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...
virtual void	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...
local	removeAllProtectedChildren ()
	Removes all children from the container with a cleanup. More...
virtual void	removeAllProtectedChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
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	reorderProtectedChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...
var	reorderProtectedChild ( var child, var localZOrder)
	Reorders a child according to a new z value. More...
local	reorderProtectedChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...
virtual void	sortAllProtectedChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
Public Member Functions inherited from Node
virtual bool	isRunning () const
	Returns whether or not the node is "running". More...
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	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
	Override this method to draw your own node. More...
virtual Scene *	getScene () const
	Returns the Scene that contains the Node. More...
local	getScene ()
	Returns the Scene that contains the Node. More...
virtual Rect	getBoundingBox () const
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...
virtual Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
	Set event dispatcher for scene. More...
var	setEventDispatcher ( var dispatcher)
	Set event dispatcher for scene. More...
local	setEventDispatcher ( local dispatcher)
	Set event dispatcher for scene. More...
virtual EventDispatcher *	getEventDispatcher () const
	Get the event dispatcher of scene. More...
local	getEventDispatcher ()
	Get the event dispatcher of scene. More...
virtual GLubyte	getOpacity () const
	Return the node's opacity. More...
local	getOpacity ()
	Return the node's opacity. More...
virtual GLubyte	getDisplayedOpacity () const
	Return the node's display opacity. More...
local	getDisplayedOpacity ()
	Return the node's display opacity. More...
virtual void	setOpacity (GLubyte opacity)
	Change node opacity. More...
virtual bool	isCascadeOpacityEnabled () const
	Whether cascadeOpacity is enabled or not. More...
var	isCascadeOpacityEnabled ()
	Whether cascadeOpacity is enabled or not. More...
local	isCascadeOpacityEnabled ()
	Whether cascadeOpacity is enabled or not. More...
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
	Change node's cascadeOpacity property. More...
local	setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
	Change node's cascadeOpacity property. More...
virtual const Color3B &	getColor () const
	Query node's color value. More...
local	getColor ()
	Query node's color value. More...
virtual const Color3B &	getDisplayedColor () const
	Query node's displayed color. More...
local	getDisplayedColor ()
	Query node's displayed color. More...
virtual void	setColor (const Color3B &color)
	Change the color of node. More...
var	setColor ( var color)
	Change the color of node. More...
local	setColor ( local color)
	Change the color of node. More...
virtual bool	isCascadeColorEnabled () const
	Query whether cascadeColor is enabled or not. More...
var	isCascadeColorEnabled ()
	Query whether cascadeColor is enabled or not. More...
local	isCascadeColorEnabled ()
	Query whether cascadeColor is enabled or not. More...
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
	If you want node's color affect the children node's color, then set it to true. More...
virtual void	setOpacityModifyRGB (bool value)
	If you want the opacity affect the color property, then set to true. More...
local	setOpacityModifyRGB ( local value)
	If you want the opacity affect the color property, then set to true. More...
virtual bool	isOpacityModifyRGB () const
	If node opacity will modify the RGB color value, then you should override this method and return true. More...
void	setOnEnterCallback (const std::function< void()> &callback)
	Set the callback of event onEnter. More...
const std::function< void()> &	getOnEnterCallback () const
	Get the callback of event onEnter. More...
void	setOnExitCallback (const std::function< void()> &callback)
	Set the callback of event onExit. More...
var	setOnExitCallback ( var callback)
	Set the callback of event onExit. More...
local	setOnExitCallback ( local callback)
	Set the callback of event onExit. More...
const std::function< void()> &	getOnExitCallback () const
	Get the callback of event onExit. More...
local	getOnExitCallback ()
	Get the callback of event onExit. More...
void	setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
	Set the callback of event EnterTransitionDidFinish. More...
var	setonEnterTransitionDidFinishCallback ( var callback)
	Set the callback of event EnterTransitionDidFinish. More...
local	setonEnterTransitionDidFinishCallback ( local callback)
	Set the callback of event EnterTransitionDidFinish. More...
const std::function< void()> &	getonEnterTransitionDidFinishCallback () const
	Get the callback of event EnterTransitionDidFinish. More...
void	setonExitTransitionDidStartCallback (const std::function< void()> &callback)
	Set the callback of event ExitTransitionDidStart. More...
var	setonExitTransitionDidStartCallback ( var callback)
	Set the callback of event ExitTransitionDidStart. More...
local	setonExitTransitionDidStartCallback ( local callback)
	Set the callback of event ExitTransitionDidStart. More...
const std::function< void()> &	getonExitTransitionDidStartCallback () const
	Get the callback of event ExitTransitionDidStart. More...
unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
virtual void	setLocalZOrder (std::int32_t localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
virtual void	setZOrder (std::int32_t localZOrder)
virtual void	_setLocalZOrder (std::int32_t z)
local	_setLocalZOrder ( local z)
void	updateOrderOfArrival ()
	!!! ONLY FOR INTERNAL USE Sets the arrival order when this node has a same ZOrder with other children. More...
virtual std::int32_t	getLocalZOrder () const
	Gets the local Z order of this node. More...
virtual std::int32_t	getZOrder () const
var	getZOrder ()
local	getZOrder ()
virtual float	getGlobalZOrder () const
	Returns the Node's Global Z Order. More...
var	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...
local	getGlobalZOrder ()
	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...
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...
local	setScaleY ( local scaleY)
	Sets the scale (y) of the node. More...
virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node. More...
virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...
local	setScaleZ ( local scaleZ)
	Changes the scale factor on Z axis of this node. More...
virtual float	getScaleZ () const
	Returns the scale factor on Z axis of this node. More...
virtual void	setScale (float scale)
	Sets the scale (x,y,z) of the node. More...
var	setScale ( var scale)
	Sets the scale (x,y,z) of the node. More...
local	setScale ( local scale)
	Sets the scale (x,y,z) of the node. More...
virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor. More...
virtual void	setScale (float scaleX, float scaleY)
	Sets the scale (x,y) of the node. More...
local	setScale ( local scaleX, local scaleY)
	Sets the scale (x,y) of the node. More...
virtual void	setPosition (const Vec2 &position)
	Sets the position (x,y) of the node in its parent's coordinate system. More...
virtual void	setPositionNormalized (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...
virtual void	setNormalizedPosition (const Vec2 &position)
local	setNormalizedPosition ( local position)
virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...
local	getPosition ()
	Gets the position (x,y) of the node in its parent's coordinate system. More...
virtual const Vec2 &	getPositionNormalized () const
	Returns the normalized position. More...
virtual const Vec2 &	getNormalizedPosition () const
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
	Gets the x coordinate of the node in its parent's coordinate system. More...
virtual void	setPositionY (float y)
	Sets the y coordinate of the node in its parent's coordinate system. More...
local	setPositionY ( local y)
	Sets the y coordinate of the node in its parent's coordinate system. More...
virtual float	getPositionY (void) const
	Gets the y coordinate of the node in its parent's coordinate system. More...
var	getPositionY ()
	Gets the y coordinate of the node in its parent's coordinate system. More...
local	getPositionY ()
	Gets the y coordinate of the node in its parent's coordinate system. More...
virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...
local	setPosition3D ( local position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...
virtual Vec3	getPosition3D () const
	Returns the position (X,Y,Z) in its parent's coordinate system. More...
local	getPosition3D ()
	Returns the position (X,Y,Z) in its parent's coordinate system. More...
virtual void	setPositionZ (float positionZ)
	Sets the 'z' coordinate in the position. More...
var	setVertexZ ( var positionZ)
	Sets the 'z' coordinate in the position. More...
local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. More...
virtual void	setVertexZ (float vertexZ)
var	setVertexZ ( var vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...
virtual float	getVertexZ () const
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...
local	getSkewX ()
	Returns the X skew angle of the node in degrees. More...
virtual void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees. More...
local	setSkewY ( local skewY)
	Changes the Y skew angle of the node in degrees. More...
virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...
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 Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...
virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...
virtual void	setContentSize (const Size &contentSize)
	Sets the untransformed size of the node. More...
local	setContentSize ( local contentSize)
	Sets the untransformed size of the node. More...
virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...
virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...
local	setVisible ( local visible)
	Sets whether the node is visible. More...
virtual bool	isVisible () const
	Determines if the node is visible. More...
virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...
local	setRotation ( local rotation)
	Sets the rotation (angle) of the node in degrees. More...
virtual float	getRotation () const
	Returns the rotation of the node in degrees. More...
virtual void	setRotation3D (const Vec3 &rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
local	setRotation3D ( local rotation)
	Sets the rotation (X,Y,Z) in degrees. More...
virtual Vec3	getRotation3D () const
	Returns the rotation (X,Y,Z) in degrees. More...
virtual void	setRotationQuat (const Quaternion &quat)
	Set rotation by quaternion. More...
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...
virtual void	setRotationX (float rotationX)
local	setRotationX ( local rotationX)
virtual float	getRotationSkewX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
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
void	setGLServerState (int)
var	setGLServerState ( var int)
int	getGLServerState () const
virtual void	setIgnoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...
local	setIgnoreAnchorPointForPosition ( local ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...
virtual void	ignoreAnchorPointForPosition (bool ignore)
local	ignoreAnchorPointForPosition ( local ignore)
virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. More...
virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...
virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily. More...
local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...
virtual const std::string &	getName () const
	Returns a string that is used to identify the node. More...
local	getName ()
	Returns a string that is used to identify the node. More...
virtual void	setName (const std::string &name)
	Changes the name that is used to identify the node easily. More...
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 Ref *	getUserObject ()
	Returns a user assigned Object. More...
var	getUserObject ()
	Returns a user assigned Object. More...
virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...
local	setUserObject ( local userObject)
	Returns a user assigned Object. More...
GLProgram *	getGLProgram () 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...
GLProgram *	getShaderProgram () const
var	getShaderProgram ()
local	getShaderProgram ()
virtual void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...
local	setGLProgram ( local glprogram)
	Sets the shader program for this node. More...
void	setShaderProgram (GLProgram *glprogram)
var	setShaderProgram ( var glprogram)
local	setShaderProgram ( local glprogram)
GLProgramState *	getGLProgramState () const
	Return the GLProgramState currently used for this node. More...
var	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...
local	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...
virtual void	setGLProgramState (GLProgramState *glProgramState)
	Set the GLProgramState for this node. More...
virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions. More...
var	setActionManager ( var actionManager)
	Sets the ActionManager object that is used by all actions. More...
local	setActionManager ( local actionManager)
	Sets the ActionManager object that is used by all actions. More...
virtual ActionManager *	getActionManager ()
	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 ActionManager *	getActionManager () const
virtual Action *	runAction (Action *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 .
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...
void	stopAllActionsByTag (int tag)
	Removes all actions from the running action list by its tag. More...
var	stopAllActionsByTag ( var tag)
	Removes all actions from the running action list by its tag. More...
local	stopAllActionsByTag ( local tag)
	Removes all actions from the running action list by its tag. More...
void	stopActionsByFlags (unsigned int flags)
	Removes all actions from the running action list by its flags. More...
Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...
ssize_t	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
ssize_t	getNumberOfRunningActionsByTag (int tag) const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
local	getNumberOfRunningActionsByTag ( local tag)
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
ssize_t	numberOfRunningActions () const
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...
virtual Scheduler *	getScheduler ()
	Gets a Scheduler object. More...
local	getScheduler ()
	Gets a Scheduler object. More...
virtual const Scheduler *	getScheduler () const
local	getScheduler ()
bool	isScheduled (SEL_SCHEDULE selector) const
	Checks whether a selector is scheduled. More...
bool	isScheduled (const std::string &key) const
	Checks whether a lambda function is scheduled. More...
void	scheduleUpdate (void)
	Schedules the "update" method. More...
var	scheduleUpdate ()
	Schedules the "update" method. More...
void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...
var	scheduleUpdateWithPriority ( var priority)
	Schedules the "update" method with a custom priority. More...
void	unscheduleUpdate (void)
var	unscheduleUpdate ()
local	unscheduleUpdate ()
void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...
void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...
void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...
void	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...
var	schedule ( var callback, var key)
	Schedules a lambda function. More...
void	schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
	Schedules a lambda function. More...
void	schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
	Schedules a lambda function. More...
void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...
void	unschedule (const std::string &key)
	Unschedules a lambda function. More...
void	unscheduleAllCallbacks ()
	Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More...
void	unscheduleAllSelectors ()
var	unscheduleAllSelectors ()
local	unscheduleAllSelectors ()
virtual void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...
var	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...
local	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...
virtual void	pause (void)
	Pauses all scheduled selectors, actions and event listeners. More...
local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...
void	resumeSchedulerAndActions ()
	Resumes all scheduled selectors, actions and event listeners. More...
void	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
var	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
local	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...
virtual void	update (float delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
var	update ( var delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
local	update ( local delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...
virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...
virtual const Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual Mat4	getNodeToParentTransform (Node *ancestor) const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
var	getNodeToParentTransform ( var ancestor)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
local	getNodeToParentTransform ( local ancestor)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual AffineTransform	getNodeToParentAffineTransform (Node *ancestor) const
	Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
local	getNodeToParentAffineTransform ( local ancestor)
	Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually. More...
var	setNodeToParentTransform ( var transform)
	Sets the transformation matrix manually. More...
local	setNodeToParentTransform ( local transform)
	Sets the transformation matrix manually. More...
virtual AffineTransform	nodeToParentTransform () const
virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
var	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
local	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
virtual AffineTransform	getParentToNodeAffineTransform () const
local	getParentToNodeAffineTransform ()
virtual AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...
var	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...
local	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...
virtual AffineTransform	getNodeToWorldAffineTransform () const
local	getNodeToWorldAffineTransform ()
virtual AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...
var	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...
local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...
virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...
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...
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...
var	convertToWorldSpaceAR ( var nodePoint)
	Converts a local Vec2 to world space coordinates.The result is in Points. More...
local	convertToWorldSpaceAR ( local nodePoint)
	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...
local	convertTouchToNodeSpace ( local touch)
	convenience methods which take a Touch instead of Vec2. More...
Vec2	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate. More...
void	setAdditionalTransform (const Mat4 *additionalTransform)
	Sets an additional transform matrix to the node. More...
void	setAdditionalTransform (const Mat4 &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
void	setAdditionalTransform (const AffineTransform &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
Component *	getComponent (const std::string &name)
	Gets a component by its name. More...
local	getComponent ( local name)
	Gets a component by its name. More...
virtual bool	addComponent (Component *component)
	Adds a component. More...
local	addComponent ( local component)
	Adds a component. More...
virtual bool	removeComponent (const std::string &name)
	Removes a component by its name. More...
local	removeComponent ( local name)
	Removes a component by its name. More...
virtual 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.
virtual std::string	getDescription () const
	Gets the description string. More...
virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...
virtual void	addChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order. More...
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 Node *	getChildByTag (int tag) const
	Gets a child from the container with its tag. More...
local	getChildByTag ( local tag)
	Gets a child from the container with its tag. More...
template<typename T >
T	getChildByTag (int tag) const
	Gets a child from the container with its tag that can be cast to Type T. More...
virtual Node *	getChildByName (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 >
T	getChildByName (const std::string &name) const
	Gets a child from the container with its name that can be cast to Type T. More...
template<typename T >
var	getChildByName ( var name)
	Gets a child from the container with its name that can be cast to Type T. More...
template<typename T >
local	getChildByName ( local name)
	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
var	getChildren ()
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns the amount of children. More...
virtual void	setParent (Node *parent)
	Sets the parent node. More...
local	setParent ( local parent)
	Sets the parent node. More...
virtual Node *	getParent ()
	Returns a pointer to the parent node. More...
virtual const Node *	getParent () 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...
local	removeChild ( local child, local 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...
var	removeChildByTag ( var tag, var true)
	Removes a child from the container by tag value. More...
local	removeChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...
virtual void	removeChildByName (const std::string &name, bool cleanup=true)
	Removes a child from the container by tag value. More...
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...
var	reorderChild ( var child, var localZOrder)
	Reorders a child according to a new z value. More...
local	reorderChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...
virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
local	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
local	getReferenceCount ()
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...

Static Public Member Functions
static ProtectedNode *	create (void)
	Creates a ProtectedNode with no argument. More...
Static Public Member Functions inherited from Node
static Node *	create ()
	Allocates and initializes a node. More...
var	create ()
	Allocates and initializes a node. More...
local	create ()
	Allocates and initializes a node. More...
static int	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
var	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
local	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
template<typename _T >
static void	sortNodes (cocos2d::Vector< _T * > &nodes)
	Sorts helper function. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
local	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
local	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
local	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
local	_rooted
	When true, it means that the object was already rooted.
Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes.
var	INVALID_TAG = -1
	Default tag used for all the nodes.
local	INVALID_TAG = -1
	Default tag used for all the nodes.

Detailed Description

A inner node type mainly used for UI module.

It is useful for composing complex node type and it's children are protected.

Member Function Documentation

static ProtectedNode* create ( void  )

static

Creates a ProtectedNode with no argument.

Returns

A instance of ProtectedNode.

var create (   )

static

Creates a ProtectedNode with no argument.

Returns

A instance of ProtectedNode.

local create (   )

static

Creates a ProtectedNode with no argument.

Returns

A instance of ProtectedNode.

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

child

A child node

var addProtectedChild ( 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

child

A child node

local addProtectedChild ( 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

child

A child node

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

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)

var addProtectedChild ( 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

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)

local addProtectedChild ( 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

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)

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

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)
tag	An integer to identify the node easily. Please refer to setTag(int)

var addProtectedChild ( 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

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)
tag	An integer to identify the node easily. Please refer to setTag(int)

local addProtectedChild ( 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

child	A child node
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)
tag	An integer to identify the node easily. Please refer to setTag(int)

virtual Node* getProtectedChildByTag ( int  tag )

virtual

Gets a child from the container with its tag.

Parameters

tag	An identifier to find the child node.

Returns

a Node object whose tag equals to the input parameter.

var getProtectedChildByTag ( var  tag )

virtual

Gets a child from the container with its tag.

Parameters

tag	An identifier to find the child node.

Returns

a Node object whose tag equals to the input parameter.

local getProtectedChildByTag ( local  tag )

virtual

Gets a child from the container with its tag.

Parameters

tag	An identifier to find the child node.

Returns

a Node object whose tag equals to the input parameter.

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

child	The child node which will be removed.
cleanup	true if all running actions and callbacks on the child node will be cleanup, false otherwise.

var removeProtectedChild ( 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

child	The child node which will be removed.
cleanup	true if all running actions and callbacks on the child node will be cleanup, false otherwise.

local removeProtectedChild ( 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

child	The child node which will be removed.
cleanup	true if all running actions and callbacks on the child node will be cleanup, false otherwise.

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

tag	An integer number that identifies a child node.
cleanup	true if all running actions and callbacks on the child node will be cleanup, false otherwise.

var removeProtectedChildByTag ( 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

tag	An integer number that identifies a child node.
cleanup	true if all running actions and callbacks on the child node will be cleanup, false otherwise.

local removeProtectedChildByTag ( 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

tag	An integer number that identifies a child node.
cleanup	true if all running actions and callbacks on the child node will be cleanup, false otherwise.

virtual void removeAllProtectedChildren ( )

virtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool).

var removeAllProtectedChildren ( )

virtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool).

local removeAllProtectedChildren ( )

virtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool).

virtual void removeAllProtectedChildrenWithCleanup ( bool  cleanup )

virtual

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

Parameters

cleanup

true if all running actions on all children nodes should be cleanup, false otherwise.

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

cleanup

true if all running actions on all children nodes should be cleanup, false otherwise.

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

cleanup

true if all running actions on all children nodes should be cleanup, false otherwise.

virtual void reorderProtectedChild ( Node *  child, int  localZOrder  )

virtual

Reorders a child according to a new z value.

Parameters

child	An already added child node. It MUST be already added.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)

var reorderProtectedChild ( var  child, var  localZOrder  )

virtual

Reorders a child according to a new z value.

Parameters

child	An already added child node. It MUST be already added.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)

local reorderProtectedChild ( local  child, local  localZOrder  )

virtual

Reorders a child according to a new z value.

Parameters

child	An already added child node. It MUST be already added.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int)

virtual void sortAllProtectedChildren ( )

virtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This approach can improves the performance massively.

Note

Don't call this manually unless a child added needs to be removed in the same frame

var sortAllProtectedChildren ( )

virtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This approach can improves the performance massively.

Note

Don't call this manually unless a child added needs to be removed in the same frame

local sortAllProtectedChildren ( )

virtual

Sorts the children array once before drawing, instead of every time when a child is added or reordered.

This approach can improves the performance massively.

Note

Don't call this manually unless a child added needs to be removed in the same frame

virtual void visit ( Renderer *  renderer, const Mat4 &  parentTransform, uint32_t  parentFlags  )

overridevirtual

Visits this node's children and draw them recursively.

Parameters

renderer	A given renderer.
parentTransform	A transform matrix.
parentFlags	Renderer flag.

Reimplemented from Node.

Reimplemented in Layout, and Widget.

local visit ( local  renderer, local  parentTransform, local  parentFlags  )

overridevirtual

Visits this node's children and draw them recursively.

Parameters

renderer	A given renderer.
parentTransform	A transform matrix.
parentFlags	Renderer flag.

Reimplemented from Node.

Reimplemented in Layout, and Widget.

virtual void onEnter ( )

overridevirtual

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

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

Reimplemented from Node.

Reimplemented in Widget, TextField, ScrollView, EditBox, Layout, WebView, VideoPlayer, and ScrollViewBar.

var onEnter ( )

overridevirtual

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

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

Reimplemented from Node.

Reimplemented in Widget, TextField, ScrollView, EditBox, Layout, WebView, VideoPlayer, and ScrollViewBar.

local onEnter ( )

overridevirtual

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

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

Reimplemented from Node.

Reimplemented in Widget, TextField, ScrollView, EditBox, Layout, WebView, VideoPlayer, and ScrollViewBar.

virtual void onEnterTransitionDidFinish ( )

overridevirtual

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

virtual void onExit ( )

overridevirtual

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

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

Reimplemented from Node.

Reimplemented in Widget, ScrollView, EditBox, Layout, WebView, and VideoPlayer.

virtual void onExitTransitionDidStart ( )

overridevirtual

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

virtual void updateDisplayedOpacity ( GLubyte  parentOpacity )

overridevirtual

Update the displayed opacity of node with it's parent opacity;.

Parameters

parentOpacity

The opacity of parent node.

Reimplemented from Node.

var updateDisplayedOpacity ( var  parentOpacity )

overridevirtual

Update the displayed opacity of node with it's parent opacity;.

Parameters

parentOpacity

The opacity of parent node.

Reimplemented from Node.

local updateDisplayedOpacity ( local  parentOpacity )

overridevirtual

Update the displayed opacity of node with it's parent opacity;.

Parameters

parentOpacity

The opacity of parent node.

Reimplemented from Node.

virtual void updateDisplayedColor ( const Color3B &  parentColor )

overridevirtual

Update node's displayed color with its parent color.

Parameters

parentColor

A Color3B color value.

Reimplemented from Node.

var updateDisplayedColor ( var  parentColor )

overridevirtual

Update node's displayed color with its parent color.

Parameters

parentColor

A Color3B color value.

Reimplemented from Node.

local updateDisplayedColor ( local  parentColor )

overridevirtual

Update node's displayed color with its parent color.

Parameters

parentColor

A Color3B color value.

Reimplemented from Node.

virtual void setCameraMask ( unsigned short  mask, bool  applyChildren = true  )

overridevirtual

Modify the camera mask for current node.

If applyChildren is true, then it will modify the camera mask of its children recursively.

Parameters

mask	A unsigned short bit for mask.
applyChildren	A boolean value to determine whether the mask bit should apply to its children or not.

Reimplemented from Node.

Reimplemented in Layout.

var setCameraMask ( var  mask, var  applyChildren = true  )

overridevirtual

Modify the camera mask for current node.

If applyChildren is true, then it will modify the camera mask of its children recursively.

Parameters

mask	A unsigned short bit for mask.
applyChildren	A boolean value to determine whether the mask bit should apply to its children or not.

Reimplemented from Node.

Reimplemented in Layout.

local setCameraMask ( local  mask, local  applyChildren = true  )

overridevirtual

Modify the camera mask for current node.

If applyChildren is true, then it will modify the camera mask of its children recursively.

Parameters

mask	A unsigned short bit for mask.
applyChildren	A boolean value to determine whether the mask bit should apply to its children or not.

Reimplemented from Node.

Reimplemented in Layout.

virtual void setGlobalZOrder ( float  globalZOrder )

overridevirtual

Defines the order 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 order 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 by Nodes that have SpriteBatchNode as one of their ancestors. 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

Parameters

globalZOrder

The global Z order value.

Reimplemented from Node.

Reimplemented in Layout.

var setGlobalZOrder ( var  globalZOrder )

overridevirtual

Defines the order 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 order 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 by Nodes that have SpriteBatchNode as one of their ancestors. 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

Parameters

globalZOrder

The global Z order value.

Reimplemented from Node.

Reimplemented in Layout.

local setGlobalZOrder ( local  globalZOrder )

overridevirtual

Defines the order 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 order 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 by Nodes that have SpriteBatchNode as one of their ancestors. 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

Parameters

globalZOrder

The global Z order value.

Reimplemented from Node.

Reimplemented in Layout.

---

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

• CCProtectedNode.h