Back to Seed Clases

Clutter

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker Clutter.Timeline

Class Clutter.Timeline

Import line:	Clutter = imports.gi.Clutter;
GIR File:	Clutter-1.0.gir
C documentation:	ClutterTimeline
Class :	Timeline
Extends:	GObject.Object
	Show / Hide Inherited methods, properties and signals

The ClutterTimeline structure contains only private data and should be accessed using the provided API

Properties
Properties		Defined By
	delay : Number A delay, in milliseconds, that should be observed by the timeline before actually starting. A delay, in milliseconds, that should be observed by the timeline before actually starting.	Clutter.Timeline
	direction : Clutter.TimelineDirection The direction of the timeline, either CLUTTER_TIMELINE_FORWARD or CLUTTER_TIMELINE_BACKWARD. The direction of the timeline, either CLUTTER_TIMELINE_FORWARD or CLUTTER_TIMELINE_BACKWARD.	Clutter.Timeline
	duration : Number Duration of the timeline in milliseconds, depending on the ClutterTimeline:fps value. Duration of the timeline in milliseconds, depending on the ClutterTimeline:fps value.	Clutter.Timeline
	loop : Boolean Whether the timeline should automatically rewind and restart. Whether the timeline should automatically rewind and restart.	Clutter.Timeline
	parent : GObject.Object read only	Clutter.Timeline
	priv : Clutter.TimelinePrivate read only	Clutter.Timeline

