spread_footprints.cpp File Reference

functions to spread footprints on free areas outside a board. More...

#include <spread_footprints.h>
#include <optional>
#include <algorithm>
#include <refdes_utils.h>
#include <string_utils.h>
#include <confirm.h>
#include <pcb_edit_frame.h>
#include <board.h>
#include <rectpack2d/finders_interface.h>

Go to the source code of this file.

Typedefs
using	spaces_type = rectpack2D::empty_spaces< allow_flip, rectpack2D::default_empty_spaces >
using	rect_type = rectpack2D::output_rect_t< spaces_type >
using	rect_ptr = rect_type *
using	rect_vector = std::vector< rect_type >

Functions
static bool	compareFootprintsbyRef (FOOTPRINT *ref, FOOTPRINT *compare)
std::optional< rectpack2D::rect_wh >	spreadRectangles (rect_vector &vecSubRects, int areaSizeX, int areaSizeY)
void	SpreadFootprints (std::vector< FOOTPRINT * > *aFootprints, VECTOR2I aTargetBoxPosition, bool aGroupBySheet, int aComponentGap, int aGroupGap)
	Footprints (after loaded by reading a netlist for instance) are moved to be in a small free area (outside the current board) without overlapping. More...

Variables
constexpr bool	allow_flip = true
const int	scale = (int) ( 0.01 * pcbIUScale.IU_PER_MM )

Detailed Description

functions to spread footprints on free areas outside a board.

this is useful after reading a netlist, when new footprints are loaded and stacked at 0,0 coordinate. Often, spread them on a free area near the board being edited make more easy their selection.

Definition in file spread_footprints.cpp.

Typedef Documentation

rect_ptr

using rect_ptr = rect_type*

Definition at line 52 of file spread_footprints.cpp.

rect_type

using rect_type = rectpack2D::output_rect_t<spaces_type>

Definition at line 51 of file spread_footprints.cpp.

rect_vector

using rect_vector = std::vector<rect_type>

Definition at line 53 of file spread_footprints.cpp.

spaces_type

using spaces_type = rectpack2D::empty_spaces<allow_flip, rectpack2D::default_empty_spaces>

Definition at line 50 of file spread_footprints.cpp.

Function Documentation

compareFootprintsbyRef()

static bool compareFootprintsbyRef ( FOOTPRINT *  ref, FOOTPRINT *  compare  )

static

Definition at line 59 of file spread_footprints.cpp.

{
 const wxString& refPrefix = UTIL::GetRefDesPrefix( ref->GetReference() );
 const wxString& cmpPrefix = UTIL::GetRefDesPrefix( compare->GetReference() );
 
 if( refPrefix != cmpPrefix )
 {
 return refPrefix < cmpPrefix;
 }
 else
 {
 const int refInt = GetTrailingInt( ref->GetReference() );
 const int cmpInt = GetTrailingInt( compare->GetReference() );
 
 return refInt < cmpInt;
 }
 
 return false;
}

References UTIL::GetRefDesPrefix(), FOOTPRINT::GetReference(), and GetTrailingInt().

Referenced by SpreadFootprints().

SpreadFootprints()

void SpreadFootprints	(	std::vector< FOOTPRINT * > *	aFootprints,
		VECTOR2I	aTargetBoxPosition,
		bool	aGroupBySheet = true,
		int	aComponentGap = pcbIUScale.mmToIU(1),
		int	aGroupGap = pcbIUScale.mmToIU(1.5)
	)

Footprints (after loaded by reading a netlist for instance) are moved to be in a small free area (outside the current board) without overlapping.

Parameters

aBoard	is the board to edit.
aFootprints	a list of footprints to be spread out.
aTargetBoxPosition	the position of the upper left corner of the area allowed to spread footprints

Definition at line 125 of file spread_footprints.cpp.

