Code

due to the order of processing events, we must disable lmb handling in children conte...
[inkscape.git] / src / box3d-context.cpp
1 #define __SP_3DBOX_CONTEXT_C__
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  */
18 #include "config.h"
20 #include <gdk/gdkkeysyms.h>
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"
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);
47 static void sp_3dbox_context_setup(SPEventContext *ec);
48 static void sp_3dbox_context_set(SPEventContext *ec, gchar const *key, gchar const *val);
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);
53 static void sp_3dbox_drag(SP3DBoxContext &rc, guint state);
54 static void sp_3dbox_finish(SP3DBoxContext *rc);
56 static SPEventContextClass *parent_class;
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 }
78 static void sp_3dbox_context_class_init(SP3DBoxContextClass *klass)
79 {
80     GObjectClass *object_class = (GObjectClass *) klass;
81     SPEventContextClass *event_context_class = (SPEventContextClass *) klass;
83     parent_class = (SPEventContextClass *) g_type_class_peek_parent(klass);
85     object_class->dispose = sp_3dbox_context_dispose;
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 }
93 Box3D::Perspective3D * SP3DBoxContext::current_perspective = NULL;
94 guint SP3DBoxContext::number_of_handles = 3;
96 static void sp_3dbox_context_init(SP3DBoxContext *box3d_context)
97 {
98     SPEventContext *event_context = SP_EVENT_CONTEXT(box3d_context);
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;
109     event_context->shape_repr = NULL;
110     event_context->shape_knot_holder = NULL;
112     box3d_context->item = NULL;
114     box3d_context->rx = 0.0;
115     box3d_context->ry = 0.0;
117     box3d_context->ctrl_dragged = false;
118     box3d_context->extruded = false;
120     /* create an initial perspective */
121     if (!SP3DBoxContext::current_perspective) {
122         SP3DBoxContext::current_perspective = new Box3D::Perspective3D (
123                                               // VP in x-direction
124                                               Box3D::VanishingPoint( NR::Point( 50.0, 600.0),
125                                                                      NR::Point( -1.0,   0.0), Box3D::VP_INFINITE),
126                                               // VP in y-direction
127                                               Box3D::VanishingPoint( NR::Point(500.0,1000.0),
128                                                                      NR::Point(  0.0,   1.0), Box3D::VP_INFINITE),
129                                               // VP in z-direction
130                                               Box3D::VanishingPoint( NR::Point(700.0, 500.0),
131                                                                      NR::Point(sqrt(3.0),1.0), Box3D::VP_INFINITE));
132     }
133     
134     new (&box3d_context->sel_changed_connection) sigc::connection();
137 static void sp_3dbox_context_dispose(GObject *object)
139     SP3DBoxContext *rc = SP_3DBOX_CONTEXT(object);
140     SPEventContext *ec = SP_EVENT_CONTEXT(object);
142     ec->enableGrDrag(false);
144     rc->sel_changed_connection.disconnect();
145     rc->sel_changed_connection.~connection();
147     /* fixme: This is necessary because we do not grab */
148     if (rc->item) {
149         sp_3dbox_finish(rc);
150     }
152     if (ec->shape_knot_holder) {
153         sp_knot_holder_destroy(ec->shape_knot_holder);
154         ec->shape_knot_holder = NULL;
155     }
157     if (ec->shape_repr) { // remove old listener
158         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
159         Inkscape::GC::release(ec->shape_repr);
160         ec->shape_repr = 0;
161     }
163     if (rc->_message_context) {
164         delete rc->_message_context;
165     }
167     G_OBJECT_CLASS(parent_class)->dispose(object);
170 static Inkscape::XML::NodeEventVector ec_shape_repr_events = {
171     NULL, /* child_added */
172     NULL, /* child_removed */
173     ec_shape_event_attr_changed,
174     NULL, /* content_changed */
175     NULL  /* order_changed */
176 };
178 /**
179 \brief  Callback that processes the "changed" signal on the selection;
180 destroys old and creates new knotholder
181 */
182 void sp_3dbox_context_selection_changed(Inkscape::Selection *selection, gpointer data)
184     SP3DBoxContext *rc = SP_3DBOX_CONTEXT(data);
185     SPEventContext *ec = SP_EVENT_CONTEXT(rc);
187     if (ec->shape_knot_holder) { // destroy knotholder
188         sp_knot_holder_destroy(ec->shape_knot_holder);
189         ec->shape_knot_holder = NULL;
190     }
192     if (ec->shape_repr) { // remove old listener
193         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
194         Inkscape::GC::release(ec->shape_repr);
195         ec->shape_repr = 0;
196     }
198     SPItem *item = selection->singleItem();
199     if (item) {
200         ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
201         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
202         if (shape_repr) {
203             ec->shape_repr = shape_repr;
204             Inkscape::GC::anchor(shape_repr);
205             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
206         }
207     }
210 static void sp_3dbox_context_setup(SPEventContext *ec)
212     SP3DBoxContext *rc = SP_3DBOX_CONTEXT(ec);
214     if (((SPEventContextClass *) parent_class)->setup) {
215         ((SPEventContextClass *) parent_class)->setup(ec);
216     }
218     SPItem *item = sp_desktop_selection(ec->desktop)->singleItem();
219     if (item) {
220         ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
221         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
222         if (shape_repr) {
223             ec->shape_repr = shape_repr;
224             Inkscape::GC::anchor(shape_repr);
225             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
226         }
227     }
229     rc->sel_changed_connection.disconnect();
230     rc->sel_changed_connection = sp_desktop_selection(ec->desktop)->connectChanged(
231         sigc::bind(sigc::ptr_fun(&sp_3dbox_context_selection_changed), (gpointer)rc)
232     );
234     sp_event_context_read(ec, "rx");
235     sp_event_context_read(ec, "ry");
237     if (prefs_get_int_attribute("tools.shapes", "selcue", 0) != 0) {
238         ec->enableSelectionCue();
239     }
241     if (prefs_get_int_attribute("tools.shapes", "gradientdrag", 0) != 0) {
242         ec->enableGrDrag();
243     }
245     rc->_message_context = new Inkscape::MessageContext((ec->desktop)->messageStack());
248 static void sp_3dbox_context_set(SPEventContext *ec, gchar const *key, gchar const *val)
250     SP3DBoxContext *rc = SP_3DBOX_CONTEXT(ec);
252     /* fixme: Proper error handling for non-numeric data.  Use a locale-independent function like
253      * g_ascii_strtod (or a thin wrapper that does the right thing for invalid values inf/nan). */
254     if ( strcmp(key, "rx") == 0 ) {
255         rc->rx = ( val
256                          ? g_ascii_strtod (val, NULL)
257                          : 0.0 );
258     } else if ( strcmp(key, "ry") == 0 ) {
259         rc->ry = ( val
260                          ? g_ascii_strtod (val, NULL)
261                          : 0.0 );
262     }
265 static gint sp_3dbox_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
267     SPDesktop *desktop = event_context->desktop;
269     gint ret = FALSE;
271     switch (event->type) {
272     case GDK_BUTTON_PRESS:
273         if ( event->button.button == 1 && !event_context->space_panning) {
274             Inkscape::setup_for_drag_start(desktop, event_context, event);
275             ret = TRUE;
276         }
277         break;
278         // motion and release are always on root (why?)
279     default:
280         break;
281     }
283     if (((SPEventContextClass *) parent_class)->item_handler) {
284         ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
285     }
287     return ret;
290 static gint sp_3dbox_context_root_handler(SPEventContext *event_context, GdkEvent *event)
292     static bool dragging;
294     SPDesktop *desktop = event_context->desktop;
295     Inkscape::Selection *selection = sp_desktop_selection (desktop);
297     SP3DBoxContext *rc = SP_3DBOX_CONTEXT(event_context);
299     event_context->tolerance = prefs_get_int_attribute_limited("options.dragtolerance", "value", 0, 0, 100);
301     gint ret = FALSE;
302     switch (event->type) {
303     case GDK_BUTTON_PRESS:
304         if ( event->button.button == 1  && !event_context->space_panning) {
305             NR::Point const button_w(event->button.x,
306                                      event->button.y);
308             // save drag origin
309             event_context->xp = (gint) button_w[NR::X];
310             event_context->yp = (gint) button_w[NR::Y];
311             event_context->within_tolerance = true;
312             
313             // remember clicked item, disregarding groups, honoring Alt
314             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);
316             dragging = true;
317             
318             /* Position center */
319             NR::Point const button_dt(desktop->w2d(button_w));
320             rc->drag_origin = button_dt;
321             rc->drag_ptB = button_dt;
322             rc->drag_ptC = button_dt;
324             /* Snap center */
325             SnapManager const &m = desktop->namedview->snap_manager;
326             rc->center = m.freeSnap(Inkscape::Snapper::SNAPPOINT_NODE | Inkscape::Snapper::SNAPPOINT_BBOX,
327                                     button_dt, rc->item).getPoint();
329             sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
330                                 ( GDK_KEY_PRESS_MASK |
331                                   GDK_BUTTON_RELEASE_MASK       |
332                                   GDK_POINTER_MOTION_MASK       |
333                                   GDK_BUTTON_PRESS_MASK ),
334                                 NULL, event->button.time);
335             ret = TRUE;
336         }
337         break;
338     case GDK_MOTION_NOTIFY:
339         if ( dragging
340              && ( event->motion.state & GDK_BUTTON1_MASK )  && !event_context->space_panning)
341         {
342             if ( event_context->within_tolerance
343                  && ( abs( (gint) event->motion.x - event_context->xp ) < event_context->tolerance )
344                  && ( abs( (gint) event->motion.y - event_context->yp ) < event_context->tolerance ) ) {
345                 break; // do not drag if we're within tolerance from origin
346             }
347             // Once the user has moved farther than tolerance from the original location
348             // (indicating they intend to draw, not click), then always process the
349             // motion notify coordinates as given (no snapping back to origin)
350             event_context->within_tolerance = false;
352             NR::Point const motion_w(event->motion.x,
353                                      event->motion.y);
354             NR::Point motion_dt(desktop->w2d(motion_w));
356             SnapManager const &m = desktop->namedview->snap_manager;
357             motion_dt = m.freeSnap(Inkscape::Snapper::SNAPPOINT_BBOX | Inkscape::Snapper::SNAPPOINT_NODE, motion_dt, rc->item).getPoint();
359             rc->ctrl_dragged  = event->motion.state & GDK_CONTROL_MASK;
361             if (event->motion.state & GDK_SHIFT_MASK && !rc->extruded) {
362                 /* once shift is pressed, set rc->extruded (no need to create further faces;
363                    all of them are already created in sp_3dbox_init) */
364                 rc->extruded = true;
365             }
367             if (!rc->extruded) {
368                 rc->drag_ptB = motion_dt;
369                 rc->drag_ptC = motion_dt;
370             } else {
371                 // Without Ctrl, motion of the extruded corner is constrained to the
372                 // perspective line from drag_ptB to vanishing point Y.
373                 if (!rc->ctrl_dragged) {
374                         rc->drag_ptC = Box3D::perspective_line_snap (rc->drag_ptB, Box3D::Z, motion_dt);
375                 } else {
376                     rc->drag_ptC = motion_dt;
377                 }
378                 rc->drag_ptC = m.freeSnap(Inkscape::Snapper::SNAPPOINT_BBOX | Inkscape::Snapper::SNAPPOINT_NODE, rc->drag_ptC, rc->item).getPoint();
379                 if (rc->ctrl_dragged) {
380                         Box3D::PerspectiveLine pl1 (NR::Point (event_context->xp, event_context->yp), Box3D::Y);
381                         Box3D::PerspectiveLine pl2 (rc->drag_ptB, Box3D::X);
382                         NR::Point corner1 = pl1.meet(pl2);
383                         
384                         Box3D::PerspectiveLine pl3 (corner1, Box3D::X);
385                         Box3D::PerspectiveLine pl4 (rc->drag_ptC, Box3D::Z);
386                         rc->drag_ptB = pl3.meet(pl4);
387                 }
388             }
389             
390             
391             sp_3dbox_drag(*rc, event->motion.state);
392             
393             ret = TRUE;
394         }
395         break;
396     case GDK_BUTTON_RELEASE:
397         event_context->xp = event_context->yp = 0;
398         if ( event->button.button == 1  && !event_context->space_panning) {
399             dragging = false;
401             if (!event_context->within_tolerance) {
402                 // we've been dragging, finish the box
403                 sp_3dbox_finish(rc);
404             } else if (event_context->item_to_select) {
405                 // no dragging, select clicked item if any
406                 if (event->button.state & GDK_SHIFT_MASK) {
407                     selection->toggle(event_context->item_to_select);
408                 } else {
409                     selection->set(event_context->item_to_select);
410                 }
411             } else {
412                 // click in an empty space
413                 selection->clear();
414             }
416             event_context->item_to_select = NULL;
417             ret = TRUE;
418             sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
419                                   event->button.time);
420         }
421         break;
422     case GDK_KEY_PRESS:
423         switch (get_group0_keyval (&event->key)) {
424         case GDK_Alt_L:
425         case GDK_Alt_R:
426         case GDK_Control_L:
427         case GDK_Control_R:
428         case GDK_Shift_L:
429         case GDK_Shift_R:
430         case GDK_Meta_L:  // Meta is when you press Shift+Alt (at least on my machine)
431         case GDK_Meta_R:
432             /***
433             if (!dragging){
434                 sp_event_show_modifier_tip (event_context->defaultMessageContext(), event,
435                                             _("<b>Ctrl</b>: make square or integer-ratio rect, lock a rounded corner circular"),
436                                             _("<b>Shift</b>: draw around the starting point"),
437                                             NULL);
438             }
439             ***/
440             break;
441         case GDK_Up:
442         case GDK_Down:
443         case GDK_KP_Up:
444         case GDK_KP_Down:
445             // prevent the zoom field from activation
446             if (!MOD__CTRL_ONLY)
447                 ret = TRUE;
448             break;
450         case GDK_x:
451         case GDK_X:
452             if (MOD__ALT_ONLY) {
453                 // desktop->setToolboxFocusTo ("altx-rect");
454                 ret = TRUE;
455             }
456             break;
458         case GDK_Escape:
459             sp_desktop_selection(desktop)->clear();
460             //TODO: make dragging escapable by Esc
461             break;
463         case GDK_space:
464             if (dragging) {
465                 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
466                                       event->button.time);
467                 dragging = false;
468                 if (!event_context->within_tolerance) {
469                     // we've been dragging, finish the box
470                     sp_3dbox_finish(rc);
471                 }
472                 // do not return true, so that space would work switching to selector
473             }
474             break;
476         default:
477             break;
478         }
479         break;
480     case GDK_KEY_RELEASE:
481         switch (get_group0_keyval (&event->key)) {
482         case GDK_Alt_L:
483         case GDK_Alt_R:
484         case GDK_Control_L:
485         case GDK_Control_R:
486         case GDK_Shift_L:
487         case GDK_Shift_R:
488         case GDK_Meta_L:  // Meta is when you press Shift+Alt
489         case GDK_Meta_R:
490             event_context->defaultMessageContext()->clear();
491             break;
492         default:
493             break;
494         }
495         break;
496     default:
497         break;
498     }
500     if (!ret) {
501         if (((SPEventContextClass *) parent_class)->root_handler) {
502             ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
503         }
504     }
506     return ret;
509 static void sp_3dbox_drag(SP3DBoxContext &bc, guint state)
511     SPDesktop *desktop = SP_EVENT_CONTEXT(&bc)->desktop;
513     if (!bc.item) {
515         if (Inkscape::have_viable_layer(desktop, bc._message_context) == false) {
516             return;
517         }
519         /* Create object */
520         Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_EVENT_CONTEXT_DOCUMENT(&bc));
521         Inkscape::XML::Node *repr = xml_doc->createElement("svg:g");
522         repr->setAttribute("sodipodi:type", "inkscape:3dbox");
524         /* Set style */
525         sp_desktop_apply_style_tool (desktop, repr, "tools.shapes.3dbox", false);
527         bc.item = (SPItem *) desktop->currentLayer()->appendChildRepr(repr);
528         Inkscape::GC::release(repr);
529         bc.item->transform = SP_ITEM(desktop->currentRoot())->getRelativeTransform(desktop->currentLayer());
531         /* Hook paths to the faces of the box */
532         for (int i = 0; i < 6; ++i) {
533             SP_3DBOX(bc.item)->faces[i]->hook_path_to_3dbox();
534         }
536         bc.item->updateRepr();
538         sp_canvas_force_full_redraw_after_interruptions(desktop->canvas, 5);
539     }
541     // FIXME: remove these extra points
542     NR::Point pt = bc.drag_ptB;
543     NR::Point shift_pt = bc.drag_ptC;
545     NR::Rect r;
546     if (!(state & GDK_SHIFT_MASK)) {
547         r = Inkscape::snap_rectangular_box(desktop, bc.item, pt, bc.center, state);
548     } else {
549         r = Inkscape::snap_rectangular_box(desktop, bc.item, shift_pt, bc.center, state);
550     }
552     SPEventContext *ec = SP_EVENT_CONTEXT(&bc);
553     NR::Point origin_w(ec->xp, ec->yp);
554     NR::Point origin(desktop->w2d(origin_w));
555     sp_3dbox_position_set(bc);
557     // status text
558     //GString *Ax = SP_PX_TO_METRIC_STRING(origin[NR::X], desktop->namedview->getDefaultMetric());
559     //GString *Ay = SP_PX_TO_METRIC_STRING(origin[NR::Y], desktop->namedview->getDefaultMetric());
560     bc._message_context->setF(Inkscape::NORMAL_MESSAGE, _("<b>3D Box</b>; with <b>Shift</b> to extrude along the Z axis"));
561     //g_string_free(Ax, FALSE);
562     //g_string_free(Ay, FALSE);
565 static void sp_3dbox_finish(SP3DBoxContext *rc)
567     rc->_message_context->clear();
569     if ( rc->item != NULL ) {
570         SPDesktop * desktop;
572         desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
574         SP_OBJECT(rc->item)->updateRepr();
576         sp_canvas_end_forced_full_redraws(desktop->canvas);
578         sp_desktop_selection(desktop)->set(rc->item);
579         sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_3DBOX,
580                          _("Create 3D box"));
582         rc->item = NULL;
583     }
585     rc->ctrl_dragged = false;
586     rc->extruded = false;
589 /*
590   Local Variables:
591   mode:c++
592   c-file-style:"stroustrup"
593   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
594   indent-tabs-mode:nil
595   fill-column:99
596   End:
597 */
598 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :