axmol/cocos2dx/include/CCActionManager.h

/****************************************************************************
Copyright (c) 2010 cocos2d-x.org

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 "NSMutableArray.h"
#include "NSObject.h"
#include "ccxCommon.h"
#include "selector_protocol.h"

namespace cocos2d {

/** 
 @brief CCActionManager is a singleton that manages all the actions.
 Normally you won't need to use this singleton directly. 99% of the cases you will use the CCNode interface,
 which uses this singleton.
 But there are some cases where you might need to use this singleton.
 Examples:
	- When you want to run an action where the target is different from a CCNode. 
	- When you want to pause / resume the actions
 
 @since v0.8
 */
struct _hashElement;
class CCX_DLL CCActionManager : public NSObject, public SelectorProtocol
{
public:
	CCActionManager(void);
	~CCActionManager(void);
	bool init(void);

    // actions
    
	/** Adds an action with a target.
	 If the target is already present, then the action will be added to the existing target.
	 If the target is not present, a new instance of this target will be created either paused or paused, and the action will be added to the newly created target.
	 When the target is paused, the queued actions won't be 'ticked'.
	 */
	void addAction(CCAction *pAction, CCNode *pTarget, bool paused);

    /** Removes all actions from all the targers.
    */
	void removeAllActions(void);

    /** Removes all actions from a certain target.
	 All the actions that belongs to the target will be removed.
	 */
	void removeAllActionsFromTarget(NSObject *pTarget);

    /** Removes an action given an action reference.
    */
	void removeAction(CCAction *pAction);

    /** Removes an action given its tag and the target */
	void removeActionByTag(int tag, NSObject *pTarget);

	/** Gets an action given its tag an a target
	 @return the Action the with the given tag
	 */
	CCAction* getActionByTag(int tag, NSObject *pTarget);

    /** Returns the numbers of actions that are running in a certain target
	 * 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.
	 */
	int numberOfRunningActionsInTarget(NSObject *pTarget);

    /** Pauses the target: all running actions and newly added actions will be paused.
	*/
	void pauseTarget(NSObject *pTarget);

    /** Resumes the target. All queued actions will be resumed.
	*/
	void resumeTarget(NSObject *pTarget);

    /** Resumes the target. All queued actions will be resumed.
	 @deprecated Use resumeTarget: instead. Will be removed in v1.0.
	 */
	void resumeAllActionsForTarget(NSObject *pTarget);

	/** Pauses the target: all running actions and newly added actions will be paused.
	*/
	void pauseAllActionsForTarget(NSObject *pTarget);

	/** purges the shared action manager. It releases the retained instance.
	 * because it uses this, so it can not be static
	 @since v0.99.0
	 */
	void purgeSharedManager(void);

	// SelectorProtocol methods

	virtual void selectorProtocolRetain(void);
	virtual void selectorProtocolRelease(void);
 
public:
	/** returns a shared instance of the CCActionManager */
	static CCActionManager* getSharedManager(void);

protected:
	// declared in CCActionManager.m

	void removeActionAtIndex(unsigned int uIndex, struct _hashElement *pElement);
    void deleteHashElement(struct _hashElement *pElement);
	void actionAllocWithHashElement(struct _hashElement *pElement);
	void update(ccTime dt);

protected:
	struct _hashElement	*m_pTargets;
	struct _hashElement	*m_pCurrentTarget;
	bool			m_bCurrentTargetSalvaged;
};

}

#endif // __ACTION_CCACTION_MANAGER_H__