cluttermm: Clutter::Behaviour Class Reference

Inheritance diagram for Clutter::Behaviour:

Collaboration diagram for Clutter::Behaviour:

Public Types
typedef sigc::slot< void, const Glib::RefPtr< Behaviour > &, const Glib::RefPtr< Actor >& >	SlotForEach
	For instance, void on_foreach(const Glib::RefPtr<Behaviour>& behaviour, const Glib::RefPtr<Actor>& actor) More...

Public Member Functions
virtual	~Behaviour ()

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

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

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

void	apply (const Glib::RefPtr< Actor >& actor)
	Applies behave to actor. More...

void	remove (const Glib::RefPtr< Actor >& actor)
	Removes actor from the list of Clutter::Actors to which behave applies. More...

void	remove_all ()
	Removes every actor from the list that behave holds. More...

bool	is_applied (const Glib::RefPtr< Actor >& actor)
	Check if behave applied to actor. More...

std::vector< Glib::RefPtr < Actor > >	get_actors ()

std::vector< Glib::RefPtr < Actor const > >	get_actors () const

int	get_n_actors () const
	Gets the number of actors this behaviour is applied too. More...

Glib::RefPtr< Actor >	get_nth_actor (int index)
	Gets an actor the behaviour was applied to referenced by index num. More...

Glib::RefPtr< const Actor >	get_nth_actor (int index) const
	Gets an actor the behaviour was applied to referenced by index num. More...

Glib::RefPtr< Alpha >	get_alpha ()
	Retrieves the Clutter::Alpha object bound to behave. More...

Glib::RefPtr< const Alpha >	get_alpha () const
	Retrieves the Clutter::Alpha object bound to behave. More...

void	set_alpha (const Glib::RefPtr< Alpha >& alpha)
	Binds alpha to a Clutter::Behaviour. More...

void	actors_foreach (const SlotForEach& slot)

Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& >	signal_applied ()

Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& >	signal_removed ()

Glib::PropertyProxy < Glib::RefPtr< Alpha > >	property_alpha ()
	Alpha Object to drive the behaviour. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Alpha > >	property_alpha () const
	Alpha Object to drive the behaviour. More...

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

Protected Member Functions
	Behaviour ()

virtual void	alpha_notify_vfunc (double alpha_value)

virtual void	on_applied (const Glib::RefPtr< Actor >& actor)
	This is a default handler for the signal signal_applied(). More...

virtual void	on_removed (const Glib::RefPtr< Actor >& actor)
	This is a default handler for the signal signal_removed(). More...

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

Detailed Description

Deprecated:: Behaviour and its sub-classes have been deprecated since Clutter 1.6, in favour of the animation framework API.

Member Typedef Documentation

typedef sigc::slot<void, const Glib::RefPtr<Behaviour>&, const Glib::RefPtr<Actor>&> Clutter::Behaviour::SlotForEach

For instance, void on_foreach(const Glib::RefPtr<Behaviour>& behaviour, const Glib::RefPtr<Actor>& actor)

Constructor & Destructor Documentation

virtual Clutter::Behaviour::~Behaviour ( )

virtual

Clutter::Behaviour::Behaviour ( )

protected

Member Function Documentation

void Clutter::Behaviour::actors_foreach ( const SlotForEach& slot)

virtual void Clutter::Behaviour::alpha_notify_vfunc ( double alpha_value)

protectedvirtual

void Clutter::Behaviour::apply ( const Glib::RefPtr< Actor >& actor)

Applies behave to actor.

This function adds a reference on the actor.

Since cluttermm 0.2:

Deprecated: 1.6

Parameters

actor A Clutter::Actor.

std::vector<Glib::RefPtr<Actor> > Clutter::Behaviour::get_actors ( )

std::vector<Glib::RefPtr<Actor const> > Clutter::Behaviour::get_actors ( ) const

Glib::RefPtr<Alpha> Clutter::Behaviour::get_alpha ( )

Retrieves the Clutter::Alpha object bound to behave.

Since cluttermm 0.2:

Deprecated: 1.6

Returns: A Clutter::Alpha object, or 0 if no alpha object has been bound to this behaviour.

Glib::RefPtr<const Alpha> Clutter::Behaviour::get_alpha ( ) const

