Clutter.BehaviourEllipse¶

Subclasses:: None

Methods¶

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

class	`new` (alpha, x, y, width, height, direction, start, end)
	`get_angle_end` ()
	`get_angle_start` ()
	`get_angle_tilt` (axis)
	`get_center` ()
	`get_direction` ()
	`get_height` ()
	`get_tilt` ()
	`get_width` ()
	`set_angle_end` (angle_end)
	`set_angle_start` (angle_start)
	`set_angle_tilt` (axis, angle_tilt)
	`set_center` (x, y)
	`set_direction` (direction)
	`set_height` (height)
	`set_tilt` (angle_tilt_x, angle_tilt_y, angle_tilt_z)
	`set_width` (width)

Virtual Methods¶

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

Properties¶

Inherited:: Clutter.Behaviour (1)

Name	Type	Flags	Short Description
`angle-end`	`float`	r/w	Final angle
`angle-start`	`float`	r/w	Initial angle
`angle-tilt-x`	`float`	r/w	Tilt of the ellipse around x axis
`angle-tilt-y`	`float`	r/w	Tilt of the ellipse around y axis
`angle-tilt-z`	`float`	r/w	Tilt of the ellipse around z axis
`center`	`Clutter.Knot`	r/w	Center of ellipse
`direction`	`Clutter.RotateDirection`	r/w	Direction of rotation
`height`	`int`	r/w	Height of ellipse
`width`	`int`	r/w	Width of the ellipse

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent_instance	`Clutter.Behaviour`	r

Class Details¶

class Clutter.BehaviourEllipse(**kwargs)¶

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

The Clutter.BehaviourEllipse struct contains only private data and should be accessed using the provided API

New in version 0.4.

Deprecated since version 1.6.

classmethod new(alpha, x, y, width, height, direction, start, end)¶

Parameters:

alpha (Clutter.Alpha or None) – a Clutter.Alpha instance, or None
x (int) – x coordinace of the center
y (int) – y coordiance of the center
width (int) – width of the ellipse
height (int) – height of the ellipse
direction (Clutter.RotateDirection) – Clutter.RotateDirection of rotation
start (float) – angle in degrees at which movement starts, between 0 and 360
end (float) – angle in degrees at which movement ends, between 0 and 360

Returns:

the newly created Clutter.BehaviourEllipse

Return type:

Clutter.Behaviour

Creates a behaviour that drives actors along an elliptical path with given center, width and height; the movement starts at start degrees (with 0 corresponding to 12 o’clock) and ends at end degrees. Angles greated than 360 degrees get clamped to the canonical interval <0, 360); if start is equal to end, the behaviour will rotate by exacly 360 degrees.

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.4.

get_angle_end()¶

Returns:: angle in degrees
Return type:: float

Gets the at which movements ends.

New in version 0.4.

get_angle_start()¶

Returns:: angle in degrees
Return type:: float

Gets the angle at which movements starts.

New in version 0.6.

get_angle_tilt(axis)¶

Parameters:: axis (Clutter.RotateAxis) – a Clutter.RotateAxis
Returns:: angle in degrees.
Return type:: float

Gets the tilt of the ellipse around the center in the given axis.

New in version 0.4.

get_center()¶

Returns:

x:: return location for the X coordinate of the center, or None
y:: return location for the Y coordinate of the center, or None

Return type:

(x: int, y: int)

Gets the center of the elliptical path path.

New in version 0.4.

get_direction()¶

Returns:: the rotation direction
Return type:: Clutter.RotateDirection

Retrieves the Clutter.RotateDirection used by the ellipse behaviour.

New in version 0.4.

get_height()¶

Returns:: the height of the path
Return type:: int

Gets the height of the elliptical path.

New in version 0.4.

get_tilt()¶

Returns:

angle_tilt_x:: return location for tilt angle on the X axis, or None.
angle_tilt_y:: return location for tilt angle on the Y axis, or None.
angle_tilt_z:: return location for tilt angle on the Z axis, or None.

