This object holds a number of currently-playing intervals and is responsible for advancing them each frame as needed. More...
#include "cIntervalManager.h"
Public Member Functions | |
| int | add_c_interval (CInterval *interval, bool external) |
| Adds the interval to the manager, and returns a unique index for the interval. More... | |
| int | find_c_interval (const std::string &name) const |
| Returns the index associated with the named interval, if there is such an interval, or -1 if there is not. More... | |
| CInterval * | get_c_interval (int index) const |
| Returns the interval associated with the given index. More... | |
| EventQueue * | get_event_queue () const |
| Returns the custom event queue to be used for throwing done events from intervals as they finish. More... | |
| int | get_max_index () const |
| Returns one more than the largest interval index number in the manager. More... | |
| int | get_next_event () |
| This should be called by the scripting language after each call to step(). More... | |
| int | get_next_removal () |
| This should be called by the scripting language after each call to step(). More... | |
| int | get_num_intervals () const |
| Returns the number of currently active intervals. More... | |
| int | interrupt () |
| Pauses or finishes (removes from the active queue) all intervals tagged with auto_pause or auto_finish set to true. More... | |
| void | output (std::ostream &out) const |
| void | remove_c_interval (int index) |
| Removes the indicated interval from the queue immediately. More... | |
| void | set_event_queue (EventQueue *event_queue) |
| Specifies a custom event queue to be used for throwing done events from intervals as they finish. More... | |
| void | step () |
| This should be called every frame to do the processing for all the active intervals. More... | |
| void | write (std::ostream &out) const |
Static Public Member Functions | |
| static CIntervalManager * | get_global_ptr () |
| Returns the pointer to the one global CIntervalManager object. More... | |
This object holds a number of currently-playing intervals and is responsible for advancing them each frame as needed.
There is normally only one IntervalManager object in the world, and it is the responsibility of the scripting language to call step() on this object once each frame, and to then process the events indicated by get_next_event().
It is also possible to create multiple IntervalManager objects for special needs.
Definition at line 39 of file cIntervalManager.h.
| int CIntervalManager::add_c_interval | ( | CInterval * | interval, |
| bool | external | ||
| ) |
Adds the interval to the manager, and returns a unique index for the interval.
This index will be unique among all the currently added intervals, but not unique across all intervals ever added to the manager. The maximum index value will never exceed the maximum number of intervals added at any given time.
If the external flag is true, the interval is understood to also be stored in the scripting language data structures. In this case, it will be available for information returned by get_next_event() and get_next_removal(). If external is false, the interval's index will never be returned by these two functions.
Definition at line 54 of file cIntervalManager.cxx.
References CInterval::get_name.
Referenced by CInterval::loop(), CInterval::resume(), CInterval::resume_until(), and CInterval::start().
| int CIntervalManager::find_c_interval | ( | const std::string & | name | ) | const |
Returns the index associated with the named interval, if there is such an interval, or -1 if there is not.
Definition at line 111 of file cIntervalManager.cxx.
Referenced by CInterval::finish(), and CInterval::pause().
| CInterval * CIntervalManager::get_c_interval | ( | int | index | ) | const |
Returns the interval associated with the given index.
Definition at line 125 of file cIntervalManager.cxx.
|
inline |
Returns the custom event queue to be used for throwing done events from intervals as they finish.
Definition at line 33 of file cIntervalManager.I.
|
static |
Returns the pointer to the one global CIntervalManager object.
Definition at line 397 of file cIntervalManager.cxx.
| int CIntervalManager::get_max_index | ( | ) | const |
Returns one more than the largest interval index number in the manager.
If you walk through all the values between (0, get_max_index()] and call get_c_interval() on each number, you will retrieve all of the managed intervals (and possibly a number of NULL pointers as well).
Definition at line 240 of file cIntervalManager.cxx.
| int CIntervalManager::get_next_event | ( | ) |
This should be called by the scripting language after each call to step().
It returns the index number of the next interval that has events requiring servicing by the scripting language, or -1 if no more intervals have any events pending.
If this function returns something other than -1, it is the scripting language's responsibility to query the indicated interval for its next event via get_event_index(), and eventually pop_event().
Then get_next_event() should be called again until it returns -1.
Definition at line 297 of file cIntervalManager.cxx.
| int CIntervalManager::get_next_removal | ( | ) |
This should be called by the scripting language after each call to step().
It returns the index number of an interval that was recently removed, or -1 if no intervals were removed.
If this returns something other than -1, the scripting language should clean up its own data structures accordingly, and then call get_next_removal() again.
Definition at line 332 of file cIntervalManager.cxx.
| int CIntervalManager::get_num_intervals | ( | ) | const |
Returns the number of currently active intervals.
Definition at line 227 of file cIntervalManager.cxx.
| int CIntervalManager::interrupt | ( | ) |
Pauses or finishes (removes from the active queue) all intervals tagged with auto_pause or auto_finish set to true.
These are intervals that someone fired up but won't necessarily expect to clean up; they can be interrupted at will when necessary.
Returns the number of intervals affected.
Definition at line 164 of file cIntervalManager.cxx.
| void CIntervalManager::remove_c_interval | ( | int | index | ) |
Removes the indicated interval from the queue immediately.
It will not be returned from get_next_removal(), and none of its pending events, if any, will be returned by get_next_event().
Definition at line 138 of file cIntervalManager.cxx.
Referenced by CInterval::finish(), and CInterval::pause().
|
inline |
Specifies a custom event queue to be used for throwing done events from intervals as they finish.
If this is not specified, the global event queue is used.
The caller maintains ownership of the EventQueue object; it is the caller's responsibility to ensure that the supplied EventQueue does not destruct during the lifetime of the CIntervalManager.
Definition at line 24 of file cIntervalManager.I.
| void CIntervalManager::step | ( | ) |
This should be called every frame to do the processing for all the active intervals.
It will call step_play() for each interval that has been added and that has not yet been removed.
After each call to step(), the scripting language should call get_next_event() and get_next_removal() repeatedly to process all the high- level (e.g. Python-interval-based) events and to manage the high-level list of intervals.
Definition at line 257 of file cIntervalManager.cxx.
1.8.15