![]() |
![]() |
![]() |
Clutter 0.6 Reference Manual | ![]() |
---|---|---|---|---|
ClutterTimeline; ClutterTimelineClass; ClutterTimeline* clutter_timeline_new (guint n_frames, guint fps); ClutterTimeline* clutter_timeline_new_for_duration (guint msecs); ClutterTimeline* clutter_timeline_clone (ClutterTimeline *timeline); void clutter_timeline_set_speed (ClutterTimeline *timeline, guint fps); guint clutter_timeline_get_speed (ClutterTimeline *timeline); void clutter_timeline_set_duration (ClutterTimeline *timeline, guint msecs); guint clutter_timeline_get_duration (ClutterTimeline *timeline); void clutter_timeline_set_loop (ClutterTimeline *timeline, gboolean loop); gboolean clutter_timeline_get_loop (ClutterTimeline *timeline); void clutter_timeline_set_n_frames (ClutterTimeline *timeline, guint n_frames); guint clutter_timeline_get_n_frames (ClutterTimeline *timeline); void clutter_timeline_set_delay (ClutterTimeline *timeline, guint msecs); guint clutter_timeline_get_delay (ClutterTimeline *timeline); enum ClutterTimelineDirection; void clutter_timeline_set_direction (ClutterTimeline *timeline, ClutterTimelineDirection direction); ClutterTimelineDirection clutter_timeline_get_direction (ClutterTimeline *timeline); void clutter_timeline_start (ClutterTimeline *timeline); void clutter_timeline_pause (ClutterTimeline *timeline); void clutter_timeline_stop (ClutterTimeline *timeline); void clutter_timeline_rewind (ClutterTimeline *timeline); void clutter_timeline_skip (ClutterTimeline *timeline, guint n_frames); void clutter_timeline_advance (ClutterTimeline *timeline, guint frame_num); gint clutter_timeline_get_current_frame (ClutterTimeline *timeline); guint clutter_timeline_get_delta (ClutterTimeline *timeline, guint *msecs); gdouble clutter_timeline_get_progress (ClutterTimeline *timeline); ClutterFixed clutter_timeline_get_progressx (ClutterTimeline *timeline); gboolean clutter_timeline_is_playing (ClutterTimeline *timeline);
"delay" guint : Read / Write "direction" ClutterTimelineDirection : Read / Write "duration" guint : Read / Write "fps" guint : Read / Write "loop" gboolean : Read / Write "num-frames" guint : Read / Write
ClutterTimeline is a base class for managing time based events such as animations.
Every timeline shares the same ClutterTimeoutPool to decrease the
possibility of starvating the main loop when using many timelines
at the same time; this might cause problems if you are also using
a library making heavy use of threads with no GLib main loop integration.
In that case you might disable the common timeline pool by setting
the CLUTTER_TIMELINE
=no-pool environment variable prior to launching
your application.
typedef struct { void (*started) (ClutterTimeline *timeline); void (*completed) (ClutterTimeline *timeline); void (*paused) (ClutterTimeline *timeline); void (*new_frame) (ClutterTimeline *timeline, gint frame_num); } ClutterTimelineClass;
ClutterTimeline* clutter_timeline_new (guint n_frames, guint fps);
Create a new ClutterTimeline instance.
n_frames : |
the number of frames |
fps : |
the number of frames per second |
Returns : | a new ClutterTimeline |
ClutterTimeline* clutter_timeline_new_for_duration (guint msecs);
Creates a new ClutterTimeline with a duration of msecs
using
the value of the ClutterTimeline:fps property to compute the
equivalent number of frames.
msecs : |
Duration of the timeline in milliseconds |
Returns : | the newly created ClutterTimeline |
Since 0.6
ClutterTimeline* clutter_timeline_clone (ClutterTimeline *timeline);
Create a new ClutterTimeline instance which has property values
matching that of supplied timeline. The cloned timeline will not
be started and will not be positioned to the current position of
timeline
: you will have to start it with clutter_timeline_start()
.
timeline : |
ClutterTimeline to duplicate. |
Returns : | a new ClutterTimeline, cloned from timeline
Since 0.4
|
void clutter_timeline_set_speed (ClutterTimeline *timeline, guint fps);
Set the speed in frames per second of the timeline.
timeline : |
A ClutterTimeline |
fps : |
New speed of timeline as frames per second |
guint clutter_timeline_get_speed (ClutterTimeline *timeline);
Gets the frames per second played by timeline
timeline : |
a ClutterTimeline |
Returns : | the number of frames per second. |
void clutter_timeline_set_duration (ClutterTimeline *timeline, guint msecs);
Sets the duration of the timeline, in milliseconds. The speed of the timeline depends on the ClutterTimeline:fps setting.
timeline : |
a ClutterTimeline |
msecs : |
duration of the timeline in milliseconds |
Since 0.6
guint clutter_timeline_get_duration (ClutterTimeline *timeline);
Retrieves the duration of a ClutterTimeline in milliseconds.
See clutter_timeline_set_duration()
.
timeline : |
a ClutterTimeline |
Returns : | the duration of the timeline, in milliseconds. |
Since 0.6
void clutter_timeline_set_loop (ClutterTimeline *timeline, gboolean loop);
Sets whether timeline
should loop.
timeline : |
a ClutterTimeline |
loop : |
TRUE for enable looping
|
gboolean clutter_timeline_get_loop (ClutterTimeline *timeline);
Gets whether timeline
is looping
timeline : |
a ClutterTimeline |
Returns : | TRUE if the timeline is looping
|
void clutter_timeline_set_n_frames (ClutterTimeline *timeline, guint n_frames);
Sets the total number of frames for timeline
timeline : |
a ClutterTimeline |
n_frames : |
the number of frames |
guint clutter_timeline_get_n_frames (ClutterTimeline *timeline);
Request the total number of frames for the ClutterTimeline.
timeline : |
A ClutterTimeline |
Returns : | Number of frames for this ClutterTimeline. |
void clutter_timeline_set_delay (ClutterTimeline *timeline, guint msecs);
Sets the delay, in milliseconds, before timeline
should start.
timeline : |
a ClutterTimeline |
msecs : |
delay in milliseconds |
Since 0.4
guint clutter_timeline_get_delay (ClutterTimeline *timeline);
Retrieves the delay set using clutter_timeline_set_delay()
.
timeline : |
a ClutterTimeline |
Returns : | the delay in milliseconds. |
Since 0.4
typedef enum { CLUTTER_TIMELINE_FORWARD, CLUTTER_TIMELINE_BACKWARD } ClutterTimelineDirection;
The direction of a ClutterTimeline
CLUTTER_TIMELINE_FORWARD |
forward direction for a timeline |
CLUTTER_TIMELINE_BACKWARD |
backward direction for a timeline |
Since 0.6
void clutter_timeline_set_direction (ClutterTimeline *timeline, ClutterTimelineDirection direction);
Sets the direction of timeline
, either CLUTTER_TIMELINE_FORWARD
or
CLUTTER_TIMELINE_BACKWARD
.
timeline : |
a ClutterTimeline |
direction : |
the direction of the timeline |
Since 0.6
ClutterTimelineDirection clutter_timeline_get_direction (ClutterTimeline *timeline);
Retrieves the direction of the timeline set with
clutter_timeline_set_direction()
.
timeline : |
a ClutterTimeline |
Returns : | the direction of the timeline |
Since 0.6
void clutter_timeline_start (ClutterTimeline *timeline);
Starts the ClutterTimeline playing.
timeline : |
A ClutterTimeline |
void clutter_timeline_pause (ClutterTimeline *timeline);
Pauses the ClutterTimeline on current frame
timeline : |
A ClutterTimeline |
void clutter_timeline_stop (ClutterTimeline *timeline);
Stops the ClutterTimeline and moves to frame 0
timeline : |
A ClutterTimeline |
void clutter_timeline_rewind (ClutterTimeline *timeline);
Rewinds ClutterTimeline to the first frame if its direction is CLUTTER_TIMELINE_FORWARD and the last frame if it is CLUTTER_TIMELINE_BACKWARD.
timeline : |
A ClutterTimeline |
void clutter_timeline_skip (ClutterTimeline *timeline, guint n_frames);
Advance timeline by requested number of frames.
timeline : |
A ClutterTimeline |
n_frames : |
Number of frames to skip |
void clutter_timeline_advance (ClutterTimeline *timeline, guint frame_num);
Advance timeline to requested frame number
timeline : |
A ClutterTimeline |
frame_num : |
Frame number to advance to |
gint clutter_timeline_get_current_frame (ClutterTimeline *timeline);
Request the current frame number of the timeline.
timeline : |
A ClutterTimeline |
Returns : | current frame number |
guint clutter_timeline_get_delta (ClutterTimeline *timeline, guint *msecs);
Retrieves the number of frames and the amount of time elapsed since the last ClutterTimeline::new-frame signal.
This function is only useful inside handlers for the ::new-frame signal, and its behaviour is undefined if the timeline is not playing.
timeline : |
a ClutterTimeline |
msecs : |
return location for the milliseconds elapsed since the last
frame, or NULL
|
Returns : | the amount of frames elapsed since the last one |
Since 0.6
gdouble clutter_timeline_get_progress (ClutterTimeline *timeline);
The position of the timeline in a [0, 1] interval.
timeline : |
a ClutterTimeline |
Returns : | the position of the timeline. |
Since 0.6
ClutterFixed clutter_timeline_get_progressx (ClutterTimeline *timeline);
Fixed point version of clutter_timeline_get_progress()
.
timeline : |
a ClutterTimeline |
Returns : | the position of the timeline as a fixed point value |
Since 0.6
gboolean clutter_timeline_is_playing (ClutterTimeline *timeline);
Query state of a ClutterTimeline instance.
timeline : |
A ClutterTimeline |
Returns : | TRUE if timeline is currently playing, FALSE if not. |
delay
" property"delay" guint : Read / Write
A delay, in milliseconds, that should be observed by the timeline before actually starting.
Default value: 0
Since 0.4
direction
" property"direction" ClutterTimelineDirection : Read / Write
The direction of the timeline, either CLUTTER_TIMELINE_FORWARD
or
CLUTTER_TIMELINE_BACKWARD
.
Default value: CLUTTER_TIMELINE_FORWARD
Since 0.6
duration
" property"duration" guint : Read / Write
Duration of the timeline in milliseconds, depending on the ClutterTimeline:fps value.
Default value: 1000
Since 0.6
fps
" property"fps" guint : Read / Write
Timeline frames per second. Because of the nature of the main loop used by Clutter this is to be considered a best approximation.
Allowed values: [1,1000]
Default value: 60
loop
" property"loop" gboolean : Read / Write
Whether the timeline should automatically rewind and restart.
Default value: FALSE
void user_function (ClutterTimeline *timeline, gpointer user_data) : Run Last
The ::completed signal is emitted when the timeline reaches the number of frames specified by the ClutterTimeline:num-frames property.
timeline : |
the ClutterTimeline which received the signal |
user_data : |
user data set when the signal handler was connected. |
void user_function (ClutterTimeline *timeline, gint frame_num, gpointer user_data) : Run Last
The ::new-frame signal is emitted each time a new frame in the timeline is reached.
timeline : |
the timeline which received the signal |
frame_num : |
the number of the new frame between 0 and ClutterTimeline:num-frames |
user_data : |
user data set when the signal handler was connected. |
void user_function (ClutterTimeline *timeline, gpointer user_data) : Run Last
The ::paused signal is emitted when clutter_timeline_pause()
is invoked.
timeline : |
the ClutterTimeline which received the signal |
user_data : |
user data set when the signal handler was connected. |
void user_function (ClutterTimeline *timeline, gpointer user_data) : Run Last
The ::started signal is emitted when the timeline starts its run.
This might be as soon as clutter_timeline_start()
is invoked or
after the delay set in the ClutterTimeline:delay property has
expired.
timeline : |
the ClutterTimeline which received the signal |
user_data : |
user data set when the signal handler was connected. |