Return type:

(angle_tilt_x: float, angle_tilt_y: float, angle_tilt_z: float)

Gets the tilt of the ellipse around the center in Y axis.

New in version 0.4.

get_width()¶

Returns:: the width of the path
Return type:: int

Gets the width of the elliptical path.

New in version 0.4.

set_angle_end(angle_end)¶

Parameters:: angle_end (float) – angle at which movement ends in degrees, between 0 and 360.

Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval <0, 360).

New in version 0.4.

set_angle_start(angle_start)¶

Parameters:: angle_start (float) – angle at which movement starts in degrees, between 0 and 360.

Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval <0, 360).

New in version 0.6.

set_angle_tilt(axis, angle_tilt)¶

Parameters:

axis (Clutter.RotateAxis) – a Clutter.RotateAxis
angle_tilt (float) – tilt of the elipse around the center in the given axis in degrees.

Sets the angle at which the ellipse should be tilted around it’s center.

New in version 0.4.

set_center(x, y)¶

Parameters:

x (int) – x coordinace of centre
y (int) – y coordinace of centre

Sets the center of the elliptical path to the point represented by knot.

New in version 0.4.

set_direction(direction)¶

Parameters:: direction (Clutter.RotateDirection) – the rotation direction

Sets the rotation direction used by the ellipse behaviour.

New in version 0.4.

set_height(height)¶

Parameters:: height (int) – height of the ellipse

Sets the height of the elliptical path.

New in version 0.4.

set_tilt(angle_tilt_x, angle_tilt_y, angle_tilt_z)¶

Parameters:

angle_tilt_x (float) – tilt of the elipse around the center in X axis in degrees.
angle_tilt_y (float) – tilt of the elipse around the center in Y axis in degrees.
angle_tilt_z (float) – tilt of the elipse around the center in Z axis in degrees.

Sets the angles at which the ellipse should be tilted around it’s center.

New in version 0.4.

set_width(width)¶

Parameters:: width (int) – width of the ellipse

Sets the width of the elliptical path.

New in version 0.4.

Property Details¶

Clutter.BehaviourEllipse.props.angle_end¶

Name:: angle-end
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The final angle to where the rotation should end.

New in version 0.4.

Clutter.BehaviourEllipse.props.angle_start¶

Name:: angle-start
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The initial angle from where the rotation should start.

New in version 0.4.

Clutter.BehaviourEllipse.props.angle_tilt_x¶

Name:: angle-tilt-x
Type:: float
Default Value:: 360.0
Flags:: READABLE, WRITABLE

The tilt angle for the rotation around center in X axis

New in version 0.4.

Clutter.BehaviourEllipse.props.angle_tilt_y¶

Name:: angle-tilt-y
Type:: float
Default Value:: 360.0
Flags:: READABLE, WRITABLE

The tilt angle for the rotation around center in Y axis

New in version 0.4.

Clutter.BehaviourEllipse.props.angle_tilt_z¶

Name:: angle-tilt-z
Type:: float
Default Value:: 360.0
Flags:: READABLE, WRITABLE

The tilt angle for the rotation on the Z axis

New in version 0.4.

Clutter.BehaviourEllipse.props.center¶

Name:: center
Type:: Clutter.Knot
Default Value:: None
Flags:: READABLE, WRITABLE

The center of the ellipse.

New in version 0.4.

Clutter.BehaviourEllipse.props.direction¶

Name:: direction
Type:: Clutter.RotateDirection
Default Value:: Clutter.RotateDirection.CW
Flags:: READABLE, WRITABLE

The direction of the rotation.

New in version 0.4.

Clutter.BehaviourEllipse.props.height¶

Name:: height
Type:: int
Default Value:: 50
Flags:: READABLE, WRITABLE

Height of the ellipse, in pixels

New in version 0.4.

Clutter.BehaviourEllipse.props.width¶

Name:: width
Type:: int
Default Value:: 100
Flags:: READABLE, WRITABLE

Width of the ellipse, in pixels

New in version 0.4.