LibrePCB Developers Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
path.h
Go to the documentation of this file.
1/*
2 * LibrePCB - Professional EDA for everyone!
3 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4 * https://librepcb.org/
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef LIBREPCB_CORE_PATH_H
21#define LIBREPCB_CORE_PATH_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
26#include "../exceptions.h"
27#include "vertex.h"
28
29#include <type_safe/constrained_type.hpp>
30
31#include <QtCore>
32#include <QtGui>
33
34/*******************************************************************************
35 * Namespace / Forward Declarations
36 ******************************************************************************/
37namespace librepcb {
38
39/*******************************************************************************
40 * Class Path
41 ******************************************************************************/
42
57class Path final {
58 Q_DECLARE_TR_FUNCTIONS(Path)
59
60public:
61 // Constructors / Destructor
62 Path() noexcept : mVertices(), mPainterPathPx() {}
63 Path(const Path& other) noexcept;
64 explicit Path(const QVector<Vertex>& vertices) noexcept
65 : mVertices(vertices) {}
66 explicit Path(const SExpression& node);
67 ~Path() noexcept {}
68
69 // Getters
70 bool isClosed() const noexcept;
71 bool isCurved() const noexcept;
72 bool isZeroLength() const noexcept;
73 bool isOnGrid(const PositiveLength& gridInterval) const noexcept;
74 QVector<Vertex>& getVertices() noexcept {
76 return mVertices;
77 }
78 const QVector<Vertex>& getVertices() const noexcept { return mVertices; }
80 qreal calcAreaOfStraightSegments() const noexcept;
81 Point calcNearestPointBetweenVertices(const Point& p) const noexcept;
82 Path cleaned() const noexcept;
83 Path toClosedPath() const noexcept;
84 Path toOpenPath() const noexcept;
85 QVector<Path> toOutlineStrokes(const PositiveLength& width) const noexcept;
86 const QPainterPath& toQPainterPathPx() const noexcept;
87 QString toSvgPathMm() const noexcept;
88
89 // Transformations
90 Path& translate(const Point& offset) noexcept;
91 Path translated(const Point& offset) const noexcept;
92 Path& mapToGrid(const PositiveLength& gridInterval) noexcept;
93 Path mappedToGrid(const PositiveLength& gridInterval) const noexcept;
94 Path& rotate(const Angle& angle, const Point& center = Point(0, 0)) noexcept;
95 Path rotated(const Angle& angle,
96 const Point& center = Point(0, 0)) const noexcept;
97 Path& mirror(Qt::Orientation orientation,
98 const Point& center = Point(0, 0)) noexcept;
99 Path mirrored(Qt::Orientation orientation,
100 const Point& center = Point(0, 0)) const noexcept;
101 Path& reverse() noexcept;
102 Path reversed() const noexcept;
103 Path& flattenArcs(const PositiveLength& maxTolerance) noexcept;
104 Path flattenedArcs(const PositiveLength& maxTolerance) const noexcept;
105
106 // General Methods
107 void addVertex(const Vertex& vertex) noexcept;
108 void addVertex(const Point& pos, const Angle& angle = Angle::deg0()) noexcept;
109 void insertVertex(int index, const Vertex& vertex) noexcept;
110 void insertVertex(int index, const Point& pos,
111 const Angle& angle = Angle::deg0()) noexcept;
112 bool clean() noexcept;
113 bool close() noexcept;
114 bool open() noexcept;
115
121 void serialize(SExpression& root) const;
122
123 // Operator Overloadings
124 Path& operator=(const Path& rhs) noexcept;
125 bool operator==(const Path& rhs) const noexcept {
126 return mVertices == rhs.mVertices;
127 }
128 bool operator!=(const Path& rhs) const noexcept { return !(*this == rhs); }
129
140 bool operator<(const Path& rhs) const noexcept;
141
142 // Static Methods
143 static Path line(const Point& p1, const Point& p2,
144 const Angle& angle = Angle::deg0()) noexcept;
145 static Path circle(const PositiveLength& diameter) noexcept;
146 static Path donut(const PositiveLength& outerDiameter,
147 const PositiveLength& innerDiameter) noexcept;
148 static Path obround(const PositiveLength& width,
149 const PositiveLength& height) noexcept;
150 static Path obround(const Point& p1, const Point& p2,
151 const PositiveLength& width) noexcept;
152 static Path arcObround(const Point& p1, const Point& p2, const Angle& angle,
153 const PositiveLength& width) noexcept;
154 static Path rect(const Point& p1, const Point& p2) noexcept;
155 static Path centeredRect(
156 const PositiveLength& width, const PositiveLength& height,
157 const UnsignedLength& cornerRadius = UnsignedLength(0)) noexcept;
158 static Path chamferedRect(const PositiveLength& width,
159 const PositiveLength& height,
160 const UnsignedLength& chamferSize, bool topLeft,
161 bool topRight, bool bottomLeft,
162 bool bottomRight) noexcept;
163 static Path trapezoid(const PositiveLength& width,
164 const PositiveLength& height, const Length& dw,
165 const Length dh) noexcept;
166 static Path octagon(
167 const PositiveLength& width, const PositiveLength& height,
168 const UnsignedLength& cornerRadius = UnsignedLength(0)) noexcept;
169 static Path flatArc(const Point& p1, const Point& p2, const Angle& angle,
170 const PositiveLength& maxTolerance) noexcept;
171
182 static QPainterPath toQPainterPathPx(const QVector<Path>& paths,
183 bool area) noexcept;
184
185private: // Methods
186 void invalidatePainterPath() const noexcept {
187 mPainterPathPx = QPainterPath();
188 }
189
190private: // Data
191 QVector<Vertex> mVertices;
192 mutable QPainterPath mPainterPathPx; // cached path for #toQPainterPathPx()
193};
194
195/*******************************************************************************
196 * Non-Member Functions
197 ******************************************************************************/
198
199inline std::size_t qHash(const Path& key, std::size_t seed = 0) noexcept {
200 return qHashRange(key.getVertices().begin(), key.getVertices().end(), seed);
201}
202
203/*******************************************************************************
204 * Class NonEmptyPath
205 ******************************************************************************/
206
208 template <typename Value, typename Predicate>
209 static constexpr auto verify(Value&& val, const Predicate& p) ->
210 typename std::decay<Value>::type {
211 return p(val)
212 ? std::forward<Value>(val)
213 : (throw RuntimeError(__FILE__, __LINE__,
214 Path::tr("Path doesn't contain vertices!")),
215 std::forward<Value>(val));
216 }
217};
218
220 bool operator()(const Path& p) const noexcept {
221 return p.getVertices().count() > 0;
222 }
223};
224
232using NonEmptyPath = type_safe::constrained_type<Path, NonEmptyPathConstraint,
234
235inline std::size_t qHash(const NonEmptyPath& key,
236 std::size_t seed = 0) noexcept {
237 return ::qHash(*key, seed);
238}
239
240inline NonEmptyPath makeNonEmptyPath(const Point& pos) noexcept {
241 return NonEmptyPath(Path({Vertex(pos)}));
242}
243
244/*******************************************************************************
245 * Class StraightAreaPath
246 ******************************************************************************/
247
249 template <typename Value, typename Predicate>
250 static constexpr auto verify(Value&& val, const Predicate& p) ->
251 typename std::decay<Value>::type {
252 return p(val) ? std::forward<Value>(val)
253 : (throw RuntimeError(
254 __FILE__, __LINE__,
255 Path::tr("Path is not fillable or contains arcs!")),
256 std::forward<Value>(val));
257 }
258};
259
261 bool operator()(const Path& p) const noexcept {
262 return (p.getVertices().count() >= 4) && p.isClosed() && (!p.isCurved());
263 }
264};
265
275 type_safe::constrained_type<Path, StraightAreaPathConstraint,
277
278inline std::size_t qHash(const StraightAreaPath& key,
279 std::size_t seed = 0) noexcept {
280 return ::qHash(*key, seed);
281}
282
283/*******************************************************************************
284 * End of File
285 ******************************************************************************/
286
287} // namespace librepcb
288
289Q_DECLARE_METATYPE(librepcb::Path)
290
291#endif
The Angle class is used to represent an angle (for example 12.75 degrees)
Definition angle.h:76
static Angle deg0() noexcept
0 degrees
Definition angle.h:349
The Length class is used to represent a length (for example 12.75 millimeters)
Definition length.h:82
The Path class represents a list of vertices connected by straight lines or circular arc segments.
Definition path.h:57
Path reversed() const noexcept
Definition path.cpp:309
Path toOpenPath() const noexcept
Definition path.cpp:152
static Path trapezoid(const PositiveLength &width, const PositiveLength &height, const Length &dw, const Length dh) noexcept
Definition path.cpp:591
QVector< Path > toOutlineStrokes(const PositiveLength &width) const noexcept
Definition path.cpp:158
Path & mirror(Qt::Orientation orientation, const Point &center=Point(0, 0)) noexcept
Definition path.cpp:283
Path flattenedArcs(const PositiveLength &maxTolerance) const noexcept
Definition path.cpp:333
const QPainterPath & toQPainterPathPx() const noexcept
Definition path.cpp:178
static Path octagon(const PositiveLength &width, const PositiveLength &height, const UnsignedLength &cornerRadius=UnsignedLength(0)) noexcept
Definition path.cpp:611
const QVector< Vertex > & getVertices() const noexcept
Definition path.h:78
Path & reverse() noexcept
Definition path.cpp:297
static Path donut(const PositiveLength &outerDiameter, const PositiveLength &innerDiameter) noexcept
Definition path.cpp:426
QVector< Vertex > & getVertices() noexcept
Definition path.h:74
bool operator<(const Path &rhs) const noexcept
The "<" operator to compare two librepcb::Path objects.
Definition path.cpp:410
QVector< Vertex > mVertices
Definition path.h:191
static Path rect(const Point &p1, const Point &p2) noexcept
Definition path.cpp:513
Path translated(const Point &offset) const noexcept
Definition path.cpp:255
Path & flattenArcs(const PositiveLength &maxTolerance) noexcept
Definition path.cpp:313
Path mirrored(Qt::Orientation orientation, const Point &center=Point(0, 0)) const noexcept
Definition path.cpp:292
static Path arcObround(const Point &p1, const Point &p2, const Angle &angle, const PositiveLength &width) noexcept
Definition path.cpp:478
bool clean() noexcept
Definition path.cpp:360
bool close() noexcept
Definition path.cpp:373
Path & mapToGrid(const PositiveLength &gridInterval) noexcept
Definition path.cpp:259
static Path chamferedRect(const PositiveLength &width, const PositiveLength &height, const UnsignedLength &chamferSize, bool topLeft, bool topRight, bool bottomLeft, bool bottomRight) noexcept
Definition path.cpp:553
static Path centeredRect(const PositiveLength &width, const PositiveLength &height, const UnsignedLength &cornerRadius=UnsignedLength(0)) noexcept
Definition path.cpp:523
Path cleaned() const noexcept
Definition path.cpp:140
void insertVertex(int index, const Vertex &vertex) noexcept
Definition path.cpp:350
static Path flatArc(const Point &p1, const Point &p2, const Angle &angle, const PositiveLength &maxTolerance) noexcept
Definition path.cpp:662
Point calcNearestPointBetweenVertices(const Point &p) const noexcept
Definition path.cpp:123
bool isZeroLength() const noexcept
Definition path.cpp:73
Path mappedToGrid(const PositiveLength &gridInterval) const noexcept
Definition path.cpp:267
QString toSvgPathMm() const noexcept
Definition path.cpp:208
Path() noexcept
Definition path.h:62
static Path circle(const PositiveLength &diameter) noexcept
Definition path.cpp:422
Path(const QVector< Vertex > &vertices) noexcept
Definition path.h:64
static Path line(const Point &p1, const Point &p2, const Angle &angle=Angle::deg0()) noexcept
Definition path.cpp:418
void invalidatePainterPath() const noexcept
Definition path.h:186
qreal calcAreaOfStraightSegments() const noexcept
Definition path.cpp:108
Path & rotate(const Angle &angle, const Point &center=Point(0, 0)) noexcept
Definition path.cpp:271
QPainterPath mPainterPathPx
Definition path.h:192
static Path obround(const PositiveLength &width, const PositiveLength &height) noexcept
Definition path.cpp:443
void addVertex(const Vertex &vertex) noexcept
Definition path.cpp:341
~Path() noexcept
Definition path.h:67
Path rotated(const Angle &angle, const Point &center=Point(0, 0)) const noexcept
Definition path.cpp:279
void serialize(SExpression &root) const
Serialize into librepcb::SExpression node.
Definition path.cpp:392
bool isOnGrid(const PositiveLength &gridInterval) const noexcept
Definition path.cpp:86
Path & translate(const Point &offset) noexcept
Definition path.cpp:247
bool isCurved() const noexcept
Definition path.cpp:63
UnsignedLength getTotalStraightLength() const noexcept
Definition path.cpp:95
bool open() noexcept
Definition path.cpp:383
bool operator!=(const Path &rhs) const noexcept
Definition path.h:128
bool isClosed() const noexcept
Definition path.cpp:55
Path toClosedPath() const noexcept
Definition path.cpp:146
The Point class is used to represent a point/coordinate/vector, for example (1.2mm; 5....
Definition point.h:78
The RuntimeError class.
Definition exceptions.h:218
The SExpression class.
Definition sexpression.h:69
The Vertex class.
Definition vertex.h:43
Definition occmodel.cpp:77
std::size_t qHash(const AttributeKey &key, std::size_t seed=0) noexcept
Definition attributekey.h:118
type_safe::constrained_type< Length, PositiveLengthConstraint, PositiveLengthVerifier > PositiveLength
Definition length.h:810
type_safe::constrained_type< Path, NonEmptyPathConstraint, NonEmptyPathVerifier > NonEmptyPath
Definition path.h:233
type_safe::constrained_type< Length, UnsignedLengthConstraint, UnsignedLengthVerifier > UnsignedLength
Definition length.h:694
type_safe::constrained_type< Path, StraightAreaPathConstraint, StraightAreaPathVerifier > StraightAreaPath
Definition path.h:276
NonEmptyPath makeNonEmptyPath(const Point &pos) noexcept
Definition path.h:240
bool operator()(const Path &p) const noexcept
Definition path.h:220
Definition path.h:207
static constexpr auto verify(Value &&val, const Predicate &p) -> typename std::decay< Value >::type
Definition path.h:209
bool operator()(const Path &p) const noexcept
Definition path.h:261
static constexpr auto verify(Value &&val, const Predicate &p) -> typename std::decay< Value >::type
Definition path.h:250