AnimInterface¶
-
class
AnimInterface
¶ This is the fundamental interface for things that have a play/loop/stop type interface for frame-based animation, such as animated characters. This is the base class for
AnimControl
and other, similar classes.Inheritance diagram
-
static TypeHandle
get_class_type
(void)¶
-
double
get_frac
(void) const¶ Returns the fractional part of the current frame. Normally, this is in the range 0.0 <= f < 1.0, but in the one special case of an animation playing to its end frame and stopping, it might exactly equal 1.0.
It will always be true that
get_full_frame()
+ get_frac() ==get_full_fframe()
.
-
int
get_frame
(void) const¶ Returns the current integer frame number. This number will be in the range 0 <= f <
get_num_frames()
.
-
double
get_frame_rate
(void) const¶ Returns the native frame rate of the animation. This is the number of frames per second that will elapse when the play_rate is set to 1.0. It is a fixed property of the animation and may not be adjusted by the user.
-
double
get_full_fframe
(void) const¶ Returns the current floating-point frame number.
Unlike the value returned by
get_frame()
, this frame number may extend beyond the range ofget_num_frames()
if the frame range passed toplay()
,loop()
, etc. did.Unlike the value returned by
get_full_frame()
, this return value may equal (to_frame + 1.0), when the animation has played to its natural end. However, in this case the return value ofget_full_frame()
will be to_frame, not (to_frame + 1).
-
int
get_full_frame
(void) const¶ Returns the current integer frame number.
Unlike the value returned by
get_frame()
, this frame number may extend beyond the range ofget_num_frames()
if the frame range passed toplay()
,loop()
, etc. did.Unlike the value returned by
get_full_fframe()
, this return value will never exceed the value passed to to_frame in theplay()
method.
-
int
get_next_frame
(void) const¶ Returns the current integer frame number + 1, constrained to the range 0 <= f <
get_num_frames()
.If the play mode is PM_play, this will clamp to the same value as
get_frame()
at the end of the animation. If the play mode is any other value, this will wrap around to frame 0 at the end of the animation.
-
virtual int
get_num_frames
(void) const¶ Returns the number of frames in the animation. This is a property of the animation and may not be directly adjusted by the user (although it may change without warning with certain kinds of animations, since this is a virtual method that may be overridden).
-
double
get_play_rate
(void) const¶ Returns the rate at which the animation plays. See
set_play_rate()
.
-
bool
is_playing
(void) const¶ Returns true if the animation is currently playing, false if it is stopped (e.g. because
stop()
orpose()
was called, or because it reached the end of the animation afterplay()
was called).
-
void
loop
(bool restart)¶
-
void
loop
(bool restart, double from, double to)¶ Starts the entire animation looping. If restart is true, the animation is restarted from the beginning; otherwise, it continues from the current frame.
Loops the animation from the frame “from” to and including the frame “to”, indefinitely. If restart is true, the animation is restarted from the beginning; otherwise, it continues from the current frame.
-
virtual void
output
(std::ostream &out) const¶
-
void
pingpong
(bool restart)¶
-
void
pingpong
(bool restart, double from, double to)¶ Starts the entire animation bouncing back and forth between its first frame and last frame. If restart is true, the animation is restarted from the beginning; otherwise, it continues from the current frame.
Loops the animation from the frame “from” to and including the frame “to”, and then back in the opposite direction, indefinitely.
-
void
play
(void)¶
-
void
play
(double from, double to)¶ Runs the entire animation from beginning to end and stops.
Runs the animation from the frame “from” to and including the frame “to”, at which point the animation is stopped. Both “from” and “to” frame numbers may be outside the range (0,
get_num_frames()
) and the animation will follow the range correctly, reporting numbers moduloget_num_frames()
. For instance, play(0,get_num_frames()
* 2) will play the animation twice and then stop.
-
void
pose
(double frame)¶ Sets the animation to the indicated frame and holds it there.
-
void
set_play_rate
(double play_rate)¶ Changes the rate at which the animation plays. 1.0 is the normal speed, 2.0 is twice normal speed, and 0.5 is half normal speed. 0.0 is legal to pause the animation, and a negative value will play the animation backwards.
-
void
stop
(void)¶ Stops a currently playing or looping animation right where it is. The animation remains posed at the current frame.
-
static TypeHandle