Clutter.PageTurnEffect¶

Subclasses:: None

Methods¶

Inherited:: Clutter.DeformEffect (5), Clutter.OffscreenEffect (6), Clutter.Effect (1), Clutter.ActorMeta (5), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (period, angle, radius)
	`get_angle` ()
	`get_period` ()
	`get_radius` ()
	`set_angle` (angle)
	`set_period` (period)
	`set_radius` (radius)

Virtual Methods¶

Inherited:: Clutter.DeformEffect (1), Clutter.OffscreenEffect (2), Clutter.Effect (5), Clutter.ActorMeta (1), GObject.Object (7)

Properties¶

Inherited:: Clutter.DeformEffect (2), Clutter.ActorMeta (3)

Name	Type	Flags	Short Description
`angle`	`float`	r/w	The angle of the page rotation, in degrees
`period`	`float`	r/w	The period of the page turn
`radius`	`float`	r/w	The radius of the page curl

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Clutter.PageTurnEffect(**kwargs)¶

Bases:: Clutter.DeformEffect
Abstract:: No
Structure:: Clutter.PageTurnEffectClass

Clutter.PageTurnEffect is an opaque structure whose members can only be accessed using the provided API

New in version 1.4.

classmethod new(period, angle, radius)¶

Parameters:

period (float) – the period of the page curl, between 0.0 and 1.0
angle (float) – the angle of the page curl, between 0.0 and 360.0
radius (float) – the radius of the page curl, in pixels

Returns:

the newly created Clutter.PageTurnEffect

Return type:

Clutter.Effect

Creates a new Clutter.PageTurnEffect instance with the given parameters

New in version 1.4.

get_angle()¶

Returns:: the angle of the page curling
Return type:: float

Retrieves the value set using Clutter.PageTurnEffect.get_angle()

New in version 1.4.

get_period()¶

Returns:: the period of the page curling
Return type:: float

Retrieves the value set using Clutter.PageTurnEffect.get_period()

New in version 1.4.

get_radius()¶

Returns:: the radius of the page curling
Return type:: float

Retrieves the value set using Clutter.PageTurnEffect.set_radius()

New in version 1.4.

set_angle(angle)¶

Parameters:: angle (float) – the angle of the page curl, in degrees

Sets the angle of the page curling, in degrees

New in version 1.4.

set_period(period)¶

Parameters:: period (float) – the period of the page curl, between 0.0 and 1.0

Sets the period of the page curling, between 0.0 (no curling) and 1.0 (fully curled)

New in version 1.4.

set_radius(radius)¶

Parameters:: radius (float) – the radius of the page curling, in pixels

Sets the radius of the page curling

New in version 1.4.

Property Details¶

Clutter.PageTurnEffect.props.angle¶

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

The angle of the page rotation, in degrees, between 0.0 and 360.0

New in version 1.4.

Clutter.PageTurnEffect.props.period¶

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

The period of the page turn, between 0.0 (no curling) and 1.0 (fully curled)

New in version 1.4.

Clutter.PageTurnEffect.props.radius¶

Name:: radius
Type:: float
Default Value:: 24.0
Flags:: READABLE, WRITABLE

The radius of the page curl, in pixels

New in version 1.4.