Initial commit (version 0.2.1)

1 files changed, 111 insertions, 0 deletions

@@ -0,0 +1,111 @@
+/*
+ * cocos2d for iPhone: http://www.cocos2d-iphone.org
+ *
+ * Copyright (c) 2009 Valentin Milea
+ *
+ * Copyright (c) 2008-2010 Ricardo Quesada
+ * Copyright (c) 2011 Zynga Inc.
+ *
+ * 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.
+ *
+ */
+
+
+#import "CCAction.h"
+#import "Support/ccCArray.h"
+#import "Support/uthash.h"
+
+typedef struct _hashElement
+{
+        struct ccArray  *actions;
+        id                              target;
+        NSUInteger              actionIndex;
+        CCAction                *currentAction;
+        BOOL                    currentActionSalvaged;
+        BOOL                    paused; 
+        UT_hash_handle  hh;
+} tHashElement;
+
+
+/** 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
+ */
+@interface CCActionManager : NSObject
+{
+        tHashElement    *targets;
+        tHashElement    *currentTarget;
+        BOOL                    currentTargetSalvaged;
+}
+
+/** returns a shared instance of the CCActionManager */
++ (CCActionManager *)sharedManager;
+
+/** purges the shared action manager. It releases the retained instance.
+ @since v0.99.0
+ */
++(void)purgeSharedManager;
+
+// 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*) action target:(id)target paused:(BOOL)paused;
+/** Removes all actions from all the targers.
+ */
+-(void) removeAllActions;
+
+/** Removes all actions from a certain target.
+ All the actions that belongs to the target will be removed.
+ */
+-(void) removeAllActionsFromTarget:(id)target;
+/** Removes an action given an action reference.
+ */
+-(void) removeAction: (CCAction*) action;
+/** Removes an action given its tag and the target */
+-(void) removeActionByTag:(NSInteger)tag target:(id)target;
+/** Gets an action given its tag an a target
+ @return the Action the with the given tag
+ */
+-(CCAction*) getActionByTag:(NSInteger) tag target:(id)target;
+/** 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.
+ */
+-(NSUInteger) numberOfRunningActionsInTarget:(id)target;
+
+/** Pauses the target: all running actions and newly added actions will be paused.
+ */
+-(void) pauseTarget:(id)target;
+/** Resumes the target. All queued actions will be resumed.
+ */
+-(void) resumeTarget:(id)target;
+
+@end
+