footprint.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2015 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "footprint.h"
 
#include <magic_enum.hpp>
 
#include <algorithm>
#include <cmath>
#include <unordered_set>
#include <utility>   // std::as_const
 
#include <wx/log.h>
#include <wx/debug.h>
#include <wx/tokenzr.h>
 
#include <bitmaps.h>
#include <board.h>
#include <board_design_settings.h>
#include <collectors.h>
#include <component_classes/component_class_manager.h>
#include <confirm.h>
#include <convert_basic_shapes_to_polygon.h>
#include <convert_shape_list_to_polygon.h>
#include <component_classes/component_class.h>
#include <component_classes/component_class_cache_proxy.h>
#include <core/kicad_algo.h>
#include <drc/drc_item.h>
#include <diff_merge/property_value_converter.h>
#include <embedded_files.h>
#include <font/font.h>
#include <font/outline_font.h>
#include <geometry/convex_hull.h>
#include <geometry/shape_segment.h>
#include <geometry/shape_simple.h>
#include <geometry/geometry_utils.h>
#include <i18n_utility.h>
#include <lset.h>
#include <macros.h>
#include <pad.h>
#include <pcb_dimension.h>
#include <pcb_edit_frame.h>
#include <pcb_field.h>
#include <pcb_group.h>
#include <constraints/pcb_constraint.h>
#include <pcb_marker.h>
#include <pcb_point.h>
#include <pcb_reference_image.h>
#include <pcb_textbox.h>
#include <pcb_track.h>
#include <pcb_barcode.h>
#include <name_validation.h>
#include <refdes_utils.h>
#include <string_utils.h>
#include <view/view.h>
#include <zone.h>
 
#include <google/protobuf/any.pb.h>
#include <api/board/board_types.pb.h>
#include <api/api_enums.h>
#include <api/api_utils.h>
#include <api/api_pcb_utils.h>
#include <properties/property.h>
#include <properties/property_mgr.h>
 
 
class PCB_FOOTPRINT_FIELD_PROPERTY : public PROPERTY_BASE
{
public:
    PCB_FOOTPRINT_FIELD_PROPERTY( const wxString& aName ) :
            PROPERTY_BASE( aName ),
            m_name( aName )
    {
        SetGroup( _HKI( "Fields" ) );
    }
 
    size_t OwnerHash() const override { return TYPE_HASH( FOOTPRINT ); }
    size_t BaseHash() const override { return TYPE_HASH( FOOTPRINT ); }
    size_t TypeHash() const override { return TYPE_HASH( wxString ); }
 
    void setter( void* obj, wxAny& v ) override
    {
        wxString value;
 
        if( !v.GetAs( &value ) )
            return;
 
        FOOTPRINT* footprint = reinterpret_cast<FOOTPRINT*>( obj );
        PCB_FIELD* field = footprint->GetField( m_name );
 
        wxString variantName;
 
        if( footprint->GetBoard() )
            variantName = footprint->GetBoard()->GetCurrentVariant();
 
        if( !variantName.IsEmpty() )
        {
            FOOTPRINT_VARIANT* variant = footprint->AddVariant( variantName );
 
            if( variant )
                variant->SetFieldValue( m_name, value );
        }
        else if( !field )
        {
            PCB_FIELD* newField = new PCB_FIELD( footprint, FIELD_T::USER, m_name );
            newField->SetText( value );
            footprint->Add( newField );
        }
        else
        {
            field->SetText( value );
        }
    }
 
