This is the fundamental interface for things that have a play/loop/stop type interface for frame-based animation, such as animated characters. More...

#include "animInterface.h"

Inheritance diagram for AnimInterface:

Public Member Functions
double	get_frac () const

int	get_frame () const

double	get_frame_rate () const

double	get_full_fframe () const

int	get_full_frame () const

int	get_next_frame () const

virtual int	get_num_frames () const

double	get_play_rate () const

bool	is_playing () const

void	loop (bool restart)
	Starts the entire animation looping. More...

void	loop (bool restart, double from, double to)
	Loops the animation from the frame "from" to and including the frame "to", indefinitely. More...

virtual void	output (std::ostream &out) const

void	pingpong (bool restart)
	Starts the entire animation bouncing back and forth between its first frame and last frame. More...

void	pingpong (bool restart, double from, double to)
	Loops the animation from the frame "from" to and including the frame "to", and then back in the opposite direction, indefinitely. More...

void	play ()
	Runs the entire animation from beginning to end and stops. More...

void	play (double from, double to)
	Runs the animation from the frame "from" to and including the frame "to", at which point the animation is stopped. More...

void	pose (double frame)
	Sets the animation to the indicated frame and holds it there. More...

void	set_play_rate (double play_rate)

void	stop ()
	Stops a currently playing or looping animation right where it is. More...

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

Public Attributes
	get_frac
	Returns the fractional part of the current frame. More...

	get_frame
	Returns the current integer frame number. More...

	get_frame_rate
	Returns the native frame rate of the animation. More...

	get_full_fframe
	Returns the current floating-point frame number. More...

	get_full_frame
	Returns the current integer frame number. More...

	get_next_frame
	Returns the current integer frame number + 1, constrained to the range 0 <= f < get_num_frames(). More...

	get_num_frames
	Returns the number of frames in the animation. More...

	get_play_rate
	Returns the rate at which the animation plays. More...

	is_playing
	Returns true if the animation is currently playing, false if it is stopped (e.g. More...

	set_play_rate
	Changes the rate at which the animation plays. More...

Detailed Description

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.

Definition at line 35 of file animInterface.h.

Member Function Documentation

◆ loop() [1/2]

void AnimInterface::loop ( bool restart )

inline

Starts the entire animation looping.

If restart is true, the animation is restarted from the beginning; otherwise, it continues from the current frame.

Definition at line 45 of file animInterface.I.

References get_num_frames.

Referenced by AnimControlCollection::loop().

◆ loop() [2/2]

void AnimInterface::loop	(	bool	restart,
		double	from,
		double	to
	)

inline

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.

Definition at line 55 of file animInterface.I.

◆ pingpong() [1/2]

void AnimInterface::pingpong ( bool restart )

inline

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.

Definition at line 69 of file animInterface.I.

References get_num_frames.

◆ pingpong() [2/2]

void AnimInterface::pingpong	(	bool	restart,
		double	from,
		double	to
	)

inline

Loops the animation from the frame "from" to and including the frame "to", and then back in the opposite direction, indefinitely.

Definition at line 78 of file animInterface.I.

◆ play() [1/2]

void AnimInterface::play ( )

inline

Runs the entire animation from beginning to end and stops.

Definition at line 18 of file animInterface.I.

References get_num_frames.

Referenced by AnimControlCollection::play().

◆ play() [2/2]

void AnimInterface::play	(	double	from,
		double	to
	)

inline

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 modulo get_num_frames(). For instance, play(0, get_num_frames() * 2) will play the animation twice and then stop.

Definition at line 31 of file animInterface.I.

◆ pose()

void AnimInterface::pose ( double frame )

inline

Sets the animation to the indicated frame and holds it there.

Definition at line 103 of file animInterface.I.

Referenced by AnimControlCollection::pose().

◆ stop()

void AnimInterface::stop ( )

inline

Stops a currently playing or looping animation right where it is.

The animation remains posed at the current frame.

Definition at line 91 of file animInterface.I.

Referenced by AnimControlCollection::stop().

Member Data Documentation

◆ get_frac

double AnimInterface::get_frac

inline

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

Definition at line 72 of file animInterface.h.

Referenced by AnimControl::channel_has_changed(), and AnimControl::mark_channels().

◆ get_frame

int AnimInterface::get_frame

inline

Returns the current integer frame number.

This number will be in the range 0 <= f < get_num_frames().

Definition at line 70 of file animInterface.h.

Referenced by AnimControl::channel_has_changed(), SequenceNode::cull_callback(), SequenceNode::get_first_visible_child(), AnimControlCollection::get_frame(), SequenceNode::get_visible_child(), and AnimControl::mark_channels().

◆ get_frame_rate

double AnimInterface::get_frame_rate

inline

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.

Definition at line 67 of file animInterface.h.

◆ get_full_fframe

double AnimInterface::get_full_fframe

inline

Returns the current floating-point frame number.

Unlike the value returned by get_frame(), this frame number may extend beyond the range of get_num_frames() if the frame range passed to play(), 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 of get_full_frame() will be to_frame, not (to_frame + 1).

Definition at line 74 of file animInterface.h.

◆ get_full_frame

int AnimInterface::get_full_frame

inline

Returns the current integer frame number.

Unlike the value returned by get_frame(), this frame number may extend beyond the range of get_num_frames() if the frame range passed to play(), loop(), etc. did.

Unlike the value returned by get_full_fframe(), this return value will never exceed the value passed to to_frame in the play() method.

Definition at line 73 of file animInterface.h.

◆ get_next_frame

int AnimInterface::get_next_frame

inline

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.

Definition at line 71 of file animInterface.h.

◆ get_num_frames

int AnimInterface::get_num_frames

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

Definition at line 68 of file animInterface.h.

Referenced by AnimControlCollection::get_num_frames(), loop(), pingpong(), and play().

◆ get_play_rate

double AnimInterface::get_play_rate

inline

Returns the rate at which the animation plays.

See set_play_rate().

Definition at line 66 of file animInterface.h.

◆ is_playing

bool AnimInterface::is_playing

inline

Returns true if the animation is currently playing, false if it is stopped (e.g.

because stop() or pose() was called, or because it reached the end of the animation after play() was called).

Definition at line 75 of file animInterface.h.

Referenced by AnimControlCollection::is_playing().

◆ set_play_rate

void AnimInterface::set_play_rate

inline

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.

Definition at line 66 of file animInterface.h.

The documentation for this class was generated from the following files:

panda/src/putil/animInterface.h
panda/src/putil/animInterface.cxx
panda/src/putil/animInterface.I

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ loop() [1/2]

◆ loop() [2/2]

◆ pingpong() [1/2]

◆ pingpong() [2/2]

◆ play() [1/2]

◆ play() [2/2]

◆ pose()

◆ stop()

Member Data Documentation

◆ get_frac

◆ get_frame

◆ get_frame_rate

◆ get_full_fframe

◆ get_full_frame

◆ get_next_frame

◆ get_num_frames

◆ get_play_rate

◆ is_playing

◆ set_play_rate