CInterval¶
-
class
CInterval
¶ Bases:
TypedReferenceCount
The base class for timeline components. A CInterval represents a single action, event, or collection of nested intervals that will be performed at some specific time or over a period of time.
This is essentially similar to the Python “Interval” class, but it is implemented in C++ (hence the name). Intervals that may be implemented in C++ will inherit from this class; Intervals that must be implemented in Python will inherit from the similar Python class.
Inheritance diagram
-
enum
EventType
¶ -
enumerator
ET_initialize
= 0¶
-
enumerator
ET_instant
= 1¶
-
enumerator
ET_step
= 2¶
-
enumerator
ET_finalize
= 3¶
-
enumerator
ET_reverse_initialize
= 4¶
-
enumerator
ET_reverse_instant
= 5¶
-
enumerator
ET_reverse_finalize
= 6¶
-
enumerator
ET_interrupt
= 7¶
-
enumerator
-
enum
State
¶ -
enumerator
S_initial
= 0¶
-
enumerator
S_started
= 1¶
-
enumerator
S_paused
= 2¶
-
enumerator
S_final
= 3¶
-
enumerator
-
void
clear_to_initial
(void)¶ Pauses the interval, if it is playing, and resets its state to its initial state, abandoning any state changes already in progress in the middle of the interval. Calling this is like pausing the interval and discarding it, creating a new one in its place.
-
void
finish
(void)¶ Stops the interval from playing and sets it to its final state.
-
bool
get_auto_finish
(void) const¶ Returns the state of the ‘auto_finish’ flag. See
set_auto_finish()
.
-
bool
get_auto_pause
(void) const¶ Returns the state of the ‘auto_pause’ flag. See
set_auto_pause()
.
-
static TypeHandle
get_class_type
(void)¶
-
std::string const &
get_done_event
(void) const¶ Returns the event that is generated whenever the interval reaches its final state, whether it is explicitly finished or whether it gets there on its own.
-
double
get_duration
(void) const¶ Returns the duration of the interval in seconds.
-
CIntervalManager *
get_manager
(void) const¶ Returns the
CIntervalManager
object which will be responsible for playing this interval. Note that this can only return a C++ object; if the particularCIntervalManager
object has been extended in the scripting language, this will return the encapsulated C++ object, not the full extended object.
-
std::string const &
get_name
(void) const¶ Returns the interval’s name.
-
bool
get_open_ended
(void) const¶ Returns the state of the “open_ended” flag. This is primarily intended for instantaneous intervals like FunctionIntervals; it indicates true if the interval has some lasting effect that should be applied even if the interval doesn’t get started until after its finish time, or false if the interval is a transitive thing that doesn’t need to be called late.
-
double
get_play_rate
(void) const¶ Returns the play rate as set by the last call to
start()
,loop()
, orset_play_rate()
.
-
State
get_state
(void) const¶ Indicates the state the interval believes it is in: whether it has been started, is currently in the middle, or has been finalized.
-
double
get_t
(void) const¶ Returns the current time of the interval: the last value of t passed to
priv_initialize()
,priv_step()
, orpriv_finalize()
.
-
bool
get_wants_t_callback
(void) const¶ Returns the state of the ‘wants_t_callback’ flag. See
set_wants_t_callback()
.
-
bool
is_playing
(void) const¶ Returns true if the interval is currently playing, false otherwise.
-
bool
is_stopped
(void) const¶ Returns true if the interval is in either its initial or final states (but not in a running or paused state).
-
void
loop
(double start_t = 0.0, double end_t = -1.0, double play_rate = 1.0)¶ Starts the interval playing by registering it with the current
CIntervalManager
. The interval will play until it is interrupted withfinish()
orpause()
, looping back to start_t when it reaches end_t.If end_t is less than zero, it indicates the end of the interval.
-
virtual void
output
(std::ostream &out) const¶
-
double
pause
(void)¶ Stops the interval from playing but leaves it in its current state. It may later be resumed from this point by calling
resume()
.
-
void
priv_do_event
(double t, EventType event)¶ These cannot be declared private because they must be accessible to Python, but the method names are prefixed with priv_ to remind you that you probably don’t want to be using them directly.
Calls the appropriate event function indicated by the
EventType
.
-
virtual void
priv_finalize
(void)¶ This is called to stop an interval, forcing it to whatever state it would be after it played all the way through. It’s generally invoked by set_final_t().
-
virtual void
priv_initialize
(double t)¶ 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.
-
virtual void
priv_instant
(void)¶ 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.
-
virtual void
priv_interrupt
(void)¶ 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 topriv_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.
-
virtual void
priv_reverse_finalize
(void)¶ 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
(void)¶ 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.
-
virtual void
priv_step
(double t)¶ 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).
-
void
resume
(void)¶
-
void
resume
(double start_t)¶ Restarts the interval from its current point after a previous call to
pause()
.Restarts the interval from the indicated point after a previous call to
pause()
.
-
void
resume_until
(double end_t)¶ Restarts the interval from the current point after a previous call to
pause()
(or a previous play-to-point-and-stop), to play until the indicated point and then stop.
-
void
set_auto_finish
(bool auto_finish)¶ Changes the state of the ‘auto_finish’ flag. If this is true, the interval may be arbitrarily finished when the system needs to reset due to some external event by calling
CIntervalManager::interrupt()
. If this is false (the default), the interval must always be explicitly finished or paused.
-
void
set_auto_pause
(bool auto_pause)¶ Changes the state of the ‘auto_pause’ flag. If this is true, the interval may be arbitrarily interrupted when the system needs to reset due to some external event by calling
CIntervalManager::interrupt()
. If this is false (the default), the interval must always be explicitly finished or paused.
-
void
set_done_event
(std::string const &event)¶ Sets the event that is generated whenever the interval reaches its final state, whether it is explicitly finished or whether it gets there on its own.
-
void
set_manager
(CIntervalManager *manager)¶ Indicates the
CIntervalManager
object which will be responsible for playing this interval. This defaults to the globalCIntervalManager
; you should need to change this only if you have special requirements for playing this interval.
-
void
set_play_rate
(double play_rate)¶ Changes the play rate of the interval. If the interval is already started, this changes its speed on-the-fly. Note that since play_rate is a parameter to
start()
andloop()
, the next call tostart()
orloop()
will reset this parameter.
-
void
set_t
(double t)¶ Explicitly sets the time within the interval. Normally, you would use
start()
..finish()
to let the time play normally, but this may be used to set the time to some particular value.
-
void
set_wants_t_callback
(bool wants_t_callback)¶ Changes the state of the ‘wants_t_callback’ flag. If this is true, the interval will be returned by CIntervalManager::get_event() each time the interval’s time value has been changed, regardless of whether it has any external events.
-
void
setup_play
(double start_time, double end_time, double play_rate, bool do_loop)¶ Called to prepare the interval for automatic timed playback, e.g. via a Python task. The interval will be played from start_t to end_t, at a time factor specified by play_rate. start_t must always be less than end_t (except for the exception for end_t == -1, below), but if play_rate is negative the interval will be played backwards.
Specify end_t of -1 to play the entire interval from start_t.
Call
step_play()
repeatedly to execute the interval.
-
void
setup_resume
(void)¶ Called to prepare the interval for restarting at the current point within the interval after an interruption.
-
void
setup_resume_until
(double end_t)¶ Called to prepare the interval for restarting from the current point after a previous call to
pause()
(or a previous play-to-point-and-stop), to play until the indicated point and then stop.
-
void
start
(double start_t = 0.0, double end_t = -1.0, double play_rate = 1.0)¶ Starts the interval playing by registering it with the current
CIntervalManager
. The interval will play to the end and stop.If end_t is less than zero, it indicates the end of the interval.
-
bool
step_play
(void)¶ Should be called once per frame to execute the automatic timed playback begun with
setup_play()
.Returns true if the interval should continue, false if it is done and should stop.
-
virtual void
write
(std::ostream &out, int indent_level) const¶
-
enum