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, REPORTER *aReporter)
 
 ~EXPORTER_STEP ()
 
bool Export ()
 

Public Attributes

wxString m_outputFile
 

Private Member Functions

bool buildBoard3DShapes ()
 
bool buildFootprint3DShapes (FOOTPRINT *aFootprint, const VECTOR2D &aOrigin, SHAPE_POLY_SET *aClipPolygon)
 
bool buildTrack3DShape (PCB_TRACK *aTrack, const VECTOR2D &aOrigin)
 
void buildZones3DShape (VECTOR2D aOrigin)
 
bool buildGraphic3DShape (BOARD_ITEM *aItem, const VECTOR2D &aOrigin)
 
void initOutputVariant ()
 
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).
 

Private Attributes

EXPORTER_STEP_PARAMS m_params
 
std::unique_ptr< FILENAME_RESOLVER > m_resolver
 
REPORTER * m_reporter
 
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, std::map< wxString, 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 46 of file exporter_step.h.

Constructor & Destructor Documentation

◆ EXPORTER_STEP()

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

Definition at line 126 of file exporter_step.cpp.

References BOARD::GetFileName(), BOARD::GetProject(), m_board, m_copperColor, m_padColor, m_params, m_pcbBaseName, m_pcbModel, m_platingThickness, m_reporter, m_resolver, pcbIUScale, and Pgm().

◆ ~EXPORTER_STEP()

EXPORTER_STEP::~EXPORTER_STEP ( )

Definition at line 156 of file exporter_step.cpp.

Member Function Documentation

◆ buildBoard3DShapes()

bool EXPORTER_STEP::buildBoard3DShapes ( )
private

Definition at line 1052 of file exporter_step.cpp.

References _, B_Mask, SHAPE_POLY_SET::BooleanSubtract(), buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), buildZones3DShape(), SHAPE_POLY_SET::ClearArcs(), F_Mask, SHAPE_POLY_SET::FullPointCount(), initOutputVariant(), m_board, m_copperColor, m_layersToExport, m_padColor, m_params, m_pcbBaseName, m_pcbModel, m_poly_holes, m_poly_shapes, m_reporter, OCC_MAX_DISTANCE_TO_MERGE_POINTS, pcbIUScale, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, and SHAPE_POLY_SET::Simplify().

Referenced by Export().

◆ buildFootprint3DShapes()

bool EXPORTER_STEP::buildFootprint3DShapes ( FOOTPRINT * aFootprint,
const VECTOR2D & aOrigin,
SHAPE_POLY_SET * aClipPolygon )
private

Definition at line 201 of file exporter_step.cpp.

References _, PADSTACK::POST_MACHINING_PROPS::angle, EDA_ANGLE::AsRadians(), B_Cu, B_Mask, B_SilkS, PADSTACK::BackPostMachining(), CASTELLATED, COUNTERBORE, COUNTERSINK, SHAPE_POLY_SET::CPolygons(), SHAPE_POLY_SET::Deflate(), PADSTACK::POST_MACHINING_PROPS::depth, PADSTACK::DRILL_PROPS::end, ERROR_INSIDE, F_Cu, F_Mask, F_SilkS, PROJECT_PCB::FootprintLibAdapter(), FP_DNP, FP_SMD, FP_THROUGH_HOLE, PADSTACK::FrontPostMachining(), FOOTPRINT::GetAttributes(), FOOTPRINT::GetEmbeddedFiles(), FOOTPRINT::GetFPID(), LIBRARY_MANAGER::GetFullURI(), FOOTPRINT::GetLayer(), LIB_ID::GetLibNickname(), BOARD_ITEM::GetMaxError(), FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), FOOTPRINT::GetReference(), LIBRARY_MANAGER_ADAPTER::GetRow(), IsCopperLayer(), isLayerInBackdrillSpan(), m_board, m_layersToExport, m_params, m_pcbModel, M_PI, m_platingThickness, m_poly_holes, m_poly_shapes, m_reporter, m_resolver, PADSTACK::POST_MACHINING_PROPS::mode, FOOTPRINT::Models(), pad, FOOTPRINT::Pads(), pcbIUScale, PTH, ROUND_ALL_CORNERS, RPT_SEVERITY_WARNING, PADSTACK::SecondaryDrill(), PADSTACK::DRILL_PROPS::size, PADSTACK::POST_MACHINING_PROPS::size, PADSTACK::DRILL_PROPS::start, PADSTACK::TertiaryDrill(), traceKiCad2Step, TransformCircleToPolygon(), FOOTPRINT::TransformFPShapesToPolySet(), SHAPE_SEGMENT::TransformToPolygon(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by buildBoard3DShapes().

◆ buildGraphic3DShape()

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

Definition at line 869 of file exporter_step.cpp.

References B_Mask, ERROR_INSIDE, F_Mask, PCB_PLOT_PARAMS::GetDashedLineDashRatio(), PCB_PLOT_PARAMS::GetDashedLineGapRatio(), EDA_SHAPE::GetHatching(), BOARD_ITEM::GetLayer(), EDA_SHAPE::GetLineStyle(), BOARD_ITEM::GetMaxError(), BOARD_CONNECTED_ITEM::GetNetname(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_SHAPE::GetWidth(), STROKE_PARAMS::GetWidth(), PCB_TEXTBOX::IsBorderEnabled(), IsCopperLayer(), EDA_SHAPE::IsHatchedFill(), IsInnerCopperLayer(), PCB_SHAPE::IsOnLayer(), m_board, m_layersToExport, m_params, m_poly_shapes, EDA_SHAPE::MakeEffectiveShapes(), PCB_BARCODE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, KIGFX::RENDER_SETTINGS::SetDashLengthRatio(), KIGFX::RENDER_SETTINGS::SetGapLengthRatio(), SOLID, STROKE_PARAMS::Stroke(), table, text, PCB_SHAPE::TransformShapeToPolygon(), BOARD_ITEM::TransformShapeToPolySet(), PCB_SHAPE::TransformShapeToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), SHAPE_SEGMENT::TransformToPolygon(), and EDA_ITEM::Type().

Referenced by buildBoard3DShapes().

◆ buildTrack3DShape()

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

Definition at line 604 of file exporter_step.cpp.

References PADSTACK::POST_MACHINING_PROPS::angle, B_Cu, B_Mask, B_SilkS, PADSTACK::BackPostMachining(), COUNTERBORE, COUNTERSINK, SHAPE_POLY_SET::Deflate(), PADSTACK::POST_MACHINING_PROPS::depth, PADSTACK::DRILL_PROPS::end, ERROR_INSIDE, F_Cu, F_Mask, F_SilkS, PADSTACK::FrontPostMachining(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetMaxError(), BOARD_CONNECTED_ITEM::GetNetname(), PCB_TRACK::GetSolderMaskExpansion(), isLayerInBackdrillSpan(), PCB_TRACK::IsOnLayer(), m_layersToExport, m_params, m_pcbModel, m_platingThickness, m_poly_holes, m_poly_shapes, PADSTACK::POST_MACHINING_PROPS::mode, PCB_VIA_T, ROUND_ALL_CORNERS, PADSTACK::SecondaryDrill(), PADSTACK::DRILL_PROPS::size, PADSTACK::POST_MACHINING_PROPS::size, PADSTACK::DRILL_PROPS::start, PADSTACK::TertiaryDrill(), traceKiCad2Step, TransformCircleToPolygon(), PCB_TRACK::TransformShapeToPolygon(), SHAPE_SEGMENT::TransformToPolygon(), EDA_ITEM::Type(), via, and VECTOR2< T >::x.

Referenced by buildBoard3DShapes().

◆ buildZones3DShape()

void EXPORTER_STEP::buildZones3DShape ( VECTOR2D aOrigin)
private

Definition at line 843 of file exporter_step.cpp.

References LSET::AllCuMask(), ADVANCED_CFG::GetCfg(), m_board, m_params, m_poly_shapes, SHAPE_POLY_SET::SimplifyOutlines(), and SHAPE_POLY_SET::Unfracture().

Referenced by buildBoard3DShapes().

◆ Export()

bool EXPORTER_STEP::Export ( )

Definition at line 1177 of file exporter_step.cpp.

References _, B_Mask, B_SilkS, EXPORTER_STEP_PARAMS::BREP, buildBoard3DShapes(), LSET::ExternalCuMask(), F_Mask, F_SilkS, GetRunningMicroSecs(), EXPORTER_STEP_PARAMS::GLB, Handle(), LSET::InternalCuMask(), m_board, m_layersToExport, m_outputFile, m_params, m_pcbModel, m_reporter, EXPORTER_STEP_PARAMS::PDF, EXPORTER_STEP_PARAMS::PLY, RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, EXPORTER_STEP_PARAMS::STEP, EXPORTER_STEP_PARAMS::STEPZ, EXPORTER_STEP_PARAMS::STL, EXPORTER_STEP_PARAMS::U3D, and EXPORTER_STEP_PARAMS::XAO.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ initOutputVariant()

void EXPORTER_STEP::initOutputVariant ( )
private

Definition at line 1003 of file exporter_step.cpp.

References EXPORTER_STEP_PARAMS::BREP, FMT_OUT_BREP, FMT_OUT_GLTF, FMT_OUT_PDF, FMT_OUT_PLY, FMT_OUT_STEP, FMT_OUT_STEPZ, FMT_OUT_STL, FMT_OUT_U3D, FMT_OUT_UNKNOWN, FMT_OUT_XAO, EXPORTER_STEP_PARAMS::GLB, m_params, m_pcbModel, EXPORTER_STEP_PARAMS::PDF, EXPORTER_STEP_PARAMS::PLY, EXPORTER_STEP_PARAMS::STEP, EXPORTER_STEP_PARAMS::STEPZ, EXPORTER_STEP_PARAMS::STL, EXPORTER_STEP_PARAMS::U3D, and EXPORTER_STEP_PARAMS::XAO.

Referenced by buildBoard3DShapes().

◆ isLayerInBackdrillSpan()

bool EXPORTER_STEP::isLayerInBackdrillSpan ( PCB_LAYER_ID aLayer,
PCB_LAYER_ID aStartLayer,
PCB_LAYER_ID aEndLayer ) const
private

Check if a copper layer is within a backdrill layer span (inclusive).

Parameters
aLayerThe layer to check
aStartLayerThe backdrill start layer
aEndLayerThe backdrill end layer
Returns
true if the layer is within the span (inclusive)

Definition at line 161 of file exporter_step.cpp.

References B_Cu, F_Cu, In1_Cu, IsCopperLayer(), IsInnerCopperLayer(), and MAX_CU_LAYERS.

Referenced by buildFootprint3DShapes(), and buildTrack3DShape().

Member Data Documentation

◆ m_board

BOARD* EXPORTER_STEP::m_board
private

Definition at line 80 of file exporter_step.h.

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

◆ m_copperColor

KIGFX::COLOR4D EXPORTER_STEP::m_copperColor
private

Definition at line 93 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_layersToExport

LSET EXPORTER_STEP::m_layersToExport
private

Definition at line 91 of file exporter_step.h.

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

◆ m_outputFile

wxString EXPORTER_STEP::m_outputFile

Definition at line 54 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 94 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_params

EXPORTER_STEP_PARAMS EXPORTER_STEP::m_params
private

Definition at line 74 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 85 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 81 of file exporter_step.h.

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

◆ m_platingThickness

int EXPORTER_STEP::m_platingThickness
private

Definition at line 96 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 89 of file exporter_step.h.

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

◆ m_poly_shapes

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

Definition at line 88 of file exporter_step.h.

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

◆ m_reporter

REPORTER* EXPORTER_STEP::m_reporter
private

Definition at line 78 of file exporter_step.h.

Referenced by buildBoard3DShapes(), buildFootprint3DShapes(), Export(), and EXPORTER_STEP().

◆ m_resolver

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

Definition at line 75 of file exporter_step.h.

Referenced by buildFootprint3DShapes(), and EXPORTER_STEP().

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