Retrieves the Clutter::Alpha object bound to behave.

Since cluttermm 0.2:

Deprecated: 1.6

Returns: A Clutter::Alpha object, or 0 if no alpha object has been bound to this behaviour.

int Clutter::Behaviour::get_n_actors ( ) const

Gets the number of actors this behaviour is applied too.

Since cluttermm 0.2:

Deprecated: 1.6

Returns: The number of applied actors.

Glib::RefPtr<Actor> Clutter::Behaviour::get_nth_actor ( int index)

Gets an actor the behaviour was applied to referenced by index num.

Since cluttermm 0.2:

Deprecated: 1.6

Parameters

index The index of an actor this behaviour is applied too.

Returns: A Clutter actor or 0 if index is invalid.

Glib::RefPtr<const Actor> Clutter::Behaviour::get_nth_actor ( int index) const

Gets an actor the behaviour was applied to referenced by index num.

Since cluttermm 0.2:

Deprecated: 1.6

Parameters

index The index of an actor this behaviour is applied too.

Returns: A Clutter actor or 0 if index is invalid.

static GType Clutter::Behaviour::get_type ( )

static

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

ClutterBehaviour* Clutter::Behaviour::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBehaviour* Clutter::Behaviour::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBehaviour* Clutter::Behaviour::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::Behaviour::is_applied ( const Glib::RefPtr< Actor >& actor)

Check if behave applied to actor.

Since cluttermm 0.4:

Deprecated: 1.6

Parameters

actor A Clutter::Actor.

Returns: true if actor has behaviour. false otherwise.

virtual void Clutter::Behaviour::on_applied ( const Glib::RefPtr< Actor >& actor)

protectedvirtual

This is a default handler for the signal signal_applied().

virtual void Clutter::Behaviour::on_removed ( const Glib::RefPtr< Actor >& actor)

protectedvirtual

This is a default handler for the signal signal_removed().

Glib::PropertyProxy< Glib::RefPtr<Alpha> > Clutter::Behaviour::property_alpha ( )

Alpha Object to drive the behaviour.

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<Alpha> > Clutter::Behaviour::property_alpha ( ) const

Alpha Object to drive the behaviour.

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::Behaviour::remove ( const Glib::RefPtr< Actor >& actor)

Removes actor from the list of Clutter::Actors to which behave applies.

This function removes a reference on the actor.

Since cluttermm 0.2:

Deprecated: 1.6

Parameters

actor A Clutter::Actor.

void Clutter::Behaviour::remove_all ( )

Removes every actor from the list that behave holds.

Since cluttermm 0.4:

Deprecated: 1.6

void Clutter::Behaviour::set_alpha ( const Glib::RefPtr< Alpha >& alpha)

Binds alpha to a Clutter::Behaviour.

The Clutter::Alpha object is what makes a behaviour work: for each tick of the timeline used by Clutter::Alpha a new value of the alpha parameter is computed by the alpha function; the value should be used by the Clutter::Behaviour to update one or more properties of the actors to which the behaviour applies.

If alpha is not 0, the Clutter::Behaviour will take ownership of the Clutter::Alpha instance.

Since cluttermm 0.2:

Deprecated: 1.6

Parameters

alpha A Clutter::Alpha or 0 to unset a previously set alpha.

Glib::SignalProxy1< void,const Glib::RefPtr<Actor>& > Clutter::Behaviour::signal_applied ( )

Slot Prototype:: void on_my_applied(const Glib::RefPtr<Actor>& actor)

The signal_apply() signal is emitted each time the behaviour is applied to an actor.

Since cluttermm 0.4:

Deprecated: 1.6

Parameters

actor The actor the behaviour was applied to.

Glib::SignalProxy1< void,const Glib::RefPtr<Actor>& > Clutter::Behaviour::signal_removed ( )

Slot Prototype:: void on_my_removed(const Glib::RefPtr<Actor>& actor)

The signal_removed() signal is emitted each time a behaviour is not applied to an actor anymore.

Since cluttermm 0.4:

Deprecated: 1.6

Parameters

actor The removed actor.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Behaviour > wrap	(	ClutterBehaviour *	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/behaviour.h

cluttermm: Clutter::Behaviour Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation