src/rect-context.cpp

   1 #define __SP_RECT_CONTEXT_C__
   2
   3 /*
   4  * Rectangle drawing context
   5  *
   6  * Author:
   7  *   Lauris Kaplinski <lauris@kaplinski.com>
   8  *   bulia byak <buliabyak@users.sf.net>
   9  *
  10  * Copyright (C) 2006      Johan Engelen <johan@shouraizou.nl>
  11  * Copyright (C) 2000-2005 authors
  12  * Copyright (C) 2000-2001 Ximian, Inc.
  13  *
  14  * Released under GNU GPL, read the file 'COPYING' for more information
  15  */
  16
  17 #include "config.h"
  18 #include "inkscape.h"
  19
  20 #include <gdk/gdkkeysyms.h>
  21 #include <cstring>
  22 #include <string>
  23
  24 #include "macros.h"
  25 #include "display/sp-canvas.h"
  26 #include "sp-rect.h"
  27 #include "document.h"
  28 #include "sp-namedview.h"
  29 #include "selection.h"
  30 #include "selection-chemistry.h"
  31 #include "desktop-handles.h"
  32 #include "snap.h"
  33 #include "desktop.h"
  34 #include "desktop-style.h"
  35 #include "message-context.h"
  36 #include "pixmaps/cursor-rect.xpm"
  37 #include "rect-context.h"
  38 #include "sp-metrics.h"
  39 #include <glibmm/i18n.h>
  40 #include "object-edit.h"
  41 #include "xml/repr.h"
  42 #include "xml/node-event-vector.h"
  43 #include "prefs-utils.h"
  44 #include "context-fns.h"
  45
  46 //static const double goldenratio = 1.61803398874989484820; // golden ratio
  47
  48 static void sp_rect_context_class_init(SPRectContextClass *klass);
  49 static void sp_rect_context_init(SPRectContext *rect_context);
  50 static void sp_rect_context_dispose(GObject *object);
  51
  52 static void sp_rect_context_setup(SPEventContext *ec);
  53 static void sp_rect_context_set(SPEventContext *ec, gchar const *key, gchar const *val);
  54
  55 static gint sp_rect_context_root_handler(SPEventContext *event_context, GdkEvent *event);
  56 static gint sp_rect_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event);
  57
  58 static void sp_rect_drag(SPRectContext &rc, NR::Point const pt, guint state);
  59 static void sp_rect_finish(SPRectContext *rc);
  60
  61 static SPEventContextClass *parent_class;
  62
  63
  64 GtkType sp_rect_context_get_type()
  65 {
  66     static GType type = 0;
  67     if (!type) {
  68         GTypeInfo info = {
  69             sizeof(SPRectContextClass),
  70             NULL, NULL,
  71             (GClassInitFunc) sp_rect_context_class_init,
  72             NULL, NULL,
  73             sizeof(SPRectContext),
  74             4,
  75             (GInstanceInitFunc) sp_rect_context_init,
  76             NULL,    /* value_table */
  77         };
  78         type = g_type_register_static(SP_TYPE_EVENT_CONTEXT, "SPRectContext", &info, (GTypeFlags) 0);
  79     }
  80     return type;
  81 }
  82
  83 static void sp_rect_context_class_init(SPRectContextClass *klass)
  84 {
  85     GObjectClass *object_class = (GObjectClass *) klass;
  86     SPEventContextClass *event_context_class = (SPEventContextClass *) klass;
  87
  88     parent_class = (SPEventContextClass *) g_type_class_peek_parent(klass);
  89
  90     object_class->dispose = sp_rect_context_dispose;
  91
  92     event_context_class->setup = sp_rect_context_setup;
  93     event_context_class->set = sp_rect_context_set;
  94     event_context_class->root_handler  = sp_rect_context_root_handler;
  95     event_context_class->item_handler  = sp_rect_context_item_handler;
  96 }
  97
  98 static void sp_rect_context_init(SPRectContext *rect_context)
  99 {
 100     SPEventContext *event_context = SP_EVENT_CONTEXT(rect_context);
 101
 102     event_context->cursor_shape = cursor_rect_xpm;
 103     event_context->hot_x = 4;
 104     event_context->hot_y = 4;
 105     event_context->xp = 0;
 106     event_context->yp = 0;
 107     event_context->tolerance = 0;
 108     event_context->within_tolerance = false;
 109     event_context->item_to_select = NULL;
 110
 111     event_context->shape_repr = NULL;
 112     event_context->shape_knot_holder = NULL;
 113
 114     rect_context->item = NULL;
 115
 116     rect_context->rx = 0.0;
 117     rect_context->ry = 0.0;
 118
 119     new (&rect_context->sel_changed_connection) sigc::connection();
 120 }
 121
 122 static void sp_rect_context_dispose(GObject *object)
 123 {
 124     SPRectContext *rc = SP_RECT_CONTEXT(object);
 125     SPEventContext *ec = SP_EVENT_CONTEXT(object);
 126
 127     ec->enableGrDrag(false);
 128
 129     rc->sel_changed_connection.disconnect();
 130     rc->sel_changed_connection.~connection();
 131
 132     /* fixme: This is necessary because we do not grab */
 133     if (rc->item) {
 134         sp_rect_finish(rc);
 135     }
 136
 137     if (ec->shape_knot_holder) {
 138         delete ec->shape_knot_holder;
 139         ec->shape_knot_holder = NULL;
 140     }
 141
 142     if (ec->shape_repr) { // remove old listener
 143         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
 144         Inkscape::GC::release(ec->shape_repr);
 145         ec->shape_repr = 0;
 146     }
 147
 148     if (rc->_message_context) {
 149         delete rc->_message_context;
 150     }
 151
 152     G_OBJECT_CLASS(parent_class)->dispose(object);
 153 }
 154
 155 static Inkscape::XML::NodeEventVector ec_shape_repr_events = {
 156     NULL, /* child_added */
 157     NULL, /* child_removed */
 158     ec_shape_event_attr_changed,
 159     NULL, /* content_changed */
 160     NULL  /* order_changed */
 161 };
 162
 163 /**
 164 \brief  Callback that processes the "changed" signal on the selection;
 165 destroys old and creates new knotholder
 166 */
 167 void sp_rect_context_selection_changed(Inkscape::Selection *selection, gpointer data)
 168 {
 169     SPRectContext *rc = SP_RECT_CONTEXT(data);
 170     SPEventContext *ec = SP_EVENT_CONTEXT(rc);
 171
 172     if (ec->shape_knot_holder) { // destroy knotholder
 173         delete ec->shape_knot_holder;
 174         ec->shape_knot_holder = NULL;
 175     }
 176
 177     if (ec->shape_repr) { // remove old listener
 178         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
 179         Inkscape::GC::release(ec->shape_repr);
 180         ec->shape_repr = 0;
 181     }
 182
 183     SPItem *item = selection->singleItem();
 184     if (item) {
 185         ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
 186         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
 187         if (shape_repr) {
 188             ec->shape_repr = shape_repr;
 189             Inkscape::GC::anchor(shape_repr);
 190             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
 191         }
 192     }
 193 }
 194
 195 static void sp_rect_context_setup(SPEventContext *ec)
 196 {
 197     SPRectContext *rc = SP_RECT_CONTEXT(ec);
 198
 199     if (((SPEventContextClass *) parent_class)->setup) {
 200         ((SPEventContextClass *) parent_class)->setup(ec);
 201     }
 202
 203     SPItem *item = sp_desktop_selection(ec->desktop)->singleItem();
 204     if (item) {
 205         ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
 206         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
 207         if (shape_repr) {
 208             ec->shape_repr = shape_repr;
 209             Inkscape::GC::anchor(shape_repr);
 210             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
 211         }
 212     }
 213
 214     rc->sel_changed_connection.disconnect();
 215     rc->sel_changed_connection = sp_desktop_selection(ec->desktop)->connectChanged(
 216         sigc::bind(sigc::ptr_fun(&sp_rect_context_selection_changed), (gpointer)rc)
 217     );
 218
 219     sp_event_context_read(ec, "rx");
 220     sp_event_context_read(ec, "ry");
 221
 222     if (prefs_get_int_attribute("tools.shapes", "selcue", 0) != 0) {
 223         ec->enableSelectionCue();
 224     }
 225
 226     if (prefs_get_int_attribute("tools.shapes", "gradientdrag", 0) != 0) {
 227         ec->enableGrDrag();
 228     }
 229
 230     rc->_message_context = new Inkscape::MessageContext((ec->desktop)->messageStack());
 231 }
 232
 233 static void sp_rect_context_set(SPEventContext *ec, gchar const *key, gchar const *val)
 234 {
 235     SPRectContext *rc = SP_RECT_CONTEXT(ec);
 236
 237     /* fixme: Proper error handling for non-numeric data.  Use a locale-independent function like
 238      * g_ascii_strtod (or a thin wrapper that does the right thing for invalid values inf/nan). */
 239     if ( strcmp(key, "rx") == 0 ) {
 240         rc->rx = ( val
 241                          ? g_ascii_strtod (val, NULL)
 242                          : 0.0 );
 243     } else if ( strcmp(key, "ry") == 0 ) {
 244         rc->ry = ( val
 245                          ? g_ascii_strtod (val, NULL)
 246                          : 0.0 );
 247     }
 248 }
 249
 250 static gint sp_rect_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
 251 {
 252     SPDesktop *desktop = event_context->desktop;
 253
 254     gint ret = FALSE;
 255
 256     switch (event->type) {
 257     case GDK_BUTTON_PRESS:
 258         if ( event->button.button == 1 && !event_context->space_panning) {
 259             Inkscape::setup_for_drag_start(desktop, event_context, event);
 260             ret = TRUE;
 261         }
 262         break;
 263         // motion and release are always on root (why?)
 264     default:
 265         break;
 266     }
 267
 268     if (((SPEventContextClass *) parent_class)->item_handler) {
 269         ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
 270     }
 271
 272     return ret;
 273 }
 274
 275 static gint sp_rect_context_root_handler(SPEventContext *event_context, GdkEvent *event)
 276 {
 277     static bool dragging;
 278
 279     SPDesktop *desktop = event_context->desktop;
 280     Inkscape::Selection *selection = sp_desktop_selection (desktop);
 281
 282     SPRectContext *rc = SP_RECT_CONTEXT(event_context);
 283
 284     event_context->tolerance = prefs_get_int_attribute_limited("options.dragtolerance", "value", 0, 0, 100);
 285
 286     gint ret = FALSE;
 287     switch (event->type) {
 288     case GDK_BUTTON_PRESS:
 289         if (event->button.button == 1 && !event_context->space_panning) {
 290             NR::Point const button_w(event->button.x,
 291                                      event->button.y);
 292
 293             // save drag origin
 294             event_context->xp = (gint) button_w[NR::X];
 295             event_context->yp = (gint) button_w[NR::Y];
 296             event_context->within_tolerance = true;
 297
 298             // remember clicked item, disregarding groups, honoring Alt
 299             event_context->item_to_select = sp_event_context_find_item (desktop, button_w, event->button.state & GDK_MOD1_MASK, TRUE);
 300
 301             dragging = true;
 302
 303             /* Position center */
 304             NR::Point const button_dt(desktop->w2d(button_w));
 305             rc->center = button_dt;
 306
 307             /* Snap center */
 308             SnapManager &m = desktop->namedview->snap_manager;
 309             m.setup(desktop, NULL); //null, because we don't have an item yet
 310             m.freeSnapReturnByRef(Inkscape::Snapper::SNAPPOINT_NODE, rc->center);
 311
 312             sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
 313                                 ( GDK_KEY_PRESS_MASK |
 314                                   GDK_BUTTON_RELEASE_MASK       |
 315                                   GDK_POINTER_MOTION_MASK       |
 316                                   GDK_POINTER_MOTION_HINT_MASK       |
 317                                   GDK_BUTTON_PRESS_MASK ),
 318                                 NULL, event->button.time);
 319
 320             ret = TRUE;
 321         }
 322         break;
 323     case GDK_MOTION_NOTIFY:
 324         if ( dragging
 325              && (event->motion.state & GDK_BUTTON1_MASK) && !event_context->space_panning)
 326         {
 327             if ( event_context->within_tolerance
 328                  && ( abs( (gint) event->motion.x - event_context->xp ) < event_context->tolerance )
 329                  && ( abs( (gint) event->motion.y - event_context->yp ) < event_context->tolerance ) ) {
 330                 break; // do not drag if we're within tolerance from origin
 331             }
 332             // Once the user has moved farther than tolerance from the original location
 333             // (indicating they intend to draw, not click), then always process the
 334             // motion notify coordinates as given (no snapping back to origin)
 335             event_context->within_tolerance = false;
 336
 337             NR::Point const motion_w(event->motion.x, event->motion.y);
 338             NR::Point motion_dt(desktop->w2d(motion_w));
 339
 340             sp_rect_drag(*rc, motion_dt, event->motion.state); // this will also handle the snapping
 341             gobble_motion_events(GDK_BUTTON1_MASK);
 342             ret = TRUE;
 343         }
 344         break;
 345     case GDK_BUTTON_RELEASE:
 346         event_context->xp = event_context->yp = 0;
 347         if (event->button.button == 1 && !event_context->space_panning) {
 348             dragging = false;
 349
 350             if (!event_context->within_tolerance) {
 351                 // we've been dragging, finish the rect
 352                 sp_rect_finish(rc);
 353             } else if (event_context->item_to_select) {
 354                 // no dragging, select clicked item if any
 355                 if (event->button.state & GDK_SHIFT_MASK) {
 356                     selection->toggle(event_context->item_to_select);
 357                 } else {
 358                     selection->set(event_context->item_to_select);
 359                 }
 360             } else {
 361                 // click in an empty space
 362                 selection->clear();
 363             }
 364
 365             event_context->item_to_select = NULL;
 366             ret = TRUE;
 367             sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 368                                   event->button.time);
 369         }
 370         break;
 371     case GDK_KEY_PRESS:
 372         switch (get_group0_keyval (&event->key)) {
 373         case GDK_Alt_L:
 374         case GDK_Alt_R:
 375         case GDK_Control_L:
 376         case GDK_Control_R:
 377         case GDK_Shift_L:
 378         case GDK_Shift_R:
 379         case GDK_Meta_L:  // Meta is when you press Shift+Alt (at least on my machine)
 380         case GDK_Meta_R:
 381             if (!dragging){
 382                 sp_event_show_modifier_tip (event_context->defaultMessageContext(), event,
 383                                             _("<b>Ctrl</b>: make square or integer-ratio rect, lock a rounded corner circular"),
 384                                             _("<b>Shift</b>: draw around the starting point"),
 385                                             NULL);
 386             }
 387             break;
 388         case GDK_Up:
 389         case GDK_Down:
 390         case GDK_KP_Up:
 391         case GDK_KP_Down:
 392             // prevent the zoom field from activation
 393             if (!MOD__CTRL_ONLY)
 394                 ret = TRUE;
 395             break;
 396
 397         case GDK_x:
 398         case GDK_X:
 399             if (MOD__ALT_ONLY) {
 400                 desktop->setToolboxFocusTo ("altx-rect");
 401                 ret = TRUE;
 402             }
 403             break;
 404
 405         case GDK_T:
 406             {
 407                 Inkscape::Selection *selection = sp_desktop_selection (inkscape_active_desktop());
 408                 SPItem *item = selection->singleItem();
 409                 if (item && SP_IS_RECT (item)) {
 410                     g_print ("Scaling transformation matrix\n");
 411                     SP_RECT (item)->transform = NR::Matrix(NR::scale(1.25, 1.5));
 412                     SP_OBJECT (item)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 413                 }
 414                 ret = TRUE;
 415             }
 416             break;
 417
 418         case GDK_g:
 419         case GDK_G:
 420             if (MOD__SHIFT_ONLY) {
 421                 sp_selection_to_guides();
 422                 ret = true;
 423             }
 424             break;
 425
 426         case GDK_Escape:
 427             sp_desktop_selection(desktop)->clear();
 428             //TODO: make dragging escapable by Esc
 429             break;
 430
 431         case GDK_space:
 432             if (dragging) {
 433                 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 434                                       event->button.time);
 435                 dragging = false;
 436                 if (!event_context->within_tolerance) {
 437                     // we've been dragging, finish the rect
 438                     sp_rect_finish(rc);
 439                 }
 440                 // do not return true, so that space would work switching to selector
 441             }
 442             break;
 443
 444         default:
 445             break;
 446         }
 447         break;
 448     case GDK_KEY_RELEASE:
 449         switch (get_group0_keyval (&event->key)) {
 450         case GDK_Alt_L:
 451         case GDK_Alt_R:
 452         case GDK_Control_L:
 453         case GDK_Control_R:
 454         case GDK_Shift_L:
 455         case GDK_Shift_R:
 456         case GDK_Meta_L:  // Meta is when you press Shift+Alt
 457         case GDK_Meta_R:
 458             event_context->defaultMessageContext()->clear();
 459             break;
 460         default:
 461             break;
 462         }
 463         break;
 464     default:
 465         break;
 466     }
 467
 468     if (!ret) {
 469         if (((SPEventContextClass *) parent_class)->root_handler) {
 470             ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
 471         }
 472     }
 473
 474     return ret;
 475 }
 476
 477 static void sp_rect_drag(SPRectContext &rc, NR::Point const pt, guint state)
 478 {
 479     SPDesktop *desktop = SP_EVENT_CONTEXT(&rc)->desktop;
 480
 481     if (!rc.item) {
 482
 483         if (Inkscape::have_viable_layer(desktop, rc._message_context) == false) {
 484             return;
 485         }
 486
 487         /* Create object */
 488         Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_EVENT_CONTEXT_DOCUMENT(&rc));
 489         Inkscape::XML::Node *repr = xml_doc->createElement("svg:rect");
 490
 491         /* Set style */
 492         sp_desktop_apply_style_tool (desktop, repr, "tools.shapes.rect", false);
 493
 494         rc.item = (SPItem *) desktop->currentLayer()->appendChildRepr(repr);
 495         Inkscape::GC::release(repr);
 496         rc.item->transform = SP_ITEM(desktop->currentRoot())->getRelativeTransform(desktop->currentLayer());
 497         rc.item->updateRepr();
 498
 499         sp_canvas_force_full_redraw_after_interruptions(desktop->canvas, 5);
 500     }
 501
 502     NR::Rect const r = Inkscape::snap_rectangular_box(desktop, rc.item, pt, rc.center, state);
 503
 504     sp_rect_position_set(SP_RECT(rc.item), r.min()[NR::X], r.min()[NR::Y], r.dimensions()[NR::X], r.dimensions()[NR::Y]);
 505     if ( rc.rx != 0.0 ) {
 506         sp_rect_set_rx (SP_RECT(rc.item), TRUE, rc.rx);
 507     }
 508     if ( rc.ry != 0.0 ) {
 509         if (rc.rx == 0.0)
 510             sp_rect_set_ry (SP_RECT(rc.item), TRUE, CLAMP(rc.ry, 0, MIN(r.dimensions()[NR::X], r.dimensions()[NR::Y])/2));
 511         else
 512             sp_rect_set_ry (SP_RECT(rc.item), TRUE, CLAMP(rc.ry, 0, r.dimensions()[NR::Y]));
 513     }
 514
 515     // status text
 516     double rdimx = r.dimensions()[NR::X];
 517     double rdimy = r.dimensions()[NR::Y];
 518     GString *xs = SP_PX_TO_METRIC_STRING(rdimx, desktop->namedview->getDefaultMetric());
 519     GString *ys = SP_PX_TO_METRIC_STRING(rdimy, desktop->namedview->getDefaultMetric());
 520     if (state & GDK_CONTROL_MASK) {
 521         int ratio_x, ratio_y;
 522         bool is_golden_ratio = false;
 523         if (fabs (rdimx) > fabs (rdimy)) {
 524             if (fabs(rdimx / rdimy - goldenratio) < 1e-6) {
 525                 is_golden_ratio = true;
 526             }
 527             ratio_x = (int) rint (rdimx / rdimy);
 528             ratio_y = 1;
 529         } else {
 530             if (fabs(rdimy / rdimx - goldenratio) < 1e-6) {
 531                 is_golden_ratio = true;
 532             }
 533             ratio_x = 1;
 534             ratio_y = (int) rint (rdimy / rdimx);
 535         }
 536         if (!is_golden_ratio) {
 537             rc._message_context->setF(Inkscape::IMMEDIATE_MESSAGE, _("<b>Rectangle</b>: %s &#215; %s (constrained to ratio %d:%d); with <b>Shift</b> to draw around the starting point"), xs->str, ys->str, ratio_x, ratio_y);
 538         } else {
 539             if (ratio_y == 1) {
 540                 rc._message_context->setF(Inkscape::IMMEDIATE_MESSAGE, _("<b>Rectangle</b>: %s &#215; %s (constrained to golden ratio 1.618 : 1); with <b>Shift</b> to draw around the starting point"), xs->str, ys->str);
 541             } else {
 542                 rc._message_context->setF(Inkscape::IMMEDIATE_MESSAGE, _("<b>Rectangle</b>: %s &#215; %s (constrained to golden ratio 1 : 1.618); with <b>Shift</b> to draw around the starting point"), xs->str, ys->str);
 543             }
 544         }
 545     } else {
 546         rc._message_context->setF(Inkscape::IMMEDIATE_MESSAGE, _("<b>Rectangle</b>: %s &#215; %s; with <b>Ctrl</b> to make square or integer-ratio rectangle; with <b>Shift</b> to draw around the starting point"), xs->str, ys->str);
 547     }
 548     g_string_free(xs, FALSE);
 549     g_string_free(ys, FALSE);
 550 }
 551
 552 static void sp_rect_finish(SPRectContext *rc)
 553 {
 554     rc->_message_context->clear();
 555
 556     if ( rc->item != NULL ) {
 557         SPDesktop * desktop;
 558
 559         desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
 560
 561         SP_OBJECT(rc->item)->updateRepr();
 562
 563         sp_canvas_end_forced_full_redraws(desktop->canvas);
 564
 565         sp_desktop_selection(desktop)->set(rc->item);
 566         sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_RECT,
 567                          _("Create rectangle"));
 568
 569         rc->item = NULL;
 570     }
 571 }
 572
 573 /*
 574   Local Variables:
 575   mode:c++
 576   c-file-style:"stroustrup"
 577   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 578   indent-tabs-mode:nil
 579   fill-column:99
 580   End:
 581 */
 582 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :