KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
EXPORTER_STEP Class Reference

#include <exporter_step.h>

Public Member Functions

 EXPORTER_STEP (BOARD *aBoard, const EXPORTER_STEP_PARAMS &aParams)
 
 ~EXPORTER_STEP ()
 
bool Export ()
 
void SetError ()
 
void SetFail ()
 
void SetWarn ()
 

Public Attributes

wxString m_outputFile
 

Private Member Functions

bool buildBoard3DShapes ()
 
bool buildFootprint3DShapes (FOOTPRINT *aFootprint, VECTOR2D aOrigin)
 
bool buildTrack3DShape (PCB_TRACK *aTrack, VECTOR2D aOrigin)
 
void buildZones3DShape (VECTOR2D aOrigin)
 
bool buildGraphic3DShape (BOARD_ITEM *aItem, VECTOR2D aOrigin)
 
void initOutputVariant ()
 

Private Attributes

EXPORTER_STEP_PARAMS m_params
 
std::unique_ptr< FILENAME_RESOLVER > m_resolver
 
bool m_error
 
bool m_fail
 
bool m_warn
 
BOARD * m_board
 
std::unique_ptr< STEP_PCB_MODEL > m_pcbModel
 
wxString m_pcbBaseName
 the name of the project (board short filename (no path, no ext) used to identify items in step file
 
std::map< PCB_LAYER_ID, SHAPE_POLY_SET > m_poly_shapes
 
std::map< PCB_LAYER_ID, SHAPE_POLY_SET > m_poly_holes
 
LSET m_layersToExport
 
KIGFX::COLOR4D m_copperColor
 
KIGFX::COLOR4D m_padColor
 
int m_platingThickness
 

Detailed Description

Definition at line 45 of file exporter_step.h.

Constructor & Destructor Documentation

◆ EXPORTER_STEP()

EXPORTER_STEP::EXPORTER_STEP ( BOARD *  aBoard,
const EXPORTER_STEP_PARAMS &  aParams 
)

Definition at line 119 of file exporter_step.cpp.

References FILEEXT::AutoSaveFilePrefix, BOARD::GetFileName(), BOARD::GetProject(), m_copperColor, EXPORTER_STEP_PARAMS::m_ExportComponents, m_padColor, m_params, m_pcbBaseName, m_platingThickness, m_resolver, EDA_IU_SCALE::mmToIU(), pcbIUScale, and Pgm().

◆ ~EXPORTER_STEP()

EXPORTER_STEP::~EXPORTER_STEP ( )

Definition at line 153 of file exporter_step.cpp.

Member Function Documentation

◆ buildBoard3DShapes()

bool EXPORTER_STEP::buildBoard3DShapes ( )
private

Definition at line 573 of file exporter_step.cpp.

References _, KIGFX::COLOR4D::b, B_Mask, SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), buildZones3DShape(), SHAPE_POLY_SET::ClearArcs(), BOARD::Drawings(), F_Mask, BOARD::Footprints(), SHAPE_POLY_SET::FullPointCount(), KIGFX::COLOR4D::g, BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetBoardPolygonOutlines(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), BOARD::GetStackupOrDefault(), initOutputVariant(), m_board, m_copperColor, EXPORTER_STEP_PARAMS::m_ExportBoardBody, EXPORTER_STEP_PARAMS::m_ExportZones, EXPORTER_STEP_PARAMS::m_FuseShapes, m_layersToExport, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_NetFilter, EXPORTER_STEP_PARAMS::m_Origin, m_padColor, m_params, m_pcbBaseName, m_pcbModel, m_poly_holes, m_poly_shapes, EXPORTER_STEP_PARAMS::m_UseDrillOrigin, EXPORTER_STEP_PARAMS::m_UseGridOrigin, EDA_IU_SCALE::mmToIU(), OCC_MAX_DISTANCE_TO_MERGE_POINTS, pcbIUScale, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, KIGFX::COLOR4D::r, ReportMessage(), LSET::Seq(), SHAPE_POLY_SET::Simplify(), SHAPE_POLY_SET::SimplifyOutlines(), and BOARD::Tracks().

Referenced by Export().

◆ buildFootprint3DShapes()

bool EXPORTER_STEP::buildFootprint3DShapes ( FOOTPRINT *  aFootprint,
VECTOR2D  aOrigin 
)
private

Definition at line 158 of file exporter_step.cpp.

