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

The base class for a family of intervals that linearly interpolate one or more numeric values over time. More...

Inheritance diagram for CLerpInterval:
CInterval TypedReferenceCount TypedObject ReferenceCount CLerpAnimEffectInterval CLerpNodePathInterval LerpAnimInterval LerpNodePathInterval LerpColorInterval LerpColorScaleInterval LerpHprInterval LerpHprScaleInterval LerpPosHprInterval LerpPosHprScaleInterval LerpPosHprScaleShearInterval LerpPosInterval LerpPosQuatInterval LerpPosQuatScaleInterval LerpPosQuatScaleShearInterval LerpQuatInterval LerpQuatScaleInterval LerpScaleInterval LerpShearInterval LerpTexOffsetInterval LerpTexRotateInterval LerpTexScaleInterval

Public Types

enum  BlendType {
  BT_no_blend = 0, BT_ease_in = 1, BT_ease_out = 2, BT_ease_in_out = 3,
  BT_invalid = 4
}
 
- Public Types inherited from CInterval
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 CLerpInterval)
 
CLerpInterval::BlendType getBlendType ()
 Returns the blend type specified for the interval. More...
 
- Public Member Functions inherited from CInterval
 __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 CLerpInterval::BlendType stringBlendType (str blend_type)
 Returns the BlendType enumerated value corresponding to the indicated string, or BT_invalid if the string doesn't match anything. More...
 
- Static Public Member Functions inherited from CInterval
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 ()
 

Additional Inherited Members

- Public Attributes inherited from CInterval
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 a family of intervals that linearly interpolate one or more numeric values over time.

Member Enumeration Documentation

◆ BlendType

enum BlendType
Enumerator
BT_no_blend 
BT_ease_in 
BT_ease_out 
BT_ease_in_out 
BT_invalid 

Member Function Documentation

◆ __init__()

__init__ ( const  CLerpInterval)

◆ getBlendType()

CLerpInterval::BlendType getBlendType ( )

Returns the blend type specified for the interval.

This controls how the linear interpolation behaves near the beginning and end of the lerp period.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ stringBlendType()

static CLerpInterval::BlendType stringBlendType ( str  blend_type)
static

Returns the BlendType enumerated value corresponding to the indicated string, or BT_invalid if the string doesn't match anything.