KiCad PCB EDA Suite
ADVANCED_CFG Class Reference

Class containing "advanced" configuration options. More...

#include <advanced_config.h>

Static Public Member Functions

static const ADVANCED_CFGGetCfg ()
 Get the singleton instance's config, which is shared by all consumers. More...
 

Public Attributes

double m_DrawArcAccuracy
 Distance from an arc end point and the estimated end point, when rotating from the start point to the end point. More...
 
double m_DrawArcCenterMaxAngle
 When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely high radii. More...
 
double m_MaxTangentAngleDeviation
 Maximum angle between the tangent line of an arc track and a connected straight track in order to commence arc dragging. More...
 
double m_MaxTrackLengthToKeep
 Maximum track length to keep after doing an arc track resizing operation. More...
 
double m_ExtraClearance
 Extra fill clearance for zone fills. More...
 
double m_DRCEpsilon
 Epsilon for DRC tests. More...
 
double m_SliverWidthTolerance
 Sliver tolerances for DRC. More...
 
double m_SliverAngleTolerance
 
double m_HoleWallThickness
 Hole wall plating thickness. More...
 
bool m_RealTimeConnectivity
 Do real-time connectivity. More...
 
int m_CoroutineStackSize
 Set the stack size for coroutines. More...
 
int m_UpdateUIEventInterval
 The update interval the wxWidgets sends wxUpdateUIEvents to windows. More...
 
bool m_ShowRouterDebugGraphics
 Show PNS router debug graphics. More...
 
bool m_CompactSave
 Save files in compact display mode When is is not specified, points are written one per line. More...
 
bool m_DrawTriangulationOutlines
 When true, strokes the triangulations with visible color. More...
 
bool m_ExtraZoneDisplayModes
 When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulation. More...
 
double m_MinPlotPenWidth
 Sets an absolute minimum pen width for plotting. More...
 
bool m_DebugZoneFiller
 A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu. More...
 
bool m_DebugPDFWriter
 A mode that writes PDFs without compression. More...
 
double m_SmallDrillMarkSize
 The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is set to "Small mark". More...
 
bool m_HotkeysDumper
 Enable the hotkeys dumper feature, used for generating documentation. More...
 
bool m_DrawBoundingBoxes
 Draw GAL bounding boxes in painters. More...
 
bool m_ShowPcbnewExportNetlist
 Enable exporting board editor netlist to a file for troubleshooting purposes. More...
 
bool m_Skip3DModelFileCache
 Skip reading/writing 3d model file caches This does not prevent the models from being cached in memory meaning reopening the 3d viewer in the same project session will not reload model data from disk again. More...
 
bool m_Skip3DModelMemoryCache
 Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even if we previously opened the 3d viewer. More...
 
bool m_HideVersionFromTitle
 Hides the build version from the KiCad manager frame title. More...
 
bool m_ShowRepairSchematic
 
bool m_ShowEventCounters
 Shows debugging event counters in various places. More...
 
bool m_AllowManualCanvasScale
 
bool m_ShowPropertiesPanel
 Show the properties panel in PcbNew. More...
 
int m_3DRT_BevelHeight_um
 3D-Viewer, Raytracing Bevel height of layer items. More...
 
double m_3DRT_BevelExtentFactor
 3D-Viewer, Raytracing Factor applied to Extent.z of the item layer, used on calculation of the bevel's height. More...
 

Private Member Functions

 ADVANCED_CFG ()
 
void loadFromConfigFile ()
 Load the config from the normal config file. More...
 
void loadSettings (wxConfigBase &aCfg)
 

Detailed Description

Class containing "advanced" configuration options.

Options set here are for developer or advanced users only. If a general user needs to set one of these for normal KiCad use, either:

  • They are working around some bug that should be fixed, or
  • The parameter they are setting is of general interest and should be in the main application config, with UI provided.

Options in this class are, in general, preferable to #defines, as they allow more flexible configuration by developers, and don't hide code from the compiler on other configurations, which can result in broken builds.

Never use advanced configs in an untestable way. If a function depends on advanced config such that you cannot test it without changing the config, "lift" the config to a higher level and make pass it as parameter of the code under test. The tests can pass their own values as needed.

This also applies to code that does not depend on "common" - it cannot use this class, so you must pass configuration in as proper parameters.