{
 using FpBBoxToFootprintsPair = std::pair<BOX2I, std::vector<FOOTPRINT*>>;
 using SheetBBoxToFootprintsMapPair =
 std::pair<BOX2I, std::map<VECTOR2I, FpBBoxToFootprintsPair>>;
 
 std::map<wxString, SheetBBoxToFootprintsMapPair> sheetsMap;
 
 // Fill in the maps
 for( FOOTPRINT* footprint : *aFootprints )
 {
 wxString path =
 aGroupBySheet ? footprint->GetPath().AsString().BeforeLast( '/' ) : wxString( wxS( "" ) );
 
 VECTOR2I size = footprint->GetBoundingBox( false, false ).GetSize();
 size.x += aComponentGap;
 size.y += aComponentGap;
 
 sheetsMap[path].second[size].second.push_back( footprint );
 }
 
 for( auto& [sheetPath, sheetPair] : sheetsMap )
 {
 auto& [sheet_bbox, sizeToFpMap] = sheetPair;
 
 for( auto& [fpSize, fpPair] : sizeToFpMap )
 {
 auto& [block_bbox, footprints] = fpPair;
 
 // Find optimal arrangement of same-size footprints
 
 double blockEstimateArea = (double) fpSize.x * fpSize.y * footprints.size();
 double initialSide = std::sqrt( blockEstimateArea );
 bool vertical = fpSize.x >= fpSize.y;
 
 int initialCountPerLine = footprints.size();
 
 const int singleLineRatio = 5;
 
 // Wrap the line if the ratio is not satisfied
 if( vertical )
 {
 if( ( fpSize.y * footprints.size() / fpSize.x ) > singleLineRatio )
 initialCountPerLine = initialSide / fpSize.y;
 }
 else
 {
 if( ( fpSize.x * footprints.size() / fpSize.y ) > singleLineRatio )
 initialCountPerLine = initialSide / fpSize.x;
 }
 
 int optimalCountPerLine = initialCountPerLine;
 int optimalRemainder = footprints.size() % optimalCountPerLine;
 
 if( optimalRemainder != 0 )
 {
 for( int i = std::max( 2, initialCountPerLine - 2 );
 i <= std::min( (int) footprints.size() - 2, initialCountPerLine + 2 ); i++ )
 {
 int r = footprints.size() % i;
 
 if( r == 0 || r >= optimalRemainder )
 {
 optimalCountPerLine = i;
 optimalRemainder = r;
 }
 }
 }
 
 std::sort( footprints.begin(), footprints.end(), compareFootprintsbyRef );
 
 // Arrange footprints in rows or columns (blocks)
 for( unsigned i = 0; i < footprints.size(); i++ )
 {
 FOOTPRINT* footprint = footprints[i];
 
 VECTOR2I position = fpSize / 2;
 
 if( vertical )
 {
 position.x += fpSize.x * ( i / optimalCountPerLine );
 position.y += fpSize.y * ( i % optimalCountPerLine );
 }
 else
 {
 position.x += fpSize.x * ( i % optimalCountPerLine );
 position.y += fpSize.y * ( i / optimalCountPerLine );
 }
 
 BOX2I old_fp_bbox = footprint->GetBoundingBox( false, false );
 footprint->Move( position - old_fp_bbox.GetOrigin() );
 
 BOX2I new_fp_bbox = footprint->GetBoundingBox( false, false );
 new_fp_bbox.Inflate( aComponentGap / 2 );
 block_bbox.Merge( new_fp_bbox );
 }
 }
 
 rect_vector vecSubRects;
 long long blocksArea = 0;
 
 // Fill in arrays for packing of blocks
 for( auto& [fpSize, fpPair] : sizeToFpMap )
 {
 auto& [block_bbox, footprints] = fpPair;
 
 vecSubRects.emplace_back( 0, 0, block_bbox.GetWidth() / scale,
 block_bbox.GetHeight() / scale, false );
 
 blocksArea += block_bbox.GetArea();
 }
 
 // Pack the blocks
 int areaSide = std::sqrt( blocksArea );
 spreadRectangles( vecSubRects, areaSide, areaSide );
 
 unsigned block_i = 0;
 
 // Move footprints to the new block locations
 for( auto& [fpSize, pair] : sizeToFpMap )
 {
 auto& [src_bbox, footprints] = pair;
 
 rect_type srect = vecSubRects[block_i];
 
 VECTOR2I target_pos( srect.x * scale, srect.y * scale );
 VECTOR2I target_size( srect.w * scale, srect.h * scale );
 
 // Avoid too large coordinates: Overlapping components
 // are better than out of screen components
 if( (uint64_t) target_pos.x + (uint64_t) target_size.x > INT_MAX / 2 )
 target_pos.x -= INT_MAX / 2;
 
 if( (uint64_t) target_pos.y + (uint64_t) target_size.y > INT_MAX / 2 )
 target_pos.y -= INT_MAX / 2;
 
 for( FOOTPRINT* footprint : footprints )
 {
 footprint->Move( target_pos - src_bbox.GetPosition() );
 sheet_bbox.Merge( footprint->GetBoundingBox( false, false ) );
 }
 
 block_i++;
 }
 }
 
 rect_vector vecSubRects;
 long long sheetsArea = 0;
 
 // Fill in arrays for packing of hierarchical sheet groups
 for( auto& [sheetPath, sheetPair] : sheetsMap )
 {
 auto& [sheet_bbox, sizeToFpMap] = sheetPair;
 BOX2I rect = sheet_bbox;
 
 // Add a margin around the sheet placement area:
 rect.Inflate( aGroupGap );
 
 vecSubRects.emplace_back( 0, 0, rect.GetWidth() / scale, rect.GetHeight() / scale, false );
 
 sheetsArea += sheet_bbox.GetArea();
 }
 
 // Pack the hierarchical sheet groups
 int areaSide = std::sqrt( sheetsArea );
 spreadRectangles( vecSubRects, areaSide, areaSide );
 
 unsigned srect_i = 0;
 
 // Move footprints to the new hierarchical sheet group locations
 for( auto& [sheetPath, sheetPair] : sheetsMap )
 {
 auto& [src_bbox, sizeToFpMap] = sheetPair;
 
 rect_type srect = vecSubRects[srect_i];
 
 VECTOR2I target_pos( srect.x * scale + aTargetBoxPosition.x,
 srect.y * scale + aTargetBoxPosition.y );
 VECTOR2I target_size( srect.w * scale, srect.h * scale );
 
 // Avoid too large coordinates: Overlapping components
 // are better than out of screen components
 if( (uint64_t) target_pos.x + (uint64_t) target_size.x > INT_MAX / 2 )
 target_pos.x -= INT_MAX / 2;
 
 if( (uint64_t) target_pos.y + (uint64_t) target_size.y > INT_MAX / 2 )
 target_pos.y -= INT_MAX / 2;
 
 for( auto& [fpSize, fpPair] : sizeToFpMap )
 {
 auto& [block_bbox, footprints] = fpPair;
 for( FOOTPRINT* footprint : footprints )
 {
 footprint->Move( target_pos - src_bbox.GetPosition() );
 }
 }
 
 srect_i++;
 }
}

