cluttermm: Clutter::Animator Class Reference

Inheritance diagram for Clutter::Animator:

Collaboration diagram for Clutter::Animator:

Public Member Functions
virtual	~Animator ()

ClutterAnimator*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterAnimator*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterAnimator*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Animator >	set_key (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name, guint mode, double progress, const Glib::ValueBase& value)
	Sets a single key in the Clutter::Animator for the property_name of object at progress. More...

Glib::RefPtr< const Animator >	set_key (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name, guint mode, double progress, const Glib::ValueBase& value) const
	Sets a single key in the Clutter::Animator for the property_name of object at progress. More...

void	remove_key (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name, double progress)
	Removes all keys matching the conditions specificed in the arguments. More...

Glib::RefPtr< Timeline >	start ()
	Start the ClutterAnimator, this is a thin wrapper that rewinds and starts the animators current timeline. More...

Glib::RefPtr< const Timeline >	start () const
	Start the ClutterAnimator, this is a thin wrapper that rewinds and starts the animators current timeline. More...

bool	compute_value (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name, double progress, Glib::ValueBase& value)
	Compute the value for a managed property at a given progress. More...

void	set_timeline (const Glib::RefPtr< Timeline >& timeline)
	Sets an external timeline that will be used for driving the animation. More...

Glib::RefPtr< Timeline >	get_timeline ()
	Get the timeline hooked up for driving the Clutter::Animator. More...

Glib::RefPtr< const Timeline >	get_timeline () const
	Get the timeline hooked up for driving the Clutter::Animator. More...

void	set_duration (guint duration)
	Runs the timeline of the Clutter::Animator with a duration in msecs as specified. More...

guint	get_duration () const
	Retrieves the current duration of an animator. More...

void	property_set_ease_in (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name, bool ease_in)
	Sets whether a property value is to be eased into the animation. More...

bool	property_get_ease_in (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name)
	Checks if a property value is to be eased into the animation. More...

void	property_set_interpolation (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name, Interpolation interpolation)
	Set the interpolation method to use, Clutter::INTERPOLATION_LINEAR causes the values to linearly change between the values, and Clutter::INTERPOLATION_CUBIC causes the values to smoothly change between the values. More...

Interpolation	property_get_interpolation (const Glib::RefPtr< Glib::Object >& object, const Glib::ustring& property_name)
	Get the interpolation used by animator for a property on a particular object. More...

Glib::PropertyProxy< guint >	property_duration ()
	The duration of the animation. More...

Glib::PropertyProxy_ReadOnly < guint >	property_duration () const
	The duration of the animation. More...

Glib::PropertyProxy < Glib::RefPtr< Timeline > >	property_timeline ()
	The timeline of the animation. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Timeline > >	property_timeline () const
	The timeline of the animation. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< Animator >	create ()

Protected Member Functions
	Animator ()

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::Animator >	wrap (ClutterAnimator* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

Deprecated:: Use KeyframeTransition instead.

Constructor & Destructor Documentation

virtual Clutter::Animator::~Animator ( )

virtual

Clutter::Animator::Animator ( )

protected

Member Function Documentation

bool Clutter::Animator::compute_value	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name,
		double	progress,
		Glib::ValueBase &	value
	)

Compute the value for a managed property at a given progress.

If the property is an ease-in property, the current value of the property on the object will be used as the starting point for computation.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

object	A Object.
property_name	The name of the property on object to check.
progress	A value between 0.0 and 1.0.
value	An initialized value to store the computed result.

Returns: true if the computation yields has a value, otherwise (when an error occurs or the progress is before any of the keys) false is returned and the Value is left untouched.

static Glib::RefPtr<Animator> Clutter::Animator::create ( )

static

guint Clutter::Animator::get_duration ( ) const

Retrieves the current duration of an animator.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Returns: The duration of the animation, in milliseconds.

Glib::RefPtr<Timeline> Clutter::Animator::get_timeline ( )

Get the timeline hooked up for driving the Clutter::Animator.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Returns: The Clutter::Timeline that drives the animator.

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

Get the timeline hooked up for driving the Clutter::Animator.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Returns: The Clutter::Timeline that drives the animator.

static GType Clutter::Animator::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

ClutterAnimator* Clutter::Animator::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterAnimator* Clutter::Animator::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterAnimator* Clutter::Animator::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Glib::PropertyProxy< guint > Clutter::Animator::property_duration ( )

The duration of the animation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< guint > Clutter::Animator::property_duration ( ) const

The duration of the animation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

bool Clutter::Animator::property_get_ease_in	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name
	)

Checks if a property value is to be eased into the animation.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

object	A Object.
property_name	The name of a property on object.

Returns: true if the property is eased in.

Interpolation Clutter::Animator::property_get_interpolation	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name
	)

Get the interpolation used by animator for a property on a particular object.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

object	A Object.
property_name	The name of a property on object.

Returns: A ClutterInterpolation value.

void Clutter::Animator::property_set_ease_in	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name,
		bool	ease_in
	)

Sets whether a property value is to be eased into the animation.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

object	A Object.
property_name	The name of a property on object.
ease_in	We are going to be easing in this property.

void Clutter::Animator::property_set_interpolation	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name,
		Interpolation	interpolation
	)

Set the interpolation method to use, Clutter::INTERPOLATION_LINEAR causes the values to linearly change between the values, and Clutter::INTERPOLATION_CUBIC causes the values to smoothly change between the values.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

object	A Object.
property_name	The name of a property on object.
interpolation	The Clutter::Interpolation to use.

Glib::PropertyProxy< Glib::RefPtr<Timeline> > Clutter::Animator::property_timeline ( )

The timeline of the animation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Timeline> > Clutter::Animator::property_timeline ( ) const

The timeline of the animation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

void Clutter::Animator::remove_key	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name,
		double	progress
	)

Removes all keys matching the conditions specificed in the arguments.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

object	A Object to search for, or `0` for all.
property_name	A specific property name to query for, or `0` for all.
progress	A specific progress to search for or a negative value for all.

void Clutter::Animator::set_duration ( guint duration)

Runs the timeline of the Clutter::Animator with a duration in msecs as specified.

Since cluttermm 1.2:: Deprecated: 1.12: Use Clutter::KeyframeTransition instead

Parameters

duration Milliseconds a run of the animator should last.

Glib::RefPtr<Animator> Clutter::Animator::set_key	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name,
		guint	mode,
		double	progress,
		const Glib::ValueBase &	value
	)

Sets a single key in the Clutter::Animator for the property_name of object at progress.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Animator > wrap	(	ClutterAnimator *	object,
		bool	take_copy = `false`
	)

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:

cluttermm/animator.h

Glib::RefPtr<const Animator> Clutter::Animator::set_key	(	const Glib::RefPtr< Glib::Object > &	object,
		const Glib::ustring &	property_name,
		guint	mode,
		double	progress,
		const Glib::ValueBase &	value
	)		const

cluttermm: Clutter::Animator Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation