Next: , Previous: ClutterOffscreenEffect, Up: Top


49 ClutterPageTurnEffect

A page turning effect

49.1 Overview

A simple page turning effect

<clutter-page-turn-effect> is available since Clutter 1.4

49.2 Usage

— Function: clutter-page-turn-effect-new (period double) (angle double) (radius float) ⇒  (ret <clutter-effect>)

Creates a new <clutter-page-turn-effect> instance with the given parameters

period
the period of the page curl, between 0.0 and 1.0
angle
the angle of the page curl, between 0.0 and 360.0
radius
the radius of the page curl, in pixels
ret
the newly created <clutter-page-turn-effect>

Since 1.4

— Function: clutter-page-turn-effect-set-period (self <clutter-page-turn-effect>) (period double)
— Method: set-period

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

effect
a <clutter-page-turn-effect>
period
the period of the page curl, between 0.0 and 1.0

Since 1.4

— Function: clutter-page-turn-effect-get-period (self <clutter-page-turn-effect>) ⇒  (ret double)
— Method: get-period

Retrieves the value set using clutter-page-turn-effect-get-period

effect
a <clutter-page-turn-effect>
ret
the period of the page curling

Since 1.4

— Function: clutter-page-turn-effect-set-angle (self <clutter-page-turn-effect>) (angle double)
— Method: set-angle

Sets the angle of the page curling, in degrees

effect
<clutter-page-turn-effect>
angle
the angle of the page curl, in degrees

Since 1.4

— Function: clutter-page-turn-effect-get-angle (self <clutter-page-turn-effect>) ⇒  (ret double)
— Method: get-angle

Retrieves the value set using clutter-page-turn-effect-get-angle

effect
a <clutter-page-turn-effect>:
ret
the angle of the page curling

Since 1.4

— Function: clutter-page-turn-effect-set-radius (self <clutter-page-turn-effect>) (radius float)
— Method: set-radius

Sets the radius of the page curling

effect
a <clutter-page-turn-effect>:
radius
the radius of the page curling, in pixels

Since 1.4

— Function: clutter-page-turn-effect-get-radius (self <clutter-page-turn-effect>) ⇒  (ret float)
— Method: get-radius

Retrieves the value set using clutter-page-turn-effect-set-radius

effect
a <clutter-page-turn-effect>
ret
the radius of the page curling

Since 1.4