ClutterBehaviourEllipse

ClutterBehaviourEllipse — elliptic path behaviour.

Synopsis




                    ClutterBehaviourEllipse;
                    ClutterBehaviourEllipseClass;
ClutterBehaviour*   clutter_behaviour_ellipse_new       (ClutterAlpha *alpha,
                                                         gint x,
                                                         gint y,
                                                         gint width,
                                                         gint height,
                                                         gdouble begin,
                                                         gdouble end,
                                                         gdouble tilt);
ClutterBehaviour*   clutter_behaviour_ellipse_newx      (ClutterAlpha *alpha,
                                                         gint x,
                                                         gint y,
                                                         gint width,
                                                         gint height,
                                                         ClutterFixed begin,
                                                         ClutterFixed end,
                                                         ClutterFixed tilt);
void                clutter_behaviour_ellipse_set_center
                                                        (ClutterBehaviourEllipse *self,
                                                         gint x,
                                                         gint y);
void                clutter_behaviour_ellipse_get_center
                                                        (ClutterBehaviourEllipse *self,
                                                         gint *x,
                                                         gint *y);
ClutterAngle        clutter_behaviour_ellipse_get_angle_begin
                                                        (ClutterBehaviourEllipse *self);
ClutterAngle        clutter_behaviour_ellipse_get_angle_end
                                                        (ClutterBehaviourEllipse *self);
ClutterAngle        clutter_behaviour_ellipse_get_angle_tilt
                                                        (ClutterBehaviourEllipse *self);
gint                clutter_behaviour_ellipse_get_height
                                                        (ClutterBehaviourEllipse *self);
gint                clutter_behaviour_ellipse_get_width (ClutterBehaviourEllipse *self);
void                clutter_behaviour_ellipse_set_angle_begin
                                                        (ClutterBehaviourEllipse *self,
                                                         ClutterAngle angle_begin);
void                clutter_behaviour_ellipse_set_angle_end
                                                        (ClutterBehaviourEllipse *self,
                                                         ClutterAngle angle_end);
void                clutter_behaviour_ellipse_set_angle_tilt
                                                        (ClutterBehaviourEllipse *self,
                                                         ClutterAngle angle_tilt);
void                clutter_behaviour_ellipse_set_height
                                                        (ClutterBehaviourEllipse *self,
                                                         gint height);
void                clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse *self,
                                                         gint width);


Object Hierarchy


  GObject
   +----ClutterBehaviour
         +----ClutterBehaviourEllipse

Properties


  "angle-begin"              gint                  : Read / Write
  "angle-end"                gint                  : Read / Write
  "angle-tilt"               gint                  : Read / Write
  "center"                   ClutterKnot           : Read / Write
  "height"                   gint                  : Read / Write
  "width"                    gint                  : Read / Write

Description

ClutterBehaviourEllipse interpolates actors along a path defined by an ellipse.

Details

ClutterBehaviourEllipse

typedef struct _ClutterBehaviourEllipse ClutterBehaviourEllipse;


ClutterBehaviourEllipseClass

typedef struct {
  ClutterBehaviourClass   parent_class;

  void (*knot_reached) (ClutterBehaviourEllipse *ellipseb,
                        const ClutterKnot       *knot);

  void (*_clutter_ellipse_1) (void);
  void (*_clutter_ellipse_2) (void);
  void (*_clutter_ellipse_3) (void);
  void (*_clutter_ellipse_4) (void);
} ClutterBehaviourEllipseClass;


clutter_behaviour_ellipse_new ()

ClutterBehaviour*   clutter_behaviour_ellipse_new       (ClutterAlpha *alpha,
                                                         gint x,
                                                         gint y,
                                                         gint width,
                                                         gint height,
                                                         gdouble begin,
                                                         gdouble end,
                                                         gdouble tilt);

