Code

Split SPCanvasItem and SPCanvasGroup to individual .h files. Removed forward header.
[inkscape.git] / src / display / canvas-grid.cpp
index 8505426d3cb7822fc68bf9fb1c27190de8c23436..5892e1dc736dfb11b89fdba115c308ec7ce867ed 100644 (file)
@@ -3,6 +3,7 @@
  */
 /* Copyright (C) Johan Engelen 2006-2007 <johan@shouraizou.nl>
  * Copyright (C) Lauris Kaplinski 2000
+ *   Abhishek Sharma
  */
 
 /* As a general comment, I am not exactly proud of how things are done.
  * Don't be shy to correct things.
  */
 
-#define INKSCAPE_CANVAS_GRID_C
-
+#include "sp-canvas-group.h"
 #include "sp-canvas-util.h"
-#include "util/mathfns.h" 
-#include "display-forward.h"
-#include <libnr/nr-pixops.h>
+#include "util/mathfns.h"
+#include "libnr/nr-pixops.h"
 #include "desktop-handles.h"
 #include "helper/units.h"
 #include "svg/svg-color.h"
@@ -33,6 +32,8 @@
 #include "canvas-grid.h"
 #include "canvas-axonomgrid.h"
 
+using Inkscape::DocumentUndo;
+
 namespace Inkscape {
 
 static gchar const *const grid_name[] = {
@@ -247,7 +248,7 @@ CanvasGrid::writeNewGridToRepr(Inkscape::XML::Node * repr, SPDocument * doc, Gri
 
     // first create the child xml node, then hook it to repr. This order is important, to not set off listeners to repr before the new node is complete.
 
-    Inkscape::XML::Document *xml_doc = sp_document_repr_doc(doc);
+    Inkscape::XML::Document *xml_doc = doc->getReprDoc();
     Inkscape::XML::Node *newnode;
     newnode = xml_doc->createElement("inkscape:grid");
     newnode->setAttribute("type", getSVGName(gridtype));
@@ -255,7 +256,7 @@ CanvasGrid::writeNewGridToRepr(Inkscape::XML::Node * repr, SPDocument * doc, Gri
     repr->appendChild(newnode);
     Inkscape::GC::release(newnode);
 
-    sp_document_done(doc, SP_VERB_DIALOG_NAMEDVIEW, _("Create new grid"));
+    DocumentUndo::done(doc, SP_VERB_DIALOG_NAMEDVIEW, _("Create new grid"));
 }
 
 /*
@@ -324,6 +325,12 @@ CanvasGrid::newWidget()
         new Inkscape::UI::Widget::RegisteredCheckButton( _("_Enabled"),
                         _("Determines whether to snap to this grid or not. Can be 'on' for invisible grids."),
                          "enabled", _wr, false, repr, doc) );
+
+    Inkscape::UI::Widget::RegisteredCheckButton * _rcb_snap_visible_only = Gtk::manage(
+            new Inkscape::UI::Widget::RegisteredCheckButton( _("Snap to visible _grid lines only"),
+                            _("When zoomed out, not all grid lines will be displayed. Only the visible ones will be snapped to"),
+                             "snapvisiblegridlinesonly", _wr, true, repr, doc) );
+
     Inkscape::UI::Widget::RegisteredCheckButton * _rcb_visible = Gtk::manage(
         new Inkscape::UI::Widget::RegisteredCheckButton( _("_Visible"),
                         _("Determines whether the grid is displayed or not. Objects are still snapped to invisible grids."),
@@ -331,11 +338,13 @@ CanvasGrid::newWidget()
 
     vbox->pack_start(*_rcb_enabled, true, true);
     vbox->pack_start(*_rcb_visible, true, true);
+    vbox->pack_start(*_rcb_snap_visible_only, true, true);
     Gtk::Widget * gridwdg = newSpecificWidget();
     vbox->pack_start(*gridwdg, true, true);
 
     std::list<Gtk::Widget*> slaves;
     slaves.push_back(_rcb_visible);
+    slaves.push_back(_rcb_snap_visible_only);
     slaves.push_back(gridwdg);
     _rcb_enabled->setSlaveWidgets(slaves);
 
@@ -343,6 +352,7 @@ CanvasGrid::newWidget()
     _rcb_visible->setActive(visible);
     if (snapper != NULL) {
         _rcb_enabled->setActive(snapper->getEnabled());
+        _rcb_snap_visible_only->setActive(snapper->getSnapVisibleOnly());
     }
 
     return dynamic_cast<Gtk::Widget *> (vbox);
@@ -357,13 +367,13 @@ CanvasGrid::on_repr_attr_changed(Inkscape::XML::Node *repr, gchar const *key, gc
     ((CanvasGrid*) data)->onReprAttrChanged(repr, key, oldval, newval, is_interactive);
 }
 
-bool CanvasGrid::isEnabled() 
-{ 
+bool CanvasGrid::isEnabled()
+{
     if (snapper == NULL) {
        return false;
-    } 
-    
-    return snapper->getEnabled();    
+    }
+
+    return snapper->getEnabled();
 }
 
 // ##########################################################
@@ -619,12 +629,17 @@ CanvasXYGrid::readRepr()
     if ( (value = repr->attribute("visible")) ) {
         visible = (strcmp(value,"false") != 0 && strcmp(value, "0") != 0);
     }
-    
+
     if ( (value = repr->attribute("enabled")) ) {
         g_assert(snapper != NULL);
         snapper->setEnabled(strcmp(value,"false") != 0 && strcmp(value, "0") != 0);
     }
 
+    if ( (value = repr->attribute("snapvisiblegridlinesonly")) ) {
+        g_assert(snapper != NULL);
+        snapper->setSnapVisibleOnly(strcmp(value,"false") != 0 && strcmp(value, "0") != 0);
+    }
+
     for (GSList *l = canvasitems; l != NULL; l = l->next) {
         sp_canvas_item_request_update ( SP_CANVAS_ITEM(l->data) );
     }
@@ -665,15 +680,15 @@ CanvasXYGrid::newSpecificWidget()
 
     Inkscape::UI::Widget::RegisteredColorPicker *_rcp_gcol = Gtk::manage(
         new Inkscape::UI::Widget::RegisteredColorPicker(
-            _("Grid line _color:"), _("Grid line color"), _("Color of grid lines"), 
+            _("Grid line _color:"), _("Grid line color"), _("Color of grid lines"),
             "color", "opacity", _wr, repr, doc));
 
     Inkscape::UI::Widget::RegisteredColorPicker *_rcp_gmcol = Gtk::manage(
         new Inkscape::UI::Widget::RegisteredColorPicker(
-            _("Ma_jor grid line color:"), _("Major grid line color"), 
-            _("Color of the major (highlighted) grid lines"), "empcolor", "empopacity", 
+            _("Ma_jor grid line color:"), _("Major grid line color"),
+            _("Color of the major (highlighted) grid lines"), "empcolor", "empopacity",
             _wr, repr, doc));
-    
+
     Inkscape::UI::Widget::RegisteredSuffixedInteger *_rsi = Gtk::manage( new Inkscape::UI::Widget::RegisteredSuffixedInteger(
             _("_Major grid line every:"), "", _("lines"), "empspacing", _wr, repr, doc) );
 
@@ -948,11 +963,26 @@ CanvasXYGrid::Render (SPCanvasBuf *buf)
     }
 }
 
-CanvasXYGridSnapper::CanvasXYGridSnapper(CanvasXYGrid *grid, SnapManager const *sm, Geom::Coord const d) : LineSnapper(sm, d)
+CanvasXYGridSnapper::CanvasXYGridSnapper(CanvasXYGrid *grid, SnapManager *sm, Geom::Coord const d) : LineSnapper(sm, d)
 {
     this->grid = grid;
 }
 
+/**
+ *  \return Snap tolerance (desktop coordinates); depends on current zoom so that it's always the same in screen pixels
+ */
+Geom::Coord CanvasXYGridSnapper::getSnapperTolerance() const
+{
+    SPDesktop const *dt = _snapmanager->getDesktop();
+    double const zoom =  dt ? dt->current_zoom() : 1;
+    return _snapmanager->snapprefs.getGridTolerance() / zoom;
+}
+
+bool CanvasXYGridSnapper::getSnapperAlwaysSnap() const
+{
+    return _snapmanager->snapprefs.getGridTolerance() == 10000; //TODO: Replace this threshold of 10000 by a constant; see also tolerance-slider.cpp
+}
+
 LineSnapper::LineList
 CanvasXYGridSnapper::_getSnapLines(Geom::Point const &p) const
 {
@@ -964,23 +994,30 @@ CanvasXYGridSnapper::_getSnapLines(Geom::Point const &p) const
 
     for (unsigned int i = 0; i < 2; ++i) {
 
-        /* This is to make sure we snap to only visible grid lines */
-        double scaled_spacing = grid->sw[i]; // this is spacing of visible lines in screen pixels
+        double spacing;
 
-        // convert screen pixels to px
-        // FIXME: after we switch to snapping dist in screen pixels, this will be unnecessary
-        if (SP_ACTIVE_DESKTOP) {
-            scaled_spacing /= SP_ACTIVE_DESKTOP->current_zoom();
+        if (getSnapVisibleOnly()) {
+            // Only snapping to visible grid lines
+            spacing = grid->sw[i]; // this is the spacing of the visible grid lines measured in screen pixels
+            // convert screen pixels to px
+            // FIXME: after we switch to snapping dist in screen pixels, this will be unnecessary
+            SPDesktop const *dt = _snapmanager->getDesktop();
+            if (dt) {
+                spacing /= dt->current_zoom();
+            }
+        } else {
+            // Snapping to any grid line, whether it's visible or not
+            spacing = grid->spacing[i];
         }
 
-        Geom::Coord rounded;        
+        Geom::Coord rounded;
         Geom::Point point_on_line;
-        
-        rounded = Inkscape::Util::round_to_upper_multiple_plus(p[i], scaled_spacing, grid->origin[i]);
+
+        rounded = Inkscape::Util::round_to_upper_multiple_plus(p[i], spacing, grid->origin[i]);
         point_on_line = i ? Geom::Point(0, rounded) : Geom::Point(rounded, 0);
         s.push_back(std::make_pair(component_vectors[i], point_on_line));
-        
-        rounded = Inkscape::Util::round_to_lower_multiple_plus(p[i], scaled_spacing, grid->origin[i]);
+
+        rounded = Inkscape::Util::round_to_lower_multiple_plus(p[i], spacing, grid->origin[i]);
         point_on_line = i ? Geom::Point(0, rounded) : Geom::Point(rounded, 0);
         s.push_back(std::make_pair(component_vectors[i], point_on_line));
     }
@@ -988,18 +1025,24 @@ CanvasXYGridSnapper::_getSnapLines(Geom::Point const &p) const
     return s;
 }
 
-void CanvasXYGridSnapper::_addSnappedLine(SnappedConstraints &sc, Geom::Point const snapped_point, Geom::Coord const snapped_distance, Geom::Point const normal_to_line, Geom::Point const point_on_line) const 
+void CanvasXYGridSnapper::_addSnappedLine(SnappedConstraints &sc, Geom::Point const snapped_point, Geom::Coord const snapped_distance,  SnapSourceType const &source, long source_num, Geom::Point const normal_to_line, Geom::Point const point_on_line) const
 {
-    SnappedLine dummy = SnappedLine(snapped_point, snapped_distance, getSnapperTolerance(), getSnapperAlwaysSnap(), normal_to_line, point_on_line);
+    SnappedLine dummy = SnappedLine(snapped_point, snapped_distance, source, source_num, Inkscape::SNAPTARGET_GRID, getSnapperTolerance(), getSnapperAlwaysSnap(), normal_to_line, point_on_line);
     sc.grid_lines.push_back(dummy);
 }
 
+void CanvasXYGridSnapper::_addSnappedPoint(SnappedConstraints &sc, Geom::Point const snapped_point, Geom::Coord const snapped_distance, SnapSourceType const &source, long source_num, bool constrained_snap) const
+{
+    SnappedPoint dummy = SnappedPoint(snapped_point, source, source_num, Inkscape::SNAPTARGET_GRID, snapped_distance, getSnapperTolerance(), getSnapperAlwaysSnap(), constrained_snap, true);
+    sc.points.push_back(dummy);
+}
+
 /**
  *  \return true if this Snapper will snap at least one kind of point.
  */
 bool CanvasXYGridSnapper::ThisSnapperMightSnap() const
 {
-    return _snapmanager->snapprefs.getSnapModeBBoxOrNodes();
+    return _snap_enabled && _snapmanager->snapprefs.getSnapToGrids() && _snapmanager->snapprefs.getSnapModeBBoxOrNodes();
 }
 
 } // namespace Inkscape
@@ -1014,4 +1057,4 @@ bool CanvasXYGridSnapper::ThisSnapperMightSnap() const
   fill-column:99
   End:
 */
-// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :