#include <animation.h>
Public Member Functions | |
virtual | ~Animation () |
ClutterAnimation * | gobj () |
Provides access to the underlying C GObject. | |
const ClutterAnimation * | gobj () const |
Provides access to the underlying C GObject. | |
ClutterAnimation * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | set_object (const Glib::RefPtr< Glib::Object > &object) |
Attaches animation to object. | |
Glib::RefPtr< Glib::Object > | get_object () |
Retrieves the Object attached to animation. | |
Glib::RefPtr< const Glib::Object > | get_object () const |
Retrieves the Object attached to animation. | |
void | set_mode (gulong mode) |
Sets the animation mode of animation. | |
gulong | get_mode () const |
Retrieves the animation mode of animation, as set by set_mode(). | |
void | set_duration (int msecs) |
Sets the duration of animation in milliseconds. | |
guint | get_duration () const |
Retrieves the duration of animation, in milliseconds. | |
void | set_loop (bool loop=true) |
Sets whether animation should loop over itself once finished. | |
bool | get_loop () const |
Retrieves whether animation is looping. | |
void | set_timeline (const Glib::RefPtr< Timeline > &timeline) |
Sets the Clutter::Timeline used by animation. | |
Glib::RefPtr< Timeline > | get_timeline () const |
Retrieves the Clutter::Timeline used by animation. | |
void | set_alpha (const Glib::RefPtr< Alpha > &alpha) |
Sets alpha as the Clutter::Alpha used by animation. | |
Glib::RefPtr< Alpha > | get_alpha () const |
Retrieves the Clutter::Alpha used by animation. | |
void | completed () |
Emits the completed signal on animation. | |
Glib::RefPtr< Animation > | bind (const std::string &property_name, const Glib::ValueBase &final) |
Adds a single property with name property_name to the animation animation. | |
void | bind_interval (const std::string &property_name, const Glib::RefPtr< Interval > &interval) |
Binds interval to the property_name of the Object attached to animation. | |
void | update_interval (const std::string &property_name, const Glib::RefPtr< Interval > &interval) |
Changes the interval for property_name. | |
bool | has_property (const std::string &property_name) const |
Checks whether animation is controlling property_name. | |
void | unbind_property (const std::string &property_name) |
Removes property_name from the list of animated properties. | |
Glib::RefPtr< Interval > | get_interval (const std::string &property_name) const |
Retrieves the Clutter::Interval associated to property_name inside animation. | |
Glib::SignalProxy0< void > | signal_started () |
Glib::SignalProxy0< void > | signal_completed () |
Static Public Member Functions | |
static Glib::RefPtr< Animation > | create () |
Protected Member Functions | |
Animation () | |
virtual void | on_started () |
virtual void | on_completed () |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Clutter::Animation > | wrap (ClutterAnimation *object, bool take_copy=false) |
A Glib::wrap() method for this object. |
virtual Clutter::Animation::~Animation | ( | ) | [virtual] |
Clutter::Animation::Animation | ( | ) | [protected] |
Glib::RefPtr<Animation> Clutter::Animation::bind | ( | const std::string & | property_name, | |
const Glib::ValueBase & | final | |||
) |
Adds a single property with name property_name to the animation animation.
For more information about animations, see Clutter::Actor::animate().
This method returns the animation primarily to make chained calls convenient in language bindings.
property_name | The property to control. | |
final | The final value of the property. |
void Clutter::Animation::bind_interval | ( | const std::string & | property_name, | |
const Glib::RefPtr< Interval > & | interval | |||
) |
Binds interval to the property_name of the Object attached to animation.
The Clutter::Animation will take ownership of the passed Clutter::Interval. For more information about animations, see Clutter::Actor::animate().
If you need to update the interval instance use clutter_animation_update_property() instead.
property_name | The property to control. | |
interval | (transfer full): a Clutter::Interval. |
void Clutter::Animation::completed | ( | ) |
Emits the completed signal on animation.
When using this function with a Clutter::Animation created by the Clutter::Actor::animate() family of functions, animation will be unreferenced and it will not be valid anymore, unless Glib::object_ref() was called before calling this function or unless a reference was taken inside a handler for the Clutter::Animation::completed signal
Since: 1.0
static Glib::RefPtr<Animation> Clutter::Animation::create | ( | ) | [static] |
Glib::RefPtr<Alpha> Clutter::Animation::get_alpha | ( | ) | const |
Retrieves the Clutter::Alpha used by animation.
Since: 1.0.
guint Clutter::Animation::get_duration | ( | ) | const |
Retrieves the duration of animation, in milliseconds.
Since: 1.0.
Glib::RefPtr<Interval> Clutter::Animation::get_interval | ( | const std::string & | property_name | ) | const |
Retrieves the Clutter::Interval associated to property_name inside animation.
property_name | Name of the property. |
0
if no property with the same name was found. The returned interval is owned by the Clutter::Animation and should not be unreferencedSince: 1.0.
bool Clutter::Animation::get_loop | ( | ) | const |
Retrieves whether animation is looping.
true
if the animation is loopingSince: 1.0.
gulong Clutter::Animation::get_mode | ( | ) | const |
Retrieves the animation mode of animation, as set by set_mode().
Since: 1.0.
Glib::RefPtr<const Glib::Object> Clutter::Animation::get_object | ( | ) | const |
Retrieves the Object attached to animation.
Since: 1.0.
Glib::RefPtr<Glib::Object> Clutter::Animation::get_object | ( | ) |
Retrieves the Object attached to animation.
Since: 1.0.
Glib::RefPtr<Timeline> Clutter::Animation::get_timeline | ( | ) | const |
Retrieves the Clutter::Timeline used by animation.
Since: 1.0.
const ClutterAnimation* Clutter::Animation::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
ClutterAnimation* Clutter::Animation::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
ClutterAnimation* Clutter::Animation::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Clutter::Animation::has_property | ( | const std::string & | property_name | ) | const |
Checks whether animation is controlling property_name.
property_name | Name of the property. |
true
if the property is animated by the Clutter::Animation, false
otherwiseSince: 1.0.
virtual void Clutter::Animation::on_completed | ( | ) | [protected, virtual] |
virtual void Clutter::Animation::on_started | ( | ) | [protected, virtual] |
void Clutter::Animation::set_alpha | ( | const Glib::RefPtr< Alpha > & | alpha | ) |
Sets alpha as the Clutter::Alpha used by animation.
If alpha is not 0
, the Clutter::Animation will take ownership of the Clutter::Alpha instance.
Since: 1.0
alpha | A Clutter::Alpha, or 0 to unset the current Clutter::Alpha. |
void Clutter::Animation::set_duration | ( | int | msecs | ) |
Sets the duration of animation in milliseconds.
This function will set Clutter::Animation:alpha and Clutter::Animation:timeline if needed.
Since: 1.0
msecs | The duration in milliseconds. |
void Clutter::Animation::set_loop | ( | bool | loop = true |
) |
Sets whether animation should loop over itself once finished.
A looping Clutter::Animation will not emit the Clutter::Animation::completed signal when finished.
This function will set Clutter::Animation:alpha and Clutter::Animation:timeline if needed.
Since: 1.0
loop | true if the animation should loop. |
void Clutter::Animation::set_mode | ( | gulong | mode | ) |
Sets the animation mode of animation.
The animation mode is a logical id, either coming from the Clutter::AnimationMode enumeration or the return value of Clutter::Alpha::register_func().
This function will also set Clutter::Animation:alpha if needed.
Since: 1.0
mode | An animation mode logical id. |
void Clutter::Animation::set_object | ( | const Glib::RefPtr< Glib::Object > & | object | ) |
Attaches animation to object.
The Clutter::Animation will take a reference on object.
Since: 1.0
object | A Object. |
void Clutter::Animation::set_timeline | ( | const Glib::RefPtr< Timeline > & | timeline | ) |
Sets the Clutter::Timeline used by animation.
Since: 1.0
timeline | A Clutter::Timeline, or 0 to unset the current Clutter::Timeline. |
Glib::SignalProxy0< void > Clutter::Animation::signal_completed | ( | ) |
void on_my_completed()
Glib::SignalProxy0< void > Clutter::Animation::signal_started | ( | ) |
void on_my_started()
void Clutter::Animation::unbind_property | ( | const std::string & | property_name | ) |
Removes property_name from the list of animated properties.
Since: 1.0
property_name | Name of the property. |
void Clutter::Animation::update_interval | ( | const std::string & | property_name, | |
const Glib::RefPtr< Interval > & | interval | |||
) |
Changes the interval for property_name.
The Clutter::Animation will take ownership of the passed Clutter::Interval.
Since: 1.0
property_name | Name of the property. | |
interval | A Clutter::Interval. |
Glib::RefPtr< Clutter::Animation > wrap | ( | ClutterAnimation * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
object | The C instance. | |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |