Clutter.Animator¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
The duration of the animation |
||
r/w |
The timeline of the animation |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent_instance |
r |
Class Details¶
- class Clutter.Animator(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
The
Clutter.Animator
structure contains only private data and should be accessed using the provided APINew in version 1.2.
Deprecated since version 1.12.
- classmethod new()¶
- Returns:
a new
Clutter.Animator
.- Return type:
Creates a new
Clutter.Animator
instanceNew in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- compute_value(object, property_name, progress, value)¶
- Parameters:
object (
GObject.Object
) – aGObject.Object
property_name (
str
) – the name of the property on object to checkprogress (
float
) – a value between 0.0 and 1.0value (
GObject.Value
) – an initialized value to store the computed result
- Returns:
True
if the computation yields has a value, otherwise (when an error occurs or the progress is before any of the keys)False
is returned and theGObject.Value
is left untouched- Return type:
Compute the value for a managed property at a given progress.
If the property is an ease-in property, the current value of the property on the object will be used as the starting point for computation.
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- get_duration()¶
- Returns:
the duration of the animation, in milliseconds
- Return type:
Retrieves the current duration of an animator
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- get_keys(object, property_name, progress)¶
- Parameters:
object (
GObject.Object
orNone
) – aGObject.Object
to search for, orNone
for all objectsproperty_name (
str
orNone
) – a specific property name to query for, orNone
for all propertiesprogress (
float
) – a specific progress to search for, or a negative value for all progresses
- Returns:
a list of
Clutter.AnimatorKey
s; the contents of the list are owned by theClutter.Animator
, but you should free the returned list when done, using g_list_free()- Return type:
Returns a list of pointers to opaque structures with accessor functions that describe the keys added to an animator.
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- get_timeline()¶
- Returns:
the
Clutter.Timeline
that drives the animator- Return type:
Get the timeline hooked up for driving the
Clutter.Animator
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- property_get_ease_in(object, property_name)¶
- Parameters:
object (
GObject.Object
) – aGObject.Object
property_name (
str
) – the name of a property on object
- Returns:
True
if the property is eased in- Return type:
Checks if a property value is to be eased into the animation.
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- property_get_interpolation(object, property_name)¶
- Parameters:
object (
GObject.Object
) – aGObject.Object
property_name (
str
) – the name of a property on object
- Returns:
a
Clutter.Interpolation
value.- Return type:
Get the interpolation used by animator for a property on a particular object.
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- property_set_ease_in(object, property_name, ease_in)¶
- Parameters:
object (
GObject.Object
) – aGObject.Object
property_name (
str
) – the name of a property on objectease_in (
bool
) – we are going to be easing in this property
Sets whether a property value is to be eased into the animation.
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- property_set_interpolation(object, property_name, interpolation)¶
- Parameters:
object (
GObject.Object
) – aGObject.Object
property_name (
str
) – the name of a property on objectinterpolation (
Clutter.Interpolation
) – theClutter.Interpolation
to use
Set the interpolation method to use,
Clutter.Interpolation.LINEAR
causes the values to linearly change between the values, andClutter.Interpolation.CUBIC
causes the values to smoothly change between the values.New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- remove_key(object, property_name, progress)¶
- Parameters:
object (
GObject.Object
orNone
) – aGObject.Object
to search for, orNone
for allproperty_name (
str
orNone
) – a specific property name to query for, orNone
for allprogress (
float
) – a specific progress to search for or a negative value for all
Removes all keys matching the conditions specificed in the arguments.
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- set_duration(duration)¶
- Parameters:
duration (
int
) – milliseconds a run of the animator should last.
Runs the timeline of the
Clutter.Animator
with a duration in msecs as specified.New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- set_key(object, property_name, mode, progress, value)¶
- Parameters:
object (
GObject.Object
) – aGObject.Object
property_name (
str
) – the property to specify a key formode (
int
) – the id of the alpha function to useprogress (
float
) – the normalized range at which stage of the animation this value appliesvalue (
GObject.Value
) – the value property_name should have at progress.
- Returns:
The animator instance
- Return type:
Sets a single key in the
Clutter.Animator
for the property_name of object at progress.See also: clutter_animator_set()
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- set_timeline(timeline)¶
- Parameters:
timeline (
Clutter.Timeline
) – aClutter.Timeline
Sets an external timeline that will be used for driving the animation
New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- start()¶
- Returns:
the
Clutter.Timeline
that drives the animator. The returned timeline is owned by theClutter.Animator
and it should not be unreferenced- Return type:
Start the
Clutter.Animator
, this is a thin wrapper that rewinds and starts the animators current timeline.New in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
Property Details¶
- Clutter.Animator.props.duration¶
-
The duration of the
Clutter.Timeline
used by theClutter.Animator
to drive the animationNew in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead
- Clutter.Animator.props.timeline¶
- Name:
timeline
- Type:
- Default Value:
- Flags:
The
Clutter.Timeline
used by theClutter.Animator
to drive the animationNew in version 1.2.
Deprecated since version 1.12: Use
Clutter.KeyframeTransition
instead