    wxAny getter( const void* obj ) const override
    {
        const FOOTPRINT* footprint = reinterpret_cast<const FOOTPRINT*>( obj );
        PCB_FIELD* field = footprint->GetField( m_name );
 
        if( !field )
            return wxAny();
 
        wxString variantName;
 
        if( footprint->GetBoard() )
            variantName = footprint->GetBoard()->GetCurrentVariant();
 
        wxString text;
 
        if( !variantName.IsEmpty() )
            text = footprint->GetFieldValueForVariant( variantName, m_name );
        else
            text = field->GetText();
 
        return wxAny( text );
    }
 
private:
    wxString m_name;
};
 
 
FOOTPRINT::FOOTPRINT( BOARD* parent ) :
        BOARD_ITEM_CONTAINER( (BOARD_ITEM*) parent, PCB_FOOTPRINT_T ),
        m_attributes( 0 ),
        m_fpStatus( FP_PADS_are_LOCKED ),
        m_fileFormatVersionAtLoad( 0 ),
        m_duplicatePadNumbersAreJumpers( false ),
        m_allowMissingCourtyard( false ),
        m_allowSolderMaskBridges( false ),
        m_zoneConnection( ZONE_CONNECTION::INHERITED ),
        m_stackupLayers( LSET{ F_Cu, In1_Cu, B_Cu } ),
        m_stackupMode( FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS ),
        m_lastEditTime( 0 ),
        m_arflag( 0 ),
        m_link( 0 ),
        m_initial_comments( nullptr ),
        m_componentClassCacheProxy( std::make_unique<COMPONENT_CLASS_CACHE_PROXY>( this ) )
{
    m_layer      = F_Cu;
    m_embedFonts = false;
 
    auto addField =
            [this]( FIELD_T id, PCB_LAYER_ID layer, bool visible )
            {
                PCB_FIELD* field = new PCB_FIELD( this, id );
                field->SetLayer( layer );
                field->SetVisible( visible );
                m_fields.push_back( field );
            };
 
    addField( FIELD_T::REFERENCE,   F_SilkS, true  );
    addField( FIELD_T::VALUE,       F_Fab,   true  );
    addField( FIELD_T::DATASHEET,   F_Fab,   false );
    addField( FIELD_T::DESCRIPTION, F_Fab,   false );
 
    m_3D_Drawings.clear();
}
 
 
FOOTPRINT::FOOTPRINT( const FOOTPRINT& aFootprint ) :
        BOARD_ITEM_CONTAINER( aFootprint ),
        EMBEDDED_FILES( aFootprint ),
        m_componentClassCacheProxy( std::make_unique<COMPONENT_CLASS_CACHE_PROXY>( this ) )
{
    m_transform               = aFootprint.m_transform;
    m_flipped                 = aFootprint.m_flipped;
    m_fpid                    = aFootprint.m_fpid;
    m_attributes              = aFootprint.m_attributes;
    m_fpStatus                = aFootprint.m_fpStatus;
    m_fileFormatVersionAtLoad = aFootprint.m_fileFormatVersionAtLoad;
 
    m_geometry_cache.reset();
 
    m_netTiePadGroups                = aFootprint.m_netTiePadGroups;
    m_jumperPadGroups                = aFootprint.m_jumperPadGroups;
    m_duplicatePadNumbersAreJumpers  = aFootprint.m_duplicatePadNumbersAreJumpers;
    m_allowMissingCourtyard          = aFootprint.m_allowMissingCourtyard;
    m_allowSolderMaskBridges         = aFootprint.m_allowSolderMaskBridges;
 
    m_zoneConnection         = aFootprint.m_zoneConnection;
    m_clearance              = aFootprint.m_clearance;
    m_solderMaskMargin       = aFootprint.m_solderMaskMargin;
    m_solderPasteMargin      = aFootprint.m_solderPasteMargin;
    m_solderPasteMarginRatio = aFootprint.m_solderPasteMarginRatio;
 
    m_stackupLayers    = aFootprint.m_stackupLayers;
    m_stackupMode      = aFootprint.m_stackupMode;
 
    m_libDescription   = aFootprint.m_libDescription;
    m_keywords         = aFootprint.m_keywords;
    m_path             = aFootprint.m_path;
    m_sheetname        = aFootprint.m_sheetname;
    m_sheetfile        = aFootprint.m_sheetfile;
    m_filters          = aFootprint.m_filters;
    m_lastEditTime     = aFootprint.m_lastEditTime;
    m_arflag           = 0;
    m_link             = aFootprint.m_link;
    m_privateLayers    = aFootprint.m_privateLayers;
 
    m_3D_Drawings      = aFootprint.m_3D_Drawings;
 
    if( aFootprint.m_extrudedBody )
        m_extrudedBody = std::make_unique<EXTRUDED_3D_BODY>( *aFootprint.m_extrudedBody );
 
    m_initial_comments = aFootprint.m_initial_comments ? new wxArrayString( *aFootprint.m_initial_comments )
                                                       : nullptr;
 
    m_embedFonts       = aFootprint.m_embedFonts;
    m_variants         = aFootprint.m_variants;
 
    m_componentClassCacheProxy->SetStaticComponentClass(
            aFootprint.m_componentClassCacheProxy->GetStaticComponentClass() );
 
    std::map<EDA_ITEM*, EDA_ITEM*> ptrMap;
 
    // Copy fields
    for( PCB_FIELD* field : aFootprint.m_fields )
    {
        if( field->IsMandatory() )
        {
            PCB_FIELD* existingField = GetField( field->GetId() );
            ptrMap[field] = existingField;
            *existingField = *field;
 
            // Assignment retains the constructor-generated KIID because m_Uuid is const
            existingField->SetUuidDirect( field->m_Uuid );
            existingField->SetParent( this );
        }
        else
        {
            PCB_FIELD* newField = static_cast<PCB_FIELD*>( field->Clone() );
            ptrMap[field] = newField;
            Add( newField );
        }
    }
 
    // Copy pads
    for( PAD* pad : aFootprint.Pads() )
    {
        PAD* newPad = static_cast<PAD*>( pad->Clone() );
        ptrMap[ pad ] = newPad;
        Add( newPad, ADD_MODE::APPEND ); // Append to ensure indexes are identical
    }
 
    // Copy zones
    for( ZONE* zone : aFootprint.Zones() )
    {
        ZONE* newZone = static_cast<ZONE*>( zone->Clone() );
        ptrMap[ zone ] = newZone;
        Add( newZone, ADD_MODE::APPEND ); // Append to ensure indexes are identical
 
        // Ensure the net info is OK and especially uses the net info list
        // living in the current board
        // Needed when copying a fp from fp editor that has its own board
        // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
        newZone->SetNetCode( -1 );
    }
 
    // Copy drawings
    for( BOARD_ITEM* item : aFootprint.GraphicalItems() )
    {
        BOARD_ITEM* newItem = static_cast<BOARD_ITEM*>( item->Clone() );
        ptrMap[ item ] = newItem;
        Add( newItem, ADD_MODE::APPEND ); // Append to ensure indexes are identical
    }
 
    // Copy groups
    for( PCB_GROUP* group : aFootprint.Groups() )
    {
        PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( group->Clone() );
        ptrMap[ group ] = newGroup;
        Add( newGroup, ADD_MODE::APPEND ); // Append to ensure indexes are identical
    }
 
    // Copy constraints.  Clone preserves the uuid, so each constraint's KIID members still
    // resolve to the matching cloned items.
    for( PCB_CONSTRAINT* constraint : aFootprint.Constraints() )
        Add( static_cast<PCB_CONSTRAINT*>( constraint->Clone() ), ADD_MODE::APPEND );
 
    for( PCB_POINT* point : aFootprint.Points() )
    {
        PCB_POINT* newPoint = static_cast<PCB_POINT*>( point->Clone() );
        ptrMap[ point ] = newPoint;
        Add( newPoint, ADD_MODE::APPEND ); // Append to ensure indexes are identical
    }
 
    // Rebuild groups
    for( PCB_GROUP* group : aFootprint.Groups() )
    {
        PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( ptrMap[ group ] );
 
        newGroup->GetItems().clear();
 
        for( EDA_ITEM* member : group->GetItems() )
        {
            if( ptrMap.count( member ) )
                newGroup->AddItem( ptrMap[ member ] );
        }
    }
 
    // Embedded files are inherited via the EMBEDDED_FILES copy constructor invoked in the
    // member initializer list above; the underlying file payloads are reference-counted so
    // cloning a footprint is cheap even when it carries large embedded models or fonts.
}
 
 
FOOTPRINT::FOOTPRINT( FOOTPRINT&& aFootprint ) :
    BOARD_ITEM_CONTAINER( aFootprint ),
    m_componentClassCacheProxy( std::make_unique<COMPONENT_CLASS_CACHE_PROXY>( this ) )
{
    *this = std::move( aFootprint );
}
 
 
FOOTPRINT::~FOOTPRINT()
{
    // Clean up the owned elements
    delete m_initial_comments;
 
    for( PCB_FIELD* f : m_fields )
        delete f;
 
    m_fields.clear();
 
    for( PAD* p : m_pads )
        delete p;
 
    m_pads.clear();
 
    for( ZONE* zone : m_zones )
        delete zone;
 
    m_zones.clear();
 
    for( PCB_GROUP* group : m_groups )
        delete group;
 
    m_groups.clear();
 
    for( PCB_CONSTRAINT* constraint : m_constraints )
        delete constraint;
 
    m_constraints.clear();
 
    for( PCB_POINT* point : m_points )
        delete point;
 
    m_points.clear();
 
    for( BOARD_ITEM* d : m_drawings )
        delete d;
 
    m_drawings.clear();
}
 
 
std::vector<PROPERTY_BASE*> FOOTPRINT::GetDynamicProperties() const
{
    std::vector<PROPERTY_BASE*> props;
    const BOARD* board = GetBoard();
    bool isFPedit = board && board->IsFootprintHolder();
 
    auto getOrCreate = [&]( const wxString& aName )
    {
        auto it = m_dynamicPropertyCache.find( aName );
 
        if( it == m_dynamicPropertyCache.end() )
        {
            auto prop = std::make_unique<PCB_FOOTPRINT_FIELD_PROPERTY>( aName );
            it = m_dynamicPropertyCache.emplace( aName, std::move( prop ) ).first;
        }
 
        return it->second.get();
    };
 
    for( PCB_FIELD* field : GetFields() )
    {
        if( !field->IsMandatory() )
            continue;
 
        if( !isFPedit && field->IsPrivate() )
            continue;
 
        const wxString& name = field->GetUntranslatedName();
 
        if( PROPERTY_MANAGER::Instance().GetProperty( TYPE_HASH( FOOTPRINT ), name ) )
            continue;
 
        props.push_back( getOrCreate( name ) );
    }
 
    std::vector<PCB_FIELD*> userFields;
 
    for( PCB_FIELD* field : GetFields() )
    {
        if( field->IsMandatory() || ( !isFPedit && field->IsPrivate() ) )
            continue;
 
        userFields.push_back( field );
    }
 
    std::ranges::sort( userFields,
                       []( const PCB_FIELD* a, const PCB_FIELD* b )
                       {
                           return a->GetUntranslatedName().CmpNoCase( b->GetUntranslatedName() ) < 0;
                       } );
 
    for( PCB_FIELD* field : userFields )
    {
        const wxString& name = field->GetUntranslatedName();
        props.push_back( getOrCreate( name ) );
    }
 
    for( PROPERTY_BASE* prop : GetCustomPropertiesAsInspectables() )
        props.push_back( prop );
 
    return props;
}
 
 
void FOOTPRINT::Serialize( google::protobuf::Any &aContainer ) const
{
    using namespace kiapi::board;
    types::FootprintInstance footprint;
 
    footprint.mutable_id()->set_value( m_Uuid.AsStdString() );
    footprint.mutable_position()->set_x_nm( GetPosition().x );
    footprint.mutable_position()->set_y_nm( GetPosition().y );
    footprint.mutable_orientation()->set_value_degrees( GetOrientationDegrees() );
    footprint.set_layer( ToProtoEnum<PCB_LAYER_ID, types::BoardLayer>( GetLayer() ) );
    footprint.set_locked( IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
                                     : kiapi::common::types::LockedState::LS_UNLOCKED );
 
    if( const BOARD* board = GetBoard() )
        footprint.mutable_parent()->set_value( board->m_Uuid.AsStdString() );
 
    GetField( FIELD_T::REFERENCE )->Serialize( *footprint.mutable_reference_field() );
    GetField( FIELD_T::VALUE )->Serialize( *footprint.mutable_value_field() );
    GetField( FIELD_T::DATASHEET )->Serialize( *footprint.mutable_datasheet_field() );
    GetField( FIELD_T::DESCRIPTION )->Serialize( *footprint.mutable_description_field() );
 
    types::FootprintAttributes* attrs = footprint.mutable_attributes();
 
    attrs->set_not_in_schematic( IsBoardOnly() );
    attrs->set_exclude_from_position_files( IsExcludedFromPosFiles() );
    attrs->set_exclude_from_bill_of_materials( IsExcludedFromBOM() );
    attrs->set_exclude_from_simulation( IsExcludedFromSim() );
    attrs->set_exempt_from_courtyard_requirement( AllowMissingCourtyard() );
    attrs->set_do_not_populate( IsDNP() );
    attrs->set_allow_soldermask_bridges( AllowSolderMaskBridges() );
 
    if( m_attributes & FP_THROUGH_HOLE )
        attrs->set_mounting_style( types::FootprintMountingStyle::FMS_THROUGH_HOLE );
    else if( m_attributes & FP_SMD )
        attrs->set_mounting_style( types::FootprintMountingStyle::FMS_SMD );
    else
        attrs->set_mounting_style( types::FootprintMountingStyle::FMS_UNSPECIFIED );
 
    SerializeDefinition( footprint.mutable_definition() );
 
    types::FootprintDesignRuleOverrides* overrides = footprint.mutable_overrides();
 
    if( GetLocalClearance().has_value() )
        overrides->mutable_copper_clearance()->set_value_nm( *GetLocalClearance() );
 
    if( GetLocalSolderMaskMargin().has_value() )
        overrides->mutable_solder_mask()->mutable_solder_mask_margin()->set_value_nm( *GetLocalSolderMaskMargin() );
 
    if( GetLocalSolderPasteMargin().has_value() )
        overrides->mutable_solder_paste()->mutable_solder_paste_margin()->set_value_nm( *GetLocalSolderPasteMargin() );
 
    if( GetLocalSolderPasteMarginRatio().has_value() )
        overrides->mutable_solder_paste()->mutable_solder_paste_margin_ratio()->set_value( *GetLocalSolderPasteMarginRatio() );
 
    overrides->set_zone_connection(
            ToProtoEnum<ZONE_CONNECTION, types::ZoneConnectionStyle>( GetLocalZoneConnection() ) );
 
    kiapi::common::PackSheetPath( *footprint.mutable_symbol_path(), m_path );
 
    footprint.set_symbol_sheet_name( m_sheetname.ToUTF8() );
    footprint.set_symbol_sheet_filename( m_sheetfile.ToUTF8() );
    footprint.set_symbol_footprint_filters( m_filters.ToUTF8() );
 
    kiapi::board::PackEmbeddedFiles( *footprint.mutable_embedded_files(), *this );
 
    kiapi::common::PackCustomProperties( footprint.mutable_custom_properties(), *this );
 
    for( const auto& [variantName, variant] : m_variants )
    {
        types::FootprintVariant* variantMsg = footprint.add_variants();
        variantMsg->set_name( variantName.ToUTF8() );
        variantMsg->set_do_not_populate( variant.GetDNP() );
        variantMsg->set_exclude_from_bill_of_materials( variant.GetExcludedFromBOM() );
        variantMsg->set_exclude_from_position_files( variant.GetExcludedFromPosFiles() );
        variantMsg->set_exclude_from_simulation( variant.GetExcludedFromSim() );
 
        for( const auto& [fieldName, fieldValue] : variant.GetFields() )
        {
            variantMsg->mutable_fields()->insert( { std::string( fieldName.ToUTF8() ),
                                                    std::string( fieldValue.ToUTF8() ) } );
        }
    }
 
    aContainer.PackFrom( footprint );
}
 
 
void FOOTPRINT::SerializeDefinition( kiapi::board::types::Footprint* aOutput ) const
{
    using namespace kiapi::board;
 
    kiapi::common::PackLibId( aOutput->mutable_id(), GetFPID() );
    // anchor?
    aOutput->mutable_attributes()->set_description( GetLibDescription().ToUTF8() );
    aOutput->mutable_attributes()->set_keywords( GetKeywords().ToUTF8() );
 
    // TODO: serialize library mandatory fields
 
    for( const wxString& group : GetNetTiePadGroups() )
    {
        types::NetTieDefinition* netTie = aOutput->add_net_ties();
        wxStringTokenizer tokenizer( group, ", \t\r\n", wxTOKEN_STRTOK );
 
        while( tokenizer.HasMoreTokens() )
            netTie->add_pad_number( tokenizer.GetNextToken().ToUTF8() );
    }
 
    for( PCB_LAYER_ID layer : GetPrivateLayers().Seq() )
        aOutput->add_private_layers( ToProtoEnum<PCB_LAYER_ID, types::BoardLayer>( layer ) );
 
    types::JumperSettings* jumpers = aOutput->mutable_jumpers();
    jumpers->set_duplicate_names_are_jumpered( GetDuplicatePadNumbersAreJumpers() );
 
    for( const JUMPER_GROUP& group : JumperPadGroups().GetAll() )
    {
        types::JumperGroup* jumperGroup = jumpers->add_groups();
 
        for( const wxString& padName : group.GetNames() )
            jumperGroup->add_pad_names( padName.ToUTF8() );
    }
 
    for( const PCB_FIELD* item : m_fields )
    {
        if( item->IsMandatory() )
            continue;
 
        google::protobuf::Any* itemMsg = aOutput->add_items();
        item->Serialize( *itemMsg );
    }
 
    for( const PAD* item : Pads() )
    {
        google::protobuf::Any* itemMsg = aOutput->add_items();
        item->Serialize( *itemMsg );
    }
 
    for( const BOARD_ITEM* item : GraphicalItems() )
    {
        google::protobuf::Any* itemMsg = aOutput->add_items();
        item->Serialize( *itemMsg );
    }
 
    for( const PCB_POINT* item : Points() )
    {
        google::protobuf::Any* itemMsg = aOutput->add_items();
        item->Serialize( *itemMsg );
    }
 
    for( const ZONE* item : Zones() )
    {
        google::protobuf::Any* itemMsg = aOutput->add_items();
        item->Serialize( *itemMsg );
    }
 
    for( const FP_3DMODEL& model : Models() )
    {
        google::protobuf::Any* itemMsg = aOutput->add_items();
        types::Footprint3DModel modelMsg;
        modelMsg.set_filename( model.m_Filename.ToUTF8() );
        kiapi::common::PackVector3D( *modelMsg.mutable_scale(), model.m_Scale );
        kiapi::common::PackVector3D( *modelMsg.mutable_rotation(), model.m_Rotation );
        kiapi::common::PackVector3D( *modelMsg.mutable_offset(), model.m_Offset );
        modelMsg.set_visible( model.m_Show );
        modelMsg.set_opacity( model.m_Opacity );
        itemMsg->PackFrom( modelMsg );
    }
}
 
 
bool FOOTPRINT::DeserializeDefinition( const kiapi::board::types::Footprint& aInput )
{
    using namespace kiapi::board;
 
    SetFPID( kiapi::common::UnpackLibId( aInput.id() ) );
    // TODO: how should anchor be handled?
    SetLibDescription( aInput.attributes().description() );
    SetKeywords( aInput.attributes().keywords() );
 
    // TODO: deserialize library mandatory fields
 
    m_netTiePadGroups.clear();
 
    for( const types::NetTieDefinition& netTieMsg : aInput.net_ties() )
    {
        wxString group;
 
        for( const std::string& pad : netTieMsg.pad_number() )
            group.Append( wxString::Format( wxT( "%s, " ), pad ) );
 
        group.Trim();
        AddNetTiePadGroup( group.BeforeLast( ',' ) );
    }
 
    SetDuplicatePadNumbersAreJumpers( aInput.jumpers().duplicate_names_are_jumpered() );
 
    JUMPER_GROUP_SET& jumperGroups = JumperPadGroups();
    jumperGroups.Clear();
 
    for( const types::JumperGroup& groupMsg : aInput.jumpers().groups() )
    {
        std::set<wxString> padNames;
 
        for( const std::string& padName : groupMsg.pad_names() )
            padNames.insert( wxString::FromUTF8( padName ) );
 
        jumperGroups.Add( std::move( padNames ) );
    }
 
    LSET privateLayers;
 
    for( int layerMsg : aInput.private_layers() )
    {
        auto layer = FromProtoEnum<PCB_LAYER_ID, types::BoardLayer>( static_cast<types::BoardLayer>( layerMsg ) );
 
        if( layer > UNDEFINED_LAYER )
            privateLayers.set( layer );
    }
 
    SetPrivateLayers( privateLayers );
 
    // Footprint items
    for( PCB_FIELD* field : m_fields )
    {
        if( !field->IsMandatory() )
            Remove( field );
    }
 
    // If this footprint is on a board, uncache all items before clearing
    if( BOARD* board = GetBoard() )
        board->UncacheChildrenById( this );
 
    Pads().clear();
    GraphicalItems().clear();
    Zones().clear();
    Groups().clear();
    Constraints().clear();
    Models().clear();
    Points().clear();
 
    for( const google::protobuf::Any& itemMsg : aInput.items() )
    {
        std::optional<KICAD_T> type = kiapi::common::TypeNameFromAny( itemMsg );
 
        if( !type )
        {
            // Bit of a hack here, but eventually 3D models should be promoted to a first-class
            // object, at which point they can get their own serialization
            if( itemMsg.type_url() == "type.googleapis.com/kiapi.board.types.Footprint3DModel" )
            {
                types::Footprint3DModel modelMsg;
 
                if( !itemMsg.UnpackTo( &modelMsg ) )
                    continue;
 
                FP_3DMODEL model;
 
                model.m_Filename = wxString::FromUTF8( modelMsg.filename() );
                model.m_Show = modelMsg.visible();
                model.m_Opacity = modelMsg.opacity();
                model.m_Scale = kiapi::common::UnpackVector3D( modelMsg.scale() );
                model.m_Rotation = kiapi::common::UnpackVector3D( modelMsg.rotation() );
                model.m_Offset = kiapi::common::UnpackVector3D( modelMsg.offset() );
 
                Models().push_back( std::move( model ) );
            }
            else
            {
                wxLogTrace( traceApi, wxString::Format( wxS( "Attempting to unpack unknown type %s "
                                                             "from footprint message, skipping" ),
                                                        itemMsg.type_url() ) );
            }
 
            continue;
        }
 
        std::unique_ptr<BOARD_ITEM> item = CreateItemForType( *type, this );
 
        if( item && item->Deserialize( itemMsg ) )
            Add( item.release(), ADD_MODE::APPEND );
    }
 
    return true;
}
 
 
bool FOOTPRINT::Deserialize( const google::protobuf::Any &aContainer )
{
    using namespace kiapi::board;
    types::FootprintInstance footprint;
 
    if( !aContainer.UnpackTo( &footprint ) )
        return false;
 
    SetUuidDirect( KIID( footprint.id().value() ) );
    SetPosition( VECTOR2I( footprint.position().x_nm(), footprint.position().y_nm() ) );
    SetOrientationDegrees( footprint.orientation().value_degrees() );
    SetLayer( FromProtoEnum<PCB_LAYER_ID, types::BoardLayer>( footprint.layer() ) );
    SetLocked( footprint.locked() == kiapi::common::types::LockedState::LS_LOCKED );
 
    google::protobuf::Any buf;
    types::Field mandatoryField;
 
    if( footprint.has_reference_field() )
    {
        mandatoryField = footprint.reference_field();
        mandatoryField.mutable_id()->set_id( (int) FIELD_T::REFERENCE );
        buf.PackFrom( mandatoryField );
        GetField( FIELD_T::REFERENCE )->Deserialize( buf );
    }
 
    if( footprint.has_value_field() )
    {
        mandatoryField = footprint.value_field();
        mandatoryField.mutable_id()->set_id( (int) FIELD_T::VALUE );
        buf.PackFrom( mandatoryField );
        GetField( FIELD_T::VALUE )->Deserialize( buf );
    }
 
    if( footprint.has_datasheet_field() )
    {
        mandatoryField = footprint.datasheet_field();
        mandatoryField.mutable_id()->set_id( (int) FIELD_T::DATASHEET );
        buf.PackFrom( mandatoryField );
        GetField( FIELD_T::DATASHEET )->Deserialize( buf );
    }
 
    if( footprint.has_description_field() )
    {
        mandatoryField = footprint.description_field();
        mandatoryField.mutable_id()->set_id( (int) FIELD_T::DESCRIPTION );
        buf.PackFrom( mandatoryField );
        GetField( FIELD_T::DESCRIPTION )->Deserialize( buf );
    }
 
    m_attributes = 0;
 
    switch( footprint.attributes().mounting_style() )
    {
    case types::FootprintMountingStyle::FMS_THROUGH_HOLE:
        m_attributes |= FP_THROUGH_HOLE;
        break;
 
    case types::FootprintMountingStyle::FMS_SMD:
        m_attributes |= FP_SMD;
        break;
 
    default:
        break;
    }
 
    SetBoardOnly( footprint.attributes().not_in_schematic() );
    SetExcludedFromBOM( footprint.attributes().exclude_from_bill_of_materials() );
    SetExcludedFromSim( footprint.attributes().exclude_from_simulation() );
    SetExcludedFromPosFiles( footprint.attributes().exclude_from_position_files() );
    SetAllowMissingCourtyard( footprint.attributes().exempt_from_courtyard_requirement() );
    SetDNP( footprint.attributes().do_not_populate() );
    SetAllowSolderMaskBridges( footprint.attributes().allow_soldermask_bridges() );
 
    // Definition
    DeserializeDefinition( footprint.definition() );
 
    const types::FootprintDesignRuleOverrides& overrides = footprint.overrides();
 
    if( overrides.has_copper_clearance() )
        SetLocalClearance( overrides.copper_clearance().value_nm() );
    else
        SetLocalClearance( std::nullopt );
 
    if( overrides.has_solder_mask() && overrides.solder_mask().has_solder_mask_margin() )
        SetLocalSolderMaskMargin( overrides.solder_mask().solder_mask_margin().value_nm() );
    else
        SetLocalSolderMaskMargin( std::nullopt );
 
    if( overrides.has_solder_paste() )
    {
        const types::SolderPasteOverrides& pasteSettings = overrides.solder_paste();
 
        if( pasteSettings.has_solder_paste_margin() )
            SetLocalSolderPasteMargin( pasteSettings.solder_paste_margin().value_nm() );
        else
            SetLocalSolderPasteMargin( std::nullopt );
 
        if( pasteSettings.has_solder_paste_margin_ratio() )
            SetLocalSolderPasteMarginRatio( pasteSettings.solder_paste_margin_ratio().value() );
        else
            SetLocalSolderPasteMarginRatio( std::nullopt );
    }
 
    SetLocalZoneConnection( FromProtoEnum<ZONE_CONNECTION>( overrides.zone_connection() ) );
 
    m_path = kiapi::common::UnpackSheetPath( footprint.symbol_path() );
    m_sheetname = wxString::FromUTF8( footprint.symbol_sheet_name() );
    m_sheetfile = wxString::FromUTF8( footprint.symbol_sheet_filename() );
    m_filters = wxString::FromUTF8( footprint.symbol_footprint_filters() );
 
    kiapi::common::UnpackCustomProperties( footprint.custom_properties(), *this );
 
    if( !kiapi::board::UnpackEmbeddedFiles( *this, footprint.embedded_files() ) )
        return false;
 
    m_variants.clear();
 
    for( const types::FootprintVariant& variantMsg : footprint.variants() )
    {
        wxString variantName = wxString::FromUTF8( variantMsg.name() );
 
        if( variantName.IsEmpty() || variantName.CmpNoCase( GetDefaultVariantName() ) == 0 )
            continue;
 
        FOOTPRINT_VARIANT& variant = m_variants[variantName];
        variant.SetName( variantName );
        variant.SetDNP( variantMsg.do_not_populate() );
        variant.SetExcludedFromBOM( variantMsg.exclude_from_bill_of_materials() );
        variant.SetExcludedFromPosFiles( variantMsg.exclude_from_position_files() );
        variant.SetExcludedFromSim( variantMsg.exclude_from_simulation() );
 
        for( const auto& [fieldName, fieldValue] : variantMsg.fields() )
            variant.SetFieldValue( wxString::FromUTF8( fieldName ), wxString::FromUTF8( fieldValue ) );
    }
 
    return true;
}
 
 
PCB_FIELD* FOOTPRINT::GetField( FIELD_T aFieldType )
{
    for( PCB_FIELD* field : m_fields )
    {
        if( field->GetId() == aFieldType )
            return field;
    }
 
    PCB_FIELD* field = new PCB_FIELD( this, aFieldType );
    m_fields.push_back( field );
 
    return field;
}
 
 
const PCB_FIELD* FOOTPRINT::GetField( FIELD_T aFieldType ) const
{
    for( const PCB_FIELD* field : m_fields )
    {
        if( field->GetId() == aFieldType )
            return field;
    }
 
    return nullptr;
}
 
 
bool FOOTPRINT::HasField( const wxString& aFieldName ) const
{
    return GetField( aFieldName ) != nullptr;
}
 
 
PCB_FIELD* FOOTPRINT::GetField( const wxString& aFieldName ) const
{
    for( PCB_FIELD* field : m_fields )
    {
        if( field->GetName() == aFieldName )
            return field;
    }
 
    return nullptr;
}
 
 
void FOOTPRINT::GetFields( std::vector<PCB_FIELD*>& aVector, bool aVisibleOnly ) const
{
    aVector.clear();
 
    for( PCB_FIELD* field : m_fields )
    {
        if( aVisibleOnly )
        {
            if( !field->IsVisible() || field->GetText().IsEmpty() )
                continue;
        }
 
        aVector.push_back( field );
    }
 
    std::sort( aVector.begin(), aVector.end(),
               []( PCB_FIELD* lhs, PCB_FIELD* rhs )
               {
                   return lhs->GetOrdinal() < rhs->GetOrdinal();
               } );
}
 
 
void FOOTPRINT::UpdateFields( const std::vector<PCB_FIELD>& aFields, std::vector<PCB_FIELD*>& aAdded,
                              std::vector<PCB_FIELD*>& aDetached )
{
    std::deque<PCB_FIELD*> updatedFieldSet;
    std::vector<wxString>  assignedFields;
 
    auto assignOrAdd =
            [&]( PCB_FIELD* existingField, const PCB_FIELD& sourceField )
            {
                if( existingField )
                {
                    *existingField = sourceField;
                    existingField->ClearEditFlags();
                    existingField->SetParent( this );
                    updatedFieldSet.push_back( existingField );
                    assignedFields.push_back( sourceField.GetName() );
                }
                else
                {
                    PCB_FIELD* destField = sourceField.CloneField();
                    aAdded.push_back( destField );
                    updatedFieldSet.push_back( destField );
                }
            };
 
    for( const PCB_FIELD& field : aFields )
    {
        // The const overload returns nullptr for a missing mandatory field instead of quietly creating one
        if( field.IsMandatory() )
            assignOrAdd( const_cast<PCB_FIELD*>( std::as_const( *this ).GetField( field.GetId() ) ), field );
        else
            assignOrAdd( GetField( field.GetName() ), field );
    }
 
    for( PCB_FIELD* field : m_fields )
    {
        if( !field->IsMandatory() && !alg::contains( assignedFields, field->GetName() ) )
            aDetached.push_back( field );
    }
 
    // Add() and Remove() carry the board's item-by-id cache and the geometry caches with them
    for( PCB_FIELD* field : aDetached )
        Remove( field );
 
    for( PCB_FIELD* field : aAdded )
        Add( field );
 
    // Add() appends, so restore the order the caller asked for
    m_fields = std::move( updatedFieldSet );
 
    InvalidateGeometryCaches();
}
 
 
int FOOTPRINT::GetNextFieldOrdinal() const
{
    int ordinal = 42;     // Arbitrarily larger than any mandatory FIELD_T id
 
    for( const PCB_FIELD* field : m_fields )
        ordinal = std::max( ordinal, field->GetOrdinal() + 1 );
 
    return ordinal;
}
 
 
void FOOTPRINT::ApplyDefaultSettings( const BOARD& board, bool aStyleFields, bool aStyleText,
                                      bool aStyleShapes, bool aStyleDimensions, bool aStyleBarcodes )
{
    if( aStyleFields )
    {
        for( PCB_FIELD* field : m_fields )
            field->StyleFromSettings( board.GetDesignSettings(), true );
    }
 
    for( BOARD_ITEM* item : m_drawings )
    {
        switch( item->Type() )
        {
        case PCB_TEXT_T:
        case PCB_TEXTBOX_T:
            if( aStyleText )
                item->StyleFromSettings( board.GetDesignSettings(), true );
 
            break;
 
        case PCB_SHAPE_T:
            if( aStyleShapes && !item->IsOnCopperLayer() )
                item->StyleFromSettings( board.GetDesignSettings(), true );
 
            break;
 
        case PCB_DIM_ALIGNED_T:
        case PCB_DIM_LEADER_T:
        case PCB_DIM_CENTER_T:
        case PCB_DIM_RADIAL_T:
        case PCB_DIM_ORTHOGONAL_T:
            if( aStyleDimensions )
                item->StyleFromSettings( board.GetDesignSettings(), true );
 
            break;
 
        case PCB_BARCODE_T:
            if( aStyleBarcodes )
                item->StyleFromSettings( board.GetDesignSettings(), true );
 
            break;
 
        default:
            break;
        }
    }
}
 
 
bool FOOTPRINT::FixUuids()
{
    // replace null UUIDs if any by a valid uuid
    std::vector< BOARD_ITEM* > item_list;
 
    for( PCB_FIELD* field : m_fields )
        item_list.push_back( field );
 
    for( PAD* pad : m_pads )
        item_list.push_back( pad );
 
    for( BOARD_ITEM* gr_item : m_drawings )
        item_list.push_back( gr_item );
 
    // Note: one cannot fix null UUIDs inside the group, but it should not happen
    // because null uuids can be found in old footprints, therefore without group
    for( PCB_GROUP* group : m_groups )
        item_list.push_back( group );
 
    // Probably not needed, because old fp do not have zones. But just in case.
    for( ZONE* zone : m_zones )
        item_list.push_back( zone );
 
    // Ditto
    for( PCB_POINT* point : m_points )
        item_list.push_back( point );
 
    bool changed = false;
 
    for( BOARD_ITEM* item : item_list )
    {
        if( item->m_Uuid == niluuid )
        {
            item->ResetUuidDirect();
            changed = true;
        }
    }
 
    return changed;
}
 
 
FOOTPRINT& FOOTPRINT::operator=( FOOTPRINT&& aOther )
{
    BOARD_ITEM::operator=( aOther );
 
    m_courtyard_cache.reset();
    m_geometry_cache.reset();
 
    m_fpid          = aOther.m_fpid;
    m_attributes    = aOther.m_attributes;
    m_fpStatus      = aOther.m_fpStatus;
    m_transform     = aOther.m_transform;
    m_flipped       = aOther.m_flipped;
    m_lastEditTime  = aOther.m_lastEditTime;
    m_link          = aOther.m_link;
    m_path          = aOther.m_path;
    m_variants      = std::move( aOther.m_variants );
 
    m_clearance                      = aOther.m_clearance;
    m_solderMaskMargin               = aOther.m_solderMaskMargin;
    m_solderPasteMargin              = aOther.m_solderPasteMargin;
    m_solderPasteMarginRatio         = aOther.m_solderPasteMarginRatio;
    m_zoneConnection                 = aOther.m_zoneConnection;
    m_netTiePadGroups                = aOther.m_netTiePadGroups;
    m_duplicatePadNumbersAreJumpers  = aOther.m_duplicatePadNumbersAreJumpers;
    m_jumperPadGroups                = aOther.m_jumperPadGroups;
 
    // If this footprint is on a board, uncache all items before deleting them
    if( BOARD* board = GetBoard() )
        board->UncacheChildrenById( this );
 
    // Move the fields
    for( PCB_FIELD* field : m_fields )
        delete field;
 
    m_fields.clear();
 
    for( PCB_FIELD* field : aOther.m_fields )
        Add( field );
 
    aOther.m_fields.clear();
 
    // Move the pads
    for( PAD* pad : m_pads )
        delete pad;
 
    m_pads.clear();
 
    for( PAD* pad : aOther.Pads() )
        Add( pad );
 
    aOther.Pads().clear();
 
    // Move the zones
    for( ZONE* zone : m_zones )
        delete zone;
 
    m_zones.clear();
 
    for( ZONE* item : aOther.Zones() )
    {
        Add( item );
 
        // Ensure the net info is OK and especially uses the net info list
        // living in the current board
        // Needed when copying a fp from fp editor that has its own board
        // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
        item->SetNetCode( -1 );
    }
 
    aOther.Zones().clear();
 
    // Move the drawings
    for( BOARD_ITEM* item : m_drawings )
        delete item;
 
    m_drawings.clear();
 
    for( BOARD_ITEM* item : aOther.GraphicalItems() )
        Add( item );
 
    aOther.GraphicalItems().clear();
 
    // Move the groups
    for( PCB_GROUP* group : m_groups )
        delete group;
 
    m_groups.clear();
 
    for( PCB_GROUP* group : aOther.Groups() )
        Add( group );
 
    aOther.Groups().clear();
 
    // Move the constraints
    for( PCB_CONSTRAINT* constraint : m_constraints )
        delete constraint;
 
    m_constraints.clear();
 
    for( PCB_CONSTRAINT* constraint : aOther.Constraints() )
        Add( constraint );
 
    aOther.Constraints().clear();
 
    // Move the points
    for( PCB_POINT* point : m_points )
        delete point;
 
    m_points.clear();
 
    for( PCB_POINT* point : aOther.Points() )
        Add( point );
 
    aOther.Points().clear();
 
    EMBEDDED_FILES::operator=( std::move( aOther ) );
 
    // Copy auxiliary data
    m_3D_Drawings      = aOther.m_3D_Drawings;
    m_extrudedBody = std::move( aOther.m_extrudedBody );
    m_libDescription   = aOther.m_libDescription;
    m_keywords         = aOther.m_keywords;
    m_privateLayers    = aOther.m_privateLayers;
 
    m_initial_comments = aOther.m_initial_comments;
 
    m_componentClassCacheProxy->SetStaticComponentClass(
            aOther.m_componentClassCacheProxy->GetStaticComponentClass() );
 
    // Clear the other item's containers since this is a move
    aOther.m_fields.clear();
    aOther.Pads().clear();
    aOther.Zones().clear();
    aOther.GraphicalItems().clear();
    aOther.m_initial_comments = nullptr;
 
    return *this;
}
 
 
FOOTPRINT& FOOTPRINT::operator=( const FOOTPRINT& aOther )
{
    BOARD_ITEM::operator=( aOther );
 
    m_courtyard_cache.reset();
    m_geometry_cache.reset();
 
    m_fpid          = aOther.m_fpid;
    m_attributes    = aOther.m_attributes;
    m_fpStatus      = aOther.m_fpStatus;
    m_transform     = aOther.m_transform;
    m_flipped       = aOther.m_flipped;
    m_lastEditTime  = aOther.m_lastEditTime;
    m_link          = aOther.m_link;
    m_path          = aOther.m_path;
 
    m_clearance                      = aOther.m_clearance;
    m_solderMaskMargin               = aOther.m_solderMaskMargin;
    m_solderPasteMargin              = aOther.m_solderPasteMargin;
    m_solderPasteMarginRatio         = aOther.m_solderPasteMarginRatio;
    m_zoneConnection                 = aOther.m_zoneConnection;
    m_netTiePadGroups                = aOther.m_netTiePadGroups;
    m_duplicatePadNumbersAreJumpers  = aOther.m_duplicatePadNumbersAreJumpers;
    m_jumperPadGroups                = aOther.m_jumperPadGroups;
    m_variants                       = aOther.m_variants;
 
    // If this footprint is on a board, uncache all items before deleting them
    if( BOARD* board = GetBoard() )
        board->UncacheChildrenById( this );
 
    std::map<EDA_ITEM*, EDA_ITEM*> ptrMap;
 
    // Copy fields
    for( PCB_FIELD* field : m_fields )
        delete field;
 
    m_fields.clear();
 
    for( PCB_FIELD* field : aOther.m_fields )
    {
        PCB_FIELD* newField = new PCB_FIELD( *field );
        ptrMap[field] = newField;
        Add( newField );
    }
 
    // Copy pads
    for( PAD* pad : m_pads )
        delete pad;
 
    m_pads.clear();
 
    for( PAD* pad : aOther.Pads() )
    {
        PAD* newPad = new PAD( *pad );
        ptrMap[ pad ] = newPad;
        Add( newPad );
    }
 
    // Copy zones
    for( ZONE* zone : m_zones )
        delete zone;
 
    m_zones.clear();
 
    for( ZONE* zone : aOther.Zones() )
    {
        ZONE* newZone = static_cast<ZONE*>( zone->Clone() );
        ptrMap[ zone ] = newZone;
        Add( newZone );
 
        // Ensure the net info is OK and especially uses the net info list
        // living in the current board
        // Needed when copying a fp from fp editor that has its own board
        // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
        newZone->SetNetCode( -1 );
    }
 
    // Copy drawings
    for( BOARD_ITEM* item : m_drawings )
        delete item;
 
    m_drawings.clear();
 
    for( BOARD_ITEM* item : aOther.GraphicalItems() )
    {
        BOARD_ITEM* newItem = static_cast<BOARD_ITEM*>( item->Clone() );
        ptrMap[ item ] = newItem;
        Add( newItem );
    }
 
    // Copy groups
    for( PCB_GROUP* group : m_groups )
        delete group;
 
    m_groups.clear();
 
    for( PCB_GROUP* group : aOther.Groups() )
    {
        PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( group->Clone() );
        newGroup->GetItems().clear();
 
        for( EDA_ITEM* member : group->GetItems() )
            newGroup->AddItem( ptrMap[ member ] );
 
        Add( newGroup );
    }
 
    // Copy constraints.  Members reference items by KIID, which Clone preserves, so the
    // copies still point at the matching cloned items by uuid (resolved on next use).
    for( PCB_CONSTRAINT* constraint : m_constraints )
        delete constraint;
 
    m_constraints.clear();
 
    for( PCB_CONSTRAINT* constraint : aOther.Constraints() )
        Add( static_cast<PCB_CONSTRAINT*>( constraint->Clone() ) );
 
    // Copy points
    for( PCB_POINT* point : m_points )
        delete point;
 
    m_points.clear();
 
    for( PCB_POINT* point : aOther.Points() )
    {
        BOARD_ITEM* newItem = static_cast<BOARD_ITEM*>( point->Clone() );
        ptrMap[ point ] = newItem;
        Add( newItem );
    }
 
    // Copy auxiliary data
    m_3D_Drawings   = aOther.m_3D_Drawings;
 
    if( aOther.m_extrudedBody )
        m_extrudedBody = std::make_unique<EXTRUDED_3D_BODY>( *aOther.m_extrudedBody );
    else
        m_extrudedBody.reset();
 
    m_libDescription = aOther.m_libDescription;
    m_keywords      = aOther.m_keywords;
    m_privateLayers = aOther.m_privateLayers;
 
    m_initial_comments = aOther.m_initial_comments ?
                            new wxArrayString( *aOther.m_initial_comments ) : nullptr;
 
    m_componentClassCacheProxy->SetStaticComponentClass(
            aOther.m_componentClassCacheProxy->GetStaticComponentClass() );
 
    EMBEDDED_FILES::operator=( aOther );
 
    return *this;
}
 
 
void FOOTPRINT::CopyFrom( const BOARD_ITEM* aOther )
{
    wxCHECK( aOther && aOther->Type() == PCB_FOOTPRINT_T, /* void */ );
    *this = *static_cast<const FOOTPRINT*>( aOther );
 
    for( PAD* pad : m_pads )
        pad->SetDirty();
}
 
 
void FOOTPRINT::InvalidateGeometryCaches()
{
    {
        std::lock_guard<std::mutex> lock( m_geometry_cache_mutex );
        m_geometry_cache.reset();
    }
 
    std::lock_guard<std::mutex> lock( m_courtyard_cache_mutex );
    m_courtyard_cache.reset();
}
 
 
bool FOOTPRINT::IsConflicting() const
{
    return HasFlag( COURTYARD_CONFLICT );
}
 
 
bool FOOTPRINT::IsWithinSchematicSheet( const KIID_PATH& aSheetPath ) const
{
    if( aSheetPath.empty() )
        return false;
 
    // m_path is written by the netlist, which omits the root sheet the way PathAsString() does
    return m_path.size() >= aSheetPath.size() - 1
           && std::equal( aSheetPath.begin() + 1, aSheetPath.end(), m_path.begin() );
}
 
 
void FOOTPRINT::GetContextualTextVars( wxArrayString* aVars ) const
{
    aVars->push_back( wxT( "REFERENCE" ) );
    aVars->push_back( wxT( "VALUE" ) );
    aVars->push_back( wxT( "LAYER" ) );
    aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
    aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
    aVars->push_back( wxT( "SHORT_NET_NAME(<pad_number>)" ) );
    aVars->push_back( wxT( "NET_NAME(<pad_number>)" ) );
    aVars->push_back( wxT( "NET_CLASS(<pad_number>)" ) );
    aVars->push_back( wxT( "PIN_NAME(<pad_number>)" ) );
    aVars->push_back( wxT( "EXCLUDE_FROM_BOM" ) );
    aVars->push_back( wxT( "EXCLUDE_FROM_BOARD" ) );
    aVars->push_back( wxT( "EXCLUDE_FROM_SIM" ) );
    aVars->push_back( wxT( "EXCLUDE_FROM_POS_FILES" ) );
    aVars->push_back( wxT( "DNP" ) );
}
 
 
bool FOOTPRINT::ResolveTextVar( wxString* token, int aDepth ) const
{
    wxString variant;
 
    if( GetBoard() )
        variant = GetBoard()->GetCurrentVariant();
 
    return ResolveTextVar( token, variant, aDepth );
}
 
 
bool FOOTPRINT::ResolveTextVar( wxString* token, const wxString& aVariantName, int aDepth ) const
{
    if( GetBoard() && GetBoard()->GetBoardUse() == BOARD_USE::FPHOLDER )
        return false;
 
    wxString variant = aVariantName;
 
    if( token->IsSameAs( wxT( "REFERENCE" ) ) )
    {
        if( const PCB_FIELD* reference = GetField( FIELD_T::REFERENCE ) )
            *token = reference->GetShownText( variant, INTERNAL, aDepth + 1 );
        else
            token->Clear();
 
        return true;
    }
    else if( token->IsSameAs( wxT( "VALUE" ) ) )
    {
        if( const PCB_FIELD* value = GetField( FIELD_T::VALUE ) )
            *token = value->GetShownText( variant, INTERNAL, aDepth + 1 );
        else
            token->Clear();
 
        return true;
    }
    else if( token->IsSameAs( wxT( "LAYER" ) ) )
    {
        *token = GetLayerName();
        return true;
    }
    else if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
    {
        *token = m_fpid.GetUniStringLibNickname();
        return true;
    }
    else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
    {
        *token = m_fpid.GetUniStringLibItemName();
        return true;
    }
    else if( token->StartsWith( wxT( "SHORT_NET_NAME(" ) )
                 || token->StartsWith( wxT( "NET_NAME(" ) )
                 || token->StartsWith( wxT( "NET_CLASS(" ) )
                 || token->StartsWith( wxT( "PIN_NAME(" ) ) )
    {
        wxString padNumber = token->AfterFirst( '(' );
        padNumber = padNumber.BeforeLast( ')' );
 
        for( PAD* pad : Pads() )
        {
            if( pad->GetNumber() == padNumber )
            {
                if( token->StartsWith( wxT( "SHORT_NET_NAME" ) ) )
                    *token = pad->GetShortNetname();
                else if( token->StartsWith( wxT( "NET_NAME" ) ) )
                    *token = pad->GetNetname();
                else if( token->StartsWith( wxT( "NET_CLASS" ) ) )
                    *token = pad->GetNetClassName();
                else
                    *token = pad->GetPinFunction();
 
                return true;
            }
        }
    }
    else if( token->IsSameAs( wxT( "EXCLUDE_FROM_BOM" ) ) )
    {
        *token = wxEmptyString;
 
        if( GetExcludedFromBOMForVariant( variant ) )
            *token = wxS( "Excluded from BOM" );
 
        return true;
    }
    else if( token->IsSameAs( wxT( "EXCLUDE_FROM_POS_FILES" ) ) )
    {
        *token = wxEmptyString;
 
        if( GetExcludedFromPosFilesForVariant( variant ) )
            *token = wxS( "Excluded from position files" );
 
        return true;
    }
    else if( token->IsSameAs( wxT( "EXCLUDE_FROM_BOARD" ) ) )
    {
        // Footprints are never excluded from board by definition
        *token = wxEmptyString;
        return true;
    }
    else if( token->IsSameAs( wxT( "EXCLUDE_FROM_SIM" ) ) )
    {
        *token = wxEmptyString;
 
        if( GetExcludedFromSimForVariant( variant ) )
            *token = wxS( "Excluded from simulation" );
 
        return true;
    }
    else if( token->IsSameAs( wxT( "DNP" ) ) )
    {
        *token = wxEmptyString;
 
        if( GetDNPForVariant( variant ) )
            *token = wxS( "DNP" );
 
        return true;
    }
    else if( PCB_FIELD* field = GetField( *token ) )
    {
        *token = field->GetShownText( variant, INTERNAL, aDepth + 1 );
        return true;
    }
    // The great property resolver: ${PROPERTY.My_Property}
    else if( token->StartsWith( wxS( "PROPERTY." ) ) )
    {
        // Get the second half, convert _ to ' '
        wxString propertyName = token->AfterFirst( '.' );
        propertyName.Replace( wxS( "_" ), wxS( " " ) );
 
        // Check if the property manager knows this property
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        PROPERTY_BASE*    property = propMgr.GetProperty( this, propertyName );
 
        if( !property || property->IsHiddenFromPropertiesManager() )
            return false;
 
        if( !propMgr.IsAvailableFor( TYPE_HASH( *this ), property, const_cast<FOOTPRINT*>( this ) ) )
            return false;
 
        KICAD_DIFF::DIFF_VALUE value = KICAD_DIFF::WxAnyToDiffValue( Get( property ), property );
 
        if( value.GetType() == KICAD_DIFF::DIFF_VALUE::T::NONE )
            return false;
 
        *token = value.ToDisplayString( EDA_UNITS::MM, pcbIUScale );
        return true;
    }
 
    if( GetBoard() && GetBoard()->ResolveTextVar( token, aVariantName, aDepth + 1 ) )
        return true;
 
    return false;
}
 
 
// ============================================================================
// Variant Support Implementation
// ============================================================================
 