References EDA_ANGLE::AsRadians(), B_Cu, B_Mask, SHAPE_POLY_SET::CPolygons(), ERROR_INSIDE, F_Cu, F_Mask, FP_LIB_TABLE::FindRow(), FP_DNP, FP_SMD, FP_THROUGH_HOLE, FOOTPRINT::GetAttributes(), BOARD::GetDesignSettings(), FOOTPRINT::GetFPID(), LIB_TABLE_ROW::GetFullURI(), FOOTPRINT::GetLayer(), LIB_ID::GetLibNickname(), FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), BOARD::GetProject(), FOOTPRINT::GetReference(), IsCopperLayer(), EDA_IU_SCALE::IUTomm(), m_board, EXPORTER_STEP_PARAMS::m_BoardOnly, EXPORTER_STEP_PARAMS::m_ComponentFilter, EXPORTER_STEP_PARAMS::m_ExportComponents, EXPORTER_STEP_PARAMS::m_ExportPads, EXPORTER_STEP_PARAMS::m_ExportSoldermask, EXPORTER_STEP_PARAMS::m_ExportTracksVias, EXPORTER_STEP_PARAMS::m_IncludeDNP, EXPORTER_STEP_PARAMS::m_IncludeUnspecified, m_layersToExport, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_NetFilter, m_params, m_pcbModel, m_platingThickness, m_poly_holes, m_poly_shapes, m_resolver, EXPORTER_STEP_PARAMS::m_SubstModels, FOOTPRINT::Models(), pad, FOOTPRINT::Pads(), PROJECT_PCB::PcbFootprintLibs(), pcbIUScale, ReportMessage(), LSET::Seq(), FOOTPRINT::TransformFPShapesToPolySet(), SHAPE_POLY_SET::TransformToPolygon(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by buildBoard3DShapes().

◆ buildGraphic3DShape()

bool EXPORTER_STEP::buildGraphic3DShape ( BOARD_ITEM *  aItem,
VECTOR2D  aOrigin 
)
private

Definition at line 476 of file exporter_step.cpp.

References LSET::Contains(), ERROR_INSIDE, BOARD::GetDesignSettings(), BOARD_ITEM::GetLayer(), BOARD_CONNECTED_ITEM::GetNetname(), IsCopperLayer(), IsInnerCopperLayer(), m_board, EXPORTER_STEP_PARAMS::m_ExportInnerCopper, EXPORTER_STEP_PARAMS::m_ExportTracksVias, m_layersToExport, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_NetFilter, m_params, m_poly_shapes, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, text, PCB_SHAPE::TransformShapeToPolygon(), PCB_TEXTBOX::TransformTextToPolySet(), and EDA_ITEM::Type().

Referenced by buildBoard3DShapes().

◆ buildTrack3DShape()

bool EXPORTER_STEP::buildTrack3DShape ( PCB_TRACK *  aTrack,
VECTOR2D  aOrigin 
)
private

Definition at line 387 of file exporter_step.cpp.

References LSET::Contains(), ERROR_INSIDE, BOARD::GetDesignSettings(), BOARD_ITEM::GetLayer(), BOARD_CONNECTED_ITEM::GetNetname(), m_board, EXPORTER_STEP_PARAMS::m_CutViasInBody, EXPORTER_STEP_PARAMS::m_ExportTracksVias, EXPORTER_STEP_PARAMS::m_FillAllVias, m_layersToExport, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_NetFilter, m_params, m_pcbModel, m_platingThickness, m_poly_holes, m_poly_shapes, PCB_VIA_T, LSET::Seq(), PCB_TRACK::TransformShapeToPolygon(), SHAPE_POLY_SET::TransformToPolygon(), EDA_ITEM::Type(), and via.

Referenced by buildBoard3DShapes().

◆ buildZones3DShape()

void EXPORTER_STEP::buildZones3DShape ( VECTOR2D  aOrigin)
private

Definition at line 450 of file exporter_step.cpp.

References LSET::AllCuMask(), ADVANCED_CFG::GetCfg(), m_board, EXPORTER_STEP_PARAMS::m_NetFilter, m_params, m_poly_shapes, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, LSET::Seq(), SHAPE_POLY_SET::SimplifyOutlines(), SHAPE_POLY_SET::Unfracture(), and BOARD::Zones().

Referenced by buildBoard3DShapes().

◆ Export()

bool EXPORTER_STEP::Export ( )

Definition at line 689 of file exporter_step.cpp.

References _, B_Mask, B_SilkS, EXPORTER_STEP_PARAMS::BREP, buildBoard3DShapes(), LSET::ExternalCuMask(), F_Mask, F_SilkS, EXPORTER_STEP_PARAMS::GetDefaultExportExtension(), BOARD::GetEnabledLayers(), BOARD::GetFileName(), EXPORTER_STEP_PARAMS::GetFormatName(), GetRunningMicroSecs(), EXPORTER_STEP_PARAMS::GLB, LSET::InternalCuMask(), m_board, m_error, EXPORTER_STEP_PARAMS::m_ExportInnerCopper, EXPORTER_STEP_PARAMS::m_ExportSilkscreen, EXPORTER_STEP_PARAMS::m_ExportSoldermask, m_fail, EXPORTER_STEP_PARAMS::m_Format, m_layersToExport, EXPORTER_STEP_PARAMS::m_OptimizeStep, EXPORTER_STEP_PARAMS::m_OutputFile, m_outputFile, m_params, m_pcbModel, m_warn, EXPORTER_STEP_PARAMS::PLY, ReportMessage(), BASE_SET::set(), EXPORTER_STEP_PARAMS::STEP, EXPORTER_STEP_PARAMS::STL, and EXPORTER_STEP_PARAMS::XAO.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ initOutputVariant()

void EXPORTER_STEP::initOutputVariant ( )
private

Definition at line 536 of file exporter_step.cpp.

References EXPORTER_STEP_PARAMS::BREP, EXPORTER_STEP_PARAMS::GLB, EXPORTER_STEP_PARAMS::m_Format, m_params, m_pcbModel, EXPORTER_STEP_PARAMS::PLY, EXPORTER_STEP_PARAMS::STEP, EXPORTER_STEP_PARAMS::STL, and EXPORTER_STEP_PARAMS::XAO.

Referenced by buildBoard3DShapes().

◆ SetError()

void EXPORTER_STEP::SetError ( )
inline

Definition at line 55 of file exporter_step.h.

References m_error.

Referenced by KiCadPrinter::Send().

◆ SetFail()

void EXPORTER_STEP::SetFail ( )
inline

Definition at line 56 of file exporter_step.h.

References m_fail.

Referenced by KiCadPrinter::Send().

◆ SetWarn()

void EXPORTER_STEP::SetWarn ( )
inline

Definition at line 57 of file exporter_step.h.

References m_warn.

Referenced by KiCadPrinter::Send().

Member Data Documentation

◆ m_board

BOARD* EXPORTER_STEP::m_board
private

Definition at line 75 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), buildZones3DShape(), and Export().