Sometimes you can just use values directly, and sometimes helper functions might be provided to allow extra logic (for example when a advanced config applies only on certain platforms).

For more information on what config keys set these parameters in the config files, and why you might want to set them, see AC_KEYS

Definition at line 58 of file advanced_config.h.

Constructor & Destructor Documentation

◆ ADVANCED_CFG()

ADVANCED_CFG::ADVANCED_CFG ( )
private

Definition at line 279 of file advanced_config.cpp.

280{
281 wxLogTrace( AdvancedConfigMask, "Init advanced config" );
282
283 // Init defaults - this is done in case the config doesn't exist,
284 // then the values will remain as set here.
288 m_DrawArcAccuracy = 10.0;
291 m_MaxTrackLengthToKeep = 0.0005;
294
295 m_ExtraClearance = 0.0005;
296 m_DRCEpsilon = 0.0005; // 0.5um is small enough not to materially violate
297 // any constraints.
300
301 m_HoleWallThickness = 0.020; // IPC-6012 says 15-18um; Cadence says at least
302 // 0.020 for a Class 2 board and at least 0.025
303 // for Class 3.
304
305 m_MinPlotPenWidth = 0.0212; // 1 pixel at 1200dpi.
306
307 m_DebugZoneFiller = false;
308 m_DebugPDFWriter = false;
310 m_HotkeysDumper = false;
311 m_DrawBoundingBoxes = false;
316 m_ShowEventCounters = false;
318 m_CompactSave = false;
320 m_ShowRepairSchematic = false;
321 m_ShowPropertiesPanel = false;
322
324 m_3DRT_BevelExtentFactor = 1.0 / 16.0;
325
327}
static const wxChar AdvancedConfigMask[]
bool m_Skip3DModelFileCache
Skip reading/writing 3d model file caches This does not prevent the models from being cached in memor...
bool m_ShowRepairSchematic
double m_DrawArcCenterMaxAngle
When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely...
double m_MaxTangentAngleDeviation
Maximum angle between the tangent line of an arc track and a connected straight track in order to com...
bool m_ShowRouterDebugGraphics
Show PNS router debug graphics.
bool m_Skip3DModelMemoryCache
Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even...
void loadFromConfigFile()
Load the config from the normal config file.
double m_HoleWallThickness
Hole wall plating thickness.
int m_CoroutineStackSize
Set the stack size for coroutines.
double m_SmallDrillMarkSize
The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is s...
bool m_ShowPropertiesPanel
Show the properties panel in PcbNew.
double m_ExtraClearance
Extra fill clearance for zone fills.
bool m_DrawBoundingBoxes
Draw GAL bounding boxes in painters.
double m_DRCEpsilon
Epsilon for DRC tests.
double m_SliverAngleTolerance
bool m_AllowManualCanvasScale
double m_SliverWidthTolerance
Sliver tolerances for DRC.
bool m_ExtraZoneDisplayModes
When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulati...
double m_MinPlotPenWidth
Sets an absolute minimum pen width for plotting.
double m_MaxTrackLengthToKeep
Maximum track length to keep after doing an arc track resizing operation.
double m_DrawArcAccuracy
Distance from an arc end point and the estimated end point, when rotating from the start point to the...
bool m_HotkeysDumper
Enable the hotkeys dumper feature, used for generating documentation.
int m_UpdateUIEventInterval
The update interval the wxWidgets sends wxUpdateUIEvents to windows.
double m_3DRT_BevelExtentFactor
3D-Viewer, Raytracing Factor applied to Extent.z of the item layer, used on calculation of the bevel'...
bool m_ShowPcbnewExportNetlist
Enable exporting board editor netlist to a file for troubleshooting purposes.
bool m_RealTimeConnectivity
Do real-time connectivity.
bool m_DebugPDFWriter
A mode that writes PDFs without compression.
bool m_ShowEventCounters
Shows debugging event counters in various places.
bool m_DrawTriangulationOutlines
When true, strokes the triangulations with visible color.
int m_3DRT_BevelHeight_um
3D-Viewer, Raytracing Bevel height of layer items.
bool m_CompactSave
Save files in compact display mode When is is not specified, points are written one per line.
bool m_HideVersionFromTitle
Hides the build version from the KiCad manager frame title.
bool m_DebugZoneFiller
A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
static constexpr int default_stack

