92 return std::optional<int>();
95 return std::optional<int>( stackup.
GetLayerDistance( aStartLayer, aEndLayer ) );
98 if( !aGenerateNPTH_list )
115 std::max( secondary.
start, secondary.
end ) );
117 if( secondaryPair != aSpan.
Pair() )
126 if( secondary.
size.
x <= 0 && secondary.
size.
y <= 0 )
140 int diameter = secondary.
size.
x;
142 if( secondary.
size.
y > 0 )
143 diameter = ( diameter > 0 ) ? std::min( diameter, secondary.
size.
y )
186 int hole_sz =
via->GetDrillValue();
193 via->LayerPair( &top_layer, &bottom_layer );
248 for(
PAD*
pad : footprint->Pads() )
259 if(
pad->GetDrillSize().x == 0 )
285 &&
pad->GetDrillSizeX() !=
pad->GetDrillSizeY() )
305 bool last_notplated_opt =
false;
381 std::set<DRILL_SPAN> unique;
383 for(
int i = 0; i < vias.
GetCount(); ++i )
389 via->LayerPair( &top_layer, &bottom_layer );
392 unique.emplace( top_layer, bottom_layer,
false,
false );
399 if( secondary.
size.
x <= 0 && secondary.
size.
y <= 0 )
402 unique.emplace( secondary.
start, secondary.
end,
true,
false );
405 std::vector<DRILL_SPAN> ret;
407 ret.emplace_back(
F_Cu,
B_Cu,
false,
false );
412 ret.push_back( span );
431 int ly_id = ( aLayer -
B_Cu ) / 2;
432 return fmt::format(
"in{}", ly_id );
440 std::string ret =
layerName( aPair.first );
449 bool aMerge_PTH_NPTH )
const
457 int conventional_layer_num = 1;
461 if( layer == aLayer )
462 return conventional_layer_num;
464 conventional_layer_num++;
467 return conventional_layer_num;
472 extend.Printf( wxT(
"_Backdrills_Drill_%d_%d" ),
478 extend = wxT(
"-NPTH" );
482 if( !aMerge_PTH_NPTH )
483 extend = wxT(
"-PTH" );
492 wxFileName fn =
m_pcb->GetFileName();
494 fn.SetName( fn.GetName() + extend );
497 wxString ret = fn.GetFullName();
513 extend << wxT(
"-filling-" );
517 extend << wxT(
"-capping-" );
521 extend << wxT(
"-covering-" );
525 extend << wxT(
"-covering-" );
529 extend << wxT(
"-plugging-" );
533 extend << wxT(
"-plugging-" );
537 extend << wxT(
"-tenting-" );
541 extend << wxT(
"-tenting-" );
546 wxFileName fn =
m_pcb->GetFileName();
548 fn.SetName( fn.GetName() + extend );
551 wxString ret = fn.GetFullName();
565 hole_sets.emplace_back(
F_Cu,
B_Cu,
false,
true );
567 for( std::vector<DRILL_SPAN>::const_iterator it = hole_sets.begin(); it != hole_sets.end(); ++it )
577 fn.SetPath( aPlotDirectory );
579 fn.SetExt( wxEmptyString );
580 wxString fullfilename = fn.GetFullPath() + wxT(
"-drl_map" );
589 msg.Printf(
_(
"Failed to create file '%s'." ), fullfilename );
599 msg.Printf(
_(
"Created file '%s'." ), fullfilename );
612 bool aCompatNCdrill )
const
619 text = wxT(
"; #@! " );
623 text << wxT(
"TF.FileFunction," );
626 text << wxT(
"NonPlated," );
628 text << wxT(
"MixedPlating," );
630 text << wxT(
"Plated," );
632 int layer1 = aSpan.
Pair().first;
633 int layer2 = aSpan.
Pair().second;
643 else if( layer1 ==
B_Cu )
644 layer1 =
m_pcb->GetCopperLayerCount();
646 layer1 = ( ( layer1 -
B_Cu ) / 2 ) + 1;
650 else if( layer2 ==
B_Cu )
651 layer2 =
m_pcb->GetCopperLayerCount();
653 layer2 = ( ( layer2 -
B_Cu ) / 2) + 1;
656 if( layer1 > layer2 )
657 std::swap( layer1, layer2 );
659 text << layer1 << wxT(
"," ) << layer2;
663 int bottomlayer =
m_pcb->GetCopperLayerCount();
666 text << wxT(
",Blind" );
668 text << wxT(
",NPTH" );
671 else if( layer1 == toplayer && layer2 == bottomlayer )
672 text << wxT(
",PTH" );
673 else if( layer1 == toplayer || layer2 == bottomlayer )
674 text << wxT(
",Blind" );
676 text << wxT(
",Buried" );
687 bool hasOblong =
false;
688 bool hasDrill =
false;
700 if( hasOblong && hasDrill )
701 text << wxT(
",Mixed" );
703 text << wxT(
",Drill" );
705 text << wxT(
",Rout" );
733 int bestsize = aMarkerDiameter / 10;
735 const double MIN_SIZE_MM = 0.1;
736 bestsize = std::max( bestsize,
pcbIUScale.mmToIU( MIN_SIZE_MM ) );
745 const double SKETCH_LINE_WIDTH_MM = 0.1;
746 return pcbIUScale.mmToIU( SKETCH_LINE_WIDTH_MM );
753 const double DEFAULT_LINE_WIDTH_MM = 0.2;
754 return pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH_MM );
768 int bottom_limit = 0;
776 LSET visibleLayers =
m_pcb->GetVisibleLayers();
778 BOX2I bbbox =
m_pcb->GetBoardEdgesBoundingBox();
779 m_pcb->SetVisibleLayers( visibleLayers );
809 double Xscale = double( pageSizeIU.
x - ( 2 * margin ) ) / bbbox.
GetWidth();
813 int ypagesize_for_board =
KiROUND( pageSizeIU.
y * 0.6 );
814 double Yscale = double( ypagesize_for_board - margin ) / bbbox.
GetHeight();
816 scale = std::min( Xscale, Yscale );
829 bottom_limit = ( pageSizeIU.
y - margin ) / std::min(
scale, 1.0 );
849 plotter = dxf_plotter;
864 if( !plotter->
OpenFile( aFullFileName ) )
887 text =
"%TF.FileFunction,Drillmap*%";
891 text = wxT(
"%TF.FilePolarity,Positive*%" );
909 switch( item->Type() )
927 for(
BOARD_ITEM* item : footprint->GraphicalItems() )
932 switch( item->Type() )
948 int plotX, plotY, TextWidth;
952 int textmarginaftersymbol =
pcbIUScale.mmToIU( 2 );
968 double charScale = std::min( 1.0, 1.0 /
scale );
970 TextWidth =
KiROUND( ( charSize * charScale ) / 10.0 );
971 intervalle =
KiROUND( charSize * charScale ) + TextWidth;
974 plotX =
KiROUND( bbbox.
GetX() + textmarginaftersymbol * charScale );
978 wxString Text = wxT(
"Drill Map:" );
983 attrs.
m_Size =
KiROUND( charSize * charScale, charSize * charScale );
994 int max_line_len = 0;
1003 plotY += intervalle;
1006 if( bottom_limit && ( plotY + intervalle > bottom_limit ) )
1009 plotX += max_line_len +
pcbIUScale.mmToIU( 10 );
1016 plot_diam = std::min( plot_diam,
KiROUND( charSize * charScale ) );
1017 int x =
KiROUND( plotX - textmarginaftersymbol * charScale - plot_diam / 2.0 );
1018 int y =
KiROUND( plotY + charSize * charScale );
1032 extraInfo += wxT(
", castellated" );
1034 extraInfo += wxT(
", press-fit" );
1045 extraInfo += wxString::Format( wxT(
", backdrill stub %.3f-%.3fmm" ), minStub, maxStub );
1049 extraInfo += wxString::Format( wxT(
", backdrill stub %.3fmm" ), minStub );
1054 extraInfo += wxT(
", backdrill" );
1059 extraInfo += wxT(
", post-machined" );
1064 counts.Printf( wxT(
"(1 hole%s)" ), extraInfo );
1066 counts.Printf( wxT(
"(1 slot%s)" ), extraInfo );
1068 counts.Printf( wxT(
"(%d holes%s)" ), tool.
m_TotalCount, extraInfo );
1070 counts.Printf( wxT(
"(%d holes + 1 slot%s)" ), tool.
m_TotalCount - 1, extraInfo );
1078 msg += wxT(
" (not plated)" );
1083 intervalle =
KiROUND( ( ( charSize * charScale ) + TextWidth ) * 1.2 );
1085 if( intervalle < ( plot_diam + ( 1 *
pcbIUScale.IU_PER_MM /
scale ) + TextWidth ) )
1086 intervalle = plot_diam + ( 1 *
pcbIUScale.IU_PER_MM /
scale ) + TextWidth;
1090 int text_len = msg.Len() * ( ( charSize * charScale ) + TextWidth );
1091 max_line_len = std::max( max_line_len, text_len + plot_diam );
1103 wxFFile out( aFullFileName,
"wb" );
1105 if( !out.IsOpened() )
1109 wxString msg = wxString::Format(
_(
"Error creating drill report file '%s'" ),
1117 FILE* outFp = out.fp();
1119 static const char separator[] =
1120 " =============================================================\n";
1124 unsigned totalHoleCount;
1125 wxFileName brdFilename(
m_pcb->GetFileName() );
1129 bool writeError =
false;
1133 fmt::print( outFp,
"Drill report for {}\n",
TO_UTF8( brdFilename.GetFullName() ) );
1137 fmt::print( outFp,
"Copper Layer Stackup:\n" );
1138 fmt::print( outFp,
"{}", separator );
1140 int conventional_layer_num = 1;
1144 fmt::print( outFp,
" L{:<2}: {:<25} {}\n", conventional_layer_num++,
1149 fmt::print( outFp,
"\n\n" );
1157 bool buildNPTHlist =
false;
1160 for(
unsigned pair_ndx = 0; pair_ndx < hole_sets.size(); ++pair_ndx )
1162 const DRILL_SPAN& span = hole_sets[pair_ndx];
1168 fmt::print( outFp,
"Drill file '{}' contains\n",
1171 fmt::print( outFp,
" plated through holes:\n" );
1172 fmt::print( outFp,
"{}", separator );
1174 fmt::print( outFp,
" Total plated holes count {}\n", totalHoleCount );
1178 fmt::print( outFp,
"Drill file '{}' contains\n",
1181 fmt::print( outFp,
" backdrill span: '{}' to '{}':\n",
1185 fmt::print( outFp,
"{}", separator );
1187 fmt::print( outFp,
" Total backdrilled holes count {}\n", totalHoleCount );
1191 fmt::print( outFp,
"Drill file '{}' contains\n",
1194 fmt::print( outFp,
" holes connecting layer pair: '{} and {}' ({} vias):\n",
1197 span.
Pair().first ==
F_Cu || span.
Pair().second ==
B_Cu ?
"blind" :
"buried" );
1199 fmt::print( outFp,
"{}", separator );
1201 fmt::print( outFp,
" Total plated holes count {}\n", totalHoleCount );
1204 fmt::print( outFp,
"\n\n" );
1210 buildNPTHlist =
true;
1218 fmt::print( outFp,
"Not plated through holes are merged with plated holes\n" );
1220 fmt::print( outFp,
"Drill file '{}' contains\n",
1223 fmt::print( outFp,
" unplated through holes:\n" );
1224 fmt::print( outFp,
"{}", separator );
1226 fmt::print( outFp,
" Total unplated holes count {}\n", totalHoleCount );
1228 catch(
const std::system_error& )
1232 catch(
const fmt::format_error& )
1237 if( writeError && aReporter )
1239 wxString msg = wxString::Format(
_(
"Error writing drill report file '%s'" ), aFullFileName );
1275 unsigned totalHoleCount = 0;
1288 int tool_number = ii+1;
1289 fmt::print( 0,
" T{} {:2.3f}mm {:2.4f}\" ", tool_number,
1295 fmt::print( out,
"(1 hole" );
1297 fmt::print( out,
"(1 hole) (with 1 slot" );
1301 fmt::print( out,
"({} holes) (with 1 slot", tool.
m_TotalCount );
1306 fmt::print( out,
", castellated" );
1309 fmt::print( out,
", press-fit" );
1311 fmt::print( out,
")\n" );
1316 fmt::print( out,
"\n" );
1318 return totalHoleCount;
constexpr EDA_IU_SCALE pcbIUScale
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Manage layers needed to make a physical board.
int GetLayerDistance(PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer) const
Calculate the distance (height) between the two given copper layers.
constexpr size_type GetWidth() const
constexpr Vec Centre() const
constexpr coord_type GetX() const
constexpr size_type GetHeight() const
constexpr coord_type GetBottom() const
void SetLayerSet(const LSET &aLayerMask)
void PlotShape(const PCB_SHAPE *aShape)
int GetCount() const
Return the number of objects in the list.
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
void SetUnits(DXF_UNITS aUnit)
Set the units to use for plotting the DXF file.
virtual void SetParentGroup(EDA_GROUP *aGroup)
virtual const wxString getProtectionFileName(const DRILL_SPAN &aSpan, IPC4761_FEATURES aFeature) const
const PAGE_INFO * m_pageInfo
wxString m_drillFileExtension
std::vector< HOLE_INFO > m_holeListBuffer
void buildHolesList(const DRILL_SPAN &aSpan, bool aGenerateNPTH_list)
Create the list of holes and tools for a given board.
bool genDrillMapFile(const wxString &aFullFileName, PLOT_FORMAT aFormat)
Plot a map of drill marks for holes.
VECTOR2I GetOffset()
Return the plot offset (usually the position of the drill/place origin).
std::vector< DRILL_SPAN > getUniqueLayerPairs() const
Get unique layer pairs by examining the micro and blind_buried vias.
std::vector< DRILL_TOOL > m_toolListBuffer
const std::string layerPairName(DRILL_LAYER_PAIR aPair) const
bool CreateMapFilesSet(const wxString &aPlotDirectory, REPORTER *aReporter=nullptr)
Create the full set of map files for the board, in PS, PDF ... format (use SetMapFileFormat() to sele...
const std::string layerName(PCB_LAYER_ID aLayer) const
unsigned printToolSummary(FILE *out, bool aSummaryNPTH) const
Print m_toolListBuffer[] tools to aOut and returns total hole count.
int getHolesCount() const
virtual const wxString getDrillFileName(const DRILL_SPAN &aSpan, bool aNPTH, bool aMerge_PTH_NPTH) const
bool plotDrillMarks(PLOTTER *aPlotter)
Write the drill marks in PDF, POSTSCRIPT or other supported formats/.
const wxString BuildFileFunctionAttributeString(const DRILL_SPAN &aSpan, TYPE_FILE aHoleType, bool aCompatNCdrill=false) const
bool GenDrillReportFile(const wxString &aFullFileName, REPORTER *aReporter=nullptr)
Create a plain text report file giving a list of drill values and drill count for through holes,...
void UseX2format(bool aEnable)
void UseX2NetAttributes(bool aEnable)
void DisableApertMacros(bool aDisable)
Disable Aperture Macro (AM) command, only for broken Gerber Readers.
Handle hole which must be drilled (diameter, position and layers).
int m_FrontPostMachiningDepth
PAD_DRILL_POST_MACHINING_MODE m_FrontPostMachining
PCB_LAYER_ID m_Hole_Bottom_Layer
std::optional< int > m_StubLength
PCB_LAYER_ID m_Hole_Top_Layer
HOLE_ATTRIBUTE m_HoleAttribute
int m_FrontPostMachiningAngle
PCB_LAYER_ID m_DrillStart
BOARD_ITEM * m_ItemParent
int m_BackPostMachiningDepth
int m_BackPostMachiningSize
PAD_DRILL_POST_MACHINING_MODE m_BackPostMachining
int m_FrontPostMachiningSize
int m_BackPostMachiningAngle
static const METRICS & Default()
PCB specific render settings.
void SetDefaultPenWidth(int aWidth)
LSET is a set of PCB_LAYER_IDs.
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Describe the page size and margins of a paper page on which to eventually print or plot.
const VECTOR2D GetSizeIU(double aIUScale) const
Gets the page size in internal units.
Parameters and options when plotting/printing a board.
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
Collect all BOARD_ITEM objects of a given set of KICAD_T type(s).
void Collect(BOARD_ITEM *aBoard, const std::vector< KICAD_T > &aTypes)
Collect BOARD_ITEM objects using this class's Inspector method, which does the collection.
Base plotter engine class.
virtual bool OpenFile(const wxString &aFullFilename)
Open or create the plot file aFullFilename.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)
void SetRenderSettings(RENDER_SETTINGS *aSettings)
static const int USE_DEFAULT_LINE_WIDTH
virtual void ThickOval(const VECTOR2I &aPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, int aWidth, void *aData)
virtual bool StartPlot(const wxString &aPageNumber)=0
virtual void SetGerberCoordinatesFormat(int aResolution, bool aUseInches=false)
virtual PLOT_FORMAT GetPlotterType() const =0
Return the effective plot engine in use.
void Marker(const VECTOR2I &position, int diametre, unsigned aShapeId)
Draw a pattern shape number aShapeId, to coord position.
virtual void SetCreator(const wxString &aCreator)
void ClearHeaderLinesList()
Remove all lines from the list of free lines to print at the beginning of the file.
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror)=0
Set the plot offset and scaling for the current plot.
void AddLineToHeader(const wxString &aExtraString)
Add a line to the list of free lines to print at the beginning of the file.
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
virtual void PlotText(const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const TEXT_ATTRIBUTES &aAttributes, KIFONT::FONT *aFont=nullptr, const KIFONT::METRICS &aFontMetrics=KIFONT::METRICS::Default(), void *aData=nullptr)
A pure virtual class used to derive REPORTER objects from.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Report a string with a given severity.
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Return the default plot extension for a format.
static constexpr EDA_ANGLE ANGLE_0
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
double diameter_in_mm(double ius)
double diameter_in_inches(double ius)
static bool cmpHoleSorting(const HOLE_INFO &a, const HOLE_INFO &b)
static int getMarkerBestPenSize(int aMarkerDiameter)
int getSketchOvalBestPenSize()
helper classes to handle hole info for drill files generators.
#define USE_ATTRIB_FOR_HOLES
std::pair< PCB_LAYER_ID, PCB_LAYER_ID > DRILL_LAYER_PAIR
PCB_LAYER_ID
A quick note on layer IDs:
PCB_LAYER_ID ToLAYER_ID(int aLayer)
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
@ NPTH
like PAD_PTH, but not plated mechanical use only, no connection allowed
@ PRESSFIT
a PTH with a hole diameter with tight tolerances for press fit pin
@ CASTELLATED
a pad with a castellated through hole
void AddGerberX2Header(PLOTTER *aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode)
Calculate some X2 attributes as defined in the Gerber file format specification J4 (chapter 5) and ad...
PLOT_FORMAT
The set of supported output plot formats.
Plotting engines similar to ps (PostScript, Gerber, svg)
std::vector< FAB_LAYER_COLOR > dummy
wxString From_UTF8(const char *cstring)
wxString GetISO8601CurrentDateTime()
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
DRILL_LAYER_PAIR Pair() const
PCB_LAYER_ID DrillEndLayer() const
PCB_LAYER_ID TopLayer() const
PCB_LAYER_ID DrillStartLayer() const
PCB_LAYER_ID BottomLayer() const
! The properties of a padstack drill. Drill position is always the pad position (origin).
VECTOR2I size
Drill diameter (x == y) or slot dimensions (x != y)
std::optional< bool > is_capped
True if the drill hole should be capped.
std::optional< bool > is_filled
True if the drill hole should be filled completely.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
VECTOR2< int32_t > VECTOR2I