Clutter.AnimatorKey

Fields

None

Methods

  get_mode ()
  get_object ()
  get_progress ()
  get_property_name ()
  get_property_type ()
  get_value (value)

Details

class Clutter.AnimatorKey

A key frame inside a Clutter.Animator

New in version 1.2.

Deprecated since version 1.12.

get_mode()
Returns:the mode of a Clutter.AnimatorKey
Return type:int

Retrieves the mode of a Clutter.Animator key, for the first key of a property for an object this represents the whether the animation is open ended and or curved for the remainding keys for the property it represents the easing mode.

New in version 1.2.

Deprecated since version 1.12: Use Clutter.KeyframeTransition instead

get_object()
Returns:the object an animator_key exist for.
Return type:GObject.Object

Retrieves the object a key applies to.

New in version 1.2.

Deprecated since version 1.12: Use Clutter.KeyframeTransition instead

get_progress()
Returns:the progress defined for a Clutter.Animator key.
Return type:float

Retrieves the progress of an clutter_animator_key

New in version 1.2.

Deprecated since version 1.12: Use Clutter.KeyframeTransition instead

get_property_name()
Returns:the name of the property an animator_key exist for.
Return type:str

Retrieves the name of the property a key applies to.

New in version 1.2.

Deprecated since version 1.12: Use Clutter.KeyframeTransition instead

get_property_type()
Returns:the GObject.GType of the property
Return type:GObject.GType

Retrieves the GObject.GType of the property a key applies to

You can use this type to initialize the GObject.Value to pass to Clutter.AnimatorKey.get_value()

New in version 1.2.

Deprecated since version 1.12: Use Clutter.KeyframeTransition instead

get_value(value)
Parameters:value (GObject.Value) – a GObject.Value initialized with the correct type for the animator key
Returns:True if the passed GObject.Value was successfully set, and False otherwise
Return type:bool

Retrieves a copy of the value for a Clutter.AnimatorKey.

The passed in GObject.Value needs to be already initialized for the value type of the key or to a type that allow transformation from the value type of the key.

Use GObject.Value.unset() when done.

New in version 1.2.

Deprecated since version 1.12: Use Clutter.KeyframeTransition instead