◆ m_copperColor

KIGFX::COLOR4D EXPORTER_STEP::m_copperColor
private

Definition at line 87 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_error

bool EXPORTER_STEP::m_error
private

Definition at line 71 of file exporter_step.h.

Referenced by Export(), and SetError().

◆ m_fail

bool EXPORTER_STEP::m_fail
private

Definition at line 72 of file exporter_step.h.

Referenced by Export(), and SetFail().

◆ m_layersToExport

LSET EXPORTER_STEP::m_layersToExport
private

Definition at line 85 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), and Export().

◆ m_outputFile

wxString EXPORTER_STEP::m_outputFile

Definition at line 53 of file exporter_step.h.

Referenced by Export(), and PCBNEW_JOBS_HANDLER::JobExportStep().

◆ m_padColor

KIGFX::COLOR4D EXPORTER_STEP::m_padColor
private

Definition at line 88 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_params

EXPORTER_STEP_PARAMS EXPORTER_STEP::m_params
private

Definition at line 67 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), buildZones3DShape(), Export(), EXPORTER_STEP(), and initOutputVariant().

◆ m_pcbBaseName

wxString EXPORTER_STEP::m_pcbBaseName
private

the name of the project (board short filename (no path, no ext) used to identify items in step file

Definition at line 80 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_pcbModel

std::unique_ptr<STEP_PCB_MODEL> EXPORTER_STEP::m_pcbModel
private

Definition at line 76 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), buildTrack3DShape(), Export(), and initOutputVariant().

◆ m_platingThickness

int EXPORTER_STEP::m_platingThickness
private

Definition at line 90 of file exporter_step.h.

Referenced by buildFootprint3DShapes(), buildTrack3DShape(), and EXPORTER_STEP().

◆ m_poly_holes

std::map<PCB_LAYER_ID, SHAPE_POLY_SET> EXPORTER_STEP::m_poly_holes
private

Definition at line 83 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), and buildTrack3DShape().

◆ m_poly_shapes

std::map<PCB_LAYER_ID, SHAPE_POLY_SET> EXPORTER_STEP::m_poly_shapes
private

Definition at line 82 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), and buildZones3DShape().

◆ m_resolver

std::unique_ptr<FILENAME_RESOLVER> EXPORTER_STEP::m_resolver
private

Definition at line 68 of file exporter_step.h.

Referenced by buildFootprint3DShapes(), and EXPORTER_STEP().

◆ m_warn

bool EXPORTER_STEP::m_warn
private

Definition at line 73 of file exporter_step.h.

Referenced by Export(), and SetWarn().

The documentation for this class was generated from the following files: