snap.h revision 700fe8603c02a9d683dd7b1ccdfae489b61ea2c2
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#ifndef SEEN_SNAP_H
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#define SEEN_SNAP_H
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm/**
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * \file snap.h
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * \brief SnapManager class.
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm *
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Authors:
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Lauris Kaplinski <lauris@kaplinski.com>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Frank Felfe <innerspace@iname.com>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Carl Hetherington <inkscape@carlh.net>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Diederik van Lierop <mail@diedenrezi.nl>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm *
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Copyright (C) 2000-2002 Lauris Kaplinski
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Copyright (C) 2000-2008 Authors
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm *
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Released under GNU GPL, read the file 'COPYING' for more information
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm */
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include <vector>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include <libnr/nr-coord.h>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include <libnr/nr-dim2.h>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include <libnr/nr-forward.h>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include <libnr/nr-scale.h>
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include "guide-snapper.h"
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#include "object-snapper.h"
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrmclass SPNamedView;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm/// Class to coordinate snapping operations
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm/**
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * Each SPNamedView has one of these. It offers methods to snap points to whatever
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * snappers are defined (e.g. grid, guides etc.). It also allows callers to snap
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm * points which have undergone some transformation (e.g. translation, scaling etc.)
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm */
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrmclass SnapManager
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm{
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrmpublic:
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SnapManager(SPNamedView const *v);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm typedef std::list<const Inkscape::Snapper*> SnapperList;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool SomeSnapperMightSnap() const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setup(SPDesktop const *desktop, bool snapindicator = true, SPItem const *item_to_ignore = NULL, std::vector<Geom::Point> *unselected_nodes = NULL);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setup(SPDesktop const *desktop, bool snapindicator, std::vector<SPItem const *> &items_to_ignore, std::vector<Geom::Point> *unselected_nodes = NULL);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm // freeSnapReturnByRef() is preferred over freeSnap(), because it only returns a
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm // point if snapping has occured (by overwriting p); otherwise p is untouched
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void freeSnapReturnByRef(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool first_point = true,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm boost::optional<Geom::Rect> const &bbox_to_snap = boost::optional<Geom::Rect>()) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint freeSnap(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool first_point = true,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm boost::optional<Geom::Rect> const &bbox_to_snap = boost::optional<Geom::Rect>() ) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point multipleOfGridPitch(Geom::Point const &t) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm // constrainedSnapReturnByRef() is preferred over constrainedSnap(), because it only returns a
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm // point, by overwriting p, if snapping has occured; otherwise p is untouched
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void constrainedSnapReturnByRef(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::Snapper::ConstraintLine const &constraint,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool first_point = true,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm boost::optional<Geom::Rect> const &bbox_to_snap = boost::optional<Geom::Rect>()) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint constrainedSnap(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::Snapper::ConstraintLine const &constraint,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool first_point = true,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm boost::optional<Geom::Rect> const &bbox_to_snap = boost::optional<Geom::Rect>()) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void guideSnap(Geom::Point &p, Geom::Point const &guide_normal) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint freeSnapTranslation(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &tr) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint constrainedSnapTranslation(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::Snapper::ConstraintLine const &constraint,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &tr) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint freeSnapScale(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Scale const &s,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &o) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint constrainedSnapScale(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Scale const &s,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &o) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint constrainedSnapStretch(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Coord const &s,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &o,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Dim2 d,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool uniform) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint constrainedSnapSkew(Inkscape::Snapper::PointType point_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &p,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::Snapper::ConstraintLine const &constraint,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &s, // s[0] = skew factor, s[1] = scale factor
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &o,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Dim2 d) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::GuideSnapper guide; ///< guide snapper
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::ObjectSnapper object; ///< snapper to other objects
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SnapperList getSnappers() const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SnapperList getGridSnappers() const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setSnapModeBBox(bool enabled);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setSnapModeNode(bool enabled);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setSnapModeGuide(bool enabled);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getSnapModeBBox() const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getSnapModeNode() const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getSnapModeGuide() const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setSnapIntersectionGG(bool enabled) {_intersectionGG = enabled;}
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setSnapIntersectionCS(bool enabled) {_intersectionCS = enabled;}
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getSnapIntersectionGG() {return _intersectionGG;}
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getSnapIntersectionCS() {return _intersectionCS;}
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setIncludeItemCenter(bool enabled) {
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm _include_item_center = enabled;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm // also store a local copy in the object-snapper instead of passing it through many functions
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm object.setIncludeItemCenter(enabled);
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm }
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getIncludeItemCenter() const {
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm return _include_item_center;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm }
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void setSnapEnabledGlobally(bool enabled) {
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm _snap_enabled_globally = enabled;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm }
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool getSnapEnabledGlobally() const {
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm return _snap_enabled_globally;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm }
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm void toggleSnapEnabledGlobally() {
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm _snap_enabled_globally = !_snap_enabled_globally;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm }
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrmprotected:
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SPNamedView const *_named_view;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrmprivate:
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm enum Transformation {
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm TRANSLATION,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SCALE,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm STRETCH,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SKEW
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm };
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool _include_item_center; //If true, snapping nodes will also snap the item's center
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool _intersectionGG;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool _intersectionCS;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool _snap_enabled_globally; //Toggles ALL snapping
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<SPItem const *> *_items_to_ignore;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SPItem const *_item_to_ignore;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm SPDesktop const *_desktop;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool _snapindicator;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> *_unselected_nodes;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint _snapTransformed(Inkscape::Snapper::PointType type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm std::vector<Geom::Point> const &points,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool constrained,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::Snapper::ConstraintLine const &constraint,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Transformation transformation_type,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &transformation,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Point const &origin,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Geom::Dim2 dim,
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm bool uniform) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Inkscape::SnappedPoint findBestSnap(Geom::Point const &p, SnappedConstraints &sc, bool constrained) const;
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm};
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm#endif /* !SEEN_SNAP_H */
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm/*
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm Local Variables:
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm mode:c++
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm c-file-style:"stroustrup"
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm indent-tabs-mode:nil
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm fill-column:99
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm End:
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm*/
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :
da58597f9f9ecb17c4f545c4483a844a363bcc27pjrm