/* * KiRouter - a push-and-(sometimes-)shove PCB router * * Copyright (C) 2013-2017 CERN * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors. * Author: Tomasz Wlostowski * * 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 . */ #include #include #include "pns_arc.h" #include "pns_debug_decorator.h" #include "pns_line_placer.h" #include "pns_node.h" #include "pns_router.h" #include "pns_shove.h" #include "pns_solid.h" #include "pns_topology.h" #include "pns_walkaround.h" #include "pns_mouse_trail_tracer.h" #include namespace PNS { LINE_PLACER::LINE_PLACER( ROUTER* aRouter ) : PLACEMENT_ALGO( aRouter ) { m_initial_direction = DIRECTION_45::N; m_world = nullptr; m_shove = nullptr; m_currentNode = nullptr; m_idle = true; // Init temporary variables (do not leave uninitialized members) m_lastNode = nullptr; m_placingVia = false; m_currentNet = 0; m_currentLayer = 0; m_startItem = nullptr; m_chainedPlacement = false; m_orthoMode = false; m_placementCorrect = false; } LINE_PLACER::~LINE_PLACER() { } void LINE_PLACER::setWorld( NODE* aWorld ) { m_world = aWorld; } const VIA LINE_PLACER::makeVia( const VECTOR2I& aP ) { const LAYER_RANGE layers( m_sizes.ViaType() == VIATYPE::THROUGH ? F_Cu : m_sizes.GetLayerTop(), m_sizes.ViaType() == VIATYPE::THROUGH ? B_Cu : m_sizes.GetLayerBottom() ); return VIA( aP, layers, m_sizes.ViaDiameter(), m_sizes.ViaDrill(), -1, m_sizes.ViaType() ); } bool LINE_PLACER::ToggleVia( bool aEnabled ) { m_placingVia = aEnabled; if( !aEnabled ) m_head.RemoveVia(); return true; } void LINE_PLACER::setInitialDirection( const DIRECTION_45& aDirection ) { m_initial_direction = aDirection; if( m_tail.SegmentCount() == 0 ) m_direction = aDirection; } bool LINE_PLACER::handleSelfIntersections() { SHAPE_LINE_CHAIN::INTERSECTIONS ips; SHAPE_LINE_CHAIN& head = m_head.Line(); SHAPE_LINE_CHAIN& tail = m_tail.Line(); // if there is no tail, there is nothing to intersect with if( tail.PointCount() < 2 ) return false; if( head.PointCount() < 2 ) return false; // completely new head trace? chop off the tail if( tail.CPoint(0) == head.CPoint(0) ) { m_p_start = tail.CPoint( 0 ); m_direction = m_initial_direction; tail.Clear(); return true; } tail.Intersect( head, ips ); // no intesection points - nothing to reduce if( ips.empty() ) return false; int n = INT_MAX; VECTOR2I ipoint; // if there is more than one intersection, find the one that is // closest to the beginning of the tail. for( const SHAPE_LINE_CHAIN::INTERSECTION& i : ips ) { if( i.index_our < n ) { n = i.index_our; ipoint = i.p; } } // ignore the point where head and tail meet if( ipoint == head.CPoint( 0 ) || ipoint == tail.CPoint( -1 ) ) return false; // Intersection point is on the first or the second segment: just start routing // from the beginning if( n < 2 ) { m_p_start = tail.CPoint( 0 ); m_direction = m_initial_direction; tail.Clear(); head.Clear(); return true; } else { // Clip till the last tail segment before intersection. // Set the direction to the one of this segment. const SEG last = tail.CSegment( n - 1 ); m_p_start = last.A; m_direction = DIRECTION_45( last ); tail.Remove( n, -1 ); return true; } return false; } bool LINE_PLACER::handlePullback() { SHAPE_LINE_CHAIN& head = m_head.Line(); SHAPE_LINE_CHAIN& tail = m_tail.Line(); if( head.PointCount() < 2 ) return false; int n = tail.PointCount(); if( n == 0 ) { return false; } else if( n == 1 ) { m_p_start = tail.CPoint( 0 ); tail.Clear(); return true; } DIRECTION_45 first_head, last_tail; wxASSERT( tail.PointCount() >= 2 ); if( !head.IsPtOnArc( 0 ) ) first_head = DIRECTION_45( head.CSegment( 0 ) ); else first_head = DIRECTION_45( head.CArcs()[head.ArcIndex(0)] ); int lastSegIdx = tail.PointCount() - 2; if( !tail.IsPtOnArc( lastSegIdx ) ) last_tail = DIRECTION_45( tail.CSegment( lastSegIdx ) ); else last_tail = DIRECTION_45( tail.CArcs()[tail.ArcIndex(lastSegIdx)] ); DIRECTION_45::AngleType angle = first_head.Angle( last_tail ); // case 1: we have a defined routing direction, and the currently computed // head goes in different one. bool pullback_1 = false; // (m_direction != DIRECTION_45::UNDEFINED && m_direction != first_head); // case 2: regardless of the current routing direction, if the tail/head // extremities form an acute or right angle, reduce the tail by one segment // (and hope that further iterations) will result with a cleaner trace bool pullback_2 = ( angle == DIRECTION_45::ANG_RIGHT || angle == DIRECTION_45::ANG_ACUTE ); if( pullback_1 || pullback_2 ) { lastSegIdx = tail.PrevShape( -1 ); if( !tail.IsPtOnArc( lastSegIdx ) ) { const SEG& seg = tail.CSegment( lastSegIdx ); m_direction = DIRECTION_45( seg ); m_p_start = seg.A; } else { const SHAPE_ARC& arc = tail.CArcs()[tail.ArcIndex( lastSegIdx )]; m_direction = DIRECTION_45( arc ); m_p_start = arc.GetP0(); } wxLogTrace( wxT( "PNS" ), wxT( "Placer: pullback triggered [%d] [%s %s]" ), n, last_tail.Format().c_str(), first_head.Format().c_str() ); // erase the last point in the tail, hoping that the next iteration will // result with a head trace that starts with a segment following our // current direction. if( n < 2 ) tail.Clear(); // don't leave a single-point tail else tail.RemoveShape( -1 ); if( !tail.SegmentCount() ) m_direction = m_initial_direction; return true; } return false; } bool LINE_PLACER::reduceTail( const VECTOR2I& aEnd ) { SHAPE_LINE_CHAIN& head = m_head.Line(); SHAPE_LINE_CHAIN& tail = m_tail.Line(); int n = tail.SegmentCount(); if( head.SegmentCount() < 1 ) return false; // Don't attempt this for too short tails if( n < 2 ) return false; // Start from the segment farthest from the end of the tail // int start_index = std::max(n - 1 - ReductionDepth, 0); DIRECTION_45 new_direction; VECTOR2I new_start; int reduce_index = -1; for( int i = tail.SegmentCount() - 1; i >= 0; i-- ) { const SEG s = tail.CSegment( i ); DIRECTION_45 dir( s ); // calculate a replacement route and check if it matches // the direction of the segment to be replaced SHAPE_LINE_CHAIN replacement = dir.BuildInitialTrace( s.A, aEnd ); if( replacement.SegmentCount() < 1 ) continue; LINE tmp( m_tail, replacement ); if( m_currentNode->CheckColliding( &tmp, ITEM::ANY_T ) ) break; if( DIRECTION_45( replacement.CSegment( 0 ) ) == dir ) { new_start = s.A; new_direction = dir; reduce_index = i; } } if( reduce_index >= 0 ) { wxLogTrace( wxT( "PNS" ), wxT( "Placer: reducing tail: %d" ), reduce_index ); SHAPE_LINE_CHAIN reducedLine = new_direction.BuildInitialTrace( new_start, aEnd ); m_p_start = new_start; m_direction = new_direction; tail.Remove( reduce_index + 1, -1 ); head.Clear(); return true; } if( !tail.SegmentCount() ) m_direction = m_initial_direction; return false; } bool LINE_PLACER::mergeHead() { SHAPE_LINE_CHAIN& head = m_head.Line(); SHAPE_LINE_CHAIN& tail = m_tail.Line(); const int ForbiddenAngles = DIRECTION_45::ANG_ACUTE | DIRECTION_45::ANG_HALF_FULL | DIRECTION_45::ANG_UNDEFINED; head.Simplify(); tail.Simplify(); int n_head = head.ShapeCount(); int n_tail = tail.ShapeCount(); if( n_head < 3 ) { wxLogTrace( wxT( "PNS" ), wxT( "Merge failed: not enough head segs." ) ); return false; } if( n_tail && head.CPoint( 0 ) != tail.CPoint( -1 ) ) { wxLogTrace( wxT( "PNS" ), wxT( "Merge failed: head and tail discontinuous." ) ); return false; } if( m_head.CountCorners( ForbiddenAngles ) != 0 ) return false; DIRECTION_45 dir_tail, dir_head; if( !head.IsPtOnArc( 0 ) ) dir_head = DIRECTION_45( head.CSegment( 0 ) ); else dir_head = DIRECTION_45( head.CArcs()[head.ArcIndex( 0 )] ); if( n_tail ) { wxASSERT( tail.PointCount() >= 2 ); int lastSegIdx = tail.PointCount() - 2; if( !tail.IsPtOnArc( lastSegIdx ) ) dir_tail = DIRECTION_45( tail.CSegment( -1 ) ); else dir_tail = DIRECTION_45( tail.CArcs()[tail.ArcIndex( lastSegIdx )] ); if( dir_head.Angle( dir_tail ) & ForbiddenAngles ) return false; } tail.Append( head ); tail.Simplify(); SEG last = tail.CSegment( -1 ); m_p_start = last.B; int lastSegIdx = tail.PointCount() - 2; if( !tail.IsArcSegment( lastSegIdx ) ) m_direction = DIRECTION_45( tail.CSegment( -1 ) ); else m_direction = DIRECTION_45( tail.CArcs()[tail.ArcIndex( lastSegIdx )] ); head.Remove( 0, -1 ); wxLogTrace( wxT( "PNS" ), wxT( "Placer: merge %d, new direction: %s" ), n_head, m_direction.Format().c_str() ); head.Simplify(); tail.Simplify(); return true; } VECTOR2I closestProjectedPoint( const SHAPE_LINE_CHAIN& line, const VECTOR2I& p ) { // Keep distances squared for performance SEG::ecoord min_dist_sq = VECTOR2I::ECOORD_MAX; VECTOR2I closest; for( int i = 0; i < line.SegmentCount(); i++ ) { const SEG& s = line.CSegment( i ); VECTOR2I a = s.NearestPoint( p ); int d_sq = (a - p).SquaredEuclideanNorm(); if( d_sq < min_dist_sq ) { min_dist_sq = d_sq; closest = a; } } return closest; } static bool cursorDistMinimum( const SHAPE_LINE_CHAIN& aL, const VECTOR2I& aCursor, double lengthThreshold, int& theDist, VECTOR2I& aNearest ) { std::vector dists; std::vector pts; if( aL.PointCount() == 0 ) return false; VECTOR2I lastP = aL.CPoint(-1); int accumulatedDist = 0; dists.reserve( 2 * aL.PointCount() ); for( int i = 0; i < aL.SegmentCount(); i++ ) { const SEG& s = aL.CSegment( i ); dists.push_back( ( aCursor - s.A ).EuclideanNorm() ); pts.push_back( s.A ); auto pn = s.NearestPoint( aCursor ); if( pn != s.A && pn != s.B ) { dists.push_back( ( pn - aCursor ).EuclideanNorm() ); pts.push_back( pn ); } accumulatedDist += s.Length(); if ( accumulatedDist > lengthThreshold ) { lastP = s.B; break; } } dists.push_back( ( aCursor - lastP ).EuclideanNorm() ); pts.push_back( lastP ); int minDistLoc = std::numeric_limits::max(); int minPLoc = -1; int minDistGlob = std::numeric_limits::max(); int minPGlob = -1; for( int i = 0; i < dists.size(); i++ ) { int d = dists[i]; if( d < minDistGlob ) { minDistGlob = d; minPGlob = i; } } if( dists.size() >= 3 ) { for( int i = 0; i < dists.size() - 3; i++ ) { if( dists[i + 2] > dists[i + 1] && dists[i] > dists[i + 1] ) { int d = dists[i + 1]; if( d < minDistLoc ) { minDistLoc = d; minPLoc = i + 1; } } } if( dists.back() < minDistLoc && minPLoc >= 0 ) { minDistLoc = dists.back(); minPLoc = dists.size() - 1; } } else { // Too few points: just use the global minDistLoc = minDistGlob; minPLoc = minPGlob; } // fixme: I didn't make my mind yet if local or global minimum feels better. I'm leaving both // in the code, enabling the global one by default minPLoc = -1; if( minPLoc < 0 ) { theDist = minDistGlob; aNearest = pts[minPGlob]; return true; } else { theDist = minDistLoc; aNearest = pts[minPLoc]; return true; } } bool LINE_PLACER::rhWalkOnly( const VECTOR2I& aP, LINE& aNewHead ) { LINE initTrack( m_head ); LINE walkFull( m_head ); initTrack.RemoveVia(); walkFull.RemoveVia(); int effort = 0; bool viaOk = false; VECTOR2I walkP = aP; WALKAROUND walkaround( m_currentNode, Router() ); walkaround.SetSolidsOnly( false ); walkaround.SetDebugDecorator( Dbg() ); walkaround.SetLogger( Logger() ); walkaround.SetIterationLimit( Settings().WalkaroundIterationLimit() ); char name[50]; int round = 0; do { snprintf( name, sizeof( name ), "walk-round-%d", round ); PNS_DBG( Dbg(), BeginGroup, name ); viaOk = buildInitialLine( walkP, initTrack, round == 0 ); double initialLength = initTrack.CLine().Length(); double hugThresholdLength = initialLength * Settings().WalkaroundHugLengthThreshold(); WALKAROUND::RESULT wr = walkaround.Route( initTrack ); SHAPE_LINE_CHAIN l_cw = wr.lineCw.CLine(); SHAPE_LINE_CHAIN l_ccw = wr.lineCcw.CLine(); if( wr.statusCcw == WALKAROUND::DONE || wr.statusCw == WALKAROUND::DONE ) { int len_cw = wr.statusCw == WALKAROUND::DONE ? l_cw.Length() : INT_MAX; int len_ccw = wr.statusCcw == WALKAROUND::DONE ? l_ccw.Length() : INT_MAX; PNS_DBG( Dbg(), AddLine, wr.lineCw.CLine(), CYAN, 10000, "wf-result-cw" ); PNS_DBG( Dbg(), AddLine, wr.lineCcw.CLine(), BLUE, 20000, "wf-result-ccw" ); int bestLength = len_cw < len_ccw ? len_cw : len_ccw; if( bestLength > hugThresholdLength ) { wr.statusCw = WALKAROUND::ALMOST_DONE; wr.statusCcw = WALKAROUND::ALMOST_DONE; } SHAPE_LINE_CHAIN& bestLine = len_cw < len_ccw ? l_cw : l_ccw; walkFull.SetShape( bestLine ); } if( wr.statusCcw == WALKAROUND::ALMOST_DONE || wr.statusCw == WALKAROUND::ALMOST_DONE ) { bool valid_cw = false, valid_ccw = false; VECTOR2I p_cw, p_ccw; int dist_ccw = 0, dist_cw = 0; if( wr.statusCcw == WALKAROUND::ALMOST_DONE ) { valid_ccw = cursorDistMinimum( l_ccw, aP, hugThresholdLength, dist_ccw, p_ccw ); if( valid_ccw ) { int idx_ccw = l_ccw.Split( p_ccw ); l_ccw = l_ccw.Slice( 0, idx_ccw ); PNS_DBG( Dbg(), AddPoint, p_ccw, BLUE, 500000, "hug-target-ccw" ); PNS_DBG( Dbg(), AddLine, l_ccw, MAGENTA, 200000, "wh-result-ccw" ); } } if( wr.statusCw == WALKAROUND::ALMOST_DONE ) { valid_cw = cursorDistMinimum( l_cw, aP, hugThresholdLength, dist_cw, p_cw ); if( valid_cw ) { int idx_cw = l_cw.Split( p_cw ); l_cw = l_cw.Slice( 0, idx_cw ); PNS_DBG( Dbg(), AddPoint, p_cw, YELLOW, 500000, "hug-target-cw" ); PNS_DBG( Dbg(), AddLine, l_cw, BLUE, 200000, "wh-result-cw" ); } } if( dist_cw < dist_ccw && valid_cw ) { walkFull.SetShape( l_cw ); walkP = p_cw; } else if ( valid_ccw ) { walkFull.SetShape( l_ccw ); walkP = p_ccw; } else { PNS_DBGN( Dbg(), EndGroup ); return false; } } else if ( wr.statusCcw == WALKAROUND::STUCK || wr.statusCw == WALKAROUND::STUCK ) { PNS_DBGN( Dbg(), EndGroup ); return false; } PNS_DBGN( Dbg(), EndGroup ); round++; } while( round < 2 && m_placingVia ); PNS_DBG( Dbg(), AddLine, walkFull.CLine(), GREEN, 200000, "walk-full" ); switch( Settings().OptimizerEffort() ) { case OE_LOW: effort = 0; break; case OE_MEDIUM: case OE_FULL: effort = OPTIMIZER::MERGE_SEGMENTS; break; } DIRECTION_45::CORNER_MODE cornerMode = Settings().GetCornerMode(); // Smart Pads is incompatible with 90-degree mode for now if( Settings().SmartPads() && ( cornerMode == DIRECTION_45::MITERED_45 || cornerMode == DIRECTION_45::ROUNDED_45 ) && !m_mouseTrailTracer.IsManuallyForced() ) { effort |= OPTIMIZER::SMART_PADS; } if( m_placingVia && viaOk ) { walkFull.AppendVia( makeVia( walkFull.CPoint( -1 ) ) ); } OPTIMIZER::Optimize( &walkFull, effort, m_currentNode ); if( m_currentNode->CheckColliding( &walkFull ) ) { return false; } aNewHead = walkFull; return true; } bool LINE_PLACER::rhMarkObstacles( const VECTOR2I& aP, LINE& aNewHead ) { buildInitialLine( aP, m_head ); m_head.SetBlockingObstacle( nullptr ); // Note: Something like the below could be used to implement a "stop at first obstacle" mode, // but we don't have one right now and there isn't a lot of demand for one. If we do end up // doing that, put it in a new routing mode as "highlight collisions" mode should not have // collision handling other than highlighting. #if 0 if( !Settings().AllowDRCViolations() ) { NODE::OPT_OBSTACLE obs = m_currentNode->NearestObstacle( &m_head ); if( obs && obs->m_distFirst != INT_MAX ) { buildInitialLine( obs->m_ipFirst, m_head ); m_head.SetBlockingObstacle( obs->m_item ); } } #endif aNewHead = m_head; return true; } bool LINE_PLACER::rhShoveOnly( const VECTOR2I& aP, LINE& aNewHead ) { LINE initTrack( m_head ); LINE walkSolids, l2; bool viaOk = buildInitialLine( aP, initTrack ); m_currentNode = m_shove->CurrentNode(); m_shove->SetLogger( Logger() ); m_shove->SetDebugDecorator( Dbg() ); OPTIMIZER optimizer( m_currentNode ); WALKAROUND walkaround( m_currentNode, Router() ); walkaround.SetSolidsOnly( true ); walkaround.SetIterationLimit( 10 ); walkaround.SetDebugDecorator( Dbg() ); walkaround.SetLogger( Logger() ); WALKAROUND::WALKAROUND_STATUS stat_solids = walkaround.Route( initTrack, walkSolids ); optimizer.SetEffortLevel( OPTIMIZER::MERGE_SEGMENTS ); optimizer.SetCollisionMask( ITEM::SOLID_T ); optimizer.Optimize( &walkSolids ); if( stat_solids == WALKAROUND::DONE ) l2 = walkSolids; else l2 = initTrack.ClipToNearestObstacle( m_shove->CurrentNode() ); LINE l( m_tail ); l.Line().Append( l2.CLine() ); l.Line().Simplify(); if( l.PointCount() == 0 || l2.PointCount() == 0 ) { aNewHead = m_head; return false; } if( m_placingVia && viaOk ) { VIA v1( makeVia( l.CPoint( -1 ) ) ); VIA v2( makeVia( l2.CPoint( -1 ) ) ); l.AppendVia( v1 ); l2.AppendVia( v2 ); } l.Line().Simplify(); // in certain, uncommon cases there may be loops in the head+tail, In such case, we don't // shove to avoid screwing up the database. if( l.HasLoops() ) { aNewHead = m_head; return false; } if( m_endItem ) { // Make sure the springback algorithm won't erase the NODE that owns m_endItem. m_shove->SetSpringbackDoNotTouchNode( m_endItem->Owner() ); } SHOVE::SHOVE_STATUS status = m_shove->ShoveLines( l ); m_currentNode = m_shove->CurrentNode(); if( status == SHOVE::SH_OK || status == SHOVE::SH_HEAD_MODIFIED ) { if( status == SHOVE::SH_HEAD_MODIFIED ) l2 = m_shove->NewHead(); optimizer.SetWorld( m_currentNode ); int effortLevel = OPTIMIZER::MERGE_OBTUSE; if( Settings().SmartPads() && !m_mouseTrailTracer.IsManuallyForced() ) effortLevel = OPTIMIZER::SMART_PADS; optimizer.SetEffortLevel( effortLevel ); optimizer.SetCollisionMask( ITEM::ANY_T ); optimizer.Optimize( &l2 ); aNewHead = l2; return true; } else { walkaround.SetWorld( m_currentNode ); walkaround.SetSolidsOnly( false ); walkaround.SetIterationLimit( 10 ); walkaround.SetApproachCursor( true, aP ); walkaround.Route( initTrack, l2 ); aNewHead = l2.ClipToNearestObstacle( m_shove->CurrentNode() ); return false; } return false; } bool LINE_PLACER::routeHead( const VECTOR2I& aP, LINE& aNewHead ) { switch( Settings().Mode() ) { case RM_MarkObstacles: return rhMarkObstacles( aP, aNewHead ); case RM_Walkaround: return rhWalkOnly( aP, aNewHead ); case RM_Shove: return rhShoveOnly( aP, aNewHead ); default: break; } return false; } bool LINE_PLACER::optimizeTailHeadTransition() { LINE linetmp = Trace(); PNS_DBG( Dbg(), Message, "optimize HT" ); // NOTE: FANOUT_CLEANUP can override posture setting at the moment if( !m_mouseTrailTracer.IsManuallyForced() && OPTIMIZER::Optimize( &linetmp, OPTIMIZER::FANOUT_CLEANUP, m_currentNode ) ) { if( linetmp.SegmentCount() < 1 ) return false; m_head = linetmp; m_p_start = linetmp.CLine().CPoint( 0 ); m_direction = DIRECTION_45( linetmp.CSegment( 0 ) ); m_tail.Line().Clear(); PNS_DBG( Dbg(), Message, wxString::Format( "Placer: optimize fanout-cleanup" ) ); return true; } SHAPE_LINE_CHAIN& head = m_head.Line(); SHAPE_LINE_CHAIN& tail = m_tail.Line(); int tailLookbackSegments = 3; //if(m_currentMode() == RM_Walkaround) // tailLookbackSegments = 10000; int threshold = std::min( tail.PointCount(), tailLookbackSegments + 1 ); if( tail.ShapeCount() < 3 ) return false; // assemble TailLookbackSegments tail segments with the current head SHAPE_LINE_CHAIN opt_line = tail.Slice( -threshold, -1 ); int end = std::min(2, head.PointCount() - 1 ); opt_line.Append( head.Slice( 0, end ) ); LINE new_head( m_tail, opt_line ); // and see if it could be made simpler by merging obtuse/collnear segments. // If so, replace the (threshold) last tail points and the head with // the optimized line PNS_DBG( Dbg(), AddLine, new_head.CLine(), LIGHTCYAN, 10000, "ht-newline" ); if( OPTIMIZER::Optimize( &new_head, OPTIMIZER::MERGE_SEGMENTS, m_currentNode ) ) { LINE tmp( m_tail, opt_line ); PNS_DBG( Dbg(), Message, wxString::Format( "Placer: optimize tail-head [%d]", threshold ) ); head.Clear(); tail.Replace( -threshold, -1, new_head.CLine() ); tail.Simplify(); m_p_start = new_head.CLine().CPoint( -1 ); m_direction = DIRECTION_45( new_head.CSegment( -1 ) ); return true; } return false; } void LINE_PLACER::routeStep( const VECTOR2I& aP ) { bool fail = false; bool go_back = false; int i, n_iter = 1; LINE new_head; wxLogTrace( wxT( "PNS" ), wxT( "routeStep: direction: %s head: %d, tail: %d shapes" ), m_direction.Format().c_str(), m_head.ShapeCount(), m_tail.ShapeCount() ); PNS_DBG( Dbg(), BeginGroup, "route-step" ); PNS_DBG( Dbg(), AddLine, m_tail.CLine(), WHITE, 10000, "tail-init" ); PNS_DBG( Dbg(), AddLine, m_head.CLine(), GREEN, 10000, "head-init" ); for( i = 0; i < n_iter; i++ ) { if( !go_back && Settings().FollowMouse() ) reduceTail( aP ); PNS_DBG( Dbg(), AddLine, m_tail.CLine(), WHITE, 10000, "tail-after-reduce" ); PNS_DBG( Dbg(), AddLine, m_head.CLine(), GREEN, 10000, "head-after-reduce" ); go_back = false; if( !routeHead( aP, new_head ) ) fail = true; if( !new_head.Is45Degree() && !(Settings().GetFreeAngleMode() && Settings().Mode() == RM_MarkObstacles) ) fail = true; if( fail ) break; m_head = new_head; PNS_DBG( Dbg(), AddLine, m_head.CLine(), LIGHTGREEN, 100000, "head-new" ); if( handleSelfIntersections() ) { n_iter++; go_back = true; } PNS_DBG( Dbg(), AddLine, m_tail.CLine(), WHITE, 10000, "tail-after-si" ); PNS_DBG( Dbg(), AddLine, m_head.CLine(), GREEN, 10000, "head-after-si" ); if( !go_back && handlePullback() ) { n_iter++; go_back = true; } PNS_DBG( Dbg(), AddLine, m_tail.CLine(), WHITE, 100000, "tail-after-pb" ); PNS_DBG( Dbg(), AddLine, m_head.CLine(), GREEN, 100000, "head-after-pb" ); } if( fail ) { if( m_last_head.PointCount() > 0 ) { m_head = m_last_head; } else { m_head.RemoveVia(); m_head.Clear(); } } else { m_last_head = m_head; } if( !fail && Settings().FollowMouse() ) { PNS_DBG( Dbg(), AddLine, m_tail.CLine(), WHITE, 10000, "tail-pre-merge" ); PNS_DBG( Dbg(), AddLine, m_head.CLine(), GREEN, 10000, "head-pre-merge" ); if( !optimizeTailHeadTransition() ) { mergeHead(); } PNS_DBG( Dbg(), AddLine, m_tail.CLine(), WHITE, 100000, "tail-post-merge" ); PNS_DBG( Dbg(), AddLine, m_head.CLine(), GREEN, 100000, "head-post-merge" ); } PNS_DBGN( Dbg(), EndGroup ); } bool LINE_PLACER::route( const VECTOR2I& aP ) { routeStep( aP ); if (!m_head.PointCount() ) return false; return m_head.CPoint(-1) == aP; } const LINE LINE_PLACER::Trace() const { LINE tmp( m_head ); tmp.SetShape( m_tail.CLine() ); tmp.Line().Append( m_head.CLine() ); tmp.Line().Simplify(); return tmp; } const ITEM_SET LINE_PLACER::Traces() { m_currentTrace = Trace(); return ITEM_SET( &m_currentTrace ); } void LINE_PLACER::FlipPosture() { m_mouseTrailTracer.FlipPosture(); } NODE* LINE_PLACER::CurrentNode( bool aLoopsRemoved ) const { if( aLoopsRemoved && m_lastNode ) return m_lastNode; return m_currentNode; } bool LINE_PLACER::SplitAdjacentSegments( NODE* aNode, ITEM* aSeg, const VECTOR2I& aP ) { if( !aSeg ) return false; if( !aSeg->OfKind( ITEM::SEGMENT_T ) ) return false; JOINT* jt = aNode->FindJoint( aP, aSeg ); if( jt && jt->LinkCount() >= 1 ) return false; SEGMENT* s_old = static_cast( aSeg ); std::unique_ptr s_new[2] = { Clone( *s_old ), Clone( *s_old ) }; s_new[0]->SetEnds( s_old->Seg().A, aP ); s_new[1]->SetEnds( aP, s_old->Seg().B ); aNode->Remove( s_old ); aNode->Add( std::move( s_new[0] ), true ); aNode->Add( std::move( s_new[1] ), true ); return true; } bool LINE_PLACER::SetLayer( int aLayer ) { if( m_idle ) { m_currentLayer = aLayer; return true; } else if( m_chainedPlacement ) { return false; } else if( !m_startItem || ( m_startItem->OfKind( ITEM::VIA_T ) && m_startItem->Layers().Overlaps( aLayer ) ) || ( m_startItem->OfKind( ITEM::SOLID_T ) && m_startItem->Layers().Overlaps( aLayer ) ) ) { m_currentLayer = aLayer; m_p_start = m_currentStart; m_direction = m_initial_direction; m_mouseTrailTracer.Clear(); m_head.Line().Clear(); m_tail.Line().Clear(); m_last_head.Line().Clear(); m_head.RemoveVia(); m_tail.RemoveVia(); m_last_head.RemoveVia(); m_head.SetLayer( m_currentLayer ); m_tail.SetLayer( m_currentLayer ); Move( m_currentEnd, nullptr ); return true; } return false; } bool LINE_PLACER::Start( const VECTOR2I& aP, ITEM* aStartItem ) { m_placementCorrect = false; m_currentStart = VECTOR2I( aP ); m_currentEnd = VECTOR2I( aP ); m_currentNet = std::max( 0, aStartItem ? aStartItem->Net() : 0 ); m_startItem = aStartItem; m_placingVia = false; m_chainedPlacement = false; m_fixedTail.Clear(); m_endItem = nullptr; setInitialDirection( Settings().InitialDirection() ); initPlacement(); DIRECTION_45 initialDir = m_initial_direction; DIRECTION_45 lastSegDir = DIRECTION_45::UNDEFINED; if( aStartItem && aStartItem->Kind() == ITEM::SEGMENT_T ) { // If we land on a segment endpoint, assume the starting direction is continuing along // the same direction as the endpoint. If we started in the middle, don't set a // direction so that the posture solver is not biased. SEG seg = static_cast( aStartItem )->Seg(); if( aP == seg.A ) lastSegDir = DIRECTION_45( seg.Reversed() ); else if( aP == seg.B ) lastSegDir = DIRECTION_45( seg ); } else if( aStartItem && aStartItem->Kind() == ITEM::SOLID_T && static_cast( aStartItem )->Parent()->Type() == PCB_PAD_T ) { double angle = static_cast( aStartItem )->GetOrientation() / 10.0; angle = ( angle + 22.5 ) / 45.0; initialDir = DIRECTION_45( static_cast( int( angle ) ) ); } wxLogTrace( wxT( "PNS" ), wxT( "Posture: init %s, last seg %s" ), initialDir.Format(), lastSegDir.Format() ); m_mouseTrailTracer.Clear(); m_mouseTrailTracer.AddTrailPoint( aP ); m_mouseTrailTracer.SetTolerance( m_head.Width() ); m_mouseTrailTracer.SetDefaultDirections( m_initial_direction, DIRECTION_45::UNDEFINED ); m_mouseTrailTracer.SetMouseDisabled( !Settings().GetAutoPosture() ); NODE *n; if ( Settings().Mode() == PNS::RM_Shove ) n = m_shove->CurrentNode(); else n = m_currentNode; m_fixedTail.AddStage( m_currentStart, m_currentLayer, m_placingVia, m_direction, n ); return true; } void LINE_PLACER::initPlacement() { m_idle = false; m_head.Line().Clear(); m_tail.Line().Clear(); m_head.SetNet( m_currentNet ); m_tail.SetNet( m_currentNet ); m_head.SetLayer( m_currentLayer ); m_tail.SetLayer( m_currentLayer ); m_head.SetWidth( m_sizes.TrackWidth() ); m_tail.SetWidth( m_sizes.TrackWidth() ); m_head.RemoveVia(); m_tail.RemoveVia(); m_p_start = m_currentStart; m_direction = m_initial_direction; NODE* world = Router()->GetWorld(); world->KillChildren(); NODE* rootNode = world->Branch(); SplitAdjacentSegments( rootNode, m_startItem, m_currentStart ); setWorld( rootNode ); wxLogTrace( wxT( "PNS" ), wxT( "world %p, intitial-direction %s layer %d" ), m_world, m_direction.Format().c_str(), m_currentLayer ); m_lastNode = nullptr; m_currentNode = m_world; m_shove = std::make_unique( m_world->Branch(), Router() ); } bool LINE_PLACER::Move( const VECTOR2I& aP, ITEM* aEndItem ) { LINE current; VECTOR2I p = aP; int eiDepth = -1; if( aEndItem && aEndItem->Owner() ) eiDepth = static_cast( aEndItem->Owner() )->Depth(); if( m_lastNode ) { delete m_lastNode; m_lastNode = nullptr; } m_endItem = aEndItem; bool reachesEnd = route( p ); current = Trace(); if( !current.PointCount() ) m_currentEnd = m_p_start; else m_currentEnd = current.CLine().CPoint( -1 ); NODE* latestNode = m_currentNode; m_lastNode = latestNode->Branch(); if( reachesEnd && eiDepth >= 0 && aEndItem && latestNode->Depth() >= eiDepth && current.SegmentCount() ) { SplitAdjacentSegments( m_lastNode, aEndItem, current.CPoint( -1 ) ); if( Settings().RemoveLoops() ) removeLoops( m_lastNode, current ); } updateLeadingRatLine(); m_mouseTrailTracer.AddTrailPoint( aP ); return true; } bool LINE_PLACER::FixRoute( const VECTOR2I& aP, ITEM* aEndItem, bool aForceFinish ) { bool fixAll = Settings().GetFixAllSegments(); bool realEnd = false; LINE pl = Trace(); if( Settings().Mode() == RM_MarkObstacles ) { // Mark Obstacles is sort of a half-manual, half-automated mode in which the // user has more responsibility and authority. if( aEndItem ) { // The user has indicated a connection should be made. If either the trace or // endItem is net-less, then allow the connection by adopting the net of the other. if( m_currentNet <= 0 ) { m_currentNet = aEndItem->Net(); pl.SetNet( m_currentNet ); } else if (aEndItem->Net() <= 0 ) { aEndItem->SetNet( m_currentNet ); } } // Collisions still prevent fixing unless "Allow DRC violations" is checked if( !Settings().AllowDRCViolations() && m_world->CheckColliding( &pl ) ) return false; } const SHAPE_LINE_CHAIN& l = pl.CLine(); if( !l.SegmentCount() ) { if( m_lastNode ) { // Do a final optimization to the stored state NODE::ITEM_VECTOR removed, added; m_lastNode->GetUpdatedItems( removed, added ); if( !added.empty() && added.back()->Kind() == ITEM::SEGMENT_T ) simplifyNewLine( m_lastNode, static_cast( added.back() ) ); } // Nothing to commit if we have an empty line if( !pl.EndsWithVia() ) return false; ///< @todo Determine what to do if m_lastNode is a null pointer. I'm guessing return ///< false but someone with more knowledge of the code will need to determine that.. if( m_lastNode ) { m_lastNode->Add( Clone( pl.Via() ) ); m_shove->AddLockedSpringbackNode( m_lastNode ); } m_currentNode = nullptr; m_idle = true; m_placementCorrect = true; return true; } VECTOR2I p_pre_last = l.CPoint( -1 ); const VECTOR2I p_last = l.CPoint( -1 ); if( l.PointCount() > 2 ) p_pre_last = l.CPoint( -2 ); if( aEndItem && m_currentNet >= 0 && m_currentNet == aEndItem->Net() ) realEnd = true; if( aForceFinish ) realEnd = true; // TODO: Rollback doesn't work properly if fix-all isn't enabled and we are placing arcs, // so if we are, act as though we are in fix-all mode. if( !fixAll && l.ArcCount() ) fixAll = true; // TODO: lastDirSeg will be calculated incorrectly if we end on an arc SEG lastDirSeg = ( !fixAll && l.SegmentCount() > 1 ) ? l.CSegment( -2 ) : l.CSegment( -1 ); DIRECTION_45 d_last( lastDirSeg ); int lastV; if( realEnd || m_placingVia || fixAll ) lastV = l.SegmentCount(); else lastV = std::max( 1, l.SegmentCount() - 1 ); ARC arc; SEGMENT seg; LINKED_ITEM* lastItem = nullptr; int lastArc = -1; for( int i = 0; i < lastV; i++ ) { ssize_t arcIndex = l.ArcIndex( i ); if( arcIndex < 0 || ( lastArc >= 0 && i == lastV - 1 && !l.IsPtOnArc( lastV ) ) ) { seg = SEGMENT( pl.CSegment( i ), m_currentNet ); seg.SetWidth( pl.Width() ); seg.SetLayer( m_currentLayer ); std::unique_ptr sp = std::make_unique( seg ); lastItem = sp.get(); if( !m_lastNode->Add( std::move( sp ) ) ) lastItem = nullptr; } else { if( arcIndex == lastArc ) continue; arc = ARC( l.Arc( arcIndex ), m_currentNet ); arc.SetWidth( pl.Width() ); arc.SetLayer( m_currentLayer ); std::unique_ptr ap = std::make_unique( arc ); lastItem = ap.get(); if( !m_lastNode->Add( std::move( ap ) ) ) lastItem = nullptr; lastArc = arcIndex; } } if( pl.EndsWithVia() ) m_lastNode->Add( Clone( pl.Via() ) ); if( realEnd && lastItem ) simplifyNewLine( m_lastNode, lastItem ); if( !realEnd ) { setInitialDirection( d_last ); m_currentStart = ( m_placingVia || fixAll ) ? p_last : p_pre_last; VECTOR2I ps; if( m_tail.SegmentCount() ) ps = m_tail.CPoint( 0 ); else ps = m_p_start; m_fixedTail.AddStage( ps, m_currentLayer, m_placingVia, m_direction, m_currentNode ); m_startItem = nullptr; m_placingVia = false; m_chainedPlacement = !pl.EndsWithVia(); m_p_start = m_currentStart; m_direction = m_initial_direction; m_head.Line().Clear(); m_tail.Line().Clear(); m_head.RemoveVia(); m_tail.RemoveVia(); m_currentNode = m_lastNode; m_lastNode = m_lastNode->Branch(); m_shove->AddLockedSpringbackNode( m_currentNode ); DIRECTION_45 lastSegDir = pl.EndsWithVia() ? DIRECTION_45::UNDEFINED : d_last; m_mouseTrailTracer.Clear(); m_mouseTrailTracer.SetTolerance( m_head.Width() ); m_mouseTrailTracer.AddTrailPoint( m_currentStart ); m_mouseTrailTracer.SetDefaultDirections( m_initial_direction, lastSegDir ); m_placementCorrect = true; } else { m_shove->AddLockedSpringbackNode( m_lastNode ); m_placementCorrect = true; m_idle = true; } return realEnd; } bool LINE_PLACER::UnfixRoute() { FIXED_TAIL::STAGE st; if ( !m_fixedTail.PopStage( st ) ) return false; m_head.Line().Clear(); m_tail.Line().Clear(); m_startItem = nullptr; m_p_start = st.pts[0].p; m_direction = st.pts[0].direction; m_placingVia = st.pts[0].placingVias; m_currentNode = st.commit; m_currentLayer = st.pts[0].layer; m_head.SetLayer( m_currentLayer ); m_tail.SetLayer( m_currentLayer ); m_head.RemoveVia(); m_tail.RemoveVia(); m_mouseTrailTracer.Clear(); m_mouseTrailTracer.SetDefaultDirections( m_initial_direction, m_direction ); m_mouseTrailTracer.AddTrailPoint( m_p_start ); m_shove->RewindSpringbackTo( m_currentNode ); m_shove->UnlockSpringbackNode( m_currentNode ); if( Settings().Mode() == PNS::RM_Shove ) { m_currentNode = m_shove->CurrentNode(); m_currentNode->KillChildren(); } m_lastNode = m_currentNode->Branch(); return true; } bool LINE_PLACER::HasPlacedAnything() const { return m_placementCorrect || m_fixedTail.StageCount() > 1; } bool LINE_PLACER::CommitPlacement() { if( Settings().Mode() == PNS::RM_Shove ) { m_shove->RewindToLastLockedNode(); m_lastNode = m_shove->CurrentNode(); m_lastNode->KillChildren(); } if( m_lastNode ) Router()->CommitRouting( m_lastNode ); m_lastNode = nullptr; m_currentNode = nullptr; return true; } void LINE_PLACER::removeLoops( NODE* aNode, LINE& aLatest ) { if( !aLatest.SegmentCount() ) return; if( aLatest.CLine().CPoint( 0 ) == aLatest.CLine().CPoint( -1 ) ) return; std::set toErase; aNode->Add( aLatest, true ); for( int s = 0; s < aLatest.LinkCount(); s++ ) { LINKED_ITEM* seg = aLatest.GetLink(s); LINE ourLine = aNode->AssembleLine( seg ); JOINT a, b; std::vector lines; aNode->FindLineEnds( ourLine, a, b ); if( a == b ) aNode->FindLineEnds( aLatest, a, b ); aNode->FindLinesBetweenJoints( a, b, lines ); int removedCount = 0; int total = 0; for( LINE& line : lines ) { total++; if( !( line.ContainsLink( seg ) ) && line.SegmentCount() ) { for( LINKED_ITEM* ss : line.Links() ) toErase.insert( ss ); removedCount++; } } wxLogTrace( wxT( "PNS" ), wxT( "total segs removed: %d/%d" ), removedCount, total ); } for( LINKED_ITEM* s : toErase ) aNode->Remove( s ); aNode->Remove( aLatest ); } void LINE_PLACER::simplifyNewLine( NODE* aNode, LINKED_ITEM* aLatest ) { wxASSERT( aLatest->OfKind( ITEM::SEGMENT_T | ITEM::ARC_T ) ); // Before we assemble the final line and run the optimizer, do a separate pass to clean up // colinear segments that exist on non-line-corner joints, as these will prevent proper assembly // of the line and won't get cleaned up by the optimizer. NODE::ITEM_VECTOR removed, added; aNode->GetUpdatedItems( removed, added ); std::set cleanup; auto processJoint = [&]( JOINT* aJoint, ITEM* aItem ) { if( !aJoint || aJoint->IsLineCorner() ) return; SEG refSeg = static_cast( aItem )->Seg(); NODE::ITEM_VECTOR toRemove; for( ITEM* neighbor : aJoint->Links() ) { if( neighbor == aItem || !neighbor->OfKind( ITEM::SEGMENT_T | ITEM::ARC_T ) || !neighbor->LayersOverlap( aItem ) ) { continue; } if( static_cast( neighbor )->Width() != static_cast( aItem )->Width() ) { continue; } const SEG& testSeg = static_cast( neighbor )->Seg(); if( refSeg.Contains( testSeg ) ) { JOINT* nA = aNode->FindJoint( neighbor->Anchor( 0 ), neighbor ); JOINT* nB = aNode->FindJoint( neighbor->Anchor( 1 ), neighbor ); if( ( nA == aJoint && nB->LinkCount() == 1 ) || ( nB == aJoint && nA->LinkCount() == 1 ) ) { cleanup.insert( neighbor ); } } } }; for( ITEM* item : added ) { if( !item->OfKind( ITEM::SEGMENT_T ) || cleanup.count( item ) ) continue; JOINT* jA = aNode->FindJoint( item->Anchor( 0 ), item ); JOINT* jB = aNode->FindJoint( item->Anchor( 1 ), item ); processJoint( jA, item ); processJoint( jB, item ); } for( ITEM* seg : cleanup ) aNode->Remove( seg ); // And now we can proceed with assembling the final line and optimizing it. LINE l = aNode->AssembleLine( aLatest ); bool optimized = OPTIMIZER::Optimize( &l, OPTIMIZER::MERGE_COLINEAR, aNode ); SHAPE_LINE_CHAIN simplified( l.CLine() ); simplified.Simplify(); if( optimized || simplified.PointCount() != l.PointCount() ) { aNode->Remove( l ); l.SetShape( simplified ); aNode->Add( l ); } } void LINE_PLACER::UpdateSizes( const SIZES_SETTINGS& aSizes ) { m_sizes = aSizes; if( !m_idle ) { // If the track width continues from an existing track, we don't want to change the width. // Disallow changing width after the first segment has been fixed because we don't want to // go back and rip up tracks or allow DRC errors if( m_sizes.TrackWidthIsExplicit() || ( !HasPlacedAnything() && ( !m_startItem || m_startItem->Kind() != ITEM::SEGMENT_T ) ) ) { m_head.SetWidth( m_sizes.TrackWidth() ); m_tail.SetWidth( m_sizes.TrackWidth() ); m_currentTrace.SetWidth( m_sizes.TrackWidth() ); } if( m_head.EndsWithVia() ) { m_head.SetViaDiameter( m_sizes.ViaDiameter() ); m_head.SetViaDrill( m_sizes.ViaDrill() ); } } } void LINE_PLACER::updateLeadingRatLine() { LINE current = Trace(); SHAPE_LINE_CHAIN ratLine; TOPOLOGY topo( m_lastNode ); if( topo.LeadingRatLine( ¤t, ratLine ) ) m_router->GetInterface()->DisplayRatline( ratLine, 5 ); } void LINE_PLACER::SetOrthoMode( bool aOrthoMode ) { m_orthoMode = aOrthoMode; } bool LINE_PLACER::buildInitialLine( const VECTOR2I& aP, LINE& aHead, bool aForceNoVia ) { SHAPE_LINE_CHAIN l; DIRECTION_45 guessedDir = m_mouseTrailTracer.GetPosture( aP ); wxLogTrace( wxT( "PNS" ), wxT( "buildInitialLine: m_direction %s, guessedDir %s, tail points %d" ), m_direction.Format(), guessedDir.Format(), m_tail.PointCount() ); DIRECTION_45::CORNER_MODE cornerMode = Settings().GetCornerMode(); // Rounded corners don't make sense when routing orthogonally (single track at a time) if( m_orthoMode ) cornerMode = DIRECTION_45::CORNER_MODE::MITERED_45; if( m_p_start == aP ) { l.Clear(); } else { if( Settings().GetFreeAngleMode() && Settings().Mode() == RM_MarkObstacles ) { l = SHAPE_LINE_CHAIN( { m_p_start, aP } ); } else { if( !m_tail.PointCount() ) l = guessedDir.BuildInitialTrace( m_p_start, aP, false, cornerMode ); else l = m_direction.BuildInitialTrace( m_p_start, aP, false, cornerMode ); } if( l.SegmentCount() > 1 && m_orthoMode ) { VECTOR2I newLast = l.CSegment( 0 ).LineProject( l.CPoint( -1 ) ); l.Remove( -1, -1 ); l.SetPoint( 1, newLast ); } } aHead.SetLayer( m_currentLayer ); aHead.SetShape( l ); if( !m_placingVia || aForceNoVia ) return true; VIA v( makeVia( aP ) ); v.SetNet( aHead.Net() ); if( Settings().Mode() == RM_MarkObstacles ) { aHead.AppendVia( v ); return true; } VECTOR2I force; VECTOR2I lead = aP - m_p_start; bool solidsOnly = ( Settings().Mode() != RM_Walkaround ); if( v.PushoutForce( m_currentNode, lead, force, solidsOnly, 40 ) ) { SHAPE_LINE_CHAIN line = guessedDir.BuildInitialTrace( m_p_start, aP + force, false, cornerMode ); aHead = LINE( aHead, line ); v.SetPos( v.Pos() + force ); return true; } return false; // via placement unsuccessful } void LINE_PLACER::GetModifiedNets( std::vector& aNets ) const { aNets.push_back( m_currentNet ); } bool LINE_PLACER::AbortPlacement() { m_world->KillChildren(); return true; } FIXED_TAIL::FIXED_TAIL( int aLineCount ) { } FIXED_TAIL::~FIXED_TAIL() { } void FIXED_TAIL::Clear() { m_stages.clear(); } void FIXED_TAIL::AddStage( const VECTOR2I& aStart, int aLayer, bool placingVias, DIRECTION_45 direction, NODE* aNode ) { STAGE st; FIX_POINT pt; pt.p = aStart; pt.layer = aLayer; pt.direction = direction; pt.placingVias = placingVias; st.pts.push_back(pt); st.commit = aNode; m_stages.push_back( st ); } bool FIXED_TAIL::PopStage( FIXED_TAIL::STAGE& aStage ) { if( !m_stages.size() ) return false; aStage = m_stages.back(); if( m_stages.size() > 1 ) m_stages.pop_back(); return true; } int FIXED_TAIL::StageCount() const { return m_stages.size(); } }