Clutter.PathConstraint¶

Subclasses:: None

Methods¶

Inherited:: Clutter.ActorMeta (5), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (path, offset)
	`get_offset` ()
	`get_path` ()
	`set_offset` (offset)
	`set_path` (path)

Virtual Methods¶

Inherited:: Clutter.Constraint (2), Clutter.ActorMeta (1), GObject.Object (7)

Properties¶

Inherited:: Clutter.ActorMeta (3)

Name	Type	Flags	Short Description
`offset`	`float`	r/w	The offset along the path, between -1.0 and 2.0
`path`	`Clutter.Path`	r/w	The path used to constrain an actor

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`node-reached`	The `::node-reached` signal is emitted each time a `Clutter.PathConstraint` `:offset` value results in the actor passing a `Clutter.PathNode`

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Clutter.PathConstraint(**kwargs)¶

Bases:: Clutter.Constraint
Abstract:: No
Structure:: Clutter.PathConstraintClass

Clutter.PathConstraint is an opaque structure whose members cannot be directly accessed

New in version 1.6.

classmethod new(path, offset)¶

Parameters:

path (Clutter.Path or None) – a Clutter.Path, or None
offset (float) – the offset along the Clutter.Path

Returns:

the newly created Clutter.PathConstraint

Return type:

Clutter.Constraint

Creates a new Clutter.PathConstraint with the given path and offset

New in version 1.6.

get_offset()¶

Returns:: the offset
Return type:: float

Retrieves the offset along the Clutter.Path used by self.

New in version 1.6.

get_path()¶

Returns:: the Clutter.Path used by the Clutter.PathConstraint, or None. The returned Clutter.Path is owned by the constraint and it should not be unreferenced
Return type:: Clutter.Path

Retrieves a pointer to the Clutter.Path used by self.

New in version 1.6.

set_offset(offset)¶

Parameters:: offset (float) – the offset along the path

Sets the offset along the Clutter.Path used by self.

New in version 1.6.

set_path(path)¶

Parameters:: path (Clutter.Path or None) – a Clutter.Path

Sets the path to be followed by the Clutter.PathConstraint.

The self will take ownership of the Clutter.Path passed to this function.

New in version 1.6.

Signal Details¶

Clutter.PathConstraint.signals.node_reached(path_constraint, actor, index)¶

Signal Name:

node-reached

Flags:

RUN_LAST

Parameters:

path_constraint (Clutter.PathConstraint) – The object which received the signal
actor (Clutter.Actor) – the Clutter.Actor using the constraint
index (int) – the index of the node that has been reached

The ::node-reached signal is emitted each time a Clutter.PathConstraint :offset value results in the actor passing a Clutter.PathNode

New in version 1.6.

Property Details¶

Clutter.PathConstraint.props.offset¶

Name:: offset
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The offset along the Clutter.PathConstraint :path, between -1.0 and 2.0.

New in version 1.6.

Clutter.PathConstraint.props.path¶

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

The Clutter.Path used to constrain the position of an actor.

New in version 1.6.