## ClutterPageTurnEffect

ClutterPageTurnEffect — A page turning effect

## Synopsis

                        ClutterPageTurnEffect;
    ClutterEffect *     clutter_page_turn_effect_new        (gdouble period,
                                                             gdouble angle,
                                                             gfloat radius);
    void                clutter_page_turn_effect_set_period (ClutterPageTurnEffect *effect,
                                                             gdouble period);
    gdouble             clutter_page_turn_effect_get_period (ClutterPageTurnEffect *effect);
    void                clutter_page_turn_effect_set_angle  (ClutterPageTurnEffect *effect,
                                                             gdouble angle);
    gdouble             clutter_page_turn_effect_get_angle  (ClutterPageTurnEffect *effect);
    void                clutter_page_turn_effect_set_radius (ClutterPageTurnEffect *effect,
                                                             gfloat radius);
    gfloat              clutter_page_turn_effect_get_radius (ClutterPageTurnEffect *effect);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----ClutterActorMeta
                   +----ClutterEffect
                         +----ClutterOffscreenEffect
                               +----ClutterDeformEffect
                                     +----ClutterPageTurnEffect

## Properties

      "angle"                    gdouble               : Read / Write
      "period"                   gdouble               : Read / Write
      "radius"                   gfloat                : Read / Write

## Description

A simple page turning effect

ClutterPageTurnEffect is available since Clutter 1.4

## Details

### ClutterPageTurnEffect

    typedef struct _ClutterPageTurnEffect ClutterPageTurnEffect;

ClutterPageTurnEffect is an opaque structure whose members can only be accessed using the provided API

Since 1.4

### clutter_page_turn_effect_new ()

    ClutterEffect *     clutter_page_turn_effect_new        (gdouble period,
                                                             gdouble angle,
                                                             gfloat radius);

Creates a new ClutterPageTurnEffect 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
Returns : | the newly created ClutterPageTurnEffect

Since 1.4

### clutter_page_turn_effect_set_period ()

    void                clutter_page_turn_effect_set_period (ClutterPageTurnEffect *effect,
                                                             gdouble period);

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

`effect` : | a ClutterPageTurnEffect
`period` : | the period of the page curl, between 0.0 and 1.0

Since 1.4

### clutter_page_turn_effect_get_period ()

    gdouble             clutter_page_turn_effect_get_period (ClutterPageTurnEffect *effect);

Retrieves the value set using `clutter_page_turn_effect_get_period()`

`effect` : | a ClutterPageTurnEffect
Returns : | the period of the page curling

Since 1.4

### clutter_page_turn_effect_set_angle ()

    void                clutter_page_turn_effect_set_angle  (ClutterPageTurnEffect *effect,
                                                             gdouble angle);

Sets the angle of the page curling, in degrees

`effect` : | ClutterPageTurnEffect
`angle` : | the angle of the page curl, in degrees

Since 1.4

### clutter_page_turn_effect_get_angle ()

    gdouble             clutter_page_turn_effect_get_angle  (ClutterPageTurnEffect *effect);

Retrieves the value set using `clutter_page_turn_effect_get_angle()`

`effect` : | a ClutterPageTurnEffect:
Returns : | the angle of the page curling

Since 1.4

### clutter_page_turn_effect_set_radius ()

    void                clutter_page_turn_effect_set_radius (ClutterPageTurnEffect *effect,
                                                             gfloat radius);

Sets the radius of the page curling

`effect` : | a ClutterPageTurnEffect:
`radius` : | the radius of the page curling, in pixels

Since 1.4

### clutter_page_turn_effect_get_radius ()

    gfloat              clutter_page_turn_effect_get_radius (ClutterPageTurnEffect *effect);

Retrieves the value set using `clutter_page_turn_effect_set_radius()`

`effect` : | a ClutterPageTurnEffect
Returns : | the radius of the page curling

Since 1.4

## Property Details

### The `"angle"` property

      "angle"                    gdouble               : Read / Write

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

Allowed values: [0,360]

Default value: 0

Since 1.4

### The `"period"` property

      "period"                   gdouble               : Read / Write

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

Allowed values: [0,1]

Default value: 0

Since 1.4

### The `"radius"` property

      "radius"                   gfloat                : Read / Write

The radius of the page curl, in pixels

Default value: 24

Since 1.4