// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef SEEN_LINE_SNAPPER_H
#define SEEN_LINE_SNAPPER_H
/*
 *    Authors:
 *      Carl Hetherington <inkscape@carlh.net>
 *      Diederik van Lierop <mail@diedenrezi.nl>
 *
 * 	  Copyright (C) 1999-2008 Authors
 *
 *    Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */

#include "snapper.h"

namespace Inkscape {

class SnapCandidatePoint;

/**
 * Superclass for snappers to horizontal and vertical lines.
 */
class LineSnapper : public Snapper
{
public:
  LineSnapper(SnapManager *sm, Geom::Coord const d);

  void freeSnap(IntermSnapResults &isr,
                   Inkscape::SnapCandidatePoint const &p,
                   Geom::OptRect const &bbox_to_snap,
                   std::vector<SPObject const *> const *it,
                   std::vector<Inkscape::SnapCandidatePoint> *unselected_nodes) const override;

  void constrainedSnap(IntermSnapResults &isr,
                          Inkscape::SnapCandidatePoint const &p,
                          Geom::OptRect const &bbox_to_snap,
                          SnapConstraint const &c,
                          std::vector<SPObject const *> const *it,
                          std::vector<SnapCandidatePoint> *unselected_nodes) const override;

protected:
  typedef std::list<std::pair<Geom::Point, Geom::Point> > LineList;
  //first point is a vector normal to the line
  //second point is a point on the line

private:
  /**
   *  \param p Point that we are trying to snap.
   *  \return List of lines that we should try snapping to.
   */
  virtual LineList _getSnapLines(Geom::Point const &p) const = 0;

  virtual void _addSnappedLine(IntermSnapResults &isr, 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;

  // Will only be implemented for guide lines, because grid lines don't have an origin
  virtual void _addSnappedLinesOrigin(IntermSnapResults &isr, Geom::Point const &origin, Geom::Coord const &snapped_distance, SnapSourceType const &source, long source_num, bool constrained_snap) const;

  virtual void _addSnappedLinePerpendicularly(IntermSnapResults &isr, Geom::Point const &snapped_point, Geom::Coord const &snapped_distance, SnapSourceType const &source, long source_num, bool constrained_snap) const = 0;
  virtual void _addSnappedPoint(IntermSnapResults &isr, Geom::Point const &snapped_point, Geom::Coord const &snapped_distance, SnapSourceType const &source, long source_num, bool constrained_snap) const = 0;
};

}

#endif /* !SEEN_LINE_SNAPPER_H */