2012-04-19 14:35:52 +08:00
|
|
|
/****************************************************************************
|
2012-09-24 21:22:20 +08:00
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
2012-04-19 14:35:52 +08:00
|
|
|
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"
|
2013-10-14 14:01:00 +08:00
|
|
|
#include "CCArray.h"
|
|
|
|
#include "CCObject.h"
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
NS_CC_BEGIN
|
|
|
|
|
2013-06-20 14:13:12 +08:00
|
|
|
class Set;
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
struct _hashElement;
|
2012-06-20 18:09:11 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup actions
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2010-09-28 18:27:33 +08:00
|
|
|
/**
|
2013-06-20 14:13:12 +08:00
|
|
|
@brief ActionManager 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 Node interface,
|
2010-08-05 14:37:36 +08:00
|
|
|
which uses this singleton.
|
|
|
|
But there are some cases where you might need to use this singleton.
|
|
|
|
Examples:
|
2013-06-20 14:13:12 +08:00
|
|
|
- When you want to run an action where the target is different from a Node.
|
2012-04-19 14:35:52 +08:00
|
|
|
- When you want to pause / resume the actions
|
2010-08-05 14:37:36 +08:00
|
|
|
|
|
|
|
@since v0.8
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
class CC_DLL ActionManager : public Object
|
2012-04-19 14:35:52 +08:00
|
|
|
{
|
|
|
|
public:
|
2013-09-13 16:46:31 +08:00
|
|
|
/**
|
|
|
|
* @js ctor
|
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
ActionManager(void);
|
2013-09-13 13:52:42 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
~ActionManager(void);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
// 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 not, and the action will be added to the newly created target.
|
|
|
|
When the target is paused, the queued actions won't be 'ticked'.
|
|
|
|
*/
|
2013-07-18 07:56:19 +08:00
|
|
|
void addAction(Action *pAction, Node *target, bool paused);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2010-09-29 17:39:45 +08:00
|
|
|
/** Removes all actions from all the targets.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
|
|
|
void removeAllActions(void);
|
|
|
|
|
2010-08-05 14:37:36 +08:00
|
|
|
/** Removes all actions from a certain target.
|
2012-04-19 14:35:52 +08:00
|
|
|
All the actions that belongs to the target will be removed.
|
|
|
|
*/
|
2013-07-18 07:56:19 +08:00
|
|
|
void removeAllActionsFromTarget(Object *target);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2010-08-05 14:37:36 +08:00
|
|
|
/** Removes an action given an action reference.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
void removeAction(Action *pAction);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
/** Removes an action given its tag and the target */
|
2013-08-29 03:42:25 +08:00
|
|
|
void removeActionByTag(int tag, Object *target);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
/** Gets an action given its tag an a target
|
|
|
|
@return the Action the with the given tag
|
|
|
|
*/
|
2013-08-29 03:42:25 +08:00
|
|
|
Action* getActionByTag(int tag, const Object *target) const;
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2010-09-29 17:39:45 +08:00
|
|
|
/** Returns the numbers of actions that are running in a certain target.
|
2012-04-19 14:35:52 +08:00
|
|
|
* 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.
|
|
|
|
*/
|
2013-12-05 17:19:01 +08:00
|
|
|
int getNumberOfRunningActionsInTarget(const Object *target) const;
|
2013-07-18 07:56:19 +08:00
|
|
|
|
|
|
|
/** @deprecated use getNumberOfRunningActionsInTarget() instead */
|
2013-12-05 17:19:01 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE inline int numberOfRunningActionsInTarget(Object *target) const { return getNumberOfRunningActionsInTarget(target); }
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2010-08-05 14:37:36 +08:00
|
|
|
/** Pauses the target: all running actions and newly added actions will be paused.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-07-18 07:56:19 +08:00
|
|
|
void pauseTarget(Object *target);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2010-08-05 14:37:36 +08:00
|
|
|
/** Resumes the target. All queued actions will be resumed.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-07-18 07:56:19 +08:00
|
|
|
void resumeTarget(Object *target);
|
2012-06-08 13:55:28 +08:00
|
|
|
|
|
|
|
/** Pauses all running actions, returning a list of targets whose actions were paused.
|
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
Set* pauseAllRunningActions();
|
2012-06-08 13:55:28 +08:00
|
|
|
|
|
|
|
/** Resume a set of targets (convenience function to reverse a pauseAllRunningActions call)
|
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
void resumeTargets(Set *targetsToResume);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
protected:
|
2013-06-20 14:13:12 +08:00
|
|
|
// declared in ActionManager.m
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2013-12-05 17:19:01 +08:00
|
|
|
void removeActionAtIndex(int index, struct _hashElement *pElement);
|
2012-04-19 14:35:52 +08:00
|
|
|
void deleteHashElement(struct _hashElement *pElement);
|
|
|
|
void actionAllocWithHashElement(struct _hashElement *pElement);
|
2012-06-08 13:55:28 +08:00
|
|
|
void update(float dt);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
protected:
|
2013-06-15 14:03:30 +08:00
|
|
|
struct _hashElement *_targets;
|
|
|
|
struct _hashElement *_currentTarget;
|
|
|
|
bool _currentTargetSalvaged;
|
2012-04-19 14:35:52 +08:00
|
|
|
};
|
|
|
|
|
2012-06-20 18:09:11 +08:00
|
|
|
// end of actions group
|
|
|
|
/// @}
|
|
|
|
|
2012-04-19 14:35:52 +08:00
|
|
|
NS_CC_END
|
|
|
|
|
|
|
|
#endif // __ACTION_CCACTION_MANAGER_H__
|