References AdvancedConfigMask, AC_STACK::default_stack, loadFromConfigFile(), m_3DRT_BevelExtentFactor, m_3DRT_BevelHeight_um, m_AllowManualCanvasScale, m_CompactSave, m_CoroutineStackSize, m_DebugPDFWriter, m_DebugZoneFiller, m_DrawArcAccuracy, m_DrawArcCenterMaxAngle, m_DrawBoundingBoxes, m_DrawTriangulationOutlines, m_DRCEpsilon, m_ExtraClearance, m_ExtraZoneDisplayModes, m_HideVersionFromTitle, m_HoleWallThickness, m_HotkeysDumper, m_MaxTangentAngleDeviation, m_MaxTrackLengthToKeep, m_MinPlotPenWidth, m_RealTimeConnectivity, m_ShowEventCounters, m_ShowPcbnewExportNetlist, m_ShowPropertiesPanel, m_ShowRepairSchematic, m_ShowRouterDebugGraphics, m_Skip3DModelFileCache, m_Skip3DModelMemoryCache, m_SliverAngleTolerance, m_SliverWidthTolerance, m_SmallDrillMarkSize, and m_UpdateUIEventInterval.

Member Function Documentation

◆ GetCfg()

const ADVANCED_CFG & ADVANCED_CFG::GetCfg ( )
static

Get the singleton instance's config, which is shared by all consumers.

This configuration is read-only - to set options, users should add the parameters to their config files at ~/.config/kicad/advanced, or the platform equivalent.

Definition at line 330 of file advanced_config.cpp.

