Class: Clutter::Transition

Inherits:
Timeline show all
Defined in:
(unknown)

Overview

The Clutter::TransitionClass structure contains private data.

Direct Known Subclasses

PropertyTransition, TransitionGroup

Instance Method Summary collapse

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, #initialize, #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

This class inherits a constructor from Clutter::Timeline

Instance Method Details

#animatable ⇒ Clutter::Animatable

The Clutter::Animatable instance currently being animated.

Returns:

#animatable=(animatable) ⇒ Clutter::Animatable

The Clutter::Animatable instance currently being animated.

Parameters:

Returns:

#from_value=(value) ⇒ nil

Sets the initial value of the transition.

This is a convenience function that will either create the Clutter::Interval used by transition, 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 g_value_unset() after it returns.

If transition 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.

Parameters:

  • value (GObject::Value) —

    a #GValue with the initial value of the transition

Returns:

  • (nil)

#interval ⇒ Clutter::Interval

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

Returns:

#interval=(interval) ⇒ Clutter::Interval

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

Parameters:

Returns:

#remove_on_complete ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the transition should be detached when complete, and false otherwise

#remove_on_complete=(remove_on_complete) ⇒ Boolean

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.

Parameters:

  • remove_on_complete (Boolean)

Returns:

  • (Boolean) —

    remove-on-complete

  • (Boolean) —

    remove-on-complete

#remove_on_complete? ⇒ Boolean

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.

Returns:

  • (Boolean) —

    remove-on-complete

#set_from(value_type, array) ⇒ nil

Sets the initial value of the transition.

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

If transition 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 is a convenience function for the C API; language bindings should use clutter_transition_set_from_value() instead.

Parameters:

  • value_type (GLib::Type) —

    the type of the value to set

  • array (Array) —

    the initial value

Returns:

  • (nil)

#set_to(value_type, array) ⇒ nil

Sets the final value of the transition.

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

If transition 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 is a convenience function for the C API; language bindings should use clutter_transition_set_to_value() instead.

Parameters:

  • value_type (GLib::Type) —

    the type of the value to set

  • array (Array) —

    the final value

Returns:

  • (nil)

#to_value=(value) ⇒ nil

Sets the final value of the transition.

This is a convenience function that will either create the Clutter::Interval used by transition, 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 g_value_unset() after it returns.

If transition 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.

Parameters:

  • value (GObject::Value) —

    a #GValue with the final value of the transition

Returns:

  • (nil)