Clutter::Animation Class Reference

#include <animation.h>

Inheritance diagram for Clutter::Animation:
Inheritance graph
[legend]

List of all members.

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< Timelineget_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< Alphaget_alpha () const
 Retrieves the Clutter::Alpha used by animation.
void completed ()
 Emits the completed signal on animation.
Glib::RefPtr< Animationbind (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< Intervalget_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< Animationcreate ()

Protected Member Functions

 Animation ()
virtual void on_started ()
virtual void on_completed ()

Related Functions

(Note that these are not member functions.)



Glib::RefPtr< Clutter::Animationwrap (ClutterAnimation *object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual Clutter::Animation::~Animation (  )  [virtual]
Clutter::Animation::Animation (  )  [protected]

Member Function Documentation

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.

Parameters:
property_name The property to control.
final The final value of the property.
Returns:
(transfer none): The animation itself. Since: 1.0.
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.

Parameters:
property_name The property to control.
interval (transfer full): a Clutter::Interval.
Returns:
(transfer none): The animation itself. Since: 1.0.
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.

Returns:
(transfer none): the alpha object used by the animation

Since: 1.0.

guint Clutter::Animation::get_duration (  )  const

Retrieves the duration of animation, in milliseconds.

Returns:
The duration of the animation

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.

Parameters:
property_name Name of the property.
Returns:
(transfer none): a Clutter::Interval or 0 if no property with the same name was found. The returned interval is owned by the Clutter::Animation and should not be unreferenced

Since: 1.0.

bool Clutter::Animation::get_loop (  )  const

Retrieves whether animation is looping.

Returns:
true if the animation is looping

Since: 1.0.

gulong Clutter::Animation::get_mode (  )  const

Retrieves the animation mode of animation, as set by set_mode().

Returns:
The mode for the animation

Since: 1.0.

Glib::RefPtr<const Glib::Object> Clutter::Animation::get_object (  )  const

Retrieves the Object attached to animation.

Returns:
(transfer none): a Object

Since: 1.0.

Glib::RefPtr<Glib::Object> Clutter::Animation::get_object (  ) 

Retrieves the Object attached to animation.

Returns:
(transfer none): a Object

Since: 1.0.

Glib::RefPtr<Timeline> Clutter::Animation::get_timeline (  )  const

Retrieves the Clutter::Timeline used by animation.

Returns:
(transfer none): the timeline used by the 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.

Parameters:
property_name Name of the property.
Returns:
true if the property is animated by the Clutter::Animation, false otherwise

Since: 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

Parameters:
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

Parameters:
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

Parameters:
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

Parameters:
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

Parameters:
object A Object.
void Clutter::Animation::set_timeline ( const Glib::RefPtr< Timeline > &  timeline  ) 

Sets the Clutter::Timeline used by animation.

Since: 1.0

Parameters:
timeline A Clutter::Timeline, or 0 to unset the current Clutter::Timeline.
Glib::SignalProxy0< void > Clutter::Animation::signal_completed (  ) 
Prototype:
void on_my_completed()
Glib::SignalProxy0< void > Clutter::Animation::signal_started (  ) 
Prototype:
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

Parameters:
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

Parameters:
property_name Name of the property.
interval A Clutter::Interval.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Animation > wrap ( ClutterAnimation *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
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.
Returns:
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

Generated on 7 Sep 2009 for cluttermm by  doxygen 1.6.1