Code

NR::Maybe => boost::optional
[inkscape.git] / src / sp-item.cpp
index 0784d404c39745243c71be65fd5e4f90c95c7014..b0b6d8137f4cb9ba9109b7168886c6c09bc7f4ad 100644 (file)
@@ -56,7 +56,6 @@
 #include "filter-chemistry.h"
 #include "sp-guide.h"
 
-#include "libnr/nr-matrix-div.h"
 #include "libnr/nr-matrix-fns.h"
 #include "libnr/nr-matrix-scale-ops.h"
 #include "libnr/nr-matrix-translate-ops.h"
@@ -65,6 +64,8 @@
 #include "libnr/nr-convert2geom.h"
 #include "algorithms/find-last-if.h"
 #include "util/reverse-list.h"
+#include <2geom/rect.h>
+#include <2geom/transforms.h>
 
 #include "xml/repr.h"
 #include "extract-uri.h"
@@ -286,7 +287,7 @@ SPItem::setExplicitlyHidden(bool const val) {
  */
 void
 SPItem::setCenter(NR::Point object_centre) {
-    NR::Maybe<NR::Rect> bbox = getBounds(sp_item_i2d_affine(this));
+    boost::optional<NR::Rect> bbox = getBounds(from_2geom(sp_item_i2d_affine(this)));
     if (bbox) {
         transform_center_x = object_centre[NR::X] - bbox->midpoint()[NR::X];
         if (fabs(transform_center_x) < 1e-5) // rounding error
@@ -308,7 +309,7 @@ bool SPItem::isCenterSet() {
 }
 
 NR::Point SPItem::getCenter() const {
-    NR::Maybe<NR::Rect> bbox = getBounds(sp_item_i2d_affine(this));
+    boost::optional<NR::Rect> bbox = getBounds(from_2geom(sp_item_i2d_affine(this)));
     if (bbox) {
         return bbox->midpoint() + NR::Point (this->transform_center_x, this->transform_center_y);
     } else {
@@ -639,7 +640,7 @@ sp_item_update(SPObject *object, SPCtx *ctx, guint flags)
     if (item->style->filter.set && item->display) {
         NRRect item_bbox;
         sp_item_invoke_bbox(item, &item_bbox, NR::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
-        NR::Maybe<NR::Rect> i_bbox = item_bbox;
+        boost::optional<NR::Rect> i_bbox = item_bbox;
 
         SPItemView *itemview = item->display;
         do {
@@ -692,22 +693,38 @@ sp_item_write(SPObject *const object, Inkscape::XML::Document *xml_doc, Inkscape
     return repr;
 }
 
-NR::Maybe<NR::Rect> SPItem::getBounds(NR::Matrix const &transform,
+boost::optional<NR::Rect> SPItem::getBounds(NR::Matrix const &transform,
                                       SPItem::BBoxType type,
                                       unsigned int /*dkey*/) const
 {
-    NR::Maybe<NR::Rect> r = NR::Nothing();
+    boost::optional<NR::Rect> r;
     sp_item_invoke_bbox_full(this, &r, transform, type, TRUE);
     return r;
 }
 
+/*
+ * If the item is empty, or has an empty boundingbox for another reason, this method will
+ * return an empty rectangle. I.e. "getBounds(...).isEmpty() == true".
+ */
+Geom::Rect
+SPItem::getBounds(Geom::Matrix const &transform, SPItem::BBoxType type, unsigned int /*dkey*/)
+const
+{
+    boost::optional<NR::Rect> r;
+    sp_item_invoke_bbox_full(this, &r, from_2geom(transform), type, TRUE);
+    if (r)
+        return to_2geom(*r);
+    else
+        return Geom::Rect(); // return empty rectangle
+}
+
 void
-sp_item_invoke_bbox(SPItem const *item, NR::Maybe<NR::Rect> *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
+sp_item_invoke_bbox(SPItem const *item, boost::optional<NR::Rect> *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
 {
     sp_item_invoke_bbox_full(item, bbox, transform, type, clear);
 }
 
-// DEPRECATED to phase out the use of NRRect in favor of NR::Maybe<NR::Rect>
+// DEPRECATED to phase out the use of NRRect in favor of boost::optional<NR::Rect>
 void
 sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
 {
@@ -719,14 +736,14 @@ sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transfor
  * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
  * clones), in turn, call this function in their bbox methods. */
 void
-sp_item_invoke_bbox_full(SPItem const *item, NR::Maybe<NR::Rect> *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear)
+sp_item_invoke_bbox_full(SPItem const *item, boost::optional<NR::Rect> *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear)
 {
     g_assert(item != NULL);
     g_assert(SP_IS_ITEM(item));
     g_assert(bbox != NULL);
 
     if (clear) {
-        *bbox = NR::Nothing();
+        *bbox = boost::optional<NR::Rect>();
     }
 
     // TODO: replace NRRect by NR::Rect, for all SPItemClasses, and for SP_CLIPPATH
@@ -783,7 +800,7 @@ sp_item_invoke_bbox_full(SPItem const *item, NR::Maybe<NR::Rect> *bbox, NR::Matr
                 }
 
                 // transform the expansions by the item's transform:
-                NR::Matrix i2d = sp_item_i2d_affine (item);
+                NR::Matrix i2d = from_2geom(sp_item_i2d_affine (item));
                 dx0 *= NR::expansionX(i2d);
                 dx1 *= NR::expansionX(i2d);
                 dy0 *= NR::expansionY(i2d);
@@ -809,20 +826,20 @@ sp_item_invoke_bbox_full(SPItem const *item, NR::Maybe<NR::Rect> *bbox, NR::Matr
         // or it has explicitely been set to be like this (e.g. in sp_shape_bbox)
         
         // When x0 > x1 or y0 > y1, the bbox is considered to be "nothing", although it has not been 
-        // explicitely defined this way for NRRects (as opposed to NR::Maybe<NR::Rect>)
-        *bbox = NR::Nothing();
+        // explicitely defined this way for NRRects (as opposed to boost::optional<NR::Rect>)
+        // So union bbox with nothing = do nothing, just return
         return;
     }
 
-    // Do not use temp_bbox.upgrade() here, because it uses a test that returns NR::Nothing
+    // Do not use temp_bbox.upgrade() here, because it uses a test that returns an empty boost::optional<NR::Rect>()
     // for any rectangle with zero area. The geometrical bbox of for example a vertical line
-    // would therefore be translated into NR::Nothing (see bug https://bugs.launchpad.net/inkscape/+bug/168684)
-    NR::Maybe<NR::Rect> temp_bbox_new = NR::Rect(NR::Point(temp_bbox.x0, temp_bbox.y0), NR::Point(temp_bbox.x1, temp_bbox.y1));
+    // would therefore be translated into empty boost::optional<NR::Rect>() (see bug https://bugs.launchpad.net/inkscape/+bug/168684)
+    boost::optional<NR::Rect> temp_bbox_new = NR::Rect(NR::Point(temp_bbox.x0, temp_bbox.y0), NR::Point(temp_bbox.x1, temp_bbox.y1));
 
     *bbox = NR::union_bounds(*bbox, temp_bbox_new);
 }
 
-// DEPRECATED to phase out the use of NRRect in favor of NR::Maybe<NR::Rect>
+// DEPRECATED to phase out the use of NRRect in favor of boost::optional<NR::Rect>
 /** Calls \a item's subclass' bounding box method; clips it by the bbox of clippath, if any; and
  * unions the resulting bbox with \a bbox. If \a clear is true, empties \a bbox first. Passes the
  * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
@@ -893,19 +910,19 @@ sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type)
     g_assert(SP_IS_ITEM(item));
     g_assert(bbox != NULL);
 
-    sp_item_invoke_bbox(item, bbox, sp_item_i2d_affine(item), TRUE, type);
+    sp_item_invoke_bbox(item, bbox, from_2geom(sp_item_i2d_affine(item)), TRUE, type);
 }
 
-NR::Maybe<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type)
+boost::optional<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type)
 {
-    NR::Maybe<NR::Rect> rect = NR::Nothing();
-    sp_item_invoke_bbox(item, &rect, sp_item_i2d_affine(item), TRUE, type);
+    boost::optional<NR::Rect> rect = boost::optional<NR::Rect>();
+    sp_item_invoke_bbox(item, &rect, from_2geom(sp_item_i2d_affine(item)), TRUE, type);
     return rect;
 }
 
 static void sp_item_private_snappoints(SPItem const *item, SnapPointsIter p)
 {
-    NR::Maybe<NR::Rect> bbox = item->getBounds(sp_item_i2d_affine(item));
+    boost::optional<NR::Rect> bbox = item->getBounds(from_2geom(sp_item_i2d_affine(item)));
     /* Just the corners of the bounding box suffices given that we don't yet
        support angled guide lines. */
 
@@ -922,16 +939,43 @@ static void sp_item_private_snappoints(SPItem const *item, SnapPointsIter p)
 
 void sp_item_snappoints(SPItem const *item, bool includeItemCenter, SnapPointsIter p)
 {
-    g_assert (item != NULL);
+       g_assert (item != NULL);
     g_assert (SP_IS_ITEM(item));
 
+    // Get the snappoints of the item
     SPItemClass const &item_class = *(SPItemClass const *) G_OBJECT_GET_CLASS(item);
     if (item_class.snappoints) {
         item_class.snappoints(item, p);
     }
 
+    // Get the snappoints at the item's center
     if (includeItemCenter) {
        *p = item->getCenter();
+    }    
+    
+    // Get the snappoints of clipping paths and mask, if any
+    std::list<SPObject const *> clips_and_masks;
+    
+    clips_and_masks.push_back(SP_OBJECT(item->clip_ref->getObject()));
+    clips_and_masks.push_back(SP_OBJECT(item->mask_ref->getObject()));
+    
+    for (std::list<SPObject const *>::const_iterator o = clips_and_masks.begin(); o != clips_and_masks.end(); o++) {
+       if (*o) {
+               // obj is a group object, the children are the actual clippers
+               for (SPObject *child = (*o)->children ; child ; child = child->next) {
+                   if (SP_IS_ITEM(child)) {
+                       std::vector<NR::Point> p_clip_or_mask;                      
+                       // Please note the recursive call here!
+                       sp_item_snappoints(SP_ITEM(child), includeItemCenter, SnapPointsIter(p_clip_or_mask));
+                       // Take into account the transformation of the item being clipped or masked
+                       for (std::vector<NR::Point>::const_iterator p_orig = p_clip_or_mask.begin(); p_orig != p_clip_or_mask.end(); p_orig++) {
+                       // All snappoints are in desktop coordinates, but the item's transformation is
+                               // in document coordinates. Hence the awkward construction below
+                               *p = (*p_orig) * from_2geom(matrix_to_desktop (matrix_from_desktop (to_2geom(item->transform), item), item));
+                   }
+                   }
+               }
+       }
     }
 }
 
@@ -1070,7 +1114,7 @@ sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned key, unsigned flags)
         NR_ARENA_ITEM_SET_DATA(ai, item);
         NRRect item_bbox;
         sp_item_invoke_bbox(item, &item_bbox, NR::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
-        NR::Maybe<NR::Rect> i_bbox = item_bbox;
+        boost::optional<NR::Rect> i_bbox = item_bbox;
         nr_arena_item_set_item_bbox(ai, i_bbox);
     }
 
@@ -1299,14 +1343,16 @@ sp_item_adjust_livepatheffect (SPItem *item, NR::Matrix const &postmul, bool set
             // If the path effect is used by 2 or more items, fork it
             // so that each object has its own independent copy of the effect
             LivePathEffectObject *lpeobj = (*it)->lpeobject;
-            LivePathEffectObject *new_lpeobj = lpeobj->fork_private_if_necessary();
-            if (new_lpeobj != lpeobj) {
-                sp_lpe_item_replace_path_effect(lpeitem, lpeobj, new_lpeobj);
-            }
+            if (lpeobj) {
+                LivePathEffectObject *new_lpeobj = lpeobj->fork_private_if_necessary();
+                if (new_lpeobj != lpeobj) {
+                    sp_lpe_item_replace_path_effect(lpeitem, lpeobj, new_lpeobj);
+                }
         
-            if (lpeobj->lpe) {
-                Inkscape::LivePathEffect::Effect * effect = lpeobj->lpe;
-                effect->transform_multiply(to_2geom(postmul), set);
+                if (lpeobj->lpe) {
+                    Inkscape::LivePathEffect::Effect * effect = lpeobj->lpe;
+                    effect->transform_multiply(to_2geom(postmul), set);
+                }
             }
         }
     }
@@ -1454,38 +1500,38 @@ sp_item_convert_item_to_guides(SPItem *item) {
  * \pre \a ancestor really is an ancestor (\>=) of \a object, or NULL.
  *   ("Ancestor (\>=)" here includes as far as \a object itself.)
  */
-NR::Matrix
+Geom::Matrix
 i2anc_affine(SPObject const *object, SPObject const *const ancestor) {
-    NR::Matrix ret(NR::identity());
+    Geom::Matrix ret(Geom::identity());
     g_return_val_if_fail(object != NULL, ret);
 
     /* stop at first non-renderable ancestor */
     while ( object != ancestor && SP_IS_ITEM(object) ) {
         if (SP_IS_ROOT(object)) {
-            ret *= SP_ROOT(object)->c2p;
+            ret *= to_2geom(SP_ROOT(object)->c2p);
         }
-        ret *= SP_ITEM(object)->transform;
+        ret *= to_2geom(SP_ITEM(object)->transform);
         object = SP_OBJECT_PARENT(object);
     }
     return ret;
 }
 
-NR::Matrix
+Geom::Matrix
 i2i_affine(SPObject const *src, SPObject const *dest) {
-    g_return_val_if_fail(src != NULL && dest != NULL, NR::identity());
+    g_return_val_if_fail(src != NULL && dest != NULL, Geom::identity());
     SPObject const *ancestor = src->nearestCommonAncestor(dest);
-    return i2anc_affine(src, ancestor) / i2anc_affine(dest, ancestor);
+    return i2anc_affine(src, ancestor) * i2anc_affine(dest, ancestor).inverse();
 }
 
 NR::Matrix SPItem::getRelativeTransform(SPObject const *dest) const {
-    return i2i_affine(this, dest);
+    return from_2geom(i2i_affine(this, dest));
 }
 
 /**
  * Returns the accumulated transformation of the item and all its ancestors, including root's viewport.
  * \pre (item != NULL) and SP_IS_ITEM(item).
  */
-NR::Matrix sp_item_i2doc_affine(SPItem const *item)
+Geom::Matrix sp_item_i2doc_affine(SPItem const *item)
 {
     return i2anc_affine(item, NULL);
 }
@@ -1495,46 +1541,46 @@ NR::Matrix sp_item_i2doc_affine(SPItem const *item)
  * Used in path operations mostly.
  * \pre (item != NULL) and SP_IS_ITEM(item).
  */
-NR::Matrix sp_item_i2root_affine(SPItem const *item)
+Geom::Matrix sp_item_i2root_affine(SPItem const *item)
 {
     g_assert(item != NULL);
     g_assert(SP_IS_ITEM(item));
 
-    NR::Matrix ret(NR::identity());
-    g_assert(ret.test_identity());
+    Geom::Matrix ret(Geom::identity());
+    g_assert(ret.isIdentity());
     while ( NULL != SP_OBJECT_PARENT(item) ) {
-        ret *= item->transform;
+        ret *= to_2geom(item->transform);
         item = SP_ITEM(SP_OBJECT_PARENT(item));
     }
     g_assert(SP_IS_ROOT(item));
 
-    ret *= item->transform;
+    ret *= to_2geom(item->transform);
 
     return ret;
 }
 
 /* fixme: This is EVIL!!! */
-
-NR::Matrix sp_item_i2d_affine(SPItem const *item)
+// fix this note: why/what evil? :)
+Geom::Matrix sp_item_i2d_affine(SPItem const *item)
 {
     g_assert(item != NULL);
     g_assert(SP_IS_ITEM(item));
 
-    NR::Matrix const ret( sp_item_i2doc_affine(item)
-                          * NR::scale(1, -1)
-                          * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
+    Geom::Matrix const ret( sp_item_i2doc_affine(item)
+                          * Geom::Scale(1, -1)
+                          * Geom::Translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
     return ret;
 }
 
 // same as i2d but with i2root instead of i2doc
-NR::Matrix sp_item_i2r_affine(SPItem const *item)
+Geom::Matrix sp_item_i2r_affine(SPItem const *item)
 {
     g_assert(item != NULL);
     g_assert(SP_IS_ITEM(item));
 
-    NR::Matrix const ret( sp_item_i2root_affine(item)
-                          * NR::scale(1, -1)
-                          * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
+    Geom::Matrix const ret( sp_item_i2root_affine(item)
+                          * Geom::Scale(1, -1)
+                          * Geom::Translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
     return ret;
 }
 
@@ -1542,11 +1588,11 @@ NR::Matrix sp_item_i2r_affine(SPItem const *item)
  * Converts a matrix \a m into the desktop coords of the \a item.
  * Will become a noop when we eliminate the coordinate flipping.
  */
-NR::Matrix matrix_to_desktop(NR::Matrix const m, SPItem const *item)
+Geom::Matrix matrix_to_desktop(Geom::Matrix const m, SPItem const *item)
 {
-    NR::Matrix const ret(m
-                         * NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
-                         * NR::scale(1, -1));
+    Geom::Matrix const ret(m
+                         * Geom::Translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
+                         * Geom::Scale(1, -1));
     return ret;
 }
 
@@ -1554,33 +1600,33 @@ NR::Matrix matrix_to_desktop(NR::Matrix const m, SPItem const *item)
  * Converts a matrix \a m from the desktop coords of the \a item.
  * Will become a noop when we eliminate the coordinate flipping.
  */
-NR::Matrix matrix_from_desktop(NR::Matrix const m, SPItem const *item)
+Geom::Matrix matrix_from_desktop(Geom::Matrix const m, SPItem const *item)
 {
-    NR::Matrix const ret(NR::scale(1, -1)
-                         * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item)))
+    Geom::Matrix const ret(Geom::Scale(1, -1)
+                         * Geom::Translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item)))
                          * m);
     return ret;
 }
 
-void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &i2dt)
+void sp_item_set_i2d_affine(SPItem *item, Geom::Matrix const &i2dt)
 {
     g_return_if_fail( item != NULL );
     g_return_if_fail( SP_IS_ITEM(item) );
 
-    NR::Matrix dt2p; /* desktop to item parent transform */
+    Geom::Matrix dt2p; /* desktop to item parent transform */
     if (SP_OBJECT_PARENT(item)) {
         dt2p = sp_item_i2d_affine((SPItem *) SP_OBJECT_PARENT(item)).inverse();
     } else {
-        dt2p = ( NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
-                 * NR::scale(1, -1) );
+        dt2p = ( Geom::Translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
+                 * Geom::Scale(1, -1) );
     }
 
-    NR::Matrix const i2p( i2dt * dt2p );
-    sp_item_set_item_transform(item, i2p);
+    Geom::Matrix const i2p( i2dt * dt2p );
+    sp_item_set_item_transform(item, from_2geom(i2p));
 }
 
 
-NR::Matrix
+Geom::Matrix
 sp_item_dt2i_affine(SPItem const *item)
 {
     /* fixme: Implement the right way (Lauris) */
@@ -1670,7 +1716,7 @@ sp_item_convert_to_guides(SPItem *item) {
     SPItem::BBoxType bbox_type = (prefs_bbox ==0)? 
         SPItem::APPROXIMATE_BBOX : SPItem::GEOMETRIC_BBOX;
 
-    NR::Maybe<NR::Rect> bbox = sp_item_bbox_desktop(item, bbox_type);
+    boost::optional<NR::Rect> bbox = sp_item_bbox_desktop(item, bbox_type);
     if (!bbox) {
         g_warning ("Cannot determine item's bounding box during conversion to guides.\n");
         return;
@@ -1683,12 +1729,12 @@ sp_item_convert_to_guides(SPItem *item) {
     NR::Point B(A[NR::X], C[NR::Y]);
     NR::Point D(C[NR::X], A[NR::Y]);
 
-    pts.push_back(std::make_pair(A.to_2geom(), B.to_2geom()));
-    pts.push_back(std::make_pair(B.to_2geom(), C.to_2geom()));
-    pts.push_back(std::make_pair(C.to_2geom(), D.to_2geom()));
-    pts.push_back(std::make_pair(D.to_2geom(), A.to_2geom()));
+    pts.push_back(std::make_pair(A, B));
+    pts.push_back(std::make_pair(B, C));
+    pts.push_back(std::make_pair(C, D));
+    pts.push_back(std::make_pair(D, A));
 
-    sp_guide_pt_pairs_to_guides(SP_OBJECT_DOCUMENT(item), pts);
+    sp_guide_pt_pairs_to_guides(dt, pts);
 }
 
 /*