From e61aed2146cf76a3c4077460b9ff643b076e1b4e Mon Sep 17 00:00:00 2001 From: Tomas Frydrych Date: Mon, 30 Apr 2007 08:39:20 +0000 Subject: [PATCH] cleaned up ClutterBehaviourEllipse api, added documentation --- clutter/Makefile.am | 2 + clutter/clutter-behaviour-ellipse.c | 226 ++++++++++++++++++++------ clutter/clutter-behaviour-ellipse.h | 44 +++-- clutter/clutter.h | 1 + doc/reference/clutter-docs.sgml | 1 + doc/reference/clutter-sections.txt | 20 +++ doc/reference/clutter.types | 1 + doc/reference/tmpl/clutter-media.sgml | 15 -- 8 files changed, 236 insertions(+), 74 deletions(-) diff --git a/clutter/Makefile.am b/clutter/Makefile.am index a48bb645d..ee2ba3679 100644 --- a/clutter/Makefile.am +++ b/clutter/Makefile.am @@ -40,6 +40,7 @@ source_h = \ $(srcdir)/clutter-alpha.h \ $(srcdir)/clutter-behaviour.h \ $(srcdir)/clutter-behaviour-bspline.h \ + $(srcdir)/clutter-behaviour-ellipse.h \ $(srcdir)/clutter-behaviour-opacity.h \ $(srcdir)/clutter-behaviour-path.h \ $(srcdir)/clutter-behaviour-rotate.h \ @@ -125,6 +126,7 @@ source_c = \ clutter-backend.c \ clutter-behaviour.c \ clutter-behaviour-bspline.c \ + clutter-behaviour-ellipse.c \ clutter-behaviour-opacity.c \ clutter-behaviour-path.c \ clutter-behaviour-rotate.c \ diff --git a/clutter/clutter-behaviour-ellipse.c b/clutter/clutter-behaviour-ellipse.c index 7f0185c7a..9bdbcce78 100644 --- a/clutter/clutter-behaviour-ellipse.c +++ b/clutter/clutter-behaviour-ellipse.c @@ -79,7 +79,6 @@ enum PROP_HEIGHT, PROP_ANGLE_BEGIN, PROP_ANGLE_END, - PROP_DIRECTION, }; struct _ClutterBehaviourEllipsePrivate @@ -92,7 +91,6 @@ struct _ClutterBehaviourEllipsePrivate gint b; ClutterAngle angle_begin; ClutterAngle angle_end; - ClutterRotateDirection direction; }; static void @@ -109,8 +107,8 @@ clutter_behaviour_ellipse_advance (ClutterBehaviourEllipse * e, knot->x = CFX_INT (e->priv->a * clutter_cosi (angle)); knot->y = CFX_INT (e->priv->b * clutter_sini (angle)); -/* g_debug ("advancing to angle %d [%d, %d] (a: %d, b: %d)", */ -/* angle, knot->x, knot->y, e->priv->a, e->priv->b); */ + g_debug ("advancing to angle %d [%d, %d] (a: %d, b: %d)", + angle, knot->x, knot->y, e->priv->a, e->priv->b); } @@ -125,22 +123,23 @@ actor_apply_knot_foreach (ClutterBehaviour *behave, static void clutter_behaviour_ellipse_alpha_notify (ClutterBehaviour * behave, - guint32 alpha) + guint32 alpha) { ClutterKnot knot; ClutterBehaviourEllipse * self = CLUTTER_BEHAVIOUR_ELLIPSE (behave); ClutterAngle angle; - if (self->priv->direction == CLUTTER_ROTATE_CW) + if (self->priv->angle_end >= self->priv->angle_begin) { angle = self->priv->angle_end - self->priv->angle_begin; - angle = (angle * alpha) / CLUTTER_ALPHA_MAX_ALPHA + - self->priv->angle_begin; + angle = + (angle * alpha) / CLUTTER_ALPHA_MAX_ALPHA + self->priv->angle_begin; } else { - angle = 1024 - (self->priv->angle_end - self->priv->angle_begin); - angle = self->priv->angle_begin - (angle * alpha) / CLUTTER_ALPHA_MAX_ALPHA; + angle = self->priv->angle_begin - self->priv->angle_end; + angle = + self->priv->angle_begin - (angle * alpha) / CLUTTER_ALPHA_MAX_ALPHA; } clutter_behaviour_ellipse_advance (self, angle, &knot); @@ -175,13 +174,10 @@ clutter_behaviour_ellipse_set_property (GObject *gobject, priv->angle_end = g_value_get_int (value); break; case PROP_WIDTH: - priv->a = g_value_get_int (value) / 2; + priv->a = g_value_get_int (value) >> 1; break; case PROP_HEIGHT: - priv->b = g_value_get_int (value) / 2; - break; - case PROP_DIRECTION: - priv->direction = g_value_get_enum (value); + priv->b = g_value_get_int (value) >> 1; break; case PROP_CENTER: clutter_behaviour_ellipse_set_center (el, g_value_get_boxed (value)); @@ -216,9 +212,6 @@ clutter_behaviour_ellipse_get_property (GObject *gobject, case PROP_HEIGHT: g_value_set_int (value, 2 * priv->b); break; - case PROP_DIRECTION: - g_value_set_enum (value, priv->direction); - break; case PROP_CENTER: g_value_set_boxed (value, &priv->center); break; @@ -243,7 +236,7 @@ clutter_behaviour_ellipse_class_init (ClutterBehaviourEllipseClass *klass) /** * ClutterBehaviourEllipse:angle-begin: * - * The initial angle from whence the rotation should begin. + * The initial angle from where the rotation should begin. * * Since: 0.4 */ @@ -310,30 +303,15 @@ clutter_behaviour_ellipse_class_init (ClutterBehaviourEllipseClass *klass) "Center of ellipse", CLUTTER_TYPE_KNOT, CLUTTER_PARAM_READWRITE)); - /** - * ClutterBehaviourEllipse:direction: - * - * The direction of the rotation. - * - * Since: 0.4 - */ - g_object_class_install_property (object_class, - PROP_DIRECTION, - g_param_spec_enum ("direction", - "Direction", - "Direction of rotation", - CLUTTER_TYPE_ROTATE_DIRECTION, - CLUTTER_ROTATE_CW, - CLUTTER_PARAM_READWRITE)); /** * ClutterBehaviourEllipse::knot-reached: - * @pathb: the object which received the signal + * @ellipse: the object which received the signal * @knot: the #ClutterKnot reached * * This signal is emitted at the end of each frame. * - * Since: 0.2 + * Since: 0.4 */ ellipse_signals[KNOT_REACHED] = g_signal_new ("knot-reached", @@ -359,11 +337,16 @@ clutter_behaviour_ellipse_init (ClutterBehaviourEllipse * self) /** * clutter_behaviour_ellipse_new: * @alpha: a #ClutterAlpha, or %NULL - * @center: center of the ellipse + * @center: center of the ellipse as #ClutterKnot * @width: width of the ellipse - * @height: heigh of the ellipse + * @height: height of the ellipse + * @begin: #ClutterAngle at which movement begins + * @end: #ClutterAngle at which movement ends * - * Creates a behaviour that drives actors along the elliptical path. + * Creates a behaviour that drives actors along an elliptical path with + * given center, width and height; the movement begins at angle_begin and + * ends at angle_end; if angle_end > angle_begin, the movement is in + * counter-clockwise direction, clockwise other wise. * * Return value: a #ClutterBehaviour * @@ -375,8 +358,7 @@ clutter_behaviour_ellipse_new (ClutterAlpha * alpha, gint width, gint height, ClutterAngle begin, - ClutterAngle end, - ClutterRotateDirection dir) + ClutterAngle end) { ClutterBehaviourEllipse *bc; @@ -389,7 +371,6 @@ clutter_behaviour_ellipse_new (ClutterAlpha * alpha, "height", height, "angle-begin", begin, "angle-end", end, - "direction", dir, NULL); return CLUTTER_BEHAVIOUR (bc); @@ -398,9 +379,9 @@ clutter_behaviour_ellipse_new (ClutterAlpha * alpha, /** * clutter_behaviour_ellipse_set_center * @self: a #ClutterBehaviourEllipse - * @knot: a #ClutterKnot center for the bezier + * @knot: a #ClutterKnot center for the ellipse * - * Sets the center of the ellipse path to the point represented by knot. + * Sets the center of the elliptical path to the point represented by knot. * * Since: 0.4 */ @@ -408,7 +389,13 @@ void clutter_behaviour_ellipse_set_center (ClutterBehaviourEllipse * self, ClutterKnot * knot) { - self->priv->center = *knot; + if (self->priv->center.x != knot->x || self->priv->center.y != knot->y) + { + g_object_ref (self); + self->priv->center = *knot; + g_object_notify (G_OBJECT (self), "center"); + g_object_unref (self); + } } /** @@ -416,7 +403,7 @@ clutter_behaviour_ellipse_set_center (ClutterBehaviourEllipse * self, * @self: a #ClutterBehaviourEllipse * @knot: a #ClutterKnot where to store the center of the ellipse * - * Gets the center of the ellipse path. + * Gets the center of the elliptical path path. * * Since: 0.4 */ @@ -427,3 +414,150 @@ clutter_behaviour_ellipse_get_center (ClutterBehaviourEllipse * self, *knot = self->priv->center; } + +/** + * clutter_behaviour_ellipse_set_width + * @self: a #ClutterBehaviourEllipse + * @width: width of the ellipse + * + * Sets the width of the elliptical path. + * + * Since: 0.4 + */ +void +clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse * self, + gint width) +{ + if (self->priv->a != width >> 1) + { + g_object_ref (self); + self->priv->a = width >> 1; + g_object_notify (G_OBJECT (self), "width"); + g_object_unref (self); + } +} + +/** + * clutter_behaviour_ellipse_get_width + * @self: a #ClutterBehaviourEllipse + * + * Gets the width of the elliptical path. + * + * Since: 0.4 + */ +gint +clutter_behaviour_ellipse_get_width (ClutterBehaviourEllipse * self) +{ + return self->priv->a << 1; +} + +/** + * clutter_behaviour_ellipse_set_height + * @self: a #ClutterBehaviourEllipse + * @height: height of the ellipse + * + * Sets the height of the elliptical path. + * + * Since: 0.4 + */ +void +clutter_behaviour_ellipse_set_height (ClutterBehaviourEllipse * self, + gint height) +{ + if (self->priv->b != height >> 1) + { + g_object_ref (self); + self->priv->b = height >> 1; + g_object_notify (G_OBJECT (self), "height"); + g_object_unref (self); + } +} + +/** + * clutter_behaviour_ellipse_get_height + * @self: a #ClutterBehaviourEllipse + * + * Gets the height of the elliptical path. + * + * Since: 0.4 + */ +gint +clutter_behaviour_ellipse_get_height (ClutterBehaviourEllipse * self) +{ + return self->priv->b << 1; +} + + +/** + * clutter_behaviour_ellipse_set_angle_begin + * @self: a #ClutterBehaviourEllipse + * @angle_begin: #ClutterAngle at which movement begins + * + * Sets the angle at which movement begins. + * + * Since: 0.4 + */ +void +clutter_behaviour_ellipse_set_angle_begin (ClutterBehaviourEllipse * self, + ClutterAngle angle_begin) +{ + if (self->priv->angle_begin != angle_begin) + { + g_object_ref (self); + self->priv->angle_begin = angle_begin; + g_object_notify (G_OBJECT (self), "angle-begin"); + g_object_unref (self); + } +} + +/** + * clutter_behaviour_ellipse_get_angle_begin + * @self: a #ClutterBehaviourEllipse + * + * Gets the at which movements begins. + * + * Since: 0.4 + */ +ClutterAngle +clutter_behaviour_ellipse_get_angle_begin (ClutterBehaviourEllipse * self) +{ + return self->priv->angle_begin; +} + + +/** + * clutter_behaviour_ellipse_set_angle_end + * @self: a #ClutterBehaviourEllipse + * @angle_end: #ClutterAngle at which movement ends + * + * Sets the angle at which movement ends. + * + * Since: 0.4 + */ +void +clutter_behaviour_ellipse_set_angle_end (ClutterBehaviourEllipse * self, + ClutterAngle angle_end) +{ + if (self->priv->angle_end != angle_end) + { + g_object_ref (self); + self->priv->angle_end = angle_end; + g_object_notify (G_OBJECT (self), "angle-end"); + g_object_unref (self); + } +} + +/** + * clutter_behaviour_ellipse_get_angle_end + * @self: a #ClutterBehaviourEllipse + * + * Gets the at which movements ends. + * + * Since: 0.4 + */ +ClutterAngle +clutter_behaviour_ellipse_get_angle_end (ClutterBehaviourEllipse * self) +{ + return self->priv->angle_end; +} + diff --git a/clutter/clutter-behaviour-ellipse.h b/clutter/clutter-behaviour-ellipse.h index 893190ed0..b6d1ed186 100644 --- a/clutter/clutter-behaviour-ellipse.h +++ b/clutter/clutter-behaviour-ellipse.h @@ -5,7 +5,7 @@ * * Authored By Tomas Frydrych * - * Copyright (C) 2006, 2007 OpenedHand + * Copyright (C) 2007 OpenedHand * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -29,7 +29,6 @@ #include #include #include -#include G_BEGIN_DECLS @@ -82,18 +81,37 @@ struct _ClutterBehaviourEllipseClass GType clutter_behaviour_ellipse_get_type (void) G_GNUC_CONST; -ClutterBehaviour *clutter_behaviour_ellipse_new (ClutterAlpha *alpha, - ClutterKnot * center, - gint width, - gint height, - ClutterAngle start, - ClutterAngle end, - ClutterRotateDirection dir); +ClutterBehaviour *clutter_behaviour_ellipse_new (ClutterAlpha * alpha, + ClutterKnot * center, + gint width, + gint height, + ClutterAngle start, + ClutterAngle end); -void clutter_behaviour_ellipse_set_center (ClutterBehaviourEllipse *self, - ClutterKnot *knot); -void clutter_behaviour_ellipse_get_center (ClutterBehaviourEllipse *bs, - ClutterKnot *knot); +void clutter_behaviour_ellipse_set_center (ClutterBehaviourEllipse * self, + ClutterKnot * knot); +void clutter_behaviour_ellipse_get_center (ClutterBehaviourEllipse * bs, + ClutterKnot * knot); + +void clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse * self, + gint width); + +gint clutter_behaviour_ellipse_get_width (ClutterBehaviourEllipse * self); + +void clutter_behaviour_ellipse_set_height (ClutterBehaviourEllipse * self, + gint height); + +gint clutter_behaviour_ellipse_get_height (ClutterBehaviourEllipse * self); + +void clutter_behaviour_ellipse_set_angle_begin (ClutterBehaviourEllipse * self, + ClutterAngle angle_begin); + +ClutterAngle clutter_behaviour_ellipse_get_angle_begin (ClutterBehaviourEllipse * self); + +void clutter_behaviour_ellipse_set_angle_end (ClutterBehaviourEllipse * self, + ClutterAngle angle_end); + +ClutterAngle clutter_behaviour_ellipse_get_angle_end (ClutterBehaviourEllipse * self); G_END_DECLS diff --git a/clutter/clutter.h b/clutter/clutter.h index 91de7ad72..3448f6dd4 100644 --- a/clutter/clutter.h +++ b/clutter/clutter.h @@ -34,6 +34,7 @@ #include "clutter-timeline.h" #include "clutter-behaviour.h" #include "clutter-behaviour-bspline.h" +#include "clutter-behaviour-ellipse.h" #include "clutter-behaviour-opacity.h" #include "clutter-behaviour-path.h" #include "clutter-behaviour-rotate.h" diff --git a/doc/reference/clutter-docs.sgml b/doc/reference/clutter-docs.sgml index 3972aed99..ae2c77368 100644 --- a/doc/reference/clutter-docs.sgml +++ b/doc/reference/clutter-docs.sgml @@ -80,6 +80,7 @@ + diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt index 275767479..01fa50b0d 100644 --- a/doc/reference/clutter-sections.txt +++ b/doc/reference/clutter-sections.txt @@ -497,6 +497,26 @@ ClutterBehaviourBsplinePrivate clutter_behaviour_bspline_get_type +
+clutter-behaviour-ellipse +ClutterBehaviourEllipse +ClutterBehaviourEllipse +ClutterBehaviourEllipseClass +clutter_behaviour_ellipse_new +clutter_behaviour_ellipse_set_center +clutter_behaviour_ellipse_get_center + +CLUTTER_BEHAVIOUR_ELLIPSE +CLUTTER_BEHAVIOUR_ELLIPSE_CLASS +CLUTTER_IS_BEHAVIOUR_ELLIPSE +CLUTTER_IS_BEHAVIOUR_ELLIPSE_CLASS +CLUTTER_BEHAVIOUR_ELLIPSE_GET_CLASS + +ClutterBehaviourEllipsePrivate +clutter_behaviour_ellipse_get_type +
+ +
clutter-backend ClutterBackend diff --git a/doc/reference/clutter.types b/doc/reference/clutter.types index 74b1b0b96..1d23a0f43 100644 --- a/doc/reference/clutter.types +++ b/doc/reference/clutter.types @@ -12,6 +12,7 @@ clutter_media_get_type clutter_behaviour_get_type clutter_alpha_get_type clutter_behaviour_bspline_get_type +clutter_behaviour_ellipse_get_type clutter_behaviour_opacity_get_type clutter_behaviour_path_get_type clutter_behaviour_rotate_get_type diff --git a/doc/reference/tmpl/clutter-media.sgml b/doc/reference/tmpl/clutter-media.sgml index 3d85887af..5330021ec 100644 --- a/doc/reference/tmpl/clutter-media.sgml +++ b/doc/reference/tmpl/clutter-media.sgml @@ -23,21 +23,6 @@ clutter-media - - - - - -@cluttermedia: the object which received the signal. - - - - - - -@cluttermedia: the object which received the signal. -@arg1: -