src/adg/adg-projection.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009,2010  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-internal.h"
  38 #include "adg-projection.h"
  39 #include "adg-projection-private.h"
  40 #include "adg-line-style.h"
  41 #include "adg-dress-builtins.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         data->symbol_dress = g_value_get_int(value);
 177         break;
 178     case PROP_AXIS_DRESS:
 179         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  * If @scheme is invalid, a projection symbol without a scheme is
 197  * returned, that is #AdgProjection:scheme is set to
 198  * #ADG_PROJECTION_UNDEFINED, and a warning is raised.
 199  *
 200  * Returns: the newly created projection entity
 201  **/
 202 AdgProjection *
 203 adg_projection_new(AdgProjectionScheme scheme)
 204 {
 205     return g_object_new(ADG_TYPE_PROJECTION, "scheme", scheme, NULL);
 206 }
 207
 208 /**
 209  * adg_projection_set_symbol_dress:
 210  * @projection: an #AdgProjection
 211  * @dress: the new #AdgDress to use
 212  *
 213  * Sets a new line dress for rendering the symbol of @projection. The
 214  * new dress must be a line dress: the check is done by calling
 215  * adg_dress_are_related() with @dress and the old dress as
 216  * arguments. Check out its documentation for further details.
 217  *
 218  * The default dress is a transparent line dress: the rendering
 219  * callback will stroke the symbol using the default color with
 220  * a predefined thickness.
 221  **/
 222 void
 223 adg_projection_set_symbol_dress(AdgProjection *projection, AdgDress dress)
 224 {
 225     g_return_if_fail(ADG_IS_PROJECTION(projection));
 226     g_object_set((GObject *) projection, "symbol-dress", dress, NULL);
 227 }
 228
 229 /**
 230  * adg_projection_get_symbol_dress:
 231  * @projection: an #AdgProjection
 232  *
 233  * Gets the line dress to be used in stroking the symbol of @projection.
 234  *
 235  * Returns: the requested line dress
 236  **/
 237 AdgDress
 238 adg_projection_get_symbol_dress(AdgProjection *projection)
 239 {
 240     AdgProjectionPrivate *data;
 241
 242     g_return_val_if_fail(ADG_IS_PROJECTION(projection), ADG_DRESS_UNDEFINED);
 243
 244     data = projection->data;
 245
 246     return data->symbol_dress;
 247 }
 248
 249 /**
 250  * adg_projection_set_axis_dress:
 251  * @projection: an #AdgProjection
 252  * @dress: the new #AdgDress to use
 253  *
 254  * Sets a new line dress for rendering the axis of @projection.
 255  * The new dress must be a line dress: the check is done by
 256  * calling adg_dress_are_related() with @dress and the old
 257  * dress as arguments. Check out its documentation for
 258  * further details.
 259  *
 260  * The default dress is a transparent line dress: the rendering
 261  * callback will stroke the axis using the default line style.
 262  **/
 263 void
 264 adg_projection_set_axis_dress(AdgProjection *projection, AdgDress dress)
 265 {
 266     g_return_if_fail(ADG_IS_PROJECTION(projection));
 267     g_object_set((GObject *) projection, "axis-dress", dress, NULL);
 268 }
 269
 270 /**
 271  * adg_projection_get_axis_dress:
 272  * @projection: an #AdgProjection
 273  *
 274  * Gets the line dress to be used in stroking the axis of @projection.
 275  *
 276  * Returns: the requested line dress
 277  **/
 278 AdgDress
 279 adg_projection_get_axis_dress(AdgProjection *projection)
 280 {
 281     AdgProjectionPrivate *data;
 282
 283     g_return_val_if_fail(ADG_IS_PROJECTION(projection), ADG_DRESS_UNDEFINED);
 284
 285     data = projection->data;
 286
 287     return data->axis_dress;
 288 }
 289
 290 /**
 291  * adg_projection_set_scheme:
 292  * @projection: an #AdgProjection
 293  * @scheme: the new projection scheme
 294  *
 295  * Sets a new scheme on @projection. If @scheme is different
 296  * from the old one, @projection is invalidated.
 297  **/
 298 void
 299 adg_projection_set_scheme(AdgProjection *projection,
 300                           AdgProjectionScheme scheme)
 301 {
 302     g_return_if_fail(ADG_IS_PROJECTION(projection));
 303
 304     if (set_scheme(projection, scheme))
 305         g_object_notify((GObject *) projection, "scheme");
 306 }
 307
 308 /**
 309  * adg_projection_get_scheme:
 310  * @projection: an #AdgProjection
 311  *
 312  * Gets the scheme represented by @projection.
 313  *
 314  * Returns: the scheme of @projection
 315  **/
 316 AdgProjectionScheme
 317 adg_projection_get_scheme(AdgProjection  *projection)
 318 {
 319     AdgProjectionPrivate *data;
 320
 321     g_return_val_if_fail(ADG_IS_PROJECTION(projection),
 322                          ADG_PROJECTION_UNDEFINED);
 323
 324     data = projection->data;
 325
 326     return data->scheme;
 327 }
 328
 329
 330 static void
 331 arrange(AdgEntity *entity)
 332 {
 333     AdgProjectionPrivate *data;
 334     AdgProjectionClass *projection_class;
 335     AdgProjectionClassPrivate *data_class;
 336     CpmlExtents extents;
 337
 338     data = ((AdgProjection *) entity)->data;
 339     projection_class = ADG_PROJECTION_GET_CLASS(entity);
 340     data_class = projection_class->data_class;
 341
 342     arrange_class(projection_class, data->scheme);
 343     cpml_extents_copy(&extents, &data_class->extents);
 344
 345     cpml_extents_transform(&extents, adg_entity_get_local_matrix(entity));
 346     cpml_extents_transform(&extents, adg_entity_get_global_matrix(entity));
 347     adg_entity_set_extents(entity, &extents);
 348 }
 349
 350 static void
 351 arrange_class(AdgProjectionClass *projection_class, AdgProjectionScheme scheme)
 352 {
 353     AdgProjectionClassPrivate *data_class;
 354     AdgPath *symbol, *axis;
 355
 356     data_class = projection_class->data_class;
 357
 358     if (data_class->scheme == scheme)
 359         return;
 360
 361     if (data_class->symbol != NULL)
 362         g_object_unref(data_class->symbol);
 363
 364     if (data_class->axis != NULL)
 365         g_object_unref(data_class->axis);
 366
 367     data_class->scheme = scheme;
 368
 369     switch(scheme) {
 370     case ADG_PROJECTION_UNDEFINED:
 371         symbol = NULL;
 372         axis = NULL;
 373         break;
 374     case ADG_PROJECTION_FIRST_ANGLE:
 375         symbol = adg_path_new();
 376         adg_path_move_to_explicit(symbol, 4, 19);
 377         adg_path_line_to_explicit(symbol, 24, 24);
 378         adg_path_line_to_explicit(symbol, 24, 4);
 379         adg_path_line_to_explicit(symbol, 4, 9);
 380         adg_path_close(symbol);
 381         adg_path_move_to_explicit(symbol, 49, 14);
 382         adg_path_arc_to_explicit(symbol, 29, 14, 49, 14);
 383         adg_path_move_to_explicit(symbol, 44, 14);
 384         adg_path_arc_to_explicit(symbol, 34, 14, 44, 14);
 385
 386         axis = adg_path_new();
 387         adg_path_move_to_explicit(axis, 0, 14);
 388         adg_path_line_to_explicit(axis, 53, 14);
 389         adg_path_move_to_explicit(axis, 39, 0);
 390         adg_path_line_to_explicit(axis, 39, 28);
 391         break;
 392     case ADG_PROJECTION_THIRD_ANGLE:
 393         symbol = adg_path_new();
 394         adg_path_move_to_explicit(symbol, 29, 19);
 395         adg_path_line_to_explicit(symbol, 49, 24);
 396         adg_path_line_to_explicit(symbol, 49, 4);
 397         adg_path_line_to_explicit(symbol, 29, 9);
 398         adg_path_close(symbol);
 399         adg_path_move_to_explicit(symbol, 24, 14);
 400         adg_path_arc_to_explicit(symbol, 4, 14, 24, 14);
 401         adg_path_move_to_explicit(symbol, 19, 14);
 402         adg_path_arc_to_explicit(symbol, 9, 14, 19, 14);
 403
 404         axis = adg_path_new();
 405         adg_path_move_to_explicit(axis, 0, 14);
 406         adg_path_line_to_explicit(axis, 53, 14);
 407         adg_path_move_to_explicit(axis, 14, 0);
 408         adg_path_line_to_explicit(axis, 14, 28);
 409         break;
 410     default:
 411         g_return_if_reached();
 412         break;
 413     }
 414
 415     data_class->symbol = symbol;
 416     data_class->axis = axis;
 417     data_class->extents.is_defined = FALSE;
 418
 419     if (axis != NULL)
 420         cpml_extents_add(&data_class->extents,
 421                          adg_trail_get_extents((AdgTrail *) axis));
 422
 423     if (symbol != NULL)
 424         cpml_extents_add(&data_class->extents,
 425                          adg_trail_get_extents((AdgTrail *) symbol));
 426 }
 427
 428 static void
 429 render(AdgEntity *entity, cairo_t *cr)
 430 {
 431     AdgProjectionClassPrivate *data_class;
 432     AdgProjectionPrivate *data;
 433     const cairo_path_t *cairo_path;
 434
 435     data_class = ADG_PROJECTION_GET_CLASS(entity)->data_class;
 436     data = ((AdgProjection *) entity)->data;
 437
 438     if (data_class->symbol != NULL) {
 439         cairo_path = adg_trail_get_cairo_path((AdgTrail *) data_class->symbol);
 440
 441         cairo_save(cr);
 442         cairo_transform(cr, adg_entity_get_local_matrix(entity));
 443         cairo_append_path(cr, cairo_path);
 444         cairo_restore(cr);
 445
 446         cairo_set_line_width(cr, 2);
 447         adg_entity_apply_dress(entity, data->symbol_dress, cr);
 448
 449         cairo_stroke(cr);
 450     }
 451
 452     if (data_class->axis != NULL) {
 453         const gdouble dashes[] = { 5, 2, 1, 2 };
 454
 455         cairo_path = adg_trail_get_cairo_path((AdgTrail *) data_class->axis);
 456
 457         cairo_save(cr);
 458         cairo_transform(cr, adg_entity_get_local_matrix(entity));
 459         cairo_append_path(cr, cairo_path);
 460         cairo_restore(cr);
 461
 462         cairo_set_line_width(cr, 1);
 463         cairo_set_dash(cr, dashes, G_N_ELEMENTS(dashes), -1.5);
 464         adg_entity_apply_dress(entity, data->axis_dress, cr);
 465
 466         cairo_stroke(cr);
 467     }
 468 }
 469
 470 static gboolean
 471 set_scheme(AdgProjection *projection, AdgProjectionScheme scheme)
 472 {
 473     AdgProjectionPrivate *data;
 474
 475     g_return_val_if_fail(adg_is_enum_value(scheme, ADG_TYPE_PROJECTION_SCHEME),
 476                          FALSE);
 477
 478     data = projection->data;
 479
 480     if (data->scheme == scheme)
 481         return FALSE;
 482
 483     data->scheme = scheme;
 484
 485     adg_entity_invalidate((AdgEntity *) projection);
 486     return TRUE;
 487 }