ClutterBehaviourScale

ClutterBehaviourScale — A behaviour class interpolating actors size between two values.

Synopsis




enum                ClutterGravity;
ClutterBehaviour*   clutter_behaviour_scale_new         (ClutterAlpha *alpha,
                                                         gdouble scale_begin,
                                                         gdouble scale_end,
                                                         ClutterGravity gravity);
ClutterBehaviour*   clutter_behaviour_scale_newx        (ClutterAlpha *alpha,
                                                         ClutterFixed scale_begin,
                                                         ClutterFixed scale_end,
                                                         ClutterGravity gravity);
void                clutter_behaviour_scale_get_bounds  (ClutterBehaviourScale *scale,
                                                         gdouble *scale_begin,
                                                         gdouble *scale_end);
void                clutter_behaviour_scale_get_boundsx (ClutterBehaviourScale *scale,
                                                         ClutterFixed *scale_begin,
                                                         ClutterFixed *scale_end);
ClutterGravity      clutter_behaviour_scale_get_gravity (ClutterBehaviourScale *scale);


Description

A ClutterBehaviourScale interpolates actors size between two values.

Details

enum ClutterGravity

typedef enum { /*< prefix=CLUTTER_GRAVITY >*/
  CLUTTER_GRAVITY_NONE       = 0,
  CLUTTER_GRAVITY_NORTH,
  CLUTTER_GRAVITY_NORTH_EAST,
  CLUTTER_GRAVITY_EAST,
  CLUTTER_GRAVITY_SOUTH_EAST,
  CLUTTER_GRAVITY_SOUTH,
  CLUTTER_GRAVITY_SOUTH_WEST,
  CLUTTER_GRAVITY_WEST,
  CLUTTER_GRAVITY_NORTH_WEST,
  CLUTTER_GRAVITY_CENTER
} ClutterGravity;

Gravity of the scaling operations. When a gravity different than CLUTTER_GRAVITY_NONE is used, an actor is scaled keeping the position of the specified portion at the same coordinates.

CLUTTER_GRAVITY_NONE Do not apply any gravity
CLUTTER_GRAVITY_NORTH Scale from topmost downwards
CLUTTER_GRAVITY_NORTH_EAST Scale from the top left corner
CLUTTER_GRAVITY_EAST Scale from the left side
CLUTTER_GRAVITY_SOUTH_EAST Scale from the bottom left corner
CLUTTER_GRAVITY_SOUTH Scale from the bottom upwards
CLUTTER_GRAVITY_SOUTH_WEST Scale from the bottom right corner
CLUTTER_GRAVITY_WEST Scale from the right side
CLUTTER_GRAVITY_NORTH_WEST Scale from the top right corner
CLUTTER_GRAVITY_CENTER Scale from the center.

Since 0.2


clutter_behaviour_scale_new ()

ClutterBehaviour*   clutter_behaviour_scale_new         (ClutterAlpha *alpha,
                                                         gdouble scale_begin,
                                                         gdouble scale_end,
                                                         ClutterGravity gravity);

Creates a new ClutterBehaviourScale instance.

alpha : a ClutterAlpha
scale_begin : initial scale factor
scale_end : final scale factor
gravity : a ClutterGravity for the scale.
Returns : the newly created ClutterBehaviourScale

Since 0.2


clutter_behaviour_scale_newx ()

ClutterBehaviour*   clutter_behaviour_scale_newx        (ClutterAlpha *alpha,
                                                         ClutterFixed scale_begin,
                                                         ClutterFixed scale_end,
                                                         ClutterGravity gravity);

A fixed point implementation of clutter_behaviour_scale_new()

alpha : a ClutterAlpha
scale_begin : initial scale factor
scale_end : final scale factor
gravity : a ClutterGravity for the scale.
Returns : the newly created ClutterBehaviourScale

Since 0.2


clutter_behaviour_scale_get_bounds ()

void                clutter_behaviour_scale_get_bounds  (ClutterBehaviourScale *scale,
                                                         gdouble *scale_begin,
                                                         gdouble *scale_end);

Retrieves the bounds used by scale behaviour.

scale : a ClutterBehaviourScale
scale_begin : return location for the initial scale factor
scale_end : return location for the final scale factor

Since 0.4


clutter_behaviour_scale_get_boundsx ()

void                clutter_behaviour_scale_get_boundsx (ClutterBehaviourScale *scale,
                                                         ClutterFixed *scale_begin,
                                                         ClutterFixed *scale_end);

Retrieves the bounds used by scale behaviour.

scale : a ClutterBehaviourScale
scale_begin : return location for the initial scale factor
scale_end : return location for the final scale factor

Since 0.4


clutter_behaviour_scale_get_gravity ()

ClutterGravity      clutter_behaviour_scale_get_gravity (ClutterBehaviourScale *scale);

Retrieves the ClutterGravity applied by the scale behaviour.

scale : a ClutterBehaviourScale
Returns : the gravity used by the behaviour

Since 0.4