331{
332 static ADVANCED_CFG instance;
333 return instance;
334}
Class containing "advanced" configuration options.

Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_EDITOR_CONTROL::AssignNetclass(), ZONE_FILLER::buildCopperItemClearances(), S3D_CACHE::checkCache(), PDF_PLOTTER::closePdfStream(), COROUTINE< ReturnType, ArgType >::COROUTINE(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), EDIT_TOOL::DragArcTrack(), SCH_EDITOR_CONTROL::DrawSheetOnClipboard(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), EVT_MENU_RANGE(), EVT_UPDATE_UI_RANGE(), PCB_PLUGIN::format(), formatPoly(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), BOARD_DESIGN_SETTINGS::GetHolePlatingThickness(), ROUTER_TOOL::handleCommonEvents(), HOTKEY_STORE::Init(), PGM_BASE::InitPgm(), BOARD_ADAPTER::InitSettings(), PANEL_HOTKEYS_EDITOR::installButtons(), LAYER_ITEM::Intersect(), SCH_EDIT_FRAME::KiwayMailIn(), S3D_CACHE::load(), SCH_EDIT_FRAME::OnModify(), PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS(), SCH_EDITOR_CONTROL::Plot(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotLayerOutlines(), SCH_EDITOR_CONTROL::Print(), KICAD_MANAGER_FRAME::ProjectChanged(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), BOARD_EDITOR_CONTROL::setTransitions(), PCBNEW_PRINTOUT::setupPainter(), PNS_KICAD_IFACE::SetView(), PDF_PLOTTER::startPdfStream(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), BUS_UNFOLD_MENU::update(), ZONE_FILLER::ZONE_FILLER(), and PCB_EDIT_FRAME::~PCB_EDIT_FRAME().

◆ loadFromConfigFile()

void ADVANCED_CFG::loadFromConfigFile ( )
private

Load the config from the normal config file.

Definition at line 337 of file advanced_config.cpp.

338{
339 const wxFileName k_advanced = getAdvancedCfgFilename();
340
341 // If we are running headless, use the class defaults because we cannot instantiate wxConfig
342 if( !wxTheApp )
343 return;
344
345 if( !k_advanced.FileExists() )
346 {
347 wxLogTrace( AdvancedConfigMask, "File does not exist %s", k_advanced.GetFullPath() );
348
349 // load the defaults
350 wxConfig emptyConfig;
351 loadSettings( emptyConfig );
352
353 return;
354 }
355
356 wxLogTrace( AdvancedConfigMask, "Loading advanced config from: %s", k_advanced.GetFullPath() );
357
358 wxFileConfig file_cfg( "", "", k_advanced.GetFullPath() );
359 loadSettings( file_cfg );
360}
static wxFileName getAdvancedCfgFilename()
Get the filename for the advanced config file.
void loadSettings(wxConfigBase &aCfg)

References AdvancedConfigMask, getAdvancedCfgFilename(), and loadSettings().

Referenced by ADVANCED_CFG().

◆ loadSettings()

void ADVANCED_CFG::loadSettings ( wxConfigBase &  aCfg)
private

Definition at line 363 of file advanced_config.cpp.

364{
365 std::vector<PARAM_CFG*> configParams;
366
367 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::RealtimeConnectivity,
369
370 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::ExtraFillMargin,
371 &m_ExtraClearance, m_ExtraClearance, 0.0, 1.0 ) );
372
373 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCEpsilon,
374 &m_DRCEpsilon, m_DRCEpsilon, 0.0, 1.0 ) );
375
376 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCSliverWidthTolerance,
378
379 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCSliverAngleTolerance,
381
382 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::HoleWallThickness,
384
385 configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::CoroutineStackSize,
388
389 configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::UpdateUIEventInterval,
391
392 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRouterDebugGraphics,
394
395 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::CompactFileSave,
397
398 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcAccuracy,
399 &m_DrawArcAccuracy, m_DrawArcAccuracy, 0.0, 100000.0 ) );
400
401 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcCenterStartEndMaxAngle,
403
404 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTangentTrackAngleDeviation,
406
407 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTrackLengthToKeep,
409
410 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ExtraZoneDisplayModes,
412
413 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::StrokeTriangulation,
415
416 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MinPlotPenWidth,
417 &m_MinPlotPenWidth, m_MinPlotPenWidth, 0.0, 1.0 ) );
418
419 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugZoneFiller,
421
422 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugPDFWriter,
424
425 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::SmallDrillMarkSize,
427
428 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HotkeysDumper,
430
431 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DrawBoundingBoxes,
433
434 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowPcbnewExportNetlist,
436
437 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelFileCache,
439
440 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelMemoryCache,
442
443 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HideVersionFromTitle,
445
446 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRepairSchematic,
448
449 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowEventCounters,
451
452 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::AllowManualCanvasScale,
454
455 configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::V3DRT_BevelHeight_um,
457 0, std::numeric_limits<int>::max(),
459
460 configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::V3DRT_BevelExtentFactor,
462 0.0, 100.0,
464
465
466
467 // Special case for trace mask setting...we just grab them and set them immediately
468 // Because we even use wxLogTrace inside of advanced config
469 wxString traceMasks = "";
470 configParams.push_back( new PARAM_CFG_WXSTRING( true, AC_KEYS::TraceMasks, &traceMasks, "" ) );
471
472 configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowPropertiesPanel,
473 &m_ShowPropertiesPanel, false ) );
474
475 // Load the config from file
476 wxConfigLoadSetups( &aCfg, configParams );
477
478 // Now actually set the trace masks
479 wxStringTokenizer traceMaskTokenizer( traceMasks, "," );
480
481 while( traceMaskTokenizer.HasMoreTokens() )
482 {
483 wxString mask = traceMaskTokenizer.GetNextToken();
484 wxLog::AddTraceMask( mask );
485 }
486
487 dumpCfg( configParams );
488
489 for( PARAM_CFG* param : configParams )
490 delete param;
491}
static void dumpCfg(const std::vector< PARAM_CFG * > &aArray)
Dump the configs in the given array to trace.
Configuration object for booleans.
Configuration object for double precision floating point numbers.
Configuration object for integers.
Configuration object for wxString objects.
A base class which establishes the interface functions ReadParam and SaveParam, which are implemented...
Definition: config_params.h:82
void wxConfigLoadSetups(wxConfigBase *aCfg, const std::vector< PARAM_CFG * > &aList)
Use aList of PARAM_CFG object to load configuration values from aCfg.
static const wxChar V3D_RayTracing[]
static const wxChar DebugPDFWriter[]
static const wxChar HotkeysDumper[]
static const wxChar ShowRepairSchematic[]
static const wxChar HideVersionFromTitle[]
static const wxChar ShowPropertiesPanel[]
static const wxChar AllowManualCanvasScale[]
static const wxChar MaxTangentTrackAngleDeviation[]
For arc track interactive drag-resizing Maximum angle between the tangent line of an arc track and a ...
static const wxChar MaxTrackLengthToKeep[]
For arc track interactive drag-resizing Maximum track length to keep after doing an arc track resizin...
static const wxChar ShowPcbnewExportNetlist[]
static const wxChar DrawBoundingBoxes[]
static const wxChar MinPlotPenWidth[]
Absolute minimum pen width to send to the plotter.
static const wxChar CoroutineStackSize[]
Configure the coroutine stack size in bytes.
static const wxChar HoleWallThickness[]
Used to calculate the actual hole size from the finish hole size.
static const wxChar DRCSliverWidthTolerance[]
Angle and width tolerances for copper and solder mask sliver detection.
static const wxChar DebugZoneFiller[]
static const wxChar StrokeTriangulation[]
When true, GAL will stroke the triangulations (only used in OpenGL) with a visible color.
static const wxChar CompactFileSave[]
When set to true, this will wrap polygon point sets at 4 points per line rather than a single point p...
static const wxChar DRCSliverAngleTolerance[]
static const wxChar UpdateUIEventInterval[]
static const wxChar V3DRT_BevelHeight_um[]
static const wxChar RealtimeConnectivity[]
Testing mode for new connectivity algorithm.
static const wxChar ShowRouterDebugGraphics[]
Show PNS router debug graphics while routing.
static const wxChar DRCEpsilon[]
A fudge factor for DRC.
static const wxChar V3DRT_BevelExtentFactor[]
static const wxChar DrawArcAccuracy[]
For drawsegments - arcs.
static const wxChar Skip3DModelMemoryCache[]
static const wxChar ExtraZoneDisplayModes[]
When true, a third zone-display-mode is included which strokes the filled areas and fracture boundari...
static const wxChar Skip3DModelFileCache[]
static const wxChar SmallDrillMarkSize[]
The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is s...
static const wxChar DrawArcCenterStartEndMaxAngle[]
For drawsegments - arcs.
static const wxChar ExtraFillMargin[]
When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors d...
static const wxChar ShowEventCounters[]
static const wxChar TraceMasks[]
static constexpr int min_stack
static constexpr int max_stack