Creates a behaviour that drives actors along an elliptical path with given center, width and height; the movement begins at angle_begin (with 0 corresponding to 12 o'clock) and ends at angle_end; if angle_end > angle_begin, the movement is in clockwise direction, counter-clockwise otherwise.

alpha : a ClutterAlpha, or NULL
x : x coordinace of the center
y : y coordiance of the center
width : width of the ellipse
height : height of the ellipse
begin : angle in degrees at which movement begins
end : angle in degrees at which movement ends
tilt : angle in degrees with which the ellipse should be tilted around its center
Returns : a ClutterBehaviour

Since 0.4


clutter_behaviour_ellipse_newx ()

ClutterBehaviour*   clutter_behaviour_ellipse_newx      (ClutterAlpha *alpha,
                                                         gint x,
                                                         gint y,
                                                         gint width,
                                                         gint height,
                                                         ClutterFixed begin,
                                                         ClutterFixed end,
                                                         ClutterFixed tilt);

Creates a behaviour that drives actors along an elliptical path with given center, width and height; the movement begins at angle_begin (with 0 corresponding to 12 o'clock) and ends at angle_end; if angle_end > angle_begin, the movement is in clockwise direction, counter-clockwise otherwise.

alpha : a ClutterAlpha, or NULL
x : x coordinace of the center
y : y coordiance of the center
width : width of the ellipse
height : height of the ellipse
begin : ClutterFixed angle in degrees at which movement begins
end : ClutterFixed angle in degrees at which movement ends
tilt : ClutterFixed angle in degrees with which the ellipse should be tilted around its center
Returns : a ClutterBehaviour

Since 0.4


clutter_behaviour_ellipse_set_center ()

void                clutter_behaviour_ellipse_set_center
                                                        (ClutterBehaviourEllipse *self,
                                                         gint x,
                                                         gint y);

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

self : a ClutterBehaviourEllipse
x : x coordinace of centre
y : y coordinace of centre

Since 0.4


clutter_behaviour_ellipse_get_center ()

void                clutter_behaviour_ellipse_get_center
                                                        (ClutterBehaviourEllipse *self,
                                                         gint *x,
                                                         gint *y);

Gets the center of the elliptical path path.

self : a ClutterBehaviourEllipse
x : location to store the x coordinace of the center, or NULL
y : location to store the y coordinace of the center, or NULL

Since 0.4


clutter_behaviour_ellipse_get_angle_begin ()

ClutterAngle        clutter_behaviour_ellipse_get_angle_begin
                                                        (ClutterBehaviourEllipse *self);

Gets the angle at which movements begins.

self : a ClutterBehaviourEllipse
Returns : a ClutterAngle

Since 0.4


clutter_behaviour_ellipse_get_angle_end ()

ClutterAngle        clutter_behaviour_ellipse_get_angle_end
                                                        (ClutterBehaviourEllipse *self);

Gets the at which movements ends.

self : a ClutterBehaviourEllipse
Returns : a ClutterAngle

Since 0.4


clutter_behaviour_ellipse_get_angle_tilt ()

ClutterAngle        clutter_behaviour_ellipse_get_angle_tilt
                                                        (ClutterBehaviourEllipse *self);

Gets the tilt of the ellipse around the center.

self : a ClutterBehaviourEllipse
Returns : a ClutterAngle

Since 0.4


clutter_behaviour_ellipse_get_height ()

gint                clutter_behaviour_ellipse_get_height
                                                        (ClutterBehaviourEllipse *self);

Gets the height of the elliptical path.

self : a ClutterBehaviourEllipse
Returns : the height of the path

Since 0.4


clutter_behaviour_ellipse_get_width ()

gint                clutter_behaviour_ellipse_get_width (ClutterBehaviourEllipse *self);

Gets the width of the elliptical path.

self : a ClutterBehaviourEllipse
Returns : the width of the path

Since 0.4


clutter_behaviour_ellipse_set_angle_begin ()

void                clutter_behaviour_ellipse_set_angle_begin
                                                        (ClutterBehaviourEllipse *self,
                                                         ClutterAngle angle_begin);

Sets the angle at which movement begins.

self : a ClutterBehaviourEllipse
angle_begin : ClutterAngle at which movement begins

Since 0.4


clutter_behaviour_ellipse_set_angle_end ()

void                clutter_behaviour_ellipse_set_angle_end
                                                        (ClutterBehaviourEllipse *self,
                                                         ClutterAngle angle_end);

Sets the angle at which movement ends.

self : a ClutterBehaviourEllipse
angle_end : ClutterAngle at which movement ends

Since 0.4


clutter_behaviour_ellipse_set_angle_tilt ()

void                clutter_behaviour_ellipse_set_angle_tilt
                                                        (ClutterBehaviourEllipse *self,
                                                         ClutterAngle angle_tilt);

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

self : a ClutterBehaviourEllipse
angle_tilt : ClutterAngle tilt of the elipse around the center

Since 0.4


clutter_behaviour_ellipse_set_height ()

void                clutter_behaviour_ellipse_set_height
                                                        (ClutterBehaviourEllipse *self,
                                                         gint height);

Sets the height of the elliptical path.

self : a ClutterBehaviourEllipse
height : height of the ellipse

Since 0.4


clutter_behaviour_ellipse_set_width ()

void                clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse *self,
                                                         gint width);

Sets the width of the elliptical path.

self : a ClutterBehaviourEllipse
width : width of the ellipse

Since 0.4

Property Details

The "angle-begin" property

  "angle-begin"              gint                  : Read / Write

The initial angle from where the rotation should begin.

Default value: 0

Since 0.4


The "angle-end" property

  "angle-end"                gint                  : Read / Write

The final angle to where the rotation should end.

Default value: 1024

Since 0.4


The "angle-tilt" property

  "angle-tilt"               gint                  : Read / Write

Tilt of the ellipse.

Default value: 1024


The "center" property

  "center"                   ClutterKnot           : Read / Write

The center of the ellipse.

Since 0.4


The "height" property

  "height"                   gint                  : Read / Write

Height of the ellipse.

Allowed values: >= 0

Default value: 50

Since 0.4


The "width" property

  "width"                    gint                  : Read / Write

Width of the ellipse.

Allowed values: >= 0

Default value: 100

Since 0.4