const FOOTPRINT_VARIANT* FOOTPRINT::GetVariant( const wxString& aVariantName ) const
{
    auto it = m_variants.find( aVariantName );
 
    return it != m_variants.end() ? &it->second : nullptr;
}
 
 
FOOTPRINT_VARIANT* FOOTPRINT::GetVariant( const wxString& aVariantName )
{
    auto it = m_variants.find( aVariantName );
 
    return it != m_variants.end() ? &it->second : nullptr;
}
 
 
void FOOTPRINT::SetVariant( const FOOTPRINT_VARIANT& aVariant )
{
    if( aVariant.GetName().IsEmpty()
        || aVariant.GetName().CmpNoCase( GetDefaultVariantName() ) == 0 )
    {
        return;
    }
 
    auto it = m_variants.find( aVariant.GetName() );
 
    if( it != m_variants.end() )
    {
        FOOTPRINT_VARIANT updated = aVariant;
        updated.SetName( it->first );
        it->second = std::move( updated );
        return;
    }
 
    m_variants.emplace( aVariant.GetName(), aVariant );
}
 
 
FOOTPRINT_VARIANT* FOOTPRINT::AddVariant( const wxString& aVariantName )
{
    if( aVariantName.IsEmpty()
        || aVariantName.CmpNoCase( GetDefaultVariantName() ) == 0 )
    {
        wxASSERT_MSG( false, wxT( "Variant name cannot be empty or default." ) );
        return nullptr;
    }
 
    auto it = m_variants.find( aVariantName );
 
    if( it != m_variants.end() )
        return &it->second;
 
    FOOTPRINT_VARIANT variant( aVariantName );
    variant.SetDNP( IsDNP() );
    variant.SetExcludedFromBOM( IsExcludedFromBOM() );
    variant.SetExcludedFromSim( IsExcludedFromSim() );
    variant.SetExcludedFromPosFiles( IsExcludedFromPosFiles() );
 
    auto inserted = m_variants.emplace( aVariantName, std::move( variant ) );
    return &inserted.first->second;
}
 
 
void FOOTPRINT::DeleteVariant( const wxString& aVariantName )
{
    m_variants.erase( aVariantName );
}
 
 
void FOOTPRINT::RenameVariant( const wxString& aOldName, const wxString& aNewName )
{
    if( aNewName.IsEmpty()
        || aNewName.CmpNoCase( GetDefaultVariantName() ) == 0 )
    {
        return;
    }
 
    auto it = m_variants.find( aOldName );
 
    if( it == m_variants.end() )
        return;
 
    auto existingIt = m_variants.find( aNewName );
 
    if( existingIt != m_variants.end() && existingIt != it )
        return;
 
    if( it->first == aNewName )
        return;
 
    FOOTPRINT_VARIANT variant = it->second;
    variant.SetName( aNewName );
    m_variants.erase( it );
    m_variants.emplace( aNewName, std::move( variant ) );
}
 
 
bool FOOTPRINT::HasVariant( const wxString& aVariantName ) const
{
    return m_variants.find( aVariantName ) != m_variants.end();
}
 
 
bool FOOTPRINT::GetDNPForVariant( const wxString& aVariantName ) const
{
    // Empty variant name means default
    if( aVariantName.IsEmpty() || aVariantName.CmpNoCase( GetDefaultVariantName() ) == 0 )
        return IsDNP();
 
    const FOOTPRINT_VARIANT* variant = GetVariant( aVariantName );
 
    if( variant )
        return variant->GetDNP();
 
    // Fall back to default if variant doesn't exist
    return IsDNP();
}
 
 
bool FOOTPRINT::GetExcludedFromBOMForVariant( const wxString& aVariantName ) const
{
    // Empty variant name means default
    if( aVariantName.IsEmpty() || aVariantName.CmpNoCase( GetDefaultVariantName() ) == 0 )
        return IsExcludedFromBOM();
 
    const FOOTPRINT_VARIANT* variant = GetVariant( aVariantName );
 
    if( variant )
        return variant->GetExcludedFromBOM();
 
    // Fall back to default if variant doesn't exist
    return IsExcludedFromBOM();
}
 
 
bool FOOTPRINT::GetExcludedFromSimForVariant( const wxString& aVariantName ) const
{
    // Empty variant name means default
    if( aVariantName.IsEmpty() || aVariantName.CmpNoCase( GetDefaultVariantName() ) == 0 )
        return IsExcludedFromSim();
 
    const FOOTPRINT_VARIANT* variant = GetVariant( aVariantName );
 
    if( variant )
        return variant->GetExcludedFromSim();
 
    // Fall back to default if variant doesn't exist
    return IsExcludedFromSim();
}
 
 
bool FOOTPRINT::GetExcludedFromPosFilesForVariant( const wxString& aVariantName ) const
{
    // Empty variant name means default
    if( aVariantName.IsEmpty() || aVariantName.CmpNoCase( GetDefaultVariantName() ) == 0 )
        return IsExcludedFromPosFiles();
 
    const FOOTPRINT_VARIANT* variant = GetVariant( aVariantName );
 
    if( variant )
        return variant->GetExcludedFromPosFiles();
 
    // Fall back to default if variant doesn't exist
    return IsExcludedFromPosFiles();
}
 
 
wxString FOOTPRINT::GetFieldValueForVariant( const wxString& aVariantName, const wxString& aFieldName ) const
{
    // Check variant-specific override first
    if( !aVariantName.IsEmpty() && aVariantName.CmpNoCase( GetDefaultVariantName() ) != 0 )
    {
        const FOOTPRINT_VARIANT* variant = GetVariant( aVariantName );
 
        if( variant && variant->HasFieldValue( aFieldName ) )
            return variant->GetFieldValue( aFieldName );
    }
 
    // Fall back to default field value
    if( const PCB_FIELD* field = GetField( aFieldName ) )
        return field->GetText();
 
    return wxString();
}
 
 
void FOOTPRINT::ClearAllNets()
{
    // Force the ORPHANED dummy net info on every BOARD_CONNECTED_ITEM descendant so that
    // operations which read through m_netinfo (e.g. library serialization) cannot chase a
    // dangling pointer when this footprint has been detached from its original parent board.
    // ORPHANED dummy net does not depend on a board.
    RunOnChildren(
            []( BOARD_ITEM* aItem )
            {
                if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( aItem ) )
                    bci->SetNetCode( NETINFO_LIST::ORPHANED, /* aNoAssert */ true );
            },
            RECURSE_MODE::RECURSE );
}
 
 
void FOOTPRINT::Add( BOARD_ITEM* aBoardItem, ADD_MODE aMode, bool aSkipConnectivity )
{
    switch( aBoardItem->Type() )
    {
    case PCB_FIELD_T:
        m_fields.push_back( static_cast<PCB_FIELD*>( aBoardItem ) );
        break;
 
    case PCB_BARCODE_T:
    case PCB_TEXT_T:
    case PCB_DIM_ALIGNED_T:
    case PCB_DIM_LEADER_T:
    case PCB_DIM_CENTER_T:
    case PCB_DIM_RADIAL_T:
    case PCB_DIM_ORTHOGONAL_T:
    case PCB_SHAPE_T:
    case PCB_TEXTBOX_T:
    case PCB_TABLE_T:
    case PCB_REFERENCE_IMAGE_T:
        if( aMode == ADD_MODE::APPEND )
            m_drawings.push_back( aBoardItem );
        else
            m_drawings.push_front( aBoardItem );
 
        break;
 
    case PCB_PAD_T:
        if( aMode == ADD_MODE::APPEND )
            m_pads.push_back( static_cast<PAD*>( aBoardItem ) );
        else
            m_pads.push_front( static_cast<PAD*>( aBoardItem ) );
 
        break;
 
    case PCB_ZONE_T:
        if( aMode == ADD_MODE::APPEND )
            m_zones.push_back( static_cast<ZONE*>( aBoardItem ) );
        else
            m_zones.insert( m_zones.begin(), static_cast<ZONE*>( aBoardItem ) );
 
        break;
 
    case PCB_GROUP_T:
        if( aMode == ADD_MODE::APPEND )
            m_groups.push_back( static_cast<PCB_GROUP*>( aBoardItem ) );
        else
            m_groups.insert( m_groups.begin(), static_cast<PCB_GROUP*>( aBoardItem ) );
 
        break;
 
    case PCB_CONSTRAINT_T:
        if( aMode == ADD_MODE::APPEND )
            m_constraints.push_back( static_cast<PCB_CONSTRAINT*>( aBoardItem ) );
        else
            m_constraints.insert( m_constraints.begin(), static_cast<PCB_CONSTRAINT*>( aBoardItem ) );
 
        break;
 
    case PCB_MARKER_T:
        wxFAIL_MSG( wxT( "FOOTPRINT::Add(): Markers go at the board level, even in the footprint editor" ) );
        return;
 
    case PCB_FOOTPRINT_T:
        wxFAIL_MSG( wxT( "FOOTPRINT::Add(): Nested footprints not supported" ) );
        return;
 
    case PCB_POINT_T:
        if( aMode == ADD_MODE::APPEND )
            m_points.push_back( static_cast<PCB_POINT*>( aBoardItem ) );
        else
            m_points.insert( m_points.begin(), static_cast<PCB_POINT*>( aBoardItem ) );
 
        break;
 
    default:
        wxFAIL_MSG( wxString::Format( wxT( "FOOTPRINT::Add(): BOARD_ITEM type (%d) not handled" ),
                                      aBoardItem->Type() ) );
 
        return;
    }
 
    aBoardItem->ClearEditFlags();
    aBoardItem->SetParent( this );
 
    // If this footprint is on a board, update the board's item-by-id cache
    // Skip caching for copy-constructed footprints (inherited board ptr but not a real member).
    if( BOARD* board = GetBoard(); board && board->IsItemIndexedById( this ) )
    {
        board->CacheItemSubtreeById( aBoardItem );
 
        // A pad arriving here never passes through BOARD::Add, so this is the only chance to
        // invalidate the drill caches
        board->noteDrillModelChange( aBoardItem );
    }
 
    InvalidateGeometryCaches();
}
 
 
void FOOTPRINT::Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aMode )
{
    switch( aBoardItem->Type() )
    {
    case PCB_FIELD_T:
        for( auto it = m_fields.begin(); it != m_fields.end(); ++it )
        {
            if( *it == aBoardItem )
            {
                const wxString fieldName = ( *it )->GetUntranslatedName();
 
                m_fields.erase( it );
 
                for( auto& [variantName, footprintVariant] : m_variants )
                    footprintVariant.RemoveFieldValue( fieldName );
 
                break;
            }
        }
 
        break;
 
    case PCB_BARCODE_T:
    case PCB_TEXT_T:
    case PCB_DIM_ALIGNED_T:
    case PCB_DIM_CENTER_T:
    case PCB_DIM_ORTHOGONAL_T:
    case PCB_DIM_RADIAL_T:
    case PCB_DIM_LEADER_T:
    case PCB_SHAPE_T:
    case PCB_TEXTBOX_T:
    case PCB_TABLE_T:
    case PCB_REFERENCE_IMAGE_T:
        for( auto it = m_drawings.begin(); it != m_drawings.end(); ++it )
        {
            if( *it == aBoardItem )
            {
                m_drawings.erase( it );
                break;
            }
        }
 
        break;
 
    case PCB_PAD_T:
        for( auto it = m_pads.begin(); it != m_pads.end(); ++it )
        {
            if( *it == static_cast<PAD*>( aBoardItem ) )
            {
                m_pads.erase( it );
                break;
            }
        }
 
        break;
 
    case PCB_ZONE_T:
        for( auto it = m_zones.begin(); it != m_zones.end(); ++it )
        {
            if( *it == static_cast<ZONE*>( aBoardItem ) )
            {
                m_zones.erase( it );
                break;
            }
        }
 
        break;
 
    case PCB_CONSTRAINT_T:
        for( auto it = m_constraints.begin(); it != m_constraints.end(); ++it )
        {
            if( *it == static_cast<PCB_CONSTRAINT*>( aBoardItem ) )
            {
                m_constraints.erase( it );
                break;
            }
        }
 
        break;
 
    case PCB_GROUP_T:
        for( auto it = m_groups.begin(); it != m_groups.end(); ++it )
        {
            if( *it == static_cast<PCB_GROUP*>( aBoardItem ) )
            {
                m_groups.erase( it );
                break;
            }
        }
 
        break;
 
    case PCB_MARKER_T:
        wxFAIL_MSG( wxT( "FOOTPRINT::Remove(): Markers go at the board level, even in the footprint editor" ) );
        break;
 
    case PCB_FOOTPRINT_T:
        wxFAIL_MSG( wxT( "FOOTPRINT::Remove(): Nested footprints not supported" ) );
        break;
 
    case PCB_POINT_T:
        for( auto it = m_points.begin(); it != m_points.end(); ++it )
        {
            if( *it == static_cast<PCB_POINT*>( aBoardItem ) )
            {
                m_points.erase( it );
                break;
            }
        }
 
        break;
 
    default:
        wxFAIL_MSG( wxString::Format( wxT( "FOOTPRINT::Remove() needs work: BOARD_ITEM type (%d) not handled" ),
                                      aBoardItem->Type() ) );
    }
 
    // If this footprint is on a board, update the board's item-by-id cache
    if( BOARD* board = GetBoard() )
    {
        if( board->IsItemIndexedById( this ) )
        {
            board->UncacheItemSubtreeById( aBoardItem );
            board->noteDrillModelChange( aBoardItem );
        }
 
        board->IncrementTimeStamp();
    }
 
    aBoardItem->SetFlags( STRUCT_DELETED );
 
    InvalidateGeometryCaches();
}
 
 
double FOOTPRINT::GetArea( int aPadding ) const
{
    BOX2I bbox = GetBoundingBox( false );
 
    double w = std::abs( static_cast<double>( bbox.GetWidth() ) ) + aPadding;
    double h = std::abs( static_cast<double>( bbox.GetHeight() ) ) + aPadding;
    return w * h;
}
 
 
int FOOTPRINT::GetLikelyAttribute() const
{
    int smd_count = 0;
    int tht_count = 0;
 
    for( PAD* pad : m_pads )
    {
        switch( pad->GetProperty() )
        {
        case PAD_PROP::FIDUCIAL_GLBL:
        case PAD_PROP::FIDUCIAL_LOCAL:
            continue;
 
        case PAD_PROP::HEATSINK:
        case PAD_PROP::CASTELLATED:
        case PAD_PROP::MECHANICAL:
            continue;
 
        case PAD_PROP::NONE:
        case PAD_PROP::BGA:
        case PAD_PROP::TESTPOINT:
        case PAD_PROP::PRESSFIT:
            break;
        }
 
        switch( pad->GetAttribute() )
        {
        case PAD_ATTRIB::PTH:
            tht_count++;
            break;
 
        case PAD_ATTRIB::SMD:
            if( pad->IsOnCopperLayer() )
                smd_count++;
 
            break;
 
        default:
            break;
        }
    }
 
    // Footprints with plated through-hole pads should usually be marked through hole even if they
    // also have SMD because they might not be auto-placed.  Exceptions to this might be shielded
    if( tht_count > 0 )
        return FP_THROUGH_HOLE;
 
    if( smd_count > 0 )
        return FP_SMD;
 
    return 0;
}
 
 
wxString FOOTPRINT::GetTypeName() const
{
    if( GetFootprintType() == FOOTPRINT_TYPE::SMD )
        return _( "SMD" );
 
    if( GetFootprintType() == FOOTPRINT_TYPE::THROUGH_HOLE )
        return _( "Through hole" );
 
    return _( "Unspecified" );
}
 
 
FOOTPRINT_TYPE FOOTPRINT::GetFootprintType() const
{
    if( m_attributes & FP_SMD )
        return FOOTPRINT_TYPE::SMD;
 
    if( m_attributes & FP_THROUGH_HOLE )
        return FOOTPRINT_TYPE::THROUGH_HOLE;
 
    return FOOTPRINT_TYPE::UNSPECIFIED;
}
 
 
void FOOTPRINT::SetFootprintType( FOOTPRINT_TYPE aMountingStyle )
{
    m_attributes &= ~( FP_THROUGH_HOLE | FP_SMD );
 
    if( aMountingStyle == FOOTPRINT_TYPE::THROUGH_HOLE )
        m_attributes |= FP_THROUGH_HOLE;
    else if( aMountingStyle == FOOTPRINT_TYPE::SMD )
        m_attributes |= FP_SMD;
}
 
 
std::vector<SEARCH_TERM>& FOOTPRINT::GetSearchTerms()
{
    m_searchTerms.clear();
    m_searchTerms.reserve( 6 );
 
    m_searchTerms.emplace_back( SEARCH_TERM( GetLibNickname(), 4 ) );
    m_searchTerms.emplace_back( SEARCH_TERM( GetName(), 8, true ) );
    m_searchTerms.emplace_back( SEARCH_TERM( GetLIB_ID().Format(), 16, true ) );
 
    wxStringTokenizer keywordTokenizer( GetKeywords(), wxS( " \t\r\n" ), wxTOKEN_STRTOK );
 
    while( keywordTokenizer.HasMoreTokens() )
        m_searchTerms.emplace_back( SEARCH_TERM( keywordTokenizer.GetNextToken(), 4 ) );
 
    m_searchTerms.emplace_back( SEARCH_TERM( GetKeywords(), 1 ) );
    m_searchTerms.emplace_back( SEARCH_TERM( GetLibDescription(), 1 ) );
 
    return m_searchTerms;
}
 
 
BOX2I FOOTPRINT::GetFpPadsLocalBbox() const
{
    BOX2I bbox;
 
    // We want the bounding box of the footprint pads at rot 0, not flipped
    // Create such a image:
    FOOTPRINT dummy( *this );
 
    dummy.SetPosition( VECTOR2I( 0, 0 ) );
    dummy.SetOrientation( ANGLE_0 );
 
    if( dummy.IsFlipped() )
        dummy.Flip( VECTOR2I( 0, 0 ), FLIP_DIRECTION::TOP_BOTTOM );
 
    for( PAD* pad : dummy.Pads() )
        bbox.Merge( pad->GetBoundingBox() );
 
    return bbox;
}
 
 
bool FOOTPRINT::TextOnly() const
{
    for( BOARD_ITEM* item : m_drawings )
    {
        if( m_privateLayers.test( item->GetLayer() ) )
            continue;
 
        if( item->Type() != PCB_FIELD_T && item->Type() != PCB_TEXT_T )
            return false;
    }
 
    return true;
}
 
 
const BOX2I FOOTPRINT::GetBoundingBox() const
{
    return GetBoundingBox( true );
}
 
 
const BOX2I FOOTPRINT::GetBoundingBox( bool aIncludeText ) const
{
    const BOARD* board = GetBoard();
 
    if( board )
    {
        std::lock_guard<std::mutex> lock( m_geometry_cache_mutex );
 
        if( !m_geometry_cache )
            m_geometry_cache = std::make_unique<FOOTPRINT_GEOMETRY_CACHE_DATA>();
 
        if( aIncludeText )
        {
            if( m_geometry_cache->bounding_box_timestamp >= board->GetTimeStamp() )
                return m_geometry_cache->bounding_box;
        }
        else
        {
            if( m_geometry_cache->text_excluded_bbox_timestamp >= board->GetTimeStamp() )
                return m_geometry_cache->text_excluded_bbox;
        }
    }
 
    std::vector<PCB_TEXT*> texts;
    bool                   isFPEdit = board && board->IsFootprintHolder();
 
    BOX2I bbox( m_transform.GetTranslate() );
    bbox.Inflate( pcbIUScale.mmToIU( 0.25 ) );   // Give a min size to the bbox
 
    // Calculate the footprint side
    PCB_LAYER_ID footprintSide = GetSide();
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( IsValidLayer( item->GetLayer() ) && m_privateLayers.test( item->GetLayer() ) && !isFPEdit )
            continue;
 
        // We want the bitmap bounding box just in the footprint editor
        // so it will start with the correct initial zoom
        if( item->Type() == PCB_REFERENCE_IMAGE_T && !isFPEdit )
            continue;
 
        // Handle text separately
        if( item->Type() == PCB_TEXT_T )
        {
            texts.push_back( static_cast<PCB_TEXT*>( item ) );
            continue;
        }
 
        // If we're not including text then drop annotations as well -- unless, of course, it's
        // an unsided footprint -- in which case it's likely to be nothing *but* annotations.
        if( !aIncludeText && footprintSide != UNDEFINED_LAYER )
        {
            if( BaseType( item->Type() ) == PCB_DIMENSION_T )
                continue;
 
            if( item->GetLayer() == Cmts_User || item->GetLayer() == Dwgs_User
                || item->GetLayer() == Eco1_User || item->GetLayer() == Eco2_User )
            {
                continue;
            }
        }
 
        bbox.Merge( item->GetBoundingBox() );
    }
 
    for( PCB_FIELD* field : m_fields )
    {
        // Reference and value get their own processing
        if( field->IsReference() || field->IsValue() )
            continue;
 
        texts.push_back( field );
    }
 
    for( PAD* pad : m_pads )
        bbox.Merge( pad->GetBoundingBox() );
 
    for( ZONE* zone : m_zones )
        bbox.Merge( zone->GetBoundingBox() );
 
    for( PCB_POINT* point : m_points )
        bbox.Merge( point->GetBoundingBox() );
 
    bool noDrawItems = ( m_drawings.empty() && m_pads.empty() && m_zones.empty() );
 
    // Groups do not contribute to the rect, only their members
    if( aIncludeText || noDrawItems )
    {
        // Only PCB_TEXT and PCB_FIELD items are independently selectable; PCB_TEXTBOX items go
        // in with other graphic items above.
        for( PCB_TEXT* text : texts )
        {
            if( !isFPEdit && m_privateLayers.test( text->GetLayer() ) )
                continue;
 
            if( text->Type() == PCB_FIELD_T && !text->IsVisible() )
                continue;
 
            bbox.Merge( text->GetBoundingBox() );
        }
 
        // A footprint is constructed with its mandatory fields, but they can be removed again
        // through the editing dialogs or the scripting API, and the const accessors return
        // nullptr rather than recreating them.
        const PCB_FIELD* value = GetField( FIELD_T::VALUE );
        const PCB_FIELD* reference = GetField( FIELD_T::REFERENCE );
 
        // This can be further optimized when aIncludeInvisibleText is true, but currently
        // leaving this as is until it's determined there is a noticeable speed hit.
        bool   valueLayerIsVisible = true;
        bool   refLayerIsVisible   = true;
 
        if( board )
        {
            // The first "&&" conditional handles the user turning layers off as well as layers
            // not being present in the current PCB stackup.  Values, references, and all
            // footprint text can also be turned off via the GAL meta-layers, so the 2nd and
            // 3rd "&&" conditionals handle that.
            if( value )
            {
                valueLayerIsVisible = board->IsLayerVisible( value->GetLayer() )
                                      && board->IsElementVisible( LAYER_FP_VALUES )
                                      && board->IsElementVisible( LAYER_FP_TEXT );
            }
 
            if( reference )
            {
                refLayerIsVisible = board->IsLayerVisible( reference->GetLayer() )
                                    && board->IsElementVisible( LAYER_FP_REFERENCES )
                                    && board->IsElementVisible( LAYER_FP_TEXT );
            }
        }
 
 
        if( value && ( ( value->IsVisible() && valueLayerIsVisible ) || noDrawItems ) )
            bbox.Merge( value->GetBoundingBox() );
 
        if( reference && ( ( reference->IsVisible() && refLayerIsVisible ) || noDrawItems ) )
            bbox.Merge( reference->GetBoundingBox() );
    }
 
    if( board )
    {
        std::lock_guard<std::mutex> lock( m_geometry_cache_mutex );
 
        if( !m_geometry_cache )
            m_geometry_cache = std::make_unique<FOOTPRINT_GEOMETRY_CACHE_DATA>();
 
        if( aIncludeText || noDrawItems )
        {
            m_geometry_cache->bounding_box_timestamp = board->GetTimeStamp();
            m_geometry_cache->bounding_box = bbox;
        }
        else
        {
            m_geometry_cache->text_excluded_bbox_timestamp = board->GetTimeStamp();
            m_geometry_cache->text_excluded_bbox = bbox;
        }
    }
 
    return bbox;
}
 
 
const BOX2I FOOTPRINT::GetLayerBoundingBox( const LSET& aLayers ) const
{
    std::vector<PCB_TEXT*> texts;
    const BOARD* board = GetBoard();
    bool         isFPEdit = board && board->IsFootprintHolder();
 
    // Start with an uninitialized bounding box
    BOX2I bbox;
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( IsValidLayer( item->GetLayer() ) && m_privateLayers.test( item->GetLayer() ) && !isFPEdit )
            continue;
 
        if( ( aLayers & item->GetLayerSet() ).none() )
            continue;
 
        // We want the bitmap bounding box just in the footprint editor
        // so it will start with the correct initial zoom
        if( item->Type() == PCB_REFERENCE_IMAGE_T && !isFPEdit )
            continue;
 
        bbox.Merge( item->GetBoundingBox() );
    }
 
    for( PAD* pad : m_pads )
    {
        if( ( aLayers & pad->GetLayerSet() ).none() )
            continue;
 
        bbox.Merge( pad->GetBoundingBox() );
    }
 
    for( ZONE* zone : m_zones )
    {
        if( ( aLayers & zone->GetLayerSet() ).none() )
            continue;
 
        bbox.Merge( zone->GetBoundingBox() );
    }
 
    for( PCB_POINT* point : m_points )
    {
        if( m_privateLayers.test( point->GetLayer() ) && !isFPEdit )
            continue;
 
        if( ( aLayers & point->GetLayerSet() ).none() )
            continue;
 
        bbox.Merge( point->GetBoundingBox() );
    }
 
    return bbox;
}
 
 
SHAPE_POLY_SET FOOTPRINT::GetBoundingHull() const
{
    const BOARD* board = GetBoard();
    bool         isFPEdit = board && board->IsFootprintHolder();
 
    if( board )
    {
        std::lock_guard<std::mutex> lock( m_geometry_cache_mutex );
 
        if( m_geometry_cache && m_geometry_cache->hull_timestamp >= board->GetTimeStamp() )
            return m_geometry_cache->hull;
    }
 
    SHAPE_POLY_SET rawPolys;
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( !isFPEdit && m_privateLayers.test( item->GetLayer() ) )
            continue;
 
        if( item->Type() != PCB_FIELD_T && item->Type() != PCB_REFERENCE_IMAGE_T )
            item->TransformShapeToPolygon( rawPolys, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 
        // We intentionally exclude footprint fields from the bounding hull.
    }
 
    for( PAD* pad : m_pads )
    {
        pad->Padstack().ForEachUniqueLayer(
                [&]( PCB_LAYER_ID aLayer )
                {
                    pad->TransformShapeToPolygon( rawPolys, aLayer, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
                } );
 
        // In case hole is larger than pad
        pad->TransformHoleToPolygon( rawPolys, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
    }
 
    for( ZONE* zone : m_zones )
    {
        for( PCB_LAYER_ID layer : zone->GetLayerSet() )
        {
            const SHAPE_POLY_SET& layerPoly = *zone->GetFilledPolysList( layer );
 
            for( int ii = 0; ii < layerPoly.OutlineCount(); ii++ )
            {
                const SHAPE_LINE_CHAIN& poly = layerPoly.COutline( ii );
                rawPolys.AddOutline( poly );
            }
        }
    }
 
    // If there are some graphic items, build the actual hull.
    // However if no items, create a minimal polygon (can happen if a footprint
    // is created with no item: it contains only 2 texts.
    if( rawPolys.OutlineCount() == 0 || rawPolys.FullPointCount() < 3 )
    {
        // generate a small dummy rectangular outline around the anchor
        const int halfsize = pcbIUScale.mmToIU( 1.0 );
 
        rawPolys.NewOutline();
 
        // add a square:
        rawPolys.Append( GetPosition().x - halfsize,  GetPosition().y - halfsize );
        rawPolys.Append( GetPosition().x + halfsize,  GetPosition().y - halfsize );
        rawPolys.Append( GetPosition().x + halfsize,  GetPosition().y + halfsize );
        rawPolys.Append( GetPosition().x - halfsize,  GetPosition().y + halfsize );
    }
 
    std::vector<VECTOR2I> convex_hull;
    BuildConvexHull( convex_hull, rawPolys );
 
    {
        std::lock_guard<std::mutex> lock( m_geometry_cache_mutex );
 
        if( !m_geometry_cache )
            m_geometry_cache = std::make_unique<FOOTPRINT_GEOMETRY_CACHE_DATA>();
 
        m_geometry_cache->hull.RemoveAllContours();
        m_geometry_cache->hull.NewOutline();
 
        for( const VECTOR2I& pt : convex_hull )
            m_geometry_cache->hull.Append( pt );
 
        if( board )
            m_geometry_cache->hull_timestamp = board->GetTimeStamp();
 
        return m_geometry_cache->hull;
    }
}
 
 
SHAPE_POLY_SET FOOTPRINT::GetBoundingHull( PCB_LAYER_ID aLayer ) const
{
    const BOARD* board = GetBoard();
    bool         isFPEdit = board && board->IsFootprintHolder();
 
    SHAPE_POLY_SET rawPolys;
    SHAPE_POLY_SET hull;
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( !isFPEdit && m_privateLayers.test( item->GetLayer() ) )
            continue;
 
        if( item->IsOnLayer( aLayer ) )
        {
            if( item->Type() != PCB_FIELD_T && item->Type() != PCB_REFERENCE_IMAGE_T )
                item->TransformShapeToPolygon( rawPolys, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 
            // We intentionally exclude footprint fields from the bounding hull.
        }
    }
 
    for( PAD* pad : m_pads )
    {
        if( pad->IsOnLayer( aLayer ) )
            pad->TransformShapeToPolygon( rawPolys, aLayer, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
    }
 
    for( ZONE* zone : m_zones )
    {
        if( zone->GetIsRuleArea() )
            continue;
 
        if( zone->IsOnLayer( aLayer ) )
        {
            const std::shared_ptr<SHAPE_POLY_SET>& layerPoly = zone->GetFilledPolysList( aLayer );
 
            for( int ii = 0; ii < layerPoly->OutlineCount(); ii++ )
                rawPolys.AddOutline( layerPoly->COutline( ii ) );
        }
    }
 
    std::vector<VECTOR2I> convex_hull;
    BuildConvexHull( convex_hull, rawPolys );
 
    hull.NewOutline();
 
    for( const VECTOR2I& pt : convex_hull )
        hull.Append( pt );
 
    return hull;
}
 
 
void FOOTPRINT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
{
    wxString msg, msg2;
    wxString variant;
 
    if( BOARD* board = GetBoard() )
        variant = board->GetCurrentVariant();
 
    // Don't use GetShownText(); we want to see the variable references here
    aList.emplace_back( UnescapeString( Reference().GetText() ),
                        UnescapeString( GetFieldValueForVariant( variant, GetDefaultFieldName( FIELD_T::VALUE,
                                                                                               UNTRANSLATED ) ) ) );
 
    if( aFrame->IsType( FRAME_FOOTPRINT_VIEWER )
        || aFrame->IsType( FRAME_FOOTPRINT_CHOOSER )
        || aFrame->IsType( FRAME_FOOTPRINT_EDITOR ) )
    {
        aList.emplace_back( _( "Library" ), GetFPID().GetLibNickname().wx_str() );
 
        aList.emplace_back( _( "Footprint Name" ), GetFPID().GetLibItemName().wx_str() );
 
        aList.emplace_back( _( "Pads" ), wxString::Format( wxT( "%u" ), GetNumberedPadCount() ) );
 
        aList.emplace_back( wxString::Format( _( "Doc: %s" ), GetLibDescription() ),
                            wxString::Format( _( "Keywords: %s" ), GetKeywords() ) );
 
        return;
    }
 
    // aFrame is the board editor:
 
    switch( GetSide() )
    {
    case F_Cu: aList.emplace_back( _( "Board Side" ), _( "Front" ) );          break;
    case B_Cu: aList.emplace_back( _( "Board Side" ), _( "Back (Flipped)" ) ); break;
    default:   /* unsided: user-layers only, etc. */                           break;
    }
 
    aList.emplace_back( _( "Rotation" ), wxString::Format( wxT( "%.4g" ), GetOrientation().AsDegrees() ) );
 
    auto addToken = []( wxString* aStr, const wxString& aAttr )
                    {
                        if( !aStr->IsEmpty() )
                            *aStr += wxT( ", " );
 
                        *aStr += aAttr;
                    };
 
    wxString status;
    wxString attrs;
 
    if( IsLocked() )
        addToken( &status, _( "Locked" ) );
 
    if( IsPlaced() )
        addToken( &status, _( "autoplaced" ) );
 
    if( IsBoardOnly() )
        addToken( &attrs, _( "not in schematic" ) );
 
    if( GetExcludedFromPosFilesForVariant( variant ) )
        addToken( &attrs, _( "exclude from pos files" ) );
 
    if( GetExcludedFromBOMForVariant( variant ) )
        addToken( &attrs, _( "exclude from BOM" ) );
 
    if( GetExcludedFromSimForVariant( variant ) )
        addToken( &attrs, _( "exclude from simulation" ) );
 
    if( GetDNPForVariant( variant ) )
        addToken( &attrs, _( "DNP" ) );
 
    aList.emplace_back( _( "Status: " ) + status, _( "Attributes:" ) + wxS( " " ) + attrs );
 
    if( !m_componentClassCacheProxy->GetComponentClass()->IsEmpty() )
    {
        aList.emplace_back( _( "Component Class" ),
                            m_componentClassCacheProxy->GetComponentClass()->GetHumanReadableName() );
    }
 
    msg.Printf( _( "Footprint: %s" ), m_fpid.GetUniStringLibId() );
    msg2.Printf( _( "3D-Shape: %s" ), m_3D_Drawings.empty() ? _( "<none>" ) : m_3D_Drawings.front().m_Filename );
    aList.emplace_back( msg, msg2 );
 
    msg.Printf( _( "Doc: %s" ), m_libDescription );
    msg2.Printf( _( "Keywords: %s" ), m_keywords );
    aList.emplace_back( msg, msg2 );
}
 
 
PCB_LAYER_ID FOOTPRINT::GetSide() const
{
    if( const BOARD* board = GetBoard() )
    {
        if( board->IsFootprintHolder() )
            return UNDEFINED_LAYER;
    }
 
    // Test pads first; they're the most likely to return a quick answer.
    for( PAD* pad : m_pads )
    {
        if( ( LSET::SideSpecificMask() & pad->GetLayerSet() ).any() )
            return GetLayer();
    }
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( IsValidLayer( item->GetLayer() ) && LSET::SideSpecificMask().test( item->GetLayer() ) )
            return GetLayer();
    }
 
    for( ZONE* zone : m_zones )
    {
        if( ( LSET::SideSpecificMask() & zone->GetLayerSet() ).any() )
            return GetLayer();
    }
 
    return UNDEFINED_LAYER;
}
 
 
bool FOOTPRINT::IsOnLayer( PCB_LAYER_ID aLayer ) const
{
    auto isOnLayer =
            [aLayer]( const BOARD_ITEM* aItem )
            {
                return aItem->IsOnLayer( aLayer );
            };
 
    return std::ranges::any_of( m_pads, isOnLayer )
           || std::ranges::any_of( m_zones, isOnLayer )
           || std::ranges::any_of( m_fields, isOnLayer )
           || std::ranges::any_of( m_drawings, isOnLayer );
}
 
 
bool FOOTPRINT::HitTestOnLayer( const VECTOR2I& aPosition, PCB_LAYER_ID aLayer, int aAccuracy ) const
{
    for( PAD* pad : m_pads )
    {
        if( pad->IsOnLayer( aLayer ) && pad->HitTest( aPosition, aAccuracy ) )
            return true;
    }
 
    for( ZONE* zone : m_zones )
    {
        if( zone->IsOnLayer( aLayer ) && zone->HitTest( aPosition, aAccuracy ) )
            return true;
    }
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->Type() != PCB_TEXT_T && item->IsOnLayer( aLayer )
            && item->HitTest( aPosition, aAccuracy ) )
        {
            return true;
        }
    }
 
    return false;
}
 
 
bool FOOTPRINT::HitTestOnLayer( const BOX2I& aRect, bool aContained, PCB_LAYER_ID aLayer, int aAccuracy ) const
{
    std::vector<BOARD_ITEM*> items;
 
    for( PAD* pad : m_pads )
    {
        if( pad->IsOnLayer( aLayer ) )
            items.push_back( pad );
    }
 
    for( ZONE* zone : m_zones )
    {
        if( zone->IsOnLayer( aLayer ) )
            items.push_back( zone );
    }
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->Type() != PCB_TEXT_T && item->IsOnLayer( aLayer ) )
            items.push_back( item );
    }
 
    // If we require the elements to be contained in the rect and any of them are not,
    // we can return false;
    // Conversely, if we just require any of the elements to have a hit, we can return true
    // when the first one is found.
    for( BOARD_ITEM* item : items )
    {
        if( !aContained && item->HitTest( aRect, aContained, aAccuracy ) )
            return true;
        else if( aContained && !item->HitTest( aRect, aContained, aAccuracy ) )
            return false;
    }
 
    // If we didn't exit in the loop, that means that we did not return false for aContained or
    // we did not return true for !aContained.  So we can just return the bool with a test of
    // whether there were any elements or not.
    return !items.empty() && aContained;
}
 
 
bool FOOTPRINT::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
{
    BOX2I rect = GetBoundingBox( false );
    return rect.Inflate( aAccuracy ).Contains( aPosition );
}
 
 
bool FOOTPRINT::HitTestAccurate( const VECTOR2I& aPosition, int aAccuracy ) const
{
    return GetBoundingHull().Collide( aPosition, aAccuracy );
}
 
 
bool FOOTPRINT::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
{
    BOX2I arect = aRect;
    arect.Inflate( aAccuracy );
 
    if( aContained )
    {
        return arect.Contains( GetBoundingBox( false ) );
    }
    else
    {
        // If the rect does not intersect the bounding box, skip any tests
        if( !arect.Intersects( GetBoundingBox( false ) ) )
            return false;
 
        // If there are no pads, zones, or drawings, allow intersection with text
        if( m_pads.empty() && m_zones.empty() && m_drawings.empty() )
            return GetBoundingBox( true ).Intersects( arect );
 
        // Determine if any elements in the FOOTPRINT intersect the rect
        for( PAD* pad : m_pads )
        {
            if( pad->HitTest( arect, false, 0 ) )
                return true;
        }
 
        for( ZONE* zone : m_zones )
        {
            if( zone->HitTest( arect, false, 0 ) )
                return true;
        }
 
        for( PCB_POINT* point : m_points )
        {
            if( point->HitTest( arect, false, 0 ) )
                return true;
        }
 
        // PCB fields are selectable on their own, so they don't get tested
 
        for( BOARD_ITEM* item : m_drawings )
        {
            // Text items are selectable on their own, and are therefore excluded from this
            // test.  TextBox items are NOT selectable on their own, and so MUST be included
            // here. Bitmaps aren't selectable since they aren't displayed.
            if( item->Type() != PCB_TEXT_T && item->HitTest( arect, false, 0 ) )
                return true;
        }
 
        // Groups are not hit-tested; only their members
 
        // No items were hit
        return false;
    }
}
 
 
bool FOOTPRINT::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
{
    using std::ranges::all_of;
    using std::ranges::any_of;
 
    // If there are no pads, zones, or drawings, test footprint text instead.
    if( m_pads.empty() && m_zones.empty() && m_drawings.empty() )
        return KIGEOM::BoxHitTest( aPoly, GetBoundingBox( true ), aContained );
 
    auto hitTest =
            [&]( const auto* aItem )
            {
                return aItem && aItem->HitTest( aPoly, aContained );
            };
 
    // Filter out text items from the drawings, since they are selectable on their own,
    // and we don't want to select the whole footprint when text is hit. TextBox items are NOT
    // selectable on their own, so they are not excluded here.
    auto drawings = m_drawings | std::views::filter( []( const auto* aItem )
                                                     {
                                                         return aItem && aItem->Type() != PCB_TEXT_T;
                                                     } );
 
    // Test pads, zones and drawings with text excluded. PCB fields are also selectable
    // on their own, so they don't get tested. Groups are not hit-tested, only their members.
    // Bitmaps aren't selectable since they aren't displayed.
    if( aContained )
    {
        // All items must be contained in the selection poly.
        return all_of( drawings, hitTest )
            && all_of( m_pads,   hitTest )
            && all_of( m_zones,  hitTest );
    }
    else
    {
        // Any item intersecting the selection poly is sufficient.
        return any_of( drawings, hitTest )
            || any_of( m_pads,   hitTest )
            || any_of( m_zones,  hitTest );
    }
}
 
 
PAD* FOOTPRINT::FindPadByNumber( const wxString& aPadNumber, PAD* aSearchAfterMe ) const
{
    bool can_select = aSearchAfterMe ? false : true;
 
    for( PAD* pad : m_pads )
    {
        if( !can_select && pad == aSearchAfterMe )
        {
            can_select = true;
            continue;
        }
 
        if( can_select && pad->GetNumber() == aPadNumber )
            return pad;
    }
 
    return nullptr;
}
 
 
PAD* FOOTPRINT::FindPadByUuid( const KIID& aUuid ) const
{
    for( PAD* pad : m_pads )
    {
        if( pad->m_Uuid == aUuid )
            return pad;
    }
 
    return nullptr;
}
 
 
PAD* FOOTPRINT::GetPad( const VECTOR2I& aPosition, const LSET& aLayerMask )
{
    for( PAD* pad : m_pads )
    {
        // ... and on the correct layer.
        if( !( pad->GetLayerSet() & aLayerMask ).any() )
            continue;
 
        if( pad->HitTest( aPosition ) )
            return pad;
    }
 
    return nullptr;
}
 
 
std::vector<const PAD*> FOOTPRINT::GetPads( const wxString& aPadNumber, const PAD* aIgnore ) const
{
    std::vector<const PAD*> retv;
 
    for( const PAD* pad : m_pads )
    {
        if( ( aIgnore && aIgnore == pad ) || ( pad->GetNumber() != aPadNumber ) )
            continue;
 
        retv.push_back( pad );
    }
 
    return retv;
}
 
 
unsigned FOOTPRINT::GetPadCount() const
{
    return m_pads.size();
}
 
 
std::set<wxString> FOOTPRINT::GetUniquePadNumbers() const
{
    std::set<wxString> usedNumbers;
 
    // Create a set of used pad numbers
    for( PAD* pad : m_pads )
    {
        // Skip pads not on copper layers (used to build complex
        // solder paste shapes for instance)
        if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none() )
            continue;
 
        // Skip pads with no name, because they are usually "mechanical"
        // pads, not "electrical" pads
        if( pad->GetNumber().IsEmpty() )
            continue;
 
        usedNumbers.insert( pad->GetNumber() );
    }
 
    return usedNumbers;
}
 
 
unsigned FOOTPRINT::GetNumberedPadCount() const
{
    // A pad number is "electrical" (i.e. maps to a schematic pin) when it is either:
    //
    //   - purely numeric:           "1", "42"
    //
    //   - BGA / alphanumeric style: up to two leading letters followed by digits, e.g.
    //                               "A1", "B12", "AA3", "AB10"
    //
    //   - ganged alphanumeric:      two strings matching the above alphanumeric style
    //                               separated by an underscore, as used on the outside
    //                               ganged pins of a USB-C connector, e.g.
    //                               "A1_B12", "A12_B1"
    //                               these pads count as two each, as they will match
    //                               two schematic pins
    //
    // Mounting-pad designators such as "MP" do not end in a digit typically and are
    // intentionally excluded.
    auto isElectricalPadNumber =
            []( const wxString& num ) -> bool
            {
                if( num.IsEmpty() )
                    return false;
 
                // Walk past an optional alphabetic prefix of at most two characters.
                size_t i = 0;
                while( i < num.size() && wxIsalpha( num[i] ) )
                    ++i;
 
                // Prefix must be 0–2 letters; anything longer is not a pin number.
                if( i > 2 )
                    return false;
 
                // The remainder must be non-empty and consist entirely of digits.
                if( i == num.size() )
                    return false;   // no digits at all (e.g. "MP", "GND")
 
                for( size_t j = i; j < num.size(); ++j )
                {
                    if( !wxIsdigit( num[j] ) )
                        return false;
                }
 
                return true;
            };
 
    std::set<wxString> counted;
 
    for( const PAD* pad : m_pads )
    {
        // Must be on at least one copper layer.
        if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none() )
            continue;
 
        // Skip NPTH (mechanical holes).
        if( pad->GetAttribute() == PAD_ATTRIB::NPTH )
            continue;
 
        const wxString& num = pad->GetNumber();
 
        if( isElectricalPadNumber( num ) )
        {
            counted.insert( num );
        }
        else if( num.Contains( '_' ) )
        {
            wxString first, second;
            first = num.BeforeFirst( '_', &second );
 
            if( isElectricalPadNumber( first ) && isElectricalPadNumber( second ) )
            {
                counted.insert( first );
                counted.insert( second );
            }
        }
    }
 
    return static_cast<unsigned>( counted.size() );
}
 
 
void FOOTPRINT::Add3DModel( FP_3DMODEL* a3DModel )
{
    if( nullptr == a3DModel )
        return;
 
    if( !a3DModel->m_Filename.empty() )
        m_3D_Drawings.push_back( *a3DModel );
}
 
 
EXTRUDED_3D_BODY& FOOTPRINT::EnsureExtrudedBody()
{
    if( !m_extrudedBody )
        m_extrudedBody = std::make_unique<EXTRUDED_3D_BODY>();
 
    return *m_extrudedBody;
}
 
 
void FOOTPRINT::SetExtrudedBody( std::unique_ptr<EXTRUDED_3D_BODY> aBody )
{
    m_extrudedBody = std::move( aBody );
}
 
 
bool FOOTPRINT::Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
{
    if( aSearchData.searchMetadata )
    {
        if( EDA_ITEM::Matches( GetFPIDAsString(), aSearchData ) )
            return true;
 
        if( EDA_ITEM::Matches( GetLibDescription(), aSearchData ) )
            return true;
 
        if( EDA_ITEM::Matches( GetKeywords(), aSearchData ) )
            return true;
    }
 
    return false;
}
 
 
// see footprint.h
INSPECT_RESULT FOOTPRINT::Visit( INSPECTOR inspector, void* testData,
                                 const std::vector<KICAD_T>& aScanTypes )
{
#if 0 && defined(DEBUG)
    std::cout << GetClass().mb_str() << ' ';
#endif
 
    bool drawingsScanned = false;
 
    for( KICAD_T scanType : aScanTypes )
    {
        switch( scanType )
        {
        case PCB_FOOTPRINT_T:
            if( inspector( this, testData ) == INSPECT_RESULT::QUIT )
                return INSPECT_RESULT::QUIT;
 
            break;
 
        case PCB_PAD_T:
            if( IterateForward<PAD*>( m_pads, inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
                return INSPECT_RESULT::QUIT;
 
            break;
 
        case PCB_ZONE_T:
            if( IterateForward<ZONE*>( m_zones, inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
                return INSPECT_RESULT::QUIT;
 
            break;
 
        case PCB_FIELD_T:
            if( IterateForward<PCB_FIELD*>( m_fields, inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
                return INSPECT_RESULT::QUIT;
 
            break;
 
        case PCB_TEXT_T:
        case PCB_DIM_ALIGNED_T:
        case PCB_DIM_LEADER_T:
        case PCB_DIM_CENTER_T:
        case PCB_DIM_RADIAL_T:
        case PCB_DIM_ORTHOGONAL_T:
        case PCB_SHAPE_T:
        case PCB_BARCODE_T:
        case PCB_TEXTBOX_T:
        case PCB_TABLE_T:
        case PCB_TABLECELL_T:
            if( !drawingsScanned )
            {
                if( IterateForward<BOARD_ITEM*>( m_drawings, inspector, testData, aScanTypes ) == INSPECT_RESULT::QUIT )
                    return INSPECT_RESULT::QUIT;
 
                drawingsScanned = true;
            }
 
            break;
 
        case PCB_GROUP_T:
            if( IterateForward<PCB_GROUP*>( m_groups, inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
                return INSPECT_RESULT::QUIT;
 
            break;
 
        case PCB_CONSTRAINT_T:
            if( IterateForward<PCB_CONSTRAINT*>( m_constraints, inspector, testData, { scanType } )
                    == INSPECT_RESULT::QUIT )
            {
                return INSPECT_RESULT::QUIT;
            }
 
            break;
 
        case PCB_POINT_T:
            if( IterateForward<PCB_POINT*>( m_points, inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
                return INSPECT_RESULT::QUIT;
 
            break;
 
        default:
            break;
        }
    }
 
    return INSPECT_RESULT::CONTINUE;
}
 
 
wxString FOOTPRINT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
{
    wxString reference = GetReference();
 
    if( reference.IsEmpty() )
        reference = _( "<no reference designator>" );
 
    return wxString::Format( _( "Footprint %s" ), reference );
}
 
 
wxString FOOTPRINT::DisambiguateItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
{
    return wxString::Format( wxT( "%s (%s)" ),
                             GetItemDescription( aUnitsProvider, aFull ),
                             GetFPIDAsString() );
}
 
 
BITMAPS FOOTPRINT::GetMenuImage() const
{
    return BITMAPS::module;
}
 
 
EDA_ITEM* FOOTPRINT::Clone() const
{
    return new FOOTPRINT( *this );
}
 
 
void FOOTPRINT::RunOnChildren( const std::function<void( BOARD_ITEM* )>& aFunction, RECURSE_MODE aMode ) const
{
    try
    {
        for( PCB_FIELD* field : m_fields )
            aFunction( field );
 
        for( PAD* pad : m_pads )
            aFunction( pad );
 
        for( ZONE* zone : m_zones )
            aFunction( zone  );
 
        for( PCB_GROUP* group : m_groups )
            aFunction( group );
 
        for( PCB_CONSTRAINT* constraint : m_constraints )
            aFunction( constraint );
 
        for( PCB_POINT* point : m_points )
            aFunction( point );
 
        for( BOARD_ITEM* drawing : m_drawings )
        {
            aFunction( drawing );
 
            if( aMode == RECURSE_MODE::RECURSE )
                drawing->RunOnChildren( aFunction, RECURSE_MODE::RECURSE );
        }
    }
    catch( std::bad_function_call& )
    {
        wxFAIL_MSG( wxT( "Error running FOOTPRINT::RunOnChildren" ) );
    }
}
 
 
std::vector<int> FOOTPRINT::ViewGetLayers() const
{
    std::vector<int> layers;
 
    layers.reserve( 6 );
    layers.push_back( LAYER_ANCHOR );
 
    switch( m_layer )
    {
    default:
        wxASSERT_MSG( false, wxT( "Illegal layer" ) );   // do you really have footprints placed
                                                         // on other layers?
        KI_FALLTHROUGH;
 
    case F_Cu:
        layers.push_back( LAYER_FOOTPRINTS_FR );
        break;
 
    case B_Cu:
        layers.push_back( LAYER_FOOTPRINTS_BK );
        break;
    }
 
    layers.push_back( LAYER_CONFLICTS_SHADOW );
 
    // If there are no pads, and only drawings on a silkscreen layer, then report the silkscreen
    // layer as well so that the component can be edited with the silkscreen layer
    bool f_silk = false, b_silk = false, non_silk = false;
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->GetLayer() == F_SilkS )
            f_silk = true;
        else if( item->GetLayer() == B_SilkS )
            b_silk = true;
        else
            non_silk = true;
    }
 
    if( ( f_silk || b_silk ) && !non_silk && m_pads.empty() )
    {
        if( f_silk )
            layers.push_back( F_SilkS );
 
        if( b_silk )
            layers.push_back( B_SilkS );
    }
 
    return layers;
}
 
 
double FOOTPRINT::ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const
{
    if( aLayer == LAYER_CONFLICTS_SHADOW && IsConflicting() )
    {
        // The locked shadow shape is shown only if the footprint itself is visible
        if( ( m_layer == F_Cu ) && aView->IsLayerVisible( LAYER_FOOTPRINTS_FR ) )
            return LOD_SHOW;
 
        if( ( m_layer == B_Cu ) && aView->IsLayerVisible( LAYER_FOOTPRINTS_BK ) )
            return LOD_SHOW;
 
        return LOD_HIDE;
    }
 
    // Only show anchors if the layer the footprint is on is visible
    if( aLayer == LAYER_ANCHOR && !aView->IsLayerVisible( m_layer ) )
        return LOD_HIDE;
 
    int layer = ( m_layer == F_Cu ) ? LAYER_FOOTPRINTS_FR :
                ( m_layer == B_Cu ) ? LAYER_FOOTPRINTS_BK : LAYER_ANCHOR;
 
    // Currently this is only pertinent for the anchor layer; everything else is drawn from the
    // children.
    // The "good" value is experimentally chosen.
    constexpr double MINIMAL_ZOOM_LEVEL_FOR_VISIBILITY = 1.5;
 
    if( aView->IsLayerVisible( layer ) )
        return MINIMAL_ZOOM_LEVEL_FOR_VISIBILITY;
 
    return LOD_HIDE;
}
 
 
const BOX2I FOOTPRINT::ViewBBox() const
{
    BOX2I area = GetBoundingBox( true );
 
    // Inflate in case clearance lines are drawn around pads, etc.
    if( const BOARD* board = GetBoard() )
    {
        int biggest_clearance = board->GetMaxClearanceValue();
        area.Inflate( biggest_clearance );
    }
 
    return area;
}
 
 
bool FOOTPRINT::IsLibNameValid( const wxString & aName )
{
    const wxChar * invalids = StringLibNameInvalidChars( false );
 
    if( aName.find_first_of( invalids ) != std::string::npos )
        return false;
 
    return true;
}
 
 
const wxChar* FOOTPRINT::StringLibNameInvalidChars( bool aUserReadable )
{
    // Filename rules are a superset of LIB_ID rules; the machine-readable list is the shared
    // source of truth, while the human-readable spelling stays local.
    static const wxString invalidChars = GetLibFilenameForbiddenChars();
    static const wxChar invalidCharsReadable[] = wxT("% $ < > 'tab' 'return' 'line feed' \\ \" / :");
 
    if( aUserReadable )
        return invalidCharsReadable;
    else
        return invalidChars.wc_str();
}
 
 
void FOOTPRINT::Move( const VECTOR2I& aMoveVector )
{
    if( aMoveVector.x == 0 && aMoveVector.y == 0 )
        return;
 
    VECTOR2I newpos = m_transform.GetTranslate() + aMoveVector;
    SetPosition( newpos );
}
 
 
void FOOTPRINT::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
{
    if( aAngle == ANGLE_0 )
        return;
 
    EDA_ANGLE orientation = GetOrientation();
    EDA_ANGLE newOrientation = orientation + aAngle;
    VECTOR2I  newpos = m_transform.GetTranslate();
    RotatePoint( newpos, aRotCentre, aAngle );
    SetPosition( newpos );
    SetOrientation( newOrientation );
 
    for( PCB_FIELD* field : m_fields )
        field->KeepUpright();
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->Type() == PCB_TEXT_T )
            static_cast<PCB_TEXT*>( item )->KeepUpright();
    }
}
 
 
void FOOTPRINT::SetLayerAndFlip( PCB_LAYER_ID aLayer )
{
    wxASSERT( aLayer == F_Cu || aLayer == B_Cu );
 
    if( aLayer != GetLayer() )
        Flip( GetPosition(), FLIP_DIRECTION::LEFT_RIGHT );
}
 
 
void FOOTPRINT::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
{
    // Move footprint to its final position:
    VECTOR2I finalPos = m_transform.GetTranslate();
 
    // Now Flip the footprint.
    // Flipping a footprint is a specific transform: it is not mirrored like a text.
    // We have to change the side, and ensure the footprint rotation is modified according to the
    // transform, because this parameter is used in pick and place files, and when updating the
    // footprint from library.
    // When flipped around the X axis (Y coordinates changed) orientation is negated
    // When flipped around the Y axis (X coordinates changed) orientation is 180 - old orient.
    // Because it is specific to a footprint, we flip around the X axis, and after rotate 180 deg
 
    MIRROR( finalPos.y, aCentre.y );     
 
    SetPosition( finalPos );
 
    // Flip layer
    BOARD_ITEM::SetLayer( GetBoard() ? GetBoard()->FlipLayer( GetLayer() ) : FlipLayer( GetLayer() ) );
 
    const VECTOR2I pos = m_transform.GetTranslate();
 
    // Children mirror their lib-frame state directly so the result does not
    // depend on the parent rotation at the time of the call. The parent
    // rotation is negated once at the end.
    for( PCB_FIELD* field : m_fields )
        field->Flip( pos, FLIP_DIRECTION::TOP_BOTTOM );
 
    for( PAD* pad : m_pads )
        pad->Flip( pos, FLIP_DIRECTION::TOP_BOTTOM );
 
    for( ZONE* zone : m_zones )
        zone->Flip( pos, FLIP_DIRECTION::TOP_BOTTOM );
 
    for( BOARD_ITEM* item : m_drawings )
        item->Flip( pos, FLIP_DIRECTION::TOP_BOTTOM );
 
    // Points move but don't flip layer
    for( PCB_POINT* point : m_points )
        point->Flip( pos, FLIP_DIRECTION::TOP_BOTTOM );
 
    EDA_ANGLE newOrientation = -m_transform.GetRotate();
    newOrientation.Normalize180();
    m_transform.SetRotate( newOrientation );
 
    // Refresh derived caches now that the final rotation is in place.
    for( PCB_FIELD* field : m_fields )
        field->OnFootprintTransformed();
 
    for( PAD* pad : m_pads )
        pad->OnFootprintTransformed();
 
    for( ZONE* zone : m_zones )
        zone->OnFootprintTransformed();
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->Type() == PCB_TEXT_T || item->Type() == PCB_SHAPE_T || item->Type() == PCB_TEXTBOX_T
            || item->Type() == PCB_BARCODE_T || item->Type() == PCB_TABLE_T
            || BaseType( item->Type() ) == PCB_DIMENSION_T )
        {
            item->OnFootprintTransformed();
        }
    }
 
    for( PCB_POINT* point : m_points )
        point->OnFootprintTransformed();
 
    // Swap the courtyard sides, then mirror in the same way as everything else.
    if( m_courtyard_cache )
    {
        std::swap( m_courtyard_cache->back, m_courtyard_cache->front );
        m_courtyard_cache->back.Mirror( pos, FLIP_DIRECTION::TOP_BOTTOM );
        m_courtyard_cache->back_hash = m_courtyard_cache->back.GetHash();
 
        m_courtyard_cache->front.Mirror( pos, FLIP_DIRECTION::TOP_BOTTOM );
        m_courtyard_cache->front_hash = m_courtyard_cache->front.GetHash();
    }
 
    // Flip the extrusion source layer to match the new side.
    if( m_extrudedBody && m_extrudedBody->m_layer != UNDEFINED_LAYER )
        m_extrudedBody->m_layer = GetBoard()->FlipLayer( m_extrudedBody->m_layer );
 
    if( m_geometry_cache )
        m_geometry_cache->hull.Mirror( pos, FLIP_DIRECTION::TOP_BOTTOM );
 
    // Now rotate 180 deg if required
    if( aFlipDirection == FLIP_DIRECTION::LEFT_RIGHT )
        Rotate( aCentre, ANGLE_180 );
 
    if( m_geometry_cache )
        m_geometry_cache->text_excluded_bbox_timestamp = 0;
 
    m_flipped = ( GetLayer() == B_Cu );
}
 
 
void FOOTPRINT::SetLayer( PCB_LAYER_ID aLayer )
{
    BOARD_ITEM::SetLayer( aLayer );
    m_flipped = ( aLayer == B_Cu );
}
 
 
void FOOTPRINT::SetTransformScale( double aScaleX, double aScaleY )
{
    // Reject zero, negative, and non-finite scales: they produce a degenerate transform.
    if( !std::isfinite( aScaleX ) || !std::isfinite( aScaleY ) || aScaleX <= 0.0 || aScaleY <= 0.0 )
        return;
 
    const double oldSx = m_transform.GetScaleX();
    const double oldSy = m_transform.GetScaleY();
    const double ratioX = aScaleX / oldSx;
    const double ratioY = aScaleY / oldSy;
    const double linearFactor = ( aScaleX + aScaleY ) / ( oldSx + oldSy );
 
    m_transform.SetScale( aScaleX, aScaleY );
 
    const VECTOR2I  anchor = m_transform.GetTranslate();
    const EDA_ANGLE parentRotate = m_transform.GetRotate();
 
    for( PAD* pad : m_pads )
        pad->OnFootprintRescaled( ratioX, ratioY, linearFactor, anchor, parentRotate );
 
    for( PCB_FIELD* field : m_fields )
        field->OnFootprintRescaled( ratioX, ratioY, linearFactor, anchor, parentRotate );
 
    for( BOARD_ITEM* item : m_drawings )
        item->OnFootprintRescaled( ratioX, ratioY, linearFactor, anchor, parentRotate );
 
    for( ZONE* zone : m_zones )
        zone->OnFootprintRescaled( ratioX, ratioY, linearFactor, anchor, parentRotate );
 
    for( PCB_POINT* point : m_points )
        point->OnFootprintTransformed();
 
    if( m_geometry_cache )
    {
        m_geometry_cache->bounding_box_timestamp = 0;
        m_geometry_cache->text_excluded_bbox_timestamp = 0;
    }
 
    m_courtyard_cache.reset();
}
 
 
void FOOTPRINT::RescaleAroundPoint( const VECTOR2I& aCenter, double aSx, double aSy )
{
    TRANSFORM_TRS rescaled = m_transform.RescaleAround( aCenter, aSx, aSy );
 
    SetPosition( rescaled.GetTranslate() );
    SetTransformScale( rescaled.GetScaleX(), rescaled.GetScaleY() );
}
 
 
void FOOTPRINT::SetPosition( const VECTOR2I& aPos )
{
    VECTOR2I delta = aPos - m_transform.GetTranslate();
 
    m_transform.SetTranslate( aPos );
 
    for( PCB_FIELD* field : m_fields )
        field->OnFootprintTransformed();
 
    for( PAD* pad : m_pads )
        pad->OnFootprintTransformed();
 
    for( ZONE* zone : m_zones )
        zone->OnFootprintTransformed();
 
    for( PCB_POINT* point : m_points )
        point->OnFootprintTransformed();
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->Type() == PCB_TEXT_T || item->Type() == PCB_SHAPE_T || item->Type() == PCB_TEXTBOX_T
            || item->Type() == PCB_BARCODE_T || item->Type() == PCB_TABLE_T
            || BaseType( item->Type() ) == PCB_DIMENSION_T )
        {
            item->OnFootprintTransformed();
        }
        else
        {
            item->Move( delta );
        }
    }
 
    if( m_geometry_cache )
    {
        m_geometry_cache->bounding_box.Move( delta );
        m_geometry_cache->text_excluded_bbox.Move( delta );
        m_geometry_cache->hull.Move( delta );
    }
 
    // The geometry work has been conserved by using Move(). But the hashes
    // need to be updated, otherwise the cached polygons will still be rebuild.
    if( m_courtyard_cache )
    {
        m_courtyard_cache->back.Move( delta );
        m_courtyard_cache->back_hash = m_courtyard_cache->back.GetHash();
        m_courtyard_cache->front.Move( delta );
        m_courtyard_cache->front_hash = m_courtyard_cache->front.GetHash();
    }
}
 
 
void FOOTPRINT::MoveAnchorPosition( const VECTOR2I& aMoveVector )
{
    /*
     * Move the reference point of the footprint
     * the footprints elements (pads, outlines, edges .. ) are moved
     * but:
     * - the footprint position is not modified.
     * - the relative (local) coordinates of these items are modified
     * - Draw coordinates are updated
     */
 
    // Update (move) the relative coordinates relative to the new anchor point.
    VECTOR2I moveVector = aMoveVector;
    RotatePoint( moveVector, -GetOrientation() );
 
    // Update field local coordinates
    for( PCB_FIELD* field : m_fields )
        field->Move( moveVector );
 
    // Update the pad local coordinates.
    for( PAD* pad : m_pads )
        pad->Move( moveVector );
 
    // Update the draw element coordinates.
    for( BOARD_ITEM* item : GraphicalItems() )
        item->Move( moveVector );
 
    // Update the keepout zones
    for( ZONE* zone : Zones() )
        zone->Move( moveVector );
 
    // Update the point local coordinates.
    for( PCB_POINT* point : m_points )
        point->Move( moveVector );
 
    // Update the 3D models
    for( FP_3DMODEL& model : Models() )
    {
        model.m_Offset.x += pcbIUScale.IUTomm( moveVector.x );
        model.m_Offset.y -= pcbIUScale.IUTomm( moveVector.y );
    }
 
    if( m_geometry_cache )
    {
        m_geometry_cache->bounding_box.Move( moveVector );
        m_geometry_cache->text_excluded_bbox.Move( moveVector );
        m_geometry_cache->hull.Move( moveVector );
    }
 
    // The geometry work have been conserved by using Move(). But the hashes
    // need to be updated, otherwise the cached polygons will still be rebuild.
    if( m_courtyard_cache )
    {
        m_courtyard_cache->back.Move( moveVector );
        m_courtyard_cache->back_hash = m_courtyard_cache->back.GetHash();
        m_courtyard_cache->front.Move( moveVector );
        m_courtyard_cache->front_hash = m_courtyard_cache->front.GetHash();
    }
}
 
 
void FOOTPRINT::SetOrientation( const EDA_ANGLE& aNewAngle )
{
    EDA_ANGLE angleChange = aNewAngle - m_transform.GetRotate();  // change in rotation
 
    EDA_ANGLE newAngle = aNewAngle;
    newAngle.Normalize180();
    m_transform.SetRotate( newAngle );
 
    const VECTOR2I rotationCenter = GetPosition();
 
    for( PCB_FIELD* field : m_fields )
        field->OnFootprintTransformed();
 
    for( PAD* pad : m_pads )
        pad->OnFootprintTransformed();
 
    for( ZONE* zone : m_zones )
        zone->OnFootprintTransformed();
 
    for( PCB_POINT* point : m_points )
        point->OnFootprintTransformed();
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->Type() == PCB_TEXT_T || item->Type() == PCB_SHAPE_T || item->Type() == PCB_TEXTBOX_T
            || item->Type() == PCB_BARCODE_T || item->Type() == PCB_TABLE_T
            || BaseType( item->Type() ) == PCB_DIMENSION_T )
        {
            item->OnFootprintTransformed();
        }
        else
        {
            item->Rotate( rotationCenter, angleChange );
        }
    }
 
    if( m_geometry_cache )
        m_geometry_cache->text_excluded_bbox_timestamp = 0;
 
    if( m_courtyard_cache )
    {
        m_courtyard_cache->front.Rotate( angleChange, rotationCenter );
        m_courtyard_cache->front_hash = m_courtyard_cache->front.GetHash();
 
        m_courtyard_cache->back.Rotate( angleChange, rotationCenter );
        m_courtyard_cache->back_hash = m_courtyard_cache->back.GetHash();
    }
 
    if( m_geometry_cache )
        m_geometry_cache->hull.Rotate( angleChange, rotationCenter );
}
 
 
BOARD_ITEM* FOOTPRINT::Duplicate( bool addToParentGroup, BOARD_COMMIT* aCommit ) const
{
    FOOTPRINT* dupe = static_cast<FOOTPRINT*>( BOARD_ITEM::Duplicate( addToParentGroup, aCommit ) );
 
    // Clones keep child UUIDs so cloned constraints still resolve to them
    // Map old ids to new before reset else constraints below strand
    std::map<KIID, KIID> idMap;
 
    dupe->RunOnChildren(
            [&]( BOARD_ITEM* child )
            {
                KIID oldId = child->m_Uuid;
                child->ResetUuidDirect();
                idMap[oldId] = child->m_Uuid;
            },
            RECURSE_MODE::RECURSE );
 
    for( PCB_CONSTRAINT* constraint : dupe->Constraints() )
        constraint->RemapKIIDs( idMap );
 
    return dupe;
}
 
 
BOARD_ITEM* FOOTPRINT::DuplicateItem( bool addToParentGroup, BOARD_COMMIT* aCommit,
                                      const BOARD_ITEM* aItem, bool addToFootprint )
{
    BOARD_ITEM* new_item = nullptr;
 
    switch( aItem->Type() )
    {
    case PCB_PAD_T:
    {
        PAD* new_pad = new PAD( *static_cast<const PAD*>( aItem ) );
        new_pad->ResetUuidDirect();
 
        if( addToFootprint )
            m_pads.push_back( new_pad );
 
        new_item = new_pad;
        break;
    }
 
    case PCB_ZONE_T:
    {
        ZONE* new_zone = new ZONE( *static_cast<const ZONE*>( aItem ) );
        new_zone->ResetUuidDirect();
 
        if( addToFootprint )
            m_zones.push_back( new_zone );
 
        new_item = new_zone;
        break;
    }
 
    case PCB_POINT_T:
    {
        PCB_POINT* new_point = new PCB_POINT( *static_cast<const PCB_POINT*>( aItem ) );
        new_point->ResetUuidDirect();
 
        if( addToFootprint )
            m_points.push_back( new_point );
 
        new_item = new_point;
        break;
    }
 
    case PCB_FIELD_T:
    {
        PCB_FIELD* new_field = new PCB_FIELD( *static_cast<const PCB_FIELD*>( aItem ) );
        new_field->ResetUuidDirect();
 
        switch( static_cast<const PCB_FIELD*>( aItem )->GetId() )
        {
        case FIELD_T::REFERENCE: new_field->SetText( wxT( "${REFERENCE}" ) ); break;
        case FIELD_T::VALUE:     new_field->SetText( wxT( "${VALUE}" ) );     break;
        case FIELD_T::DATASHEET: new_field->SetText( wxT( "${DATASHEET}" ) ); break;
        default:                                                              break;
        }
 
        if( addToFootprint )
            Add( new_field );
 
        new_item = new_field;
        break;
    }
 
    case PCB_TEXT_T:
    {
        PCB_TEXT* new_text = new PCB_TEXT( *static_cast<const PCB_TEXT*>( aItem ) );
        new_text->ResetUuidDirect();
 
        if( addToFootprint )
            Add( new_text );
 
        new_item = new_text;
        break;
    }
 
    case PCB_SHAPE_T:
    {
        PCB_SHAPE* new_shape = new PCB_SHAPE( *static_cast<const PCB_SHAPE*>( aItem ) );
        new_shape->ResetUuidDirect();
 
        if( addToFootprint )
            Add( new_shape );
 
        new_item = new_shape;
        break;
    }
 
    case PCB_BARCODE_T:
    {
        PCB_BARCODE* new_barcode = new PCB_BARCODE( *static_cast<const PCB_BARCODE*>( aItem ) );
        new_barcode->ResetUuidDirect();
 
        if( addToFootprint )
            Add( new_barcode );
 
        new_item = new_barcode;
        break;
    }
 
    case PCB_REFERENCE_IMAGE_T:
    {
        PCB_REFERENCE_IMAGE* new_image = new PCB_REFERENCE_IMAGE( *static_cast<const PCB_REFERENCE_IMAGE*>( aItem ) );
        new_image->ResetUuidDirect();
 
        if( addToFootprint )
            Add( new_image );
 
        new_item = new_image;
        break;
    }
 
    case PCB_TEXTBOX_T:
    {
        PCB_TEXTBOX* new_textbox = new PCB_TEXTBOX( *static_cast<const PCB_TEXTBOX*>( aItem ) );
        new_textbox->ResetUuidDirect();
 
        if( addToFootprint )
            Add( new_textbox );
 
        new_item = new_textbox;
        break;
    }
 
    case PCB_DIM_ALIGNED_T:
    case PCB_DIM_LEADER_T:
    case PCB_DIM_CENTER_T:
    case PCB_DIM_RADIAL_T:
    case PCB_DIM_ORTHOGONAL_T:
    {
        PCB_DIMENSION_BASE* dimension = static_cast<PCB_DIMENSION_BASE*>( aItem->Duplicate( addToParentGroup,
                                                                                            aCommit ) );
 
        if( addToFootprint )
            Add( dimension );
 
        new_item = dimension;
        break;
    }
 
    case PCB_TABLE_T:
    {
        new_item = aItem->Duplicate( addToParentGroup, aCommit );
 
        if( addToFootprint )
            Add( new_item );
 
        break;
    }
 
    case PCB_GROUP_T:
    {
        PCB_GROUP* group = static_cast<const PCB_GROUP*>( aItem )->DeepDuplicate( addToParentGroup, aCommit );
 
        if( addToFootprint )
        {
            group->RunOnChildren(
                    [&]( BOARD_ITEM* aCurrItem )
                    {
                        Add( aCurrItem );
                    },
                    RECURSE_MODE::RECURSE );
 
            Add( group );
        }
 
        new_item = group;
        break;
    }
 
    case PCB_FOOTPRINT_T:
        // Ignore the footprint itself
        break;
 
    default:
        // Un-handled item for duplication
        wxFAIL_MSG( wxT( "Duplication not supported for items of class " ) + aItem->GetClass() );
        break;
    }
 
    return new_item;
}
 
 
wxString FOOTPRINT::GetNextPadNumber( const wxString& aLastPadNumber ) const
{
    std::set<wxString> usedNumbers;
 
    // Create a set of used pad numbers
    for( PAD* pad : m_pads )
        usedNumbers.insert( pad->GetNumber() );
 
    // Pad numbers aren't technically reference designators, but the formatting is close enough
    // for these to give us what we need.
    wxString prefix = UTIL::GetRefDesPrefix( aLastPadNumber );
    int      num = GetTrailingInt( aLastPadNumber );
 
    while( usedNumbers.count( wxString::Format( wxT( "%s%d" ), prefix, num ) ) )
        num++;
 
    return wxString::Format( wxT( "%s%d" ), prefix, num );
}
 
 
void FOOTPRINT::AutoPositionFields()
{
    // Auto-position reference and value
    BOX2I bbox = GetBoundingBox( false );
    bbox.Inflate( pcbIUScale.mmToIU( 0.2 ) ); // Gap between graphics and text
 
    if( Reference().GetPosition() == VECTOR2I( 0, 0 ) )
    {
        Reference().SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
        Reference().SetVertJustify( GR_TEXT_V_ALIGN_CENTER );
        Reference().SetTextAngle( ANGLE_0 );
 
        Reference().SetX( bbox.GetCenter().x );
        Reference().SetY( bbox.GetTop() - Reference().GetTextSize().y / 2 );
    }
 
    if( Value().GetPosition() == VECTOR2I( 0, 0 ) )
    {
        Value().SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
        Value().SetVertJustify( GR_TEXT_V_ALIGN_CENTER );
        Value().SetTextAngle( ANGLE_0 );
 
        Value().SetX( bbox.GetCenter().x );
        Value().SetY( bbox.GetBottom() + Value().GetTextSize().y / 2 );
    }
}
 
 
void FOOTPRINT::IncrementReference( int aDelta )
{
    const wxString& refdes = GetReference();
 
    SetReference( wxString::Format( wxT( "%s%i" ),
                                    UTIL::GetRefDesPrefix( refdes ),
                                    GetTrailingInt( refdes ) + aDelta ) );
}
 
 
double FOOTPRINT::GetCoverageArea( int aTextMargin ) const
{
    SHAPE_POLY_SET hull = GetBoundingHull();
    return polygonArea( hull );
}
 
 
double FOOTPRINT::CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const
{
    int textMargin = aCollector.GetGuide()->Accuracy();
 
    SHAPE_POLY_SET footprintRegion( GetBoundingHull() );
    SHAPE_POLY_SET coveredRegion;
 
    TransformPadsToPolySet( coveredRegion, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 
    TransformFPShapesToPolySet( coveredRegion, UNDEFINED_LAYER, textMargin, ARC_LOW_DEF,
                                ERROR_OUTSIDE,
                                true,  /* include text */
                                false, /* include shapes */
                                false  /* include private items */ );
 
    for( int i = 0; i < aCollector.GetCount(); ++i )
    {
        const BOARD_ITEM* item = aCollector[i];
 
        switch( item->Type() )
        {
        case PCB_FIELD_T:
        case PCB_TEXT_T:
        case PCB_TEXTBOX_T:
        case PCB_SHAPE_T:
        case PCB_BARCODE_T:
        case PCB_TRACE_T:
        case PCB_ARC_T:
        case PCB_VIA_T:
            if( item->GetParent() != this )
            {
                item->TransformShapeToPolygon( coveredRegion, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
                                               ERROR_OUTSIDE );
            }
            break;
 
        case PCB_FOOTPRINT_T:
            if( item != this )
            {
                const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( item );
                coveredRegion.AddOutline( footprint->GetBoundingHull().Outline( 0 ) );
            }
            break;
 
        default:
            break;
        }
    }
 
    coveredRegion.BooleanIntersection( footprintRegion );
 
    double footprintRegionArea = polygonArea( footprintRegion );
    double uncoveredRegionArea = footprintRegionArea - polygonArea( coveredRegion );
    double coveredArea = footprintRegionArea - uncoveredRegionArea;
 
    // Avoid div-by-zero (this will result in the disambiguate dialog)
    if( footprintRegionArea == 0 )
        return 1.0;
 
    double ratio = coveredArea / footprintRegionArea;
 
    // Test for negative ratio (should not occur).
    // better to be conservative (this will result in the disambiguate dialog)
    if( ratio < 0.0 )
        return 1.0;
 
    return std::min( ratio, 1.0 );
}
 
 
std::shared_ptr<SHAPE> FOOTPRINT::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash,
                                                     DRC_CONSTRAINT_T aUsage ) const
{
    std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
 
    // There are several possible interpretations here:
    // 1) the bounding box (without or without invisible items)
    // 2) just the pads and "edges" (ie: non-text graphic items)
    // 3) the courtyard
 
    // We'll go with (2) for now, unless the caller is clearly looking for (3)
 
    if( aLayer == F_CrtYd || aLayer == B_CrtYd )
    {
        const SHAPE_POLY_SET& courtyard = GetCourtyard( aLayer );
 
        if( courtyard.OutlineCount() == 0 )    // malformed/empty polygon
            return shape;
 
        shape->AddShape( new SHAPE_SIMPLE( courtyard.COutline( 0 ) ) );
    }
    else
    {
        for( PAD* pad : Pads() )
            shape->AddShape( pad->GetEffectiveShape( aLayer, aFlash, aUsage )->Clone() );
 
        for( BOARD_ITEM* item : GraphicalItems() )
        {
            if( item->Type() == PCB_SHAPE_T )
                shape->AddShape( item->GetEffectiveShape( aLayer, aFlash, aUsage )->Clone() );
            else if( item->Type() == PCB_BARCODE_T )
                shape->AddShape( item->GetEffectiveShape( aLayer, aFlash, aUsage )->Clone() );
        }
    }
 
    return shape;
}
 
 
const SHAPE_POLY_SET& FOOTPRINT::GetCourtyard( PCB_LAYER_ID aLayer ) const
{
    std::lock_guard<std::mutex> lock( m_courtyard_cache_mutex );
 
    if( !m_courtyard_cache
        || m_courtyard_cache->front_hash != m_courtyard_cache->front.GetHash()
        || m_courtyard_cache->back_hash != m_courtyard_cache->back.GetHash() )
    {
        const_cast<FOOTPRINT*>(this)->BuildCourtyardCaches();
    }
 
    return GetCachedCourtyard( aLayer );
}
 
 
const SHAPE_POLY_SET& FOOTPRINT::GetCachedCourtyard( PCB_LAYER_ID aLayer ) const
{
    if( !m_courtyard_cache )
        m_courtyard_cache = std::make_unique<FOOTPRINT_COURTYARD_CACHE_DATA>();
 
    if( IsBackLayer( aLayer ) )
        return m_courtyard_cache->back;
    else
        return m_courtyard_cache->front;
}
 
 
void FOOTPRINT::BuildCourtyardCaches( OUTLINE_ERROR_HANDLER* aErrorHandler )
{
    if( !m_courtyard_cache )
        m_courtyard_cache = std::make_unique<FOOTPRINT_COURTYARD_CACHE_DATA>();
 
    m_courtyard_cache->front.RemoveAllContours();
    m_courtyard_cache->back.RemoveAllContours();
    ClearFlags( MALFORMED_COURTYARDS );
 
    // Build the courtyard area from graphic items on the courtyard.
    // Only PCB_SHAPE_T have meaning, graphic texts are ignored.
    // Collect items:
    std::vector<PCB_SHAPE*> list_front;
    std::vector<PCB_SHAPE*> list_back;
    std::map<int, int>      front_width_histogram;
    std::map<int, int>      back_width_histogram;
 
    for( BOARD_ITEM* item : GraphicalItems() )
    {
        if( item->GetLayer() == B_CrtYd && item->Type() == PCB_SHAPE_T )
        {
            PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( item );
            list_back.push_back( shape );
            back_width_histogram[ shape->GetStroke().GetWidth() ]++;
        }
 
        if( item->GetLayer() == F_CrtYd && item->Type() == PCB_SHAPE_T )
        {
            PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( item );
            list_front.push_back( shape );
            front_width_histogram[ shape->GetStroke().GetWidth() ]++;
        }
    }
 
    if( !list_front.size() && !list_back.size() )
        return;
 
    int maxError = pcbIUScale.mmToIU( 0.005 );        // max error for polygonization
    int chainingEpsilon = pcbIUScale.mmToIU( 0.02 );  // max dist from one endPt to next startPt
 
    if( ConvertOutlineToPolygon( list_front, m_courtyard_cache->front, maxError, chainingEpsilon,
                                 true, aErrorHandler ) )
    {
        int width = 0;
 
        // Touching courtyards, or courtyards -at- the clearance distance are legal.
        // Use maxError here because that is the allowed deviation when transforming arcs/circles to
        // polygons.
        m_courtyard_cache->front.Inflate( -maxError, CORNER_STRATEGY::CHAMFER_ACUTE_CORNERS, maxError );
 
        m_courtyard_cache->front.CacheTriangulation();
        auto max = std::max_element( front_width_histogram.begin(), front_width_histogram.end(),
                                     []( const std::pair<int, int>& a, const std::pair<int, int>& b )
                                     {
                                         return a.second < b.second;
                                     } );
 
        if( max != front_width_histogram.end() )
            width = max->first;
 
        if( width == 0 )
            width = pcbIUScale.mmToIU( DEFAULT_COURTYARD_WIDTH );
 
        if( m_courtyard_cache->front.OutlineCount() > 0 )
            m_courtyard_cache->front.Outline( 0 ).SetWidth( width );
    }
    else
    {
        SetFlags( MALFORMED_F_COURTYARD );
    }
 
    if( ConvertOutlineToPolygon( list_back, m_courtyard_cache->back, maxError, chainingEpsilon, true,
                                 aErrorHandler ) )
    {
        int width = 0;
 
        // Touching courtyards, or courtyards -at- the clearance distance are legal.
        m_courtyard_cache->back.Inflate( -maxError, CORNER_STRATEGY::CHAMFER_ACUTE_CORNERS, maxError );
 
        m_courtyard_cache->back.CacheTriangulation();
        auto max = std::max_element( back_width_histogram.begin(), back_width_histogram.end(),
                                     []( const std::pair<int, int>& a, const std::pair<int, int>& b )
                                     {
                                         return a.second < b.second;
                                     } );
 
        if( max != back_width_histogram.end() )
            width = max->first;
 
        if( width == 0 )
            width = pcbIUScale.mmToIU( DEFAULT_COURTYARD_WIDTH );
 
        if( m_courtyard_cache->back.OutlineCount() > 0 )
            m_courtyard_cache->back.Outline( 0 ).SetWidth( width );
    }
    else
    {
        SetFlags( MALFORMED_B_COURTYARD );
    }
 
    m_courtyard_cache->front_hash = m_courtyard_cache->front.GetHash();
    m_courtyard_cache->back_hash = m_courtyard_cache->back.GetHash();
}
 
 
void FOOTPRINT::BuildNetTieCache()
{
    m_netTieCache.clear();
    std::map<wxString, int> map = MapPadNumbersToNetTieGroups();
    std::map<PCB_LAYER_ID, std::vector<PCB_SHAPE*>> layer_shapes;
    BOARD* board = GetBoard();
 
    std::for_each( m_drawings.begin(), m_drawings.end(),
                   [&]( BOARD_ITEM* item )
                   {
                       if( item->Type() != PCB_SHAPE_T )
                           return;
 
                       for( PCB_LAYER_ID layer : item->GetLayerSet() )
                       {
                           if( !IsCopperLayer( layer ) )
                               continue;
 
                           if( board && !board->GetEnabledLayers().Contains( layer ) )
                               continue;
 
                           layer_shapes[layer].push_back( static_cast<PCB_SHAPE*>( item ) );
                       }
                   } );
 
    for( size_t ii = 0; ii < m_pads.size(); ++ii )
    {
        PAD* pad = m_pads[ ii ];
        bool has_nettie = false;
 
        auto it = map.find( pad->GetNumber() );
 
        if( it == map.end() || it->second < 0 )
            continue;
 
        for( size_t jj = 0; jj < m_pads.size(); ++jj )
        {
            if( jj == ii )
                continue;
 
            PAD* other = m_pads[ jj ];
 
            auto it2 = map.find( other->GetNumber() );
 
            if( it2 == map.end() || it2->second < 0 )
                continue;
 
            if( it2->second == it->second )
            {
                m_netTieCache[pad].insert( pad->GetNetCode() );
                m_netTieCache[pad].insert( other->GetNetCode() );
                m_netTieCache[other].insert( other->GetNetCode() );
                m_netTieCache[other].insert( pad->GetNetCode() );
                has_nettie = true;
            }
        }
 
        if( !has_nettie )
            continue;
 
        for( auto& [ layer, shapes ] : layer_shapes )
        {
            auto pad_shape = pad->GetEffectiveShape( layer );
 
            for( auto other_shape : shapes )
            {
                auto shape = other_shape->GetEffectiveShape( layer );
 
                if( pad_shape->Collide( shape.get() ) )
                {
                    std::set<int>& nettie = m_netTieCache[pad];
                    m_netTieCache[other_shape].insert( nettie.begin(), nettie.end() );
                }
            }
        }
    }
}
 
 
std::map<wxString, int> FOOTPRINT::MapPadNumbersToNetTieGroups() const
{
    std::map<wxString, int> padNumberToGroupIdxMap;
 
    for( const PAD* pad : m_pads )
        padNumberToGroupIdxMap[ pad->GetNumber() ] = -1;
 
    auto processPad =
            [&]( wxString aPad, int aGroup )
            {
                aPad.Trim( true ).Trim( false );
 
                if( !aPad.IsEmpty() )
                    padNumberToGroupIdxMap[ aPad ] = aGroup;
            };
 
    for( int ii = 0; ii < (int) m_netTiePadGroups.size(); ++ii )
    {
        wxString group( m_netTiePadGroups[ ii ] );
        bool esc = false;
        wxString pad;
 
        for( wxUniCharRef ch : group )
        {
            if( esc )
            {
                esc = false;
                pad.Append( ch );
                continue;
            }
 
            switch( static_cast<unsigned char>( ch ) )
            {
            case '\\':
                esc = true;
                break;
 
            case ',':
                processPad( pad, ii );
                pad.Clear();
                break;
 
            default:
                pad.Append( ch );
                break;
            }
        }
 
        processPad( pad, ii );
    }
 
    return padNumberToGroupIdxMap;
}
 
 
std::vector<PAD*> FOOTPRINT::GetNetTiePads( PAD* aPad ) const
{
    // First build a map from pad numbers to allowed-shorting-group indexes.  This ends up being
    // something like O(3n), but it still beats O(n^2) for large numbers of pads.
 
    std::map<wxString, int> padToNetTieGroupMap = MapPadNumbersToNetTieGroups();
    int                     groupIdx = padToNetTieGroupMap[ aPad->GetNumber() ];
    std::vector<PAD*>       otherPads;
 
    if( groupIdx >= 0 )
    {
        for( PAD* pad : m_pads )
        {
            if( padToNetTieGroupMap[ pad->GetNumber() ] == groupIdx )
                otherPads.push_back( pad );
        }
    }
 
    return otherPads;
}
 
 
void FOOTPRINT::CheckFootprintAttributes( const std::function<void( const wxString& )>& aErrorHandler )
{
    int likelyAttr = ( GetLikelyAttribute() & ( FP_SMD | FP_THROUGH_HOLE ) );
    int setAttr = ( GetAttributes() & ( FP_SMD | FP_THROUGH_HOLE ) );
 
    if( setAttr && likelyAttr && setAttr != likelyAttr )
    {
        wxString msg;
 
        switch( likelyAttr )
        {
        case FP_THROUGH_HOLE:
            msg.Printf( _( "(expected 'Through hole'; actual '%s')" ), GetTypeName() );
            break;
        case FP_SMD:
            msg.Printf( _( "(expected 'SMD'; actual '%s')" ), GetTypeName() );
            break;
        }
 
        if( aErrorHandler )
            (aErrorHandler)( msg );
    }
}
 
 
void FOOTPRINT::CheckPads( UNITS_PROVIDER* aUnitsProvider,
                           const std::function<void( const PAD*, int,
                                                     const wxString& )>& aErrorHandler )
{
    if( aErrorHandler == nullptr )
        return;
 
    for( PAD* pad: Pads() )
    {
        pad->CheckPad( aUnitsProvider, false,
                [&]( int errorCode, const wxString& msg )
                {
                    aErrorHandler( pad, errorCode, msg );
                } );
    }
}
 
 
void FOOTPRINT::CheckShortingPads( const std::function<void( const PAD*, const PAD*, int aErrorCode,
                                                             const VECTOR2I& )>& aErrorHandler )
{
    std::unordered_map<PTR_PTR_CACHE_KEY, int> checkedPairs;
 
    for( PAD* pad : Pads() )
    {
        std::vector<PAD*> netTiePads = GetNetTiePads( pad );
 
        for( PAD* other : Pads() )
        {
            if( other == pad )
                continue;
 
            // store canonical order so we don't collide in both directions (a:b and b:a)
            PAD* a = pad;
            PAD* b = other;
 
            if( static_cast<void*>( a ) > static_cast<void*>( b ) )
                std::swap( a, b );
 
            if( checkedPairs.find( { a, b } ) == checkedPairs.end() )
            {
                checkedPairs[ { a, b } ] = 1;
 
                if( pad->HasDrilledHole() && other->HasDrilledHole() )
                {
                    VECTOR2I pos = pad->GetPosition();
 
                    if( pad->GetPosition() == other->GetPosition() )
                    {
                        aErrorHandler( pad, other, DRCE_DRILLED_HOLES_COLOCATED, pos );
                    }
                    else
                    {
                        std::shared_ptr<SHAPE_SEGMENT> holeA = pad->GetEffectiveHoleShape( UNDEFINED_LAYER,
                                                                                           HOLE_TO_HOLE_CONSTRAINT );
                        std::shared_ptr<SHAPE_SEGMENT> holeB = other->GetEffectiveHoleShape( UNDEFINED_LAYER,
                                                                                             HOLE_TO_HOLE_CONSTRAINT );
 
                        if( holeA->Collide( holeB->GetSeg(), 0 ) )
                            aErrorHandler( pad, other, DRCE_DRILLED_HOLES_TOO_CLOSE, pos );
                    }
                }
 
                if( pad->SameLogicalPadAs( other ) || alg::contains( netTiePads, other ) )
                    continue;
 
                if( !( ( pad->GetLayerSet() & other->GetLayerSet() ) & LSET::AllCuMask() ).any() )
                    continue;
 
                if( pad->GetBoundingBox().Intersects( other->GetBoundingBox() ) )
                {
                    VECTOR2I pos;
 
                    for( PCB_LAYER_ID l : pad->Padstack().RelevantShapeLayers( other->Padstack() ) )
                    {
                        SHAPE*   padShape = pad->GetEffectiveShape( l ).get();
                        SHAPE*   otherShape = other->GetEffectiveShape( l ).get();
 
                        if( padShape->Collide( otherShape, 0, nullptr, &pos ) )
                            aErrorHandler( pad, other, DRCE_SHORTING_ITEMS, pos );
                    }
                }
            }
        }
    }
}
 
 
void FOOTPRINT::CheckNetTies( const std::function<void( const BOARD_ITEM* aItem,
                                                        const BOARD_ITEM* bItem,
                                                        const BOARD_ITEM* cItem,
                                                        const VECTOR2I& )>& aErrorHandler )
{
    // First build a map from pad numbers to allowed-shorting-group indexes.  This ends up being
    // something like O(3n), but it still beats O(n^2) for large numbers of pads.
 
    std::map<wxString, int> padNumberToGroupIdxMap = MapPadNumbersToNetTieGroups();
 
    // Now collect all the footprint items which are on copper layers
 
    std::vector<BOARD_ITEM*> copperItems;
 
    for( BOARD_ITEM* item : m_drawings )
    {
        if( item->IsOnCopperLayer() )
            copperItems.push_back( item );
 
        item->RunOnChildren(
                [&]( BOARD_ITEM* descendent )
                {
                    if( descendent->IsOnCopperLayer() )
                        copperItems.push_back( descendent );
                },
                RECURSE_MODE::RECURSE );
    }
 
    for( ZONE* zone : m_zones )
    {
        if( !zone->GetIsRuleArea() && zone->IsOnCopperLayer() )
            copperItems.push_back( zone );
    }
 
    for( PCB_FIELD* field : m_fields )
    {
        if( field->IsOnCopperLayer() )
            copperItems.push_back( field );
    }
 
    for( PCB_LAYER_ID layer : { F_Cu, In1_Cu, B_Cu } )
    {
        // Next, build a polygon-set for the copper on this layer.  We don't really care about
        // nets here, we just want to end up with a set of outlines describing the distinct
        // copper polygons of the footprint.
 
        SHAPE_POLY_SET                         copperOutlines;
        std::map<int, std::vector<const PAD*>> outlineIdxToPadsMap;
 
        for( BOARD_ITEM* item : copperItems )
        {
            if( item->IsOnLayer( layer ) )
                item->TransformShapeToPolygon( copperOutlines, layer, 0, GetMaxError(), ERROR_OUTSIDE );
        }
 
        copperOutlines.Simplify();
 
        // Index each pad to the outline in the set that it is part of.
 
        for( const PAD* pad : m_pads )
        {
            for( int ii = 0; ii < copperOutlines.OutlineCount(); ++ii )
            {
                if( pad->GetEffectiveShape( layer )->Collide( &copperOutlines.Outline( ii ), 0 ) )
                    outlineIdxToPadsMap[ ii ].emplace_back( pad );
            }
        }
 
        // Finally, ensure that each outline which contains multiple pads has all its pads
        // listed in an allowed-shorting group.
 
        for( const auto& [ outlineIdx, pads ] : outlineIdxToPadsMap )
        {
            if( pads.size() > 1 )
            {
                const PAD* firstPad = pads[0];
                int        firstGroupIdx = padNumberToGroupIdxMap[ firstPad->GetNumber() ];
 
                for( size_t ii = 1; ii < pads.size(); ++ii )
                {
                    const PAD* thisPad = pads[ii];
                    int        thisGroupIdx = padNumberToGroupIdxMap[ thisPad->GetNumber() ];
 
                    if( thisGroupIdx < 0 || thisGroupIdx != firstGroupIdx )
                    {
                        BOARD_ITEM* shortingItem = nullptr;
                        VECTOR2I    pos = ( firstPad->GetPosition() + thisPad->GetPosition() ) / 2;
 
                        pos = copperOutlines.Outline( outlineIdx ).NearestPoint( pos );
 
                        for( BOARD_ITEM* item : copperItems )
                        {
                            if( item->HitTest( pos, 1 ) )
                            {
                                shortingItem = item;
                                break;
                            }
                        }
 
                        if( shortingItem )
                            aErrorHandler( shortingItem, firstPad, thisPad, pos );
                        else
                            aErrorHandler( firstPad, thisPad, nullptr, pos );
                    }
                }
            }
        }
    }
}
 
 
void FOOTPRINT::CheckNetTiePadGroups( const std::function<void( const wxString& )>& aErrorHandler )
{
    std::set<wxString> padNumbers;
    wxString           msg;
 
    for( const auto& [ padNumber, _ ] : MapPadNumbersToNetTieGroups() )
    {
        const PAD* pad = FindPadByNumber( padNumber );
 
        if( !pad )
        {
            msg.Printf( _( "(net-tie pad group contains unknown pad number %s)" ), padNumber );
            aErrorHandler( msg );
        }
        else if( !padNumbers.insert( pad->GetNumber() ).second )
        {
            msg.Printf( _( "(pad %s appears in more than one net-tie pad group)" ), padNumber );
            aErrorHandler( msg );
        }
    }
}
 
 
void FOOTPRINT::CheckClippedSilk( const std::function<void( BOARD_ITEM* aItemA,
                                                            BOARD_ITEM* aItemB,
                                                            const VECTOR2I& aPt )>& aErrorHandler )
{
    auto checkColliding =
            [&]( BOARD_ITEM* item, BOARD_ITEM* other )
            {
                for( PCB_LAYER_ID silk : { F_SilkS, B_SilkS } )
                {
                    PCB_LAYER_ID mask = silk == F_SilkS ? F_Mask : B_Mask;
 
                    if( !item->IsOnLayer( silk ) || !other->IsOnLayer( mask ) )
                        continue;
 
                    std::shared_ptr<SHAPE> itemShape = item->GetEffectiveShape( silk );
                    std::shared_ptr<SHAPE> otherShape = other->GetEffectiveShape( mask );
                    int                    actual;
                    VECTOR2I               pos;
 
                    if( itemShape->Collide( otherShape.get(), 0, &actual, &pos ) )
                        aErrorHandler( item, other, pos );
                }
            };
 
    for( BOARD_ITEM* item : m_drawings )
    {
        for( BOARD_ITEM* other : m_drawings )
        {
            if( other != item )
                checkColliding( item, other );
        }
 
        for( PAD* pad : m_pads )
            checkColliding( item, pad );
    }
}
 
 
void FOOTPRINT::swapData( BOARD_ITEM* aImage )
{
    wxASSERT( aImage->Type() == PCB_FOOTPRINT_T );
 
    FOOTPRINT* image = static_cast<FOOTPRINT*>( aImage );
 
    std::swap( *this, *image );
 
    RunOnChildren(
            [&]( BOARD_ITEM* child )
            {
                child->SetParent( this );
            },
            RECURSE_MODE::NO_RECURSE );
 
    image->RunOnChildren(
            [&]( BOARD_ITEM* child )
            {
                child->SetParent( image );
            },
            RECURSE_MODE::NO_RECURSE );
}
 
 
bool FOOTPRINT::HasThroughHolePads() const
{
    for( PAD* pad : Pads() )
    {
        if( pad->GetAttribute() != PAD_ATTRIB::SMD )
            return true;
    }
 
    return false;
}
 
 
bool FOOTPRINT::operator==( const BOARD_ITEM& aOther ) const
{
    if( aOther.Type() != PCB_FOOTPRINT_T )
        return false;
 
    const FOOTPRINT& other = static_cast<const FOOTPRINT&>( aOther );
 
    return *this == other;
}
 
 
bool FOOTPRINT::operator==( const FOOTPRINT& aOther ) const
{
    auto equalItems =
            []( const auto* aLeft, const auto* aRight )
            {
                return *aLeft == *aRight;
            };
 
    if( !std::ranges::equal( m_pads, aOther.m_pads, equalItems ) )
        return false;
 
    if( !std::ranges::equal( m_drawings, aOther.m_drawings, equalItems ) )
        return false;
 
    if( !std::ranges::equal( m_zones, aOther.m_zones, equalItems ) )
        return false;
 
    if( m_points.size() != aOther.m_points.size() )
        return false;
 
    // Compare fields in ordinally-sorted order
    std::vector<PCB_FIELD*> fields, otherFields;
 
    GetFields( fields, false );
    aOther.GetFields( otherFields, false );
 
    if( fields.size() != otherFields.size() )
        return false;
 
    for( size_t ii = 0; ii < fields.size(); ++ii )
    {
        if( fields[ii] )
        {
            if( !( *fields[ii] == *otherFields[ii] ) )
                return false;
        }
    }
 
    return true;
}
 
 
double FOOTPRINT::Similarity( const BOARD_ITEM& aOther ) const
{
    if( aOther.Type() != PCB_FOOTPRINT_T )
        return 0.0;
 
    const FOOTPRINT& other = static_cast<const FOOTPRINT&>( aOther );
 
    double similarity = 1.0;
 
    for( const PAD* pad : m_pads)
    {
        const PAD* otherPad = other.FindPadByNumber( pad->GetNumber() );
 
        if( !otherPad )
            continue;
 
        similarity *= pad->Similarity( *otherPad );
    }
 
    return similarity;
}
 