References AC_KEYS::AllowManualCanvasScale, AC_KEYS::CompactFileSave, AC_KEYS::CoroutineStackSize, AC_KEYS::DebugPDFWriter, AC_KEYS::DebugZoneFiller, AC_STACK::default_stack, AC_KEYS::DrawArcAccuracy, AC_KEYS::DrawArcCenterStartEndMaxAngle, AC_KEYS::DrawBoundingBoxes, AC_KEYS::DRCEpsilon, AC_KEYS::DRCSliverAngleTolerance, AC_KEYS::DRCSliverWidthTolerance, dumpCfg(), AC_KEYS::ExtraFillMargin, AC_KEYS::ExtraZoneDisplayModes, AC_KEYS::HideVersionFromTitle, AC_KEYS::HoleWallThickness, AC_KEYS::HotkeysDumper, m_3DRT_BevelExtentFactor, m_3DRT_BevelHeight_um, m_AllowManualCanvasScale, m_CompactSave, m_CoroutineStackSize, m_DebugPDFWriter, m_DebugZoneFiller, m_DrawArcAccuracy, m_DrawArcCenterMaxAngle, m_DrawBoundingBoxes, m_DrawTriangulationOutlines, m_DRCEpsilon, m_ExtraClearance, m_ExtraZoneDisplayModes, m_HideVersionFromTitle, m_HoleWallThickness, m_HotkeysDumper, m_MaxTangentAngleDeviation, m_MaxTrackLengthToKeep, m_MinPlotPenWidth, m_RealTimeConnectivity, m_ShowEventCounters, m_ShowPcbnewExportNetlist, m_ShowPropertiesPanel, m_ShowRepairSchematic, m_ShowRouterDebugGraphics, m_Skip3DModelFileCache, m_Skip3DModelMemoryCache, m_SliverAngleTolerance, m_SliverWidthTolerance, m_SmallDrillMarkSize, m_UpdateUIEventInterval, AC_STACK::max_stack, AC_KEYS::MaxTangentTrackAngleDeviation, AC_KEYS::MaxTrackLengthToKeep, AC_STACK::min_stack, AC_KEYS::MinPlotPenWidth, AC_KEYS::RealtimeConnectivity, AC_KEYS::ShowEventCounters, AC_KEYS::ShowPcbnewExportNetlist, AC_KEYS::ShowPropertiesPanel, AC_KEYS::ShowRepairSchematic, AC_KEYS::ShowRouterDebugGraphics, AC_KEYS::Skip3DModelFileCache, AC_KEYS::Skip3DModelMemoryCache, AC_KEYS::SmallDrillMarkSize, AC_KEYS::StrokeTriangulation, AC_KEYS::TraceMasks, AC_KEYS::UpdateUIEventInterval, AC_GROUPS::V3D_RayTracing, AC_KEYS::V3DRT_BevelExtentFactor, AC_KEYS::V3DRT_BevelHeight_um, and wxConfigLoadSetups().

