Node 节点常用 API

前言

节点在cocosCreator中是非常重要的,所以它的相关API至关重要。


# 一. 基本属性

# width:

节点宽度。

# height:

节点高度。

# name:

节点名称。

# color:

节点颜色。

# opacity:

节点透明度(0-255)。

# position:

节点在父节点坐标系中的位置。

# x:

节点 X 轴坐标(相当于父节点)。

# y:

节点 Y 轴坐标(相当于父节点)。

# anchorX:

节点 X 轴锚点位置(0-1之间)。

# anchorY:

节点 Y 轴锚点位置(0-1之间)。

# rotation:

该节点旋转角度。

# scale:

节点相对父节点的缩放。

# zIndex:

决定一个节点在兄弟节点之间的位置。

# active:

当前节点的自身激活状态。

# parent:

该节点的父节点。

# children:

节点的所有子节点。

# childrenCount:

获取子节点数量。

# isValid:

判定节点是否可用:

this.node.isValid;

# 二. 基本方法

# getContentSize:

获取节点原始大小,不受该节点是否被缩放或者旋转的影响。

# setContentSize:

设置节点原始大小,不受该节点是否被缩放或者旋转的影响。

# getPosition:

获取节点在父节点坐标系中的位置(x, y)。

# setPosition:

设置节点在父节点坐标系中的位置。

# getScale:

获取节点的缩放。

# setScale:

设置节点的缩放比例,默认值为 1.0。

# getRotation:

获取该节点以局部坐标系 Z 轴为轴进行旋转的角度。

# setRotation:

设置该节点以局部坐标系 Z 轴为轴进行旋转的角度。

# getBoundingBox:

返回父节坐标系下的轴向对齐的包围盒。

# getBoundingBoxToWorld:

返回节点在世界坐标系下的对齐轴向的包围盒。

# convertToWorldSpace:

将一个相对于节点左下角的坐标位置转换到世界空间坐标系。

# convertToWorldSpaceAR:

将一个相对于节点锚点的坐标位置转换到世界空间坐标系。

# convertToNodeSpace:

将一个点转换到节点空间坐标系,这个坐标系以节点左下角为原点。

# convertToNodeSpaceAR:

将一个点转换到节点空间坐标系,这个坐标系以锚点为原点。


# 三. 操作查找相关方法

# getParent:

获取该节点的父节点。

# setParent:

设置该节点的父节点。

# addChild:

添加子节点。

# insertChild:

插入子节点到指定位置。

# removeChild:

移除节点中指定的子节点。

# removeAllChild:

移除节点所有的子节点。

# removeFromParent:

从父节点中删除该节点。

# getChildByName:

通过名称获取节点的子节点。

# getComponent:

获取节点上指定类型的组件。

# getComponents:

返回节点上指定类型的所有组件。

# addComponent:

向节点添加一个指定类型的组件类。

# removeComponent:

删除节点上的指定组件。

# cc.find:

通过访问路径来获取节点:

var node = cc.find("Canvas/bg");

通过指定节点下的路径获取节点:

var a = cc.find("bg/score",this.node);

# getChildByTag:

通过标签获取子节点:

var a = this.node.getChildByTag(1001);

# destroyAllChildren:

销毁所有子节点:

this.node.destroyAllChildren();

# cleanup:

停止所有正在播放的动作和计时器:

this.node.cleanup();

# getComponentsInChildren:

递归查找自身及所有子节点中指定类型的组件:

var sprites = this.node.getComponentsInChildren(cc.Label);

# getLocalZOrder:

获取节点层级:

var order = node.getLocalZOrder();

# setLocalZOrder:

设置节点层级:

var order = node.setLocalZOrder(1);

# pause:

暂停:

cc.director.pause();

# resume:

继续:

cc.director.resume();

# end:

退出整个应用:

cc.director.end();

# 四. 节点事件相关方法

# on:

在节点上注册指定类型的回调函数。

# once:

注册节点的特定事件类型回调,回调会在第一时间被触发后删除自身。

# off:

删除之前与同类型,回调,目标注册的回调。

# targetOff:

移除目标上的所有注册事件。

# emit:

通过事件名发送自定义事件。

# dispatchEvent:

分发事件到事件流中。

# pauseSystemEvents:

暂停当前节点上注册的所有节点系统事件,节点系统事件包含触摸和鼠标事件。

# resumeSystemEvents:

恢复当前节点上注册的所有节点系统事件,节点系统事件包含触摸和鼠标事件。


# 五. 节点动作相关方法

# runAction:

执行并返回该执行的动作。

# stopAction:

停止并移除指定的动作。

# stopAllActions:

停止并且移除所有正在运行的动作列表。

# pauseAllActions:

暂停本节点上所有正在运行的动作。

# resumeAllActions:

恢复运行本节点上所有暂停的动作。


# 六. 注意点

  • 节点的width,height代表节点原始大小(与getContentSize方法的结果一样),不受节点缩放旋转的影响;
  • 节点旋转后,自身的坐标系也会一起旋转。所以一些转换坐标的方法结果会有变化;
  • 一个空节点设置颜色是无效的,可以给空节点添加Sprite渲染组件;
  • 无论你的鼠标和触摸事件注册在哪个层级的节点上,获取到的位置坐标都是基于世界坐标系的;