54#include <Message_PrinterOStream.hxx>
55#include <Standard_Failure.hxx>
57#include <Standard_Version.hxx>
61#include <wx/tokenzr.h>
64#define OCC_VERSION_MIN 0x070500
66#if OCC_VERSION_HEX < OCC_VERSION_MIN
67#include <Message_Messenger.hxx>
79#if OCC_VERSION_HEX < OCC_VERSION_MIN
80 virtual void Send(
const TCollection_ExtendedString& theString,
81 const Message_Gravity theGravity,
82 const Standard_Boolean theToPutEol )
const override
84 Send( TCollection_AsciiString( theString ), theGravity, theToPutEol );
87 virtual void Send(
const TCollection_AsciiString& theString,
88 const Message_Gravity theGravity,
89 const Standard_Boolean theToPutEol )
const override
91 virtual void send(
const TCollection_AsciiString& theString,
92 const Message_Gravity theGravity )
const override
95 wxString msg( theString.ToCString() );
97#if OCC_VERSION_HEX < OCC_VERSION_MIN
150 m_resolver = std::make_unique<FILENAME_RESOLVER>();
170 if( aLayer == aStartLayer || aLayer == aEndLayer )
189 int startIdx = layerToIndex( aStartLayer );
190 int endIdx = layerToIndex( aEndLayer );
191 int layerIdx = layerToIndex( aLayer );
196 int minIdx = std::min( startIdx, endIdx );
197 int maxIdx = std::max( startIdx, endIdx );
199 return ( layerIdx >= minIdx && layerIdx <= maxIdx );
206 bool hasdata =
false;
207 std::vector<PAD*> padsMatchingNetFilter;
213 std::shared_ptr<SHAPE_SEGMENT> holeShape =
pad->GetEffectiveHoleShape();
216 holeShape->TransformToPolygon( holePoly,
pad->GetMaxError(),
ERROR_INSIDE );
223 if(
pad->IsOnLayer( pcblayer ) )
231 if(
m_pcbModel->AddHole( *holeShape, platingThickness,
F_Cu,
B_Cu,
false, aOrigin,
true,
true ) )
247 if( secondaryDrill.
size.
x > 0 )
250 secondaryDrill.
size.
x );
252 secondaryDrill.
end, aOrigin );
278 if( tertiaryDrill.
size.
x > 0 )
281 tertiaryDrill.
size.
x );
283 tertiaryDrill.
end, aOrigin );
312 wxLogTrace(
traceKiCad2Step, wxT(
"PAD post-machining check: frontPM.mode.has_value=%d frontPM.size=%d frontPM.depth=%d frontPM.angle=%d" ),
314 wxLogTrace(
traceKiCad2Step, wxT(
"PAD post-machining check: backPM.mode.has_value=%d backPM.size=%d backPM.depth=%d backPM.angle=%d" ),
318 bool frontPMValid = frontPM.
mode.has_value() && frontPM.
size > 0 &&
324 wxLogTrace(
traceKiCad2Step, wxT(
"PAD front post-machining: mode=%d (COUNTERBORE=2, COUNTERSINK=3)" ),
325 static_cast<int>( *frontPM.
mode ) );
332 frontPM.
depth,
true, aOrigin );
337 frontPM.
depth, frontPM.
angle,
true, aOrigin );
343 for(
const auto& [layer, diameter] : knockouts )
360 bool backPMValid = backPM.
mode.has_value() && backPM.
size > 0 &&
366 wxLogTrace(
traceKiCad2Step, wxT(
"PAD back post-machining: mode=%d (COUNTERBORE=2, COUNTERSINK=3)" ),
367 static_cast<int>( *backPM.
mode ) );
374 backPM.
depth,
false, aOrigin );
385 for(
const auto& [layer, diameter] : knockouts )
402 if( !
m_params.m_NetFilter.IsEmpty() && !
pad->GetNetname().Matches(
m_params.m_NetFilter ) )
407 if(
m_pcbModel->AddPadShape(
pad, aOrigin,
false, castellated ? aClipPolygon :
nullptr) )
419 pad->TransformShapeToPolygon( poly, cuLayer,
pad->GetSolderMaskExpansion( cuLayer ),
427 padsMatchingNetFilter.push_back(
pad );
449 std::map<const SHAPE_POLY_SET::POLYGON*, PAD*> polyPadMap;
454 for(
PAD*
pad : padsMatchingNetFilter )
456 if( !
pad->IsOnLayer( pcblayer ) )
459 std::shared_ptr<SHAPE_POLY_SET> padPoly =
pad->GetEffectivePolygon( pcblayer );
462 if( padPoly->Collide( &gfxPoly ) )
464 polyPadMap[&poly] =
pad;
476 auto it = polyPadMap.find( &poly );
478 if( it == polyPadMap.end() )
499 wxString footprintBasePath = wxEmptyString;
502 double posY = (aFootprint->
GetPosition().y) - aOrigin.
y;
506 std::optional<LIBRARY_TABLE_ROW*> fpRow =
518 bool componentFilter = !
m_params.m_ComponentFilter.IsEmpty();
519 std::vector<wxString> componentFilterPatterns;
521 if( componentFilter )
523 wxStringTokenizer tokenizer(
m_params.m_ComponentFilter,
", \t\r\n", wxTOKEN_STRTOK );
525 while( tokenizer.HasMoreTokens() )
526 componentFilterPatterns.push_back( tokenizer.GetNextToken() );
530 for(
const wxString& pattern : componentFilterPatterns )
547 if( !fp_model.m_Show || fp_model.m_Filename.empty() )
550 std::vector<wxString> searchedPaths;
551 std::vector<const EMBEDDED_FILES*> embeddedFilesStack;
553 embeddedFilesStack.push_back(
m_board->GetEmbeddedFiles() );
555 wxString mainPath =
m_resolver->ResolvePath( fp_model.m_Filename, footprintBasePath,
556 embeddedFilesStack );
558 if( mainPath.empty() || !wxFileName::FileExists( mainPath ) )
561 if( mainPath.empty() )
562 mainPath = fp_model.m_Filename;
564 m_reporter->Report( wxString::Format(
_(
"Could not add 3D model for %s.\n"
565 "File not found: %s\n" ),
572 fp_model.m_Filename.AfterLast(
'/' ).AfterLast(
'\\' ).BeforeLast(
'.' );
574 std::vector<wxString> altFilenames;
581 const auto& map = filesPtr->EmbeddedFileMap();
583 for(
auto& [fname, file] : map )
585 if( fname.BeforeLast(
'.' ) == baseName )
587 wxFileName temp_file = filesPtr->GetTemporaryFileName( fname );
589 if( !temp_file.IsOk() )
592 wxString altPath = temp_file.GetFullPath();
594 if( mainPath == altPath )
597 altFilenames.emplace_back( altPath );
608 VECTOR3D modelRot = fp_model.m_Rotation;
613 baseName, mainPath, altFilenames, aFootprint->
GetReference(), bottomSide,
615 modelRot, fp_model.m_Scale,
m_params.m_SubstModels ) )
620 catch(
const Standard_Failure& e )
622 m_reporter->Report( wxString::Format(
_(
"Could not add 3D model for %s.\n"
623 "OpenCASCADE error: %s\n" ),
625 e.GetMessageString() ),
637 bool skipCopper = !
m_params.m_ExportTracksVias
638 || ( !
m_params.m_NetFilter.IsEmpty()
659 std::shared_ptr<SHAPE_SEGMENT> holeShape =
via->GetEffectiveHoleShape();
661 holeShape->TransformToPolygon( holePoly,
via->GetMaxError(),
ERROR_INSIDE );
669 via->LayerPair( &top_layer, &bot_layer );
675 const std::shared_ptr<SHAPE>& shape =
via->GetEffectiveShape( pcblayer );
683 m_pcbModel->AddBarrel( *holeShape, top_layer, bot_layer,
true, aOrigin,
via->GetNetname() );
713 if( secondaryDrill.
size.
x > 0 )
716 secondaryDrill.
size.
x );
718 secondaryDrill.
end, aOrigin );
744 if( tertiaryDrill.
size.
x > 0 )
747 tertiaryDrill.
size.
x );
749 tertiaryDrill.
end, aOrigin );
778 wxLogTrace(
traceKiCad2Step, wxT(
"VIA post-machining check: frontPM.mode.has_value=%d frontPM.size=%d frontPM.depth=%d frontPM.angle=%d" ),
780 wxLogTrace(
traceKiCad2Step, wxT(
"VIA post-machining check: backPM.mode.has_value=%d backPM.size=%d backPM.depth=%d backPM.angle=%d" ),
784 bool frontPMValid = frontPM.
mode.has_value() && frontPM.
size > 0 &&
790 wxLogTrace(
traceKiCad2Step, wxT(
"VIA front post-machining: mode=%d (COUNTERBORE=2, COUNTERSINK=3)" ),
791 static_cast<int>( *frontPM.
mode ) );
798 frontPM.
depth,
true, aOrigin );
803 frontPM.
depth, frontPM.
angle,
true, aOrigin );
809 for(
const auto& [layer, diameter] : knockouts )
826 bool backPMValid = backPM.
mode.has_value() && backPM.
size > 0 &&
832 wxLogTrace(
traceKiCad2Step, wxT(
"VIA back post-machining: mode=%d (COUNTERBORE=2, COUNTERSINK=3)" ),
833 static_cast<int>( *backPM.
mode ) );
840 backPM.
depth,
false, aOrigin );
851 for(
const auto& [layer, diameter] : knockouts )
889 LSET layers = zone->GetLayerSet();
893 && !zone->GetNetname().Matches(
m_params.m_NetFilter ) )
900 bool isMaskLayer = ( layer ==
F_Mask || layer ==
B_Mask );
903 if( aSolderMaskOnly && !isMaskLayer )
907 if( !aSolderMaskOnly && isMaskLayer && !
m_params.m_ExportZones )
911 zone->TransformSolidAreasShapesToPolygon( layer, fill_shape );
916 m_poly_shapes[layer][zone->GetNetname()].Append( fill_shape );
936 switch( aItem->
Type() )
964 for(
SHAPE* shape : shapes )
969 SHAPE_SEGMENT seg( a, b, graphic->GetWidth() );
970 seg.TransformToPolygon( m_poly_shapes[pcblayer][graphic->GetNetname()],
971 maxError, ERROR_INSIDE );
975 for(
SHAPE* shape : shapes )
1021 textbox->PCB_SHAPE::TransformShapeToPolygon(
m_poly_shapes[pcblayer][wxEmptyString], pcblayer, 0,
1049 default: wxFAIL_MSG(
"buildGraphic3DShape: unhandled item type" );
1112 if( !
m_board->GetBoardPolygonOutlines( pcbOutlines,
1117 wxLogWarning(
_(
"Board outline is malformed. Run DRC for a full analysis." ) );
1128 origin =
m_board->GetDesignSettings().GetAuxOrigin();
1129 else if(
m_params.m_UseGridOrigin )
1130 origin =
m_board->GetDesignSettings().GetGridOrigin();
1189 poly.SimplifyOutlines(
pcbIUScale.mmToIU( 0.003 ) );
1197 m_pcbModel->AddPolygonShapes( &mask, pcblayer, origin, wxEmptyString );
1205 poly.SimplifyOutlines(
pcbIUScale.mmToIU( 0.003 ) );
1209 poly.BooleanSubtract( holes );
1212 poly.BooleanIntersection( pcbOutlinesNoArcs );
1214 m_pcbModel->AddPolygonShapes( &poly, pcblayer, origin, netname );
1221 m_reporter->Report( wxString::Format( wxT(
"Board outline: found %d initial points.\n" ),
1241 struct SCOPED_PRINTER
1243 Handle( Message_Printer ) m_handle;
1245 SCOPED_PRINTER(
const Handle( Message_Printer ) & aHandle ) : m_handle( aHandle )
1247 Message::DefaultMessenger()->AddPrinter( m_handle );
1250 ~SCOPED_PRINTER() { Message::DefaultMessenger()->RemovePrinter( m_handle ); }
1253 Message::DefaultMessenger()->RemovePrinters( STANDARD_TYPE( Message_PrinterOStream ) );
1258 if(
m_params.m_OutputFile.IsEmpty() )
1260 wxFileName fn =
m_board->GetFileName();
1261 fn.SetName( fn.GetName() );
1262 fn.SetExt(
m_params.GetDefaultExportExtension() );
1264 m_params.m_OutputFile = fn.GetFullName();
1288 m_reporter->Report( wxString::Format( wxT(
"Build %s data.\n" ),
m_params.GetFormatName() ),
1294 "** Error building STEP board model. Export aborted. **\n" ),
1299 m_reporter->Report( wxString::Format( wxT(
"Writing %s file.\n" ),
m_params.GetFormatName() ),
1302 bool success =
true;
1325 "** Error writing %s file. **\n" ),
1332 m_reporter->Report( wxString::Format( wxT(
"%s file '%s' created.\n" ),
1338 catch(
const std::bad_alloc& )
1340 m_reporter->Report( wxString::Format(
_(
"\n** Out of memory while exporting %s file. **\n"
1341 "The board may have too many objects (e.g., vias, tracks, components) "
1342 "to process with available system memory.\n"
1343 "Try disabling 'Fuse Shapes' option, reducing board complexity, "
1344 "or freeing up system memory.\n" ),
1349 catch(
const Standard_Failure& e )
1351 wxString errorMsg = e.GetMessageString();
1352 m_reporter->Report( wxString::Format(
_(
"\nOpenCASCADE error: %s\n" ), errorMsg ),
1356 if( errorMsg.Contains(
"alloc" ) || errorMsg.Contains(
"memory" ) ||
1357 errorMsg.IsEmpty() )
1359 m_reporter->Report(
_(
"This error may indicate insufficient memory. Consider disabling "
1360 "'Fuse Shapes', reducing the number of vias/components, or freeing "
1361 "system memory.\n" ),
1365 m_reporter->Report( wxString::Format(
_(
"** Error exporting %s file. Export aborted. **\n" ),
1373 m_reporter->Report( wxString::Format(
_(
"\n** Unexpected error while exporting %s file. **\n"
1374 "This may be caused by insufficient system memory, especially "
1375 "when exporting boards with many vias or components with 'Fuse Shapes' enabled.\n"
1376 "Try disabling 'Fuse Shapes', reducing board complexity, "
1377 "or freeing up system memory.\n" ),
1387 "Export time %.3f s\n" ),
constexpr EDA_IU_SCALE pcbIUScale
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
wxString GetNetname() const
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
virtual void TransformShapeToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const
Convert the item shape to a polyset.
Information pertinent to a Pcbnew printed circuit board.
const wxString & GetFileName() const
PROJECT * GetProject() const
KICAD_T Type() const
Returns the type of object.
const SHAPE_POLY_SET & GetHatching() const
virtual std::vector< SHAPE * > MakeEffectiveShapes(bool aEdgeOnly=false) const
Make a set of SHAPE objects representing the EDA_SHAPE.
bool IsHatchedFill() const
LINE_STYLE GetLineStyle() const
bool buildTrack3DShape(PCB_TRACK *aTrack, const VECTOR2D &aOrigin)
bool buildFootprint3DShapes(FOOTPRINT *aFootprint, const VECTOR2D &aOrigin, SHAPE_POLY_SET *aClipPolygon)
std::map< PCB_LAYER_ID, SHAPE_POLY_SET > m_poly_holes
bool isLayerInBackdrillSpan(PCB_LAYER_ID aLayer, PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const
Check if a copper layer is within a backdrill layer span (inclusive).
EXPORTER_STEP_PARAMS m_params
wxString m_pcbBaseName
the name of the project (board short filename (no path, no ext) used to identify items in step file
std::unique_ptr< FILENAME_RESOLVER > m_resolver
bool buildBoard3DShapes()
std::unique_ptr< STEP_PCB_MODEL > m_pcbModel
std::map< PCB_LAYER_ID, std::map< wxString, SHAPE_POLY_SET > > m_poly_shapes
KIGFX::COLOR4D m_copperColor
EXPORTER_STEP(BOARD *aBoard, const EXPORTER_STEP_PARAMS &aParams, REPORTER *aReporter)
bool buildGraphic3DShape(BOARD_ITEM *aItem, const VECTOR2D &aOrigin)
KIGFX::COLOR4D m_padColor
void buildZones3DShape(VECTOR2D aOrigin, bool aSolderMaskOnly=false)
virtual void Send(const TCollection_ExtendedString &theString, const Message_Gravity theGravity, const Standard_Boolean theToPutEol) const override
SEVERITY getSeverity(const Message_Gravity theGravity) const
KICAD_PRINTER(REPORTER *aReporter)
virtual void Send(const TCollection_AsciiString &theString, const Message_Gravity theGravity, const Standard_Boolean theToPutEol) const override
A color representation with 4 components: red, green, blue, alpha.
PCB specific render settings.
void SetGapLengthRatio(double aRatio)
void SetDashLengthRatio(double aRatio)
std::optional< LIBRARY_TABLE_ROW * > GetRow(const wxString &aNickname, LIBRARY_TABLE_SCOPE aScope=LIBRARY_TABLE_SCOPE::BOTH) const
Like LIBRARY_MANAGER::GetRow but filtered to the LIBRARY_TABLE_TYPE of this adapter.
std::optional< wxString > GetFullURI(LIBRARY_TABLE_TYPE aType, const wxString &aNickname, bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
LSET is a set of PCB_LAYER_IDs.
static const LSET & ExternalCuMask()
Return a mask holding the Front and Bottom layers.
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
static const LSET & InternalCuMask()
Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.
A PADSTACK defines the characteristics of a single or multi-layer pad, in the IPC sense of the word.
POST_MACHINING_PROPS & FrontPostMachining()
DRILL_PROPS & TertiaryDrill()
DRILL_PROPS & SecondaryDrill()
POST_MACHINING_PROPS & BackPostMachining()
Parameters and options when plotting/printing a board.
double GetDashedLineGapRatio() const
double GetDashedLineDashRatio() const
int GetWidth() const override
int GetSolderMaskExpansion() const
void TransformShapeToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const override
Convert the item shape to a polyset.
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the shape to a closed polygon.
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
bool IsBorderEnabled() const
Disables the border, this is done by changing the stroke internally.
void TransformTextToPolySet(SHAPE_POLY_SET &aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc) const
Function TransformTextToPolySet Convert the text to a polygonSet describing the actual character stro...
int GetSolderMaskExpansion() const
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the track shape to a closed polygon.
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
static FOOTPRINT_LIBRARY_ADAPTER * FootprintLibAdapter(PROJECT *aProject)
A pure virtual class used to derive REPORTER objects from.
Represent a set of closed polygons.
void ClearArcs()
Removes all arc references from all the outlines and holes in the polyset.
int FullPointCount() const
Return the number of points in the shape poly set.
void Simplify()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
std::vector< SHAPE_LINE_CHAIN > POLYGON
represents a single polygon outline with holes.
void Unfracture()
Convert a single outline slitted ("fractured") polygon into a set ouf outlines with holes.
void SimplifyOutlines(int aMaxError=0)
Simplifies the lines in the polyset.
void Deflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError)
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
const std::vector< POLYGON > & CPolygons() const
void TransformToPolygon(SHAPE_POLY_SET &aBuffer, int aError, ERROR_LOC aErrorLoc) const override
Fills a SHAPE_POLY_SET with a polygon representation of this shape.
An abstract shape on 2D plane.
Simple container to manage line stroke parameters.
static void Stroke(const SHAPE *aShape, LINE_STYLE aLineStyle, int aWidth, const KIGFX::RENDER_SETTINGS *aRenderSettings, const std::function< void(const VECTOR2I &a, const VECTOR2I &b)> &aStroker)
Handle a list of polygons defining a copper zone.
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aBuffer, const VECTOR2I &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
@ ROUND_ALL_CORNERS
All angles are rounded.
static const std::string KiCadUriPrefix
const wxChar *const traceKiCad2Step
Flag to enable KiCad2Step debug tracing.
Handle(KICAD3D_INFO) KICAD3D_INFO
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
bool IsInnerCopperLayer(int aLayerId)
Test whether a layer is an inner (In1_Cu to In30_Cu) copper layer.
PCB_LAYER_ID
A quick note on layer IDs:
@ PTH
Plated through hole pad.
@ CASTELLATED
a pad with a castellated through hole
BARCODE class definition.
PGM_BASE & Pgm()
The global program "get" accessor.
int64_t GetRunningMicroSecs()
An alternate way to calculate an elapsed time (in microsecondes) to class PROF_COUNTER.
static constexpr double OCC_MAX_DISTANCE_TO_MERGE_POINTS
Default distance between points to treat them as separate ones (mm) 0.001 mm or less is a reasonable ...
LINE_STYLE
Dashed line types.
! 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< PAD_DRILL_POST_MACHINING_MODE > mode
wxLogTrace helper definitions.
@ 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)
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_BARCODE_T
class PCB_BARCODE, a barcode (graphic item)
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
VECTOR2< int32_t > VECTOR2I
VECTOR2< double > VECTOR2D
VECTOR3< double > VECTOR3D
Definition of file extensions used in Kicad.