Referenced by loadFromConfigFile().

Member Data Documentation

◆ m_3DRT_BevelExtentFactor

double ADVANCED_CFG::m_3DRT_BevelExtentFactor

3D-Viewer, Raytracing Factor applied to Extent.z of the item layer, used on calculation of the bevel's height.

Definition at line 239 of file advanced_config.h.

Referenced by ADVANCED_CFG(), LAYER_ITEM::Intersect(), and loadSettings().

◆ m_3DRT_BevelHeight_um

int ADVANCED_CFG::m_3DRT_BevelHeight_um

3D-Viewer, Raytracing Bevel height of layer items.

Controls the start of curvature normal on the edge. Value is in micrometre. Good values should be arround or less than the copper thickness.

Definition at line 233 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_AllowManualCanvasScale

bool ADVANCED_CFG::m_AllowManualCanvasScale

Definition at line 221 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_CompactSave

bool ADVANCED_CFG::m_CompactSave

Save files in compact display mode When is is not specified, points are written one per line.

Definition at line 145 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_CoroutineStackSize

int ADVANCED_CFG::m_CoroutineStackSize

Set the stack size for coroutines.

Definition at line 124 of file advanced_config.h.

Referenced by ADVANCED_CFG(), COROUTINE< ReturnType, ArgType >::COROUTINE(), and loadSettings().

◆ m_DebugPDFWriter

bool ADVANCED_CFG::m_DebugPDFWriter

A mode that writes PDFs without compression.

Definition at line 172 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_DebugZoneFiller

bool ADVANCED_CFG::m_DebugZoneFiller

A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.

Definition at line 167 of file advanced_config.h.

Referenced by ADVANCED_CFG(), loadSettings(), and ZONE_FILLER::ZONE_FILLER().

◆ m_DrawArcAccuracy

double ADVANCED_CFG::m_DrawArcAccuracy

Distance from an arc end point and the estimated end point, when rotating from the start point to the end point.

Definition at line 73 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_DrawArcCenterMaxAngle

double ADVANCED_CFG::m_DrawArcCenterMaxAngle

When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely high radii.

Definition at line 79 of file advanced_config.h.

Referenced by ADVANCED_CFG(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), and loadSettings().

◆ m_DrawBoundingBoxes

bool ADVANCED_CFG::m_DrawBoundingBoxes

Draw GAL bounding boxes in painters.

Definition at line 188 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_DrawTriangulationOutlines

bool ADVANCED_CFG::m_DrawTriangulationOutlines

When true, strokes the triangulations with visible color.

Definition at line 150 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_DRCEpsilon

double ADVANCED_CFG::m_DRCEpsilon

Epsilon for DRC tests.

Note that for zone tests this is essentially additive with m_ExtraClearance. Units are mm.

Definition at line 102 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_ExtraClearance

double ADVANCED_CFG::m_ExtraClearance

Extra fill clearance for zone fills.

Note that for zone tests this is essentially additive with m_DRCEpsilon. Units are mm.

Definition at line 96 of file advanced_config.h.

Referenced by ADVANCED_CFG(), ZONE_FILLER::buildCopperItemClearances(), and loadSettings().

◆ m_ExtraZoneDisplayModes

bool ADVANCED_CFG::m_ExtraZoneDisplayModes

When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulation.

Definition at line 156 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_HideVersionFromTitle

