kicad/pcbnew/drc/drc_interactive_courtyard_c...

265 lines
9.1 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2022 KiCad Developers.
*
* 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 2
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <drc/drc_interactive_courtyard_clearance.h>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <pad.h>
#include <zone.h>
#include <geometry/shape_segment.h>
#include <footprint.h>
void DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances()
{
for( FOOTPRINT* fpA: m_board->Footprints() )
{
if( fpA->IsSelected() )
continue;
const SHAPE_POLY_SET& frontA = fpA->GetCourtyard( F_CrtYd );
const SHAPE_POLY_SET& backA = fpA->GetCourtyard( B_CrtYd );
if( frontA.OutlineCount() == 0 && backA.OutlineCount() == 0 )
// No courtyards defined and no hole testing against other footprint's courtyards
continue;
BOX2I frontBBox = frontA.BBoxFromCaches();
BOX2I backBBox = backA.BBoxFromCaches();
frontBBox.Inflate( m_largestCourtyardClearance );
backBBox.Inflate( m_largestCourtyardClearance );
BOX2I fpABBox = fpA->GetBoundingBox();
for( FOOTPRINT* fpB : m_FpInMove )
{
BOX2I fpBBBox = fpB->GetBoundingBox();
const SHAPE_POLY_SET& frontB = fpB->GetCourtyard( F_CrtYd );
const SHAPE_POLY_SET& backB = fpB->GetCourtyard( B_CrtYd );
DRC_CONSTRAINT constraint;
int clearance;
int actual;
VECTOR2I pos;
if( frontA.OutlineCount() > 0 && frontB.OutlineCount() > 0
&& frontBBox.Intersects( frontB.BBoxFromCaches() ) )
{
// Currently, do not use DRC engine for calculation time reasons
// constraint = m_drcEngine->EvalRules( COURTYARD_CLEARANCE_CONSTRAINT, fpA, fpB, B_Cu );
// constraint.GetValue().Min();
clearance = 0;
if( frontA.Collide( &frontB, clearance, &actual, &pos ) )
{
m_itemsInConflict.insert( fpA );
m_itemsInConflict.insert( fpB );
}
}
if( backA.OutlineCount() > 0 && backB.OutlineCount() > 0
&& backBBox.Intersects( backB.BBoxFromCaches() ) )
{
// Currently, do not use DRC engine for calculation time reasons
// constraint = m_drcEngine->EvalRules( COURTYARD_CLEARANCE_CONSTRAINT, fpA, fpB, B_Cu );
// constraint.GetValue().Min();
clearance = 0;
if( backA.Collide( &backB, clearance, &actual, &pos ) )
{
m_itemsInConflict.insert( fpA );
m_itemsInConflict.insert( fpB );
}
}
// Now test if a pad hole of some other footprint is inside the courtyard area
// of the moved footprint
auto testPadAgainstCourtyards =
[&]( const PAD* pad, FOOTPRINT* footprint ) -> bool
{
if( pad->HasHole() )
{
std::shared_ptr<SHAPE_SEGMENT> hole = pad->GetEffectiveHoleShape();
const SHAPE_POLY_SET& front = footprint->GetCourtyard( F_CrtYd );
const SHAPE_POLY_SET& back = footprint->GetCourtyard( B_CrtYd );
if( front.OutlineCount() > 0 && front.Collide( hole.get(), 0 ) )
return true;
else if( back.OutlineCount() > 0 && back.Collide( hole.get(), 0 ) )
return true;
}
return false;
};
bool skipNextCmp = false;
if( ( frontA.OutlineCount() > 0 && frontA.BBoxFromCaches().Intersects( fpBBBox ) )
|| ( backA.OutlineCount() > 0 && backA.BBoxFromCaches().Intersects( fpBBBox ) ) )
{
for( const PAD* padB : fpB->Pads() )
{
if( testPadAgainstCourtyards( padB, fpA ) )
{
m_itemsInConflict.insert( fpA );
m_itemsInConflict.insert( fpB );
skipNextCmp = true;
break;
}
}
}
if( skipNextCmp )
continue; // fpA and fpB are already in list
if( ( frontB.OutlineCount() > 0 && frontB.BBoxFromCaches().Intersects( fpABBox ) )
|| ( backB.OutlineCount() > 0 && backB.BBoxFromCaches().Intersects( fpABBox ) ) )
{
for( const PAD* padA : fpA->Pads() )
{
if( testPadAgainstCourtyards( padA, fpB ) )
{
m_itemsInConflict.insert( fpA );
m_itemsInConflict.insert( fpB );
break;
}
}
}
}
}
for( ZONE* zone : m_board->Zones() )
{
if( !zone->GetIsRuleArea() || !zone->GetDoNotAllowFootprints() )
continue;
bool disallowFront = ( zone->GetLayerSet() & LSET::FrontMask() ).any();
bool disallowBack = ( zone->GetLayerSet() & LSET::BackMask() ).any();
for( FOOTPRINT* fp : m_FpInMove )
{
if( disallowFront )
{
const SHAPE_POLY_SET& frontCourtyard = fp->GetCourtyard( F_CrtYd );
if( !frontCourtyard.IsEmpty() )
{
if( zone->Outline()->Collide( &frontCourtyard.Outline( 0 ) ) )
{
m_itemsInConflict.insert( fp );
m_itemsInConflict.insert( zone );
break;
}
}
}
if( disallowBack )
{
const SHAPE_POLY_SET& backCourtyard = fp->GetCourtyard( B_CrtYd );
if( !backCourtyard.IsEmpty() )
{
if( zone->Outline()->Collide( &backCourtyard.Outline( 0 ) ) )
{
m_itemsInConflict.insert( fp );
m_itemsInConflict.insert( zone );
break;
}
}
}
}
}
}
void DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init( BOARD* aBoard )
{
m_board = aBoard;
// Update courtyard data and clear the COURTYARD_CONFLICT flag
for( FOOTPRINT* fp: m_board->Footprints() )
{
fp->ClearFlags( COURTYARD_CONFLICT );
fp->BuildCourtyardCaches();
}
}
bool DRC_INTERACTIVE_COURTYARD_CLEARANCE::Run()
{
m_itemsInConflict.clear();
m_largestCourtyardClearance = 0;
DRC_CONSTRAINT constraint;
if( m_drcEngine->QueryWorstConstraint( COURTYARD_CLEARANCE_CONSTRAINT, constraint ) )
m_largestCourtyardClearance = constraint.GetValue().Min();
testCourtyardClearances();
return true;
}
void DRC_INTERACTIVE_COURTYARD_CLEARANCE::UpdateConflicts( KIGFX::VIEW* aView,
bool aHighlightMoved )
{
// Ensure the "old" conflicts are cleared
for( BOARD_ITEM* item: m_lastItemsInConflict )
{
item->ClearFlags(COURTYARD_CONFLICT );
aView->Update( item );
aView->MarkTargetDirty( KIGFX::TARGET_OVERLAY );
}
m_lastItemsInConflict.clear();
for( BOARD_ITEM* item: m_itemsInConflict )
{
if( aHighlightMoved || !alg::contains( m_FpInMove, item ) )
{
if( !item->HasFlag( COURTYARD_CONFLICT ) )
{
item->SetFlags( COURTYARD_CONFLICT );
aView->Update( item );
aView->MarkTargetDirty( KIGFX::TARGET_OVERLAY );
}
m_lastItemsInConflict.push_back( item );
}
}
}
void DRC_INTERACTIVE_COURTYARD_CLEARANCE::ClearConflicts( KIGFX::VIEW* aView )
{
for( BOARD_ITEM* item: m_lastItemsInConflict )
{
item->ClearFlags( COURTYARD_CONFLICT );
aView->Update( item );
aView->MarkTargetDirty( KIGFX::TARGET_OVERLAY );
}
}