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 }
134 new (&box3d_context->sel_changed_connection) sigc::connection();
135 }
137 static void sp_3dbox_context_dispose(GObject *object)
138 {
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);
168 }
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)
183 {
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);
207 // FIXME: The following really belongs in sp_3dbox_build. But when undoing & redoing the
208 // creation of a 3D box, we have no means of accessing the recreated paths, which
209 // seem to be built after the box itself. Thus we need to check for untracked paths
210 // here and hook them to the box if the latter was created by a redo operation.
211 if (SP_IS_3DBOX(item)) {
212 sp_3dbox_link_to_existing_paths (SP_3DBOX(item), shape_repr);
213 }
214 }
215 }
216 }
218 static void sp_3dbox_context_setup(SPEventContext *ec)
219 {
220 SP3DBoxContext *rc = SP_3DBOX_CONTEXT(ec);
222 if (((SPEventContextClass *) parent_class)->setup) {
223 ((SPEventContextClass *) parent_class)->setup(ec);
224 }
226 SPItem *item = sp_desktop_selection(ec->desktop)->singleItem();
227 if (item) {
228 ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
229 Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
230 if (shape_repr) {
231 ec->shape_repr = shape_repr;
232 Inkscape::GC::anchor(shape_repr);
233 sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
234 }
235 }
237 rc->sel_changed_connection.disconnect();
238 rc->sel_changed_connection = sp_desktop_selection(ec->desktop)->connectChanged(
239 sigc::bind(sigc::ptr_fun(&sp_3dbox_context_selection_changed), (gpointer)rc)
240 );
242 sp_event_context_read(ec, "rx");
243 sp_event_context_read(ec, "ry");
245 if (prefs_get_int_attribute("tools.shapes", "selcue", 0) != 0) {
246 ec->enableSelectionCue();
247 }
249 if (prefs_get_int_attribute("tools.shapes", "gradientdrag", 0) != 0) {
250 ec->enableGrDrag();
251 }
253 rc->_message_context = new Inkscape::MessageContext((ec->desktop)->messageStack());
254 }
256 static void sp_3dbox_context_set(SPEventContext *ec, gchar const *key, gchar const *val)
257 {
258 SP3DBoxContext *rc = SP_3DBOX_CONTEXT(ec);
260 /* fixme: Proper error handling for non-numeric data. Use a locale-independent function like
261 * g_ascii_strtod (or a thin wrapper that does the right thing for invalid values inf/nan). */
262 if ( strcmp(key, "rx") == 0 ) {
263 rc->rx = ( val
264 ? g_ascii_strtod (val, NULL)
265 : 0.0 );
266 } else if ( strcmp(key, "ry") == 0 ) {
267 rc->ry = ( val
268 ? g_ascii_strtod (val, NULL)
269 : 0.0 );
270 }
271 }
273 static gint sp_3dbox_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
274 {
275 SPDesktop *desktop = event_context->desktop;
277 gint ret = FALSE;
279 switch (event->type) {
280 case GDK_BUTTON_PRESS:
281 if ( event->button.button == 1 ) {
282 Inkscape::setup_for_drag_start(desktop, event_context, event);
283 ret = TRUE;
284 }
285 break;
286 // motion and release are always on root (why?)
287 default:
288 break;
289 }
291 if (((SPEventContextClass *) parent_class)->item_handler) {
292 ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
293 }
295 return ret;
296 }
298 static gint sp_3dbox_context_root_handler(SPEventContext *event_context, GdkEvent *event)
299 {
300 static bool dragging;
302 SPDesktop *desktop = event_context->desktop;
303 Inkscape::Selection *selection = sp_desktop_selection (desktop);
305 SP3DBoxContext *rc = SP_3DBOX_CONTEXT(event_context);
307 event_context->tolerance = prefs_get_int_attribute_limited("options.dragtolerance", "value", 0, 0, 100);
309 gint ret = FALSE;
310 switch (event->type) {
311 case GDK_BUTTON_PRESS:
312 if ( event->button.button == 1 ) {
313 NR::Point const button_w(event->button.x,
314 event->button.y);
316 // save drag origin
317 event_context->xp = (gint) button_w[NR::X];
318 event_context->yp = (gint) button_w[NR::Y];
319 event_context->within_tolerance = true;
321 // remember clicked item, disregarding groups, honoring Alt
322 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);
324 dragging = true;
326 /* Position center */
327 NR::Point const button_dt(desktop->w2d(button_w));
328 rc->drag_origin = button_dt;
329 rc->drag_ptB = button_dt;
330 rc->drag_ptC = button_dt;
332 /* Snap center */
333 SnapManager const &m = desktop->namedview->snap_manager;
334 rc->center = m.freeSnap(Inkscape::Snapper::SNAP_POINT | Inkscape::Snapper::BBOX_POINT,
335 button_dt, rc->item).getPoint();
337 sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
338 ( GDK_KEY_PRESS_MASK |
339 GDK_BUTTON_RELEASE_MASK |
340 GDK_POINTER_MOTION_MASK |
341 GDK_BUTTON_PRESS_MASK ),
342 NULL, event->button.time);
343 ret = TRUE;
344 }
345 break;
346 case GDK_MOTION_NOTIFY:
347 if ( dragging
348 && ( event->motion.state & GDK_BUTTON1_MASK ) )
349 {
350 if ( event_context->within_tolerance
351 && ( abs( (gint) event->motion.x - event_context->xp ) < event_context->tolerance )
352 && ( abs( (gint) event->motion.y - event_context->yp ) < event_context->tolerance ) ) {
353 break; // do not drag if we're within tolerance from origin
354 }
355 // Once the user has moved farther than tolerance from the original location
356 // (indicating they intend to draw, not click), then always process the
357 // motion notify coordinates as given (no snapping back to origin)
358 event_context->within_tolerance = false;
360 NR::Point const motion_w(event->motion.x,
361 event->motion.y);
362 NR::Point motion_dt(desktop->w2d(motion_w));
364 SnapManager const &m = desktop->namedview->snap_manager;
365 motion_dt = m.freeSnap(Inkscape::Snapper::BBOX_POINT | Inkscape::Snapper::SNAP_POINT, motion_dt, rc->item).getPoint();
367 rc->ctrl_dragged = event->motion.state & GDK_CONTROL_MASK;
369 if (event->motion.state & GDK_SHIFT_MASK && !rc->extruded) {
370 /* once shift is pressed, set rc->extruded (no need to create further faces;
371 all of them are already created in sp_3dbox_init) */
372 rc->extruded = true;
373 }
375 if (!rc->extruded) {
376 rc->drag_ptB = motion_dt;
377 rc->drag_ptC = motion_dt;
378 } else {
379 // Without Ctrl, motion of the extruded corner is constrained to the
380 // perspective line from drag_ptB to vanishing point Y.
381 if (!rc->ctrl_dragged) {
382 rc->drag_ptC = Box3D::perspective_line_snap (rc->drag_ptB, Box3D::Z, motion_dt);
383 } else {
384 rc->drag_ptC = motion_dt;
385 }
386 rc->drag_ptC = m.freeSnap(Inkscape::Snapper::BBOX_POINT | Inkscape::Snapper::SNAP_POINT, rc->drag_ptC, rc->item).getPoint();
387 if (rc->ctrl_dragged) {
388 Box3D::PerspectiveLine pl1 (NR::Point (event_context->xp, event_context->yp), Box3D::Y);
389 Box3D::PerspectiveLine pl2 (rc->drag_ptB, Box3D::X);
390 NR::Point corner1 = pl1.meet(pl2);
392 Box3D::PerspectiveLine pl3 (corner1, Box3D::X);
393 Box3D::PerspectiveLine pl4 (rc->drag_ptC, Box3D::Z);
394 rc->drag_ptB = pl3.meet(pl4);
395 }
396 }
399 sp_3dbox_drag(*rc, event->motion.state);
401 ret = TRUE;
402 }
403 break;
404 case GDK_BUTTON_RELEASE:
405 event_context->xp = event_context->yp = 0;
406 if ( event->button.button == 1 ) {
407 dragging = false;
409 if (!event_context->within_tolerance) {
410 // we've been dragging, finish the box
411 sp_3dbox_finish(rc);
412 } else if (event_context->item_to_select) {
413 // no dragging, select clicked item if any
414 if (event->button.state & GDK_SHIFT_MASK) {
415 selection->toggle(event_context->item_to_select);
416 } else {
417 selection->set(event_context->item_to_select);
418 }
419 } else {
420 // click in an empty space
421 selection->clear();
422 }
424 event_context->item_to_select = NULL;
425 ret = TRUE;
426 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
427 event->button.time);
428 }
429 break;
430 case GDK_KEY_PRESS:
431 switch (get_group0_keyval (&event->key)) {
432 case GDK_Alt_L:
433 case GDK_Alt_R:
434 case GDK_Control_L:
435 case GDK_Control_R:
436 case GDK_Shift_L:
437 case GDK_Shift_R:
438 case GDK_Meta_L: // Meta is when you press Shift+Alt (at least on my machine)
439 case GDK_Meta_R:
440 /***
441 if (!dragging){
442 sp_event_show_modifier_tip (event_context->defaultMessageContext(), event,
443 _("<b>Ctrl</b>: make square or integer-ratio rect, lock a rounded corner circular"),
444 _("<b>Shift</b>: draw around the starting point"),
445 NULL);
446 }
447 ***/
448 break;
449 case GDK_Up:
450 case GDK_Down:
451 case GDK_KP_Up:
452 case GDK_KP_Down:
453 // prevent the zoom field from activation
454 if (!MOD__CTRL_ONLY)
455 ret = TRUE;
456 break;
458 case GDK_x:
459 case GDK_X:
460 if (MOD__ALT_ONLY) {
461 // desktop->setToolboxFocusTo ("altx-rect");
462 ret = TRUE;
463 }
464 break;
466 case GDK_Escape:
467 sp_desktop_selection(desktop)->clear();
468 //TODO: make dragging escapable by Esc
469 break;
471 case GDK_space:
472 if (dragging) {
473 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
474 event->button.time);
475 dragging = false;
476 if (!event_context->within_tolerance) {
477 // we've been dragging, finish the box
478 sp_3dbox_finish(rc);
479 }
480 // do not return true, so that space would work switching to selector
481 }
482 break;
484 default:
485 break;
486 }
487 break;
488 case GDK_KEY_RELEASE:
489 switch (get_group0_keyval (&event->key)) {
490 case GDK_Alt_L:
491 case GDK_Alt_R:
492 case GDK_Control_L:
493 case GDK_Control_R:
494 case GDK_Shift_L:
495 case GDK_Shift_R:
496 case GDK_Meta_L: // Meta is when you press Shift+Alt
497 case GDK_Meta_R:
498 event_context->defaultMessageContext()->clear();
499 break;
500 default:
501 break;
502 }
503 break;
504 default:
505 break;
506 }
508 if (!ret) {
509 if (((SPEventContextClass *) parent_class)->root_handler) {
510 ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
511 }
512 }
514 return ret;
515 }
517 static void sp_3dbox_drag(SP3DBoxContext &bc, guint state)
518 {
519 SPDesktop *desktop = SP_EVENT_CONTEXT(&bc)->desktop;
521 if (!bc.item) {
523 if (Inkscape::have_viable_layer(desktop, bc._message_context) == false) {
524 return;
525 }
527 /* Create object */
528 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_EVENT_CONTEXT_DOCUMENT(&bc));
529 Inkscape::XML::Node *repr = xml_doc->createElement("svg:g");
530 repr->setAttribute("sodipodi:type", "inkscape:3dbox");
532 /* Set style */
533 sp_desktop_apply_style_tool (desktop, repr, "tools.shapes.3dbox", false);
535 bc.item = (SPItem *) desktop->currentLayer()->appendChildRepr(repr);
536 Inkscape::GC::release(repr);
537 bc.item->transform = SP_ITEM(desktop->currentRoot())->getRelativeTransform(desktop->currentLayer());
539 /* Hook paths to the faces of the box */
540 for (int i = 0; i < 6; ++i) {
541 SP_3DBOX(bc.item)->faces[i]->hook_path_to_3dbox();
542 }
544 bc.item->updateRepr();
546 sp_canvas_force_full_redraw_after_interruptions(desktop->canvas, 5);
547 }
549 // FIXME: remove these extra points
550 NR::Point pt = bc.drag_ptB;
551 NR::Point shift_pt = bc.drag_ptC;
553 NR::Rect r;
554 if (!(state & GDK_SHIFT_MASK)) {
555 r = Inkscape::snap_rectangular_box(desktop, bc.item, pt, bc.center, state);
556 } else {
557 r = Inkscape::snap_rectangular_box(desktop, bc.item, shift_pt, bc.center, state);
558 }
560 SPEventContext *ec = SP_EVENT_CONTEXT(&bc);
561 NR::Point origin_w(ec->xp, ec->yp);
562 NR::Point origin(desktop->w2d(origin_w));
563 sp_3dbox_position_set(bc);
565 // status text
566 //GString *Ax = SP_PX_TO_METRIC_STRING(origin[NR::X], desktop->namedview->getDefaultMetric());
567 //GString *Ay = SP_PX_TO_METRIC_STRING(origin[NR::Y], desktop->namedview->getDefaultMetric());
568 bc._message_context->setF(Inkscape::NORMAL_MESSAGE, _("<b>3D Box</b>; with <b>Shift</b> to extrude along the Z axis"));
569 //g_string_free(Ax, FALSE);
570 //g_string_free(Ay, FALSE);
571 }
573 static void sp_3dbox_finish(SP3DBoxContext *rc)
574 {
575 rc->_message_context->clear();
577 if ( rc->item != NULL ) {
578 SPDesktop * desktop;
580 desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
582 SP_OBJECT(rc->item)->updateRepr();
584 sp_canvas_end_forced_full_redraws(desktop->canvas);
586 sp_desktop_selection(desktop)->set(rc->item);
587 sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_3DBOX,
588 _("Create 3D box"));
590 rc->item = NULL;
591 }
593 rc->ctrl_dragged = false;
594 rc->extruded = false;
595 }
597 /*
598 Local Variables:
599 mode:c++
600 c-file-style:"stroustrup"
601 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
602 indent-tabs-mode:nil
603 fill-column:99
604 End:
605 */
606 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :