cocos2d-X 节点(CCActionManager.h)API

本文来自http://blog.csdn.net/runaying ,引用必须注明出处!

cocos2d-X 节点(CCActionManager.h)API

温馨提醒:为了大家能更好学习,强烈推荐大家看看本人的这篇博客 Cocos2d-X权威指南笔记

///cocos2d-x-3.0alpha0/cocos2dx/actions
/****************************************************************************
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2008-2010 Ricardo Quesada
Copyright (c) 2009      Valentin Milea
Copyright (c) 2011      Zynga Inc.

http://www.cocos2d-x.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/

#ifndef __ACTION_CCACTION_MANAGER_H__
#define __ACTION_CCACTION_MANAGER_H__

#include "CCAction.h"
#include "cocoa/CCArray.h"
#include "cocoa/CCObject.h"

NS_CC_BEGIN

class Set;

struct _hashElement;

/**
 * @addtogroup actions
 * @{
 */

/** 
 @brief ActionManager 是一个管理所有 actions 的单例.
 正常情况下你不直接使用这个单例,99% 的情况是你希望使用这个节点的接口
 
 但是有一些情况你或许需要使用这个单例
 Examples:
    - 你希望你的 action 运行在不同的不同的节点
    - 你希望 pause / resume  actions
 
 @since v0.8
 */
class CC_DLL ActionManager : public Object
{
public:
    /**
     * @js ctor
     */
    ActionManager(void);
    /**
     * @js NA
     * @lua NA
     */
    ~ActionManager(void);

    // actions
    
    /** 使用 target 添加一个 action. 
     如果这个 target 已经存在,那么 action 将添加到这个已经存在的 target上
     如果这个 target 不存在, 那么这个 target 的实例会创建,其它的 target 暂停或者不暂停;同时这个 action 会被添加到最近创建的 target 列表里面
     当这个 target 暂停时,这个 actions 队列不会被'ticked'(选择)
     */
    void addAction(Action *pAction, Node *target, bool paused);

    /** 从 targets 里面移除所有 actions
    */
    void removeAllActions(void);

    /** Removes 某个 target 所对应的所有 action
    这个 target 所拥有的所有 action 都会被移除
     */
    void removeAllActionsFromTarget(Object *target);

    /** Removes 指定引用所对应的 action
    */
    void removeAction(Action *pAction);

    /** Removes target 下某个 tag 所对应的 action */
    void removeActionByTag(int tag, Object *target);

    /** Gets  target 下某个 tag 所对应的 action
     @return 制定 tag 所对应的 action
      */
    Action* getActionByTag(int tag, const Object *target) const;

    /** Returns 正在运行的 target 数目
     * 有效的 actions 可能时 1 action. Example:
     * - 如果你正在运行的有 1 个包含 7 个 actions 的序列, 他会返回 1
     * - 如果你正在运行的有 7 个包含 1 个 actions 的序列, 他会返回 7.
     */
    unsigned int getNumberOfRunningActionsInTarget(const Object *target) const;

    /** @过时不再需要建议使用新的 API 可以使用 getNumberOfRunningActionsInTarget() 代替 */
    CC_DEPRECATED_ATTRIBUTE inline unsigned int numberOfRunningActionsInTarget(Object *target) const { return getNumberOfRunningActionsInTarget(target); }

    /** Pauses  target: 所有正在运行的 action 和新添加的 action 都会被暂停
    */
    void pauseTarget(Object *target);

    /** Resumes  target. 所有 actions 队列都会重新开始.
    */
    void resumeTarget(Object *target);
    
    /** Pauses 所有的 actions, returning 一个反应谁的 target 所对应的 actions 暂停了的清单
     */
    Set* pauseAllRunningActions();
    
    /** Resume 一个 targets 的 set (pauseAllRunningActions 是一个和他相反的函数)
     */
    void resumeTargets(Set *targetsToResume);

protected:
    // 在 ActionManager.m 声明的

    void removeActionAtIndex(int index, struct _hashElement *pElement);
    void deleteHashElement(struct _hashElement *pElement);
    void actionAllocWithHashElement(struct _hashElement *pElement);
    void update(float dt);

protected:
    struct _hashElement    *_targets;
    struct _hashElement    *_currentTarget;
    bool            _currentTargetSalvaged;
};

// end of actions group
/// @}

NS_CC_END

#endif // __ACTION_CCACTION_MANAGER_H__



你可能感兴趣的:(cocos2d,cocos2dx,cocos2d-x)