mirror of https://github.com/axmolengine/axmol.git
551 lines
20 KiB
C++
551 lines
20 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
Copyright (c) 2011 Zynga Inc.
|
|
Copyright (c) 2013-2017 Chukong Technologies 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 __CCSCHEDULER_H__
|
|
#define __CCSCHEDULER_H__
|
|
|
|
#include <functional>
|
|
#include <mutex>
|
|
#include <set>
|
|
|
|
#include "base/CCRef.h"
|
|
#include "base/CCVector.h"
|
|
#include "base/uthash.h"
|
|
|
|
NS_CC_BEGIN
|
|
|
|
class Scheduler;
|
|
|
|
typedef std::function<void(float)> ccSchedulerFunc;
|
|
|
|
/**
|
|
* @cond
|
|
*/
|
|
class CC_DLL Timer : public Ref
|
|
{
|
|
protected:
|
|
Timer();
|
|
public:
|
|
void setupTimerWithInterval(float seconds, unsigned int repeat, float delay);
|
|
void setAborted() { _aborted = true; }
|
|
bool isAborted() const { return _aborted; }
|
|
bool isExhausted() const;
|
|
|
|
virtual void trigger(float dt) = 0;
|
|
virtual void cancel() = 0;
|
|
|
|
/** triggers the timer */
|
|
void update(float dt);
|
|
|
|
protected:
|
|
Scheduler* _scheduler; // weak ref
|
|
float _elapsed;
|
|
bool _runForever;
|
|
bool _useDelay;
|
|
unsigned int _timesExecuted;
|
|
unsigned int _repeat; //0 = once, 1 is 2 x executed
|
|
float _delay;
|
|
float _interval;
|
|
bool _aborted;
|
|
};
|
|
|
|
|
|
class CC_DLL TimerTargetSelector : public Timer
|
|
{
|
|
public:
|
|
TimerTargetSelector();
|
|
|
|
/** Initializes a timer with a target, a selector and an interval in seconds, repeat in number of times to repeat, delay in seconds. */
|
|
bool initWithSelector(Scheduler* scheduler, SEL_SCHEDULE selector, Ref* target, float seconds, unsigned int repeat, float delay);
|
|
|
|
SEL_SCHEDULE getSelector() const { return _selector; }
|
|
|
|
virtual void trigger(float dt) override;
|
|
virtual void cancel() override;
|
|
|
|
protected:
|
|
Ref* _target;
|
|
SEL_SCHEDULE _selector;
|
|
};
|
|
|
|
|
|
class CC_DLL TimerTargetCallback : public Timer
|
|
{
|
|
public:
|
|
TimerTargetCallback();
|
|
|
|
// Initializes a timer with a target, a lambda and an interval in seconds, repeat in number of times to repeat, delay in seconds.
|
|
bool initWithCallback(Scheduler* scheduler, const ccSchedulerFunc& callback, void *target, const std::string& key, float seconds, unsigned int repeat, float delay);
|
|
|
|
const ccSchedulerFunc& getCallback() const { return _callback; }
|
|
const std::string& getKey() const { return _key; }
|
|
|
|
virtual void trigger(float dt) override;
|
|
virtual void cancel() override;
|
|
|
|
protected:
|
|
void* _target;
|
|
ccSchedulerFunc _callback;
|
|
std::string _key;
|
|
};
|
|
|
|
#if CC_ENABLE_SCRIPT_BINDING
|
|
|
|
class CC_DLL TimerScriptHandler : public Timer
|
|
{
|
|
public:
|
|
bool initWithScriptHandler(int handler, float seconds);
|
|
int getScriptHandler() const { return _scriptHandler; }
|
|
|
|
virtual void trigger(float dt) override;
|
|
virtual void cancel() override;
|
|
|
|
private:
|
|
int _scriptHandler;
|
|
};
|
|
|
|
#endif
|
|
|
|
/**
|
|
* @endcond
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup base
|
|
* @{
|
|
*/
|
|
|
|
struct _listEntry;
|
|
struct _hashSelectorEntry;
|
|
struct _hashUpdateEntry;
|
|
|
|
#if CC_ENABLE_SCRIPT_BINDING
|
|
class SchedulerScriptHandlerEntry;
|
|
#endif
|
|
|
|
/** @brief Scheduler is responsible for triggering the scheduled callbacks.
|
|
You should not use system timer for your game logic. Instead, use this class.
|
|
|
|
There are 2 different types of callbacks (selectors):
|
|
|
|
- update selector: the 'update' selector will be called every frame. You can customize the priority.
|
|
- custom selector: A custom selector will be called every frame, or with a custom interval of time
|
|
|
|
The 'custom selectors' should be avoided when possible. It is faster, and consumes less memory to use the 'update selector'.
|
|
|
|
*/
|
|
class CC_DLL Scheduler : public Ref
|
|
{
|
|
public:
|
|
/** Priority level reserved for system services.
|
|
* @lua NA
|
|
* @js NA
|
|
*/
|
|
static const int PRIORITY_SYSTEM;
|
|
|
|
/** Minimum priority level for user scheduling.
|
|
* Priority level of user scheduling should bigger then this value.
|
|
*
|
|
* @lua NA
|
|
* @js NA
|
|
*/
|
|
static const int PRIORITY_NON_SYSTEM_MIN;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @js ctor
|
|
*/
|
|
Scheduler();
|
|
|
|
/**
|
|
* Destructor
|
|
*
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~Scheduler();
|
|
|
|
/**
|
|
* Gets the time scale of schedule callbacks.
|
|
* @see Scheduler::setTimeScale()
|
|
*/
|
|
float getTimeScale() { return _timeScale; }
|
|
/** Modifies the time of all scheduled callbacks.
|
|
You can use this property to create a 'slow motion' or 'fast forward' effect.
|
|
Default is 1.0. To create a 'slow motion' effect, use values below 1.0.
|
|
To create a 'fast forward' effect, use values higher than 1.0.
|
|
@since v0.8
|
|
@warning It will affect EVERY scheduled selector / action.
|
|
*/
|
|
void setTimeScale(float timeScale) { _timeScale = timeScale; }
|
|
|
|
/** 'update' the scheduler.
|
|
* You should NEVER call this method, unless you know what you are doing.
|
|
* @lua NA
|
|
*/
|
|
void update(float dt);
|
|
|
|
/////////////////////////////////////
|
|
|
|
// schedule
|
|
|
|
/** The scheduled method will be called every 'interval' seconds.
|
|
If paused is true, then it won't be called until it is resumed.
|
|
If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdate' instead.
|
|
If the 'callback' is already scheduled, then only the interval parameter will be updated without re-scheduling it again.
|
|
repeat let the action be repeated repeat + 1 times, use CC_REPEAT_FOREVER to let the action run continuously
|
|
delay is the amount of time the action will wait before it'll start.
|
|
@param callback The callback function.
|
|
@param target The target of the callback function.
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every frame.
|
|
@param repeat repeat+1 times to schedule the callback.
|
|
@param delay Schedule call back after `delay` seconds. If the value is not 0, the first schedule will happen after `delay` seconds.
|
|
But it will only affect first schedule. After first schedule, the delay time is determined by `interval`.
|
|
@param paused Whether or not to pause the schedule.
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
@since v3.0
|
|
*/
|
|
void schedule(const ccSchedulerFunc& callback, void *target, float interval, unsigned int repeat, float delay, bool paused, const std::string& key);
|
|
|
|
/** The scheduled method will be called every 'interval' seconds for ever.
|
|
@param callback The callback function.
|
|
@param target The target of the callback function.
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every frame.
|
|
@param paused Whether or not to pause the schedule.
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
@since v3.0
|
|
*/
|
|
void schedule(const ccSchedulerFunc& callback, void *target, float interval, bool paused, const std::string& key);
|
|
|
|
|
|
/** The scheduled method will be called every `interval` seconds.
|
|
If paused is true, then it won't be called until it is resumed.
|
|
If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdate' instead.
|
|
If the selector is already scheduled, then only the interval parameter will be updated without re-scheduling it again.
|
|
repeat let the action be repeated repeat + 1 times, use CC_REPEAT_FOREVER to let the action run continuously
|
|
delay is the amount of time the action will wait before it'll start
|
|
|
|
@param selector The callback function.
|
|
@param target The target of the callback function.
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every frame.
|
|
@param repeat repeat+1 times to schedule the callback.
|
|
@param delay Schedule call back after `delay` seconds. If the value is not 0, the first schedule will happen after `delay` seconds.
|
|
But it will only affect first schedule. After first schedule, the delay time is determined by `interval`.
|
|
@param paused Whether or not to pause the schedule.
|
|
@since v3.0
|
|
*/
|
|
void schedule(SEL_SCHEDULE selector, Ref *target, float interval, unsigned int repeat, float delay, bool paused);
|
|
|
|
/** The scheduled method will be called every `interval` seconds for ever.
|
|
@param selector The callback function.
|
|
@param target The target of the callback function.
|
|
@param interval The interval to schedule the callback. If the value is 0, then the callback will be scheduled every frame.
|
|
@param paused Whether or not to pause the schedule.
|
|
*/
|
|
void schedule(SEL_SCHEDULE selector, Ref *target, float interval, bool paused);
|
|
|
|
/** Schedules the 'update' selector for a given target with a given priority.
|
|
The 'update' selector will be called every frame.
|
|
The lower the priority, the earlier it is called.
|
|
@since v3.0
|
|
@lua NA
|
|
*/
|
|
template <class T>
|
|
void scheduleUpdate(T *target, int priority, bool paused)
|
|
{
|
|
this->schedulePerFrame([target](float dt){
|
|
target->update(dt);
|
|
}, target, priority, paused);
|
|
}
|
|
|
|
#if CC_ENABLE_SCRIPT_BINDING
|
|
// Schedule for script bindings.
|
|
/** The scheduled script callback will be called every 'interval' seconds.
|
|
If paused is true, then it won't be called until it is resumed.
|
|
If 'interval' is 0, it will be called every frame.
|
|
return schedule script entry ID, used for unscheduleScriptFunc().
|
|
|
|
@warn Don't invoke this function unless you know what you are doing.
|
|
@js NA
|
|
@lua NA
|
|
*/
|
|
unsigned int scheduleScriptFunc(unsigned int handler, float interval, bool paused);
|
|
#endif
|
|
/////////////////////////////////////
|
|
|
|
// unschedule
|
|
|
|
/** Unschedules a callback for a key and a given target.
|
|
If you want to unschedule the 'callbackPerFrame', use unscheduleUpdate.
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
@param target The target to be unscheduled.
|
|
@since v3.0
|
|
*/
|
|
void unschedule(const std::string& key, void *target);
|
|
|
|
/** Unschedules a selector for a given target.
|
|
If you want to unschedule the "update", use `unscheduleUpdate()`.
|
|
@param selector The selector that is unscheduled.
|
|
@param target The target of the unscheduled selector.
|
|
@since v3.0
|
|
*/
|
|
void unschedule(SEL_SCHEDULE selector, Ref *target);
|
|
|
|
/** Unschedules the update selector for a given target
|
|
@param target The target to be unscheduled.
|
|
@since v0.99.3
|
|
*/
|
|
void unscheduleUpdate(void *target);
|
|
|
|
/** Unschedules all selectors for a given target.
|
|
This also includes the "update" selector.
|
|
@param target The target to be unscheduled.
|
|
@since v0.99.3
|
|
@lua NA
|
|
*/
|
|
void unscheduleAllForTarget(void *target);
|
|
|
|
/** Unschedules all selectors from all targets.
|
|
You should NEVER call this method, unless you know what you are doing.
|
|
@since v0.99.3
|
|
*/
|
|
void unscheduleAll();
|
|
|
|
/** Unschedules all selectors from all targets with a minimum priority.
|
|
You should only call this with `PRIORITY_NON_SYSTEM_MIN` or higher.
|
|
@param minPriority The minimum priority of selector to be unscheduled. Which means, all selectors which
|
|
priority is higher than minPriority will be unscheduled.
|
|
@since v2.0.0
|
|
*/
|
|
void unscheduleAllWithMinPriority(int minPriority);
|
|
|
|
#if CC_ENABLE_SCRIPT_BINDING
|
|
/** Unschedule a script entry.
|
|
* @warning Don't invoke this function unless you know what you are doing.
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
void unscheduleScriptEntry(unsigned int scheduleScriptEntryID);
|
|
#endif
|
|
|
|
/////////////////////////////////////
|
|
|
|
// isScheduled
|
|
|
|
/** Checks whether a callback associated with 'key' and 'target' is scheduled.
|
|
@param key The key to identify the callback function, because there is not way to identify a std::function<>.
|
|
@param target The target of the callback.
|
|
@return True if the specified callback is invoked, false if not.
|
|
@since v3.0.0
|
|
*/
|
|
bool isScheduled(const std::string& key, void *target) const;
|
|
|
|
/** Checks whether a selector for a given target is scheduled.
|
|
@param selector The selector to be checked.
|
|
@param target The target of the callback.
|
|
@return True if the specified selector is invoked, false if not.
|
|
@since v3.0
|
|
*/
|
|
bool isScheduled(SEL_SCHEDULE selector, Ref *target) const;
|
|
|
|
/////////////////////////////////////
|
|
|
|
/** Pauses the target.
|
|
All scheduled selectors/update for a given target won't be 'ticked' until the target is resumed.
|
|
If the target is not present, nothing happens.
|
|
@param target The target to be paused.
|
|
@since v0.99.3
|
|
*/
|
|
void pauseTarget(void *target);
|
|
|
|
/** Resumes the target.
|
|
The 'target' will be unpaused, so all schedule selectors/update will be 'ticked' again.
|
|
If the target is not present, nothing happens.
|
|
@param target The target to be resumed.
|
|
@since v0.99.3
|
|
*/
|
|
void resumeTarget(void *target);
|
|
|
|
/** Returns whether or not the target is paused.
|
|
* @param target The target to be checked.
|
|
* @return True if the target is paused, false if not.
|
|
* @since v1.0.0
|
|
* @lua NA
|
|
*/
|
|
bool isTargetPaused(void *target);
|
|
|
|
/** Pause all selectors from all targets.
|
|
You should NEVER call this method, unless you know what you are doing.
|
|
@since v2.0.0
|
|
*/
|
|
std::set<void*> pauseAllTargets();
|
|
|
|
/** Pause all selectors from all targets with a minimum priority.
|
|
You should only call this with PRIORITY_NON_SYSTEM_MIN or higher.
|
|
@param minPriority The minimum priority of selector to be paused. Which means, all selectors which
|
|
priority is higher than minPriority will be paused.
|
|
@since v2.0.0
|
|
*/
|
|
std::set<void*> pauseAllTargetsWithMinPriority(int minPriority);
|
|
|
|
/** Resume selectors on a set of targets.
|
|
This can be useful for undoing a call to pauseAllSelectors.
|
|
@param targetsToResume The set of targets to be resumed.
|
|
@since v2.0.0
|
|
*/
|
|
void resumeTargets(const std::set<void*>& targetsToResume);
|
|
|
|
/** Calls a function on the cocos2d thread. Useful when you need to call a cocos2d function from another thread.
|
|
This function is thread safe.
|
|
@param function The function to be run in cocos2d thread.
|
|
@since v3.0
|
|
@js NA
|
|
*/
|
|
void performFunctionInCocosThread(std::function<void()> function);
|
|
|
|
/**
|
|
* Remove all pending functions queued to be performed with Scheduler::performFunctionInCocosThread
|
|
* Functions unscheduled in this manner will not be executed
|
|
* This function is thread safe
|
|
* @since v3.14
|
|
* @js NA
|
|
*/
|
|
void removeAllFunctionsToBePerformedInCocosThread();
|
|
|
|
/////////////////////////////////////
|
|
|
|
// Deprecated methods:
|
|
|
|
/** The scheduled method will be called every 'interval' seconds.
|
|
If paused is true, then it won't be called until it is resumed.
|
|
If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdateForTarget:' instead.
|
|
If the selector is already scheduled, then only the interval parameter will be updated without re-scheduling it again.
|
|
repeat let the action be repeated repeat + 1 times, use CC_REPEAT_FOREVER to let the action run continuously
|
|
delay is the amount of time the action will wait before it'll start
|
|
@deprecated Please use `Scheduler::schedule` instead.
|
|
@since v0.99.3, repeat and delay added in v1.1
|
|
@js NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE void scheduleSelector(SEL_SCHEDULE selector, Ref *target, float interval, unsigned int repeat, float delay, bool paused)
|
|
{
|
|
schedule(selector, target, interval, repeat, delay, paused);
|
|
}
|
|
|
|
/** Calls scheduleSelector with CC_REPEAT_FOREVER and a 0 delay.
|
|
* @deprecated Please use `Scheduler::schedule` instead.
|
|
* @js NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE void scheduleSelector(SEL_SCHEDULE selector, Ref *target, float interval, bool paused)
|
|
{
|
|
schedule(selector, target, interval, paused);
|
|
}
|
|
|
|
/** Schedules the 'update' selector for a given target with a given priority.
|
|
The 'update' selector will be called every frame.
|
|
The lower the priority, the earlier it is called.
|
|
@deprecated Please use 'Scheduler::scheduleUpdate' instead.
|
|
@since v0.99.3
|
|
*/
|
|
template <class T>
|
|
CC_DEPRECATED_ATTRIBUTE void scheduleUpdateForTarget(T* target, int priority, bool paused) { scheduleUpdate(target, priority, paused); };
|
|
|
|
/** Unschedule a selector for a given target.
|
|
If you want to unschedule the "update", use unscheduleUpdateForTarget.
|
|
@deprecated Please use 'Scheduler::unschedule' instead.
|
|
@since v0.99.3
|
|
@js NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE void unscheduleSelector(SEL_SCHEDULE selector, Ref *target) { unschedule(selector, target); };
|
|
|
|
/** Checks whether a selector for a given target is scheduled.
|
|
@deprecated Please use 'Scheduler::isScheduled' instead.
|
|
@since v0.99.3
|
|
@js NA
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE bool isScheduledForTarget(Ref *target, SEL_SCHEDULE selector) { return isScheduled(selector, target); };
|
|
|
|
/** Unschedules the update selector for a given target
|
|
@deprecated Please use 'Scheduler::unscheduleUpdate' instead.
|
|
@since v0.99.3
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE void unscheduleUpdateForTarget(Ref *target) { return unscheduleUpdate(target); };
|
|
|
|
protected:
|
|
|
|
/** Schedules the 'callback' function for a given target with a given priority.
|
|
The 'callback' selector will be called every frame.
|
|
The lower the priority, the earlier it is called.
|
|
@note This method is only for internal use.
|
|
@since v3.0
|
|
@js _schedulePerFrame
|
|
*/
|
|
void schedulePerFrame(const ccSchedulerFunc& callback, void *target, int priority, bool paused);
|
|
|
|
void removeHashElement(struct _hashSelectorEntry *element);
|
|
void removeUpdateFromHash(struct _listEntry *entry);
|
|
|
|
// update specific
|
|
|
|
void priorityIn(struct _listEntry **list, const ccSchedulerFunc& callback, void *target, int priority, bool paused);
|
|
void appendIn(struct _listEntry **list, const ccSchedulerFunc& callback, void *target, bool paused);
|
|
|
|
|
|
float _timeScale;
|
|
|
|
//
|
|
// "updates with priority" stuff
|
|
//
|
|
struct _listEntry *_updatesNegList; // list of priority < 0
|
|
struct _listEntry *_updates0List; // list priority == 0
|
|
struct _listEntry *_updatesPosList; // list priority > 0
|
|
struct _hashUpdateEntry *_hashForUpdates; // hash used to fetch quickly the list entries for pause,delete,etc
|
|
std::vector<struct _listEntry *> _updateDeleteVector; // the vector holds list entries that needs to be deleted after update
|
|
|
|
// Used for "selectors with interval"
|
|
struct _hashSelectorEntry *_hashForTimers;
|
|
struct _hashSelectorEntry *_currentTarget;
|
|
bool _currentTargetSalvaged;
|
|
// If true unschedule will not remove anything from a hash. Elements will only be marked for deletion.
|
|
bool _updateHashLocked;
|
|
|
|
#if CC_ENABLE_SCRIPT_BINDING
|
|
Vector<SchedulerScriptHandlerEntry*> _scriptHandlerEntries;
|
|
#endif
|
|
|
|
// Used for "perform Function"
|
|
std::vector<std::function<void()>> _functionsToPerform;
|
|
std::mutex _performMutex;
|
|
};
|
|
|
|
// end of base group
|
|
/** @} */
|
|
|
|
NS_CC_END
|
|
|
|
#endif // __CCSCHEDULER_H__
|