References compareFootprintsbyRef(), BOX2< Vec >::GetArea(), FOOTPRINT::GetBoundingBox(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), BOX2< Vec >::Merge(), FOOTPRINT::Move(), path, scale, spreadRectangles(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_EDIT_FRAME::OnNetlistChanged(), and EDIT_TOOL::PackAndMoveFootprints().

spreadRectangles()

std::optional< rectpack2D::rect_wh > spreadRectangles	(	rect_vector &	vecSubRects,
		int	areaSizeX,
		int	areaSizeY
	)

Definition at line 81 of file spread_footprints.cpp.

{
 areaSizeX /= scale;
 areaSizeY /= scale;
 
 std::optional<rectpack2D::rect_wh> result;
 
 int max_side = std::max( areaSizeX, areaSizeY );
 
 for( int i = 0; i < 2000; i++ )
 {
 bool anyUnsuccessful = false;
 const int discard_step = 1;
 
 auto report_successful = [&]( rect_type& )
 {
 return rectpack2D::callback_result::CONTINUE_PACKING;
 };
 
 auto report_unsuccessful = [&]( rect_type& r )
 {
 anyUnsuccessful = true;
 return rectpack2D::callback_result::ABORT_PACKING;
 };
 
 result = rectpack2D::find_best_packing<spaces_type>(
 vecSubRects,
 make_finder_input( max_side, discard_step, report_successful, report_unsuccessful,
 rectpack2D::flipping_option::DISABLED ) );
 
 if( !result || anyUnsuccessful )
 {
 max_side = (int) ( max_side * 1.2 );
 continue;
 }
 
 break;
 }
 
 return result;
}

References scale.

Referenced by SpreadFootprints().

Variable Documentation

allow_flip

constexpr bool allow_flip = true

constexpr

Definition at line 48 of file spread_footprints.cpp.

scale

const int scale = (int) ( 0.01 * pcbIUScale.IU_PER_MM )

Definition at line 56 of file spread_footprints.cpp.

Referenced by DXF_IMPORT_PLUGIN::addInsert(), ACTION_TOOLBAR::AddScaledSeparator(), GRID_MENU::BuildChoiceList(), Clamp_Text_PenSize(), KIGFX::GAL::ComputeWorldScreenMatrix(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), SCH_PLOTTER::createPSFiles(), EDA_3D_CANVAS::DoRePaint(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), KIGFX::OPENGL_GAL::DrawBitmap(), BITMAP_BASE::DrawBitmap(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), PCB_EDIT_FRAME::Export_IDF3(), PCB_SELECTION_TOOL::FindItem(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), GENDRILL_WRITER_BASE::genDrillMapFile(), RENDER_3D_OPENGL::generate3dGrid(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), DXF_IMPORT_PLUGIN::getCurrentUnitScale(), KIUI::GetDockedPaneFont(), getEnvironmentScale(), getKiCadConfiguredScale(), DIALOG_PRINT_GENERIC::getScaleValue(), KIUI::GetStatusFont(), NL_SCHEMATIC_PLUGIN_IMPL::GetViewExtents(), NL_PCBNEW_PLUGIN_IMPL::GetViewExtents(), idf_export_footprint(), idf_export_outline(), WRL1STATUS::Init(), KiScaledBitmap(), RENDER_3D_RAYTRACE::load3DModels(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), PCB_EDIT_FRAME::OnExportVRML(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onPaintPolyPanel(), DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), PANEL_IMAGE_EDITOR::OnRedrawPanel(), std::hash< SCALED_BITMAP_ID >::operator()(), SCH_PLOTTER::plotOneSheetSVG(), SCENEGRAPH::Prepare(), PCB_EDIT_FRAME::PrepareLayerIndicator(), PCB_EDIT_FRAME::redrawNetnames(), COMMON_TOOLS::Reset(), SCH_SEXPR_PLUGIN::saveBitmap(), KIGFX::VERTEX_MANAGER::Scale(), ZOOM_TOOL::selectRegion(), UNIT_BINDER::setPrecision(), SCH_PLOTTER::setupPlotPagePDF(), NL_SCHEMATIC_PLUGIN_IMPL::SetViewExtents(), NL_PCBNEW_PLUGIN_IMPL::SetViewExtents(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), SpreadFootprints(), spreadRectangles(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), SPICE_VALUE::ToString(), DIALOG_IMPORT_GFX::TransferDataFromWindow(), PANEL_IMAGE_EDITOR::TransferToImage(), DIALOG_PAD_PRIMITIVES_TRANSFORM::Transform(), WRL1TRANSFORM::TranslateToSG(), PANEL_TRACK_WIDTH::TWCalculateCurrent(), PANEL_TRACK_WIDTH::TWCalculateWidth(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().