netsegmentsimplifier.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_NETSEGMENTSIMPLIFIER_H
#define LIBREPCB_CORE_NETSEGMENTSIMPLIFIER_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../types/point.h"
 
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class Layer;
 
/*******************************************************************************
 *  Class NetSegmentSimplifier
 ******************************************************************************/
 
class NetSegmentSimplifier final {
  Q_DECLARE_TR_FUNCTIONS(NetSegmentSimplifier)
 
public:
  // Types
  enum class AnchorType : int {
    // Value is important for the sort algorithm, do not change!
    Via = 0,
    Fixed = 1,
    Junction = 2,
  };
  struct Line {
    int id = 0;
    int p1 = 0;
    int p2 = 0;
    const Layer* layer = nullptr;
    Length width;
    bool modified = false;
  };
  struct Result {
    QList<Line> lines;
    QMap<int, Point> newJunctions;
    QSet<int> disconnectedFixedAnchors;
    bool modified = false;
  };
 
  // Constructors / Destructor
 
  NetSegmentSimplifier() noexcept;
 
  NetSegmentSimplifier(const NetSegmentSimplifier& other) = delete;
 
  ~NetSegmentSimplifier() noexcept;
 
  int addAnchor(AnchorType type, const Point& pos, const Layer* start,
                const Layer* end) noexcept;
 
  int addLine(int p1, int p2, const Layer* layer, const Length& width) noexcept;
 
  Result simplify() noexcept;
 
  // Operator overloadings
  NetSegmentSimplifier& operator=(const NetSegmentSimplifier& rhs) = delete;
 
private:
  // Types
  struct Anchor {
    int id = 0;
    AnchorType type = AnchorType::Junction;
    Point pos;
    const Layer* startLayer = nullptr;
    const Layer* endLayer = nullptr;
    bool isNew = false;
  };
 
  // Methods
  QSet<int> getConnectedFixedAnchors() const noexcept;
  void addJunctionsAtLineIntersections() noexcept;
  void splitLinesAtAnchors() noexcept;
  void removeDuplicateJunctions() noexcept;
  void removeRedundantLines() noexcept;
  bool mergeNextLines() noexcept;
  const Anchor* findAnchor(const Point& pos, const Layer* layer) noexcept;
  static bool isAnchorOnLayer(const Anchor& anchor,
                              const Layer* layer) noexcept;
  static bool isStraightLine(const Point& p0, const Point& p1,
                             const Point& p2) noexcept;
 
  // Data input
  QList<Anchor> mAnchors;
  QMap<int, Line> mLines;
  int mNextFreeLineId;
 
  // State
  QHash<Point, QVector<Anchor>> mAnchorMap;
  QSet<int> mPinsOrPads;
  bool mModified;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif