Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CInterval Class Reference

The base class for timeline components. More...

Inheritance diagram for CInterval:
TypedReferenceCount TypedObject ReferenceCount CConstraintInterval CLerpInterval CMetaInterval HideInterval ShowInterval WaitInterval CConstrainHprInterval CConstrainPosHprInterval CConstrainPosInterval CConstrainTransformInterval CLerpAnimEffectInterval CLerpNodePathInterval MetaInterval Wait

Public Types

enum  EventType {
  ET_initialize = 0, ET_instant = 1, ET_step = 2, ET_finalize = 3,
  ET_reverse_initialize = 4, ET_reverse_instant = 5, ET_reverse_finalize = 6, ET_interrupt = 7
}
 
enum  State { S_initial = 0, S_started = 1, S_paused = 2, S_final = 3 }
 

Public Member Functions

 __init__ (const CInterval)
 
 clearToInitial ()
 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...
 
 finish ()
 Stops the interval from playing and sets it to its final state. More...
 
bool getAutoFinish ()
 Returns the state of the 'auto_finish' flag. More...
 
bool getAutoPause ()
 Returns the state of the 'auto_pause' flag. More...
 
str getDoneEvent ()
 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...
 
double getDuration ()
 Returns the duration of the interval in seconds. More...
 
CIntervalManager getManager ()
 Returns the CIntervalManager object which will be responsible for playing this interval. More...
 
str getName ()
 Returns the interval's name. More...
 
bool getOpenEnded ()
 Returns the state of the "open_ended" flag. More...
 
double getPlayRate ()
 Returns the play rate as set by the last call to start(), loop(), or set_play_rate(). More...
 
CInterval::State getState ()
 Indicates the state the interval believes it is in: whether it has been started, is currently in the middle, or has been finalized. More...
 
double getT ()
 Returns the current time of the interval: the last value of t passed to priv_initialize(), priv_step(), or priv_finalize(). More...
 
bool getWantsTCallback ()
 Returns the state of the 'wants_t_callback' flag. More...
 
bool isPlaying ()
 Returns true if the interval is currently playing, false otherwise. More...
 
bool isStopped ()
 Returns true if the interval is in either its initial or final states (but not in a running or paused state). More...
 
 loop (double start_t, double end_t, double play_rate)
 Starts the interval playing by registering it with the current CIntervalManager. More...
 
 output (Ostream out)
 
