cocos代码研究(1)Node学习笔记

时间:2021-12-10 05:20:49

理论部分

Node类继承自Ref类,是cocos框架中基础底层的一个封装类,与画面渲染相关的类一般都是继承自该类,例如Scene,Layer,Sprite,Sprite3D,Label,SpriteBatchNode,MenuItem,ClippingNode,DrawNode,ParticleBatchNode, ParticleSystem等都是继承自Node类。

代码部分

父子节点关系API

virtual void addChild (Node *child)
添加一个子节点到容器内,z-order是0.

virtual void addChild (Node *child, int localZOrder)
添加一个子节点到容器中,参数有一个局部Z轴顺序。

virtual void addChild (Node *child, int localZOrder, int tag)
添加一个子节点到容器中,有Z轴顺序和一个标记。

virtual void addChild (Node *child, int localZOrder, const std::string &name)
添加一个子节点到容器中,有Z轴顺序和一个名称。

virtual Node * getChildByTag (int tag) const
从容器中通过标记得到对应的子节点。

virtual Node * getChildByName (const std::string &name) const
从容器中通过名字得到对应的子节点。

virtual void setParent (Node *parent)
设置节点的父节点。

virtual Node * getParent ()
返回指向父节点的指针。

virtual Vector< Node * > & getChildren ()
返回所有子节点的数组。

virtual ssize_t getChildrenCount () const
返回子节点的总数。

virtual void removeFromParent ()
当前节点从父节点中移除,如无父节点则变化。

virtual void removeFromParentAndCleanup (bool cleanup)
当前节点从父节点中移除并设置是否清除。

virtual void removeChild (Node *child, bool cleanup=true)
从容器中移除一个子节点,并设置是否清除。

virtual void removeChildByTag (int tag, bool cleanup=true)
通过tag移除一个子节点,并设置是否清除。

virtual void removeChildByName (const std::string &name, bool cleanup=true)
通过名字移除一个子节点,并设置是否清除。

virtual void removeAllChildren ()
从容器中移除所有的子节点,并清除所有动作和回调。

virtual void removeAllChildrenWithCleanup (bool cleanup)
从容器中移除所有的子节点, 并设置是否清除。

virtual void reorderChild (Node *child, int localZOrder)
对一个孩子设定一个新的z轴值并重新排序。

virtual void sortAllChildren ()
在绘画之前,排列所有的孩子数组一次,而不是每次添加或者删除子节点时都排序。 这个方法可以大幅度地提高性能。

template<typename T >
T getChildByName (const std::string &name) const
通过名字获得一个子节点对象,并且这个节点对象可以被转换为类型T。

virtual void enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
在子节点中寻找匹配名字或正则表达式的节点并对这些节点执行回调函数。

标签和用户数据

virtual int getTag () const
返回一个用来更简单分辨节点的标记。

virtual void setTag (int tag)
改变这个用来分辨节点的标记。

virtual std::string getName () const
返回用于识别节点的名字。

virtual void setName (const std::string &name)
设置用于识别节点的名字。

virtual void setUserData (void *userData)
设置一个用户自定义数据的指针

virtual void * getUserData ()
返回一个用户自定义数据的指针

图形属性设置相关API

virtual void setAnchorPoint (const Vec2 &anchorPoint)
设置锚点,用百分比表示。

virtual const Vec2 & getAnchorPoint () const
返回用百分比表示的锚点。

virtual void ignoreAnchorPointForPosition (bool ignore)
设置当前节点的锚点为(0, 0)。

virtual bool isIgnoreAnchorPointForPosition () const
判断当前节点的锚点是否为默认(0,0)

virtual void setPosition (const Vec2 &position)
设置当前节点在父节点中的位置。

virtual const Vec2 & getPosition () const
得到当前节点在父节点中的位置。

virtual void setPositionX (float x)
设置当前节点在父节点X坐标

virtual float getPositionX (void) const
获取当前节点在父节点X坐标

virtual void setPositionY (float y)
设置当前节点在父节点Y坐标

virtual float getPositionY (void) const
获取当前节点在父节点Y坐标

virtual void setZOrder (int localZOrder)
设置当前节点的局部Z顺序

virtual int getZOrder () const
得到当前节点的局部Z顺序

virtual void setContentSize (const Size &contentSize)
设置不转换节点的大小。

virtual const Size & getContentSize () const
返回节点未变形状态下的大小。

virtual void setVisible (bool visible)
设置节点是否可见。

virtual bool isVisible () const
判断节点是否可见。

virtual void setScale (float scale)
设置该节点的缩放因子。

virtual float getScale () const
得到该节点的缩放因子。

virtual void setScaleX (float scaleX)
设置节点的缩放(x)。

virtual float getScaleX () const
返回该节点的X轴的缩放因子。

virtual void setScaleY (float scaleY)
设置节点的缩放(y)。

virtual float getScaleY () const
返回该节点的Y轴的缩放因子。

virtual void setScaleZ (float scaleZ)
改变该节点的Z轴的缩放因子。

virtual float getScaleZ () const
返回该节点的Z轴的缩放因子。

virtual void setGlobalZOrder (float globalZOrder)
设置当前节点的全局Z顺序

virtual float getGlobalZOrder () const
返回当前节点的全局Z顺序。

virtual void setPosition3D (const Vec3 &position)
设置当前节点在父节点3D坐标。

virtual Vec3 getPosition3D () const
获取当前节点在父节点3D坐标。

virtual void setPositionZ (float positionZ)
设置当前节点在父节点z坐标

virtual float getPositionZ () const
获取当前节点在父节点z坐标

virtual void setSkewX (float skewX)
改变该节点X轴的倾斜角,单位是度。

virtual float getSkewX () const
返回该节点的X轴倾斜角,单位是度。

virtual void setSkewY (float skewY)
改变该节点Y轴的倾斜角,单位是度。

virtual float getSkewY () const
返回该节点的Y轴倾斜角,单位是度。

virtual void setRotation (float rotation)
设置节点的旋转角度。

virtual float getRotation () const
返回节点的旋转角度。

virtual void setRotation3D (const Vec3 &rotation)
设置3D(X,Y,Z)旋转角度。

virtual Vec3 getRotation3D () const
获取(X,Y,Z)的旋转角度。

virtual void setRotationX (float rotationX)
设置X轴节点的旋转角度。

virtual float getRotationX () const
得到X轴节点的旋转角度。

virtual void setRotationY (float rotationY)
设置节点Y轴的旋转角度。

virtual float getRotationY () const
获得节点Y轴的旋转角度。

int getOrderOfArrival () const
返回到达顺序,指出哪一个子类先被添加。

virtual const Vec2 & getAnchorPointInPoints () const
返回锚点的绝对像素位置

void setGLServerState (int serverState)
int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
设置抹点为(0,0)当你摆放这个节点的时候。

virtual void setNormalizedPosition (const Vec2 &position)
设置归一化位置坐标(x, y),使用从0到1的归一化值。

virtual const Vec2 & getNormalizedPosition () const
得到在父节点坐标系中节点归一化的位置(x,y)。

virtual void setRotationQuat (const Quaternion &quat)
通过四元数来设置3D空间中的旋转角度。你要保证四元数是经过归一化的。

virtual Quaternion getRotationQuat () const
获取四元数表达的3D空间旋转角度。

节点执行动作API

virtual void setActionManager (ActionManager *actionManager)
给当前节点设置动作全局管理单例对象。

virtual ActionManager * getActionManager ()
得到当前节点的动作全局管理单例对象。

virtual Action * runAction (Action *action)
当前节点执行一个动作。

void stopAllActions ()
移除当前节点所有执行动作。

void stopAction (Action *action)
移除当前节点指定动作。

void stopActionByTag (int tag)
根据动作标识,移除当前节点指定动作。

void stopAllActionsByTag (int tag)
通过动作的标记从活动动作列表中删除动作。

Action * getActionByTag (int tag)
通过动作的标记从活动动作列表中得到一个动作。

计时回调和事件回调API

void schedule (SEL_SCHEDULE selector)
调度一个自定义的选择器,这个选择器将逐帧被调用。

void schedule (SEL_SCHEDULE selector, float interval)
调度一个自定义的选择器,以指定一个设定的时间间隔被调用,单位秒。

void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
调度一个自定义的选择器,intrerval间隔时间(秒),repeat调用次数,delay延时起效。

void schedule (const std::function< void(float)> &callback, const std::string &key)
调度一个自定义的lambda回调函数,这个回调函数将会每帧被调用,key为调度器标记。

void schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
调度一个lambda回调函数,并指定调度的时间间隔(以秒为单位),key调度器标记。

void schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
调度一个lambda回调函数

void unschedule (SEL_SCHEDULE selector)
取消调度一个自定义的选择器。

void unschedule (const std::string &key)
通过key标记取消调度一个lambda回调函数

virtual void setScheduler (Scheduler *scheduler)
设置一个调度器对象来用于调度所有的“update”和定时器。

virtual Scheduler * getScheduler ()
得到调度器对象。

bool isScheduled (SEL_SCHEDULE selector)
检查一个选择器是否在调度中。

bool isScheduled (const std::string &key)
检查一个lambda函数是否在调度中。

void scheduleUpdate (void)
调度"update"方法。

virtual void update (float delta)
scheduleUpdate默认的指定的回调方法,逐帧调用。

void scheduleUpdateWithPriority (int priority)
使用一个自定义优先级调度"update"方法。

void unscheduleUpdate (void)
停止并取消调度update方法

void scheduleOnce (SEL_SCHEDULE selector, float delay)
调度一个只运行一次的选择器,伴随着一个0或者更大的延时。

void scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
调度一个只运行一次的lambda回调函数,伴随着一个0或者更大的延时和一个key来标记这个回调。

void unscheduleAllCallbacks ()
取消调度所有选择器和回调函数,以及update调度。

virtual void resume (void)
恢复所有的调度过的选择器,动作和事件监听器。 这个方法被onEnter方法在内部调用。

virtual void pause (void)
暂停所有的调度过的选择器,动作和事件监听器。 这个方法被onExit方法在内部调用。

void resumeSchedulerAndActions ()
恢复所有的调度过的选择器,动作和事件监听器。 这个方法被onEnter方法在内部调用。

void pauseSchedulerAndActions ()
暂停所有的调度过的选择器,动作和事件监听器。 这个方法被onExit方法在内部调用。