spread_footprints.cpp File Reference

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

#include <algorithm>
#include <convert_to_biu.h>
#include <confirm.h>
#include <pcb_edit_frame.h>
#include <board.h>
#include <footprint.h>
#include <rect_placement/rect_placement.h>

Go to the source code of this file.

Classes
struct	TSubRect

Typedefs
typedef std::vector< TSubRect >	CSubRectArray

Functions
void	fillRectList (CSubRectArray &vecSubRects, std::vector< FOOTPRINT * > &aFootprintList)
void	fillRectList (CSubRectArray &vecSubRects, std::vector< EDA_RECT > &aRectList)
void	spreadRectangles (CRectPlacement &aPlacementArea, CSubRectArray &vecSubRects, int areaSizeX, int areaSizeY)
void	moveFootprintsInArea (CRectPlacement &aPlacementArea, std::vector< FOOTPRINT * > &aFootprintList, EDA_RECT &aFreeArea, bool aFindAreaOnly)
static bool	sortFootprintsbySheetPath (FOOTPRINT *ref, FOOTPRINT *compare)
void	SpreadFootprints (std::vector< FOOTPRINT * > *aFootprints, wxPoint aSpreadAreaPosition)
	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
const int	scale = (int)(0.01 * IU_PER_MM)
const int	PADDING = (int)(1 * 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

CSubRectArray

typedef std::vector<TSubRect> CSubRectArray

Definition at line 58 of file spread_footprints.cpp.

Function Documentation

fillRectList() [1/2]

void fillRectList	(	CSubRectArray &	vecSubRects,
		std::vector< FOOTPRINT * > &	aFootprintList
	)

Definition at line 66 of file spread_footprints.cpp.

{
 vecSubRects.clear();

 for( unsigned ii = 0; ii < aFootprintList.size(); ii++ )
 {
 EDA_RECT fpBox = aFootprintList[ii]->GetBoundingBox( false, false );
 TSubRect fpRect( ( fpBox.GetWidth() + PADDING ) / scale,
 ( fpBox.GetHeight() + PADDING ) / scale, ii );
 vecSubRects.push_back( fpRect );
 }
}

References EDA_RECT::GetHeight(), EDA_RECT::GetWidth(), PADDING, and scale.

Referenced by moveFootprintsInArea(), and SpreadFootprints().

fillRectList() [2/2]

void fillRectList	(	CSubRectArray &	vecSubRects,
		std::vector< EDA_RECT > &	aRectList
	)

Definition at line 80 of file spread_footprints.cpp.

{
 vecSubRects.clear();

 for( unsigned ii = 0; ii < aRectList.size(); ii++ )
 {
 EDA_RECT& rect = aRectList[ii];
 TSubRect fpRect( rect.GetWidth()/scale, rect.GetHeight()/scale, ii );
 vecSubRects.push_back( fpRect );
 }
}

References EDA_RECT::GetHeight(), EDA_RECT::GetWidth(), and scale.

moveFootprintsInArea()

void moveFootprintsInArea	(	CRectPlacement &	aPlacementArea,
		std::vector< FOOTPRINT * > &	aFootprintList,
		EDA_RECT &	aFreeArea,
		bool	aFindAreaOnly
	)

Definition at line 151 of file spread_footprints.cpp.

{
 CSubRectArray vecSubRects;

 fillRectList( vecSubRects, aFootprintList );
 spreadRectangles( aPlacementArea, vecSubRects, aFreeArea.GetWidth(), aFreeArea.GetHeight() );

 if( aFindAreaOnly )
 return;

 for( unsigned it = 0; it < vecSubRects.size(); ++it )
 {
 wxPoint pos( vecSubRects[it].x, vecSubRects[it].y );
 pos.x *= scale;
 pos.y *= scale;

 FOOTPRINT* footprint = aFootprintList[vecSubRects[it].n];

 EDA_RECT fpBBox = footprint->GetBoundingBox( false, false );
 wxPoint mod_pos = pos + ( footprint->GetPosition() - fpBBox.GetOrigin() )
 + aFreeArea.GetOrigin();

 footprint->Move( mod_pos - footprint->GetPosition() );
 }
}

References fillRectList(), FOOTPRINT::GetBoundingBox(), EDA_RECT::GetHeight(), EDA_RECT::GetOrigin(), FOOTPRINT::GetPosition(), EDA_RECT::GetWidth(), FOOTPRINT::Move(), scale, and spreadRectangles().

Referenced by SpreadFootprints().

sortFootprintsbySheetPath()

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

static

Definition at line 339 of file spread_footprints.cpp.

{
 return ref->GetPath() < compare->GetPath();
}

References FOOTPRINT::GetPath().

Referenced by SpreadFootprints().

SpreadFootprints()

void SpreadFootprints	(	std::vector< FOOTPRINT * > *	aFootprints,
		wxPoint	aSpreadAreaPosition
	)

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.
aSpreadAreaPosition	the position of the upper left corner of the area allowed to spread footprints

Definition at line 189 of file spread_footprints.cpp.

{
 // Build candidate list
 // calculate also the area needed by these footprints
 std::vector <FOOTPRINT*> footprintList;

 for( FOOTPRINT* footprint : *aFootprints )
 {
 if( footprint->IsLocked() )
 continue;

 footprintList.push_back( footprint );
 }

 if( footprintList.empty() )
 return;

 // sort footprints by sheet path. we group them later by sheet
 sort( footprintList.begin(), footprintList.end(), sortFootprintsbySheetPath );

 // Extract and place footprints by sheet
 std::vector <FOOTPRINT*> footprintListBySheet;
 std::vector <EDA_RECT> placementSheetAreas;
 double subsurface;
 double placementsurface = 0.0;

 // The placement uses 2 passes:
 // the first pass creates the rectangular areas to place footprints
 // each sheet in schematic creates one rectangular area.
 // the second pass moves footprints inside these areas
 for( int pass = 0; pass < 2; pass++ )
 {
 int subareaIdx = 0;
 footprintListBySheet.clear();
 subsurface = 0.0;

 int fp_max_width = 0;
 int fp_max_height = 0;

 for( unsigned ii = 0; ii < footprintList.size(); ii++ )
 {
 FOOTPRINT* footprint = footprintList[ii];
 bool islastItem = false;

 if( ii == footprintList.size() - 1 ||
 ( footprintList[ii]->GetPath().AsString().BeforeLast( '/' ) !=
 footprintList[ii+1]->GetPath().AsString().BeforeLast( '/' ) ) )
 islastItem = true;

 footprintListBySheet.push_back( footprint );
 subsurface += footprint->GetArea( PADDING );

 // Calculate min size of placement area:
 EDA_RECT bbox = footprint->GetBoundingBox( false, false );
 fp_max_width = std::max( fp_max_width, bbox.GetWidth() );
 fp_max_height = std::max( fp_max_height, bbox.GetHeight() );

 if( islastItem )
 {
 // end of the footprint sublist relative to the same sheet path
 // calculate placement of the current sublist
 EDA_RECT freeArea;
 int Xsize_allowed = (int) ( sqrt( subsurface ) * 4.0 / 3.0 );
 Xsize_allowed = std::max( fp_max_width, Xsize_allowed );

 int Ysize_allowed = (int) ( subsurface / Xsize_allowed );
 Ysize_allowed = std::max( fp_max_height, Ysize_allowed );

 freeArea.SetWidth( Xsize_allowed );
 freeArea.SetHeight( Ysize_allowed );
 CRectPlacement placementArea;

 if( pass == 1 )
 {
 wxPoint areapos = placementSheetAreas[subareaIdx].GetOrigin()
 + aSpreadAreaPosition;
 freeArea.SetOrigin( areapos );
 }

 bool findAreaOnly = pass == 0;
 moveFootprintsInArea( placementArea, footprintListBySheet, freeArea, findAreaOnly );

 if( pass == 0 )
 {
 // Populate sheet placement areas list
 EDA_RECT sub_area;
 sub_area.SetWidth( placementArea.GetW()*scale );
 sub_area.SetHeight( placementArea.GetH()*scale );
 // Add a margin around the sheet placement area:
 sub_area.Inflate( Millimeter2iu( 1.5 ) );

 placementSheetAreas.push_back( sub_area );

 placementsurface += (double) sub_area.GetWidth()*
 sub_area.GetHeight();
 }

 // Prepare buffers for next sheet
 subsurface = 0.0;
 footprintListBySheet.clear();
 subareaIdx++;
 }
 }

 // End of pass:
 // At the end of the first pass, we have to find position of each sheet
 // placement area
 if( pass == 0 )
 {
 int Xsize_allowed = (int) ( sqrt( placementsurface ) * 4.0 / 3.0 );

 if( Xsize_allowed <= 0 || Xsize_allowed > INT_MAX/2 )
 Xsize_allowed = INT_MAX/2;

 int Ysize_allowed = (int) ( placementsurface / Xsize_allowed );

 if( Ysize_allowed <= 0 || Ysize_allowed > INT_MAX/2 )
 Ysize_allowed = INT_MAX/2;

 CRectPlacement placementArea;
 CSubRectArray vecSubRects;
 fillRectList( vecSubRects, placementSheetAreas );
 spreadRectangles( placementArea, vecSubRects, Xsize_allowed, Ysize_allowed );

 for( unsigned it = 0; it < vecSubRects.size(); ++it )
 {
 TSubRect& srect = vecSubRects[it];
 wxPoint pos( srect.x*scale, srect.y*scale );
 wxSize size( srect.w*scale, srect.h*scale );

 // Avoid too large coordinates: Overlapping components
 // are better than out of screen components
 if( (uint64_t)pos.x + (uint64_t)size.x > INT_MAX/2 )
 pos.x = 0;

 if( (uint64_t)pos.y + (uint64_t)size.y > INT_MAX/2 )
 pos.y = 0;

 placementSheetAreas[srect.n].SetOrigin( pos );
 placementSheetAreas[srect.n].SetSize( size );
 }
 }
 } // End pass
}

References fillRectList(), FOOTPRINT::GetArea(), FOOTPRINT::GetBoundingBox(), CRectPlacement::GetH(), EDA_RECT::GetHeight(), CRectPlacement::GetW(), EDA_RECT::GetWidth(), CRectPlacement::TRect::h, EDA_RECT::Inflate(), Millimeter2iu(), moveFootprintsInArea(), TSubRect::n, PADDING, scale, EDA_RECT::SetHeight(), EDA_RECT::SetOrigin(), EDA_RECT::SetWidth(), sortFootprintsbySheetPath(), spreadRectangles(), CRectPlacement::TRect::w, CRectPlacement::TPos::x, and CRectPlacement::TPos::y.

Referenced by PCB_EDIT_FRAME::OnNetlistChanged().

spreadRectangles()

void spreadRectangles	(	CRectPlacement &	aPlacementArea,
		CSubRectArray &	vecSubRects,
		int	areaSizeX,
		int	areaSizeY
	)

Definition at line 95 of file spread_footprints.cpp.

{
 areaSizeX/= scale;
 areaSizeY/= scale;

 // Sort the subRects based on dimensions, larger dimension goes first.
 std::sort( vecSubRects.begin(), vecSubRects.end(), CRectPlacement::TRect::Greater );

 // gives the initial size to the area
 aPlacementArea.Init( areaSizeX, areaSizeY );

 // Add all subrects
 CSubRectArray::iterator it;

 for( it = vecSubRects.begin(); it != vecSubRects.end(); )
 {
 CRectPlacement::TRect r( 0, 0, it->w, it->h );

 bool bPlaced = aPlacementArea.AddAtEmptySpotAutoGrow( &r, areaSizeX, areaSizeY );

 if( !bPlaced ) // No room to place the rectangle: enlarge area and retry
 {
 bool retry = false;

 if( areaSizeX < INT_MAX/2 )
 {
 retry = true;
 areaSizeX = areaSizeX * 1.2;
 }

 if( areaSizeX < INT_MAX/2 )
 {
 retry = true;
 areaSizeY = areaSizeY * 1.2;
 }

 if( retry )
 {
 aPlacementArea.Init( areaSizeX, areaSizeY );
 it = vecSubRects.begin();
 continue;
 }
 }

 // When correctly placed in a placement area, the coords are returned in r.x and r.y
 // Store them.
 it->x = r.x;
 it->y = r.y;

 it++;
 }
}

References CRectPlacement::AddAtEmptySpotAutoGrow(), CRectPlacement::TRect::Greater(), CRectPlacement::Init(), r, and scale.

Referenced by moveFootprintsInArea(), and SpreadFootprints().

Variable Documentation

PADDING

const int PADDING = (int)(1 * IU_PER_MM)

Definition at line 63 of file spread_footprints.cpp.

Referenced by fillRectList(), and SpreadFootprints().

scale

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

Definition at line 61 of file spread_footprints.cpp.

Referenced by ACTION_TOOLBAR::AddScaledSeparator(), Clamp_Text_PenSize(), KIGFX::CAIRO_PRINT_GAL::ComputeWorldScreenMatrix(), KIGFX::GAL::ComputeWorldScreenMatrix(), DIALOG_PLOT_SCHEMATIC::createPSFiles(), EDA_3D_CANVAS::DoRePaint(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), BITMAP_BASE::DrawBitmap(), KIGFX::OPENGL_GAL::DrawBitmap(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), PCB_EDIT_FRAME::Export_IDF3(), fillRectList(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), GENDRILL_WRITER_BASE::genDrillMapFile(), RENDER_3D_OPENGL::generate3dGrid(), DXF_IMPORT_PLUGIN::getCurrentUnitScale(), getEnvironmentScale(), getKiCadConfiguredScale(), DIALOG_PRINT_GENERIC::getScaleValue(), KIUI::GetStatusFont(), idf_export_footprint(), idf_export_outline(), WRL1STATUS::Init(), KiScaledBitmap(), RENDER_3D_RAYTRACE::load3DModels(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), moveFootprintsInArea(), PCB_EDIT_FRAME::OnExportVRML(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onPaintPolyPanel(), DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), DIALOG_IMAGE_EDITOR::OnRedrawPanel(), std::hash< SCALED_BITMAP_ID >::operator()(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), SCENEGRAPH::Prepare(), PCB_EDIT_FRAME::PrepareLayerIndicator(), RENDER_3D_OPENGL::renderFootprint(), KIGFX::VERTEX_MANAGER::Scale(), ZOOM_TOOL::selectRegion(), UNIT_BINDER::setPrecision(), DIALOG_PLOT_SCHEMATIC::setupPlotPagePDF(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), SpreadFootprints(), spreadRectangles(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), DIALOG_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_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().