Back to Seed Clases

Clutter

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker Clutter.Animation

Class Clutter.Animation

Import line:	Clutter = imports.gi.Clutter;
GIR File:	Clutter-1.0.gir
C documentation:	ClutterAnimation
Class :	Animation
Implements:	Clutter.Scriptable
Extends:	GObject.Object

The ClutterAnimation structure contains only private data and should
be accessed using the provided functions.

Properties
Properties		Defined By
	alpha : Clutter.Alpha The ClutterAlpha used by the animation. The ClutterAlpha used by the animation.	Clutter.Animation
	duration : guint32 The duration of the animation, expressed in milliseconds. The duration of the animation, expressed in milliseconds.	Clutter.Animation
	loop : gboolean Whether the animation should loop. Whether the animation should loop.	Clutter.Animation
	mode : guint32 The animation mode, either a value from ClutterAnimationMode or a value returned by clutter_alpha_register_func(). The animation mode, either a value from ClutterAnimationMode or a value returned by clutter_alpha_register_func(). The default value is CLUTTER_LINEAR.	Clutter.Animation
	object : GObject.Object The GObject to which the animation applies. The GObject to which the animation applies.	Clutter.Animation
	parent_instance : GObject.Object read only	Clutter.Animation
	priv : Clutter.AnimationPrivate read only	Clutter.Animation
	timeline : Clutter.Timeline The ClutterTimeline used by the animation. The ClutterTimeline used by the animation.	Clutter.Animation

Methods / Constructors
Method / Constructor		Defined By
	new Clutter.Animation (Object *properties) Create a new Clutter.Animation Create a new Clutter.Animation Parameters: Object properties*
	bind (String *property_name, Value final) : Clutter.Animation Adds a single property with name property_name* to the animation animation. Adds a single property with name property_name to the animation animation. For more information about animations, see clutter_actor_animate(). This method returns the animation primarily to make chained calls convenient in language bindings. Parameters: String property_name Required (not null) the property to control GObject.Value final Required (not null) The final value of the property Returns: Clutter.Animation The animation itself.	Clutter.Animation
	bind_interval (String *property_name, Interval interval) : Clutter.Animation Binds interval* to the property_name of the GObject attached to animation. Binds interval to the property_name of the GObject attached to animation. The ClutterAnimation will take ownership of the passed ClutterInterval. For more information about animations, see clutter_actor_animate(). If you need to update the interval instance use clutter_animation_update_property() instead. Parameters: String property_name Required (not null) the property to control Clutter.Interval interval Required (not null) a ClutterInterval Returns: Clutter.Animation The animation itself.	Clutter.Animation
	completed () : none Emits the ::completed signal on animation When using this function with a ClutterAnimation created by the clutter_actor_animate() family of functions, animation will be unreferenced and it will not be valid anymore, unless g_object_ref() was called before calling this function or unless a reference was taken inside a handler for the ClutterAnimation::completed signal Emits the ::completed signal on animation When using this function with a ClutterAnimation created by the clutter_actor_animate() family of functions, animation will be unreferenced and it will not be valid anymore, unless g_object_ref() was called before calling this function or unless a reference was taken inside a handler for the ClutterAnimation::completed signal Returns: none	Clutter.Animation
	get_alpha () : Clutter.Alpha Retrieves the ClutterAlpha used by animation. Retrieves the ClutterAlpha used by animation. Returns: Clutter.Alpha the alpha object used by the animation	Clutter.Animation
	get_duration () : guint32 Retrieves the duration of animation, in milliseconds. Retrieves the duration of animation, in milliseconds. Returns: guint32 the duration of the animation	Clutter.Animation
	get_id () : String Retrieves the id of scriptable set using clutter_scriptable_set_id(). Retrieves the id of scriptable set using clutter_scriptable_set_id(). the scriptable object and should never be modified of freed Returns: String the id of the object. The returned string is owned by	Clutter.Scriptable
	get_interval (String *property_name) : Clutter.Interval Retrieves the ClutterInterval* associated to property_name inside animation. Retrieves the ClutterInterval associated to property_name inside animation. property with the same name was found. The returned interval is owned by the ClutterAnimation and should not be unreferenced Parameters: String property_name Required (not null) name of the property Returns: Clutter.Interval a ClutterInterval or NULL if no	Clutter.Animation
	get_loop () : gboolean Retrieves whether animation is looping. Retrieves whether animation is looping. Returns: gboolean TRUE if the animation is looping	Clutter.Animation
	get_mode () : guint32 Retrieves the animation mode of animation, as set by clutter_animation_set_mode(). Retrieves the animation mode of animation, as set by clutter_animation_set_mode(). Returns: guint32 the mode for the animation	Clutter.Animation
	get_object () : GObject.Object Retrieves the GObject attached to animation. Retrieves the GObject attached to animation. Returns: GObject.Object a GObject	Clutter.Animation
	get_timeline () : Clutter.Timeline Retrieves the ClutterTimeline used by animation Retrieves the ClutterTimeline used by animation Returns: Clutter.Timeline the timeline used by the animation	Clutter.Animation
	has_property (String *property_name) : gboolean Checks whether animation* is controlling property_name. Checks whether animation is controlling property_name. ClutterAnimation, FALSE otherwise Parameters: String property_name Required (not null) name of the property Returns: gboolean TRUE if the property is animated by the	Clutter.Animation
	parse_custom_node (Script *script, Value value, String name, Node node) : gboolean Parses the passed JSON node. Parses the passed JSON node. The implementation must set the type of the passed GValue* pointer using g_value_init(). Parameters: Clutter.Script script Required (not null) the ClutterScript creating the scriptable instance GObject.Value value Required (not null) the generic value to be set String name Required (not null) the name of the node Json.Node node Required (not null) the JSON node to be parsed Returns: gboolean TRUE if the node was successfully parsed, FALSE otherwise.	Clutter.Scriptable
	set_alpha (Alpha *alpha) : none Sets alpha* as the ClutterAlpha used by animation. Sets alpha as the ClutterAlpha used by animation. If alpha is not NULL, the ClutterAnimation will take ownership of the ClutterAlpha instance. Parameters: Clutter.Alpha alpha Required (not null) a ClutterAlpha, or NULL to unset the current ClutterAlpha Returns: none	Clutter.Animation
	set_custom_property (Script *script, String name, Value value) : none Overrides the common properties setting. Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties. Parameters: Clutter.Script script* Required (not null) the ClutterScript creating the scriptable instance String name Required (not null) the name of the property GObject.Value value Required (not null) the value of the property Returns: none	Clutter.Scriptable
	set_duration (guint32 *msecs) : none Sets the duration of animation* in milliseconds. Sets the duration of animation in milliseconds. This function will set ClutterAnimation:alpha and ClutterAnimation:timeline if needed. Parameters: guint32 msecs Required (not null) the duration in milliseconds Returns: none	Clutter.Animation
	set_id (String *id_) : none Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by ClutterScript. Parameters: String id_* Required (not null) Returns: none	Clutter.Scriptable
	set_loop (gboolean *loop) : none Sets whether animation* should loop over itself once finished. Sets whether animation should loop over itself once finished. A looping ClutterAnimation will not emit the ClutterAnimation::completed signal when finished. This function will set ClutterAnimation:alpha and ClutterAnimation:timeline if needed. Parameters: gboolean loop Required (not null) TRUE if the animation should loop Returns: none	Clutter.Animation
	set_mode (guint32 *mode) : none Sets the animation mode* of animation. Sets the animation mode of animation. The animation mode is a logical id, either coming from the ClutterAnimationMode enumeration or the return value of clutter_alpha_register_func(). This function will also set ClutterAnimation:alpha if needed. Parameters: guint32 mode Required (not null) an animation mode logical id Returns: none	Clutter.Animation
	set_object (Object *object) : none Attaches animation* to object. Attaches animation to object. The ClutterAnimation will take a reference on object. Parameters: GObject.Object object Required (not null) a GObject Returns: none	Clutter.Animation
	set_timeline (Timeline *timeline) : none Sets the ClutterTimeline* used by animation. Sets the ClutterTimeline used by animation. Parameters: Clutter.Timeline timeline Required (not null) a ClutterTimeline, or NULL to unset the current ClutterTimeline Returns: none	Clutter.Animation
	unbind_property (String *property_name) : none Removes property_name* from the list of animated properties. Removes property_name from the list of animated properties. Parameters: String property_name Required (not null) name of the property Returns: none	Clutter.Animation
	update (String *property_name, Value final) : Clutter.Animation Updates the final* value of the interval for property_name Updates the final value of the interval for property_name Parameters: String property_name Required (not null) name of the property GObject.Value final Required (not null) The final value of the property Returns: Clutter.Animation The animation itself.	Clutter.Animation
	update_interval (String *property_name, Interval interval) : none Changes the interval* for property_name. Changes the interval for property_name. The ClutterAnimation will take ownership of the passed ClutterInterval. Parameters: String property_name Required (not null) name of the property Clutter.Interval interval Required (not null) a ClutterInterval Returns: none	Clutter.Animation

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	completed (Animation *self) : none The ::completed signal is emitted once the animation has been completed. The ::completed signal is emitted once the animation has been completed. The animation* instance is guaranteed to be valid for the entire duration of the signal emission chain. Parameters: Clutter.Animation self Returns: {none}	Clutter.Animation
	started (Animation *self) : none The ::started signal is emitted once the animation has been started The ::started signal is emitted once the animation has been started Parameters: Clutter.Animation self* Returns: {none}	Clutter.Animation

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Clutter.Actor Method	animate_with_alphav (Alpha *alpha, gint32 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.Actor Method	animate_with_timelinev (guint32 *mode, Timeline timeline, gint32 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.Actor Method	animatev (guint32 *mode, guint32 duration, gint32 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.Actor Method	get_animation () : Clutter.Animation Retrieves the ClutterAnimation used by actor, if clutter_actor_animate() has been called on actor.
Clutter.Animatable Method	animate_property (Animation *animation, String property_name, Value initial_value, Value final_value, gdouble progress, Value value) : gboolean Calls the animate_property() virtual function for animatable*.

Un-official Seed Documentation

Clutter

Classes

Interfaces

Structs

Unions

Enums

Class Clutter.Animation