adg/adg-rdim.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-rdim
  23  * @short_description: Linear dimensions
  24  *
  25  * The #AdgRDim entity represents a linear dimension.
  26  **/
  27
  28 /**
  29  * AdgRDim:
  30  *
  31  * All fields are private and should not be used directly.
  32  * Use its public methods instead.
  33  **/
  34
  35
  36 #include "adg-rdim.h"
  37 #include "adg-rdim-private.h"
  38 #include "adg-dim-private.h"
  39 #include "adg-dim-style.h"
  40 #include "adg-intl.h"
  41
  42 #define PARENT_OBJECT_CLASS  ((GObjectClass *) adg_rdim_parent_class)
  43 #define PARENT_ENTITY_CLASS  ((AdgEntityClass *) adg_rdim_parent_class)
  44
  45
  46 static void             dispose                 (GObject        *object);
  47 static void             local_changed           (AdgEntity      *entity);
  48 static void             invalidate              (AdgEntity      *entity);
  49 static void             arrange                 (AdgEntity      *entity);
  50 static void             render                  (AdgEntity      *entity,
  51                                                  cairo_t        *cr);
  52 static gchar *          default_value           (AdgDim         *dim);
  53 static void             update_geometry         (AdgRDim        *rdim);
  54 static void             update_entities         (AdgRDim        *rdim);
  55 static void             unset_trail             (AdgRDim        *rdim);
  56 static void             dispose_marker          (AdgRDim        *rdim);
  57 static CpmlPath *       trail_callback          (AdgTrail       *trail,
  58                                                  gpointer        user_data);
  59
  60
  61 G_DEFINE_TYPE(AdgRDim, adg_rdim, ADG_TYPE_DIM);
  62
  63
  64 static void
  65 adg_rdim_class_init(AdgRDimClass *klass)
  66 {
  67     GObjectClass *gobject_class;
  68     AdgEntityClass *entity_class;
  69     AdgDimClass *dim_class;
  70
  71     gobject_class = (GObjectClass *) klass;
  72     entity_class = (AdgEntityClass *) klass;
  73     dim_class = (AdgDimClass *) klass;
  74
  75     g_type_class_add_private(klass, sizeof(AdgRDimPrivate));
  76
  77     gobject_class->dispose = dispose;
  78
  79     entity_class->local_changed = local_changed;
  80     entity_class->invalidate = invalidate;
  81     entity_class->arrange = arrange;
  82     entity_class->render = render;
  83
  84     dim_class->default_value = default_value;
  85 }
  86
  87 static void
  88 adg_rdim_init(AdgRDim *rdim)
  89 {
  90     AdgRDimPrivate *data;
  91     cairo_path_data_t move_to, line_to;
  92
  93     data = G_TYPE_INSTANCE_GET_PRIVATE(rdim, ADG_TYPE_RDIM, AdgRDimPrivate);
  94     move_to.header.type = CAIRO_PATH_MOVE_TO;
  95     move_to.header.length = 2;
  96     line_to.header.type = CAIRO_PATH_LINE_TO;
  97     line_to.header.length = 2;
  98
  99     data->trail = NULL;
 100     data->marker = NULL;
 101     data->geometry_arranged = FALSE;
 102     data->radius = -1.;
 103     data->shift.base.x = data->shift.base.y = 0;
 104     cairo_matrix_init_identity(&data->quote.global_map);
 105
 106     data->cpml.path.status = CAIRO_STATUS_INVALID_PATH_DATA;
 107     data->cpml.path.data = data->cpml.data;
 108     data->cpml.path.num_data = G_N_ELEMENTS(data->cpml.data);
 109     data->cpml.path.data[0] = move_to;
 110     data->cpml.path.data[2] = line_to;
 111     data->cpml.path.data[4] = move_to;
 112     data->cpml.path.data[6] = line_to;
 113
 114     rdim->data = data;
 115 }
 116
 117 static void
 118 dispose(GObject *object)
 119 {
 120     dispose_marker((AdgRDim *) object);
 121
 122     if (PARENT_OBJECT_CLASS->dispose)
 123         PARENT_OBJECT_CLASS->dispose(object);
 124 }
 125
 126
 127 /**
 128  * adg_rdim_new:
 129  *
 130  * Creates a new uninitialized radial dimension. To be useful, you
 131  * need at least define the center of the arc to quote (ref1) and
 132  * a point on the arc (ref2) with adg_dim_set_ref() and the
 133  * position of the quote with adg_dim_set_pos().
 134  *
 135  * Returns: a newly created quote
 136  **/
 137 AdgRDim *
 138 adg_rdim_new(void)
 139 {
 140     return g_object_new(ADG_TYPE_RDIM, NULL);
 141 }
 142
 143 /**
 144  * adg_rdim_new_full:
 145  * @center: center of the arc to quote
 146  * @radius: where the quote must be applied on the arc
 147  * @pos: position of the quote text
 148  *
 149  * Creates a new quote by specifying explicitely all the needed
 150  * data to get a valid quote.
 151  *
 152  * Returns: a newly created quote
 153  **/
 154 AdgRDim *
 155 adg_rdim_new_full(const AdgPair *center, const AdgPair *radius,
 156                   const AdgPair *pos)
 157 {
 158     AdgRDim *rdim;
 159     AdgDim *dim;
 160
 161     rdim = adg_rdim_new();
 162     dim = (AdgDim *) rdim;
 163
 164     adg_dim_set_ref(dim, center, radius);
 165     adg_dim_set_pos(dim, pos);
 166
 167     return rdim;
 168 }
 169
 170 /**
 171  * adg_rdim_new_full_explicit:
 172  * @center_x: x coordinate of the center of the arc to quote
 173  * @center_y: y coordinate of the center of the arc to quote
 174  * @radius_x: x coordiante where the quote must be applied on the arc
 175  * @radius_y: y coordiante where the quote must be applied on the arc
 176  * @pos_x: x coordinate of the quote text
 177  * @pos_y: y coordinate of the quote text
 178  *
 179  * Does the same job of adg_rdim_full() but using specific coordinates
 180  * instead of AdgPair structures.
 181  * data to get a valid quote.
 182  *
 183  * Returns: a newly created quote
 184  **/
 185 AdgRDim *
 186 adg_rdim_new_full_explicit(gdouble center_x, gdouble center_y,
 187                            gdouble radius_x, gdouble radius_y,
 188                            gdouble pos_x,    gdouble pos_y)
 189 {
 190     AdgPair center, radius, pos;
 191
 192     center.x = center_x;
 193     center.y = center_y;
 194     radius.x = radius_x;
 195     radius.y = radius_y;
 196     pos.x = pos_x;
 197     pos.y = pos_y;
 198
 199     return adg_rdim_new_full(&center, &radius, &pos);
 200 }
 201
 202 /**
 203  * adg_rdim_new_full_from_model:
 204  * @model: the model from which the named pairs are taken
 205  * @center: the center point of the arc to quote
 206  * @radius: an arbitrary point on the arc
 207  * @pos: the position reference
 208  *
 209  * Creates a new radial dimension, specifing all the needed properties in
 210  * one shot and using named pairs from @model.
 211  *
 212  * Returns: the newly created radial dimension entity
 213  **/
 214 AdgRDim *
 215 adg_rdim_new_full_from_model(AdgModel *model, const gchar *center,
 216                              const gchar *radius, const gchar *pos)
 217 {
 218     AdgDim *dim = g_object_new(ADG_TYPE_RDIM, NULL);
 219
 220     adg_dim_set_ref_from_model(dim, model, center, radius);
 221     adg_dim_set_pos_from_model(dim, model, pos);
 222
 223     return (AdgRDim *) dim;
 224 }
 225
 226
 227 static void
 228 local_changed(AdgEntity *entity)
 229 {
 230     unset_trail((AdgRDim *) entity);
 231
 232     if (PARENT_ENTITY_CLASS->local_changed)
 233         PARENT_ENTITY_CLASS->local_changed(entity);
 234 }
 235
 236 static void
 237 invalidate(AdgEntity *entity)
 238 {
 239     AdgRDim *rdim;
 240     AdgRDimPrivate *data;
 241
 242     rdim = (AdgRDim *) entity;
 243     data = rdim->data;
 244
 245     dispose_marker(rdim);
 246     data->geometry_arranged = FALSE;
 247     unset_trail(rdim);
 248
 249     if (PARENT_ENTITY_CLASS->invalidate)
 250         PARENT_ENTITY_CLASS->invalidate(entity);
 251 }
 252
 253 static void
 254 arrange(AdgEntity *entity)
 255 {
 256     AdgRDim *rdim;
 257     AdgDim *dim;
 258     AdgRDimPrivate *data;
 259     AdgAlignment *quote;
 260     AdgDimStyle *dim_style;
 261     gboolean outside;
 262     const AdgMatrix *local;
 263     AdgPair ref1, ref2, base;
 264     AdgPair pair;
 265
 266     if (PARENT_ENTITY_CLASS->arrange)
 267         PARENT_ENTITY_CLASS->arrange(entity);
 268
 269     rdim = (AdgRDim *) entity;
 270     dim = (AdgDim *) rdim;
 271     data = rdim->data;
 272     quote = adg_dim_get_quote(dim);
 273
 274     update_geometry(rdim);
 275     update_entities(rdim);
 276
 277     if (data->cpml.path.status == CAIRO_STATUS_SUCCESS) {
 278         AdgEntity *quote_entity = (AdgEntity *) quote;
 279         adg_entity_set_global_map(quote_entity, &data->quote.global_map);
 280         return;
 281     }
 282
 283     dim_style = GET_DIM_STYLE(dim);
 284     outside = adg_dim_get_outside(dim);
 285     if (outside == ADG_THREE_STATE_UNKNOWN)
 286         outside = ADG_THREE_STATE_OFF;
 287
 288     local = adg_entity_get_local_matrix(entity);
 289     cpml_pair_copy(&ref1, adg_dim_get_ref1(dim));
 290     cpml_pair_copy(&ref2, adg_dim_get_ref2(dim));
 291     cpml_pair_copy(&base, &data->point.base);
 292
 293     cpml_pair_transform(&ref1, local);
 294     cpml_pair_transform(&ref2, local);
 295     cpml_pair_transform(&base, local);
 296     cpml_pair_add(&base, &data->shift.base);
 297
 298     /* baseline start */
 299     cpml_pair_to_cairo(&base, &data->cpml.data[1]);
 300
 301     /* baseline end */
 302     cpml_pair_to_cairo(&ref2, &data->cpml.data[3]);
 303
 304     if (outside) {
 305         data->cpml.data[2].header.length = 2;
 306         /* TODO: outside radius dimensions */
 307     } else {
 308         data->cpml.data[2].header.length = 6;
 309     }
 310
 311     data->cpml.path.status = CAIRO_STATUS_SUCCESS;
 312
 313     if (quote != NULL) {
 314         AdgEntity *quote_entity;
 315         AdgMatrix map;
 316
 317         quote_entity = (AdgEntity *) quote;
 318         cpml_pair_from_cairo(&pair, &data->cpml.data[1]);
 319
 320         adg_alignment_set_factor_explicit(quote, 1, 0);
 321
 322         cairo_matrix_init_translate(&map, pair.x, pair.y);
 323         cairo_matrix_rotate(&map, data->angle);
 324         adg_entity_set_global_map(quote_entity, &map);
 325
 326         adg_matrix_copy(&data->quote.global_map,
 327                         adg_entity_get_global_map(quote_entity));
 328     }
 329
 330     if (data->marker != NULL) {
 331         adg_marker_set_segment(data->marker, data->trail, outside ? 2 : 1);
 332         adg_entity_local_changed((AdgEntity *) data->marker);
 333     }
 334
 335     /* TODO: compute the extents */
 336 }
 337
 338 static void
 339 render(AdgEntity *entity, cairo_t *cr)
 340 {
 341     AdgRDim *rdim;
 342     AdgDim *dim;
 343     AdgRDimPrivate *data;
 344     AdgDimStyle *dim_style;
 345     AdgDress dress;
 346     const cairo_path_t *cairo_path;
 347
 348     rdim = (AdgRDim *) entity;
 349     dim = (AdgDim *) entity;
 350     data = rdim->data;
 351     dim_style = GET_DIM_STYLE(dim);
 352
 353     adg_style_apply((AdgStyle *) dim_style, entity, cr);
 354
 355     if (data->marker != NULL)
 356         adg_entity_render((AdgEntity *) data->marker, cr);
 357
 358     adg_entity_render((AdgEntity *) adg_dim_get_quote(dim), cr);
 359
 360     dress = adg_dim_style_get_line_dress(dim_style);
 361     adg_entity_apply_dress(entity, dress, cr);
 362
 363     cairo_path = adg_trail_get_cairo_path(data->trail);
 364     cairo_append_path(cr, cairo_path);
 365     cairo_stroke(cr);
 366 }
 367
 368 static gchar *
 369 default_value(AdgDim *dim)
 370 {
 371     AdgRDim *rdim;
 372     AdgRDimPrivate *data;
 373     AdgDimStyle *dim_style;
 374     const gchar *format;
 375
 376     rdim = (AdgRDim *) dim;
 377     data = rdim->data;
 378     dim_style = GET_DIM_STYLE(dim);
 379     format = adg_dim_style_get_number_format(dim_style);
 380
 381     update_geometry(rdim);
 382
 383     return g_strdup_printf(format, data->radius);
 384 }
 385
 386 static void
 387 update_geometry(AdgRDim *rdim)
 388 {
 389     AdgRDimPrivate *data;
 390     AdgDim *dim;
 391     AdgDimStyle *dim_style;
 392     const AdgPair *ref1, *ref2;
 393     const AdgPair *pos;
 394     gdouble spacing, level, pos_distance;
 395     CpmlVector vector;
 396
 397     data = rdim->data;
 398
 399     if (data->geometry_arranged)
 400         return;
 401
 402     dim = (AdgDim *) rdim;
 403     dim_style = GET_DIM_STYLE(rdim);
 404     ref1 = adg_dim_get_ref1(dim);
 405     ref2 = adg_dim_get_ref2(dim);
 406     pos = adg_dim_get_pos(dim);
 407     spacing = adg_dim_style_get_baseline_spacing(dim_style);
 408     level = adg_dim_get_level(dim);
 409     pos_distance = cpml_pair_distance(pos, ref1);
 410     cpml_pair_sub(cpml_pair_copy(&vector, ref2), ref1);
 411     if (cpml_pair_squared_distance(pos, ref1) <
 412         cpml_pair_squared_distance(pos, ref2))
 413         cpml_pair_negate(&vector);
 414
 415     /* radius */
 416     data->radius = cpml_pair_distance(&vector, NULL);
 417
 418     /* angle */
 419     data->angle = adg_dim_quote_angle(dim, cpml_vector_angle(&vector));
 420
 421     /* point.base */
 422     cpml_pair_copy(&data->point.base, &vector);
 423     cpml_vector_set_length(&data->point.base, pos_distance);
 424     cpml_pair_add(&data->point.base, ref1);
 425
 426     /* shift.base */
 427     cpml_pair_copy(&data->shift.base, &vector);
 428     cpml_vector_set_length(&data->shift.base, spacing * level);
 429
 430     data->geometry_arranged = TRUE;
 431 }
 432
 433 static void
 434 update_entities(AdgRDim *rdim)
 435 {
 436     AdgRDimPrivate *data;
 437     AdgDimStyle *dim_style;
 438
 439     data = rdim->data;
 440     dim_style = GET_DIM_STYLE(rdim);
 441
 442     if (data->trail == NULL)
 443         data->trail = adg_trail_new(trail_callback, rdim);
 444
 445     if (data->marker == NULL)
 446         data->marker = adg_dim_style_marker2_new(dim_style);
 447 }
 448
 449 static void
 450 unset_trail(AdgRDim *rdim)
 451 {
 452     AdgRDimPrivate *data = rdim->data;
 453
 454     if (data->trail != NULL)
 455         adg_model_clear((AdgModel *) data->trail);
 456
 457     data->cpml.path.status = CAIRO_STATUS_INVALID_PATH_DATA;
 458 }
 459
 460 static void
 461 dispose_marker(AdgRDim *rdim)
 462 {
 463     AdgRDimPrivate *data = rdim->data;
 464
 465     if (data->trail != NULL) {
 466         g_object_unref(data->trail);
 467         data->trail = NULL;
 468     }
 469
 470     if (data->marker != NULL) {
 471         g_object_unref(data->marker);
 472         data->marker = NULL;
 473     }
 474 }
 475
 476 static CpmlPath *
 477 trail_callback(AdgTrail *trail, gpointer user_data)
 478 {
 479     AdgRDim *rdim;
 480     AdgRDimPrivate *data;
 481
 482     rdim = (AdgRDim *) user_data;
 483     data = rdim->data;
 484
 485     return &data->cpml.path;
 486 }