cluttermm: Clutter::Animatable Class Reference

Inheritance diagram for Clutter::Animatable:

Collaboration diagram for Clutter::Animatable:

Public Member Functions
virtual	~Animatable ()

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

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

GParamSpec*	find_property (const Glib::ustring& property_name)
	Finds the ParamSpec for property_name. More...

void	get_initial_state_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
	Retrieves the current state of property_name and sets value with it. More...

void	set_final_state_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
	Sets the current state of property_name to value. More...

void	interpolate_value_value (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, Glib::ValueBase& value)
	Asks a Clutter::Animatable implementation to interpolate a a named property between the initial and final values of a Clutter::Interval, using progress as the interpolation value, and store the result inside value. More...

template<class ValueType >
void	get_initial_state (const Glib::ustring& property_name, ValueType& value) const
	Gets the initial state of an animation. More...

template<class ValueType >
void	set_final_state (const Glib::ustring& property_name, const ValueType& value)
	Sets the final state for an animation. More...

template<class ValueType >
bool	interpolate (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, ValueType& value)

Static Public Member Functions
static void	add_interface (GType gtype_implementer)

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

Protected Member Functions
	Animatable ()
	You should derive from this class to use it. More...

virtual GParamSpec*	find_property_vfunc (const Glib::ustring& property_name)

virtual void	get_initial_state_vfunc (const Glib::ustring& property_name, Glib::ValueBase& value)

virtual void	set_final_state_vfunc (const Glib::ustring& property_name, const Glib::ValueBase& value)

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

Constructor & Destructor Documentation

Clutter::Animatable::Animatable ( )

protected

You should derive from this class to use it.

virtual Clutter::Animatable::~Animatable ( )

virtual

Member Function Documentation

static void Clutter::Animatable::add_interface ( GType gtype_implementer)

static

GParamSpec* Clutter::Animatable::find_property ( const Glib::ustring & property_name)

Finds the ParamSpec for property_name.

Since cluttermm 1.4:

Parameters

property_name The name of the animatable property to find.

Returns: The ParamSpec for the given property or 0.

virtual GParamSpec* Clutter::Animatable::find_property_vfunc ( const Glib::ustring & property_name)

protectedvirtual

template <class ValueType >

void Clutter::Animatable::get_initial_state	(	const Glib::ustring &	property_name,
		ValueType &	value
	)		const

Gets the initial state of an animation.

Parameters

property_name	the name of the animatable property to retrieve
value	the value of the property.

void Clutter::Animatable::get_initial_state_value	(	const Glib::ustring &	property_name,
		Glib::ValueBase &	value
	)		const

Retrieves the current state of property_name and sets value with it.

Since cluttermm 1.4:

Parameters

property_name	The name of the animatable property to retrieve.
value	A Value initialized to the type of the property to retrieve.

virtual void Clutter::Animatable::get_initial_state_vfunc	(	const Glib::ustring &	property_name,
		Glib::ValueBase &	value
	)

protectedvirtual

static GType Clutter::Animatable::get_type ( )

static

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

ClutterAnimatable* Clutter::Animatable::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterAnimatable* Clutter::Animatable::gobj ( ) const

inline

Provides access to the underlying C GObject.

template <class ValueType >

bool Clutter::Animatable::interpolate	(	const Glib::ustring &	property_name,
		const Glib::RefPtr< const Interval >&	interval,
		double	progress,
		ValueType &	value
	)

void Clutter::Animatable::interpolate_value_value	(	const Glib::ustring &	property_name,
		const Glib::RefPtr< const Interval >&	interval,
		double	progress,
		Glib::ValueBase &	value
	)

Asks a Clutter::Animatable implementation to interpolate a a named property between the initial and final values of a Clutter::Interval, using progress as the interpolation value, and store the result inside value.

This function should be used for every property animation involving Clutter::Animatables.

This function replaces animate_property().

Since cluttermm 1.8:

Parameters

property_name	The name of the property to interpolate.
interval	A Clutter::Interval with the animation range.
progress	The progress to use to interpolate between the initial and final values of the interval.
value	Return location for an initialized Value using the same type of the interval.

Returns: true if the interpolation was successful, and false otherwise.

template <class ValueType >

void Clutter::Animatable::set_final_state	(	const Glib::ustring &	property_name,
		const ValueType &	value
	)

Sets the final state for an animation.

Parameters

property_name	the name of the animatable property to set.
value	a value of the appropriate type.

void Clutter::Animatable::set_final_state_value	(	const Glib::ustring &	property_name,
		const Glib::ValueBase &	value
	)

Sets the current state of property_name to value.

Since cluttermm 1.4:

Parameters

property_name	The name of the animatable property to set.
value	The value of the animatable property to set.

virtual void Clutter::Animatable::set_final_state_vfunc	(	const Glib::ustring &	property_name,
		const Glib::ValueBase &	value
	)

protectedvirtual

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Animatable > wrap	(	ClutterAnimatable *	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/animatable.h

cluttermm: Clutter::Animatable Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation