cluttermm: Clutter::BehaviourPath Class Reference

Inheritance diagram for Clutter::BehaviourPath:

Collaboration diagram for Clutter::BehaviourPath:

Public Member Functions
virtual	~BehaviourPath ()

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

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

ClutterBehaviourPath*	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	set_path (const Glib::RefPtr< Path >& path)
	Change the path that the actors will follow. More...

Glib::RefPtr< Path >	get_path ()
	Get the current path of the behaviour. More...

Glib::RefPtr< const Path >	get_path () const
	Get the current path of the behaviour. More...

Glib::PropertyProxy < Glib::RefPtr< Path > >	property_path ()
	The ClutterPath object representing the path to animate along. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Path > >	property_path () const
	The ClutterPath object representing the path to animate along. More...

Glib::SignalProxy1< void, guint >	signal_knot_reached ()

Public Member Functions inherited from Clutter::Behaviour
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...

Public Member Functions inherited from Clutter::Scriptable
virtual	~Scriptable ()

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

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

void	set_id (const std::string& id)
	Sets id as the unique Clutter script it for this instance of Clutter::ScriptableIface. More...

std::string	get_id () const
	Retrieves the id of scriptable set using set_id(). More...

bool	parse_custom_node (const Glib::RefPtr< Script >& script, Glib::ValueBase& value, const Glib::ustring& name, JsonNode* node)
	Parses the passed JSON node. More...

void	set_custom_property (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value)
	Overrides the common properties setting. 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 < BehaviourPath >	create (const Glib::RefPtr< Alpha >& alpha, const Glib::RefPtr< Path >& path)

static Glib::RefPtr < BehaviourPath >	create_with_knots (const Glib::RefPtr< Alpha >& alpha, const std::vector< Knot >& knots)

static Glib::RefPtr < BehaviourPath >	create_with_description (const Glib::RefPtr< Alpha >& alpha, const Glib::ustring& description)

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

Static Public Member Functions inherited from Clutter::Scriptable
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
	BehaviourPath (const Glib::RefPtr< Alpha >& alpha, const Glib::RefPtr< Path >& path)

virtual void	on_knot_reached (guint knot_num)
	This is a default handler for the signal signal_knot_reached(). More...

Protected Member Functions inherited from Clutter::Behaviour
	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...

Protected Member Functions inherited from Clutter::Scriptable
	Scriptable ()
	You should derive from this class to use it. More...

virtual void	set_id_vfunc (const std::string& id)

virtual const char*	get_id_vfunc () const

virtual void	set_custom_property_vfunc (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value)

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

Related Functions inherited from Clutter::Behaviour
Glib::RefPtr< Clutter::Behaviour >	wrap (ClutterBehaviour* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::Scriptable
Glib::RefPtr< Clutter::Scriptable >	wrap (ClutterScriptable* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Clutter::Behaviour
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...

Detailed Description

Deprecated:: Use Path and PathConstraint with Actor::animate() instead.

Constructor & Destructor Documentation

virtual Clutter::BehaviourPath::~BehaviourPath ( )

virtual

Clutter::BehaviourPath::BehaviourPath	(	const Glib::RefPtr< Alpha >&	alpha,
		const Glib::RefPtr< Path >&	path
	)

explicitprotected

Member Function Documentation

static Glib::RefPtr<BehaviourPath> Clutter::BehaviourPath::create	(	const Glib::RefPtr< Alpha >&	alpha,
		const Glib::RefPtr< Path >&	path
	)

static

static Glib::RefPtr<BehaviourPath> Clutter::BehaviourPath::create_with_description	(	const Glib::RefPtr< Alpha >&	alpha,
		const Glib::ustring &	description
	)

static

static Glib::RefPtr<BehaviourPath> Clutter::BehaviourPath::create_with_knots	(	const Glib::RefPtr< Alpha >&	alpha,
		const std::vector< Knot >&	knots
	)

static

Glib::RefPtr<Path> Clutter::BehaviourPath::get_path ( )

Get the current path of the behaviour.

Since cluttermm 1.0:

Deprecated: 1.6

Returns: The path.

Glib::RefPtr<const Path> Clutter::BehaviourPath::get_path ( ) const

Get the current path of the behaviour.

Since cluttermm 1.0:

Deprecated: 1.6

Returns: The path.

static GType Clutter::BehaviourPath::get_type ( )

static

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

ClutterBehaviourPath* Clutter::BehaviourPath::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBehaviourPath* Clutter::BehaviourPath::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBehaviourPath* Clutter::BehaviourPath::gobj_copy ( )

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

virtual void Clutter::BehaviourPath::on_knot_reached ( guint knot_num)

protectedvirtual

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

Glib::PropertyProxy< Glib::RefPtr<Path> > Clutter::BehaviourPath::property_path ( )

The ClutterPath object representing the path to animate along.

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<Path> > Clutter::BehaviourPath::property_path ( ) const

The ClutterPath object representing the path to animate along.

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::BehaviourPath::set_path ( const Glib::RefPtr< Path >& path)

Change the path that the actors will follow.

This will take the floating reference on the Clutter::Path so you do not need to unref it.

Since cluttermm 1.0:

Deprecated: 1.6

Parameters

path	The new path to follow.

Glib::SignalProxy1< void,guint > Clutter::BehaviourPath::signal_knot_reached ( )

Slot Prototype:: void on_my_knot_reached(guint knot_num)

This signal is emitted each time a node defined inside the path is reached.

Since cluttermm 0.2:

Deprecated: 1.6

Parameters

knot_num The index of the Clutter::Knot reached.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BehaviourPath > wrap	(	ClutterBehaviourPath *	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-path.h

cluttermm: Clutter::BehaviourPath Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation