Class: Clutter::KeyframeTransition

Inherits:
PropertyTransition show all
Defined in:
(unknown)

Overview

The ClutterKeyframeTransitionClass structure contains only private data.

Instance Method Summary collapse

Methods inherited from PropertyTransition

#property_name, #property_name=

Methods inherited from Transition

#animatable, #animatable=, #from_value=, #interval, #interval=, #remove_on_complete, #remove_on_complete=, #remove_on_complete?, #set_from, #set_to, #to_value=

Methods inherited from Timeline

#add_marker, #add_marker_at_time, #advance, #advance_to_marker, #auto_reverse, #auto_reverse=, #auto_reverse?, #clone, #current_repeat, #delay, #delay=, #delta, #direction, #direction=, #duration, #duration=, #duration_hint, #elapsed_time, #get_cubic_bezier_progress, #get_step_progress, #has_marker, #is_playing, #list_markers, #loop, #loop=, #loop?, #pause, #progress, #progress_mode, #progress_mode=, #remove_marker, #repeat_count, #repeat_count=, #rewind, #set_cubic_bezier_progress, #set_progress_func, #set_step_progress, #skip, #start, #stop

Constructor Details

#initialize(property_name) ⇒ Clutter::Transition

Creates a new Clutter::KeyframeTransition for property_name.

Parameters:

  • property_name (String) —

    the property to animate

Instance Method Details

#clear ⇒ nil

Removes all key frames from transition.

Returns:

  • (nil)

#get_key_frame(index_, key, mode, value) ⇒ nil

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

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

Parameters:

  • index_ (Integer) —

    the index of the key frame

  • key (Float) —

    return location for the key, or nil

  • mode (Clutter::AnimationMode) —

    return location for the easing mode, or nil

  • value (GObject::Value) —

    a #GValue initialized with the type of the values

Returns:

  • (nil)

#n_key_frames ⇒ Integer

Retrieves the number of key frames inside transition.

Returns:

  • (Integer) —

    the number of key frames

#set(gtype, n_key_frames, array) ⇒ nil

Sets the key frames of the transition.

This variadic arguments function is a convenience for C developers; language bindings should use clutter_keyframe_transition_set_key_frames(), clutter_keyframe_transition_set_modes(), and clutter_keyframe_transition_set_values() instead.

Parameters:

  • gtype (GLib::Type) —

    the type of the values to use for the key frames

  • n_key_frames (Integer) —

    the number of key frames between the initial and final values

  • array (Array) —

    a list of tuples, containing the key frame index, the value at the key frame, and the animation mode

Returns:

  • (nil)

#set_key_frame(index_, key, mode, value) ⇒ nil

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

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

Parameters:

  • index_ (Integer) —

    the index of the key frame

  • key (Float) —

    the key of the key frame

  • mode (Clutter::AnimationMode) —

    the easing mode of the key frame

  • value (GObject::Value) —

    a #GValue containing the value of the key frame

Returns:

  • (nil)

#set_key_frames(n_key_frames, key_frames) ⇒ nil

Sets the keys for each key frame inside transition.

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

Parameters:

  • n_key_frames (Integer) —

    the number of values

  • key_frames (Array<Float>) —

    an array of keys between 0.0 and 1.0, one for each key frame

Returns:

  • (nil)

#set_modes(n_modes, modes) ⇒ nil

Sets the easing modes for each key frame inside transition.

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

Parameters:

  • n_modes (Integer) —

    the number of easing modes

  • modes (Array<Clutter::AnimationMode>) —

    an array of easing modes, one for each key frame

Returns:

  • (nil)

#set_values(n_values, values) ⇒ nil

Sets the values for each key frame inside transition.

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

Parameters:

  • n_values (Integer) —

    the number of values

  • values (Array<GObject::Value>) —

    an array of values, one for each key frame

Returns:

  • (nil)