Clutter.Animatable

Implementations:

Clutter.Actor

Methods

	animate_property (animation, property_name, initial_value, final_value, progress, value)
	find_property (property_name)
	get_initial_state (property_name, value)
	interpolate_value (property_name, interval, progress)
	set_final_state (property_name, value)

Virtual Methods

	do_animate_property (animation, property_name, initial_value, final_value, progress, value)
	do_find_property (property_name)
	do_get_initial_state (property_name, value)
	do_interpolate_value (property_name, interval, progress)
	do_set_final_state (property_name, value)

Properties

None

Signals

None

Fields

None

Class Details

class Clutter.Animatable

Bases:

GObject.GInterface

Structure:

Clutter.AnimatableIface

Clutter.Animatable is an opaque structure whose members cannot be directly accessed

New in version 1.0.

animate_property(animation, property_name, initial_value, final_value, progress, value)

Parameters:

• animation (Clutter.Animation) – a Clutter.Animation

• property_name (str) – the name of the animated property

• initial_value (GObject.Value) – the initial value of the animation interval

• final_value (GObject.Value) – the final value of the animation interval

• progress (float) – the progress factor

• value (GObject.Value) – return location for the animation value

Returns:

True if the value has been validated and can be applied to the Clutter.Animatable, and False otherwise

Return type:

bool

Calls the animate_property() virtual function for self.

The initial_value and final_value GObject.Value s must contain the same type; value must have been initialized to the same type of initial_value and final_value.

All implementation of the Clutter.Animatable interface must implement this function.

New in version 1.0.

Deprecated since version 1.8: Use Clutter.Animatable.interpolate_value() instead

find_property(property_name)

Parameters:

property_name (str) – the name of the animatable property to find

Returns:

The GObject.ParamSpec for the given property or None

Return type:

GObject.ParamSpec

Finds the GObject.ParamSpec for property_name

New in version 1.4.

get_initial_state(property_name, value)

Parameters:

• property_name (str) – the name of the animatable property to retrieve

• value (GObject.Value) – a GObject.Value initialized to the type of the property to retrieve

Retrieves the current state of property_name and sets value with it

New in version 1.4.

interpolate_value(property_name, interval, progress)

Parameters:

• property_name (str) – the name of the property to interpolate

• interval (Clutter.Interval) – a Clutter.Interval with the animation range

• progress (float) – the progress to use to interpolate between the initial and final values of the interval

Returns:

True if the interpolation was successful, and False otherwise

value:

return location for an initialized GObject.Value using the same type of the interval

Return type:

(bool, value: GObject.Value)

Asks a Clutter.Animatable implementation to interpolate a a named property between the initial and final values of a Clutter.Interval, using progress as the interpolation value, and store the result inside value.

This function should be used for every property animation involving Clutter.Animatable s.

This function replaces Clutter.Animatable.animate_property().

New in version 1.8.

set_final_state(property_name, value)

Parameters:

• property_name (str) – the name of the animatable property to set

• value (GObject.Value) – the value of the animatable property to set

Sets the current state of property_name to value

New in version 1.4.

do_animate_property(animation, property_name, initial_value, final_value, progress, value) virtual

Parameters:

• animation (Clutter.Animation) – a Clutter.Animation

• property_name (str) – the name of the animated property

• initial_value (GObject.Value) – the initial value of the animation interval

• final_value (GObject.Value) – the final value of the animation interval

• progress (float) – the progress factor

• value (GObject.Value) – return location for the animation value

Returns:

True if the value has been validated and can be applied to the Clutter.Animatable, and False otherwise

Return type:

bool

Calls the animate_property() virtual function for animatable.

The initial_value and final_value GObject.Value s must contain the same type; value must have been initialized to the same type of initial_value and final_value.

All implementation of the Clutter.Animatable interface must implement this function.

New in version 1.0.

Deprecated since version 1.8: Use Clutter.Animatable.interpolate_value() instead

do_find_property(property_name) virtual

Parameters:

property_name (str) – the name of the animatable property to find

Returns:

The GObject.ParamSpec for the given property or None

Return type:

GObject.ParamSpec

Finds the GObject.ParamSpec for property_name

New in version 1.4.

do_get_initial_state(property_name, value) virtual

Parameters:

• property_name (str) – the name of the animatable property to retrieve

• value (GObject.Value) – a GObject.Value initialized to the type of the property to retrieve

Retrieves the current state of property_name and sets value with it

New in version 1.4.

do_interpolate_value(property_name, interval, progress) virtual

Parameters:

• property_name (str) – the name of the property to interpolate

• interval (Clutter.Interval) – a Clutter.Interval with the animation range

• progress (float) – the progress to use to interpolate between the initial and final values of the interval

Returns:

True if the interpolation was successful, and False otherwise

value:

return location for an initialized GObject.Value using the same type of the interval

Return type:

(bool, value: GObject.Value)

Asks a Clutter.Animatable implementation to interpolate a a named property between the initial and final values of a Clutter.Interval, using progress as the interpolation value, and store the result inside value.

This function should be used for every property animation involving Clutter.Animatable s.

This function replaces Clutter.Animatable.animate_property().

New in version 1.8.

do_set_final_state(property_name, value) virtual

Parameters:

• property_name (str) – the name of the animatable property to set

• value (GObject.Value) – the value of the animatable property to set

Sets the current state of property_name to value

New in version 1.4.