snap.h revision ac4bd992c7d196c7abdc858f0e00ab09e305213b
#ifndef SEEN_SNAP_H
#define SEEN_SNAP_H
/**
* \file snap.h
* \brief SnapManager class.
*
* The SnapManager class handles most (if not all) of the interfacing of the snapping mechanisms with the
* other parts of the code base. It stores the references to the various types of snappers for grid, guides
* and objects, and it stores most of the snapping preferences. Besides that it provides methods to setup
* the snapping environment (e.g. keeps a list of the items to ignore when looking for snap target candidates,
* and toggling of the snap indicator), and it provides many different methods for the snapping itself (free
* snapping vs. constrained snapping, returning the result by reference or through a return statement, etc.)
*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Frank Felfe <innerspace@iname.com>
* Carl Hetherington <inkscape@carlh.net>
* Diederik van Lierop <mail@diedenrezi.nl>
*
* Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
* Copyright (C) 2000-2002 Lauris Kaplinski
* Copyright (C) 2000-2009 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include <vector>
#include "guide-snapper.h"
#include "object-snapper.h"
#include "snap-preferences.h"
/* Guides */
enum SPGuideDragType { // used both here and in desktop-events.cpp
};
/// Class to coordinate snapping operations
/**
* Each SPNamedView has one of these. It offers methods to snap points to whatever
* snappers are defined (e.g. grid, guides etc.). It also allows callers to snap
* points which have undergone some transformation (e.g. translation, scaling etc.)
*/
{
enum Transformation {
};
SnapManager(SPNamedView const *v);
bool someSnapperMightSnap() const;
bool gridSnapperMightSnap() const;
bool snapindicator = true,
bool snapindicator,
// freeSnapReturnByRef() is preferred over freeSnap(), because it only returns a
// point if snapping has occurred (by overwriting p); otherwise p is untouched
bool first_point = true,
bool first_point = true,
// constrainedSnapReturnByRef() is preferred over constrainedSnap(), because it only returns a
// point, by overwriting p, if snapping has occurred; otherwise p is untouched
bool first_point = true,
bool first_point = true,
void guideFreeSnap(Geom::Point &p, Geom::Point const &guide_normal, SPGuideDragType drag_type) const;
bool uniform) const;
SnapperList getSnappers() const;
SnapperList getGridSnappers() const;
SPDocument *getDocument() const;
bool getSnapIndicator() const {return _snapindicator;}
SPNamedView const *_named_view;
std::vector<SPItem const *> *_items_to_ignore; ///< Items that should not be snapped to, for example the items that are currently being dragged. Set using the setup() method
SPItem const *_item_to_ignore; ///< Single item that should not be snapped to. If not NULL then this takes precedence over _items_to_ignore. Set using the setup() method
SPGuide *_guide_to_ignore; ///< A guide that should not be snapped to, e.g. the guide that is currently being dragged
bool _snapindicator; ///< When true, an indicator will be drawn at the position that was being snapped to
std::vector<std::pair<Geom::Point, int> > *_unselected_nodes; ///< Nodes of the path that is currently being edited and which have not been selected and which will therefore be stationary. Only these nodes will be considered for snapping to. Of each unselected node both the position (Geom::Point) and the type (Inkscape::SnapTargetType) will be stored
//TODO: Make _unselected_nodes type safe; in the line above int is used for Inkscape::SnapTargetType, but if I remember
//correctly then in other cases the int is being used for Inkscape::SnapSourceType, or for both. How to make
//this type safe?
bool constrained,
bool uniform) const;
bool const uniform) const;
void _displaySnapsource(Inkscape::SnapPreferences::PointType point_type, std::pair<Geom::Point, int> const &p) const;
Inkscape::SnappedPoint findBestSnap(Geom::Point const &p, Inkscape::SnapSourceType const source_type, SnappedConstraints &sc, bool constrained, bool noCurves = false) const;
};
#endif /* !SEEN_SNAP_H */
/*
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 :