src/box3d-context.cpp

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