kicad/pcbnew/router/pns_dragger.cpp

783 lines
19 KiB
C++
Raw Normal View History

/*
* KiRouter - a push-and-(sometimes-)shove PCB router
*
* Copyright (C) 2013-2014 CERN
* Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
* Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "pns_arc.h"
#include "pns_dragger.h"
#include "pns_shove.h"
#include "pns_router.h"
#include "pns_debug_decorator.h"
#include "pns_walkaround.h"
namespace PNS {
DRAGGER::DRAGGER( ROUTER* aRouter ) :
DRAG_ALGO( aRouter ),
m_initialVia( {} ),
m_draggedVia( {} )
{
2021-07-19 23:56:05 +00:00
m_world = nullptr;
m_lastNode = nullptr;
m_mode = DM_SEGMENT;
m_draggedSegmentIndex = 0;
m_dragStatus = false;
m_currentMode = RM_MarkObstacles;
m_freeAngleMode = false;
}
DRAGGER::~DRAGGER()
{
}
bool DRAGGER::propagateViaForces( NODE* node, std::set<VIA*>& vias )
{
VIA* via = *vias.begin();
VECTOR2I force;
VECTOR2I lead = -m_mouseTrailTracer.GetTrailLeadVector();
const int iterLimit = Settings().ViaForcePropIterationLimit();
if( via->PushoutForce( node, lead, force, ITEM::ANY_T, iterLimit ) )
{
via->SetPos( via->Pos() + force );
return true;
}
return false;
}
VVIA* DRAGGER::checkVirtualVia( const VECTOR2D& aP, SEGMENT* aSeg )
{
int w2 = aSeg->Width() / 2;
auto distA = ( aP - aSeg->Seg().A ).EuclideanNorm();
auto distB = ( aP - aSeg->Seg().B ).EuclideanNorm();
VECTOR2I psnap;
if( distA <= w2 )
{
psnap = aSeg->Seg().A;
}
else if( distB <= w2 )
{
psnap = aSeg->Seg().B;
}
else
{
return nullptr;
}
const JOINT *jt = m_world->FindJoint( psnap, aSeg );
if ( !jt )
return nullptr;
for( ITEM* item : jt->LinkList() )
{
if( item->IsVirtual() && item->OfKind( ITEM::VIA_T ))
return static_cast<VVIA*>( item );
}
return nullptr;
}
bool DRAGGER::startDragSegment( const VECTOR2D& aP, SEGMENT* aSeg )
{
int w2 = aSeg->Width() / 2;
m_draggedLine = m_world->AssembleLine( aSeg, &m_draggedSegmentIndex );
m_lastDragSolution = m_draggedLine;
if( m_shove )
{
m_shove->SetInitialLine( m_draggedLine );
}
auto distA = ( aP - aSeg->Seg().A ).EuclideanNorm();
auto distB = ( aP - aSeg->Seg().B ).EuclideanNorm();
if( distA < w2 || distB < w2 )
{
m_mode = DM_CORNER;
if( distB <= distA )
m_draggedSegmentIndex++;
}
else if( m_freeAngleMode )
{
if( distB < distA &&
( m_draggedSegmentIndex < m_draggedLine.PointCount() - 2 ) &&
( !m_draggedLine.CLine().IsPtOnArc( static_cast<size_t>(m_draggedSegmentIndex) + 1 ) ) )
{
m_draggedSegmentIndex++;
}
m_mode = DM_CORNER;
}
else
{
m_mode = DM_SEGMENT;
}
return true;
}
bool DRAGGER::startDragArc( const VECTOR2D& aP, ARC* aArc )
{
m_draggedLine = m_world->AssembleLine( aArc, &m_draggedSegmentIndex );
m_shove->SetInitialLine( m_draggedLine );
m_mode = DM_ARC;
return true;
}
bool DRAGGER::startDragVia( VIA* aVia )
{
m_initialVia = aVia->MakeHandle();
m_draggedVia = m_initialVia;
m_mode = DM_VIA;
return true;
}
const ITEM_SET DRAGGER::findViaFanoutByHandle ( NODE *aNode, const VIA_HANDLE& handle )
{
ITEM_SET rv;
const JOINT* jt = aNode->FindJoint( handle.pos, handle.layers.Start(), handle.net );
2015-08-04 09:37:16 +00:00
if( !jt )
return rv;
2015-08-04 09:37:16 +00:00
for( ITEM* item : jt->LinkList() )
{
if( item->OfKind( ITEM::SEGMENT_T | ITEM::ARC_T ) )
{
int segIndex;
LINKED_ITEM* seg = ( LINKED_ITEM*) item;
LINE l = aNode->AssembleLine( seg, &segIndex );
if( segIndex != 0 )
l.Reverse();
rv.Add( l );
}
else if( item->OfKind( ITEM::VIA_T ) )
{
rv.Add( item );
}
}
return rv;
}
bool DRAGGER::Start( const VECTOR2I& aP, ITEM_SET& aPrimitives )
{
if( aPrimitives.Empty() )
return false;
ITEM* startItem = aPrimitives[0];
2021-07-19 23:56:05 +00:00
m_lastNode = nullptr;
m_draggedItems.Clear();
m_currentMode = Settings().Mode();
m_freeAngleMode = (m_mode & DM_FREE_ANGLE);
m_lastValidPoint = aP;
m_mouseTrailTracer.Clear();
m_mouseTrailTracer.AddTrailPoint( aP );
if( m_currentMode == RM_Shove && !m_freeAngleMode )
{
m_shove = std::make_unique<SHOVE>( m_world, Router() );
m_shove->SetLogger( Logger() );
m_shove->SetDebugDecorator( Dbg() );
}
startItem->Unmark( MK_LOCKED );
2021-07-19 23:56:05 +00:00
PNS_DBG( Dbg(), Message, wxString::Format( "StartDragging: item %p [kind %d]",
startItem, (int) startItem->Kind() ) );
switch( startItem->Kind() )
2014-11-14 19:19:00 +00:00
{
case ITEM::SEGMENT_T:
{
SEGMENT* seg = static_cast<SEGMENT*>( startItem );
VVIA* vvia = checkVirtualVia( aP, seg );
if( vvia )
{
return startDragVia( vvia );
}
else
{
return startDragSegment( aP, seg );
}
}
case ITEM::VIA_T:
return startDragVia( static_cast<VIA*>( startItem ) );
case ITEM::ARC_T:
return startDragArc( aP, static_cast<ARC*>( startItem ) );
2015-10-05 16:28:41 +00:00
default:
return false;
2014-11-14 19:19:00 +00:00
}
}
void DRAGGER::SetMode( PNS::DRAG_MODE aMode )
{
m_mode = static_cast<int>( aMode );
}
PNS::DRAG_MODE DRAGGER::Mode() const
{
return static_cast<PNS::DRAG_MODE>( m_mode );
}
const std::vector<NET_HANDLE> DRAGGER::CurrentNets() const
{
if( m_mode == PNS::DM_VIA )
return std::vector<NET_HANDLE>( 1, m_draggedVia.net );
else
return std::vector<NET_HANDLE>( 1, m_draggedLine.Net() );
}
bool DRAGGER::dragMarkObstacles( const VECTOR2I& aP )
2014-11-14 19:19:00 +00:00
{
// fixme: rewrite using shared_ptr...
if( m_lastNode )
{
delete m_lastNode;
m_lastNode = nullptr;
}
m_lastNode = m_world->Branch();
switch( m_mode )
{
case DM_SEGMENT:
case DM_CORNER:
2015-10-05 16:28:41 +00:00
{
//TODO: Make threshold configurable
int thresh = Settings().SmoothDraggedSegments() ? m_draggedLine.Width() / 4 : 0;
LINE origLine( m_draggedLine );
LINE dragged( m_draggedLine );
dragged.SetSnapThreshhold( thresh );
dragged.ClearLinks();
2014-11-14 19:19:00 +00:00
if( m_mode == DM_SEGMENT )
dragged.DragSegment( aP, m_draggedSegmentIndex );
2015-10-05 16:28:41 +00:00
else
dragged.DragCorner( aP, m_draggedSegmentIndex, m_freeAngleMode );
2014-11-14 19:19:00 +00:00
m_lastNode->Remove( origLine );
m_lastNode->Add( dragged );
2014-11-14 19:19:00 +00:00
2015-10-05 16:28:41 +00:00
m_draggedItems.Clear();
m_draggedItems.Add( dragged );
2015-10-05 16:28:41 +00:00
break;
}
case DM_VIA: // fixme...
2015-10-05 16:28:41 +00:00
{
2020-02-06 17:03:18 +00:00
dragViaMarkObstacles( m_initialVia, m_lastNode, aP );
2015-10-05 16:28:41 +00:00
break;
}
}
if( Settings().AllowDRCViolations() )
m_dragStatus = true;
else
m_dragStatus = !m_lastNode->CheckColliding( m_draggedItems );
2014-11-14 19:19:00 +00:00
return true;
}
bool DRAGGER::dragViaMarkObstacles( const VIA_HANDLE& aHandle, NODE* aNode, const VECTOR2I& aP )
{
m_draggedItems.Clear();
ITEM_SET fanout = findViaFanoutByHandle( aNode, aHandle );
2014-11-14 19:19:00 +00:00
if( fanout.Empty() )
{
return true;
}
for( ITEM* item : fanout.Items() )
{
if( const LINE* l = dyn_cast<const LINE*>( item ) )
{
LINE origLine( *l );
LINE draggedLine( *l );
2014-11-14 19:19:00 +00:00
draggedLine.DragCorner( aP, origLine.CLine().Find( aHandle.pos ), m_freeAngleMode );
draggedLine.ClearLinks();
m_draggedItems.Add( draggedLine );
2014-11-14 19:19:00 +00:00
m_lastNode->Remove( origLine );
m_lastNode->Add( draggedLine );
}
else if ( VIA *via = dyn_cast<VIA*>( item ) )
{
auto nvia = Clone( *via );
nvia->SetPos( aP );
m_draggedItems.Add( nvia.get() );
m_lastNode->Remove( via );
m_lastNode->Add( std::move( nvia ) );
}
}
return true;
}
2020-02-06 17:03:18 +00:00
bool DRAGGER::dragViaWalkaround( const VIA_HANDLE& aHandle, NODE* aNode, const VECTOR2I& aP )
2020-02-06 17:03:18 +00:00
{
m_draggedItems.Clear();
ITEM_SET fanout = findViaFanoutByHandle( aNode, aHandle );
if( fanout.Empty() )
{
return true;
2020-02-06 17:03:18 +00:00
}
bool viaPropOk = false;
VECTOR2I viaTargetPos;
2020-02-06 17:03:18 +00:00
for( ITEM* item : fanout.Items() )
{
if ( VIA *via = dyn_cast<VIA*>( item ) )
{
auto draggedVia = Clone( *via );
draggedVia->SetPos( aP );
m_draggedItems.Add( draggedVia.get() );
std::set<VIA*> vias;
vias.insert( draggedVia.get() );
m_lastNode->Remove( via );
bool ok = propagateViaForces( m_lastNode, vias );
if( ok )
{
viaTargetPos = draggedVia->Pos();
viaPropOk = true;
m_lastNode->Add( std::move(draggedVia) );
}
}
}
if( !viaPropOk ) // can't force-propagate the via? bummer...
return false;
for( ITEM* item : fanout.Items() )
{
2020-02-06 17:03:18 +00:00
if( const LINE* l = dyn_cast<const LINE*>( item ) )
{
LINE origLine( *l );
LINE draggedLine( *l );
LINE walkLine( *l );
2020-02-06 17:03:18 +00:00
2021-07-19 23:56:05 +00:00
draggedLine.DragCorner( viaTargetPos, origLine.CLine().Find( aHandle.pos ),
m_freeAngleMode );
draggedLine.ClearLinks();
2020-02-06 17:03:18 +00:00
if ( m_world->CheckColliding( &draggedLine ) )
{
bool ok = tryWalkaround( m_lastNode, draggedLine, walkLine );
if( !ok )
return false;
2020-02-06 17:03:18 +00:00
2021-02-25 16:18:13 +00:00
m_lastNode->Remove( origLine );
optimizeAndUpdateDraggedLine( walkLine, origLine, aP );
2021-02-25 16:18:13 +00:00
}
else
2021-02-25 16:18:13 +00:00
{
m_draggedItems.Add( draggedLine );
m_lastNode->Remove( origLine );
m_lastNode->Add( draggedLine );
2021-02-25 16:18:13 +00:00
}
}
2020-02-06 17:03:18 +00:00
}
return true;
}
2020-02-06 17:03:18 +00:00
void DRAGGER::optimizeAndUpdateDraggedLine( LINE& aDragged, const LINE& aOrig, const VECTOR2I& aP )
{
VECTOR2D lockV;
aDragged.ClearLinks();
aDragged.Unmark();
lockV = aDragged.CLine().NearestPoint( aP );
OPTIMIZER optimizer( m_lastNode );
int effort = OPTIMIZER::MERGE_SEGMENTS | OPTIMIZER::KEEP_TOPOLOGY | OPTIMIZER::RESTRICT_AREA;
if( Settings().SmoothDraggedSegments() )
effort |= OPTIMIZER::MERGE_COLINEAR;
optimizer.SetEffortLevel( effort );
OPT_BOX2I affectedArea = aDragged.ChangedArea( &aOrig );
VECTOR2I anchor( aP );
if( aDragged.CLine().Find( aP ) < 0 )
{
anchor = aDragged.CLine().NearestPoint( aP );
}
2021-02-11 23:14:39 +00:00
optimizer.SetPreserveVertex( anchor );
// People almost never want KiCad to reroute tracks in areas they can't even see, so restrict
// the area to what is visible even if we are optimizing the "entire" track.
if( Settings().GetOptimizeEntireDraggedTrack() )
affectedArea = VisibleViewArea();
else if( !affectedArea )
affectedArea = BOX2I( aP ); // No valid area yet? set to minimum to disable optimization
PNS_DBG( Dbg(), AddPoint, anchor, YELLOW, 100000, wxT( "drag-anchor" ) );
PNS_DBG( Dbg(), AddShape, *affectedArea, RED, 0, wxT( "drag-affected-area" ) );
optimizer.SetRestrictArea( *affectedArea );
optimizer.Optimize( &aDragged );
OPT_BOX2I optArea = aDragged.ChangedArea( &aOrig );
if( optArea )
PNS_DBG( Dbg(), AddShape, *optArea, BLUE, 0, wxT( "drag-opt-area" ) );
m_lastNode->Add( aDragged );
m_draggedItems.Clear();
m_draggedItems.Add( aDragged );
}
bool DRAGGER::tryWalkaround( NODE* aNode, LINE& aOrig, LINE& aWalk )
{
WALKAROUND walkaround( aNode, Router() );
bool ok = false;
walkaround.SetSolidsOnly( false );
walkaround.SetDebugDecorator( Dbg() );
walkaround.SetLogger( Logger() );
walkaround.SetIterationLimit( Settings().WalkaroundIterationLimit() );
aWalk = aOrig;
WALKAROUND::RESULT wr = walkaround.Route( aWalk );
if( wr.statusCcw == WALKAROUND::DONE && wr.statusCw == WALKAROUND::DONE )
{
if( wr.lineCw.CLine().PointCount() > 1
&& wr.lineCw.CLine().Length() < wr.lineCcw.CLine().Length() )
{
aWalk = wr.lineCw;
ok = true;
}
else if( wr.lineCcw.CLine().PointCount() > 1 )
{
aWalk = wr.lineCcw;
ok = true;
}
}
else if( wr.statusCw == WALKAROUND::DONE && wr.lineCw.CLine().PointCount() > 1 )
{
aWalk = wr.lineCw;
ok = true;
}
else if( wr.statusCcw == WALKAROUND::DONE && wr.lineCcw.CLine().PointCount() > 1 )
{
aWalk = wr.lineCcw;
ok = true;
}
return ok;
}
bool DRAGGER::dragWalkaround( const VECTOR2I& aP )
{
bool ok = false;
2021-07-19 23:56:05 +00:00
// fixme: rewrite using shared_ptr...
if( m_lastNode )
{
delete m_lastNode;
m_lastNode = nullptr;
}
m_lastNode = m_world->Branch();
switch( m_mode )
{
case DM_SEGMENT:
case DM_CORNER:
{
int thresh = Settings().SmoothDraggedSegments() ? m_draggedLine.Width() / 4 : 0;
LINE dragged( m_draggedLine );
LINE draggedWalk( m_draggedLine );
LINE origLine( m_draggedLine );
dragged.SetSnapThreshhold( thresh );
if( m_mode == DM_SEGMENT )
dragged.DragSegment( aP, m_draggedSegmentIndex );
else
dragged.DragCorner( aP, m_draggedSegmentIndex );
if ( m_world->CheckColliding( &dragged ) )
{
ok = tryWalkaround( m_lastNode, dragged, draggedWalk );
}
else
{
draggedWalk = dragged;
ok = true;
}
if( draggedWalk.CLine().PointCount() < 2 )
ok = false;
if( ok )
{
PNS_DBG( Dbg(), AddShape, &origLine.CLine(), BLUE, 50000, wxT( "drag-orig-line" ) );
PNS_DBG( Dbg(), AddShape, &draggedWalk.CLine(), CYAN, 75000, wxT( "drag-walk" ) );
m_lastNode->Remove( origLine );
optimizeAndUpdateDraggedLine( draggedWalk, origLine, aP );
}
2021-07-19 23:56:05 +00:00
break;
}
2020-02-06 17:03:18 +00:00
case DM_VIA: // fixme...
{
ok = dragViaWalkaround( m_initialVia, m_lastNode, aP );
break;
}
}
m_dragStatus = ok;
return ok;
}
bool DRAGGER::dragShove( const VECTOR2I& aP )
{
bool ok = false;
if( m_lastNode )
{
delete m_lastNode;
2021-07-19 23:56:05 +00:00
m_lastNode = nullptr;
}
switch( m_mode )
{
case DM_SEGMENT:
case DM_CORNER:
2015-10-05 16:28:41 +00:00
{
//TODO: Make threshold configurable
int thresh = Settings().SmoothDraggedSegments() ? m_draggedLine.Width() / 2 : 0;
LINE dragged( m_draggedLine );
dragged.SetSnapThreshhold( thresh );
2014-11-14 19:19:00 +00:00
if( m_mode == DM_SEGMENT )
dragged.DragSegment( aP, m_draggedSegmentIndex );
2015-10-05 16:28:41 +00:00
else
dragged.DragCorner( aP, m_draggedSegmentIndex );
2014-11-14 19:19:00 +00:00
PNS_DBG( Dbg(), AddShape, &dragged.CLine(), BLUE, 5000, wxT( "drag-shove-line" ) );
SHOVE::SHOVE_STATUS st = m_shove->ShoveLines( dragged );
if( st == SHOVE::SH_OK )
2021-07-19 23:56:05 +00:00
{
2015-10-05 16:28:41 +00:00
ok = true;
2021-07-19 23:56:05 +00:00
}
else if( st == SHOVE::SH_HEAD_MODIFIED )
2015-10-05 16:28:41 +00:00
{
dragged = m_shove->NewHead();
ok = true;
}
2015-10-05 16:28:41 +00:00
m_lastNode = m_shove->CurrentNode()->Branch();
2014-11-14 19:19:00 +00:00
2015-10-05 16:28:41 +00:00
if( ok )
{
VECTOR2D lockV;
dragged.ClearLinks();
dragged.Unmark();
optimizeAndUpdateDraggedLine( dragged, m_draggedLine, aP );
m_lastDragSolution = dragged;
}
else
{
m_lastDragSolution.ClearLinks();
m_lastNode->Add( m_lastDragSolution );
}
2015-10-05 16:28:41 +00:00
break;
}
case DM_VIA:
2015-10-05 16:28:41 +00:00
{
VIA_HANDLE newVia;
// corner count limiter intended to avoid excessive optimization produces mediocre results for via shoving.
// this is a hack that disables it, before I figure out a more reliable solution
m_shove->DisablePostShoveOptimizations( OPTIMIZER::LIMIT_CORNER_COUNT );
SHOVE::SHOVE_STATUS st = m_shove->ShoveDraggingVia( m_draggedVia, aP, newVia );
if( st == SHOVE::SH_OK || st == SHOVE::SH_HEAD_MODIFIED )
2015-10-05 16:28:41 +00:00
ok = true;
2015-10-05 16:28:41 +00:00
m_lastNode = m_shove->CurrentNode()->Branch();
if( newVia.valid )
m_draggedVia = newVia;
2015-10-05 16:28:41 +00:00
m_draggedItems.Clear();
// If drag didn't work (i.e. dragged onto a collision) try walkaround instead
if( !ok )
ok = dragViaWalkaround( m_draggedVia, m_lastNode, aP );
2015-10-05 16:28:41 +00:00
break;
}
}
2014-11-14 19:19:00 +00:00
m_dragStatus = ok;
return ok;
}
bool DRAGGER::FixRoute()
{
NODE* node = CurrentNode();
if( node )
{
// If collisions exist, we can fix in shove/smart mode because all tracks to be committed
// will be in valid positions (even if the current routing solution to the mouse cursor is
// invalid). In other modes, we can only commit if "Allow DRC violations" is enabled.
if( !m_dragStatus )
{
Drag( m_lastValidPoint );
node = CurrentNode();
if( !node )
return false;
}
if( !m_dragStatus && !Settings().AllowDRCViolations() )
return false;
Router()->CommitRouting( node );
return true;
2014-11-14 19:19:00 +00:00
}
return false;
}
bool DRAGGER::Drag( const VECTOR2I& aP )
{
m_mouseTrailTracer.AddTrailPoint( aP );
bool ret = false;
if( m_freeAngleMode )
2014-11-14 19:19:00 +00:00
{
ret = dragMarkObstacles( aP );
}
else
{
switch( m_currentMode )
{
case RM_MarkObstacles: ret = dragMarkObstacles( aP ); break;
case RM_Shove: ret = dragShove( aP ); break;
case RM_Walkaround: ret = dragWalkaround( aP ); break;
default: break;
}
2014-11-14 19:19:00 +00:00
}
if( ret )
{
m_lastValidPoint = aP;
}
else
{
if( m_lastNode )
{
delete m_lastNode;
m_draggedItems.Clear();
m_lastNode = nullptr;
}
}
return ret;
}
NODE* DRAGGER::CurrentNode() const
{
return m_lastNode ? m_lastNode : m_world;
}
const ITEM_SET DRAGGER::Traces()
{
return m_draggedItems;
}
}