Clutter.BehaviourPath¶

Subclasses:: None

Methods¶

Inherited:: Clutter.Behaviour (10), GObject.Object (37), Clutter.Scriptable (4)
Structs:: GObject.ObjectClass (5)

class	`new` (alpha, path)
class	`new_with_description` (alpha, desc)
class	`new_with_knots` (alpha, knots)
	`get_path` ()
	`set_path` (path)

Virtual Methods¶

Inherited:: Clutter.Behaviour (3), GObject.Object (7), Clutter.Scriptable (4)

do_knot_reached (knot_num)

Properties¶

Inherited:: Clutter.Behaviour (1)

Name	Type	Flags	Short Description
`path`	`Clutter.Path`	r/w	The `Clutter.Path` object representing the path to animate along

Signals¶

Inherited:: Clutter.Behaviour (2), GObject.Object (1)

Name	Short Description
`knot-reached`	This signal is emitted each time a node defined inside the path is reached. `deprecated`

Fields¶

Inherited:: Clutter.Behaviour (2), GObject.Object (1)

Name	Type	Access	Description
parent	`Clutter.Behaviour`	r

Class Details¶

class Clutter.BehaviourPath(**kwargs)¶

Bases:: Clutter.Behaviour
Abstract:: No
Structure:: Clutter.BehaviourPathClass

The Clutter.BehaviourPath structure contains only private data and should be accessed using the provided API

New in version 0.2.

Deprecated since version 1.6: Use Clutter.PathConstraint and clutter_actor_animate() instead.

classmethod new(alpha, path)¶

Parameters:

alpha (Clutter.Alpha or None) – a Clutter.Alpha instance, or None
path (Clutter.Path) – a Clutter.Path or None for an empty path

Returns:

a Clutter.Behaviour

Return type:

Clutter.Behaviour

Creates a new path behaviour. You can use this behaviour to drive actors along the nodes of a path, described by path.

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

If alpha is not None, the Clutter.Behaviour will take ownership of the Clutter.Alpha instance. In the case when alpha is None, it can be set later with Clutter.Behaviour.set_alpha().

New in version 0.2.

Deprecated since version 1.6.

classmethod new_with_description(alpha, desc)¶

Parameters:

alpha (Clutter.Alpha or None) – a Clutter.Alpha instance, or None
desc (str) – a string description of the path

Returns:

a Clutter.Behaviour

Return type:

Clutter.Behaviour

Creates a new path behaviour using the path described by desc. See Clutter.Path.add_string() for a description of the format.

If alpha is not None, the Clutter.Behaviour will take ownership of the Clutter.Alpha instance. In the case when alpha is None, it can be set later with Clutter.Behaviour.set_alpha().

New in version 1.0.

Deprecated since version 1.6.

classmethod new_with_knots(alpha, knots)¶

Parameters:

alpha (Clutter.Alpha or None) – a Clutter.Alpha instance, or None
knots ([Clutter.Knot]) – an array of Clutter.Knot s

Returns:

a Clutter.Behaviour

Return type:

Clutter.Behaviour

Creates a new path behaviour that will make the actors visit all of the given knots in order with straight lines in between.

A path will be created where the first knot is used in a Clutter.PathNodeType.MOVE_TO and the subsequent knots are used in Clutter.PathNodeType.LINE_TO s.

If alpha is not None, the Clutter.Behaviour will take ownership of the Clutter.Alpha instance. In the case when alpha is None, it can be set later with Clutter.Behaviour.set_alpha().

New in version 1.0.

Deprecated since version 1.6.

get_path()¶

Returns:: the path
Return type:: Clutter.Path

Get the current path of the behaviour

New in version 1.0.

Deprecated since version 1.6.

set_path(path)¶

Parameters:: path (Clutter.Path) – the new path to follow

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.

New in version 1.0.

Deprecated since version 1.6.

do_knot_reached(knot_num) virtual¶

Parameters:: knot_num (int) –

Signal Details¶

Clutter.BehaviourPath.signals.knot_reached(behaviour_path, knot_num)¶

Signal Name:

knot-reached

Flags:

RUN_LAST

Parameters:

behaviour_path (Clutter.BehaviourPath) – The object which received the signal
knot_num (int) – the index of the Clutter.Knot reached

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

New in version 0.2.

Deprecated since version 1.6.

Property Details¶

Clutter.BehaviourPath.props.path¶

Name:: path
Type:: Clutter.Path
Default Value:: None
Flags:: READABLE, WRITABLE

The Clutter.Path object representing the path to animate along