Node Class Reference

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

#include <Node.h>

Inherits Object.

Inherited by AtlasNode, AttachNode, BaseLight, Camera, ClippingNode, ClippingRectangleNode, DrawNode, FastTMXLayer, FastTMXTiledMap, Label, , LayerMultiplex, LayerRadialGradient, Menu, MenuItem, MeshRenderer, MotionStreak, MotionStreak3D, NodeGrid, ParallaxNode, ParticleBatchNode, ParticleSystem, ProgressTimer, ProtectedNode, RenderTexture, Scene, Skybox, Sprite, and SpriteBatchNode.

Public Member Functions
virtual bool	isRunning () const
	Returns whether or not the node is "running".
void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script.
virtual void	cleanup ()
	Stops all running actions and schedulers.
virtual void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
	Override this method to draw your own node.
virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
	Visits this node's children and draw them recursively.
virtual Scene *	getScene () const
	Returns the Scene that contains the Node.
virtual Rect	getBoundingBox () const
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
	Set event dispatcher for scene.
virtual EventDispatcher *	getEventDispatcher () const
	Get the event dispatcher of scene.
virtual uint8_t	getOpacity () const
	Return the node's opacity.
virtual uint8_t	getDisplayedOpacity () const
	Return the node's display opacity.
virtual void	setOpacity (uint8_t opacity)
	Change node opacity.
virtual void	updateDisplayedOpacity (uint8_t parentOpacity)
	Update the displayed opacity of node with it's parent opacity;.
virtual bool	isCascadeOpacityEnabled () const
	Whether cascadeOpacity is enabled or not.
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
	Change node's cascadeOpacity property.
virtual const Color3B &	getColor () const
	Query node's color value.
virtual const Color3B &	getDisplayedColor () const
	Query node's displayed color.
virtual void	setColor (const Color3B &color)
	Change the color of node.
virtual void	updateDisplayedColor (const Color3B &parentColor)
	Update node's displayed color with its parent color.
virtual bool	isCascadeColorEnabled () const
	Query whether cascadeColor is enabled or not.
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
	If you want node's color affect the children node's color, then set it to true.
virtual void	setOpacityModifyRGB (bool value)
	If you want the opacity affect the color property, then set to true.
virtual bool	isOpacityModifyRGB () const
	If node opacity will modify the RGB color value, then you should override this method and return true.
void	setOnEnterCallback (const std::function< void()> &callback)
	Set the callback of event onEnter.
const std::function< void()> &	getOnEnterCallback () const
	Get the callback of event onEnter.
void	setOnExitCallback (const std::function< void()> &callback)
	Set the callback of event onExit.
const std::function< void()> &	getOnExitCallback () const
	Get the callback of event onExit.
void	setOnEnterTransitionDidFinishCallback (const std::function< void()> &callback)
	Set the callback of event EnterTransitionDidFinish.
const std::function< void()> &	getOnEnterTransitionDidFinishCallback () const
	Get the callback of event EnterTransitionDidFinish.
void	setOnExitTransitionDidStartCallback (const std::function< void()> &callback)
	Set the callback of event ExitTransitionDidStart.
const std::function< void()> &	getOnExitTransitionDidStartCallback () const
	Get the callback of event ExitTransitionDidStart.
unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
virtual void	setCameraMask (unsigned short mask, bool applyChildren=true)
	Modify the camera mask for current node.
void	applyMaskOnEnter (bool applyChildren)
	Should addChild() make the child follow it's parent's mask?
virtual bool	setProgramState (backend::ProgramState *programState, bool ownPS=false)
	Sets ProgramState with retain.
backend::ProgramState *	setProgramStateByProgramId (uint64_t progId)
	Sets ProgramState by programId.
Setters & Getters for Graphic Properties
virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings.
void	updateOrderOfArrival ()
	!
virtual int	getLocalZOrder () const
	Gets the local Z order of this node.
virtual void	setGlobalZOrder (float globalZOrder)
	Defines the order in which the nodes are renderer.
virtual float	getGlobalZOrder () const
	Returns the Node's Global Z Order.
virtual void	setScaleX (float scaleX)
	Sets the scale (x) of the node.
virtual float	getScaleX () const
	Returns the scale factor on X axis of this node.
virtual void	setScaleY (float scaleY)
	Sets the scale (y) of the node.
virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node.
virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node.
virtual float	getScaleZ () const
	Returns the scale factor on Z axis of this node.
virtual void	setScale (float scale)
	Sets the scale (x,y,z) of the node.
virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor.
virtual void	setScale (float scaleX, float scaleY)
	Sets the scale (x,y) of the node.
virtual void	setPosition (const Vec2 &position)
	Sets the position (x,y) of the node in its parent's coordinate system.
virtual void	setPositionNormalized (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1.
virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system.
virtual const Vec2 &	getPositionNormalized () const
	Returns the normalized position.
virtual void	setPosition (float x, float y)
	Sets the position (x,y) of the node in its parent's coordinate system.
virtual void	getPosition (float *x, float *y) const
	Gets position in a more efficient way, returns two number instead of a Vec2 object.
virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position.
virtual float	getPositionX () const
	Gets the x coordinate of the node in its parent's coordinate system.
virtual void	setPositionY (float y)
	Sets the y coordinate of the node in its parent's coordinate system.
virtual float	getPositionY () const
	Gets the y coordinate of the node in its parent's coordinate system.
virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system.
virtual Vec3	getPosition3D () const
	Returns the position (X,Y,Z) in its parent's coordinate system.
virtual void	setPositionZ (float positionZ)
	Sets the 'z' coordinate in the position.
virtual float	getPositionZ () const
	Gets position Z coordinate of this node.
virtual void	setSkewX (float skewX)
	Changes the X skew angle of the node in degrees.
virtual float	getSkewX () const
	Returns the X skew angle of the node in degrees.
virtual void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees.
virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees.
virtual void	setAnchorPoint (const Vec2 &anchorPoint)
	Sets the anchor point in percent.
virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent.
virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels.
virtual void	setContentSize (const Vec2 &contentSize)
	Sets the untransformed size of the node.
virtual const Vec2 &	getContentSize () const
	Returns the untransformed size of the node.
virtual bool	hitTest (const Vec2 &worldPoint) const
	The basic node hit test, since axmol-1.0.
virtual void	setVisible (bool visible)
	Sets whether the node is visible.
virtual bool	isVisible () const
	Determines if the node is visible.
virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees.
virtual float	getRotation () const
	Returns the rotation of the node in degrees.
virtual void	setRotation3D (const Vec3 &rotation)
	Sets the rotation (X,Y,Z) in degrees.
virtual Vec3	getRotation3D () const
	Returns the rotation (X,Y,Z) in degrees.
virtual void	setRotationQuat (const Quaternion &quat)
	Set rotation by quaternion.
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.
virtual void	setRotationSkewX (float rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew.
virtual float	getRotationSkewX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.
virtual void	setRotationSkewY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.
virtual float	getRotationSkewY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.
virtual void	setIgnoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node.
virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node.
Tag & User data
virtual int	getTag () const
	Returns a tag that is used to identify the node easily.
virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily.
virtual std::string_view	getName () const
	Returns a string that is used to identify the node.
virtual void	setName (std::string_view name)
	Changes the name that is used to identify the node easily.
virtual void *	getUserData ()
	Returns a custom user data pointer.
virtual const void *	getUserData () const
	@lua NA
virtual void	setUserData (void *userData)
	Sets a custom user data pointer.
virtual Object *	getUserObject ()
	Returns a user assigned Object.
virtual const Object *	getUserObject () const
	@lua NA
virtual void	setUserObject (Object *userObject)
	Returns a user assigned Object.
Event Callbacks
virtual void	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'.
virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the Node enters in the 'stage'.
virtual void	onExit ()
	Event callback that is invoked every time the Node leaves the 'stage'.
virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the Node leaves the 'stage'.
Actions
virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions.
virtual ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions.
virtual Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed.
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.
void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag.
void	stopAllActionsByTag (int tag)
	Removes all actions from the running action list by its tag.
void	stopActionsByFlags (unsigned int flags)
	Removes all actions from the running action list by its flags.
Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag.
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).
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.
Scheduler and Timer
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers.
virtual Scheduler *	getScheduler ()
	Gets a Scheduler object.
bool	isScheduled (SEL_SCHEDULE selector) const
	Checks whether a selector is scheduled.
bool	isScheduled (std::string_view key) const
	Checks whether a lambda function is scheduled.
void	scheduleUpdate ()
	Schedules the "update" method.
void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority.
void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector.
void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds.
void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger.
void	scheduleOnce (const std::function< void(float)> &callback, float delay, std::string_view key)
	Schedules a lambda function that runs only once, with a delay of 0 or larger.
void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame.
void	schedule (const std::function< void(float)> &callback, std::string_view key)
	Schedules a lambda function.
void	schedule (const std::function< void(float)> &callback, float interval, std::string_view key)
	Schedules a lambda function.
void	schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, std::string_view key)
	Schedules a lambda function.
void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector.
void	unschedule (std::string_view key)
	Unschedules a lambda function.
void	unscheduleAllCallbacks ()
	Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.
virtual void	resume ()
	Resumes all scheduled selectors, actions and event listeners.
virtual void	pause ()
	Pauses all scheduled selectors, actions and event listeners.
