adg/adg-stroke.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009 Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 /**
  22  * SECTION:adg-stroke
  23  * @short_description: A stroked entity
  24  *
  25  * The #AdgStroke object is a stroked representation of an #AdgTrail model.
  26  **/
  27
  28 /**
  29  * AdgStroke:
  30  *
  31  * All fields are private and should not be used directly.
  32  * Use its public methods instead.
  33  **/
  34
  35
  36 #include "adg-stroke.h"
  37 #include "adg-stroke-private.h"
  38 #include "adg-dress-builtins.h"
  39 #include "adg-line-style.h"
  40 #include "adg-intl.h"
  41
  42 #define PARENT_OBJECT_CLASS  ((GObjectClass *) adg_stroke_parent_class)
  43 #define PARENT_ENTITY_CLASS  ((AdgEntityClass *) adg_stroke_parent_class)
  44
  45
  46 enum {
  47     PROP_0,
  48     PROP_LINE_DRESS,
  49     PROP_TRAIL
  50 };
  51
  52 static void             dispose                 (GObject        *object);
  53 static void             get_property            (GObject        *object,
  54                                                  guint           param_id,
  55                                                  GValue         *value,
  56                                                  GParamSpec     *pspec);
  57 static void             set_property            (GObject        *object,
  58                                                  guint           param_id,
  59                                                  const GValue   *value,
  60                                                  GParamSpec     *pspec);
  61 static void             local_changed           (AdgEntity      *entity);
  62 static void             arrange                 (AdgEntity      *entity);
  63 static void             render                  (AdgEntity      *entity,
  64                                                  cairo_t        *cr);
  65 static gboolean         set_trail               (AdgStroke      *stroke,
  66                                                  AdgTrail       *trail);
  67 static void             unset_trail             (AdgStroke      *stroke);
  68
  69
  70 G_DEFINE_TYPE(AdgStroke, adg_stroke, ADG_TYPE_ENTITY);
  71
  72
  73 static void
  74 adg_stroke_class_init(AdgStrokeClass *klass)
  75 {
  76     GObjectClass *gobject_class;
  77     AdgEntityClass *entity_class;
  78     GParamSpec *param;
  79
  80     gobject_class = (GObjectClass *) klass;
  81     entity_class = (AdgEntityClass *) klass;
  82
  83     g_type_class_add_private(klass, sizeof(AdgStrokePrivate));
  84
  85     gobject_class->dispose = dispose;
  86     gobject_class->get_property = get_property;
  87     gobject_class->set_property = set_property;
  88
  89     entity_class->local_changed = local_changed;
  90     entity_class->arrange = arrange;
  91     entity_class->render = render;
  92
  93     param = adg_param_spec_dress("line-dress",
  94                                  P_("Line Dress"),
  95                                  P_("The dress to use for stroking this entity"),
  96                                  ADG_DRESS_LINE_MEDIUM,
  97                                  G_PARAM_READWRITE);
  98     g_object_class_install_property(gobject_class, PROP_LINE_DRESS, param);
  99
 100     param = g_param_spec_object("trail",
 101                                 P_("Trail"),
 102                                 P_("The trail to be stroked"),
 103                                 ADG_TYPE_TRAIL,
 104                                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
 105     g_object_class_install_property(gobject_class, PROP_TRAIL, param);
 106 }
 107
 108 static void
 109 adg_stroke_init(AdgStroke *stroke)
 110 {
 111     AdgStrokePrivate *data = G_TYPE_INSTANCE_GET_PRIVATE(stroke,
 112                                                          ADG_TYPE_STROKE,
 113                                                          AdgStrokePrivate);
 114
 115     data->line_dress = ADG_DRESS_LINE_MEDIUM;
 116     data->trail = NULL;
 117
 118     stroke->data = data;
 119 }
 120
 121 static void
 122 dispose(GObject *object)
 123 {
 124     AdgStroke *stroke = (AdgStroke *) object;
 125
 126     adg_stroke_set_trail(stroke, NULL);
 127
 128     if (PARENT_OBJECT_CLASS->dispose)
 129         PARENT_OBJECT_CLASS->dispose(object);
 130 }
 131
 132 static void
 133 get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 134 {
 135     AdgStrokePrivate *data = ((AdgStroke *) object)->data;
 136
 137     switch (prop_id) {
 138     case PROP_LINE_DRESS:
 139         g_value_set_int(value, data->line_dress);
 140         break;
 141     case PROP_TRAIL:
 142         g_value_set_object(value, &data->trail);
 143         break;
 144     default:
 145         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 146         break;
 147     }
 148 }
 149
 150 static void
 151 set_property(GObject *object, guint prop_id,
 152              const GValue *value, GParamSpec *pspec)
 153 {
 154     AdgStroke *stroke;
 155     AdgStrokePrivate *data;
 156
 157     stroke = (AdgStroke *) object;
 158     data = stroke->data;
 159
 160     switch (prop_id) {
 161     case PROP_LINE_DRESS:
 162         adg_dress_set(&data->line_dress, g_value_get_int(value));
 163         break;
 164     case PROP_TRAIL:
 165         set_trail(stroke, (AdgTrail *) g_value_get_object(value));
 166         break;
 167     default:
 168         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 169         break;
 170     }
 171 }
 172
 173
 174 /**
 175  * adg_stroke_new:
 176  * @trail: the #AdgTrail to stroke
 177  *
 178  * Creates a new stroke entity.
 179  *
 180  * Returns: the newly created stroke entity
 181  **/
 182 AdgStroke *
 183 adg_stroke_new(AdgTrail *trail)
 184 {
 185     g_return_val_if_fail(ADG_IS_TRAIL(trail), NULL);
 186
 187     return g_object_new(ADG_TYPE_STROKE, "trail", trail, NULL);
 188 }
 189
 190 /**
 191  * adg_stroke_get_line_dress:
 192  * @stroke: an #AdgStroke
 193  *
 194  * Gets the line dress to be used in rendering @stroke.
 195  *
 196  * Returns: the current line dress
 197  **/
 198 AdgDress
 199 adg_stroke_get_line_dress(AdgStroke *stroke)
 200 {
 201     AdgStrokePrivate *data;
 202
 203     g_return_val_if_fail(ADG_IS_STROKE(stroke), ADG_DRESS_UNDEFINED);
 204
 205     data = stroke->data;
 206
 207     return data->line_dress;
 208 }
 209
 210 /**
 211  * adg_stroke_set_line_dress:
 212  * @stroke: an #AdgStroke
 213  * @dress: the new #AdgDress to use
 214  *
 215  * Sets a new line dress for rendering @stroke. The new dress
 216  * must be related to the original dress for this property:
 217  * you cannot set a dress used for line styles to a dress
 218  * managing fonts.
 219  *
 220  * The check is done by calling adg_dress_are_related() with
 221  * @dress and the previous dress as arguments. Check out its
 222  * documentation for details on what is a related dress.
 223  **/
 224 void
 225 adg_stroke_set_line_dress(AdgStroke *stroke, AdgDress dress)
 226 {
 227     AdgStrokePrivate *data;
 228
 229     g_return_if_fail(ADG_IS_STROKE(stroke));
 230
 231     data = stroke->data;
 232
 233     if (adg_dress_set(&data->line_dress, dress))
 234         g_object_notify((GObject *) stroke, "line-dress");
 235 }
 236
 237 /**
 238  * adg_stroke_get_trail:
 239  * @stroke: an #AdgStroke
 240  *
 241  * Gets the #AdgTrail bound to this @stroke entity.
 242  *
 243  * Returns: the requested #AdgTrail or %NULL on errors
 244  **/
 245 AdgTrail *
 246 adg_stroke_get_trail(AdgStroke *stroke)
 247 {
 248     AdgStrokePrivate *data;
 249
 250     g_return_val_if_fail(ADG_IS_STROKE(stroke), NULL);
 251
 252     data = stroke->data;
 253
 254     return data->trail;
 255 }
 256
 257 /**
 258  * adg_stroke_set_trail:
 259  * @stroke: an #AdgStroke
 260  * @trail: the new #AdgTrail to bind
 261  *
 262  * Sets @trail as the new trail to be stroked by @stroke.
 263  **/
 264 void
 265 adg_stroke_set_trail(AdgStroke *stroke, AdgTrail *trail)
 266 {
 267     g_return_if_fail(ADG_IS_STROKE(stroke));
 268
 269     if (set_trail(stroke, trail))
 270         g_object_notify((GObject *) stroke, "trail");
 271 }
 272
 273
 274 static void
 275 local_changed(AdgEntity *entity)
 276 {
 277     AdgMatrix old;
 278     const AdgMatrix *new;
 279
 280     adg_matrix_copy(&old, adg_entity_get_local_matrix(entity));
 281
 282     if (PARENT_ENTITY_CLASS->local_changed)
 283         PARENT_ENTITY_CLASS->local_changed(entity);
 284
 285     new = adg_entity_get_local_matrix(entity);
 286
 287     /* For simple translation, avoid the entity invalidation:
 288      * translate the extents of the same vector instead */
 289     if (old.xx == new->xx && old.yy == new->yy &&
 290         old.xy == new->xy && old.yx == new->yx) {
 291         CpmlExtents extents;
 292
 293         cpml_extents_copy(&extents, adg_entity_get_extents(entity));
 294
 295         extents.org.x += new->x0 - old.x0;
 296         extents.org.y += new->y0 - old.y0;
 297
 298         adg_entity_set_extents(entity, &extents);
 299     }
 300
 301     adg_entity_invalidate(entity);
 302 }
 303
 304 static void
 305 arrange(AdgEntity *entity)
 306 {
 307     AdgStroke *stroke;
 308     AdgStrokePrivate *data;
 309     CpmlExtents extents;
 310
 311     /* Check for cached result */
 312     if (adg_entity_get_extents(entity)->is_defined)
 313         return;
 314
 315     stroke = (AdgStroke *) entity;
 316     data = stroke->data;
 317
 318     cpml_extents_copy(&extents, adg_trail_get_extents(data->trail));
 319     cpml_extents_transform(&extents, adg_entity_get_local_matrix(entity));
 320
 321     adg_entity_set_extents(entity, &extents);
 322 }
 323
 324 static void
 325 render(AdgEntity *entity, cairo_t *cr)
 326 {
 327     AdgStroke *stroke;
 328     AdgStrokePrivate *data;
 329     const cairo_path_t *cairo_path;
 330
 331     stroke = (AdgStroke *) entity;
 332     data = stroke->data;
 333     cairo_path = adg_trail_get_cairo_path(data->trail);
 334
 335     if (cairo_path != NULL) {
 336         cairo_save(cr);
 337         cairo_transform(cr, adg_entity_get_local_matrix(entity));
 338         cairo_append_path(cr, cairo_path);
 339         cairo_restore(cr);
 340
 341         adg_entity_apply_dress(entity, data->line_dress, cr);
 342         cairo_stroke(cr);
 343     }
 344 }
 345
 346 static gboolean
 347 set_trail(AdgStroke *stroke, AdgTrail *trail)
 348 {
 349     AdgEntity *entity;
 350     AdgStrokePrivate *data;
 351
 352     entity = (AdgEntity *) stroke;
 353     data = stroke->data;
 354
 355     if (trail == data->trail)
 356         return FALSE;
 357
 358     if (data->trail != NULL) {
 359         g_object_weak_unref((GObject *) data->trail,
 360                             (GWeakNotify) unset_trail, stroke);
 361         adg_model_remove_dependency((AdgModel *) data->trail, entity);
 362     }
 363
 364     data->trail = trail;
 365
 366     if (data->trail != NULL) {
 367         g_object_weak_ref((GObject *) data->trail,
 368                           (GWeakNotify) unset_trail, stroke);
 369         adg_model_add_dependency((AdgModel *) data->trail, entity);
 370     }
 371
 372     return TRUE;
 373 }
 374
 375 static void
 376 unset_trail(AdgStroke *stroke)
 377 {
 378     AdgStrokePrivate *data = stroke->data;
 379
 380     if (data->trail != NULL)
 381         set_trail(stroke, NULL);
 382 }