Code

Connector tool: make connectors avoid the convex hull of shapes.
[inkscape.git] / src / sp-item.h
index 358f3d75c7566e3f227766e65f1a3f0fe4b50ba5..639a1b4a2a18d1d0c601cc41706281ce25d9a04d 100644 (file)
 
 #include "display/nr-arena-forward.h"
 #include "sp-object.h"
-#include <libnr/nr-matrix.h>
+#include <2geom/matrix.h>
 #include <libnr/nr-rect.h>
 #include <2geom/forward.h>
 #include <libnr/nr-convert2geom.h>
+#include <snap-preferences.h>
+#include <snapped-point.h>
 
 class SPGuideConstraint;
 struct SPClipPathReference;
@@ -32,7 +34,7 @@ struct SPMaskReference;
 struct SPAvoidRef;
 struct SPPrintContext;
 namespace Inkscape { class URIReference; }
+
 enum {
     SP_EVENT_INVALID,
     SP_EVENT_NONE,
@@ -56,8 +58,6 @@ struct SPEvent {
     gpointer data;
 };
 
-class SPItemView;
-
 /// SPItemView
 struct SPItemView {
     SPItemView *next;
@@ -73,29 +73,27 @@ struct SPItemView {
 #define SP_ITEM_SHOW_DISPLAY (1 << 0)
 
 /**
- * Flag for referenced views (i.e. markers, clippaths, masks and patterns); 
+ * Flag for referenced views (i.e. markers, clippaths, masks and patterns);
    currently unused, does the same as DISPLAY
  */
 #define SP_ITEM_REFERENCE_FLAGS (1 << 1)
 
-class SPItemCtx;
-
 /// Contains transformations to document/viewport and the viewport size.
 struct SPItemCtx {
     SPCtx ctx;
     /** Item to document transformation */
-    NR::Matrix i2doc;
+    Geom::Matrix i2doc;
     /** Viewport size */
     NRRect vp;
     /** Item to viewport transformation */
-    NR::Matrix i2vp;
+    Geom::Matrix i2vp;
 };
 
 /** 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, 
+        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)
@@ -107,59 +105,59 @@ struct SPItem : public SPObject {
     double transform_center_x;
     double transform_center_y;
 
-    NR::Matrix transform;
-    
+    Geom::Matrix transform;
+
     SPClipPathReference *clip_ref;
     SPMaskReference *mask_ref;
-    
+
     // Used for object-avoiding connectors
     SPAvoidRef *avoidRef;
-    
+
     SPItemView *display;
-    
+
     std::vector<SPGuideConstraint> constraints;
-    
-    sigc::signal<void, NR::Matrix const *, SPItem *> _transformed_signal;
 
-    void init();    
+    sigc::signal<void, Geom::Matrix const *, SPItem *> _transformed_signal;
+
+    void init();
     bool isLocked() const;
     void setLocked(bool lock);
-    
+
     bool isHidden() const;
     void setHidden(bool hidden);
 
     bool isEvaluated() const;
     void setEvaluated(bool visible);
     void resetEvaluated();
-    
+
     bool isHidden(unsigned display_key) const;
-    
+
     bool isExplicitlyHidden() const;
-    
+
     void setExplicitlyHidden(bool val);
 
-    void setCenter(NR::Point object_centre);
+    void setCenter(Geom::Point object_centre);
     void unsetCenter();
     bool isCenterSet();
-    NR::Point getCenter() const;
+    Geom::Point getCenter() const;
 
     bool isVisibleAndUnlocked() const;
-    
+
     bool isVisibleAndUnlocked(unsigned display_key) const;
-    
-    NR::Matrix getRelativeTransform(SPObject const *obj) const;
-    
+
+    Geom::Matrix getRelativeTransform(SPObject const *obj) const;
+
     void raiseOne();
     void lowerOne();
     void raiseToTop();
     void lowerToBottom();
 
-    boost::optional<NR::Rect> getBounds(NR::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
+    Geom::OptRect getBounds(Geom::Matrix const &transform, BBoxType type=APPROXIMATE_BBOX, unsigned int dkey=0) const;
 
     sigc::connection _clip_ref_connection;
     sigc::connection _mask_ref_connection;
 
-    sigc::connection connectTransformed(sigc::slot<void, NR::Matrix const *, SPItem *> slot)  {
+    sigc::connection connectTransformed(sigc::slot<void, Geom::Matrix const *, SPItem *> slot)  {
         return _transformed_signal.connect(slot);
     }
 
@@ -173,36 +171,36 @@ private:
     mutable EvaluatedStatus _evaluated_status;
 };
 
-typedef std::back_insert_iterator<std::vector<NR::Point> > SnapPointsIter;
+typedef std::vector<std::pair<Geom::Point, int> > SnapPointsWithType; // int is either of these enums: Inkscape::SnapTargetType or Inkscape::SnapSourceType
 
 /// The SPItem vtable.
 struct SPItemClass {
     SPObjectClass parent_class;
 
     /** BBox union in given coordinate system */
-    void (* bbox) (SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
-    
+    void (* bbox) (SPItem const *item, NRRect *bbox, Geom::Matrix const &transform, unsigned const flags);
+
     /** Printing method. Assumes ctm is set to item affine matrix */
     /* \todo Think about it, and maybe implement generic export method instead (Lauris) */
     void (* print) (SPItem *item, SPPrintContext *ctx);
-    
+
     /** Give short description of item (for status display) */
     gchar * (* description) (SPItem * item);
-    
+
     NRArenaItem * (* show) (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
     void (* hide) (SPItem *item, unsigned int key);
-    
+
     /** Write to an iterator the points that should be considered for snapping
      * as the item's `nodes'.
      */
-    void (* snappoints) (SPItem const *item, SnapPointsIter p);
-    
+    void (* snappoints) (SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const *snapprefs);
+
     /** Apply the transform optimally, and return any residual transformation */
-    NR::Matrix (* set_transform)(SPItem *item, NR::Matrix const &transform);
+    Geom::Matrix (* set_transform)(SPItem *item, Geom::Matrix const &transform);
 
     /** Convert the item to guidelines */
     void (* convert_to_guides)(SPItem *item);
-    
+
     /** Emit event, if applicable */
     gint (* event) (SPItem *item, SPEvent *event);
 };
@@ -213,10 +211,10 @@ struct SPItemClass {
 
 /* Methods */
 
-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));
+void sp_item_invoke_bbox(SPItem const *item, Geom::OptRect &bbox, Geom::Matrix const &transform, unsigned const clear, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX);
+void sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, Geom::Matrix const &transform, unsigned const clear, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX) __attribute__ ((deprecated));
+void sp_item_invoke_bbox_full(SPItem const *item, Geom::OptRect &bbox, Geom::Matrix const &transform, unsigned const flags, unsigned const clear);
+void sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, Geom::Matrix const &transform, unsigned const flags, unsigned const clear) __attribute__ ((deprecated));
 
 unsigned sp_item_pos_in_parent(SPItem *item);
 
@@ -228,19 +226,18 @@ 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, bool includeItemCenter, SnapPointsIter p);
+void sp_item_snappoints(SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const *snapprefs);
 