double pause ()
 Stops the interval from playing but leaves it in its current state. More...
 
 privDoEvent (double t, CInterval::EventType event)
 
 privFinalize ()
 This is called to stop an interval, forcing it to whatever state it would be after it played all the way through. More...
 
 privInitialize (double t)
 This replaces the first call to priv_step(), and indicates that the interval has just begun. More...
 
 privInstant ()
 This is called in lieu of priv_initialize() . More...
 
 privInterrupt ()
 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...
 
 privReverseFinalize ()
 Called generally following a priv_reverse_initialize(), this indicates the interval should set itself to the initial state. More...
 
 privReverseInitialize (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...
 
 privReverseInstant ()
 This is called in lieu of priv_reverse_initialize() . More...
 
 privStep (double t)
 Advances the time on the interval. More...
 
 resume ()
 Restarts the interval from its current point after a previous call to pause(). More...
 
 resume (double start_t)
 Restarts the interval from the indicated point after a previous call to pause(). More...
 
 resumeUntil (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...
 
 setAutoFinish (bool auto_finish)
 Changes the state of the 'auto_finish' flag. More...
 
 setAutoPause (bool auto_pause)
 Changes the state of the 'auto_pause' flag. More...
 
 setDoneEvent (str 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...
 
 setManager (CIntervalManager manager)
 Indicates the CIntervalManager object which will be responsible for playing this interval. More...
 
 setPlayRate (double play_rate)
 Changes the play rate of the interval. More...
 
 setT (double t)
 Explicitly sets the time within the interval. More...
 
 setupPlay (double start_time, double end_time, double play_rate, bool do_loop)
 Called to prepare the interval for automatic timed playback, e.g. More...
 
 setupResume ()
 Called to prepare the interval for restarting at the current point within the interval after an interruption. More...
 
 setupResumeUntil (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...
 
 setWantsTCallback (bool wants_t_callback)
 Changes the state of the 'wants_t_callback' flag. More...
 
 start (double start_t, double end_t, double play_rate)
 Starts the interval playing by registering it with the current CIntervalManager. More...
 
bool stepPlay ()
 Should be called once per frame to execute the automatic timed playback begun with setup_play(). More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

bool auto_finish
 Returns the state of the 'auto_finish' flag. More...
 
bool auto_pause
 Returns the state of the 'auto_pause' flag. More...
 
const String 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...
 
double duration
 Returns the duration of the interval in seconds. More...
 
CIntervalManager manager
 Returns the CIntervalManager object which will be responsible for playing this interval. More...
 
const String name
 Returns the interval's name. More...
 
bool open_ended
 Returns the state of the "open_ended" flag. More...
 
double play_rate
 Returns the play rate as set by the last call to start(), loop(), or set_play_rate(). More...
 
bool playing
 Returns true if the interval is currently playing, false otherwise. More...
 
CInterval::State 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...
 
bool stopped
 Returns true if the interval is in either its initial or final states (but not in a running or paused state). More...
 
double t
 Returns the current time of the interval: the last value of t passed to priv_initialize(), priv_step(), or priv_finalize(). More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

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.

Member Enumeration Documentation

◆ EventType

enum EventType
Enumerator
ET_initialize 
ET_instant 
ET_step 
ET_finalize 
ET_reverse_initialize 
ET_reverse_instant 
ET_reverse_finalize 
ET_interrupt 

◆ State

enum State
Enumerator
S_initial 
S_started 
S_paused 
S_final 

Member Function Documentation

◆ __init__()

__init__ ( const  CInterval)

◆ clearToInitial()

clearToInitial ( )

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.

◆ finish()

finish ( )

Stops the interval from playing and sets it to its final state.

◆ getAutoFinish()

bool getAutoFinish ( )

Returns the state of the 'auto_finish' flag.

See set_auto_finish().

◆ getAutoPause()

bool getAutoPause ( )

Returns the state of the 'auto_pause' flag.

See set_auto_pause().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDoneEvent()

str getDoneEvent ( )

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.

◆ getDuration()

double getDuration ( )

Returns the duration of the interval in seconds.

◆ getManager()

CIntervalManager getManager ( )

Returns the CIntervalManager object which will be responsible for playing this interval.

Note that this can only return a C++ object; if the particular CIntervalManager object has been extended in the scripting language, this will return the encapsulated C++ object, not the full extended object.

◆ getName()

str getName ( )

Returns the interval's name.

◆ getOpenEnded()

bool getOpenEnded ( )

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.

◆ getPlayRate()

double getPlayRate ( )

Returns the play rate as set by the last call to start(), loop(), or set_play_rate().

◆ getState()

CInterval::State getState ( )

Indicates the state the interval believes it is in: whether it has been started, is currently in the middle, or has been finalized.

◆ getT()

double getT ( )

Returns the current time of the interval: the last value of t passed to priv_initialize(), priv_step(), or priv_finalize().

◆ getWantsTCallback()

bool getWantsTCallback ( )

Returns the state of the 'wants_t_callback' flag.

See set_wants_t_callback().

◆ isPlaying()

bool isPlaying ( )

Returns true if the interval is currently playing, false otherwise.

◆ isStopped()

bool isStopped ( )

Returns true if the interval is in either its initial or final states (but not in a running or paused state).

◆ loop()

loop ( double  start_t,
double  end_t,
double  play_rate 
)

Starts the interval playing by registering it with the current CIntervalManager.

The interval will play until it is interrupted with finish() or pause(), looping back to start_t when it reaches end_t.

If end_t is less than zero, it indicates the end of the interval.

◆ output()

output ( Ostream  out)

◆ pause()

double pause ( )

Stops the interval from playing but leaves it in its current state.

It may later be resumed from this point by calling resume().

◆ privDoEvent()

privDoEvent ( double  t,
CInterval::EventType  event 
)

◆ privFinalize()

privFinalize ( )

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().

◆ privInitialize()

privInitialize ( 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.

◆ privInstant()

privInstant ( )

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.

◆ privInterrupt()

privInterrupt ( )

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.

◆ privReverseFinalize()

privReverseFinalize ( )

Called generally following a priv_reverse_initialize(), this indicates the interval should set itself to the initial state.

◆ privReverseInitialize()

privReverseInitialize ( 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.

◆ privReverseInstant()

privReverseInstant ( )

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.

◆ privStep()

privStep ( 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).

◆ resume() [1/2]

resume ( )

Restarts the interval from its current point after a previous call to pause().

◆ resume() [2/2]

resume ( double  start_t)

Restarts the interval from the indicated point after a previous call to pause().

◆ resumeUntil()

resumeUntil ( 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.

◆ setAutoFinish()

setAutoFinish ( 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.

◆ setAutoPause()

setAutoPause ( 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.

◆ setDoneEvent()

setDoneEvent ( str  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.

◆ setManager()

setManager ( CIntervalManager  manager)

Indicates the CIntervalManager object which will be responsible for playing this interval.

This defaults to the global CIntervalManager; you should need to change this only if you have special requirements for playing this interval.

◆ setPlayRate()

setPlayRate ( 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() and loop(), the next call to start() or loop() will reset this parameter.

◆ setT()

setT ( 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.

◆ setupPlay()

setupPlay ( 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.

◆ setupResume()

setupResume ( )

Called to prepare the interval for restarting at the current point within the interval after an interruption.

◆ setupResumeUntil()

setupResumeUntil ( 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.

◆ setWantsTCallback()

setWantsTCallback ( 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.

◆ start()

start ( double  start_t,
double  end_t,
double  play_rate 
)

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.

◆ stepPlay()

bool stepPlay ( )

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.

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ auto_finish

bool auto_finish

Returns the state of the 'auto_finish' flag.

See set_auto_finish().

◆ auto_pause

bool auto_pause

Returns the state of the 'auto_pause' flag.

See set_auto_pause().

◆ done_event

const String 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.

◆ duration

double duration

Returns the duration of the interval in seconds.

◆ manager

Returns the CIntervalManager object which will be responsible for playing this interval.

Note that this can only return a C++ object; if the particular CIntervalManager object has been extended in the scripting language, this will return the encapsulated C++ object, not the full extended object.

◆ name

const String name

Returns the interval's name.

◆ open_ended

bool open_ended

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.

◆ play_rate

double play_rate

Returns the play rate as set by the last call to start(), loop(), or set_play_rate().

◆ playing

bool playing

Returns true if the interval is currently playing, false otherwise.

◆ state

Indicates the state the interval believes it is in: whether it has been started, is currently in the middle, or has been finalized.

◆ stopped

bool stopped

Returns true if the interval is in either its initial or final states (but not in a running or paused state).

◆ t

double t

Returns the current time of the interval: the last value of t passed to priv_initialize(), priv_step(), or priv_finalize().