Clutter.Transition¶

Subclasses:: Clutter.PropertyTransition, Clutter.TransitionGroup

Methods¶

Inherited:: Clutter.Timeline (39), GObject.Object (37), Clutter.Scriptable (4)
Structs:: GObject.ObjectClass (5)

	`get_animatable` ()
	`get_interval` ()
	`get_remove_on_complete` ()
	`set_animatable` (animatable)
	`set_from` (value)
	`set_interval` (interval)
	`set_remove_on_complete` (remove_complete)
	`set_to` (value)

Virtual Methods¶

Inherited:: Clutter.Timeline (6), GObject.Object (7), Clutter.Scriptable (4)

	`do_attached` (animatable)
	`do_compute_value` (animatable, interval, progress)
	`do_detached` (animatable)

Properties¶

Inherited:: Clutter.Timeline (7)

Name	Type	Flags	Short Description
`animatable`	`Clutter.Animatable`	r/w	The animatable object
`interval`	`Clutter.Interval`	r/w	The interval of values to transition
`remove-on-complete`	`bool`	r/w	Detach the transition when completed

Signals¶

Inherited:: Clutter.Timeline (6), GObject.Object (1)

Fields¶

Inherited:: Clutter.Timeline (6), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Clutter.Timeline`	r

Class Details¶

class Clutter.Transition(**kwargs)¶

Bases:: Clutter.Timeline
Abstract:: Yes
Structure:: Clutter.TransitionClass

The Clutter.Transition structure contains private data and should only be accessed using the provided API.

New in version 1.10.

get_animatable()¶

Returns:: a Clutter.Animatable, or None; the returned animatable is owned by the Clutter.Transition, and it should not be freed directly.
Return type:: Clutter.Animatable

Retrieves the Clutter.Animatable set using Clutter.Transition.set_animatable().

New in version 1.10.

get_interval()¶

Returns:: a Clutter.Interval, or None; the returned interval is owned by the Clutter.Transition and it should not be freed directly
Return type:: Clutter.Interval

Retrieves the interval set using Clutter.Transition.set_interval()

New in version 1.10.

get_remove_on_complete()¶

Returns:: True if the self should be detached when complete, and False otherwise
Return type:: bool

Retrieves the value of the Clutter.Transition :remove-on-complete property.

New in version 1.10.

set_animatable(animatable)¶

Parameters:: animatable (Clutter.Animatable or None) – a Clutter.Animatable, or None

Sets the Clutter.Transition :animatable property.

The self will acquire a reference to the animatable instance, and will call the Clutter.Transition.do_attached() virtual function.

If an existing Clutter.Animatable is attached to self, the reference will be released, and the Clutter.Transition.do_detached() virtual function will be called.

New in version 1.10.

set_from(value)¶

Parameters:: value (GObject.Value) – a GObject.Value with the initial value of the transition

Sets the initial value of the transition.

This is a convenience function that will either create the Clutter.Interval used by self, or will update it if the Clutter.Transition :interval is already set.

This function will copy the contents of value, so it is safe to call GObject.Value.unset() after it returns.

If self already has a Clutter.Transition :interval set, then value must hold the same type, or a transformable type, as the interval’s Clutter.Interval :value-type property.

This function is meant to be used by language bindings.

New in version 1.12.

set_interval(interval)¶

Parameters:: interval (Clutter.Interval or None) – a Clutter.Interval, or None

Sets the Clutter.Transition :interval property using interval.

The self will acquire a reference on the interval, sinking the floating flag on it if necessary.

New in version 1.10.

set_remove_on_complete(remove_complete)¶

Parameters:: remove_complete (bool) – whether to detach self when complete

Sets whether self should be detached from the Clutter.Animatable set using Clutter.Transition.set_animatable() when the Clutter.Timeline ::completed signal is emitted.

New in version 1.10.

set_to(value)¶

Parameters:: value (GObject.Value) – a GObject.Value with the final value of the transition

Sets the final value of the transition.

This is a convenience function that will either create the Clutter.Interval used by self, or will update it if the Clutter.Transition :interval is already set.

This function will copy the contents of value, so it is safe to call GObject.Value.unset() after it returns.

If self already has a Clutter.Transition :interval set, then value must hold the same type, or a transformable type, as the interval’s Clutter.Interval :value-type property.

This function is meant to be used by language bindings.

New in version 1.12.

do_attached(animatable) virtual¶

Parameters:: animatable (Clutter.Animatable) –

virtual function; called when a transition is attached to a Clutter.Animatable instance

do_compute_value(animatable, interval, progress) virtual¶

Parameters:

animatable (Clutter.Animatable) –
interval (Clutter.Interval) –
progress (float) –

virtual function; called each frame to compute and apply the interpolation of the interval

do_detached(animatable) virtual¶

Parameters:: animatable (Clutter.Animatable) –

virtual function; called when a transition is detached from a Clutter.Animatable instance

Property Details¶

Clutter.Transition.props.animatable¶

Name:: animatable
Type:: Clutter.Animatable
Default Value:: None
Flags:: READABLE, WRITABLE

The Clutter.Animatable instance currently being animated.

New in version 1.10.

Clutter.Transition.props.interval¶

Name:: interval
Type:: Clutter.Interval
Default Value:: None
Flags:: READABLE, WRITABLE

The Clutter.Interval used to describe the initial and final states of the transition.

New in version 1.10.

Clutter.Transition.props.remove_on_complete¶

Name:: remove-on-complete
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Clutter.Transition should be automatically detached from the Clutter.Transition :animatable instance whenever the Clutter.Timeline ::stopped signal is emitted.

The Clutter.Transition :remove-on-complete property takes into account the value of the Clutter.Timeline :repeat-count property, and it only detaches the transition if the transition is not repeating.

New in version 1.10.