- try to use more forward declarations for less dependencies on display/curve.h

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

diff --git a/src/sp-item.h b/src/sp-item.h
index 5596942763b697693202476c19eea54358a37fdb..96981aa1d7b1bd5cedc1655902488ddd53971265 100644 (file)
--- a/src/sp-item.h
+++ b/src/sp-item.h
@@ -71,9 +71,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;
 
@@ -91,8 +92,11 @@ struct SPItemCtx {
 /** Abstract base class for all visible shapes. */
 struct SPItem : public SPObject {
     enum BBoxType {
-        APPROXIMATE_BBOX,
+        // 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
     };
 
@@ -135,7 +139,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;
     
@@ -148,8 +152,7 @@ struct SPItem : public SPObject {
     void raiseToTop();
     void lowerToBottom();
 
-    NR::Rect invokeBbox(NR::Matrix const &transform) const;
-    NR::Maybe<NR::Rect> getBBox(NR::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
+    NR::Maybe<NR::Rect> getBounds(NR::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
 
     sigc::connection _clip_ref_connection;
     sigc::connection _mask_ref_connection;
@@ -194,6 +197,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);
@@ -205,8 +211,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, NR::Maybe<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, NR::Maybe<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);
 
@@ -218,27 +226,30 @@ 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));
+NR::Maybe<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);
@@ -264,6 +275,8 @@ NR::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
 
 /*