adg/adg-projection.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-projection
  23  * @short_description: The standard symbol for specifying the projection scheme
  24  *
  25  * The #AdgProjection is an entity representing the standard symbol
  26  * of the projection scheme.
  27  **/
  28
  29 /**
  30  * AdgProjection:
  31  *
  32  * All fields are private and should not be used directly.
  33  * Use its public methods instead.
  34  **/
  35
  36
  37 #include "adg-projection.h"
  38 #include "adg-projection-private.h"
  39 #include "adg-line-style.h"
  40 #include "adg-dress-builtins.h"
  41 #include "adg-intl.h"
  42
  43 #define PARENT_OBJECT_CLASS  ((GObjectClass *) adg_projection_parent_class)
  44
  45
  46 enum {
  47     PROP_0,
  48     PROP_SYMBOL_DRESS,
  49     PROP_AXIS_DRESS,
  50     PROP_SCHEME
  51 };
  52
  53
  54 static void             get_property            (GObject        *object,
  55                                                  guint           param_id,
  56                                                  GValue         *value,
  57                                                  GParamSpec     *pspec);
  58 static void             set_property            (GObject        *object,
  59                                                  guint           param_id,
  60                                                  const GValue   *value,
  61                                                  GParamSpec     *pspec);
  62 static void             arrange                 (AdgEntity      *entity);
  63 static void             render                  (AdgEntity      *entity,
  64                                                  cairo_t        *cr);
  65 static void             arrange_class           (AdgProjectionClass *projection_class,
  66                                                  AdgProjectionScheme scheme);
  67 static gboolean         set_scheme              (AdgProjection  *projection,
  68                                                  AdgProjectionScheme scheme);
  69
  70
  71 G_DEFINE_TYPE(AdgProjection, adg_projection, ADG_TYPE_ENTITY);
  72
  73
  74 static void
  75 adg_projection_class_init(AdgProjectionClass *klass)
  76 {
  77     GObjectClass *gobject_class;
  78     AdgEntityClass *entity_class;
  79     GParamSpec *param;
  80     AdgProjectionClassPrivate *data_class;
  81
  82     gobject_class = (GObjectClass *) klass;
  83     entity_class = (AdgEntityClass *) klass;
  84
  85     g_type_class_add_private(klass, sizeof(AdgProjectionPrivate));
  86
  87     gobject_class->get_property = get_property;
  88     gobject_class->set_property = set_property;
  89
  90     entity_class->arrange = arrange;
  91     entity_class->render = render;
  92
  93     param = adg_param_spec_dress("symbol-dress",
  94                                  P_("Symbol Dress"),
  95                                  P_("The line dress to use for rendering the views of the projection"),
  96                                  ADG_DRESS_LINE,
  97                                  G_PARAM_READWRITE);
  98     g_object_class_install_property(gobject_class, PROP_SYMBOL_DRESS, param);
  99
 100     param = adg_param_spec_dress("axis-dress",
 101                                  P_("Axis Dress"),
 102                                  P_("The line dress to use for rendering the axis of the projection scheme"),
 103                                  ADG_DRESS_LINE,
 104                                  G_PARAM_READWRITE);
 105     g_object_class_install_property(gobject_class, PROP_AXIS_DRESS, param);
 106
 107     param = g_param_spec_enum("scheme",
 108                               P_("Projection Scheme"),
 109                               P_("The projection scheme to be represented"),
 110                               ADG_TYPE_PROJECTION_SCHEME,
 111                               ADG_PROJECTION_UNDEFINED,
 112                               G_PARAM_READWRITE);
 113     g_object_class_install_property(gobject_class, PROP_SCHEME, param);
 114
 115     /* Initialize the private class data: the allocated struct is
 116      * never freed as this type is registered statically, hence
 117      * never destroyed. A better approach would be to use the old
 118      * type initialization (no G_TYPE_DEFINE and friends) that
 119      * allows to specify a custom class finalization method */
 120     data_class = g_new(AdgProjectionClassPrivate, 1);
 121
 122     data_class->scheme = ADG_PROJECTION_UNDEFINED;
 123     data_class->symbol = NULL;
 124     data_class->axis = NULL;
 125     data_class->extents.is_defined = FALSE;
 126
 127     klass->data_class = data_class;
 128 }
 129
 130 static void
 131 adg_projection_init(AdgProjection *projection)
 132 {
 133     AdgProjectionPrivate *data = G_TYPE_INSTANCE_GET_PRIVATE(projection, ADG_TYPE_PROJECTION,
 134                                                        AdgProjectionPrivate);
 135
 136     data->symbol_dress = ADG_DRESS_LINE;
 137     data->axis_dress = ADG_DRESS_LINE;
 138     data->scheme = ADG_PROJECTION_UNDEFINED;
 139
 140     projection->data = data;
 141 }
 142
 143 static void
 144 get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 145 {
 146     AdgProjectionPrivate *data = ((AdgProjection *) object)->data;
 147
 148     switch (prop_id) {
 149     case PROP_SYMBOL_DRESS:
 150         g_value_set_int(value, data->symbol_dress);
 151         break;
 152     case PROP_AXIS_DRESS:
 153         g_value_set_int(value, data->axis_dress);
 154         break;
 155     case PROP_SCHEME:
 156         g_value_set_enum(value, data->scheme);
 157         break;
 158     default:
 159         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 160         break;
 161     }
 162 }
 163
 164 static void
 165 set_property(GObject *object, guint prop_id,
 166              const GValue *value, GParamSpec *pspec)
 167 {
 168     AdgProjection *projection;
 169     AdgProjectionPrivate *data;
 170
 171     projection = (AdgProjection *) object;
 172     data = projection->data;
 173
 174     switch (prop_id) {
 175     case PROP_SYMBOL_DRESS:
 176         adg_dress_set(&data->symbol_dress, g_value_get_int(value));
 177         break;
 178     case PROP_AXIS_DRESS:
 179         adg_dress_set(&data->axis_dress, g_value_get_int(value));
 180         break;
 181     case PROP_SCHEME:
 182         set_scheme(projection, g_value_get_enum(value));
 183         break;
 184     default:
 185         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 186         break;
 187     }
 188 }
 189
 190
 191 /**
 192  * adg_projection_new:
 193  * @scheme: the scheme represented by this projection
 194  *
 195  * Creates a new projection entity representing the selected @scheme.
 196  *
 197  * Returns: the newly created projection entity
 198  **/
 199 AdgProjection *
 200 adg_projection_new(AdgProjectionScheme scheme)
 201 {
 202     return g_object_new(ADG_TYPE_PROJECTION, "scheme", scheme, NULL);
 203 }
 204
 205 /**
 206  * adg_projection_get_symbol_dress:
 207  * @projection: an #AdgProjection
 208  *
 209  * Gets the line dress to be used in stroking the symbol of @projection.
 210  *
 211  * Returns: the requested line dress
 212  **/
 213 AdgDress
 214 adg_projection_get_symbol_dress(AdgProjection *projection)
 215 {
 216     AdgProjectionPrivate *data;
 217
 218     g_return_val_if_fail(ADG_IS_PROJECTION(projection), ADG_DRESS_UNDEFINED);
 219
 220     data = projection->data;
 221
 222     return data->symbol_dress;
 223 }
 224
 225 /**
 226  * adg_projection_set_symbol_dress:
 227  * @projection: an #AdgProjection
 228  * @dress: the new #AdgDress to use
 229  *
 230  * Sets a new line dress for rendering the symbol of @projection. The
 231  * new dress must be a line dress: the check is done by calling
 232  * adg_dress_are_related() with @dress and the old dress as
 233  * arguments. Check out its documentation for further details.
 234  *
 235  * The default dress is a transparent line dress: the rendering
 236  * callback will stroke the symbol using the default color with
 237  * a predefined thickness.
 238  **/
 239 void
 240 adg_projection_set_symbol_dress(AdgProjection *projection, AdgDress dress)
 241 {
 242     AdgProjectionPrivate *data;
 243
 244     g_return_if_fail(ADG_IS_PROJECTION(projection));
 245
 246     data = projection->data;
 247
 248     if (adg_dress_set(&data->symbol_dress, dress))
 249         g_object_notify((GObject *) projection, "symbol-dress");
 250 }
 251
 252 /**
 253  * adg_projection_get_axis_dress:
 254  * @projection: an #AdgProjection
 255  *
 256  * Gets the line dress to be used in stroking the axis of @projection.
 257  *
 258  * Returns: the requested line dress
 259  **/
 260 AdgDress
 261 adg_projection_get_axis_dress(AdgProjection *projection)
 262 {
 263     AdgProjectionPrivate *data;
 264
 265     g_return_val_if_fail(ADG_IS_PROJECTION(projection), ADG_DRESS_UNDEFINED);
 266
 267     data = projection->data;
 268
 269     return data->axis_dress;
 270 }
 271
 272 /**
 273  * adg_projection_set_axis_dress:
 274  * @projection: an #AdgProjection
 275  * @dress: the new #AdgDress to use
 276  *
 277  * Sets a new line dress for rendering the axis of @projection.
 278  * The new dress must be a line dress: the check is done by
 279  * calling adg_dress_are_related() with @dress and the old
 280  * dress as arguments. Check out its documentation for
 281  * further details.
 282  *
 283  * The default dress is a transparent line dress: the rendering
 284  * callback will stroke the axis using the default line style.
 285  **/
 286 void
 287 adg_projection_set_axis_dress(AdgProjection *projection, AdgDress dress)
 288 {
 289     AdgProjectionPrivate *data;
 290
 291     g_return_if_fail(ADG_IS_PROJECTION(projection));
 292
 293     data = projection->data;
 294
 295     if (adg_dress_set(&data->axis_dress, dress))
 296         g_object_notify((GObject *) projection, "axis-dress");
 297 }
 298
 299 /**
 300  * adg_projection_get_scheme:
 301  * @projection: an #AdgProjection
 302  *
 303  * Gets the scheme represented by @projection.
 304  *
 305  * Returns: the scheme of @projection
 306  **/
 307 AdgProjectionScheme
 308 adg_projection_get_scheme(AdgProjection  *projection)
 309 {
 310     AdgProjectionPrivate *data;
 311
 312     g_return_val_if_fail(ADG_IS_PROJECTION(projection),
 313                          ADG_PROJECTION_UNDEFINED);
 314
 315     data = projection->data;
 316
 317     return data->scheme;
 318 }
 319
 320 /**
 321  * adg_projection_set_scheme:
 322  * @projection: an #AdgProjection
 323  * @scheme: the new projection scheme
 324  *
 325  * Sets a new scheme on @projection. If @scheme is different
 326  * from the old one, @projection is invalidated.
 327  **/
 328 void
 329 adg_projection_set_scheme(AdgProjection *projection,
 330                           AdgProjectionScheme scheme)
 331 {
 332     g_return_if_fail(ADG_IS_PROJECTION(projection));
 333
 334     if (set_scheme(projection, scheme))
 335         g_object_notify((GObject *) projection, "scheme");
 336 }
 337
 338
 339 static void
 340 arrange(AdgEntity *entity)
 341 {
 342     AdgProjectionPrivate *data;
 343     AdgProjectionClass *projection_class;
 344     AdgProjectionClassPrivate *data_class;
 345     CpmlExtents extents;
 346     const AdgMatrix *local;
 347
 348     data = ((AdgProjection *) entity)->data;
 349     projection_class = ADG_PROJECTION_GET_CLASS(entity);
 350     data_class = projection_class->data_class;
 351     local = adg_entity_local_matrix(entity);
 352
 353     arrange_class(projection_class, data->scheme);
 354     cpml_extents_copy(&extents, &data_class->extents);
 355
 356     /* Apply the local matrix to the extents of this projection instance */
 357     cpml_pair_transform(&extents.org, local);
 358     cpml_vector_transform(&extents.size, local);
 359     adg_entity_set_extents(entity, &extents);
 360 }
 361
 362 static void
 363 arrange_class(AdgProjectionClass *projection_class, AdgProjectionScheme scheme)
 364 {
 365     AdgProjectionClassPrivate *data_class;
 366     AdgPath *symbol, *axis;
 367
 368     data_class = projection_class->data_class;
 369
 370     if (data_class->scheme == scheme)
 371         return;
 372
 373     if (data_class->symbol != NULL)
 374         g_object_unref(data_class->symbol);
 375
 376     if (data_class->axis != NULL)
 377         g_object_unref(data_class->axis);
 378
 379     data_class->scheme = scheme;
 380
 381     switch(scheme) {
 382     case ADG_PROJECTION_UNDEFINED:
 383         symbol = NULL;
 384         axis = NULL;
 385         break;
 386     case ADG_PROJECTION_FIRST_ANGLE:
 387         symbol = adg_path_new();
 388         adg_path_move_to_explicit(symbol, 4, 19);
 389         adg_path_line_to_explicit(symbol, 24, 24);
 390         adg_path_line_to_explicit(symbol, 24, 4);
 391         adg_path_line_to_explicit(symbol, 4, 9);
 392         adg_path_close(symbol);
 393         adg_path_move_to_explicit(symbol, 49, 14);
 394         adg_path_arc_to_explicit(symbol, 29, 14, 49, 14);
 395         adg_path_move_to_explicit(symbol, 44, 14);
 396         adg_path_arc_to_explicit(symbol, 34, 14, 44, 14);
 397
 398         axis = adg_path_new();
 399         adg_path_move_to_explicit(axis, 0, 14);
 400         adg_path_line_to_explicit(axis, 53, 14);
 401         adg_path_move_to_explicit(axis, 39, 0);
 402         adg_path_line_to_explicit(axis, 39, 28);
 403         break;
 404     case ADG_PROJECTION_THIRD_ANGLE:
 405         symbol = adg_path_new();
 406         adg_path_move_to_explicit(symbol, 29, 19);
 407         adg_path_line_to_explicit(symbol, 49, 24);
 408         adg_path_line_to_explicit(symbol, 49, 4);
 409         adg_path_line_to_explicit(symbol, 29, 9);
 410         adg_path_close(symbol);
 411         adg_path_move_to_explicit(symbol, 24, 14);
 412         adg_path_arc_to_explicit(symbol, 4, 14, 24, 14);
 413         adg_path_move_to_explicit(symbol, 19, 14);
 414         adg_path_arc_to_explicit(symbol, 9, 14, 19, 14);
 415
 416         axis = adg_path_new();
 417         adg_path_move_to_explicit(axis, 0, 14);
 418         adg_path_line_to_explicit(axis, 53, 14);
 419         adg_path_move_to_explicit(axis, 14, 0);
 420         adg_path_line_to_explicit(axis, 14, 28);
 421         break;
 422     default:
 423         g_assert_not_reached();
 424         break;
 425     }
 426
 427     data_class->symbol = symbol;
 428     data_class->axis = axis;
 429     data_class->extents.is_defined = FALSE;
 430
 431     if (axis != NULL)
 432         cpml_extents_add(&data_class->extents,
 433                          adg_trail_extents((AdgTrail *) axis));
 434
 435     if (symbol != NULL)
 436         cpml_extents_add(&data_class->extents,
 437                          adg_trail_extents((AdgTrail *) symbol));
 438 }
 439
 440 static void
 441 render(AdgEntity *entity, cairo_t *cr)
 442 {
 443     AdgProjectionClassPrivate *data_class;
 444     AdgProjectionPrivate *data;
 445     const cairo_path_t *cairo_path;
 446
 447     data_class = ADG_PROJECTION_GET_CLASS(entity)->data_class;
 448     data = ((AdgProjection *) entity)->data;
 449
 450     if (data_class->symbol != NULL) {
 451         cairo_path = adg_trail_get_cairo_path((AdgTrail *) data_class->symbol);
 452
 453         cairo_save(cr);
 454         cairo_set_matrix(cr, adg_entity_ctm(entity));
 455         cairo_append_path(cr, cairo_path);
 456         cairo_restore(cr);
 457
 458         cairo_set_line_width(cr, 2);
 459         adg_entity_apply_dress(entity, data->symbol_dress, cr);
 460
 461         cairo_stroke(cr);
 462     }
 463
 464     if (data_class->axis != NULL) {
 465         const gdouble dashes[] = { 5, 2, 1, 2 };
 466
 467         cairo_path = adg_trail_get_cairo_path((AdgTrail *) data_class->axis);
 468
 469         cairo_save(cr);
 470         cairo_set_matrix(cr, adg_entity_ctm(entity));
 471         cairo_append_path(cr, cairo_path);
 472         cairo_restore(cr);
 473
 474         cairo_set_line_width(cr, 1);
 475         cairo_set_dash(cr, dashes, G_N_ELEMENTS(dashes), -1.5);
 476         adg_entity_apply_dress(entity, data->axis_dress, cr);
 477
 478         cairo_stroke(cr);
 479     }
 480 }
 481
 482 static gboolean
 483 set_scheme(AdgProjection *projection, AdgProjectionScheme scheme)
 484 {
 485     AdgProjectionPrivate *data = projection->data;
 486
 487     if (data->scheme == scheme)
 488         return FALSE;
 489
 490     data->scheme = scheme;
 491
 492     adg_entity_invalidate((AdgEntity *) projection);
 493     return TRUE;
 494 }