object-snapper.cpp revision e8f467c9c30a028b10ca166c02e49df62bf753c2
/**
* \file object-snapper.cpp
* \brief Snapping things to objects.
*
* Authors:
* Carl Hetherington <inkscape@carlh.net>
* Diederik van Lierop <mail@diedenrezi.nl>
*
* Copyright (C) 2005 - 2008 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include "libnr/nr-rect-ops.h"
#include "libnr/nr-point-fns.h"
#include "document.h"
#include "sp-namedview.h"
#include "sp-image.h"
#include "sp-item-group.h"
#include "sp-item.h"
#include "sp-use.h"
#include "inkscape.h"
#include "preferences.h"
#include "sp-text.h"
#include "sp-flowtext.h"
#include "text-editing.h"
#include "sp-clippath.h"
#include "sp-mask.h"
#include "helper/geom-curves.h"
#include "desktop.h"
Inkscape::SnapCandidate::SnapCandidate(SPItem* item, bool clip_or_mask, Geom::Matrix additional_affine)
{
}
{
}
_strict_snapping(true)
{
}
{
_candidates->clear();
delete _candidates;
delete _points_to_snap_to;
_clear_paths();
delete _paths_to_snap_to;
}
/**
* Find all items within snapping range.
* \param parent Pointer to the document's root, or to a clipped path or mask object
* \param it List of items to ignore
* \param first_point If true then this point is the first one from a whole bunch of points
* \param bbox_to_snap Bounding box hulling the whole bunch of points, all from the same selection and having the same transformation
* \param DimensionToSnap Snap in X, Y, or both directions.
*/
bool const &first_point,
DimensionToSnap const snap_dim,
bool const clip_or_mask,
{
return;
}
if (first_point) {
_candidates->clear();
}
if (SP_IS_ITEM(o) && !SP_ITEM(o)->isLocked() && !(_snapmanager->getDesktop()->itemIsHidden(SP_ITEM(o)) && !clip_or_mask)) {
// Don't snap to locked items, and
// don't snap to hidden objects, unless they're a clipped path or a mask
/* See if this item is on the ignore list */
i++;
}
}
if (item) {
if (!clip_or_mask) { // cannot clip or mask more than once
// The current item is not a clipping path or a mask, but might
// still be the subject of clipping or masking itself ; if so, then
// we should also consider that path or mask for snapping to
if (obj) {
}
if (obj) {
}
}
}
if (SP_IS_GROUP(o)) {
} else {
if (clip_or_mask) {
// Oh oh, this will get ugly. We cannot use sp_item_i2d_affine directly because we need to
// insert an additional transformation in document coordinates (code copied from sp_item_i2d_affine)
true);
} else {
}
if (bbox_of_item) {
// See if the item is within range
// This item is within snapping range, so record it as a candidate
}
}
}
}
}
}
}
bool const &first_point) const
{
// Now, let's first collect all points to snap to. If we have a whole bunch of points to snap,
// e.g. when translating an item using the selector tool, then we will only do this for the
// first point and store the collection for later use. This significantly improves the performance
if (first_point) {
// Determine the type of bounding box we should snap to
// A point considered for snapping should be either a node, a bbox corner or a guide. Pick only ONE!
g_assert(!((p_is_a_node && p_is_a_bbox) || (p_is_a_bbox && p_is_a_guide) || (p_is_a_node && p_is_a_guide)));
if (_snap_to_bboxnode) {
bbox_type = !prefs_bbox ?
}
// Consider the page border for snapping
if (_snap_to_page_border) {
}
for (std::vector<SnapCandidate>::const_iterator i = _candidates->begin(); i != _candidates->end(); i++) {
//Geom::Matrix i2doc(Geom::identity());
}
//Collect all nodes so we can snap to them
if (_snap_to_itemnode) {
// Note: there are two ways in which intersections are considered:
// Method 1: Intersections are calculated for each shape individually, for both the
// snap source and snap target (see sp_shape_snappoints)
// Method 2: Intersections are calculated for each curve or line that we've snapped to, i.e. only for
// the target (see the intersect() method in the SnappedCurve and SnappedLine classes)
// Some differences:
// - Method 1 doesn't find intersections within a set of multiple objects
// - Method 2 only works for targets
// When considering intersections as snap targets:
// - Method 1 only works when snapping to nodes, whereas
// - Method 2 only works when snapping to paths
// - There will be performance differences too!
// If both methods are being used simultaneously, then this might lead to duplicate targets!
// Well, here we will be looking for snap TARGETS. Both methods can therefore be used.
// When snapping to paths, we will get a collection of snapped lines and snapped curves. findBestSnap() will
// go hunting for intersections (but only when asked to in the prefs of course). In that case we can just
// temporarily block the intersections in sp_item_snappoints, we don't need duplicates. If we're not snapping to
// paths though but only to item nodes then we should still look for the intersections in sp_item_snappoints()
if (_snap_to_itempath) {
}
if (_snap_to_itempath) {
}
}
}
//Collect the bounding box's corners so we can snap to them
if (_snap_to_bboxnode) {
// Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
// of the item AND the bbox of the clipping path at the same time
if (!(*i).clip_or_mask) {
if (b) {
for ( unsigned k = 0 ; k < 4 ; k++ ) {
}
}
}
}
}
}
}
}
bool const &first_point,
{
// Iterate through all nodes, find out which one is the closest to p, and snap to it!
_collectNodes(t, first_point);
if (unselected_nodes != NULL) {
_points_to_snap_to->insert(_points_to_snap_to->end(), unselected_nodes->begin(), unselected_nodes->end());
}
SnappedPoint s;
bool success = false;
for (std::vector<Geom::Point>::const_iterator k = _points_to_snap_to->begin(); k != _points_to_snap_to->end(); k++) {
success = true;
}
}
if (success) {
}
}
{
// Iterate through all nodes, find out which one is the closest to this guide, and snap to it!
_collectNodes(t, true);
SnappedPoint s;
bool success = false;
for (std::vector<Geom::Point>::const_iterator k = _points_to_snap_to->begin(); k != _points_to_snap_to->end(); k++) {
// Project each node (*k) on the guide line (running through point p)
Geom::Coord dist2 = Geom::L2(p - p_proj); // distance from projection of node on the guide, to the mouse location
success = true;
}
}
if (success) {
}
}
/**
* Returns index of first NR_END bpath in array.
*/
bool const &first_point) const
{
// Now, let's first collect all paths to snap to. If we have a whole bunch of points to snap,
// e.g. when translating an item using the selector tool, then we will only do this for the
// first point and store the collection for later use. This significantly improves the performance
if (first_point) {
_clear_paths();
// Determine the type of bounding box we should snap to
if (_snap_to_bboxpath) {
bbox_type = !prefs_bbox ?
}
// Consider the page border for snapping
if (_snap_to_page_border) {
if (border_path != NULL) {
}
}
for (std::vector<SnapCandidate>::const_iterator i = _candidates->begin(); i != _candidates->end(); i++) {
/* Transform the requested snap point to this item's coordinates */
/* We might have a clone at hand, so make sure we get the root item */
} else {
}
//Build a list of all paths considered for snapping to
//Add the item's path to snap to
if (_snap_to_itempath) {
if (!(_strict_snapping && !p_is_a_node)) {
// Snapping to the path of characters is very cool, but for a large
// chunk of text this will take ages! So limit snapping to text paths
// containing max. 240 characters. Snapping the bbox will not be affected
bool very_lenghty_prose = false;
}
// On my AMD 3000+, the snapping lag becomes annoying at approx. 240 chars
// which corresponds to a lag of 500 msec. This is for snapping a rect
// to a single line of text.
// Snapping for example to a traced bitmap is also very stressing for
// the CPU, so we'll only snap to paths having no more than 500 nodes
// This also leads to a lag of approx. 500 msec (in my lousy test set-up).
bool very_complex_path = false;
if (SP_IS_PATH(root_item)) {
}
if (!very_lenghty_prose && !very_complex_path) {
if (curve) {
// We will get our own copy of the path, which must be freed at some point
Geom::PathVector *borderpathv = pathvector_for_curve(root_item, curve, true, true, Geom::identity(), (*i).additional_affine);
_paths_to_snap_to->push_back(borderpathv); // Perhaps for speed, get a reference to the Geom::pathvector, and store the transformation besides it.
}
}
}
}
//Add the item's bounding box to snap to
if (_snap_to_bboxpath) {
if (!(_strict_snapping && p_is_a_node)) {
// Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
// of the item AND the bbox of the clipping path at the same time
if (!(*i).clip_or_mask) {
if (rect) {
}
}
}
}
}
}
}
bool const &first_point,
SPPath const *selected_path) const
{
_collectPaths(t, first_point);
// Now we can finally do the real snapping, using the paths collected above
if (first_point) {
/* findCandidates() is used for snapping to both paths and nodes. It ignores the path that is
* currently being edited, because that path requires special care: when snapping to nodes
* only the unselected nodes of that path should be considered, and these will be passed on separately.
* This path must not be ignored however when snapping to the paths, so we add it here
* manually when applicable.
*
* Note that this path must be the last in line!
* */
if (node_tool_active) {
if (curve) {
Geom::PathVector *pathv = pathvector_for_curve(SP_ITEM(selected_path), curve, true, true, Geom::identity(), Geom::identity()); // We will get our own copy of the path, which must be freed at some point
}
}
}
for (std::vector<Geom::PathVector*>::const_iterator it_p = _paths_to_snap_to->begin(); it_p != _paths_to_snap_to->end(); it_p++) {
//if true then this pathvector it_pv is currently being edited in the node tool
// char * svgd = sp_svg_write_path(**it_p);
// std::cout << "Dumping the pathvector: " << svgd << std::endl;
// Find a nearest point for each curve within this path
// n curves will return n time values with 0 <= t <= 1
unsigned int index = 0;
bool c1 = true;
bool c2 = true;
if (being_edited) {
/* If the path is being edited, then we should only snap though to stationary pieces of the path
* and not to the pieces that are being dragged around. This way we avoid
* self-snapping. For this we check whether the nodes at both ends of the current
* piece are unselected; if they are then this piece must be stationary
*/
/* Unfortunately, this might yield false positives for coincident nodes. Inkscape might therefore mistakenly
* snap to path segments that are not stationary. There are at least two possible ways to overcome this:
* - Linking the individual nodes of the SPPath we have here, to the nodes of the NodePath::SubPath class as being
* used in sp_nodepath_selected_nodes_move. This class has a member variable called "selected". For this the nodes
* should be in the exact same order for both classes, so we can index them
* - Replacing the SPPath being used here by the the NodePath::SubPath class; but how?
*/
}
if (dist < getSnapperTolerance()) {
sc.curves.push_back(Inkscape::SnappedCurve(from_2geom(sp_dt), dist, getSnapperTolerance(), getSnapperAlwaysSnap(), false, curve));
}
}
}
} // End of: for (Geom::PathVector::iterator ....)
}
}
/* Returns true if point is coincident with one of the unselected nodes */
bool Inkscape::ObjectSnapper::isUnselectedNode(Geom::Point const &point, std::vector<Geom::Point> const *unselected_nodes) const
{
if (unselected_nodes == NULL) {
return false;
}
if (unselected_nodes->size() == 0) {
return false;
}
for (std::vector<Geom::Point>::const_iterator i = unselected_nodes->begin(); i != unselected_nodes->end(); i++) {
return true;
}
}
return false;
}
bool const &first_point,
ConstraintLine const &c) const
{
_collectPaths(t, first_point);
// Now we can finally do the real snapping, using the paths collected above
if (!is_zero(direction_vector)) {
}
// The intersection point of the constraint line with any path,
// must lie within two points on the constraintline: p_min_on_cl and p_max_on_cl
// The distance between those points is twice the snapping tolerance
Geom::Point const p_min_on_cl = _snapmanager->getDesktop()->dt2doc(p_proj_on_cl - getSnapperTolerance() * direction_vector);
Geom::Point const p_max_on_cl = _snapmanager->getDesktop()->dt2doc(p_proj_on_cl + getSnapperTolerance() * direction_vector);
for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
if (*k) {
// We need only the first element of cs, because cl is only a single straight linesegment
// This first element contains a vector filled with crossings of cl with *k
// Reconstruct the point of intersection
// When it's within snapping range, then return it
// (within snapping range == between p_min_on_cl and p_max_on_cl == 0 < ta < 1)
SnappedPoint s(_snapmanager->getDesktop()->doc2dt(p_inters), SNAPTARGET_PATH, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
}
}
}
}
}
}
bool const &first_point,
{
return;
}
/* Get a list of all the SPItems that we will try to snap to */
if (first_point) {
_findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
}
}
if (n > 0) {
/* While editing a path in the node tool, findCandidates must ignore that path because
* of the node snapping requirements (i.e. only unselected nodes must be snapable).
* That path must not be ignored however when snapping to the paths, so we add it here
* manually when applicable
*/
}
} else {
}
}
}
bool const &first_point,
ConstraintLine const &c,
{
return;
}
/* Get a list of all the SPItems that we will try to snap to */
if (first_point) {
_findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
}
// A constrained snap, is a snap in only one degree of freedom (specified by the constraint line).
// This is usefull for example when scaling an object while maintaining a fixed aspect ratio. It's
// nodes are only allowed to move in one direction (i.e. in one degree of freedom).
// When snapping to objects, we either snap to their nodes or their paths. It is however very
// unlikely that any node will be exactly at the constrained line, so for a constrained snap
// to objects we will only consider the object's paths. Beside, the nodes will be at these paths,
// so we will more or less snap to them anyhow.
}
}
// This method is used to snap a guide to nodes, while dragging the guide around
{
/* Get a list of all the SPItems that we will try to snap to */
} else {
}
// We don't support ANGLED_GUIDE_ROT_SNAP yet.
// It would be cool to allow the user to rotate a guide by dragging it, instead of
// only translating it. (For example when CTRL is pressed). We will need an UI part
// for that first; and some important usability choices need to be made:
// E.g. which point should be used for pivoting? A previously snapped point,
// or a transformation center (which can be moved after clicking for the
// second time on an object; but should this point then be constrained to the
// line, or can it be located anywhere?)
_findCandidates(sp_document_root(_snapmanager->getDocument()), &it, true, Geom::Rect(p, p), snap_dim, false, Geom::identity());
// _snapRotatingGuideToNodes has not been implemented yet.
}
/**
* \return true if this Snapper will snap at least one kind of point.
*/
{
bool snap_to_something = _snap_to_itempath || _snap_to_itemnode || _snap_to_bboxpath || _snap_to_bboxnode || _snap_to_page_border;
}
{
}
{
for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
g_free(*k);
}
}
{
Geom::Rect const border_rect = Geom::Rect(Geom::Point(0,0), Geom::Point(sp_document_width(_snapmanager->getDocument()),sp_document_height(_snapmanager->getDocument())));
return _getPathvFromRect(border_rect);
}
{
if (border_curve) {
return dummy;
} else {
return NULL;
}
}
{
}
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :