First (very limited) version of the 3D box tool; allows for drawing of new boxes in a fixed perspective without any live interaction.

(bzr r3084)

1 files changed, 608 insertions, 0 deletions

diff --git a/src/box3d-context.cpp b/src/box3d-context.cpp
new file mode 100644
index 000000000..ead6486e5
--- /dev/null
+++ b/src/box3d-context.cpp
@@ -0,0 +1,608 @@
+#define __SP_3DBOX_CONTEXT_C__
+
+/*
+ * 3D box drawing context
+ *
+ * Author:
+ *   Lauris Kaplinski <lauris@kaplinski.com>
+ *   bulia byak <buliabyak@users.sf.net>
+ *
+ * Copyright (C) 2007      Maximilian Albert <Anhalter42@gmx.de>
+ * Copyright (C) 2006      Johan Engelen <johan@shouraizou.nl>
+ * Copyright (C) 2000-2005 authors
+ * Copyright (C) 2000-2001 Ximian, Inc.
+ *
+ * Released under GNU GPL, read the file 'COPYING' for more information
+ */
+
+#include "config.h"
+
+#include <gdk/gdkkeysyms.h>
+
+#include "macros.h"
+#include "display/sp-canvas.h"
+#include "document.h"
+#include "sp-namedview.h"
+#include "selection.h"
+#include "desktop-handles.h"
+#include "snap.h"
+#include "display/curve.h"
+#include "desktop.h"
+#include "message-context.h"
+#include "pixmaps/cursor-rect.xpm"
+#include "box3d.h"
+#include "box3d-context.h"
+#include "sp-metrics.h"
+#include <glibmm/i18n.h>
+#include "object-edit.h"
+#include "xml/repr.h"
+#include "xml/node-event-vector.h"
+#include "prefs-utils.h"
+#include "context-fns.h"
+
+static void sp_3dbox_context_class_init(SP3DBoxContextClass *klass);
+static void sp_3dbox_context_init(SP3DBoxContext *box3d_context);
+static void sp_3dbox_context_dispose(GObject *object);
+
+static void sp_3dbox_context_setup(SPEventContext *ec);
+static void sp_3dbox_context_set(SPEventContext *ec, gchar const *key, gchar const *val);
+
+static gint sp_3dbox_context_root_handler(SPEventContext *event_context, GdkEvent *event);
+static gint sp_3dbox_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event);
+
+static void sp_3dbox_drag(SP3DBoxContext &rc, guint state);
+static void sp_3dbox_finish(SP3DBoxContext *rc);
+
+static SPEventContextClass *parent_class;
+
+
+GtkType sp_3dbox_context_get_type()
+{
+    static GType type = 0;
+    if (!type) {
+        GTypeInfo info = {
+            sizeof(SP3DBoxContextClass),
+            NULL, NULL,
+            (GClassInitFunc) sp_3dbox_context_class_init,
+            NULL, NULL,
+            sizeof(SP3DBoxContext),
+            4,
+            (GInstanceInitFunc) sp_3dbox_context_init,
+            NULL,    /* value_table */
+        };
+        type = g_type_register_static(SP_TYPE_EVENT_CONTEXT, "SP3DBoxContext", &info, (GTypeFlags) 0);
+    }
+    return type;
+}
+
+static void sp_3dbox_context_class_init(SP3DBoxContextClass *klass)
+{
+    GObjectClass *object_class = (GObjectClass *) klass;
+    SPEventContextClass *event_context_class = (SPEventContextClass *) klass;
+
+    parent_class = (SPEventContextClass *) g_type_class_peek_parent(klass);
+
+    object_class->dispose = sp_3dbox_context_dispose;
+
+    event_context_class->setup = sp_3dbox_context_setup;
+    event_context_class->set = sp_3dbox_context_set;
+    event_context_class->root_handler  = sp_3dbox_context_root_handler;
+    event_context_class->item_handler  = sp_3dbox_context_item_handler;
+}
+
+Box3D::Perspective3D * SP3DBoxContext::current_perspective = NULL;
+
+static void sp_3dbox_context_init(SP3DBoxContext *box3d_context)
+{
+    SPEventContext *event_context = SP_EVENT_CONTEXT(box3d_context);
+
+    event_context->cursor_shape = cursor_rect_xpm;
+    event_context->hot_x = 4;
+    event_context->hot_y = 4;
+    event_context->xp = 0;
+    event_context->yp = 0;
+    event_context->tolerance = 0;
+    event_context->within_tolerance = false;
+    event_context->item_to_select = NULL;
+
+    event_context->shape_repr = NULL;
+    event_context->shape_knot_holder = NULL;
+
+    box3d_context->item = NULL;
+
+    box3d_context->rx = 0.0;
+    box3d_context->ry = 0.0;
+
+    box3d_context->ctrl_dragged = false;
+    box3d_context->extruded = false;
+
+    /* create an initial perspective */
+    if (!SP3DBoxContext::current_perspective) {
+        SP3DBoxContext::current_perspective = new Box3D::Perspective3D (
+                                              // VP in x-direction
+                                              Box3D::VanishingPoint( NR::Point( 50.0, 600.0),
+                                                                     NR::Point( -1.0,   0.0), Box3D::VP_INFINITE),
+                                              // VP in y-direction
+                                              Box3D::VanishingPoint( NR::Point(700.0, 500.0),
+                                                                     NR::Point(sqrt(3.0),1.0), Box3D::VP_INFINITE),
+                                              // VP in z-direction
+                                              Box3D::VanishingPoint( NR::Point(500.0,1000.0),
+                                                                     NR::Point(  0.0,   1.0), Box3D::VP_INFINITE));
+    }
+    
+    new (&box3d_context->sel_changed_connection) sigc::connection();
+}
+
+static void sp_3dbox_context_dispose(GObject *object)
+{
+    SP3DBoxContext *rc = SP_3DBOX_CONTEXT(object);
+    SPEventContext *ec = SP_EVENT_CONTEXT(object);
+
+    ec->enableGrDrag(false);
+
+    rc->sel_changed_connection.disconnect();
+    rc->sel_changed_connection.~connection();
+
+    /* fixme: This is necessary because we do not grab */
+    if (rc->item) {
+        sp_3dbox_finish(rc);
+    }
+
+    if (ec->shape_knot_holder) {
+        sp_knot_holder_destroy(ec->shape_knot_holder);
+        ec->shape_knot_holder = NULL;
+    }
+
+    if (ec->shape_repr) { // remove old listener
+        sp_repr_remove_listener_by_data(ec->shape_repr, ec);
+        Inkscape::GC::release(ec->shape_repr);
+        ec->shape_repr = 0;
+    }
+
+    if (rc->_message_context) {
+        delete rc->_message_context;
+    }
+
+    G_OBJECT_CLASS(parent_class)->dispose(object);
+}
+
+static Inkscape::XML::NodeEventVector ec_shape_repr_events = {
+    NULL, /* child_added */
+    NULL, /* child_removed */
+    ec_shape_event_attr_changed,
+    NULL, /* content_changed */
+    NULL  /* order_changed */
+};
+
+/**
+\brief  Callback that processes the "changed" signal on the selection;
+destroys old and creates new knotholder
+*/
+void sp_3dbox_context_selection_changed(Inkscape::Selection *selection, gpointer data)
+{
+    SP3DBoxContext *rc = SP_3DBOX_CONTEXT(data);
+    SPEventContext *ec = SP_EVENT_CONTEXT(rc);
+
+    if (ec->shape_knot_holder) { // destroy knotholder
+        sp_knot_holder_destroy(ec->shape_knot_holder);
+        ec->shape_knot_holder = NULL;
+    }
+
+    if (ec->shape_repr) { // remove old listener
+        sp_repr_remove_listener_by_data(ec->shape_repr, ec);
+        Inkscape::GC::release(ec->shape_repr);
+        ec->shape_repr = 0;
+    }
+
+    SPItem *item = selection->singleItem();
+    if (item) {
+        ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
+        Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
+        if (shape_repr) {
+            ec->shape_repr = shape_repr;
+            Inkscape::GC::anchor(shape_repr);
+            sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
+        }
+    }
+}
+
+static void sp_3dbox_context_setup(SPEventContext *ec)
+{
+    SP3DBoxContext *rc = SP_3DBOX_CONTEXT(ec);
+
+    if (((SPEventContextClass *) parent_class)->setup) {
+        ((SPEventContextClass *) parent_class)->setup(ec);
+    }
+
+    SPItem *item = sp_desktop_selection(ec->desktop)->singleItem();
+    if (item) {
+        ec->shape_knot_holder = sp_item_knot_holder(item, ec->desktop);
+        Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
+        if (shape_repr) {
+            ec->shape_repr = shape_repr;
+            Inkscape::GC::anchor(shape_repr);
+            sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
+        }
+    }
+
+    rc->sel_changed_connection.disconnect();
+    rc->sel_changed_connection = sp_desktop_selection(ec->desktop)->connectChanged(
+        sigc::bind(sigc::ptr_fun(&sp_3dbox_context_selection_changed), (gpointer)rc)
+    );
+
+    sp_event_context_read(ec, "rx");
+    sp_event_context_read(ec, "ry");
+
+    if (prefs_get_int_attribute("tools.shapes", "selcue", 0) != 0) {
+        ec->enableSelectionCue();
+    }
+
+    if (prefs_get_int_attribute("tools.shapes", "gradientdrag", 0) != 0) {
+        ec->enableGrDrag();
+    }
+
+    rc->_message_context = new Inkscape::MessageContext((ec->desktop)->messageStack());
+}
+
+static void sp_3dbox_context_set(SPEventContext *ec, gchar const *key, gchar const *val)
+{
+    SP3DBoxContext *rc = SP_3DBOX_CONTEXT(ec);
+
+    /* fixme: Proper error handling for non-numeric data.  Use a locale-independent function like
+     * g_ascii_strtod (or a thin wrapper that does the right thing for invalid values inf/nan). */
+    if ( strcmp(key, "rx") == 0 ) {
+        rc->rx = ( val
+                         ? g_ascii_strtod (val, NULL)
+                         : 0.0 );
+    } else if ( strcmp(key, "ry") == 0 ) {
+        rc->ry = ( val
+                         ? g_ascii_strtod (val, NULL)
+                         : 0.0 );
+    }
+}
+
+static gint sp_3dbox_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
+{
+    SPDesktop *desktop = event_context->desktop;
+
+    gint ret = FALSE;
+
+    switch (event->type) {
+    case GDK_BUTTON_PRESS:
+        if ( event->button.button == 1 ) {
+            Inkscape::setup_for_drag_start(desktop, event_context, event);
+            ret = TRUE;
+        }
+        break;
+        // motion and release are always on root (why?)
+    default:
+        break;
+    }
+
+    if (((SPEventContextClass *) parent_class)->item_handler) {
+        ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
+    }
+
+    return ret;
+}
+
+static gint sp_3dbox_context_root_handler(SPEventContext *event_context, GdkEvent *event)
+{
+    static bool dragging;
+
+    SPDesktop *desktop = event_context->desktop;
+    Inkscape::Selection *selection = sp_desktop_selection (desktop);
+
+    SP3DBoxContext *rc = SP_3DBOX_CONTEXT(event_context);
+
+    event_context->tolerance = prefs_get_int_attribute_limited("options.dragtolerance", "value", 0, 0, 100);
+
+    gint ret = FALSE;
+    switch (event->type) {
+    case GDK_BUTTON_PRESS:
+        if ( event->button.button == 1 ) {
+            NR::Point const button_w(event->button.x,
+                                     event->button.y);
+
+            // save drag origin
+            event_context->xp = (gint) button_w[NR::X];
+            event_context->yp = (gint) button_w[NR::Y];
+            event_context->within_tolerance = true;
+            
+            // remember clicked item, disregarding groups, honoring Alt
+            event_context->item_to_select = sp_event_context_find_item (desktop, button_w, event->button.state & GDK_MOD1_MASK, TRUE);
+
+            dragging = true;
+            
+            /* Position center */
+            NR::Point const button_dt(desktop->w2d(button_w));
+            rc->drag_origin = button_dt;
+            rc->drag_ptB = button_dt;
+            rc->drag_ptC = button_dt;
+
+            /* Snap center */
+            SnapManager const &m = desktop->namedview->snap_manager;
+            rc->center = m.freeSnap(Inkscape::Snapper::SNAP_POINT | Inkscape::Snapper::BBOX_POINT,
+                                    button_dt, rc->item).getPoint();
+
+            sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
+                                ( GDK_KEY_PRESS_MASK |
+                                  GDK_BUTTON_RELEASE_MASK       |
+                                  GDK_POINTER_MOTION_MASK       |
+                                  GDK_BUTTON_PRESS_MASK ),
+                                NULL, event->button.time);
+            ret = TRUE;
+        }
+        break;
+    case GDK_MOTION_NOTIFY:
+        if ( dragging
+             && ( event->motion.state & GDK_BUTTON1_MASK ) )
+        {
+            if ( event_context->within_tolerance
+                 && ( abs( (gint) event->motion.x - event_context->xp ) < event_context->tolerance )
+                 && ( abs( (gint) event->motion.y - event_context->yp ) < event_context->tolerance ) ) {
+                break; // do not drag if we're within tolerance from origin
+            }
+            // Once the user has moved farther than tolerance from the original location
+            // (indicating they intend to draw, not click), then always process the
+            // motion notify coordinates as given (no snapping back to origin)
+            event_context->within_tolerance = false;
+
+            NR::Point const motion_w(event->motion.x,
+                                     event->motion.y);
+            NR::Point motion_dt(desktop->w2d(motion_w));
+
+            SnapManager const &m = desktop->namedview->snap_manager;
+            motion_dt = m.freeSnap(Inkscape::Snapper::BBOX_POINT | Inkscape::Snapper::SNAP_POINT, motion_dt, rc->item).getPoint();
+
+            rc->ctrl_dragged  = event->motion.state & GDK_CONTROL_MASK;
+
+            if (event->motion.state & GDK_SHIFT_MASK)
+                rc->extruded = true; // set rc->extruded once shift is pressed
+
+            if (!rc->extruded) {
+            	rc->drag_ptB = motion_dt;
+            } else {
+                // Without Ctrl, motion of the extruded corner is constrained to the
+                // perspective line from drag_ptB to vanishing point Y.
+                if (!rc->ctrl_dragged) {
+                	rc->drag_ptC = Box3D::perspective_line_snap (rc->drag_ptB, Box3D::Y, motion_dt);
+                } else {
+                    rc->drag_ptC = motion_dt;
+                }
+                rc->drag_ptC = m.freeSnap(Inkscape::Snapper::BBOX_POINT | Inkscape::Snapper::SNAP_POINT, rc->drag_ptC, rc->item).getPoint();
+                if (rc->ctrl_dragged) {
+                	Box3D::PerspectiveLine pl1 (NR::Point (event_context->xp, event_context->yp), Box3D::Z);
+                	Box3D::PerspectiveLine pl2 (rc->drag_ptB, Box3D::X);
+                	NR::Point corner1 = pl1.meet(pl2);
+                	
+                	Box3D::PerspectiveLine pl3 (corner1, Box3D::X);
+                	Box3D::PerspectiveLine pl4 (rc->drag_ptC, Box3D::Y);
+                	rc->drag_ptB = pl3.meet(pl4);
+                }
+            }
+            
+            
+            sp_3dbox_drag(*rc, event->motion.state);
+            
+            ret = TRUE;
+        }
+        ret = TRUE;
+        break;
+    case GDK_BUTTON_RELEASE:
+        event_context->xp = event_context->yp = 0;
+        if ( event->button.button == 1 ) {
+            dragging = false;
+
+            if (!event_context->within_tolerance) {
+                // we've been dragging, finish the rect
+                sp_3dbox_finish(rc);
+            } else if (event_context->item_to_select) {
+                // no dragging, select clicked item if any
+                if (event->button.state & GDK_SHIFT_MASK) {
+                    selection->toggle(event_context->item_to_select);
+                } else {
+                    selection->set(event_context->item_to_select);
+                }
+            } else {
+                // click in an empty space
+                selection->clear();
+            }
+
+            event_context->item_to_select = NULL;
+            ret = TRUE;
+            sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
+                                  event->button.time);
+        }
+        break;
+    case GDK_KEY_PRESS:
+        switch (get_group0_keyval (&event->key)) {
+        case GDK_Alt_L:
+        case GDK_Alt_R:
+        case GDK_Control_L:
+        case GDK_Control_R:
+        case GDK_Shift_L:
+        case GDK_Shift_R:
+        case GDK_Meta_L:  // Meta is when you press Shift+Alt (at least on my machine)
+        case GDK_Meta_R:
+            if (!dragging){
+                sp_event_show_modifier_tip (event_context->defaultMessageContext(), event,
+                                            _("<b>Ctrl</b>: make square or integer-ratio rect, lock a rounded corner circular"),
+                                            _("<b>Shift</b>: draw around the starting point"),
+                                            NULL);
+            }
+            break;
+        case GDK_Up:
+        case GDK_Down:
+        case GDK_KP_Up:
+        case GDK_KP_Down:
+            // prevent the zoom field from activation
+            if (!MOD__CTRL_ONLY)
+                ret = TRUE;
+            break;
+
+        case GDK_x:
+        case GDK_X:
+            if (MOD__ALT_ONLY) {
+                desktop->setToolboxFocusTo ("altx-rect");
+                ret = TRUE;
+            }
+            break;
+
+        case GDK_Escape:
+            sp_desktop_selection(desktop)->clear();
+            //TODO: make dragging escapable by Esc
+            break;
+
+        case GDK_space:
+            if (dragging) {
+                sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
+                                      event->button.time);
+                dragging = false;
+                if (!event_context->within_tolerance) {
+                    // we've been dragging, finish the rect
+                    sp_3dbox_finish(rc);
+                }
+                // do not return true, so that space would work switching to selector
+            }
+            break;
+
+        default:
+            break;
+        }
+        break;
+    case GDK_KEY_RELEASE:
+        switch (get_group0_keyval (&event->key)) {
+        case GDK_Alt_L:
+        case GDK_Alt_R:
+        case GDK_Control_L:
+        case GDK_Control_R:
+        case GDK_Shift_L:
+        case GDK_Shift_R:
+        case GDK_Meta_L:  // Meta is when you press Shift+Alt
+        case GDK_Meta_R:
+            event_context->defaultMessageContext()->clear();
+            break;
+        default:
+            break;
+        }
+        break;
+    default:
+        break;
+    }
+
+    if (!ret) {
+        if (((SPEventContextClass *) parent_class)->root_handler) {
+            ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
+        }
+    }
+
+    return ret;
+}
+
+static void sp_3dbox_drag(SP3DBoxContext &rc, guint state)
+{
+    SPDesktop *desktop = SP_EVENT_CONTEXT(&rc)->desktop;
+
+    if (!rc.item) {
+
+        if (Inkscape::have_viable_layer(desktop, rc._message_context) == false) {
+            return;
+        }
+
+        /* Create object */
+        Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_EVENT_CONTEXT_DOCUMENT(&rc));
+        Inkscape::XML::Node *repr = xml_doc->createElement("svg:g");
+        repr->setAttribute("sodipodi:type", "inkscape:3dbox");
+
+        /* Set style */
+        //sp_desktop_apply_style_tool (desktop, repr, "tools.shapes.3dbox", false);
+
+        rc.item = (SPItem *) desktop->currentLayer()->appendChildRepr(repr);
+        Inkscape::GC::release(repr);
+        rc.item->transform = SP_ITEM(desktop->currentRoot())->getRelativeTransform(desktop->currentLayer());
+
+        /* The separate faces (created from rear to front) */
+        SP3DBox *box3d = SP_3DBOX(rc.item);
+        box3d->face3.hook_path_to_3dbox();
+        box3d->face4.hook_path_to_3dbox();
+        box3d->face5.hook_path_to_3dbox();
+        box3d->face6.hook_path_to_3dbox();
+        box3d->face1.hook_path_to_3dbox();
+        box3d->face2.hook_path_to_3dbox();
+
+        rc.item->updateRepr();
+
+        sp_canvas_force_full_redraw_after_interruptions(desktop->canvas, 5);
+    }
+
+    // FIXME: remove these extra points
+    NR::Point pt = rc.drag_ptB;
+    NR::Point shift_pt = rc.drag_ptC;
+
+    NR::Rect r;
+    if (!(state & GDK_SHIFT_MASK)) {
+        r = Inkscape::snap_rectangular_box(desktop, rc.item, pt, rc.center, state);
+    } else {
+        r = Inkscape::snap_rectangular_box(desktop, rc.item, shift_pt, rc.center, state);
+    }
+
+    /*** artefacts of rect ***
+    if ( rc.rx != 0.0 ) {
+        sp_3dbox_set_rx (SP_3DBOX(rc.item), TRUE, rc.rx);
+    }
+    if ( rc.ry != 0.0 ) {
+        if (rc.rx == 0.0)
+            sp_3dbox_set_ry (SP_3DBOX(rc.item), TRUE, CLAMP(rc.ry, 0, MIN(r.dimensions()[NR::X], r.dimensions()[NR::Y])/2));
+        else
+            sp_3dbox_set_ry (SP_3DBOX(rc.item), TRUE, CLAMP(rc.ry, 0, r.dimensions()[NR::Y]));
+    }
+    ***/
+
+    SPEventContext *ec = SP_EVENT_CONTEXT(&rc);
+    NR::Point origin_w(ec->xp, ec->yp);
+    NR::Point origin(desktop->w2d(origin_w));
+    sp_3dbox_position_set(rc);
+
+    // status text
+    GString *xs = SP_PX_TO_METRIC_STRING(r.dimensions()[NR::X], desktop->namedview->getDefaultMetric());
+    GString *ys = SP_PX_TO_METRIC_STRING(r.dimensions()[NR::Y], desktop->namedview->getDefaultMetric());
+    rc._message_context->setF(Inkscape::NORMAL_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);
+    g_string_free(xs, FALSE);
+    g_string_free(ys, FALSE);
+}
+
+static void sp_3dbox_finish(SP3DBoxContext *rc)
+{
+    rc->_message_context->clear();
+
+    if ( rc->item != NULL ) {
+        SPDesktop * desktop;
+
+        desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
+
+        SP_OBJECT(rc->item)->updateRepr();
+
+        sp_canvas_end_forced_full_redraws(desktop->canvas);
+
+        sp_desktop_selection(desktop)->set(rc->item);
+        sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_3DBOX,
+                         _("Create 3d box"));
+
+        rc->item = NULL;
+    }
+
+    rc->ctrl_dragged = false;
+    rc->extruded = false;
+}
+
+/*
+  Local Variables:
+  mode:c++
+  c-file-style:"stroustrup"
+  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
+  indent-tabs-mode:nil
+  fill-column:99
+  End:
+*/
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :