KiCad PCB EDA Suite
Loading...
Searching...
No Matches
teardrop_utils.cpp
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) 2021 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2023-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25/*
26 * Some calculations (mainly computeCurvedForRoundShape) are derived from
27 * https://github.com/NilujePerchut/kicad_scripts/tree/master/teardrops
28 */
29
31#include <pcb_track.h>
32#include <pad.h>
33#include <zone_filler.h>
34#include <board_commit.h>
35#include <drc/drc_rtree.h>
36
37#include "teardrop.h"
41#include <bezier_curves.h>
42
43#include <wx/log.h>
44
45
46void TRACK_BUFFER::AddTrack( PCB_TRACK* aTrack, int aLayer, int aNetcode )
47{
48 auto item = m_map_tracks.find( idxFromLayNet( aLayer, aNetcode ) );
49 std::vector<PCB_TRACK*>* buffer;
50
51 if( item == m_map_tracks.end() )
52 {
53 buffer = new std::vector<PCB_TRACK*>;
54 m_map_tracks[idxFromLayNet( aLayer, aNetcode )] = buffer;
55 }
56 else
57 {
58 buffer = (*item).second;
59 }
60
61 buffer->push_back( aTrack );
62}
63
64
66{
67 if( aItem->Type() == PCB_VIA_T )
68 {
69 PCB_VIA* via = static_cast<PCB_VIA*>( aItem );
70 return via->GetWidth( aLayer );
71 }
72 else if( aItem->Type() == PCB_PAD_T )
73 {
74 PAD* pad = static_cast<PAD*>( aItem );
75 return std::min( pad->GetSize( aLayer ).x, pad->GetSize( aLayer ).y );
76 }
77 else if( aItem->Type() == PCB_TRACE_T || aItem->Type() == PCB_ARC_T )
78 {
79 PCB_TRACK* track = static_cast<PCB_TRACK*>( aItem );
80 return track->GetWidth();
81 }
82
83 return 0;
84}
85
86
88{
89 if( aItem->Type() == PCB_PAD_T )
90 {
91 PAD* pad = static_cast<PAD*>( aItem );
92
93 return pad->GetShape( aLayer ) == PAD_SHAPE::CIRCLE
94 || ( pad->GetShape( aLayer ) == PAD_SHAPE::OVAL
95 && pad->GetSize( aLayer ).x
96 == pad->GetSize( aLayer ).y );
97 }
98
99 return true;
100}
101
102
104{
105 for( PCB_TRACK* track : m_board->Tracks() )
106 {
107 if( track->Type() == PCB_TRACE_T || track->Type() == PCB_ARC_T )
108 {
109 m_tracksRTree.Insert( track, track->GetLayer() );
110 m_trackLookupList.AddTrack( track, track->GetLayer(), track->GetNetCode() );
111 }
112 }
113}
114
115
117{
118 for( ZONE* zone: m_board->Zones() )
119 {
120 // Skip teardrops
121 if( zone->IsTeardropArea() )
122 continue;
123
124 // Only consider zones on the same layer
125 if( !zone->IsOnLayer( aTrack->GetLayer() ) )
126 continue;
127
128 if( zone->GetNetCode() == aTrack->GetNetCode() )
129 {
130 if( zone->Outline()->Contains( VECTOR2I( aPadOrVia->GetPosition() ) ) )
131 {
132 // If the first item is a pad, ensure it can be connected to the zone
133 if( aPadOrVia->Type() == PCB_PAD_T )
134 {
135 PAD *pad = static_cast<PAD*>( aPadOrVia );
136
137 if( zone->GetPadConnection() == ZONE_CONNECTION::NONE
138 || pad->GetZoneConnectionOverrides( nullptr ) == ZONE_CONNECTION::NONE )
139 {
140 return false;
141 }
142 }
143
144 return true;
145 }
146 }
147 }
148
149 return false;
150}
151
152
154 const VECTOR2I& aEndPoint ) const
155{
156 int matches = 0; // Count of candidates: only 1 is acceptable
157 PCB_TRACK* candidate = nullptr; // a reference to the track connected
158
159 m_tracksRTree.QueryColliding( aTrackRef, aTrackRef->GetLayer(), aTrackRef->GetLayer(),
160 // Filter:
161 [&]( BOARD_ITEM* trackItem ) -> bool
162 {
163 return trackItem != aTrackRef;
164 },
165 // Visitor
166 [&]( BOARD_ITEM* trackItem ) -> bool
167 {
168 PCB_TRACK* curr_track = static_cast<PCB_TRACK*>( trackItem );
169
170 // IsPointOnEnds() returns 0, EDA_ITEM_FLAGS::STARTPOINT or EDA_ITEM_FLAGS::ENDPOINT
171 if( EDA_ITEM_FLAGS match = curr_track->IsPointOnEnds( aEndPoint, m_tolerance ) )
172 {
173 // if faced with a Y junction, choose the track longest segment as candidate
174 matches++;
175
176 if( matches > 1 )
177 {
178 double previous_len = candidate->GetLength();
179 double curr_len = curr_track->GetLength();
180
181 if( previous_len >= curr_len )
182 return true;
183 }
184
185 aMatchType = match;
186 candidate = curr_track;
187 }
188
189 return true;
190 },
191 0 );
192
193 return candidate;
194}
195
196
200static VECTOR2D NormalizeVector( const VECTOR2I& aVector )
201{
202 VECTOR2D vect( aVector );
203 double norm = vect.EuclideanNorm();
204 return vect / norm;
205}
206
207
208/*
209 * Compute the curve part points for teardrops connected to a round shape
210 * The Bezier curve control points are optimized for a round pad/via shape,
211 * and do not give a good curve shape for other pad shapes
212 */
214 std::vector<VECTOR2I>& aPoly,
215 PCB_LAYER_ID aLayer,
216 int aTrackHalfWidth, const VECTOR2D& aTrackDir,
217 BOARD_ITEM* aOther, const VECTOR2I& aOtherPos,
218 std::vector<VECTOR2I>& pts ) const
219{
220 // in pts:
221 // A and B are points on the track ( pts[0] and pts[1] )
222 // C and E are points on the aViaPad ( pts[2] and pts[4] )
223 // D is the aViaPad centre ( pts[3] )
224 double Vpercent = aParams.m_BestWidthRatio;
225 int td_height = KiROUND( GetWidth( aOther, aLayer ) * Vpercent );
226
227 // First, calculate a aVpercent equivalent to the td_height clamped by aTdMaxHeight
228 // We cannot use the initial aVpercent because it gives bad shape with points
229 // on aViaPad calculated for a clamped aViaPad size
230 if( aParams.m_TdMaxWidth > 0 && aParams.m_TdMaxWidth < td_height )
231 Vpercent *= (double) aParams.m_TdMaxWidth / td_height;
232
233 int radius = GetWidth( aOther, aLayer ) / 2;
234
235 // Don't divide by zero. No good can come of that.
236 wxCHECK2( radius != 0, radius = 1 );
237
238 double minVpercent = double( aTrackHalfWidth ) / radius;
239 double weaken = (Vpercent - minVpercent) / ( 1 - minVpercent ) / radius;
240
241 double biasBC = 0.5 * SEG( pts[1], pts[2] ).Length();
242 double biasAE = 0.5 * SEG( pts[4], pts[0] ).Length();
243
244 VECTOR2I vecC = (VECTOR2I)pts[2] - aOtherPos;
245 VECTOR2I tangentC = VECTOR2I( pts[2].x - vecC.y * biasBC * weaken,
246 pts[2].y + vecC.x * biasBC * weaken );
247 VECTOR2I vecE = (VECTOR2I)pts[4] - aOtherPos;
248 VECTOR2I tangentE = VECTOR2I( pts[4].x + vecE.y * biasAE * weaken,
249 pts[4].y - vecE.x * biasAE * weaken );
250
251 VECTOR2I tangentB = VECTOR2I( pts[1].x - aTrackDir.x * biasBC, pts[1].y - aTrackDir.y * biasBC );
252 VECTOR2I tangentA = VECTOR2I( pts[0].x - aTrackDir.x * biasAE, pts[0].y - aTrackDir.y * biasAE );
253
254 std::vector<VECTOR2I> curve_pts;
255 BEZIER_POLY( pts[1], tangentB, tangentC, pts[2] ).GetPoly( curve_pts, ARC_HIGH_DEF );
256
257 for( VECTOR2I& corner: curve_pts )
258 aPoly.push_back( corner );
259
260 aPoly.push_back( pts[3] );
261
262 curve_pts.clear();
263 BEZIER_POLY( pts[4], tangentE, tangentA, pts[0] ).GetPoly( curve_pts, ARC_HIGH_DEF );
264
265 for( VECTOR2I& corner: curve_pts )
266 aPoly.push_back( corner );
267}
268
269
270/*
271 * Compute the curve part points for teardrops connected to a rectangular/polygonal shape
272 * The Bezier curve control points are not optimized for a special shape
273 */
275 std::vector<VECTOR2I>& aPoly, int aTdWidth,
276 int aTrackHalfWidth,
277 std::vector<VECTOR2I>& aPts,
278 const VECTOR2I& aIntersection) const
279{
280 // in aPts:
281 // A and B are points on the track ( pts[0] and pts[1] )
282 // C and E are points on the pad/via ( pts[2] and pts[4] )
283 // D is the aViaPad centre ( pts[3] )
284
285 // side1 is( aPts[1], aPts[2] ); from track to via
286 VECTOR2I side1( aPts[2] - aPts[1] ); // vector from track to via
287 // side2 is ( aPts[4], aPts[0] ); from via to track
288 VECTOR2I side2( aPts[4] - aPts[0] ); // vector from track to via
289
290 VECTOR2I trackDir( aIntersection - ( aPts[0] + aPts[1] ) / 2 );
291
292 std::vector<VECTOR2I> curve_pts;
293
294 // Note: This side is from track to pad/via
295 VECTOR2I ctrl1 = aPts[1] + trackDir.Resize( side1.EuclideanNorm() / 4 );
296 VECTOR2I ctrl2 = ( aPts[2] + aIntersection ) / 2;
297
298 BEZIER_POLY( aPts[1], ctrl1, ctrl2, aPts[2] ).GetPoly( curve_pts, ARC_HIGH_DEF );
299
300 for( VECTOR2I& corner: curve_pts )
301 aPoly.push_back( corner );
302
303 aPoly.push_back( aPts[3] );
304
305 // Note: This side is from pad/via to track
306 curve_pts.clear();
307
308 ctrl1 = ( aPts[4] + aIntersection ) / 2;
309 ctrl2 = aPts[0] + trackDir.Resize( side2.EuclideanNorm() / 4 );
310
311 BEZIER_POLY( aPts[4], ctrl1, ctrl2, aPts[0] ).GetPoly( curve_pts, ARC_HIGH_DEF );
312
313 for( VECTOR2I& corner: curve_pts )
314 aPoly.push_back( corner );
315}
316
317
319 BOARD_ITEM* aItem, const VECTOR2I& aPos,
320 std::vector<VECTOR2I>& aPts ) const
321{
322 // Compute the 2 anchor points on pad/via/track of the teardrop shape
323
324 SHAPE_POLY_SET c_buffer;
325
326 // m_BestWidthRatio is the factor to calculate the teardrop preferred width.
327 // teardrop width = pad, via or track size * m_BestWidthRatio (m_BestWidthRatio <= 1.0)
328 // For rectangular (and similar) shapes, the preferred_width is calculated from the min
329 // dim of the rectangle
330
331 int preferred_width = KiROUND( GetWidth( aItem, aLayer ) * aParams.m_BestWidthRatio );
332
333 // force_clip = true to force the pad/via/track polygon to be clipped to follow
334 // constraints
335 // Clipping is also needed for rectangular shapes, because the teardrop shape is restricted
336 // to a polygonal area smaller than the pad area (the teardrop height use the smaller value
337 // of X and Y sizes).
338 bool force_clip = aParams.m_BestWidthRatio < 1.0;
339
340 // To find the anchor points on the pad/via/track shape, we build the polygonal shape, and
341 // clip the polygon to the max size (preferred_width or m_TdMaxWidth) by a rectangle
342 // centered on the axis of the expected teardrop shape.
343 // (only reduce the size of polygonal shape does not give good anchor points)
344 if( IsRound( aItem, aLayer ) )
345 {
346 TransformCircleToPolygon( c_buffer, aPos, GetWidth( aItem, aLayer ) / 2, ARC_LOW_DEF,
347 ERROR_INSIDE, 16 );
348 }
349 else // Only PADS can have a not round shape
350 {
351 wxCHECK_MSG( aItem->Type() == PCB_PAD_T, false, wxT( "Expected non-round item to be PAD" ) );
352 PAD* pad = static_cast<PAD*>( aItem );
353
354 force_clip = true;
355
356 preferred_width = KiROUND( GetWidth( pad, aLayer ) * aParams.m_BestWidthRatio );
357 pad->TransformShapeToPolygon( c_buffer, aLayer, 0, ARC_LOW_DEF, ERROR_INSIDE );
358 }
359
360 // Clip the pad/via/track shape to match the m_TdMaxWidth constraint, and for non-round pads,
361 // clip the shape to the smallest of size.x and size.y values.
362 if( force_clip || ( aParams.m_TdMaxWidth > 0 && aParams.m_TdMaxWidth < preferred_width ) )
363 {
364 int halfsize = std::min( aParams.m_TdMaxWidth, preferred_width )/2;
365
366 // teardrop_axis is the line from anchor point on the track and the end point
367 // of the teardrop in the pad/via
368 // this is the teardrop_axis of the teardrop shape to build
369 VECTOR2I ref_on_track = ( aPts[0] + aPts[1] ) / 2;
370 VECTOR2I teardrop_axis( aPts[3] - ref_on_track );
371
372 EDA_ANGLE orient( teardrop_axis );
373 int len = teardrop_axis.EuclideanNorm();
374
375 // Build the constraint polygon: a rectangle with
376 // length = dist between the point on track and the pad/via pos
377 // height = m_TdMaxWidth or aViaPad.m_Width
378 SHAPE_POLY_SET clipping_rect;
379 clipping_rect.NewOutline();
380
381 // Build a horizontal rect: it will be rotated later
382 clipping_rect.Append( 0, - halfsize );
383 clipping_rect.Append( 0, halfsize );
384 clipping_rect.Append( len, halfsize );
385 clipping_rect.Append( len, - halfsize );
386
387 clipping_rect.Rotate( -orient );
388 clipping_rect.Move( ref_on_track );
389
390 // Clip the shape to the max allowed teadrop area
391 c_buffer.BooleanIntersection( clipping_rect, SHAPE_POLY_SET::PM_FAST );
392 }
393
394 /* in aPts:
395 * A and B are points on the track ( aPts[0] and aPts[1] )
396 * C and E are points on the aViaPad ( aPts[2] and aPts[4] )
397 * D is midpoint behind the aViaPad centre ( aPts[3] )
398 */
399
400 SHAPE_LINE_CHAIN& padpoly = c_buffer.Outline(0);
401 std::vector<VECTOR2I> points = padpoly.CPoints();
402
403 std::vector<VECTOR2I> initialPoints;
404 initialPoints.push_back( aPts[0] );
405 initialPoints.push_back( aPts[1] );
406
407 for( const VECTOR2I& pt: points )
408 initialPoints.emplace_back( pt.x, pt.y );
409
410 std::vector<VECTOR2I> hull;
411 BuildConvexHull( hull, initialPoints );
412
413 // Search for end points of segments starting at aPts[0] or aPts[1]
414 // In some cases, in convex hull, only one point (aPts[0] or aPts[1]) is still in list
415 VECTOR2I PointC;
416 VECTOR2I PointE;
417 int found_start = -1; // 2 points (one start and one end) should be found
418 int found_end = -1;
419
420 VECTOR2I start = aPts[0];
421 VECTOR2I pend = aPts[1];
422
423 for( unsigned ii = 0, jj = 0; jj < hull.size(); ii++, jj++ )
424 {
425 unsigned next = ii+ 1;
426
427 if( next >= hull.size() )
428 next = 0;
429
430 int prev = ii -1;
431
432 if( prev < 0 )
433 prev = hull.size()-1;
434
435 if( hull[ii] == start )
436 {
437 // the previous or the next point is candidate:
438 if( hull[next] != pend )
439 PointE = hull[next];
440 else
441 PointE = hull[prev];
442
443 found_start = ii;
444 }
445
446 if( hull[ii] == pend )
447 {
448 if( hull[next] != start )
449 PointC = hull[next];
450 else
451 PointC = hull[prev];
452
453 found_end = ii;
454 }
455 }
456
457 if( found_start < 0 ) // PointE was not initialized, because start point does not exit
458 {
459 int ii = found_end-1;
460
461 if( ii < 0 )
462 ii = hull.size()-1;
463
464 PointE = hull[ii];
465 }
466
467 if( found_end < 0 ) // PointC was not initialized, because end point does not exit
468 {
469 int ii = found_start-1;
470
471 if( ii < 0 )
472 ii = hull.size()-1;
473
474 PointC = hull[ii];
475 }
476
477 aPts[2] = PointC;
478 aPts[4] = PointE;
479
480 // Now we have to know if the choice aPts[2] = PointC is the best, or if
481 // aPts[2] = PointE is better.
482 // A criteria is to calculate the polygon area in these 2 cases, and choose the case
483 // that gives the bigger area, because the segments starting at PointC and PointE
484 // maximize their distance.
485 SHAPE_LINE_CHAIN dummy1( aPts, true );
486 double area1 = dummy1.Area();
487
488 std::swap( aPts[2], aPts[4] );
489 SHAPE_LINE_CHAIN dummy2( aPts, true );
490 double area2 = dummy2.Area();
491
492 if( area1 > area2 ) // The first choice (without swapping) is the better.
493 std::swap( aPts[2], aPts[4] );
494
495 return true;
496}
497
498
500 VECTOR2I& aStartPoint, VECTOR2I& aEndPoint,
501 VECTOR2I& aIntersection, PCB_TRACK*& aTrack,
502 BOARD_ITEM* aOther, const VECTOR2I& aOtherPos,
503 int* aEffectiveTeardropLen ) const
504{
505 bool found = true;
506 VECTOR2I start = aTrack->GetStart(); // one reference point on the track, inside teardrop
507 VECTOR2I end = aTrack->GetEnd(); // the second reference point on the track, outside teardrop
508 PCB_LAYER_ID layer = aTrack->GetLayer();
509 int radius = GetWidth( aOther, layer ) / 2;
510
511 // Requested length of the teardrop:
512 int targetLength = KiROUND( GetWidth( aOther, layer ) * aParams.m_BestLengthRatio );
513
514 if( aParams.m_TdMaxLen > 0 )
515 targetLength = std::min( aParams.m_TdMaxLen, targetLength );
516
517 // actualTdLen is the distance between start and the teardrop point on the segment from start to end
518 int actualTdLen;
519 bool need_swap = false; // true if the start and end points of the current track are swapped
520
521 // aTrack is expected to have one end inside the via/pad and the other end outside
522 // so ensure the start point is inside the via/pad
523 if( !aOther->HitTest( start, 0 ) )
524 {
525 std::swap( start, end );
526 need_swap = true;
527 }
528
529 SHAPE_POLY_SET shapebuffer;
530
531 if( IsRound( aOther, layer ) )
532 {
533 TransformCircleToPolygon( shapebuffer, aOtherPos, radius, ARC_LOW_DEF, ERROR_INSIDE, 16 );
534 }
535 else
536 {
537 wxCHECK_MSG( aOther->Type() == PCB_PAD_T, false, wxT( "Expected non-round item to be PAD" ) );
538 static_cast<PAD*>( aOther )->TransformShapeToPolygon( shapebuffer, aTrack->GetLayer(), 0,
540 }
541
542 SHAPE_LINE_CHAIN& outline = shapebuffer.Outline(0);
543 outline.SetClosed( true );
544
545 // Search the intersection point between the pad/via shape and the current track
546 // This this the starting point to define the teardrop length
548 int pt_count;
549
550 if( aTrack->Type() == PCB_ARC_T )
551 {
552 // To find the starting point we convert the arc to a polyline
553 // and compute the intersection point with the pad/via shape
554 SHAPE_ARC arc( aTrack->GetStart(), static_cast<PCB_ARC*>( aTrack )->GetMid(),
555 aTrack->GetEnd(), aTrack->GetWidth() );
556
558 pt_count = outline.Intersect( poly, pts );
559 }
560 else
561 {
562 pt_count = outline.Intersect( SEG( start, end ), pts );
563 }
564
565 // Ensure a intersection point was found, otherwise we cannot built the teardrop
566 // using this track (it is fully outside or inside the pad/via shape)
567 if( pt_count < 1 )
568 return false;
569
570 aIntersection = pts[0].p;
571 start = aIntersection; // This is currently the reference point of the teardrop length
572
573 // actualTdLen for now the distance between start and the teardrop point on the (start end)segment
574 // It cannot be bigger than the lenght of this segment
575 actualTdLen = std::min( targetLength, SEG( start, end ).Length() );
576 VECTOR2I ref_lenght_point = start; // the reference point of actualTdLen
577
578 // If the first track is too short to allow a teardrop having the requested length
579 // explore the connected track(s), and try to find a anchor point at targetLength from initial start
580 if( actualTdLen < targetLength && aParams.m_AllowUseTwoTracks )
581 {
582 int consumed = 0;
583
584 while( actualTdLen + consumed < targetLength )
585 {
586 EDA_ITEM_FLAGS matchType;
587
588 PCB_TRACK* connected_track = findTouchingTrack( matchType, aTrack, end );
589
590 if( connected_track == nullptr )
591 break;
592
593 // TODO: stop if angle between old and new segment is > 45 deg to avoid bad shape
594 consumed += actualTdLen;
595 // actualTdLen is the new distance from new start point and the teardrop anchor point
596 actualTdLen = std::min( targetLength-consumed, int( connected_track->GetLength() ) );
597 aTrack = connected_track;
598 end = connected_track->GetEnd();
599 start = connected_track->GetStart();
600 need_swap = false;
601
602 if( matchType != STARTPOINT )
603 {
604 std::swap( start, end );
605 need_swap = true;
606 }
607
608 // If we do not want to explore more than one connected track, stop search here
609 break;
610 }
611 }
612
613 // if aTrack is an arc, find the best teardrop end point on the arc
614 // It is currently on the segment from arc start point to arc end point,
615 // therefore not really on the arc, because we have used only the track end points.
616 if( aTrack->Type() == PCB_ARC_T )
617 {
618 // To find the best start and end points to build the teardrop shape, we convert
619 // the arc to segments, and search for the segment having its start point at a dist
620 // < actualTdLen, and its end point at adist > actualTdLen:
621 SHAPE_ARC arc( aTrack->GetStart(), static_cast<PCB_ARC*>( aTrack )->GetMid(),
622 aTrack->GetEnd(), aTrack->GetWidth() );
623
624 if( need_swap )
625 arc.Reverse();
626
628
629 // Now, find the segment of the arc at a distance < actualTdLen from ref_lenght_point.
630 // We just search for the first segment (starting from the farest segment) with its
631 // start point at a distance < actualTdLen dist
632 // This is basic, but it is probably enough.
633 if( poly.PointCount() > 2 )
634 {
635 // Note: the first point is inside or near the pad/via shape
636 // The last point is outside and the farest from the ref_lenght_point
637 // So we explore segments from the last to the first
638 for( int ii = poly.PointCount()-1; ii >= 0 ; ii-- )
639 {
640 int dist_from_start = ( poly.CPoint( ii ) - start ).EuclideanNorm();
641
642 // The first segment at a distance of the reference point < actualTdLen is OK
643 // and is suitable to define the reference segment of the teardrop anchor.
644 if( dist_from_start < actualTdLen || ii == 0 )
645 {
646 start = poly.CPoint( ii );
647
648 if( ii < poly.PointCount()-1 )
649 end = poly.CPoint( ii+1 );
650
651 // actualTdLen is the distance between start (the reference segment start point)
652 // and the point on track of the teardrop.
653 // This is the difference between the initial actualTdLen value and the
654 // distance between start and ref_lenght_point.
655 actualTdLen -= (start - ref_lenght_point).EuclideanNorm();
656
657 // Ensure validity of actualTdLen: >= 0, and <= segment lenght
658 if( actualTdLen < 0 ) // should not happen, but...
659 actualTdLen = 0;
660
661 actualTdLen = std::min( actualTdLen, (end - start).EuclideanNorm() );
662
663 break;
664 }
665 }
666 }
667 }
668
669 // aStartPoint and aEndPoint will define later a segment to build the 2 anchors points
670 // of the teardrop on the aTrack shape.
671 // they are two points (both outside the pad/via shape) of aTrack if aTrack is a segment,
672 // or a small segment on aTrack if aTrack is an ARC
673 aStartPoint = start;
674 aEndPoint = end;
675
676 *aEffectiveTeardropLen = actualTdLen;
677 return found;
678}
679
680
682 std::vector<VECTOR2I>& aCorners, PCB_TRACK* aTrack,
683 BOARD_ITEM* aOther, const VECTOR2I& aOtherPos ) const
684{
685 VECTOR2I start, end; // Start and end points of the track anchor of the teardrop
686 // the start point is inside the teardrop shape
687 // the end point is outside.
688 VECTOR2I intersection; // Where the track centerline intersects the pad/via edge
689 int track_stub_len; // the dist between the start point and the anchor point
690 // on the track
691
692 // Note: aTrack can be modified if the initial track is too short
693 if( !findAnchorPointsOnTrack( aParams, start, end, intersection, aTrack, aOther, aOtherPos,
694 &track_stub_len ) )
695 {
696 return false;
697 }
698
699 // The start and end points must be different to calculate a valid polygon shape
700 if( start == end )
701 return false;
702
703 VECTOR2D vecT = NormalizeVector(end - start);
704
705 // find the 2 points on the track, sharp end of the teardrop
706 int track_halfwidth = aTrack->GetWidth() / 2;
707 VECTOR2I pointB = start + VECTOR2I( vecT.x * track_stub_len + vecT.y * track_halfwidth,
708 vecT.y * track_stub_len - vecT.x * track_halfwidth );
709 VECTOR2I pointA = start + VECTOR2I( vecT.x * track_stub_len - vecT.y * track_halfwidth,
710 vecT.y * track_stub_len + vecT.x * track_halfwidth );
711
712 PCB_LAYER_ID layer = aTrack->GetLayer();
713
714 // To build a polygonal valid shape pointA and point B must be outside the pad
715 // It can be inside with some pad shapes having very different X and X sizes
716 if( !IsRound( aOther, layer ) )
717 {
718 PAD* pad = static_cast<PAD*>( aOther );
719
720 if( pad->HitTest( pointA ) )
721 return false;
722
723 if( pad->HitTest( pointB ) )
724 return false;
725 }
726
727 // Introduce a last point to cover the via centre to ensure it is seen as connected
728 VECTOR2I pointD = aOtherPos;
729 // add a small offset in order to have the aViaPad.m_Pos reference point inside
730 // the teardrop area, just in case...
731 int offset = pcbIUScale.mmToIU( 0.001 );
732 pointD += VECTOR2I( int( -vecT.x*offset), int(-vecT.y*offset) );
733
734 VECTOR2I pointC, pointE; // Point on pad/via outlines
735 std::vector<VECTOR2I> pts = { pointA, pointB, pointC, pointD, pointE };
736
737 computeAnchorPoints( aParams, aTrack->GetLayer(), aOther, aOtherPos, pts );
738
739 if( !aParams.IsCurved() )
740 {
741 aCorners = pts;
742 return true;
743 }
744
745 // See if we can use curved teardrop shape
746 if( IsRound( aOther, layer ) )
747 {
748 computeCurvedForRoundShape( aParams, aCorners, layer, track_halfwidth, vecT, aOther, aOtherPos, pts );
749 }
750 else
751 {
752 int td_width = KiROUND( GetWidth( aOther, layer ) * aParams.m_BestWidthRatio );
753
754 if( aParams.m_TdMaxWidth > 0 && aParams.m_TdMaxWidth < td_width )
755 td_width = aParams.m_TdMaxWidth;
756
757 computeCurvedForRectShape( aParams, aCorners, td_width, track_halfwidth, pts, intersection );
758 }
759
760 return true;
761}
@ ERROR_INSIDE
Definition: approximation.h:34
constexpr int ARC_HIGH_DEF
Definition: base_units.h:120
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
constexpr int ARC_LOW_DEF
Definition: base_units.h:119
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
Bezier curves to polygon converter.
Definition: bezier_curves.h:38
void GetPoly(std::vector< VECTOR2I > &aOutput, int aMaxError=10)
Convert a Bezier curve to a polygon.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:237
const ZONES & Zones() const
Definition: board.h:335
const TRACKS & Tracks() const
Definition: board.h:329
void Insert(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer, int aWorstClearance=0)
Insert an item into the tree on a particular layer with an optional worst clearance.
Definition: drc_rtree.h:104
int QueryColliding(BOARD_ITEM *aRefItem, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer, std::function< bool(BOARD_ITEM *)> aFilter=nullptr, std::function< bool(BOARD_ITEM *)> aVisitor=nullptr, int aClearance=0) const
This is a fast test which essentially does bounding-box overlap given a worst-case clearance.
Definition: drc_rtree.h:215
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:243
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
virtual bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const
Test if aPosition is inside or on the boundary of this item.
Definition: eda_item.h:216
Definition: pad.h:54
const VECTOR2I & GetMid() const
Definition: pcb_track.h:299
virtual double GetLength() const
Get the length of the track using the hypotenuse calculation.
Definition: pcb_track.cpp:725
const VECTOR2I & GetStart() const
Definition: pcb_track.h:122
const VECTOR2I & GetEnd() const
Definition: pcb_track.h:119
virtual int GetWidth() const
Definition: pcb_track.h:116
Definition: seg.h:42
int Length() const
Return the length (this).
Definition: seg.h:333
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:560
void Reverse()
Definition: shape_arc.cpp:674
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
int Intersect(const SEG &aSeg, INTERSECTIONS &aIp) const
Find all intersection points between our line chain and the segment aSeg.
int PointCount() const
Return the number of points (vertices) in this line chain.
double Area(bool aAbsolute=true) const
Return the area of this chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
std::vector< INTERSECTION > INTERSECTIONS
const std::vector< VECTOR2I > & CPoints() const
Represent a set of closed polygons.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
void BooleanIntersection(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset intersection For aFastMode meaning, see function booleanOp.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
int NewOutline()
Creates a new empty polygon in the set and returns its index.
void Move(const VECTOR2I &aVector) override
BOARD * m_board
Definition: teardrop.h:240
static bool IsRound(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer)
bool computeAnchorPoints(const TEARDROP_PARAMETERS &aParams, PCB_LAYER_ID aLayer, BOARD_ITEM *aItem, const VECTOR2I &aPos, std::vector< VECTOR2I > &aPts) const
Compute the 2 points on pad/via of the teardrop shape.
static int GetWidth(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer)
bool computeTeardropPolygon(const TEARDROP_PARAMETERS &aParams, std::vector< VECTOR2I > &aCorners, PCB_TRACK *aTrack, BOARD_ITEM *aOther, const VECTOR2I &aOtherPos) const
Compute all teardrop points of the polygon shape.
void computeCurvedForRectShape(const TEARDROP_PARAMETERS &aParams, std::vector< VECTOR2I > &aPoly, int aTdWidth, int aTrackHalfWidth, std::vector< VECTOR2I > &aPts, const VECTOR2I &aIntersection) const
Compute the curve part points for teardrops connected to a rectangular/polygonal shape The Bezier cur...
void computeCurvedForRoundShape(const TEARDROP_PARAMETERS &aParams, std::vector< VECTOR2I > &aPoly, PCB_LAYER_ID aLayer, int aTrackHalfWidth, const VECTOR2D &aTrackDir, BOARD_ITEM *aOther, const VECTOR2I &aOtherPos, std::vector< VECTOR2I > &aPts) const
Compute the curve part points for teardrops connected to a round shape The Bezier curve control point...
PCB_TRACK * findTouchingTrack(EDA_ITEM_FLAGS &aMatchType, PCB_TRACK *aTrackRef, const VECTOR2I &aEndPoint) const
Find a track connected to the end of another track.
TRACK_BUFFER m_trackLookupList
Definition: teardrop.h:245
bool areItemsInSameZone(BOARD_ITEM *aPadOrVia, PCB_TRACK *aTrack) const
DRC_RTREE m_tracksRTree
Definition: teardrop.h:244
bool findAnchorPointsOnTrack(const TEARDROP_PARAMETERS &aParams, VECTOR2I &aStartPoint, VECTOR2I &aEndPoint, VECTOR2I &aIntersection, PCB_TRACK *&aTrack, BOARD_ITEM *aOther, const VECTOR2I &aOtherPos, int *aEffectiveTeardropLen) const
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
double m_BestWidthRatio
The height of a teardrop as ratio between height and size of pad/via.
int m_TdMaxLen
max allowed length for teardrops in IU. <= 0 to disable
bool m_AllowUseTwoTracks
True to create teardrops using 2 track segments if the first in too small.
int m_TdMaxWidth
max allowed height for teardrops in IU. <= 0 to disable
double m_BestLengthRatio
The length of a teardrop as ratio between length and size of pad/via.
int idxFromLayNet(int aLayer, int aNetcode) const
Definition: teardrop.h:72
void AddTrack(PCB_TRACK *aTrack, int aLayer, int aNetcode)
Add a track in buffer, in space grouping tracks having the same netcode and the same layer.
std::map< int, std::vector< PCB_TRACK * > * > m_map_tracks
Definition: teardrop.h:78
T EuclideanNorm() const
Compute the Euclidean norm of the vector, which is defined as sqrt(x ** 2 + y ** 2).
Definition: vector2d.h:283
VECTOR2< T > Resize(T aNewLength) const
Return a vector of the same direction, but length specified in aNewLength.
Definition: vector2d.h:385
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aBuffer, const VECTOR2I &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
void BuildConvexHull(std::vector< VECTOR2I > &aResult, const std::vector< VECTOR2I > &aPoly)
Calculate the convex hull of a list of points in counter-clockwise order.
Definition: convex_hull.cpp:87
std::uint32_t EDA_ITEM_FLAGS
#define STARTPOINT
When a line is selected, these flags indicate which.
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
CITER next(CITER it)
Definition: ptree.cpp:126
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
static VECTOR2D NormalizeVector(const VECTOR2I &aVector)
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:691