-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_pattern(SPItem *item, /* Geom::Matrix const &premul, */ Geom::Matrix const &postmul, bool set = false);
+void sp_item_adjust_gradient(SPItem *item, /* Geom::Matrix const &premul, */ Geom::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_adjust_paint_recursive(SPItem *item, Geom::Matrix advertized_transform, Geom::Matrix t_ancestors, bool is_pattern);
+void sp_item_adjust_livepatheffect(SPItem *item, Geom::Matrix const &postmul, bool set = false);
 
-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_write_transform(SPItem *item, Inkscape::XML::Node *repr, Geom::Matrix const &transform, Geom::Matrix const *adv = NULL, bool compensate = true);
 
-void sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform);
+void sp_item_set_item_transform(SPItem *item, Geom::Matrix const &transform);
 
 void sp_item_convert_item_to_guides(SPItem *item);
 
@@ -251,16 +248,12 @@ gint sp_item_event (SPItem *item, SPEvent *event);
 NRArenaItem *sp_item_get_arenaitem(SPItem *item, unsigned int key);
 
 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);
+Geom::OptRect sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX);
 
 Geom::Matrix i2anc_affine(SPObject const *item, SPObject const *ancestor);
 Geom::Matrix i2i_affine(SPObject const *src, SPObject const *dest);
 
 Geom::Matrix sp_item_i2doc_affine(SPItem const *item);
-Geom::Matrix sp_item_i2root_affine(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 */
 
@@ -271,7 +264,6 @@ Geom::Matrix matrix_from_desktop (Geom::Matrix m, SPItem const *item);
  * \return TRANSFORM.
  */
 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);