bool ADVANCED_CFG::m_HideVersionFromTitle

Hides the build version from the KiCad manager frame title.

Useful for making screenshots/videos of KiCad without pinning to a specific version.

Definition at line 212 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_HoleWallThickness

double ADVANCED_CFG::m_HoleWallThickness

Hole wall plating thickness.

Used to determine actual hole size from finish hole size. Units are mm.

Definition at line 114 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_HotkeysDumper

bool ADVANCED_CFG::m_HotkeysDumper

Enable the hotkeys dumper feature, used for generating documentation.

Definition at line 183 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_MaxTangentAngleDeviation

double ADVANCED_CFG::m_MaxTangentAngleDeviation

Maximum angle between the tangent line of an arc track and a connected straight track in order to commence arc dragging.

Units are degrees.

Definition at line 85 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_MaxTrackLengthToKeep

double ADVANCED_CFG::m_MaxTrackLengthToKeep

Maximum track length to keep after doing an arc track resizing operation.

Units are mm.

Definition at line 90 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_MinPlotPenWidth

double ADVANCED_CFG::m_MinPlotPenWidth

Sets an absolute minimum pen width for plotting.

Some formats (PDF, for example) don't like ultra-thin lines. Units are mm.

Definition at line 162 of file advanced_config.h.

Referenced by ADVANCED_CFG(), loadSettings(), and KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS().

◆ m_RealTimeConnectivity

bool ADVANCED_CFG::m_RealTimeConnectivity

Do real-time connectivity.

Definition at line 119 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_ShowEventCounters

bool ADVANCED_CFG::m_ShowEventCounters

Shows debugging event counters in various places.

Definition at line 219 of file advanced_config.h.

Referenced by ADVANCED_CFG(), EVT_UPDATE_UI_RANGE(), and loadSettings().

◆ m_ShowPcbnewExportNetlist

bool ADVANCED_CFG::m_ShowPcbnewExportNetlist

Enable exporting board editor netlist to a file for troubleshooting purposes.

Definition at line 193 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_ShowPropertiesPanel

bool ADVANCED_CFG::m_ShowPropertiesPanel

Show the properties panel in PcbNew.

Definition at line 226 of file advanced_config.h.

Referenced by ADVANCED_CFG(), EVT_UPDATE_UI_RANGE(), and loadSettings().

◆ m_ShowRepairSchematic

bool ADVANCED_CFG::m_ShowRepairSchematic

Definition at line 214 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_ShowRouterDebugGraphics

bool ADVANCED_CFG::m_ShowRouterDebugGraphics

Show PNS router debug graphics.

Definition at line 139 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_Skip3DModelFileCache

bool ADVANCED_CFG::m_Skip3DModelFileCache

Skip reading/writing 3d model file caches This does not prevent the models from being cached in memory meaning reopening the 3d viewer in the same project session will not reload model data from disk again.

Definition at line 200 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_Skip3DModelMemoryCache

bool ADVANCED_CFG::m_Skip3DModelMemoryCache

Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even if we previously opened the 3d viewer.

Definition at line 206 of file advanced_config.h.

Referenced by ADVANCED_CFG(), S3D_CACHE::load(), and loadSettings().

◆ m_SliverAngleTolerance

double ADVANCED_CFG::m_SliverAngleTolerance

◆ m_SliverWidthTolerance

double ADVANCED_CFG::m_SliverWidthTolerance

Sliver tolerances for DRC.

Units are mm and deg.

Definition at line 107 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_SmallDrillMarkSize

double ADVANCED_CFG::m_SmallDrillMarkSize

The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is set to "Small mark".

Definition at line 178 of file advanced_config.h.

Referenced by ADVANCED_CFG(), loadSettings(), PlotLayerOutlines(), and PCBNEW_PRINTOUT::setupPainter().

◆ m_UpdateUIEventInterval

int ADVANCED_CFG::m_UpdateUIEventInterval

The update interval the wxWidgets sends wxUpdateUIEvents to windows.

The default is 0. Setting this to -1 will disable all automatic UI events. Any other value is the number of milliseconds between events.

See also
https://docs.wxwidgets.org/3.0/classwx_update_u_i_event.html#a24daac56f682b866baac592e761ccede.

Definition at line 134 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().


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