footprint_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#pragma once
 
#include <functional>
 
#include <wx/string.h>
 
#include <geometry/eda_angle.h>
#include <math/vector2d.h>
#include <pad_utils.h>
 
class BOARD_ITEM;
class FOOTPRINT;
class PAD;
class UNITS_PROVIDER;
 

bool ComputeFootprintShift( const FOOTPRINT& aExisting, const FOOTPRINT& aNew, VECTOR2I& aShift,
                            EDA_ANGLE& aAngleShift );
 
 
namespace FOOTPRINT_UTILS
{
 
using PAD_CHECK_HANDLER = std::function<void( const PAD&, const PAD_UTILS::PAD_CHECK_RESULT& )>;
 

void CheckFootprintAttributes( const FOOTPRINT& aFootprint,
                               const std::function<void( const wxString& )>& aErrorHandler );
 

void CheckPads( const FOOTPRINT& aFootprint, const UNITS_PROVIDER& aUnitsProvider,
                const PAD_CHECK_HANDLER& aErrorHandler );
 

void CheckShortingPads( const FOOTPRINT& aFootprint,
                        const std::function<void( const PAD*, const PAD*, int aErrorCode,
                                                  const VECTOR2I& )>& aErrorHandler );
 

void CheckNetTies( const FOOTPRINT& aFootprint,
                   const std::function<void( const BOARD_ITEM*, const BOARD_ITEM*,
                                             const BOARD_ITEM*, const VECTOR2I& )>& aErrorHandler );
 

void CheckNetTiePadGroups( const FOOTPRINT& aFootprint,
                           const std::function<void( const wxString& )>& aErrorHandler );
 

void CheckClippedSilk( const FOOTPRINT& aFootprint,
                       const std::function<void( BOARD_ITEM*, BOARD_ITEM*,
                                                 const VECTOR2I& )>& aErrorHandler );
 
} // namespace FOOTPRINT_UTILS