src/line-snapper.h

   1 #ifndef SEEN_LINE_SNAPPER_H
   2 #define SEEN_LINE_SNAPPER_H
   3
   4 /**
   5  *    \file src/line-snapper.h
   6  *    \brief Superclass for snappers to horizontal and vertical lines.
   7  *
   8  *    Authors:
   9  *      Carl Hetherington <inkscape@carlh.net>
  10  *      Diederik van Lierop <mail@diedenrezi.nl>
  11  *
  12  *        Copyright (C) 1999-2008 Authors
  13  *
  14  *    Released under GNU GPL, read the file 'COPYING' for more information.
  15  */
  16
  17 #include "snapper.h"
  18
  19 namespace Inkscape
  20 {
  21 class SnapCandidatePoint;
  22
  23 class LineSnapper : public Snapper
  24 {
  25 public:
  26   LineSnapper(SnapManager *sm, Geom::Coord const d);
  27
  28   void freeSnap(SnappedConstraints &sc,
  29                    Inkscape::SnapCandidatePoint const &p,
  30                    Geom::OptRect const &bbox_to_snap,
  31                    std::vector<SPItem const *> const *it,
  32                    std::vector<Inkscape::SnapCandidatePoint> *unselected_nodes) const;
  33
  34   void constrainedSnap(SnappedConstraints &sc,
  35                           Inkscape::SnapCandidatePoint const &p,
  36                           Geom::OptRect const &bbox_to_snap,
  37                           SnapConstraint const &c,
  38                           std::vector<SPItem const *> const *it,
  39                           std::vector<SnapCandidatePoint> *unselected_nodes) const;
  40
  41 protected:
  42   typedef std::list<std::pair<Geom::Point, Geom::Point> > LineList;
  43   //first point is a vector normal to the line
  44   //second point is a point on the line
  45
  46 private:
  47   /**
  48    *  \param p Point that we are trying to snap.
  49    *  \return List of lines that we should try snapping to.
  50    */
  51   virtual LineList _getSnapLines(Geom::Point const &p) const = 0;
  52
  53   virtual void _addSnappedLine(SnappedConstraints &sc, Geom::Point const snapped_point, Geom::Coord const snapped_distance, SnapSourceType const &source, long source_num, Geom::Point const normal_to_line, Geom::Point const point_on_line) const = 0;
  54
  55   // Will only be implemented for guide lines, because grid lines don't have an origin
  56   virtual void _addSnappedLinesOrigin(SnappedConstraints &sc, Geom::Point const origin, Geom::Coord const snapped_distance, SnapSourceType const &source, long source_num, bool constrained_snap) const;
  57
  58   virtual void _addSnappedPoint(SnappedConstraints &sc, Geom::Point const snapped_point, Geom::Coord const snapped_distance, SnapSourceType const &source, long source_num, bool constrained_snap) const = 0;
  59 };
  60
  61 }
  62
  63 #endif /* !SEEN_LINE_SNAPPER_H */