static constexpr std::optional<bool> cmp_points_opt( const VECTOR2I& aPtA, const VECTOR2I& aPtB )
{
    if( aPtA.x != aPtB.x )
        return aPtA.x < aPtB.x;
 
    if( aPtA.y != aPtB.y )
        return aPtA.y < aPtB.y;
 
    return std::nullopt;
}
 
 
bool FOOTPRINT::cmp_drawings::operator()( const BOARD_ITEM* itemA, const BOARD_ITEM* itemB ) const
{
    if( itemA->Type() != itemB->Type() )
        return itemA->Type() < itemB->Type();
 
    if( itemA->GetLayer() != itemB->GetLayer() )
        return itemA->GetLayer() < itemB->GetLayer();
 
    switch( itemA->Type() )
    {
    case PCB_SHAPE_T:
    {
        const PCB_SHAPE* dwgA = static_cast<const PCB_SHAPE*>( itemA );
        const PCB_SHAPE* dwgB = static_cast<const PCB_SHAPE*>( itemB );
 
        if( dwgA->GetShape() != dwgB->GetShape() )
            return dwgA->GetShape() < dwgB->GetShape();
 
        if( dwgA->GetShape() != SHAPE_T::POLY )
        {
            if( std::optional<bool> cmp = cmp_points_opt( dwgA->GetLibraryStart(), dwgB->GetLibraryStart() ) )
                return *cmp;
 
            if( std::optional<bool> cmp = cmp_points_opt( dwgA->GetLibraryEnd(), dwgB->GetLibraryEnd() ) )
                return *cmp;
        }
 
        if( dwgA->GetShape() == SHAPE_T::ARC )
        {
            if( std::optional<bool> cmp = cmp_points_opt( dwgA->GetLibraryArcMid(), dwgB->GetLibraryArcMid() ) )
                return *cmp;
        }
        else if( dwgA->GetShape() == SHAPE_T::BEZIER )
        {
            if( std::optional<bool> cmp = cmp_points_opt( dwgA->GetLibraryBezierC1(), dwgB->GetLibraryBezierC1() ) )
                return *cmp;
 
            if( std::optional<bool> cmp = cmp_points_opt( dwgA->GetLibraryBezierC2(), dwgB->GetLibraryBezierC2() ) )
                return *cmp;
        }
        else if( dwgA->GetShape() == SHAPE_T::POLY )
        {
            const SHAPE_POLY_SET aLib = dwgA->GetLibraryPolyShape();
            const SHAPE_POLY_SET bLib = dwgB->GetLibraryPolyShape();
 
            if( aLib.TotalVertices() != bLib.TotalVertices() )
                return aLib.TotalVertices() < bLib.TotalVertices();
 
            for( int ii = 0; ii < aLib.TotalVertices(); ++ii )
            {
                if( std::optional<bool> cmp = cmp_points_opt( aLib.CVertex( ii ), bLib.CVertex( ii ) ) )
                    return *cmp;
            }
        }
        else if( dwgA->GetShape() == SHAPE_T::ELLIPSE || dwgA->GetShape() == SHAPE_T::ELLIPSE_ARC )
        {
            if( std::optional<bool> cmp = cmp_points_opt( dwgA->GetEllipseCenter(), dwgB->GetEllipseCenter() ) )
                return *cmp;
 
            if( dwgA->GetEllipseMajorRadius() != dwgB->GetEllipseMajorRadius() )
                return dwgA->GetEllipseMajorRadius() < dwgB->GetEllipseMajorRadius();
 
            if( dwgA->GetEllipseMinorRadius() != dwgB->GetEllipseMinorRadius() )
                return dwgA->GetEllipseMinorRadius() < dwgB->GetEllipseMinorRadius();
 
            if( dwgA->GetEllipseRotation().AsTenthsOfADegree() != dwgB->GetEllipseRotation().AsTenthsOfADegree() )
                return dwgA->GetEllipseRotation().AsTenthsOfADegree() < dwgB->GetEllipseRotation().AsTenthsOfADegree();
 
            if( dwgA->GetShape() == SHAPE_T::ELLIPSE_ARC )
            {
                if( dwgA->GetEllipseStartAngle().AsTenthsOfADegree()
                    != dwgB->GetEllipseStartAngle().AsTenthsOfADegree() )
                    return dwgA->GetEllipseStartAngle().AsTenthsOfADegree()
                           < dwgB->GetEllipseStartAngle().AsTenthsOfADegree();
 
                if( dwgA->GetEllipseEndAngle().AsTenthsOfADegree() != dwgB->GetEllipseEndAngle().AsTenthsOfADegree() )
                    return dwgA->GetEllipseEndAngle().AsTenthsOfADegree()
                           < dwgB->GetEllipseEndAngle().AsTenthsOfADegree();
            }
        }
 
        if( dwgA->GetWidth() != dwgB->GetWidth() )
            return dwgA->GetWidth() < dwgB->GetWidth();
 
        break;
    }
    case PCB_TEXT_T:
    {
        const PCB_TEXT& textA = static_cast<const PCB_TEXT&>( *itemA );
        const PCB_TEXT& textB = static_cast<const PCB_TEXT&>( *itemB );
 
        if( std::optional<bool> cmp = cmp_points_opt( textA.GetFPRelativePosition(), textB.GetFPRelativePosition() ) )
            return *cmp;
 
        if( textA.GetTextAngle() != textB.GetTextAngle() )
            return textA.GetTextAngle() < textB.GetTextAngle();
 
        if( std::optional<bool> cmp = cmp_points_opt( textA.GetTextSize(), textB.GetTextSize() ) )
            return *cmp;
 
        if( textA.GetTextThickness() != textB.GetTextThickness() )
            return textA.GetTextThickness() < textB.GetTextThickness();
 
        if( textA.IsBold() != textB.IsBold() )
            return textA.IsBold() < textB.IsBold();
 
        if( textA.IsItalic() != textB.IsItalic() )
            return textA.IsItalic() < textB.IsItalic();
 
        if( textA.IsMirrored() != textB.IsMirrored() )
            return textA.IsMirrored() < textB.IsMirrored();
 
        if( textA.GetLineSpacing() != textB.GetLineSpacing() )
            return textA.GetLineSpacing() < textB.GetLineSpacing();
 
        if( textA.GetText() != textB.GetText() )
            return textA.GetText().Cmp( textB.GetText() ) < 0;
 
        break;
    }
    default:
    {
        // These items don't have their own specific sorting criteria.
        break;
    }
    }
 
    if( itemA->m_Uuid != itemB->m_Uuid )
        return itemA->m_Uuid < itemB->m_Uuid;
 
    return itemA < itemB;
}
 
 
bool FOOTPRINT::cmp_pads::operator()( const PAD* aFirst, const PAD* aSecond ) const
{
    if( aFirst->GetNumber() != aSecond->GetNumber() )
        return StrNumCmp( aFirst->GetNumber(), aSecond->GetNumber() ) < 0;
 
    if( std::optional<bool> cmp = cmp_points_opt( aFirst->GetFPRelativePosition(), aSecond->GetFPRelativePosition() ) )
        return *cmp;
 
    std::optional<bool> padCopperMatches;
 
    // Pick the "most complex" padstack to iterate
    const PAD* checkPad = aFirst;
 
    if( aSecond->Padstack().Mode() == PADSTACK::MODE::CUSTOM
        || ( aSecond->Padstack().Mode() == PADSTACK::MODE::FRONT_INNER_BACK &&
             aFirst->Padstack().Mode() == PADSTACK::MODE::NORMAL ) )
    {
        checkPad = aSecond;
    }
 
    checkPad->Padstack().ForEachUniqueLayer(
        [&]( PCB_LAYER_ID aLayer )
        {
            if( aFirst->GetSize( aLayer ).x != aSecond->GetSize( aLayer ).x )
                padCopperMatches = aFirst->GetSize( aLayer ).x < aSecond->GetSize( aLayer ).x;
            else if( aFirst->GetSize( aLayer ).y != aSecond->GetSize( aLayer ).y )
                padCopperMatches = aFirst->GetSize( aLayer ).y < aSecond->GetSize( aLayer ).y;
            else if( aFirst->GetShape( aLayer ) != aSecond->GetShape( aLayer ) )
                padCopperMatches = aFirst->GetShape( aLayer ) < aSecond->GetShape( aLayer );
        } );
 
    if( padCopperMatches.has_value() )
        return *padCopperMatches;
 
    if( aFirst->GetLayerSet() != aSecond->GetLayerSet() )
        return aFirst->GetLayerSet().Seq() < aSecond->GetLayerSet().Seq();
 
    if( aFirst->m_Uuid != aSecond->m_Uuid )
        return aFirst->m_Uuid < aSecond->m_Uuid;
 
    return aFirst < aSecond;
}
 
 
#if 0
bool FOOTPRINT::cmp_padstack::operator()( const PAD* aFirst, const PAD* aSecond ) const
{
    if( aFirst->GetSize().x != aSecond->GetSize().x )
        return aFirst->GetSize().x < aSecond->GetSize().x;
    if( aFirst->GetSize().y != aSecond->GetSize().y )
        return aFirst->GetSize().y < aSecond->GetSize().y;
 
    if( aFirst->GetShape() != aSecond->GetShape() )
        return aFirst->GetShape() < aSecond->GetShape();
 
    if( aFirst->GetLayerSet() != aSecond->GetLayerSet() )
        return aFirst->GetLayerSet().Seq() < aSecond->GetLayerSet().Seq();
 
    if( aFirst->GetDrillSizeX() != aSecond->GetDrillSizeX() )
        return aFirst->GetDrillSizeX() < aSecond->GetDrillSizeX();
 
    if( aFirst->GetDrillSizeY() != aSecond->GetDrillSizeY() )
        return aFirst->GetDrillSizeY() < aSecond->GetDrillSizeY();
 
    if( aFirst->GetDrillShape() != aSecond->GetDrillShape() )
        return aFirst->GetDrillShape() < aSecond->GetDrillShape();
 
    if( aFirst->GetAttribute() != aSecond->GetAttribute() )
        return aFirst->GetAttribute() < aSecond->GetAttribute();
 
    if( aFirst->GetOrientation() != aSecond->GetOrientation() )
        return aFirst->GetOrientation() < aSecond->GetOrientation();
 
    if( aFirst->GetSolderMaskExpansion() != aSecond->GetSolderMaskExpansion() )
        return aFirst->GetSolderMaskExpansion() < aSecond->GetSolderMaskExpansion();
 
    if( aFirst->GetSolderPasteMargin() != aSecond->GetSolderPasteMargin() )
        return aFirst->GetSolderPasteMargin() < aSecond->GetSolderPasteMargin();
 
    if( aFirst->GetLocalSolderMaskMargin() != aSecond->GetLocalSolderMaskMargin() )
        return aFirst->GetLocalSolderMaskMargin() < aSecond->GetLocalSolderMaskMargin();
 
    const std::shared_ptr<SHAPE_POLY_SET>& firstShape = aFirst->GetEffectivePolygon( ERROR_INSIDE );
    const std::shared_ptr<SHAPE_POLY_SET>& secondShape = aSecond->GetEffectivePolygon( ERROR_INSIDE );
 
    if( firstShape->VertexCount() != secondShape->VertexCount() )
        return firstShape->VertexCount() < secondShape->VertexCount();
 
    for( int ii = 0; ii < firstShape->VertexCount(); ++ii )
    {
        if( std::optional<bool> cmp = cmp_points_opt( firstShape->CVertex( ii ), secondShape->CVertex( ii ) ) )
        {
            return *cmp;
        }
    }
 
    return false;
}
#endif
 
 
bool FOOTPRINT::cmp_zones::operator()( const ZONE* aFirst, const ZONE* aSecond ) const
{
    if( aFirst->GetAssignedPriority() != aSecond->GetAssignedPriority() )
        return aFirst->GetAssignedPriority() < aSecond->GetAssignedPriority();
 
    if( aFirst->GetLayerSet() != aSecond->GetLayerSet() )
        return aFirst->GetLayerSet().Seq() < aSecond->GetLayerSet().Seq();
 
    const SHAPE_POLY_SET aLib = aFirst->GetLibraryOutline();
    const SHAPE_POLY_SET bLib = aSecond->GetLibraryOutline();
 
    if( aLib.TotalVertices() != bLib.TotalVertices() )
        return aLib.TotalVertices() < bLib.TotalVertices();
 
    for( int ii = 0; ii < aLib.TotalVertices(); ++ii )
    {
        if( std::optional<bool> cmp = cmp_points_opt( aLib.CVertex( ii ), bLib.CVertex( ii ) ) )
            return *cmp;
    }
 
    if( aFirst->m_Uuid != aSecond->m_Uuid )
        return aFirst->m_Uuid < aSecond->m_Uuid;
 
    return aFirst < aSecond;
}
 
 
void FOOTPRINT::TransformPadsToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                        int aMaxError, ERROR_LOC aErrorLoc ) const
{
    auto processPad =
        [&]( const PAD* pad, PCB_LAYER_ID padLayer )
        {
            VECTOR2I clearance( aClearance, aClearance );
 
            switch( aLayer )
            {
            case F_Mask:
            case B_Mask:
                clearance.x += pad->GetSolderMaskExpansion( padLayer );
                clearance.y += pad->GetSolderMaskExpansion( padLayer );
                break;
 
            case F_Paste:
            case B_Paste:
                clearance += pad->GetSolderPasteMargin( padLayer );
                break;
 
            default:
                break;
            }
 
            // Our standard TransformShapeToPolygon() routines can't handle differing x:y clearance
            // values (which get generated when a relative paste margin is used with an oblong pad).
            // So we apply this huge hack and fake a larger pad to run the transform on.
            // Of course being a hack it falls down when dealing with custom shape pads (where the
            // size is only the size of the anchor), so for those we punt and just use clearance.x.
 
            if( ( clearance.x < 0 || clearance.x != clearance.y )
                    && pad->GetShape( padLayer ) != PAD_SHAPE::CUSTOM )
            {
                VECTOR2I dummySize = pad->GetSize( padLayer ) + clearance + clearance;
 
                if( dummySize.x <= 0 || dummySize.y <= 0 )
                    return;
 
                PAD dummy( *pad );
                dummy.SetSize( padLayer, dummySize );
                dummy.TransformShapeToPolygon( aBuffer, padLayer, 0, aMaxError, aErrorLoc );
            }
            else
            {
                pad->TransformShapeToPolygon( aBuffer, padLayer, clearance.x, aMaxError, aErrorLoc );
            }
        };
 
    for( const PAD* pad : m_pads )
    {
        if( !pad->FlashLayer( aLayer ) )
            continue;
 
        if( aLayer == UNDEFINED_LAYER )
        {
            pad->Padstack().ForEachUniqueLayer(
                    [&]( PCB_LAYER_ID l )
                    {
                        processPad( pad, l );
                    } );
        }
        else
        {
            processPad( pad, aLayer );
        }
    }
}
 
 
void FOOTPRINT::TransformFPShapesToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                            int aError, ERROR_LOC aErrorLoc, bool aIncludeText,
                                            bool aIncludeShapes, bool aIncludePrivateItems ) const
{
    for( BOARD_ITEM* item : GraphicalItems() )
    {
        if( GetPrivateLayers().test( item->GetLayer() ) && !aIncludePrivateItems )
            continue;
 
        if( item->Type() == PCB_TEXT_T && aIncludeText )
        {
            PCB_TEXT* text = static_cast<PCB_TEXT*>( item );
 
            if( aLayer == UNDEFINED_LAYER || text->GetLayer() == aLayer )
                text->TransformTextToPolySet( aBuffer, aClearance, aError, aErrorLoc );
        }
 
        if( item->Type() == PCB_TEXTBOX_T && aIncludeText )
        {
            PCB_TEXTBOX* textbox = static_cast<PCB_TEXTBOX*>( item );
 
            if( aLayer == UNDEFINED_LAYER || textbox->GetLayer() == aLayer )
            {
                // border
                if( textbox->IsBorderEnabled() )
                    textbox->PCB_SHAPE::TransformShapeToPolygon( aBuffer, aLayer, 0, aError, aErrorLoc );
 
                // text
                textbox->TransformTextToPolySet( aBuffer, 0, aError, aErrorLoc );
            }
        }
 
        if( item->Type() == PCB_SHAPE_T && aIncludeShapes )
        {
            const PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( item );
 
            if( aLayer == UNDEFINED_LAYER || shape->GetLayer() == aLayer )
                shape->TransformShapeToPolySet( aBuffer, aLayer, 0, aError, aErrorLoc );
        }
 
        if( item->Type() == PCB_BARCODE_T && aIncludeShapes )
        {
            const PCB_BARCODE* barcode = static_cast<PCB_BARCODE*>( item );
 
            if( aLayer == UNDEFINED_LAYER || barcode->GetLayer() == aLayer )
                barcode->TransformShapeToPolySet( aBuffer, aLayer, 0, aError, aErrorLoc );
        }
    }
 
    if( aIncludeText )
    {
        for( const PCB_FIELD* field : m_fields )
        {
            if( ( aLayer == UNDEFINED_LAYER || field->GetLayer() == aLayer ) && field->IsVisible() )
                field->TransformTextToPolySet( aBuffer, aClearance, aError, aErrorLoc );
        }
    }
}
 
 
std::set<KIFONT::OUTLINE_FONT*> FOOTPRINT::GetFonts() const
{
    using PERMISSION = KIFONT::OUTLINE_FONT::EMBEDDING_PERMISSION;
 
    std::set<KIFONT::OUTLINE_FONT*> fonts;
 
    auto processItem =
            [&]( BOARD_ITEM* item )
            {
                if( EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( item ) )
                {
                    KIFONT::FONT* font = text->GetFont();
 
                    if( font && font->IsOutline() )
                    {
                        KIFONT::OUTLINE_FONT* outlineFont = static_cast<KIFONT::OUTLINE_FONT*>( font );
                        PERMISSION            permission = outlineFont->GetEmbeddingPermission();
 
                        if( permission == PERMISSION::EDITABLE || permission == PERMISSION::INSTALLABLE )
                            fonts.insert( outlineFont );
                    }
                }
            };
 
    for( BOARD_ITEM* item : GraphicalItems() )
        processItem( item );
 
    for( PCB_FIELD* field : GetFields() )
        processItem( field );
 
    return fonts;
}
 
 
void FOOTPRINT::EmbedFonts()
{
    for( KIFONT::OUTLINE_FONT* font : GetFonts() )
    {
        EMBEDDED_FILES::EMBEDDED_FILE* file = GetEmbeddedFiles()->AddFile( font->GetFileName(), false );
 
        if( !file )
        {
            wxLogTrace( "EMBED", "Failed to add font file: %s", font->GetFileName() );
            continue;
        }
 
        file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT;
    }
}
 
 
void FOOTPRINT::SetStaticComponentClass( const COMPONENT_CLASS* aClass ) const
{
    m_componentClassCacheProxy->SetStaticComponentClass( aClass );
}
 
 
const COMPONENT_CLASS* FOOTPRINT::GetStaticComponentClass() const
{
    return m_componentClassCacheProxy->GetStaticComponentClass();
}
 
 
void FOOTPRINT::RecomputeComponentClass() const
{
    m_componentClassCacheProxy->RecomputeComponentClass();
}
 
 
const COMPONENT_CLASS* FOOTPRINT::GetComponentClass() const
{
    return m_componentClassCacheProxy->GetComponentClass();
}
 
 
wxString FOOTPRINT::GetComponentClassAsString() const
{
    if( !m_componentClassCacheProxy->GetComponentClass()->IsEmpty() )
        return m_componentClassCacheProxy->GetComponentClass()->GetName();
 
    return wxEmptyString;
}
 
 
void FOOTPRINT::ResolveComponentClassNames( BOARD* aBoard,
                                            const std::unordered_set<wxString>& aComponentClassNames )
{
    const COMPONENT_CLASS* componentClass =
            aBoard->GetComponentClassManager().GetEffectiveStaticComponentClass( aComponentClassNames );
    SetStaticComponentClass( componentClass );
}
 
 
void FOOTPRINT::InvalidateComponentClassCache() const
{
    m_componentClassCacheProxy->InvalidateCache();
}
 
 
void FOOTPRINT::SetStackupMode( FOOTPRINT_STACKUP aMode )
{
    m_stackupMode = aMode;
 
    if( m_stackupMode == FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS )
    {
        // Reset the stackup layers to the default values
        m_stackupLayers = LSET{ F_Cu, In1_Cu, B_Cu };
    }
}
 
 
void FOOTPRINT::SetStackupLayers( LSET aLayers )
{
    wxCHECK2( m_stackupMode == FOOTPRINT_STACKUP::CUSTOM_LAYERS, /*void*/ );
 
    if( m_stackupMode == FOOTPRINT_STACKUP::CUSTOM_LAYERS )
        m_stackupLayers = std::move( aLayers );
}
 
 
void FOOTPRINT::FixUpPadsForBoard( BOARD* aBoard )
{
    if( !aBoard )
        return;
 
    if( GetStackupMode() != FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS )
        return;
 
    const LSET boardCopper = LSET::AllCuMask( aBoard->GetCopperLayerCount() );
 
    for( PAD* pad : Pads() )
    {
        if( pad->GetAttribute() == PAD_ATTRIB::PTH )
        {
            LSET padLayers = pad->GetLayerSet();
            padLayers |= boardCopper;
            pad->SetLayerSet( padLayers );
        }
    }
}
 
 
static struct FOOTPRINT_DESC
{
    FOOTPRINT_DESC()
    {
        ENUM_MAP<FOOTPRINT_TYPE>::Instance()
                .Map( FOOTPRINT_TYPE::THROUGH_HOLE, _HKI( "Through hole" ) )
                .Map( FOOTPRINT_TYPE::SMD,          _HKI( "SMD" ) )
                .Map( FOOTPRINT_TYPE::UNSPECIFIED,  _HKI( "Unspecified" ) );
 
        ENUM_MAP<ZONE_CONNECTION>& zcMap = ENUM_MAP<ZONE_CONNECTION>::Instance();
 
        if( zcMap.Choices().GetCount() == 0 )
        {
            zcMap.Undefined( ZONE_CONNECTION::INHERITED );
            zcMap.Map( ZONE_CONNECTION::INHERITED,   _HKI( "Inherited" ) )
                 .Map( ZONE_CONNECTION::NONE,        _HKI( "None" ) )
                 .Map( ZONE_CONNECTION::THERMAL,     _HKI( "Thermal reliefs" ) )
                 .Map( ZONE_CONNECTION::FULL,        _HKI( "Solid" ) )
                 .Map( ZONE_CONNECTION::THT_THERMAL, _HKI( "Thermal reliefs for PTH" ) );
        }
 
        ENUM_MAP<PCB_LAYER_ID>& layerEnum = ENUM_MAP<PCB_LAYER_ID>::Instance();
 
        if( layerEnum.Choices().GetCount() == 0 )
        {
            layerEnum.Undefined( UNDEFINED_LAYER );
 
            for( PCB_LAYER_ID layer : LSET::AllLayersMask() )
                layerEnum.Map( layer, LSET::Name( layer ) );
        }
 
        wxPGChoices fpLayers;       // footprints might be placed only on F.Cu & B.Cu
        fpLayers.Add( LSET::Name( F_Cu ), F_Cu );
        fpLayers.Add( LSET::Name( B_Cu ), B_Cu );
 
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        REGISTER_TYPE( FOOTPRINT );
        propMgr.AddTypeCast( new TYPE_CAST<FOOTPRINT, BOARD_ITEM> );
        propMgr.AddTypeCast( new TYPE_CAST<FOOTPRINT, BOARD_ITEM_CONTAINER> );
        propMgr.InheritsAfter( TYPE_HASH( FOOTPRINT ), TYPE_HASH( BOARD_ITEM ) );
        propMgr.InheritsAfter( TYPE_HASH( FOOTPRINT ), TYPE_HASH( BOARD_ITEM_CONTAINER ) );
 
        auto isNotFootprintHolder =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( aItem ) )
                    {
                        if( BOARD* board = footprint->GetBoard() )
                            return !board->IsFootprintHolder();
                    }
                    return true;
                };
 
        propMgr.ReplaceProperty( TYPE_HASH( BOARD_ITEM ), _HKI( "Layer" ),
                    new PROPERTY_ENUM<FOOTPRINT, PCB_LAYER_ID>( _HKI( "Layer" ),
                                &FOOTPRINT::SetLayerAndFlip, &FOOTPRINT::GetLayer ) )
                            .SetAvailableFunc( isNotFootprintHolder )
                            .SetChoices( fpLayers );
 
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, double>( _HKI( "Orientation" ),
                    &FOOTPRINT::SetOrientationDegrees, &FOOTPRINT::GetOrientationDegrees,
                    PROPERTY_DISPLAY::PT_DEGREE ) )
               .SetAvailableFunc( isNotFootprintHolder );
 
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, double>( _HKI( "Scale X" ),
                    &FOOTPRINT::SetScaleX, &FOOTPRINT::GetScaleX ) )
                .SetAvailableFunc( isNotFootprintHolder );
 
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, double>( _HKI( "Scale Y" ),
                    &FOOTPRINT::SetScaleY, &FOOTPRINT::GetScaleY ) )
                .SetAvailableFunc( isNotFootprintHolder );
 
        const wxString groupFields = _HKI( "Fields" );
 
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, wxString>( _HKI( "Reference" ),
                    &FOOTPRINT::SetReference, &FOOTPRINT::GetReferenceAsString ),
                    groupFields );
 
        const wxString propertyFields = _HKI( "Footprint Properties" );
 
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, wxString>( _HKI( "Library Link" ),
                    NO_SETTER( FOOTPRINT, wxString ), &FOOTPRINT::GetFPIDAsString ),
                    propertyFields );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, wxString>( _HKI( "Library Description" ),
                    NO_SETTER( FOOTPRINT, wxString ), &FOOTPRINT::GetLibDescription ),
                    propertyFields );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, wxString>( _HKI( "Keywords" ),
                    NO_SETTER( FOOTPRINT, wxString ), &FOOTPRINT::GetKeywords ),
                    propertyFields );
 
        // Note: Also used by DRC engine
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, wxString>( _HKI( "Component Class" ),
                    NO_SETTER( FOOTPRINT, wxString ), &FOOTPRINT::GetComponentClassAsString ),
                    propertyFields )
                .SetIsHiddenFromLibraryEditors();
 
        const wxString groupAttributes = _HKI( "Attributes" );
 
        propMgr.AddProperty( new PROPERTY_ENUM<FOOTPRINT, FOOTPRINT_TYPE>( _HKI( "Footprint Type" ),
                    &FOOTPRINT::SetFootprintType, &FOOTPRINT::GetFootprintType ),
                    groupAttributes );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, bool>( _HKI( "Not in Schematic" ),
                    &FOOTPRINT::SetBoardOnly, &FOOTPRINT::IsBoardOnly ), groupAttributes );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, bool>( _HKI( "Exclude From Position Files" ),
                    &FOOTPRINT::SetExcludedFromPosFiles, &FOOTPRINT::IsExcludedFromPosFiles ),
                    groupAttributes );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, bool>( _HKI( "Exclude From Bill of Materials" ),
                    &FOOTPRINT::SetExcludedFromBOM, &FOOTPRINT::IsExcludedFromBOM ),
                    groupAttributes );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, bool>( _HKI( "Exclude From Simulation" ),
                    &FOOTPRINT::SetExcludedFromSim, &FOOTPRINT::IsExcludedFromSim ),
                    groupAttributes );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, bool>( _HKI( "Do not Populate" ),
                    &FOOTPRINT::SetDNP, &FOOTPRINT::IsDNP ),
                    groupAttributes );
 
        const wxString groupOverrides = _HKI( "Overrides" );
 
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, bool>( _HKI( "Exempt From Courtyard Requirement" ),
                    &FOOTPRINT::SetAllowMissingCourtyard, &FOOTPRINT::AllowMissingCourtyard ),
                    groupOverrides );
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, std::optional<int>>( _HKI( "Clearance Override" ),
                    &FOOTPRINT::SetLocalClearance, &FOOTPRINT::GetLocalClearance, PROPERTY_DISPLAY::PT_SIZE ),
                    groupOverrides ).SetIsCopyable();
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, std::optional<int>>( _HKI( "Solderpaste Margin Override" ),
                    &FOOTPRINT::SetLocalSolderPasteMargin, &FOOTPRINT::GetLocalSolderPasteMargin,
                    PROPERTY_DISPLAY::PT_SIZE ),
                    groupOverrides ).SetIsCopyable();
        propMgr.AddProperty( new PROPERTY<FOOTPRINT, std::optional<double>>( _HKI( "Solderpaste Margin Ratio Override" ),
                    &FOOTPRINT::SetLocalSolderPasteMarginRatio, &FOOTPRINT::GetLocalSolderPasteMarginRatio,
                    PROPERTY_DISPLAY::PT_RATIO ),
                    groupOverrides ).SetIsCopyable();
        propMgr.AddProperty( new PROPERTY_ENUM<FOOTPRINT, ZONE_CONNECTION>( _HKI( "Zone Connection Style" ),
                    &FOOTPRINT::SetLocalZoneConnection, &FOOTPRINT::GetLocalZoneConnection ),
                    groupOverrides ).SetIsCopyable();
    }
} _FOOTPRINT_DESC;
 
ENUM_TO_WXANY( FOOTPRINT_TYPE );