Panda3D
|
This interval contains a list of nested intervals, each of which has its own begin and end times. More...
#include "cMetaInterval.h"
Classes | |
class | EventQueueEntry |
class | IntervalDef |
class | PlaybackEvent |
Public Types | |
enum | DefType { DT_c_interval, DT_ext_index, DT_push_level, DT_pop_level } |
enum | RelativeStart { RS_previous_end, RS_previous_begin, RS_level_begin } |
Public Member Functions | |
CMetaInterval (const string &name) | |
int | add_c_interval (CInterval *c_interval, double rel_time=0.0f, RelativeStart rel_to=RS_previous_end) |
Adds a new CInterval to the list. | |
int | add_ext_index (int ext_index, const string &name, double duration, bool open_ended, double rel_time, RelativeStart rel_to) |
Adds a new external interval to the list. | |
void | clear_intervals () |
Resets the list of intervals and prepares for receiving a new list. | |
virtual TypeHandle | force_init_type () |
CInterval * | get_c_interval (int n) const |
Return the CInterval pointer associated with the nth interval definition. | |
DefType | get_def_type (int n) const |
Returns the type of the nth interval definition that has been added. | |
int | get_event_index () const |
If a previous call to is_event_ready() returned true, this returns the index number (added via add_event_index()) of the external interval that needs to be played. | |
double | get_event_t () const |
If a previous call to is_event_ready() returned true, this returns the t value that should be fed to the given interval. | |
EventType | get_event_type () const |
If a previous call to is_event_ready() returned true, this returns the type of the event (initialize, step, finalize, etc.) for the given interval. | |
int | get_ext_index (int n) const |
Return the external interval index number associated with the nth interval definition. | |
double | get_interval_end_time (const string &name) const |
Returns the actual end time, relative to the beginning of the interval, of the child interval with the given name, if found, or -1 if the interval is not found. | |
double | get_interval_start_time (const string &name) const |
Returns the actual start time, relative to the beginning of the interval, of the child interval with the given name, if found, or -1 if the interval is not found. | |
int | get_num_defs () const |
Returns the number of interval and push/pop definitions that have been added to the meta interval. | |
double | get_precision () const |
Returns the precision with which time measurements are compared. | |
virtual TypeHandle | get_type () const |
bool | is_event_ready () |
Returns true if a recent call to priv_initialize(), priv_step(), or priv_finalize() has left some external intervals ready to play. | |
void | pop_event () |
Acknowledges that the external interval on the top of the queue has been extracted, and is about to be serviced by the scripting language. | |
int | pop_level (double duration=-1.0) |
Finishes a level marked by a previous call to push_level(), and returns to the previous level. | |
virtual void | priv_finalize () |
This is called when an interval is interrupted. | |
virtual void | priv_initialize (double t) |
This replaces the first call to priv_step(), and indicates that the interval has just begun. | |
virtual void | priv_instant () |
This is called in lieu of priv_initialize() . | |
virtual void | priv_interrupt () |
This is called while the interval is playing to indicate that it is about to be interrupted; that is, priv_step() will not be called for a length of time. | |
virtual void | priv_reverse_finalize () |
Called generally following a priv_reverse_initialize(), this indicates the interval should set itself to the initial state. | |
virtual void | priv_reverse_initialize (double t) |
Similar to priv_initialize(), but this is called when the interval is being played backwards; it indicates that the interval should start at the finishing state and undo any intervening intervals. | |
virtual void | priv_reverse_instant () |
This is called in lieu of priv_reverse_initialize() | |
virtual void | priv_step (double t) |
Advances the time on the interval. | |
int | push_level (const string &name, double rel_time, RelativeStart rel_to) |
Marks the beginning of a nested level of child intervals. | |
bool | set_interval_start_time (const string &name, double rel_time, RelativeStart rel_to=RS_level_begin) |
Adjusts the start time of the child interval with the given name, if found. | |
void | set_precision (double precision) |
Indicates the precision with which time measurements are compared. | |
void | timeline (ostream &out) const |
Outputs a list of all events in the order in which they occur. | |
virtual void | write (ostream &out, int indent_level) const |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
This function is declared non-inline to work around a compiler bug in g++ 2.96. | |
Protected Member Functions | |
virtual void | do_recompute () |
Recomputes all of the events (and the duration) according to the set of interval defs. |
This interval contains a list of nested intervals, each of which has its own begin and end times.
Some of them may overlap and some of them may not.
Definition at line 34 of file cMetaInterval.h.
int CMetaInterval::add_c_interval | ( | CInterval * | c_interval, |
double | rel_time = 0.0f , |
||
RelativeStart | rel_to = RS_previous_end |
||
) |
Adds a new CInterval to the list.
The interval will be played when the indicated time (relative to the given point) has been reached.
The return value is the index of the def entry representing the new interval.
Definition at line 137 of file cMetaInterval.cxx.
References CInterval::mark_dirty().
int CMetaInterval::add_ext_index | ( | int | ext_index, |
const string & | name, | ||
double | duration, | ||
bool | open_ended, | ||
double | rel_time, | ||
RelativeStart | rel_to | ||
) |
Adds a new external interval to the list.
This represents some object in the external scripting language that has properties similar to a CInterval (for instance, a Python Interval object).
The CMetaInterval object cannot play this external interval directly, but it records a placeholder for it and will ask the scripting language to play it when it is time, via is_event_ready() and related methods.
The ext_index number itself is simply a handle that the scripting language makes up and associates with its interval object somehow. The CMetaInterval object does not attempt to interpret this value.
The return value is the index of the def entry representing the new interval.
Definition at line 178 of file cMetaInterval.cxx.
References CInterval::mark_dirty().
void CMetaInterval::clear_intervals | ( | ) |
Resets the list of intervals and prepares for receiving a new list.
Definition at line 59 of file cMetaInterval.cxx.
void CMetaInterval::do_recompute | ( | ) | [protected, virtual] |
Recomputes all of the events (and the duration) according to the set of interval defs.
Reimplemented from CInterval.
Definition at line 820 of file cMetaInterval.cxx.
CInterval * CMetaInterval::get_c_interval | ( | int | n | ) | const [inline] |
Return the CInterval pointer associated with the nth interval definition.
It is only valid to call this if get_def_type(n) returns DT_c_interval.
Definition at line 77 of file cMetaInterval.I.
CMetaInterval::DefType CMetaInterval::get_def_type | ( | int | n | ) | const [inline] |
Returns the type of the nth interval definition that has been added.
Definition at line 64 of file cMetaInterval.I.
int CMetaInterval::get_event_index | ( | ) | const [inline] |
If a previous call to is_event_ready() returned true, this returns the index number (added via add_event_index()) of the external interval that needs to be played.
Definition at line 120 of file cMetaInterval.I.
double CMetaInterval::get_event_t | ( | ) | const [inline] |
If a previous call to is_event_ready() returned true, this returns the t value that should be fed to the given interval.
Definition at line 136 of file cMetaInterval.I.
CInterval::EventType CMetaInterval::get_event_type | ( | ) | const [inline] |
If a previous call to is_event_ready() returned true, this returns the type of the event (initialize, step, finalize, etc.) for the given interval.
Definition at line 149 of file cMetaInterval.I.
int CMetaInterval::get_ext_index | ( | int | n | ) | const [inline] |
Return the external interval index number associated with the nth interval definition.
It is only valid to call this if get_def_type(n) returns DT_ext_index.
Definition at line 91 of file cMetaInterval.I.
double CMetaInterval::get_interval_end_time | ( | const string & | name | ) | const |
Returns the actual end time, relative to the beginning of the interval, of the child interval with the given name, if found, or -1 if the interval is not found.
Definition at line 318 of file cMetaInterval.cxx.
References CInterval::recompute().
double CMetaInterval::get_interval_start_time | ( | const string & | name | ) | const |
Returns the actual start time, relative to the beginning of the interval, of the child interval with the given name, if found, or -1 if the interval is not found.
Definition at line 281 of file cMetaInterval.cxx.
References CInterval::recompute().
int CMetaInterval::get_num_defs | ( | ) | const [inline] |
Returns the number of interval and push/pop definitions that have been added to the meta interval.
Definition at line 53 of file cMetaInterval.I.
double CMetaInterval::get_precision | ( | ) | const [inline] |
Returns the precision with which time measurements are compared.
See set_precision().
Definition at line 41 of file cMetaInterval.I.
static void CMetaInterval::init_type | ( | ) | [inline, static] |
This function is declared non-inline to work around a compiler bug in g++ 2.96.
Making it inline seems to cause problems in the optimizer.
Reimplemented from CInterval.
Definition at line 191 of file cMetaInterval.h.
References CInterval::init_type().
bool CMetaInterval::is_event_ready | ( | ) | [inline] |
Returns true if a recent call to priv_initialize(), priv_step(), or priv_finalize() has left some external intervals ready to play.
If this returns true, call get_event_index(), get_event_t(), and pop_event() to retrieve the relevant information.
Definition at line 107 of file cMetaInterval.I.
Referenced by CIntervalManager::get_next_event().
void CMetaInterval::pop_event | ( | ) |
Acknowledges that the external interval on the top of the queue has been extracted, and is about to be serviced by the scripting language.
This prepares the interval so the next call to is_event_ready() will return information about the next external interval on the queue, if any.
Definition at line 725 of file cMetaInterval.cxx.
int CMetaInterval::pop_level | ( | double | duration = -1.0 | ) |
Finishes a level marked by a previous call to push_level(), and returns to the previous level.
If the duration is not negative, it represents a phony duration to assign to the level, for the purposes of sequencing later intervals. Otherwise, the level's duration is computed based on the intervals within the level.
Definition at line 210 of file cMetaInterval.cxx.
References CInterval::mark_dirty().
void CMetaInterval::priv_finalize | ( | ) | [virtual] |
This is called when an interval is interrupted.
It should advance the time as if priv_step() were called, and also perform whatever cleanup might be required.
Reimplemented from CInterval.
Definition at line 519 of file cMetaInterval.cxx.
References CInterval::get_duration(), CInterval::interval_done(), and priv_initialize().
void CMetaInterval::priv_initialize | ( | double | t | ) | [virtual] |
This replaces the first call to priv_step(), and indicates that the interval has just begun.
This may be overridden by derived classes that need to do some explicit initialization on the first call.
Reimplemented from CInterval.
Definition at line 358 of file cMetaInterval.cxx.
References CInterval::check_stopped(), and CInterval::recompute().
Referenced by priv_finalize(), and priv_reverse_finalize().
void CMetaInterval::priv_instant | ( | ) | [virtual] |
This is called in lieu of priv_initialize() .
. priv_step() .. priv_finalize(), when everything is to happen within one frame. The interval should initialize itself, then leave itself in the final state.
Reimplemented from CInterval.
Definition at line 413 of file cMetaInterval.cxx.
References CInterval::check_stopped(), CInterval::get_duration(), CInterval::interval_done(), and CInterval::recompute().
void CMetaInterval::priv_interrupt | ( | ) | [virtual] |
This is called while the interval is playing to indicate that it is about to be interrupted; that is, priv_step() will not be called for a length of time.
But the interval should remain in its current state in anticipation of being eventually restarted when the calls to priv_step() eventually resume.
The purpose of this function is to allow self-running intervals like sound intervals to stop the actual sound playback during the pause.
Reimplemented from CInterval.
Definition at line 695 of file cMetaInterval.cxx.
void CMetaInterval::priv_reverse_finalize | ( | ) | [virtual] |
Called generally following a priv_reverse_initialize(), this indicates the interval should set itself to the initial state.
Reimplemented from CInterval.
Definition at line 653 of file cMetaInterval.cxx.
References priv_initialize().
void CMetaInterval::priv_reverse_initialize | ( | double | t | ) | [virtual] |
Similar to priv_initialize(), but this is called when the interval is being played backwards; it indicates that the interval should start at the finishing state and undo any intervening intervals.
Reimplemented from CInterval.
Definition at line 562 of file cMetaInterval.cxx.
References CInterval::check_stopped(), and CInterval::recompute().
void CMetaInterval::priv_reverse_instant | ( | ) | [virtual] |
This is called in lieu of priv_reverse_initialize()
. priv_step() .. priv_reverse_finalize(), when everything is to happen within one frame. The interval should initialize itself, then leave itself in the initial state.
Reimplemented from CInterval.
Definition at line 618 of file cMetaInterval.cxx.
References CInterval::check_stopped(), and CInterval::recompute().
void CMetaInterval::priv_step | ( | double | t | ) | [virtual] |
Advances the time on the interval.
The time may either increase (the normal case) or decrease (e.g. if the interval is being played by a slider).
Reimplemented from CInterval.
Definition at line 454 of file cMetaInterval.cxx.
References CInterval::check_started().
int CMetaInterval::push_level | ( | const string & | name, |
double | rel_time, | ||
RelativeStart | rel_to | ||
) |
Marks the beginning of a nested level of child intervals.
Within the nested level, a RelativeStart time of RS_level_begin refers to the start of the level, and the first interval added within the level is always relative to the start of the level.
The return value is the index of the def entry created by this push.
Definition at line 111 of file cMetaInterval.cxx.
References CInterval::mark_dirty().
bool CMetaInterval::set_interval_start_time | ( | const string & | name, |
double | rel_time, | ||
CMetaInterval::RelativeStart | rel_to = RS_level_begin |
||
) |
Adjusts the start time of the child interval with the given name, if found.
This may be either a C++ interval added via add_c_interval(), or an external interval added via add_ext_index(); the name must match exactly.
If the interval is found, its start time is adjusted, and all subsequent intervals are adjusting accordingly, and true is returned. If a matching interval is not found, nothing is changed and false is returned.
Definition at line 240 of file cMetaInterval.cxx.
References CInterval::mark_dirty().
void CMetaInterval::set_precision | ( | double | precision | ) | [inline] |
Indicates the precision with which time measurements are compared.
For numerical accuracy, all floating-point time values are converted to integer values internally by scaling by the precision factor. The larger the number given here, the smaller the delta of time that can be differentiated; the limit is the maximum integer that can be represented in the system.
Definition at line 29 of file cMetaInterval.I.
References CInterval::mark_dirty().
void CMetaInterval::timeline | ( | ostream & | out | ) | const |
Outputs a list of all events in the order in which they occur.
Definition at line 773 of file cMetaInterval.cxx.
References CInterval::recompute().