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)
 

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_copper_shapes
 
KIGFX::COLOR4D m_solderMaskColor
 
KIGFX::COLOR4D m_copperColor
 

Detailed Description

Definition at line 102 of file exporter_step.h.

Constructor & Destructor Documentation

◆ EXPORTER_STEP()

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

Definition at line 144 of file exporter_step.cpp.

References FILEEXT::AutoSaveFilePrefix, BOARD::GetFileName(), BOARD::GetProject(), m_copperColor, m_pcbBaseName, m_resolver, m_solderMaskColor, and Pgm().

◆ ~EXPORTER_STEP()

EXPORTER_STEP::~EXPORTER_STEP ( )

Definition at line 171 of file exporter_step.cpp.

Member Function Documentation

◆ buildBoard3DShapes()

bool EXPORTER_STEP::buildBoard3DShapes ( )
private

Definition at line 413 of file exporter_step.cpp.

References _, KIGFX::COLOR4D::b, buildFootprint3DShapes(), buildGraphic3DShape(), buildTrack3DShape(), buildZones3DShape(), BOARD::Drawings(), LSET::ExternalCuMask(), BOARD::Footprints(), SHAPE_POLY_SET::FullPointCount(), KIGFX::COLOR4D::g, BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetBoardPolygonOutlines(), BOARD::GetDesignSettings(), BOARD::GetEnabledLayers(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), BOARD::GetStackupOrDefault(), LSET::InternalCuMask(), m_board, m_copperColor, EXPORTER_STEP_PARAMS::m_exportBoardBody, EXPORTER_STEP_PARAMS::m_exportInnerCopper, EXPORTER_STEP_PARAMS::m_exportTracksVias, EXPORTER_STEP_PARAMS::m_exportZones, EXPORTER_STEP_PARAMS::m_fuseShapes, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_netFilter, EXPORTER_STEP_PARAMS::m_origin, m_params, m_pcbBaseName, m_pcbModel, m_poly_copper_shapes, m_solderMaskColor, EXPORTER_STEP_PARAMS::m_useDrillOrigin, EXPORTER_STEP_PARAMS::m_useGridOrigin, OCC_MAX_DISTANCE_TO_MERGE_POINTS, KIGFX::COLOR4D::r, ReportMessage(), LSET::Seq(), and BOARD::Tracks().

Referenced by Export().

◆ buildFootprint3DShapes()

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

Definition at line 176 of file exporter_step.cpp.