virtual void	update (float delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
Transformations
virtual void	updateTransform ()
	Calls children's updateTransform() method recursively.
virtual const Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.
virtual Mat4	getNodeToParentTransform (Node *ancestor) const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.
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.
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually.
virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.
virtual Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix.
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix.
Coordinate Converters
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates.
Vec2	convertToWorldSpace (const Vec2 &nodePoint) const
	Converts a Vec2 to world space coordinates.
Vec2	convertToNodeSpaceAR (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates.
Vec2	convertToWorldSpaceAR (const Vec2 &nodePoint) const
	Converts a local Vec2 to world space coordinates.The result is in Points.
Vec2	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Vec2.
Vec2	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate.
Vec2	getWorldPosition () const
	Gets position of node in world space.
void	setWorldPosition (const Vec2 &position)
	Sets position of node in world space.
void	setAdditionalTransform (const Mat4 *additionalTransform)
	Sets an additional transform matrix to the node.
component functions
Component *	getComponent (std::string_view name)
	Gets a component by its name.
virtual bool	addComponent (Component *component)
	Adds a component.
virtual bool	removeComponent (std::string_view name)
	Removes a component by its name.
virtual bool	removeComponent (Component *component)
	Removes a component by its pointer.
virtual void	removeAllComponents ()
	Removes all components.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
virtual	~Object ()
	Destructor.

Static Public Attributes
static const int	INVALID_TAG = -1
	Default tag used for all the nodes.

Constructor, Destructor and Initializers
static Node *	create ()
	Allocates and initializes a node.
static int	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.
virtual std::string	getDescription () const
	Gets the description string.

Children and Parent
template<typename _T>
static void	sortNodes (ax::Vector< _T * > &nodes)
	Sorts helper function.
virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0.
virtual void	addChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order.
virtual void	addChild (Node *child, int localZOrder, int tag)
	Adds a child to the container with z order and tag.
virtual void	addChild (Node *child, int localZOrder, std::string_view name)
	Adds a child to the container with z order and tag.
virtual Node *	getChildByTag (int tag) const
	Gets a child from the container with its tag.
template<typename T>
T	getChildByTag (int tag) const
	Gets a child from the container with its tag that can be cast to Type T.
virtual Node *	getChildByName (std::string_view name) const
	Gets a child from the container with its name.
template<typename T>
T	getChildByName (std::string_view name) const
	Gets a child from the container with its name that can be cast to Type T.
virtual void	enumerateChildren (std::string_view name, std::function< bool(Node *node)> callback) const
	Search the children of the receiving node to perform processing for nodes which share a name.
virtual Vector< Node * > &	getChildren ()
	Returns the array of the node's children.
virtual ssize_t	getChildrenCount () const
	Returns the amount of children.
virtual void	setParent (Node *parent)
	Sets the parent node.
virtual Node *	getParent ()
	Returns a pointer to the parent node.
virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup.
virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node.
virtual void	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container.
virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value.
virtual void	removeChildByName (std::string_view name, bool cleanup=true)
	Removes a child from the container by tag value.
virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup.
virtual void	removeAllChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.
virtual void	reorderChild (Node *child, int localZOrder)
	Reorders a child according to a new z value.
virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered.

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

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.

Member Function Documentation

create()

static Node * create ( )

static

Allocates and initializes a node.

Returns

A initialized node which is marked as "autorelease".

getDescription()

virtual std::string getDescription ( ) const

virtual

Gets the description string.

It makes debugging easier.

Returns

A string @js NA @lua NA

Reimplemented in FastTMXLayer, FastTMXTiledMap, Label, LabelAtlas, LayerGradient, LayerMultiplex, Menu, MenuItem, ParticleSystemQuad, Scene, Sprite, SpriteBatchNode, Button, CheckBox, EditBox, ImageView, Layout, ListView, LoadingBar, PageView, RadioButton, RadioButtonGroup, RichText, ScrollView, Slider, Text, TextAtlas, TextBMFont, TextField, and Widget.

setLocalZOrder()

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 on 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 LocalZOrder values < 0 are the "left" subtree While Nodes with LocalZOrder >=0 are the "right" subtree.

See also

setGlobalZOrder

setVertexZ

Parameters

localZOrder

The local Z order value.

updateOrderOfArrival()

void updateOrderOfArrival

(

)

!

!! ONLY FOR INTERNAL USE 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 n later.

Warning

This method is used internally for localZOrder sorting, don't change this manually

Parameters

orderOfArrival

The arrival order.

getLocalZOrder()

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.

setGlobalZOrder()

virtual void setGlobalZOrder ( float globalZOrder )

virtual

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 in ClippingNode, Label, ProtectedNode, EditBox, and Layout.

getGlobalZOrder()

virtual float getGlobalZOrder ( ) const

inlinevirtual

Returns the Node's Global Z Order.

See also

setGlobalZOrder(int)

Returns

The node's global Z order

setScaleX()

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

scaleX

The scale factor on X axis.

Warning

The physics body doesn't support this.

Reimplemented in ParticleSystem, Sprite, and Widget.

getScaleX()

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

setScaleY()

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

scaleY

The scale factor on Y axis.

Warning

The physics body doesn't support this.

Reimplemented in ParticleSystem, Sprite, and Widget.

getScaleY()

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

setScaleZ()

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

scaleZ

The scale factor on Z axis.

Warning

The physics body doesn't support this.

Reimplemented in Widget.

getScaleZ()

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.

Reimplemented in Widget.

setScale() [1/2]

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

scale

The scale factor for both X and Y axis.

Warning

The physics body doesn't support this.

Reimplemented in ParticleSystem, Sprite, and Widget.

getScale()

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

setScale() [2/2]

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

scaleX	The scale factor on X axis.
scaleY	The scale factor on Y axis.

Warning

The physics body doesn't support this.

Reimplemented in Sprite, and Widget.

setPosition() [1/2]

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.

Vec2 size = Director::getInstance()->getWinSize();
node->setPosition(size.width/2, size.height/2);

Parameters

position

The position (x,y) of the node in OpenGL coordinates.

Reimplemented in MotionStreak3D, MotionStreak, Sprite, EditBox, and Widget.

setPositionNormalized()

virtual void setPositionNormalized ( 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
void setNormalizedPosition(Vec2 pos) {
  Vec2 s = getParent()->getContentSize();
  _position = pos * s;
}

Parameters

position

The normalized position (x,y) of the node, using value between 0 and 1.

Reimplemented in Widget.

getPosition() [1/2]

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 MotionStreak3D, and MotionStreak.

getPositionNormalized()

virtual const Vec2 & getPositionNormalized ( ) const

virtual

Returns the normalized position.

Returns

The normalized position.

setPosition() [2/2]

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

x	X coordinate for position.
y	Y coordinate for position.

Reimplemented in MotionStreak3D, MotionStreak, and Sprite.

getPosition() [2/2]

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.

Parameters

x	To receive x coordinate for position.
y	To receive y coordinate for position.

Reimplemented in MotionStreak3D, and MotionStreak.

setPositionX()

virtual void setPositionX ( float x )

virtual

Gets/Sets x or y coordinate individually for position.

These methods are used in Lua and Javascript Bindings Sets the x coordinate of the node in its parent's coordinate system.

Parameters

x	The x coordinate of the node.

Reimplemented in MotionStreak3D, and MotionStreak.

getPositionX()

virtual float getPositionX ( ) const

virtual

Gets the x coordinate of the node in its parent's coordinate system.

Returns

The x coordinate of the node.

Reimplemented in MotionStreak3D, and MotionStreak.

setPositionY()

virtual void setPositionY ( float y )

virtual

Sets the y coordinate of the node in its parent's coordinate system.

Parameters

y	The y coordinate of the node.

Reimplemented in MotionStreak3D, and MotionStreak.

getPositionY()

virtual float getPositionY ( ) const

virtual

Gets the y coordinate of the node in its parent's coordinate system.

Returns

The y coordinate of the node.

Reimplemented in MotionStreak3D, and MotionStreak.

setPosition3D()

virtual void setPosition3D ( const Vec3 & position )

virtual

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

Parameters

position

The position (X, Y, and Z) in its parent's coordinate system. @js NA

Reimplemented in MotionStreak3D.

getPosition3D()

virtual Vec3 getPosition3D ( ) const

virtual

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

Returns

The position (X, Y, and Z) in its parent's coordinate system. @js NA

Reimplemented in MotionStreak3D, and MotionStreak.

setPositionZ()

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

positionZ

OpenGL Z vertex of this node. @js setVertexZ

Reimplemented in Sprite.

getPositionZ()

virtual float getPositionZ ( ) const

virtual

Gets position Z coordinate of this node.

See also

setPositionZ(float)

Returns

The position Z coordinate of this node. @js getVertexZ

setSkewX()

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

skewX

The X skew angle of the node in degrees.

Warning

The physics body doesn't support this.

Reimplemented in Sprite.

getSkewX()

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.

setSkewY()

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

skewY

The Y skew angle of the node in degrees.

Warning

The physics body doesn't support this.

Reimplemented in Sprite.

getSkewY()

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.

setAnchorPoint()

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,0), so it starts in the lower left corner of the node.

Note

If node has a physics body, the anchor must be in the middle, you can't change this to other value.

Parameters

anchorPoint

The anchor point of node.

Reimplemented in AnchoredSprite, ProgressTimer, Sprite, and EditBox.

getAnchorPoint()

virtual const Vec2 & getAnchorPoint ( ) const

virtual

Returns the anchor point in percent.

See also

setAnchorPoint(const Vec2&)

Returns

The anchor point of node.

getAnchorPointInPoints()

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.

setContentSize()

virtual void setContentSize ( const Vec2 & 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

contentSize

The untransformed size of the node.

Reimplemented in LayerRadialGradient, Sprite, EditBox, and Widget.

getContentSize()

virtual const Vec2 & getContentSize ( ) const

virtual

Returns the untransformed size of the node.

See also

setContentSize(const Vec2&)

Returns

The untransformed size of the node.

Reimplemented in Label.

hitTest()

virtual bool hitTest ( const Vec2 & worldPoint ) const

virtual

The basic node hit test, since axmol-1.0.

Parameters

worldPoint

The coord in GL world space.

Returns

Whether the worldPoint is inside this node

setVisible()

virtual void setVisible ( bool visible )

virtual

Sets whether the node is visible.

The default value is true, a node is default to visible.

Parameters

visible

true if the node is visible, false if the node is hidden.

Reimplemented in Sprite, and EditBox.

isVisible()

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.

setRotation()

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

rotation

The rotation of the node in degrees.

Reimplemented in ParticleSystem, and Sprite.

getRotation()

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.

setRotation3D()

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.

Parameters

rotation

The rotation of the node in 3d. @js NA

Reimplemented in MotionStreak3D.

getRotation3D()

virtual Vec3 getRotation3D ( ) const

virtual

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

Returns

The rotation of the node in 3d. @js NA

setRotationQuat()

virtual void setRotationQuat ( const Quaternion & quat )

virtual

Set rotation by quaternion.

You should make sure the quaternion is normalized.

Parameters

quat	The rotation in quaternion, note that the quat must be normalized. @js NA

Reimplemented in MotionStreak3D.

getRotationQuat()

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.

Returns

The rotation in quaternion. @js NA

setRotationSkewX()

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

rotationX

The X rotation in degrees which performs a horizontal rotational skew.

Warning

The physics body doesn't support this. @js setRotationX

Reimplemented in Sprite.

getRotationSkewX()

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. @js getRotationX

setRotationSkewY()

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

rotationY

The Y rotation in degrees.

Warning

The physics body doesn't support this. @js setRotationY

Reimplemented in Sprite.

getRotationSkewY()

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. @js getRotationY

setIgnoreAnchorPointForPosition()

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

ignore

true if anchor point will be (0,0) when you position this node.

Reimplemented in Sprite.

isIgnoreAnchorPointForPosition()

virtual bool isIgnoreAnchorPointForPosition ( ) const

virtual

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

See also

setIgnoreAnchorPointForPosition(bool)

Returns

true if the anchor point will be (0,0) when you position this node.

addChild() [1/4]

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

child

A child node.

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

addChild() [2/4]

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

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

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

addChild() [3/4]

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

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

Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

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

addChild() [4/4]

virtual void addChild ( Node * child, int localZOrder, std::string_view 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

child	A child node.
localZOrder	Z order for drawing priority. Please refer to setLocalZOrder(int).
name	A string to identify the node easily. Please refer to setName(int).

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

getChildByTag() [1/2]

virtual Node * getChildByTag ( int tag ) const

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.

Please use getChildByName() instead.

Reimplemented in ScrollView.

getChildByTag() [2/2]

template<typename T>

T getChildByTag ( int tag ) const

inline

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

Parameters

tag	An identifier to find the child node.

Returns

a Node with the given tag that can be cast to Type T.

getChildByName() [1/2]

virtual Node * getChildByName ( std::string_view name ) const

virtual

Gets a child from the container with its name.

Parameters

name	An identifier to find the child node.

Returns

a Node object whose name equals to the input parameter.

Since

v3.2

Reimplemented in ScrollView.

getChildByName() [2/2]

template<typename T>

T getChildByName ( std::string_view name ) const

inline

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

Parameters

name	An identifier to find the child node.

Returns

a Node with the given name that can be cast to Type T.

enumerateChildren()

virtual void enumerateChildren ( std::string_view 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

name

The 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

callback

A 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

getChildren()

virtual Vector< Node * > & getChildren ( )

inlinevirtual

Returns the array of the node's children.

Returns

the array the node's children.

Reimplemented in ScrollView.

getChildrenCount()

virtual ssize_t getChildrenCount ( ) const

virtual

Returns the amount of children.

Returns

The amount of children.

Reimplemented in ScrollView.

setParent()

virtual void setParent ( Node * parent )

virtual

Sets the parent node.

Parameters

parent

A pointer to the parent node.

getParent()

virtual Node * getParent ( )

inlinevirtual

Returns a pointer to the parent node.

See also

setParent(Node*)

Returns

A pointer to the parent node.

removeFromParent()

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)

removeFromParentAndCleanup()

virtual void removeFromParentAndCleanup ( bool cleanup )

virtual

Removes this node itself from its parent node.

If the node orphan, then nothing happens.

Parameters

cleanup

true if all actions and callbacks on this node should be removed, false otherwise. @js removeFromParent @lua removeFromParent

removeChild()

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

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.

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

removeChildByTag()

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

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.

Please use removeChildByName instead.

removeChildByName()

virtual void removeChildByName ( std::string_view 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

name	A string that identifies a child node.
cleanup	True if all running actions and callbacks on the child node will be cleanup, false otherwise.

removeAllChildren()

virtual void removeAllChildren ( )

virtual

Removes all children from the container with a cleanup.

See also

removeAllChildrenWithCleanup(bool)

Reimplemented in Scene, Layout, ListView, and ScrollView.

removeAllChildrenWithCleanup()

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

cleanup

True if all running actions on all children nodes should be cleanup, false otherwise. @js removeAllChildren @lua removeAllChildren

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

reorderChild()

virtual void reorderChild ( 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).

Reimplemented in ParticleBatchNode, Sprite, and SpriteBatchNode.

sortAllChildren()

virtual void sortAllChildren ( )

virtual

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

This approach can improve the performance massively.

Note

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

Reimplemented in Sprite, and SpriteBatchNode.

getTag()

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.

setTag()

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

tag	A integer that identifies the node.

Please use setName() instead.

getName()

virtual std::string_view getName ( ) const

virtual

Returns a string that is used to identify the node.

Returns

A string that identifies the node.

Since

v3.2

setName()

virtual void setName ( std::string_view name )

virtual

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

Parameters

name	A string that identifies the node.

Since

v3.2

getUserData()

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. @lua NA

setUserData()

virtual void setUserData ( void * userData )

virtual

Sets a custom user data pointer.

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

Warning

Don't forget to release the memory manually, especially before you change this data pointer, and before this node is autoreleased.

Parameters

userData

A custom user data pointer. @lua NA

getUserObject()

virtual Object * 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. @lua NA

setUserObject()

virtual void setUserObject ( Object * userObject )

virtual

Returns a user assigned Object.

Similar to UserData, but instead of holding a void* it holds an object. The UserObject will be retained once in this method, and the previous UserObject (if existed) will be released. The UserObject will be released in Node's destructor.

Parameters

userObject

A user assigned Object.

isRunning()

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.

scheduleUpdateWithPriorityLua()

void scheduleUpdateWithPriorityLua	(	int	handler,
		int	priority )

Schedules for lua script.

@js NA

Parameters

handler	The key to search lua function.
priority	A given priority value.

onEnter()

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(). @lua NA

Reimplemented in BaseLight, Camera, ClippingNode, Menu, ParticleSystem, ProtectedNode, RenderTexture, TransitionCrossFade, TransitionFade, TransitionFadeTR, TransitionFlipAngular, TransitionFlipX, TransitionFlipY, TransitionJumpZoom, TransitionMoveInL, TransitionPageTurn, TransitionProgress, TransitionRotoZoom, TransitionScene, TransitionShrinkGrow, TransitionSlideInL, TransitionSplitCols, TransitionTurnOffTiles, TransitionZoomFlipAngular, TransitionZoomFlipX, TransitionZoomFlipY, EditBox, Layout, ScrollView, ScrollViewBar, TextField, UICCTextField, and Widget.

onEnterTransitionDidFinish()

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() @lua NA

Reimplemented in ClippingNode, and ProtectedNode.

onExit()

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(). @lua NA

Reimplemented in BaseLight, Camera, ClippingNode, Menu, ParticleSystem, ProtectedNode, RenderTexture, TransitionCrossFade, TransitionFade, TransitionFadeTR, TransitionPageTurn, TransitionProgress, TransitionScene, TransitionSplitCols, TransitionTurnOffTiles, EditBox, Layout, ScrollView, and Widget.

onExitTransitionDidStart()

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. @lua NA

Reimplemented in ClippingNode, and ProtectedNode.

draw()

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.

Parameters

renderer	A given renderer.
transform	A transform matrix.
flags	Renderer flag.

Reimplemented in AtlasNode, BillBoard, DrawNode, FastTMXLayer, Label, LayerRadialGradient, MeshRenderer, MotionStreak3D, MotionStreak, ParticleBatchNode, ParticleSystemQuad, ProgressTimer, RenderTexture, Skybox, Sprite, SpriteBatchNode, Terrain, TransitionCrossFade, TransitionFadeTR, TransitionPageTurn, TransitionScene, TransitionSplitCols, TransitionTurnOffTiles, and EditBox.

visit()

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

virtual

Visits this node's children and draw them recursively.

Parameters

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

Reimplemented in AttachNode, BillBoard, Camera, ClippingNode, ClippingRectangleNode, DrawNode, Label, MeshRenderer, NodeGrid, ParallaxNode, ParticleBatchNode, ProtectedNode, RenderTexture, Scene, SpriteBatchNode, TextFieldTTF, Layout, and Widget.

getScene()

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.

Returns

The Scene that contains the node.

getBoundingBox()

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, and MeshRenderer.

setEventDispatcher()

virtual void setEventDispatcher ( EventDispatcher * dispatcher )

virtual

Set event dispatcher for scene.

Parameters

dispatcher

The event dispatcher of scene.

getEventDispatcher()

virtual EventDispatcher * getEventDispatcher ( ) const

inlinevirtual

Get the event dispatcher of scene.

Returns

The event dispatcher of scene.

setActionManager()

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

actionManager

A ActionManager object that is used by all actions.

getActionManager()

virtual ActionManager * getActionManager ( )

inlinevirtual

Gets the ActionManager object that is used by all actions.

See also

setActionManager(ActionManager*)

Returns

A ActionManager object.

runAction()

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.

Parameters

action

An Action pointer.

Reimplemented in MeshRenderer.

stopAction()

void stopAction

(

Action *

action

)

Stops and removes an action from the running action list.

Parameters

action

The action object to be removed.

stopActionByTag()

void stopActionByTag

(

int

tag

)

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

Parameters

tag	A tag that indicates the action to be removed.

stopAllActionsByTag()

void stopAllActionsByTag

(

int

tag

)

Removes all actions from the running action list by its tag.

Parameters

tag	A tag that indicates the action to be removed.

stopActionsByFlags()

void stopActionsByFlags

(

unsigned int

flags

)

Removes all actions from the running action list by its flags.

Parameters

flags

A flag field that removes actions based on bitwise AND.

getActionByTag()

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.

getNumberOfRunningActions()

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.

Returns

The number of actions that are running plus the ones that are schedule to run.

getNumberOfRunningActionsByTag()

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.

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.

Parameters

tag	The tag that will be searched.

Returns

The number of actions that are running plus the ones that are schedule to run with specific tag.

setScheduler()

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

scheduler

A Scheduler object that is used to schedule all "update" and timers.

getScheduler()

virtual Scheduler * getScheduler ( )

inlinevirtual

Gets a Scheduler object.

See also

setScheduler(Scheduler*)

Returns

A Scheduler object.

isScheduled() [1/2]

bool isScheduled

(

SEL_SCHEDULE

selector

)

const

Checks whether a selector is scheduled.

Parameters

selector

A function selector

Returns

Whether the function selector is scheduled. @js NA @lua NA

isScheduled() [2/2]

bool isScheduled

(

std::string_view

key

)

const

Checks whether a lambda function is scheduled.

Parameters

key	key of the callback

Returns

Whether the lambda function selector is scheduled. @js NA @lua NA

scheduleUpdate()

void scheduleUpdate

(

)

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. @lua NA

scheduleUpdateWithPriority()

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). @lua NA

Parameters

priority

A given priority value.

schedule() [1/6]

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 macro.
this->schedule(AX_SCHEDULE_SELECTOR(MyNode::TickMe), 0, 0, 0);

Parameters

selector	The SEL_SCHEDULE selector to be scheduled.
interval	Tick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.
repeat	The selector will be executed (repeat + 1) times, you can use AX_REPEAT_FOREVER for tick infinitely.
delay	The amount of time that the first tick will wait before execution. @lua NA

schedule() [2/6]

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

selector	The SEL_SCHEDULE selector to be scheduled.
interval	Callback interval time in seconds. 0 means tick every frame, @lua NA

scheduleOnce() [1/2]

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

selector	The SEL_SCHEDULE selector to be scheduled.
delay	The amount of time that the first tick will wait before execution. @lua NA

scheduleOnce() [2/2]

void scheduleOnce	(	const std::function< void(float)> &	callback,
		float	delay,
		std::string_view	key )

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

Parameters

callback	The lambda function to be scheduled.
delay	The amount of time that the first tick will wait before execution.
key	The key of the lambda function. To be used if you want to unschedule it. @lua NA

schedule() [3/6]

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

selector

A function wrapped as a selector @lua NA

schedule() [4/6]

void schedule	(	const std::function< void(float)> &	callback,
		std::string_view	key )

Schedules a lambda function.

The scheduled lambda function will be called every frame.

Parameters

callback	The lambda function to be scheduled.
key	The key of the lambda function. To be used if you want to unschedule it. @lua NA

schedule() [5/6]

void schedule	(	const std::function< void(float)> &	callback,
		float	interval,
		std::string_view	key )

Schedules a lambda function.

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

Parameters

callback	The lambda function to be scheduled
interval	Callback interval time in seconds. 0 means every frame,
key	The key of the lambda function. To be used if you want to unschedule it @lua NA

schedule() [6/6]

void schedule	(	const std::function< void(float)> &	callback,
		float	interval,
		unsigned int	repeat,
		float	delay,
		std::string_view	key )

Schedules a lambda function.

Parameters

callback	The lambda function to be schedule.
interval	Tick interval in seconds. 0 means tick every frame.
repeat	The selector will be executed (repeat + 1) times, you can use AX_REPEAT_FOREVER for tick infinitely.
delay	The amount of time that the first tick will wait before execution.
key	The key of the lambda function. To be used if you want to unschedule it. @lua NA

unschedule() [1/2]

void unschedule

(

SEL_SCHEDULE

selector

)

Unschedules a custom selector.

See also

schedule(SEL_SCHEDULE, float, unsigned int, float)

Parameters

selector

A function wrapped as a selector. @lua NA

unschedule() [2/2]

void unschedule

(

std::string_view

key

)

Unschedules a lambda function.

Parameters

key	The key of the lambda function to be unscheduled. @lua NA

unscheduleAllCallbacks()

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. @lua NA

resume()

virtual void resume ( )

virtual

Resumes all scheduled selectors, actions and event listeners.

This method is called internally by onEnter.

pause()

virtual void pause ( )

virtual

Pauses all scheduled selectors, actions and event listeners.

This method is called internally by onExit.

update()

virtual void update ( float delta )

virtual

Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".

Parameters

delta

In seconds.

Reimplemented in MotionStreak3D, MotionStreak, ParticleSystem, TextFieldTTF, ScrollView, ScrollViewBar, and TextField.

updateTransform()

virtual void updateTransform ( )

virtual

Calls children's updateTransform() method recursively.

This method is moved from Sprite, so it's no longer specific to Sprite. As the result, you apply SpriteBatchNode's optimization on your customed Node. e.g., batchNode->addChild(myCustomNode), while you can only addChild(sprite) before.

Reimplemented in Camera, and Sprite.

getNodeToParentTransform() [1/2]

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.

Returns

The transformation matrix.

Reimplemented in AttachNode.

getNodeToParentTransform() [2/2]

virtual Mat4 getNodeToParentTransform ( Node * ancestor ) const

virtual

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

The matrix is in Pixels. Note: If ancestor is not a valid ancestor of the node, the API would return the same value as

See also

getNodeToWorldTransform

Parameters

ancestor

The parent's node pointer.

Since

v3.7

Returns

The transformation matrix.

getNodeToParentAffineTransform()

virtual AffineTransform getNodeToParentAffineTransform ( Node * ancestor ) const

virtual

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

The matrix is in Pixels.

Note: If ancestor is not a valid ancestor of the node, the API would return the same value as

See also

getNodeToWorldAffineTransform

Parameters

ancestor

The parent's node pointer.

Since

v3.7

Returns

The affine transformation matrix.

setNodeToParentTransform()

virtual void setNodeToParentTransform ( const Mat4 & transform )

virtual

Sets the transformation matrix manually.

Parameters

transform

A given transformation matrix.

getParentToNodeTransform()

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.

Returns

The transformation matrix.

getNodeToWorldTransform()

virtual Mat4 getNodeToWorldTransform ( ) const

virtual

Returns the world affine transform matrix.

The matrix is in Pixels.

Returns

transformation matrix, in pixels.

Reimplemented in AttachNode.

getWorldToNodeTransform()

virtual Mat4 getWorldToNodeTransform ( ) const

virtual

Returns the inverse world affine transform matrix.

The matrix is in Pixels.

Returns

The transformation matrix.

Reimplemented in AttachNode.

convertToNodeSpace()

Vec2 convertToNodeSpace

(

const Vec2 &

worldPoint

)

const

Converts a Vec2 to node (local) space coordinates.

The result is in Points.

Parameters

worldPoint

A given coordinate.

Returns

A point in node (local) space coordinates.

convertToWorldSpace()

Vec2 convertToWorldSpace

(

const Vec2 &

nodePoint

)

const

Converts a Vec2 to world space coordinates.

The result is in Points.

Parameters

nodePoint

A given coordinate.

Returns

A point in world space coordinates.

convertToNodeSpaceAR()

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.

Parameters

worldPoint

A given coordinate.

Returns

A point in node (local) space coordinates, anchor relative.

convertToWorldSpaceAR()

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.

Parameters

nodePoint

A given coordinate.

Returns

A point in world space coordinates, anchor relative.

convertTouchToNodeSpace()

Vec2 convertTouchToNodeSpace

(

Touch *

touch

)

const

convenience methods which take a Touch instead of Vec2.

Parameters

touch

A given touch.

Returns

A point in world space coordinates.

convertTouchToNodeSpaceAR()

Vec2 convertTouchToNodeSpaceAR

(

Touch *

touch

)

const

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

This method is AR (Anchor Relative).

Parameters

touch

A given touch.

Returns

A point in world space coordinates, anchor relative.

getWorldPosition()

Vec2 getWorldPosition

(

)

const

Gets position of node in world space.

Returns

Position of node in world space.

setWorldPosition()

void setWorldPosition

(

const Vec2 &

position

)

Sets position of node in world space.

Parameters

position

Position of node in world space.

setAdditionalTransform()

void setAdditionalTransform

(

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

Parameters

additionalTransform

An additional transform matrix.

getComponent()

Component * getComponent

(

std::string_view

name

)

Gets a component by its name.

Parameters

name	A given name of component.

Returns

The Component by name.

addComponent()

virtual bool addComponent ( Component * component )

virtual

Adds a component.

Parameters

component

A given component.

Returns

True if added success.

removeComponent() [1/2]

virtual bool removeComponent ( std::string_view name )

virtual

Removes a component by its name.

Parameters

name	A given name of component.

Returns

True if removed success.

removeComponent() [2/2]

virtual bool removeComponent ( Component * component )

virtual

Removes a component by its pointer.

Parameters

component

A given component.

Returns

True if removed success.

getOpacity()

virtual uint8_t getOpacity ( ) const

virtual

Return the node's opacity.

Returns

A GLubyte value.

Reimplemented in MotionStreak3D, MotionStreak, ProgressTimer, and ScrollViewBar.

getDisplayedOpacity()

virtual uint8_t getDisplayedOpacity ( ) const

virtual

Return the node's display opacity.

The difference between opacity and displayedOpacity is: The displayedOpacity is what's the final rendering opacity of node.

Returns

A GLubyte value.

Reimplemented in ProgressTimer.

setOpacity()

virtual void setOpacity ( uint8_t opacity )

virtual

Change node opacity.

Parameters

opacity

A GLubyte opacity value.

Reimplemented in AtlasNode, MotionStreak3D, MotionStreak, ProgressTimer, and ScrollViewBar.

updateDisplayedOpacity()

virtual void updateDisplayedOpacity ( uint8_t parentOpacity )

virtual

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

Parameters

parentOpacity

The opacity of parent node.

Reimplemented in Label, and ProtectedNode.

isCascadeOpacityEnabled()

virtual bool isCascadeOpacityEnabled ( ) const

virtual

Whether cascadeOpacity is enabled or not.

Returns

A boolean value.

setCascadeOpacityEnabled()

virtual void setCascadeOpacityEnabled ( bool cascadeOpacityEnabled )

virtual

Change node's cascadeOpacity property.

Parameters

cascadeOpacityEnabled

True to enable cascadeOpacity, false otherwise.

getColor()

virtual const Color3B & getColor ( ) const

virtual

Query node's color value.

Returns

A Color3B color value.

Reimplemented in AtlasNode, and ProgressTimer.

getDisplayedColor()

virtual const Color3B & getDisplayedColor ( ) const

virtual

Query node's displayed color.

Returns

A Color3B color value.

setColor()

virtual void setColor ( const Color3B & color )

virtual

Change the color of node.

Parameters

color

A Color3B color value.

Reimplemented in AtlasNode, and ProgressTimer.

updateDisplayedColor()

virtual void updateDisplayedColor ( const Color3B & parentColor )

virtual

Update node's displayed color with its parent color.

Parameters

parentColor

A Color3B color value.

Reimplemented in Label, and ProtectedNode.

isCascadeColorEnabled()

virtual bool isCascadeColorEnabled ( ) const

virtual

Query whether cascadeColor is enabled or not.

Returns

Whether cascadeColor is enabled or not.

setCascadeColorEnabled()

virtual void setCascadeColorEnabled ( bool cascadeColorEnabled )

virtual

If you want node's color affect the children node's color, then set it to true.

Otherwise, set it to false.

Parameters

cascadeColorEnabled

A boolean value.

setOpacityModifyRGB()

virtual void setOpacityModifyRGB ( bool value )

virtual

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

Parameters

value

A boolean value.

Reimplemented in AtlasNode, Label, Menu, MotionStreak3D, MotionStreak, ParticleSystem, and Sprite.

isOpacityModifyRGB()

virtual bool isOpacityModifyRGB ( ) const

virtual

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

Returns

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

Reimplemented in AtlasNode, Label, Menu, MotionStreak3D, MotionStreak, ParticleSystem, and Sprite.

setOnEnterCallback()

void setOnEnterCallback ( const std::function< void()> & callback )

inline

Set the callback of event onEnter.

Parameters

callback

A std::function<void()> callback.

getOnEnterCallback()

const std::function< void()> & getOnEnterCallback ( ) const

inline

Get the callback of event onEnter.

Returns

A std:function<void()> callback.

setOnExitCallback()

void setOnExitCallback ( const std::function< void()> & callback )

inline

Set the callback of event onExit.

Parameters

callback

A std::function<void()> callback.

getOnExitCallback()

const std::function< void()> & getOnExitCallback ( ) const

inline

Get the callback of event onExit.

Returns

A std::function<void()>.

setOnEnterTransitionDidFinishCallback()

void setOnEnterTransitionDidFinishCallback ( const std::function< void()> & callback )

inline

Set the callback of event EnterTransitionDidFinish.

Parameters

callback

A std::function<void()> callback.

getOnEnterTransitionDidFinishCallback()

const std::function< void()> & getOnEnterTransitionDidFinishCallback ( ) const

inline

Get the callback of event EnterTransitionDidFinish.

Returns

std::function<void()>

setOnExitTransitionDidStartCallback()

void setOnExitTransitionDidStartCallback ( const std::function< void()> & callback )

inline

Set the callback of event ExitTransitionDidStart.

Parameters

callback

A std::function<void()> callback.

getOnExitTransitionDidStartCallback()

const std::function< void()> & getOnExitTransitionDidStartCallback ( ) const

inline

Get the callback of event ExitTransitionDidStart.

Returns

std::function<void()>

setCameraMask()

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

virtual

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 in ClippingNode, Label, ProtectedNode, and Layout.

applyMaskOnEnter()

void applyMaskOnEnter

(

bool

applyChildren

)

Should addChild() make the child follow it's parent's mask?

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

Parameters

applyChildren

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

setProgramState()

virtual bool setProgramState ( backend::ProgramState * programState, bool ownPS = false )

virtual

Sets ProgramState with retain.

Parameters

programState

Reimplemented in AtlasNode, Label, MeshRenderer, MotionStreak, Sprite, and SpriteBatchNode.

setProgramStateByProgramId()

backend::ProgramState * setProgramStateByProgramId

(

uint64_t

progId

)

Sets ProgramState by programId.

Parameters

progId

the program id or programType used to create programState

Returns

ProgramState* (nullable)

---

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

• Node.h