Class Index Cross Index Namespace Index

Class Gnome::Animator


Contained in: Gnome
Derived from: Gtk::Widget
Derived by: none

#include <gtk--/animator.h>


public function member index:

Animator(guint width, guint height);
bool advance(gint num);
bool append_frame(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval, guint width, guint height);
bool append_frame(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval);
bool append_frame(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval, guint width, guint height);
bool append_frame(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval);
bool append_frame(Pixmap& pixmap, gint x_offset, gint y_offset, guint32 interval);
bool append_frames(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval, gint x_unit, guint width, guint height);
bool append_frames(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval, gint x_unit);
bool append_frames(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval, gint x_unit, guint width, guint height);
bool append_frames(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval, gint x_unit);
guint get_current_frame_number();
GnomeAnimatorLoopType get_loop_type();
gint get_playback_direction();
gdouble get_playback_speed();
GnomeAnimatorStatus get_status();
static GtkType get_type();
void goto_frame(guint frame_number);
GnomeAnimator* gtkobj();
const GnomeAnimator* gtkobj() const;
static bool isA(Gtk::Object* checkcast);
void set_loop_type(GnomeAnimatorLoopType loop_type);
void set_playback_direction(gint playback_direction=1);
void set_playback_speed(gdouble speed=1.0);
void start();
void stop();
virtual ~Animator();
 

protected function member index:

explicit Animator(GnomeAnimator* castitem);
void initialize_class();
 

private function member index:

Animator(const Animator&);
Animator& operator =(const Animator&);
 

Description:



Function Member Descriptions:

Gnome::Animator::advance - Advance the animation by num frames.

bool advance(gint num);
A positive value uses the specified playback direction; a negative one goes in the opposite direction. If the loop type is GNOME_ANIMATOR_LOOP_NONE and the value causes the frame counter to overflow, false is returned and the animator is stopped; otherwise, true is returned.


Gnome::Animator::append_frame - Append a frame from image with crop.

bool append_frame(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval, guint width, guint height);

Gnome::Animator::append_frame - Append a frame from image.

bool append_frame(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval);

Gnome::Animator::append_frame - Append a frame from file with crop.

bool append_frame(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval, guint width, guint height);

Gnome::Animator::append_frame - Append a frame from file.

bool append_frame(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval);

Gnome::Animator::append_frame - Append pixmap to animator's list of frames.

bool append_frame(Pixmap& pixmap, gint x_offset, gint y_offset, guint32 interval);

Gnome::Animator::append_frames - Append frames from image with crop.

bool append_frames(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval, gint x_unit, guint width, guint height);
Crop image into frames x_unit pixels wide, and append them as frames to the animator with the specified interval and offsets. Each frame is rendered at the specified size.


Gnome::Animator::append_frames - Append frames from image.

bool append_frames(const Gdk_Imlib::Image& image, gint x_offset, gint y_offset, guint32 interval, gint x_unit);
Crop image into frames x_unit pixels wide, and append them as frames to the animator with the specified interval and offsets. Each frame is rendered at its natural size.


Gnome::Animator::append_frames - Load an image from name, crop it into frames x_unit pixels wide, and append them as frames to the animator. Each frame is rendered at the specified size.

bool append_frames(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval, gint x_unit, guint width, guint height);

Gnome::Animator::append_frames - Append frames from file.

bool append_frames(const Gtk::string& name, gint x_offset, gint y_offset, guint32 interval, gint x_unit);
Load an image from name, crop it into frames x_unit pixels wide, and append them as frames to the animator. Each frame is rendered at its natural size.


Gnome::Animator::get_current_frame_number - Get the number of current frame.

guint get_current_frame_number();

Gnome::Animator::get_loop_type - Get loop type (See GnomeAnimatorLoopType).

GnomeAnimatorLoopType get_loop_type();

Gnome::Animator::get_playback_direction - Get playback direction.

gint get_playback_direction();
A positive value means "forwards"; A negative one means "backwards".


Gnome::Animator::get_playback_speed - Get speed factor

gdouble get_playback_speed();
(the higher, the faster: the interval value is divided by this factor before being used). Default is 1.0.


Gnome::Animator::get_status - Get the animator status.

GnomeAnimatorStatus get_status();

Gnome::Animator::goto_frame - Set the number of current frame. The result is immediately visible.

void goto_frame(guint frame_number);

Gnome::Animator::set_loop_type - Set loop type (See GnomeAnimatorLoopType).

void set_loop_type(GnomeAnimatorLoopType loop_type);

Gnome::Animator::set_playback_direction - Set playback direction.

void set_playback_direction(gint playback_direction=1);
A positive value means "forwards"; A negative one means "backwards".


Gnome::Animator::set_playback_speed - Set speed factor

void set_playback_speed(gdouble speed=1.0);
(the higher, the faster: the interval value is divided by this factor before being used). Default is 1.0.


Gnome::Animator::start - Start playing the animation in the GTK loop.

void start();

Gnome::Animator::stop - Stop playing the animation in the GTK loop.

void stop();


Variable Member Descriptions: