The base class for a family of intervals that constrain some property to a value over time. More...
#include "cConstraintInterval.h"
Inheritance diagram for CConstraintInterval:
Public Member Functions | |
| CConstraintInterval (const std::string &name, double duration) | |
| virtual TypeHandle | force_init_type () |
| virtual TypeHandle | get_type () const |
 Public Member Functions inherited from CInterval | |
| CInterval (const std::string &name, double duration, bool open_ended) | |
| bool | check_t_callback () |
| Returns true if the wants_t_callback() flag is true and the interval's t value has changed since the last call to check_t_callback(), false otherwise. More... | |
| void | clear_to_initial () |
| 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. More... | |
| void | finish () |
| Stops the interval from playing and sets it to its final state. More... | |
| bool | get_auto_finish () const |
| bool | get_auto_pause () const |
| const std::string & | get_done_event () const |
| double | get_duration () const |
| CIntervalManager * | get_manager () const |
| const std::string & | get_name () const |
| bool | get_open_ended () const |
| double | get_play_rate () const |
| State | get_state () const |
| double | get_t () const |
| bool | get_wants_t_callback () const |
| Returns the state of the 'wants_t_callback' flag. More... | |
| bool | is_playing () const |
| bool | is_stopped () const |
| 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. More... | |
| void | mark_dirty () |
| Called by a derived class to indicate the interval has been changed internally and must be recomputed before its duration may be returned. More... | |
| virtual void | output (std::ostream &out) const |
| double | pause () |
| Stops the interval from playing but leaves it in its current state. More... | |
| void | priv_do_event (double t, EventType event) |
| Calls the appropriate event function indicated by the EventType. More... | |
| virtual void | priv_finalize () |
| This is called to stop an interval, forcing it to whatever state it would be after it played all the way through. More... | |
| virtual void | priv_initialize (double t) |
| This replaces the first call to priv_step(), and indicates that the interval has just begun. More... | |
| virtual void | priv_instant () |
| This is called in lieu of priv_initialize() . More... | |
| 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. More... | |
| virtual void | priv_reverse_finalize () |
| Called generally following a priv_reverse_initialize(), this indicates the interval should set itself to the initial state. More... | |
| 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. More... | |
| virtual void | priv_reverse_instant () |
| This is called in lieu of priv_reverse_initialize() . More... | |
| virtual void | priv_step (double t) |
| Advances the time on the interval. More... | |
| void | resume () |
| Restarts the interval from its current point after a previous call to pause(). More... | |
| void | resume (double start_t) |
| Restarts the interval from the indicated point after a previous call to pause(). More... | |
| 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. More... | |
| void | set_auto_finish (bool auto_finish) |
| void | set_auto_pause (bool auto_pause) |
| void | set_done_event (const std::string &event) |
| void | set_manager (CIntervalManager *manager) |
| void | set_play_rate (double play_rate) |
| void | set_t (double t) |
| void | set_wants_t_callback (bool wants_t_callback) |
| Changes the state of the 'wants_t_callback' flag. More... | |
| 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. More... | |
| void | setup_resume () |
| Called to prepare the interval for restarting at the current point within the interval after an interruption. More... | |
| 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. More... | |
| 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. More... | |
| bool | step_play () |
| Should be called once per frame to execute the automatic timed playback begun with setup_play(). More... | |
| virtual void | write (std::ostream &out, int indent_level) const |
| Public Member Functions inherited from TypedReferenceCount | |
| TypedReferenceCount (const TypedReferenceCount ©) | |
| void | operator= (const TypedReferenceCount ©) |
| Public Member Functions inherited from TypedObject | |
| TypedObject (const TypedObject ©)=default | |
| TypedObject * | as_typed_object () |
| Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
| const TypedObject * | as_typed_object () const |
| Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
| int | get_best_parent_from_Set (const std::set< int > &) const |
| int | get_type_index () const |
| Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
| bool | is_exact_type (TypeHandle handle) const |
| Returns true if the current object is the indicated type exactly. More... | |
| bool | is_of_type (TypeHandle handle) const |
| Returns true if the current object is or derives from the indicated type. More... | |
| TypedObject & | operator= (const TypedObject ©)=default |
| Public Member Functions inherited from ReferenceCount | |
| int | get_ref_count () const |
| WeakReferenceList * | get_weak_list () const |
| Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
| bool | has_weak_list () const |
| Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
| void | local_object () |
| This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
| void | ref () const |
| Explicitly increments the reference count. More... | |
| bool | ref_if_nonzero () const |
| Atomically increases the reference count of this object if it is not zero. More... | |
| bool | test_ref_count_integrity () const |
| Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
| bool | test_ref_count_nonzero () const |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
| virtual bool | unref () const |
| Explicitly decrements the reference count. More... | |
| WeakReferenceList * | weak_ref () |
| Adds the indicated PointerToVoid as a weak reference to this object. More... | |
| void | weak_unref () |
| Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from CInterval | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from TypedReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from TypedObject | |
| 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. More... | |
| Static Public Member Functions inherited from ReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
Public Attributes | |
| bool | bogus_variable |
| Public Attributes inherited from CInterval | |
| get_auto_finish | |
| Returns the state of the 'auto_finish' flag. More... | |
| get_auto_pause | |
| Returns the state of the 'auto_pause' flag. More... | |
| get_done_event | |
| 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. More... | |
| get_duration | |
| Returns the duration of the interval in seconds. More... | |
| get_manager | |
| Returns the CIntervalManager object which will be responsible for playing this interval. More... | |
| get_name | |
| Returns the interval's name. More... | |
| get_open_ended | |
| Returns the state of the "open_ended" flag. More... | |
| get_play_rate | |
| Returns the play rate as set by the last call to start(), loop(), or set_play_rate(). More... | |
| get_state | |
| Indicates the state the interval believes it is in: whether it has been started, is currently in the middle, or has been finalized. More... | |
| get_t | |
| Returns the current time of the interval: the last value of t passed to priv_initialize(), priv_step(), or priv_finalize(). More... | |
| is_playing | |
| Returns true if the interval is currently playing, false otherwise. More... | |
| is_stopped | |
| Returns true if the interval is in either its initial or final states (but not in a running or paused state). More... | |
| set_auto_finish | |
| Changes the state of the 'auto_finish' flag. More... | |
| set_auto_pause | |
| Changes the state of the 'auto_pause' flag. More... | |
| set_done_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. More... | |
| set_manager | |
| Indicates the CIntervalManager object which will be responsible for playing this interval. More... | |
| set_play_rate | |
| Changes the play rate of the interval. More... | |
| set_t | |
| Explicitly sets the time within the interval. More... | |
| Public Attributes inherited from TypedObject | |
| get_type | |
| Public Attributes inherited from ReferenceCount | |
| get_ref_count | |
| Returns the current reference count. More... | |
Additional Inherited Members | |
| Public Types inherited from CInterval | |
| enum | EventType { ET_initialize, ET_instant, ET_step, ET_finalize, ET_reverse_initialize, ET_reverse_instant, ET_reverse_finalize, ET_interrupt } |
| enum | State { S_initial, S_started, S_paused, S_final } |
Detailed Description
The base class for a family of intervals that constrain some property to a value over time.
Definition at line 24 of file cConstraintInterval.h.
The documentation for this class was generated from the following files:
- direct/src/interval/cConstraintInterval.h
- direct/src/interval/cConstraintInterval.cxx