Methods / Constructors
Method / Constructor		Defined By
	new Clutter.Timeline (Object *properties) Create a new Clutter.Timeline Create a new Clutter.Timeline Parameters: Object properties*
	new Clutter.Timeline.c_new (Number *msecs) : Clutter.Timeline Create a new Clutter.Timeline Create a new Clutter.Timeline Parameters: Number msecs* Required (not null) Returns: Clutter.Timeline g_object_unref() when done using it
	add_marker_at_time (String *marker_name, Number msecs) : none Adds a named marker that will be hit when the timeline has been running for msecs* milliseconds. Adds a named marker that will be hit when the timeline has been running for msecs milliseconds. Markers are unique string identifiers for a given time. Once timeline reaches attached to that time. A marker can be removed with clutter_timeline_remove_marker(). The timeline can be advanced to a marker using clutter_timeline_advance_to_marker(). Parameters: String marker_name Required (not null) Number msecs Required (not null) Returns: none	Clutter.Timeline
	advance (Number *msecs) : none Advance timeline to the requested point. Advance timeline to the requested point. The point is given as a time in milliseconds since the timeline started. The timeline* will not emit the ClutterTimeline::new-frame signal for the given time. The first ::new-frame signal after the call to clutter_timeline_advance() will be emit the skipped markers. Parameters: Number msecs Required (not null) Returns: none	Clutter.Timeline
	advance_to_marker (String *marker_name) : none Advances timeline* to the time of the given marker_name. Advances timeline to the time of the given marker_name. Like clutter_timeline_advance(), this function will not emit the ClutterTimeline::new-frame for the time where marker_name is set, nor it will emit ClutterTimeline::marker-reached for Parameters: String marker_name Required (not null) Returns: none	Clutter.Timeline
	clone () : Clutter.Timeline Create a new ClutterTimeline instance which has property values matching that of supplied 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 Returns: Clutter.Timeline	Clutter.Timeline
	do_tick (TimeVal *tick_time) : none Parameters: GLib.TimeVal tick_time* Required (not null) Returns: none	Clutter.Timeline
	get_delay () : Number Retrieves the delay set using clutter_timeline_set_delay(). Retrieves the delay set using clutter_timeline_set_delay(). Returns: Number	Clutter.Timeline
	get_delta () : Number Retrieves the amount of time elapsed since the last ClutterTimeline::new-frame signal. Retrieves 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. last frame Returns: Number	Clutter.Timeline
	get_direction () : Clutter.TimelineDirection Retrieves the direction of the timeline set with clutter_timeline_set_direction(). Retrieves the direction of the timeline set with clutter_timeline_set_direction(). Returns: Clutter.TimelineDirection	Clutter.Timeline
	get_duration () : Number Retrieves the duration of a ClutterTimeline in milliseconds. Retrieves the duration of a ClutterTimeline in milliseconds. See clutter_timeline_set_duration(). Returns: Number	Clutter.Timeline
	get_elapsed_time () : Number Request the current time position of the timeline. Request the current time position of the timeline. Returns: Number	Clutter.Timeline
	get_loop () : Boolean Gets whether timeline is looping Gets whether timeline is looping Returns: Boolean	Clutter.Timeline
	get_progress () : Number The position of the timeline in a [0, 1] interval. The position of the timeline in a [0, 1] interval. Returns: Number	Clutter.Timeline
	has_marker (String *marker_name) : Boolean Checks whether timeline* has a marker set with the given name. Checks whether timeline has a marker set with the given name. Parameters: String marker_name Required (not null) Returns: Boolean	Clutter.Timeline
	is_playing () : Boolean Queries state of a ClutterTimeline. Queries state of a ClutterTimeline. Returns: Boolean	Clutter.Timeline
	list_markers (Number *msecs, Object out_values) : Array Retrieves the list of markers at time msecs. Retrieves the list of markers at time msecs. If frame_num* is a negative integer, all the markers attached to timeline will be returned. Parameters: Number msecs Required (not null) Object out_values Number n_markers Returns: Array a newly allocated, NULL terminated string array containing the names of the markers. Use g_strfreev() when done.	Clutter.Timeline
	pause () : none Pauses the ClutterTimeline on current frame Pauses the ClutterTimeline on current frame Returns: none	Clutter.Timeline
	remove_marker (String *marker_name) : none Removes marker_name, if found, from timeline. Removes marker_name, if found, from timeline. Parameters: String marker_name* Required (not null) Returns: none	Clutter.Timeline
	rewind () : none Rewinds ClutterTimeline to the first frame if its direction is CLUTTER_TIMELINE_FORWARD and the last frame if it is CLUTTER_TIMELINE_BACKWARD. Rewinds ClutterTimeline to the first frame if its direction is CLUTTER_TIMELINE_FORWARD and the last frame if it is CLUTTER_TIMELINE_BACKWARD. Returns: none	Clutter.Timeline
	set_delay (Number *msecs) : none Sets the delay, in milliseconds, before timeline* should start. Sets the delay, in milliseconds, before timeline should start. Parameters: Number msecs Required (not null) Returns: none	Clutter.Timeline
	set_direction (TimelineDirection *direction) : none Sets the direction of timeline, either CLUTTER_TIMELINE_FORWARD* or CLUTTER_TIMELINE_BACKWARD. Sets the direction of timeline, either CLUTTER_TIMELINE_FORWARD or CLUTTER_TIMELINE_BACKWARD. Parameters: Clutter.TimelineDirection direction Required (not null) Returns: none	Clutter.Timeline
	set_duration (Number *msecs) : none Sets the duration of the timeline, in milliseconds. Sets the duration of the timeline, in milliseconds. The speed of the timeline depends on the ClutterTimeline:fps setting. Parameters: Number msecs* Required (not null) Returns: none	Clutter.Timeline
	set_loop (Boolean *loop) : none Sets whether timeline* should loop. Sets whether timeline should loop. Parameters: Boolean loop Required (not null) Returns: none	Clutter.Timeline
	skip (Number *msecs) : none Advance timeline by the requested time in milliseconds Advance timeline by the requested time in milliseconds Parameters: Number msecs* Required (not null) Returns: none	Clutter.Timeline
	start () : none Starts the ClutterTimeline playing. Starts the ClutterTimeline playing. Returns: none	Clutter.Timeline
	stop () : none Stops the ClutterTimeline and moves to frame 0 Stops the ClutterTimeline and moves to frame 0 Returns: none	Clutter.Timeline

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	completed (Timeline *self) : none The ::completed signal is emitted when the timeline reaches the number of frames specified by the ClutterTimeline:num-frames property. The ::completed signal is emitted when the timeline reaches the number of frames specified by the ClutterTimeline:num-frames property. Parameters: Clutter.Timeline self* Returns: {none}	Clutter.Timeline
	marker_reached (Timeline *self, String marker_name, Number msecs) : none The ::marker-reached signal is emitted each time a timeline reaches a marker set with clutter_timeline_add_marker_at_time(). The ::marker-reached signal is emitted each time a timeline reaches a marker set with clutter_timeline_add_marker_at_time(). This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the ::marker-reached signal for a specific marker with: clutter_timeline_add_marker_at_time (timeline, "foo", 500); clutter_timeline_add_marker_at_time (timeline, "bar", 750); g_signal_connect (timeline, "marker-reached", G_CALLBACK (each_marker_reached), NULL); g_signal_connect (timeline, "marker-reached::foo", G_CALLBACK (foo_marker_reached), NULL); g_signal_connect (timeline, "marker-reached::bar", G_CALLBACK (bar_marker_reached), NULL); In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively. Parameters: Clutter.Timeline self* String marker_name Number msecs Returns: {none}	Clutter.Timeline
	new_frame (Timeline *self, Number msecs) : none The ::new-frame signal is emitted for each timeline running timeline before a new frame is drawn to give animations a chance to update the scene. The ::new-frame signal is emitted for each timeline running timeline before a new frame is drawn to give animations a chance to update the scene. Parameters: Clutter.Timeline self* Number msecs Returns: {none}	Clutter.Timeline
	paused (Timeline *self) : none The ::paused signal is emitted when clutter_timeline_pause() is invoked. The ::paused signal is emitted when clutter_timeline_pause() is invoked. Parameters: Clutter.Timeline self* Returns: {none}	Clutter.Timeline
	started (Timeline *self) : none The ::started signal is emitted when the timeline starts its run. 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. Parameters: Clutter.Timeline self* Returns: {none}	Clutter.Timeline

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Clutter.Actor Method	animate_with_timelinev (Number *mode, Timeline timeline, Number n_properties, Array properties, Array values) : Clutter.Animation Animates the given list of properties of actor* between the current value for each property and a new final value.
Clutter.Alpha Property	timeline : Clutter.Timeline A ClutterTimeline instance used to drive the alpha function.
Clutter.Alpha Method	new Clutter.Alpha.full (Timeline *timeline, Number mode*) : Clutter.Alpha Create a new Clutter.Alpha
Clutter.Alpha Method	new Clutter.Alpha.with_func (Timeline *timeline, Function func, void *data, Function destroy*) : Clutter.Alpha Create a new Clutter.Alpha
Clutter.Alpha Method	set_timeline (Timeline *timeline) : none Binds alpha* to timeline.
Clutter.Alpha Method	get_timeline () : Clutter.Timeline Gets the ClutterTimeline bound to alpha.
Clutter.Animation Property	timeline : Clutter.Timeline The ClutterTimeline used by the animation.
Clutter.Animation Method	set_timeline (Timeline *timeline) : none Sets the ClutterTimeline* used by animation.
Clutter.Animation Method	get_timeline () : Clutter.Timeline Retrieves the ClutterTimeline used by animation
Clutter.Animator Property	timeline : Clutter.Timeline The ClutterTimeline used by the ClutterAnimator to drive the animation
Clutter.Animator Method	start () : Clutter.Timeline Start the ClutterAnimator, this is a thin wrapper that rewinds and starts the animators current timeline.
Clutter.Animator Method	get_timeline () : Clutter.Timeline Get the timeline hooked up for driving the ClutterAnimator
Clutter.Animator Method	set_timeline (Timeline *timeline*) : none Sets an external timeline that will be used for driving the animation
Clutter.Score Signal	timeline_completed (Score *self, Timeline timeline) : none The ::timeline-completed signal is emitted each time a timeline inside a ClutterScore* terminates.
Clutter.Score Signal	timeline_started (Score *self, Timeline timeline) : none The ::timeline-started signal is emitted each time a new timeline inside a ClutterScore* starts playing.
Clutter.Score Method	append (Timeline *parent, Timeline timeline) : Number Appends a timeline to another one existing in the score; the newly appended timeline will be started when parent* is complete.
Clutter.Score Method	append_at_marker (Timeline *parent, String marker_name, Timeline timeline) : Number Appends timeline* at the given marker_name on the parent ClutterTimeline.
Clutter.Score Method	get_timeline (Number id) : Clutter.Timeline Retrieves the ClutterTimeline for id inside score.

Un-official Seed Documentation

Clutter

Classes

Interfaces

Structs

Unions

Enums

Class Clutter.Timeline