KiCad PCB EDA Suite
Loading...
Searching...
No Matches
shape_arc.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 CERN
5 * Copyright (C) 2019-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Tomasz Wlostowski <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#ifndef __SHAPE_ARC_H
27#define __SHAPE_ARC_H
28
29#include <geometry/shape.h>
30#include <base_units.h>
31#include <math/vector2d.h> // for VECTOR2I
32#include <geometry/eda_angle.h>
33
35
36class SHAPE_ARC : public SHAPE
37{
38public:
39
41 SHAPE( SH_ARC ),
42 m_width( 0 ),
43 m_radius( 0 )
44 {};
45
57 SHAPE_ARC( const VECTOR2I& aArcCenter, const VECTOR2I& aArcStartPoint,
58 const EDA_ANGLE& aCenterAngle, int aWidth = 0 );
59
66 SHAPE_ARC( const VECTOR2I& aArcStart, const VECTOR2I& aArcMid, const VECTOR2I& aArcEnd,
67 int aWidth );
68
77 SHAPE_ARC( const SEG& aSegmentA, const SEG& aSegmentB, int aRadius, int aWidth = 0 );
78
79 SHAPE_ARC( const SHAPE_ARC& aOther );
80
81 virtual ~SHAPE_ARC() {}
82
83 SHAPE* Clone() const override
84 {
85 return new SHAPE_ARC( *this );
86 }
87
97 SHAPE_ARC& ConstructFromStartEndAngle( const VECTOR2I& aStart, const VECTOR2I& aEnd,
98 const EDA_ANGLE& aAngle, double aWidth = 0 );
99
109 SHAPE_ARC& ConstructFromStartEndCenter( const VECTOR2I& aStart, const VECTOR2I& aEnd,
110 const VECTOR2I& aCenter, bool aClockwise = false,
111 double aWidth = 0 );
112
113 const VECTOR2I& GetP0() const { return m_start; }
114 const VECTOR2I& GetP1() const { return m_end; }
115 const VECTOR2I& GetArcMid() const { return m_mid; }
116 const VECTOR2I& GetCenter() const;
117
118 const BOX2I BBox( int aClearance = 0 ) const override;
119
120 VECTOR2I NearestPoint( const VECTOR2I& aP ) const;
121
122 bool Collide( const SEG& aSeg, int aClearance = 0, int* aActual = nullptr,
123 VECTOR2I* aLocation = nullptr ) const override;
124 bool Collide( const VECTOR2I& aP, int aClearance = 0, int* aActual = nullptr,
125 VECTOR2I* aLocation = nullptr ) const override;
126
127
128 bool Collide( const SHAPE* aShape, int aClearance = 0, int* aActual = nullptr,
129 VECTOR2I* aLocation = nullptr ) const override
130 {
131 return SHAPE::Collide( aShape, aClearance, aActual, aLocation );
132 }
133
142 int IntersectLine( const SEG& aSeg, std::vector<VECTOR2I>* aIpsBuffer ) const;
143
151 int Intersect( const SHAPE_ARC& aArc, std::vector<VECTOR2I>* aIpsBuffer ) const;
152
153 void SetWidth( int aWidth )
154 {
155 m_width = aWidth;
156 }
157
158 int GetWidth() const
159 {
160 return m_width;
161 }
162
163 bool IsSolid() const override
164 {
165 return true;
166 }
167
168 void Move( const VECTOR2I& aVector ) override;
169
176 void Rotate( const EDA_ANGLE& aAngle, const VECTOR2I& aCenter ) override;
177
178 void Mirror( bool aX = true, bool aY = false, const VECTOR2I& aVector = { 0, 0 } );
179
180 void Mirror( const SEG& axis );
181
182 void Reverse();
183
184 SHAPE_ARC Reversed() const;
185
186 double GetRadius() const;
187
188 SEG GetChord() const
189 {
190 return SEG( m_start, m_end );
191 }
192
197
201 EDA_ANGLE GetStartAngle() const;
202
206 EDA_ANGLE GetEndAngle() const;
207
211 double GetLength() const;
212
222 static double DefaultAccuracyForPCB(){ return 0.005 * PCB_IU_PER_MM; }
223
239 const SHAPE_LINE_CHAIN ConvertToPolyline( double aAccuracy = DefaultAccuracyForPCB(),
240 double* aEffectiveAccuracy = nullptr ) const;
241
242 bool operator==( SHAPE_ARC const& aArc ) const
243 {
244 return ( aArc.m_start == m_start ) && ( aArc.m_end == m_end ) && ( aArc.m_mid == m_mid )
245 && ( aArc.m_width == m_width );
246 }
247
248 void TransformToPolygon( SHAPE_POLY_SET& aBuffer, int aError,
249 ERROR_LOC aErrorLoc ) const override;
250
254 bool IsCCW() const
255 {
256 VECTOR2L mid = m_mid;
257 VECTOR2L v1 = m_end - mid;
258 VECTOR2L v2 = m_start - mid;
259
260 return v1.Cross( v2 ) > 0;
261 }
262
263 bool IsClockwise() const { return !IsCCW(); }
264
265private:
266 void update_values();
267
268 bool sliceContainsPoint( const VECTOR2I& p ) const;
269
270private:
275
276 BOX2I m_bbox; // Calculated value
277 VECTOR2I m_center; // Calculated value
278 double m_radius; // Calculated value
279};
280
281// Required for Boost Test BOOST_CHECK_EQUAL:
282std::ostream& operator<<( std::ostream& aStream, const SHAPE_ARC& aArc );
283
284#endif
constexpr double PCB_IU_PER_MM
Definition: base_units.h:70
Definition: seg.h:42
EDA_ANGLE GetCentralAngle() const
Definition: shape_arc.cpp:520
double m_radius
Definition: shape_arc.h:278
const VECTOR2I & GetArcMid() const
Definition: shape_arc.h:115
void update_values()
Definition: shape_arc.cpp:335
SEG GetChord() const
Definition: shape_arc.h:188
bool IsClockwise() const
Definition: shape_arc.h:263
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Definition: shape_arc.h:128
void Move(const VECTOR2I &aVector) override
Definition: shape_arc.cpp:608
SHAPE_ARC & ConstructFromStartEndAngle(const VECTOR2I &aStart, const VECTOR2I &aEnd, const EDA_ANGLE &aAngle, double aWidth=0)
Construct this arc from the given start, end and angle.
Definition: shape_arc.cpp:194
virtual ~SHAPE_ARC()
Definition: shape_arc.h:81
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
Definition: shape_arc.cpp:385
EDA_ANGLE GetEndAngle() const
Definition: shape_arc.cpp:497
bool IsCCW() const
Definition: shape_arc.h:254
double GetLength() const
Definition: shape_arc.cpp:511
BOX2I m_bbox
Definition: shape_arc.h:276
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter) override
Rotate the arc by a given angle about a point.
Definition: shape_arc.cpp:617
bool sliceContainsPoint(const VECTOR2I &p) const
Definition: shape_arc.cpp:669
VECTOR2I NearestPoint(const VECTOR2I &aP) const
Definition: shape_arc.cpp:399
SHAPE_ARC()
Definition: shape_arc.h:40
int GetWidth() const
Definition: shape_arc.h:158
void SetWidth(int aWidth)
Definition: shape_arc.h:153
VECTOR2I m_mid
Definition: shape_arc.h:272
SHAPE_ARC & ConstructFromStartEndCenter(const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCenter, bool aClockwise=false, double aWidth=0)
Constructs this arc from the given start, end and center.
Definition: shape_arc.cpp:212
SHAPE_ARC Reversed() const
Definition: shape_arc.cpp:663
VECTOR2I m_center
Definition: shape_arc.h:277
int m_width
Definition: shape_arc.h:274
const VECTOR2I & GetP1() const
Definition: shape_arc.h:114
int IntersectLine(const SEG &aSeg, std::vector< VECTOR2I > *aIpsBuffer) const
Find intersection points between this arc and aSeg, treating aSeg as an infinite line.
Definition: shape_arc.cpp:295
VECTOR2I m_end
Definition: shape_arc.h:273
bool Collide(const SEG &aSeg, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the segment aSeg than aClearance,...
Definition: shape_arc.cpp:244
const SHAPE_LINE_CHAIN ConvertToPolyline(double aAccuracy=DefaultAccuracyForPCB(), double *aEffectiveAccuracy=nullptr) const
Construct a SHAPE_LINE_CHAIN of segments from a given arc.
Definition: shape_arc.cpp:542
int Intersect(const SHAPE_ARC &aArc, std::vector< VECTOR2I > *aIpsBuffer) const
Find intersection points between this arc and aArc.
Definition: shape_arc.cpp:316
double GetRadius() const
Definition: shape_arc.cpp:536
EDA_ANGLE GetStartAngle() const
Definition: shape_arc.cpp:489
void TransformToPolygon(SHAPE_POLY_SET &aBuffer, int aError, ERROR_LOC aErrorLoc) const override
Fills a SHAPE_POLY_SET with a polygon representation of this shape.
Definition: shape_arc.cpp:695
static double DefaultAccuracyForPCB()
Definition: shape_arc.h:222
bool operator==(SHAPE_ARC const &aArc) const
Definition: shape_arc.h:242
SHAPE * Clone() const override
Return a dynamically allocated copy of the shape.
Definition: shape_arc.h:83
void Reverse()
Definition: shape_arc.cpp:657
void Mirror(bool aX=true, bool aY=false, const VECTOR2I &aVector={ 0, 0 })
Definition: shape_arc.cpp:627
const VECTOR2I & GetP0() const
Definition: shape_arc.h:113
VECTOR2I m_start
Definition: shape_arc.h:271
bool IsSolid() const override
Definition: shape_arc.h:163
const VECTOR2I & GetCenter() const
Definition: shape_arc.cpp:505
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Represent a set of closed polygons.
An abstract shape on 2D plane.
Definition: shape.h:126
virtual bool Collide(const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const
Check if the boundary of shape (this) lies closer to the point aP than aClearance,...
Definition: shape.h:181
VECTOR3< T > Cross(const VECTOR3< T > &aVector) const
Compute cross product of self with aVector.
Definition: vector3.h:128
std::ostream & operator<<(std::ostream &aStream, const EDA_TEXT &aText)
Definition: eda_text.cpp:1170
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
@ SH_ARC
circular arc
Definition: shape.h:54
VECTOR3I v1(5, 5, 5)
VECTOR2I v2(1, 0)
Test suite for KiCad math code.