src/display/snap-indicator.cpp

   1 /** \file
   2  * Provides a class that shows a temporary indicator on the canvas of where the snap was, and what kind of snap
   3  *
   4  * Authors:
   5  *   Johan Engelen
   6  *   Diederik van Lierop
   7  *
   8  * Copyright (C) Johan Engelen 2009 <j.b.c.engelen@utwente.nl>
   9  * Copyright (C) Diederik van Lierop 2009 <mail@diedenrezi.nl>
  10  *
  11  * Released under GNU GPL, read the file 'COPYING' for more information
  12  */
  13
  14 #include "display/snap-indicator.h"
  15
  16 #include "desktop.h"
  17 #include "desktop-handles.h"
  18 #include "display/sodipodi-ctrl.h"
  19 #include "display/canvas-text.h"
  20 #include "knot.h"
  21 #include "preferences.h"
  22 #include <glibmm/i18n.h>
  23
  24 namespace Inkscape {
  25 namespace Display {
  26
  27 SnapIndicator::SnapIndicator(SPDesktop * desktop)
  28     :   _snaptarget(NULL),
  29         _snaptarget_tooltip(NULL),
  30         _snapsource(NULL),
  31         _desktop(desktop)
  32 {
  33 }
  34
  35 SnapIndicator::~SnapIndicator()
  36 {
  37     // remove item that might be present
  38     remove_snaptarget();
  39     remove_snapsource();
  40 }
  41
  42 void
  43 SnapIndicator::set_new_snaptarget(Inkscape::SnappedPoint const p)
  44 {
  45     remove_snaptarget(); //only display one snaptarget at a time
  46
  47     g_assert(_desktop != NULL);
  48
  49     /* Commented out for now, because this might hide any snapping bug!
  50     if (!p.getSnapped()) {
  51        return; // If we haven't snapped, then it is of no use to draw a snapindicator
  52     }
  53     */
  54
  55     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
  56     bool value = prefs->getBool("/options/snapindicator/value", true);
  57
  58     if (value) {
  59         // TRANSLATORS: undefined target for snapping
  60         gchar *target_name = _("UNDEFINED");
  61         switch (p.getTarget()) {
  62             case SNAPTARGET_UNDEFINED:
  63                 target_name = _("UNDEFINED");
  64                 break;
  65             case SNAPTARGET_GRID:
  66                 target_name = _("grid line");
  67                 break;
  68             case SNAPTARGET_GRID_INTERSECTION:
  69                 target_name = _("grid intersection");
  70                 break;
  71             case SNAPTARGET_GUIDE:
  72                 target_name = _("guide");
  73                 break;
  74             case SNAPTARGET_GUIDE_INTERSECTION:
  75                 target_name = _("guide intersection");
  76                 break;
  77             case SNAPTARGET_GUIDE_ORIGIN:
  78                 target_name = _("guide origin");
  79                 break;
  80             case SNAPTARGET_GRID_GUIDE_INTERSECTION:
  81                 target_name = _("grid-guide intersection");
  82                 break;
  83             case SNAPTARGET_NODE_CUSP:
  84                 target_name = _("cusp node");
  85                 break;
  86             case SNAPTARGET_NODE_SMOOTH:
  87                 target_name = _("smooth node");
  88                 break;
  89             case SNAPTARGET_PATH:
  90                 target_name = _("path");
  91                 break;
  92             case SNAPTARGET_PATH_INTERSECTION:
  93                 target_name = _("path intersection");
  94                 break;
  95             case SNAPTARGET_BBOX_CORNER:
  96                 target_name = _("bounding box corner");
  97                 break;
  98             case SNAPTARGET_BBOX_EDGE:
  99                 target_name = _("bounding box side");
 100                 break;
 101             case SNAPTARGET_GRADIENTS_PARENT_BBOX:
 102                 target_name = _("bounding box");
 103                 break;
 104             case SNAPTARGET_PAGE_BORDER:
 105                 target_name = _("page border");
 106                 break;
 107             case SNAPTARGET_LINE_MIDPOINT:
 108                 target_name = _("line midpoint");
 109                 break;
 110             case SNAPTARGET_OBJECT_MIDPOINT:
 111                 target_name = _("object midpoint");
 112                 break;
 113             case SNAPTARGET_ROTATION_CENTER:
 114                 target_name = _("object rotation center");
 115                 break;
 116             case SNAPTARGET_HANDLE:
 117                 target_name = _("handle");
 118                 break;
 119             case SNAPTARGET_BBOX_EDGE_MIDPOINT:
 120                 target_name = _("bounding box side midpoint");
 121                 break;
 122             case SNAPTARGET_BBOX_MIDPOINT:
 123                 target_name = _("bounding box midpoint");
 124                 break;
 125             case SNAPTARGET_PAGE_CORNER:
 126                 target_name = _("page corner");
 127                 break;
 128             case SNAPTARGET_CONVEX_HULL_CORNER:
 129                 target_name = _("convex hull corner");
 130                 break;
 131             case SNAPTARGET_ELLIPSE_QUADRANT_POINT:
 132                 target_name = _("quadrant point");
 133                 break;
 134             case SNAPTARGET_CENTER:
 135                 target_name = _("center");
 136                 break;
 137             case SNAPTARGET_CORNER:
 138                 target_name = _("corner");
 139                 break;
 140             case SNAPTARGET_TEXT_BASELINE:
 141                 target_name = _("text baseline");
 142                 break;
 143             default:
 144                 g_warning("Snap target has not yet been defined!");
 145                 break;
 146         }
 147
 148         gchar *source_name = _("UNDEFINED");
 149         switch (p.getSource()) {
 150             case SNAPSOURCE_UNDEFINED:
 151                 source_name = _("UNDEFINED");
 152                 break;
 153             case SNAPSOURCE_BBOX_CORNER:
 154                 source_name = _("Bounding box corner");
 155                 break;
 156             case SNAPSOURCE_BBOX_MIDPOINT:
 157                 source_name = _("Bounding box midpoint");
 158                 break;
 159             case SNAPSOURCE_BBOX_EDGE_MIDPOINT:
 160                 source_name = _("Bounding box side midpoint");
 161                 break;
 162             case SNAPSOURCE_NODE_SMOOTH:
 163                 source_name = _("Smooth node");
 164                 break;
 165             case SNAPSOURCE_NODE_CUSP:
 166                 source_name = _("Cusp node");
 167                 break;
 168             case SNAPSOURCE_LINE_MIDPOINT:
 169                 source_name = _("Line midpoint");
 170                 break;
 171             case SNAPSOURCE_OBJECT_MIDPOINT:
 172                 source_name = _("Object midpoint");
 173                 break;
 174             case SNAPSOURCE_ROTATION_CENTER:
 175                 source_name = _("Object rotation center");
 176                 break;
 177             case SNAPSOURCE_HANDLE:
 178                 source_name = _("Handle");
 179                 break;
 180             case SNAPSOURCE_PATH_INTERSECTION:
 181                 source_name = _("Path intersection");
 182                 break;
 183             case SNAPSOURCE_GUIDE:
 184                 source_name = _("Guide");
 185                 break;
 186             case SNAPSOURCE_GUIDE_ORIGIN:
 187                 source_name = _("Guide origin");
 188                 break;
 189             case SNAPSOURCE_CONVEX_HULL_CORNER:
 190                 source_name = _("Convex hull corner");
 191                 break;
 192             case SNAPSOURCE_ELLIPSE_QUADRANT_POINT:
 193                 source_name = _("Quadrant point");
 194                 break;
 195             case SNAPSOURCE_CENTER:
 196                 source_name = _("Center");
 197                 break;
 198             case SNAPSOURCE_CORNER:
 199                 source_name = _("Corner");
 200                 break;
 201             case SNAPSOURCE_TEXT_BASELINE:
 202                 source_name = _("Text baseline");
 203                 break;
 204             default:
 205                 g_warning("Snap source has not yet been defined!");
 206                 break;
 207         }
 208         //std::cout << "Snapped " << source_name << " to " << target_name << std::endl;
 209
 210         remove_snapsource(); // Don't set both the source and target indicators, as these will overlap
 211
 212         // Display the snap indicator (i.e. the cross)
 213         SPCanvasItem * canvasitem = NULL;
 214         if (p.getTarget() == SNAPTARGET_NODE_SMOOTH || p.getTarget() == SNAPTARGET_NODE_CUSP) {
 215             canvasitem = sp_canvas_item_new(sp_desktop_tempgroup (_desktop),
 216                                             SP_TYPE_CTRL,
 217                                             "anchor", GTK_ANCHOR_CENTER,
 218                                             "size", 10.0,
 219                                             "stroked", TRUE,
 220                                             "stroke_color", 0xf000f0ff,
 221                                             "mode", SP_KNOT_MODE_XOR,
 222                                             "shape", SP_KNOT_SHAPE_DIAMOND,
 223                                             NULL );
 224         } else {
 225             canvasitem = sp_canvas_item_new(sp_desktop_tempgroup (_desktop),
 226                                             SP_TYPE_CTRL,
 227                                             "anchor", GTK_ANCHOR_CENTER,
 228                                             "size", 10.0,
 229                                             "stroked", TRUE,
 230                                             "stroke_color", 0xf000f0ff,
 231                                             "mode", SP_KNOT_MODE_XOR,
 232                                             "shape", SP_KNOT_SHAPE_CROSS,
 233                                             NULL );
 234         }
 235
 236         const int timeout_val = 1200; // TODO add preference for snap indicator timeout?
 237
 238         SP_CTRL(canvasitem)->moveto(p.getPoint());
 239         _snaptarget = _desktop->add_temporary_canvasitem(canvasitem, timeout_val);
 240
 241         gchar *tooltip_str = g_strconcat(source_name, _(" to "), target_name, NULL);
 242         Geom::Point tooltip_pos = p.getPoint() + _desktop->w2d(Geom::Point(15, -15));
 243
 244         SPCanvasItem *canvas_tooltip = sp_canvastext_new(sp_desktop_tempgroup(_desktop), _desktop, tooltip_pos, tooltip_str);
 245         g_free(tooltip_str);
 246
 247         sp_canvastext_set_anchor((SPCanvasText* )canvas_tooltip, -1, 1);
 248         _snaptarget_tooltip = _desktop->add_temporary_canvasitem(canvas_tooltip, timeout_val);
 249     }
 250 }
 251
 252 void
 253 SnapIndicator::remove_snaptarget()
 254 {
 255     if (_snaptarget) {
 256         _desktop->remove_temporary_canvasitem(_snaptarget);
 257         _snaptarget = NULL;
 258     }
 259
 260     if (_snaptarget_tooltip) {
 261         _desktop->remove_temporary_canvasitem(_snaptarget_tooltip);
 262         _snaptarget_tooltip = NULL;
 263     }
 264
 265 }
 266
 267 void
 268 SnapIndicator::set_new_snapsource(std::pair<Geom::Point, int> const p)
 269 {
 270     remove_snapsource();
 271
 272     g_assert(_desktop != NULL);
 273
 274     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 275     bool value = prefs->getBool("/options/snapindicator/value", true);
 276
 277     if (value) {
 278         SPCanvasItem * canvasitem = sp_canvas_item_new( sp_desktop_tempgroup (_desktop),
 279                                                         SP_TYPE_CTRL,
 280                                                         "anchor", GTK_ANCHOR_CENTER,
 281                                                         "size", 6.0,
 282                                                         "stroked", TRUE,
 283                                                         "stroke_color", 0xf000f0ff,
 284                                                         "mode", SP_KNOT_MODE_XOR,
 285                                                         "shape", SP_KNOT_SHAPE_CIRCLE,
 286                                                         NULL );
 287
 288         SP_CTRL(canvasitem)->moveto(p.first);
 289         _snapsource = _desktop->add_temporary_canvasitem(canvasitem, 1000);
 290     }
 291 }
 292
 293 void
 294 SnapIndicator::remove_snapsource()
 295 {
 296     if (_snapsource) {
 297         _desktop->remove_temporary_canvasitem(_snapsource);
 298         _snapsource = NULL;
 299     }
 300 }
 301
 302 } //namespace Display
 303 } /* namespace Inkscape */
 304
 305
 306 /*
 307   Local Variables:
 308   mode:c++
 309   c-file-style:"stroustrup"
 310   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 311   indent-tabs-mode:nil
 312   fill-column:99
 313   End:
 314 */
 315 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=4:softtabstop=4 :