Clutter.KeyframeTransition

g Clutter.KeyframeTransition Clutter.KeyframeTransition Clutter.PropertyTransition Clutter.PropertyTransition Clutter.PropertyTransition->Clutter.KeyframeTransition Clutter.Scriptable Clutter.Scriptable Clutter.Timeline Clutter.Timeline Clutter.Scriptable->Clutter.Timeline Clutter.Transition Clutter.Transition Clutter.Timeline->Clutter.Transition Clutter.Transition->Clutter.PropertyTransition GObject.GInterface GObject.GInterface GObject.GInterface->Clutter.Scriptable GObject.Object GObject.Object GObject.Object->Clutter.Timeline

Subclasses:

None

Methods

Inherited:

Clutter.PropertyTransition (3), Clutter.Transition (8), Clutter.Timeline (39), GObject.Object (37), Clutter.Scriptable (4)

Structs:

GObject.ObjectClass (5)

class

new (property_name)

clear ()

get_key_frame (index_)

get_n_key_frames ()

set_key_frame (index_, key, mode, value)

set_key_frames (key_frames)

set_modes (modes)

set_values (values)

Virtual Methods

Inherited:

Clutter.Transition (3), Clutter.Timeline (6), GObject.Object (7), Clutter.Scriptable (4)

Properties

Inherited:

Clutter.PropertyTransition (1), Clutter.Transition (3), Clutter.Timeline (7)

Signals

Inherited:

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

Fields

Inherited:

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

Name

Type

Access

Description

parent_instance

Clutter.PropertyTransition

r

Class Details

class Clutter.KeyframeTransition(**kwargs)
Bases:

Clutter.PropertyTransition

Abstract:

No

Structure:

Clutter.KeyframeTransitionClass

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

New in version 1.12.

classmethod new(property_name)
Parameters:

property_name (str) – the property to animate

Returns:

the newly allocated Clutter.KeyframeTransition instance. Use GObject.Object.unref() when done to free its resources.

Return type:

Clutter.Transition

Creates a new Clutter.KeyframeTransition for property_name.

New in version 1.12.

clear()

Removes all key frames from self.

New in version 1.12.

get_key_frame(index_)
Parameters:

index (int) – the index of the key frame

Returns:

key:

return location for the key, or None

mode:

return location for the easing mode, or None

value:

a GObject.Value initialized with the type of the values

Return type:

(key: float, mode: Clutter.AnimationMode, value: GObject.Value)

Retrieves the details of the key frame at index_ inside self.

The self must already have key frames set, and index_ must be smaller than the number of key frames.

New in version 1.12.

get_n_key_frames()
Returns:

the number of key frames

Return type:

int

Retrieves the number of key frames inside self.

New in version 1.12.

set_key_frame(index_, key, mode, value)
Parameters:

Sets the details of the key frame at index_ inside self.

The self must already have a key frame at index_, and index_ must be smaller than the number of key frames inside self.

New in version 1.12.

set_key_frames(key_frames)
Parameters:

key_frames ([float]) – an array of keys between 0.0 and 1.0, one for each key frame

Sets the keys for each key frame inside self.

If self does not hold any key frame, n_key_frames key frames will be created; if self already has key frames, key_frames must have at least as many elements as the number of key frames.

New in version 1.12.

set_modes(modes)
Parameters:

modes ([Clutter.AnimationMode]) – an array of easing modes, one for each key frame

Sets the easing modes for each key frame inside self.

If self does not hold any key frame, n_modes key frames will be created; if self already has key frames, modes must have at least as many elements as the number of key frames.

New in version 1.12.

set_values(values)
Parameters:

values ([GObject.Value]) – an array of values, one for each key frame

Sets the values for each key frame inside self.

If self does not hold any key frame, n_values key frames will be created; if self already has key frames, values must have at least as many elements as the number of key frames.

New in version 1.12.