References LSET::AllCuMask(), EDA_ANGLE::AsRadians(), B_Cu, SHAPE_POLY_SET::CPolygons(), ERROR_INSIDE, FP_LIB_TABLE::FindRow(), FP_DNP, FP_SMD, FP_THROUGH_HOLE, FOOTPRINT::GetAttributes(), BOARD::GetDesignSettings(), FOOTPRINT::GetFPID(), LIB_TABLE_ROW::GetFullURI(), FOOTPRINT::GetLayer(), BOARD_ITEM::GetLayerSet(), LIB_ID::GetLibNickname(), FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), BOARD::GetProject(), FOOTPRINT::GetReference(), EDA_IU_SCALE::IUTomm(), m_board, EXPORTER_STEP_PARAMS::m_boardOnly, EXPORTER_STEP_PARAMS::m_exportComponents, EXPORTER_STEP_PARAMS::m_exportTracksVias, EXPORTER_STEP_PARAMS::m_includeDNP, EXPORTER_STEP_PARAMS::m_includeUnspecified, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_netFilter, m_params, m_pcbModel, m_poly_copper_shapes, m_resolver, EXPORTER_STEP_PARAMS::m_substModels, FOOTPRINT::Models(), pad, FOOTPRINT::Pads(), PROJECT_PCB::PcbFootprintLibs(), pcbIUScale, ReportMessage(), LSET::Seq(), FOOTPRINT::TransformFPShapesToPolySet(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by buildBoard3DShapes().

◆ buildGraphic3DShape()

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

Definition at line 389 of file exporter_step.cpp.

References ERROR_INSIDE, BOARD::GetDesignSettings(), PCB_SHAPE::GetLayer(), BOARD_CONNECTED_ITEM::GetNetname(), IsCopperLayer(), m_board, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_netFilter, m_params, m_poly_copper_shapes, and PCB_SHAPE::TransformShapeToPolygon().

Referenced by buildBoard3DShapes().

◆ buildTrack3DShape()

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

Definition at line 338 of file exporter_step.cpp.

References ERROR_INSIDE, BOARD::GetDesignSettings(), BOARD_ITEM::GetLayer(), BOARD_CONNECTED_ITEM::GetNetname(), IsCopperLayer(), m_board, BOARD_DESIGN_SETTINGS::m_MaxError, EXPORTER_STEP_PARAMS::m_netFilter, m_params, m_pcbModel, m_poly_copper_shapes, PCB_ARC_T, PCB_VIA_T, PCB_TRACK::TransformShapeToPolygon(), and EDA_ITEM::Type().

Referenced by buildBoard3DShapes().

◆ buildZones3DShape()

void EXPORTER_STEP::buildZones3DShape ( VECTOR2D  aOrigin)
private

Definition at line 367 of file exporter_step.cpp.

References ADVANCED_CFG::GetCfg(), m_board, EXPORTER_STEP_PARAMS::m_netFilter, m_params, m_pcbModel, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, SHAPE_POLY_SET::SimplifyOutlines(), SHAPE_POLY_SET::Unfracture(), and BOARD::Zones().

Referenced by buildBoard3DShapes().

◆ Export()

bool EXPORTER_STEP::Export ( )

Definition at line 508 of file exporter_step.cpp.

References _, EXPORTER_STEP_PARAMS::BREP, buildBoard3DShapes(), EXPORTER_STEP_PARAMS::GetDefaultExportExtension(), BOARD::GetFileName(), EXPORTER_STEP_PARAMS::GetFormatName(), GetRunningMicroSecs(), EXPORTER_STEP_PARAMS::GLB, m_board, m_error, m_fail, EXPORTER_STEP_PARAMS::m_format, EXPORTER_STEP_PARAMS::m_optimizeStep, EXPORTER_STEP_PARAMS::m_outputFile, m_outputFile, m_params, m_pcbModel, m_warn, ReportMessage(), EXPORTER_STEP_PARAMS::STEP, and EXPORTER_STEP_PARAMS::XAO.

Referenced by PCBNEW_JOBS_HANDLER::JobExportStep().

◆ SetError()

void EXPORTER_STEP::SetError ( )
inline

Definition at line 112 of file exporter_step.h.

References m_error.

Referenced by KiCadPrinter::Send().

◆ SetFail()

void EXPORTER_STEP::SetFail ( )
inline

Definition at line 113 of file exporter_step.h.

References m_fail.

Referenced by KiCadPrinter::Send().

◆ SetWarn()

void EXPORTER_STEP::SetWarn ( )
inline

Definition at line 114 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 131 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 141 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_error

bool EXPORTER_STEP::m_error
private

Definition at line 127 of file exporter_step.h.

Referenced by Export(), and SetError().

◆ m_fail

bool EXPORTER_STEP::m_fail
private

Definition at line 128 of file exporter_step.h.

Referenced by Export(), and SetFail().

◆ m_outputFile

wxString EXPORTER_STEP::m_outputFile

Definition at line 110 of file exporter_step.h.

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

◆ m_params

EXPORTER_STEP_PARAMS EXPORTER_STEP::m_params
private

Definition at line 123 of file exporter_step.h.

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

◆ 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 136 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 132 of file exporter_step.h.

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

◆ m_poly_copper_shapes

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

Definition at line 138 of file exporter_step.h.

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

◆ m_resolver

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

Definition at line 124 of file exporter_step.h.

Referenced by buildFootprint3DShapes(), and EXPORTER_STEP().

◆ m_solderMaskColor

KIGFX::COLOR4D EXPORTER_STEP::m_solderMaskColor
private

Definition at line 140 of file exporter_step.h.

Referenced by buildBoard3DShapes(), and EXPORTER_STEP().

◆ m_warn

bool EXPORTER_STEP::m_warn
private

Definition at line 129 of file exporter_step.h.

Referenced by Export(), and SetWarn().

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