NR::Maybe => boost::optional

[inkscape.git] / src / sp-item.h

diff --git a/src/sp-item.h b/src/sp-item.h
index fc368d5b9223ffad5c13b0bf215dc6703b0ea82d..581b6acdd255ac04684488e79961bdfccbd508b3 100644 (file)
--- a/src/sp-item.h
+++ b/src/sp-item.h
@@ -23,6 +23,8 @@
 #include "sp-object.h"
 #include <libnr/nr-matrix.h>
 #include <libnr/nr-rect.h>
+#include <2geom/forward.h>
+#include <libnr/nr-convert2geom.h>
 
 class SPGuideConstraint;
 struct SPClipPathReference;
@@ -71,9 +73,10 @@ struct SPItemView {
 #define SP_ITEM_SHOW_DISPLAY (1 << 0)
 
 /**
- * Flag for referenced views (i.e. clippaths, masks and patterns); always display
+ * Flag for referenced views (i.e. markers, clippaths, masks and patterns); 
+   currently unused, does the same as DISPLAY
  */
-#define SP_ITEM_REFERENCE_FLAGS SP_ITEM_SHOW_DISPLAY
+#define SP_ITEM_REFERENCE_FLAGS (1 << 1)
 
 class SPItemCtx;
 
@@ -90,6 +93,15 @@ struct SPItemCtx {
 
 /** Abstract base class for all visible shapes. */
 struct SPItem : public SPObject {
+    enum BBoxType {
+        // legacy behavior: includes crude stroke, markers; excludes long miters, blur margin; is known to be wrong for caps
+        APPROXIMATE_BBOX, 
+        // includes only the bare path bbox, no stroke, no nothing
+        GEOMETRIC_BBOX,
+        // includes everything: correctly done stroke (with proper miters and caps), markers, filter margins (e.g. blur)
+        RENDERING_BBOX
+    };
+
     unsigned int sensitive : 1;
     unsigned int stop_paint: 1;
     double transform_center_x;
@@ -129,7 +141,7 @@ struct SPItem : public SPObject {
     void setCenter(NR::Point object_centre);
     void unsetCenter();
     bool isCenterSet();
-    NR::Point getCenter();
+    NR::Point getCenter() const;
 
     bool isVisibleAndUnlocked() const;
     
@@ -142,7 +154,8 @@ struct SPItem : public SPObject {
     void raiseToTop();
     void lowerToBottom();
 
-    NR::Rect invokeBbox(NR::Matrix const &transform) const;
+    boost::optional<NR::Rect> getBounds(NR::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
+    Geom::Rect getBounds(Geom::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
 
     sigc::connection _clip_ref_connection;
     sigc::connection _mask_ref_connection;
@@ -187,6 +200,9 @@ struct SPItemClass {
     
     /** Apply the transform optimally, and return any residual transformation */
     NR::Matrix (* set_transform)(SPItem *item, NR::Matrix const &transform);
+
+    /** Convert the item to guidelines */
+    void (* convert_to_guides)(SPItem *item);
     
     /** Emit event, if applicable */
     gint (* event) (SPItem *item, SPEvent *event);
@@ -198,8 +214,10 @@ struct SPItemClass {
 
 /* Methods */
 
-void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear);
-void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear);
+void sp_item_invoke_bbox(SPItem const *item, boost::optional<NR::Rect> *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX);
+void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX) __attribute__ ((deprecated));
+void sp_item_invoke_bbox_full(SPItem const *item, boost::optional<NR::Rect> *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear);
+void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear) __attribute__ ((deprecated));
 
 unsigned sp_item_pos_in_parent(SPItem *item);
 
@@ -211,36 +229,39 @@ unsigned int sp_item_display_key_new(unsigned int numkeys);
 NRArenaItem *sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
 void sp_item_invoke_hide(SPItem *item, unsigned int key);
 
-void sp_item_snappoints(SPItem const *item, SnapPointsIter p);
+void sp_item_snappoints(SPItem const *item, bool includeItemCenter, SnapPointsIter p);
 
 void sp_item_adjust_pattern(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
 void sp_item_adjust_gradient(SPItem *item, /* NR::Matrix const &premul, */ NR::Matrix const &postmul, bool set = false);
 void sp_item_adjust_stroke(SPItem *item, gdouble ex);
 void sp_item_adjust_stroke_width_recursive(SPItem *item, gdouble ex);
 void sp_item_adjust_paint_recursive(SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern);
+void sp_item_adjust_livepatheffect(SPItem *item, NR::Matrix const &postmul, bool set = false);
 
-void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv = NULL);
+void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const *transform, NR::Matrix const *adv = NULL);
 void sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv = NULL, bool compensate = true);
 
 void sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform);
 
+void sp_item_convert_item_to_guides(SPItem *item);
+
 gint sp_item_event (SPItem *item, SPEvent *event);
 
 /* Utility */
 
 NRArenaItem *sp_item_get_arenaitem(SPItem *item, unsigned int key);
 
-void sp_item_bbox_desktop(SPItem *item, NRRect *bbox) __attribute__ ((deprecated));
-NR::Rect sp_item_bbox_desktop(SPItem *item);
+void sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX) __attribute__ ((deprecated));
+boost::optional<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX);
 
-NR::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
-NR::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
+Geom::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
+Geom::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
 
-NR::Matrix sp_item_i2doc_affine(SPItem const *item);
-NR::Matrix sp_item_i2root_affine(SPItem const *item);
+Geom::Matrix sp_item_i2doc_affine(SPItem const *item);
+Geom::Matrix sp_item_i2root_affine(SPItem const *item);
 
-NR::Matrix matrix_to_desktop (NR::Matrix m, SPItem const *item);
-NR::Matrix matrix_from_desktop (NR::Matrix m, SPItem const *item);
+Geom::Matrix matrix_to_desktop (Geom::Matrix m, SPItem const *item);
+Geom::Matrix matrix_from_desktop (Geom::Matrix m, SPItem const *item);
 
 /* fixme: - these are evil, but OK */
 
@@ -250,13 +271,15 @@ NR::Matrix matrix_from_desktop (NR::Matrix m, SPItem const *item);
  *
  * \return TRANSFORM.
  */
-NR::Matrix sp_item_i2d_affine(SPItem const *item);
-NR::Matrix sp_item_i2r_affine(SPItem const *item);
-void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &transform);
-NR::Matrix sp_item_dt2i_affine(SPItem const *item);
+Geom::Matrix sp_item_i2d_affine(SPItem const *item);
+Geom::Matrix sp_item_i2r_affine(SPItem const *item);
+void sp_item_set_i2d_affine(SPItem *item, Geom::Matrix const &transform);
+Geom::Matrix sp_item_dt2i_affine(SPItem const *item);
 int sp_item_repr_compare_position(SPItem *first, SPItem *second);
 SPItem *sp_item_first_item_child (SPObject *obj);
 
+void sp_item_convert_to_guides(SPItem *item);
+
 #endif
 
 /*