KiCad PCB EDA Suite
Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
ADVANCED_CFG Class Reference

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

#include <advanced_config.h>

Static Public Member Functions

static const ADVANCED_CFG & GetCfg ()
 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_HoleWallThickness
 Hole wall plating thickness. More...
 
bool m_RealTimeConnectivity
 Do real-time connectivity. More...
 
int m_CoroutineStackSize
 Set the stack size for coroutines. 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
 

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 257 of file advanced_config.cpp.

258 {
259  wxLogTrace( AdvancedConfigMask, wxT( "Init advanced config" ) );
260 
261  // Init defaults - this is done in case the config doesn't exist,
262  // then the values will remain as set here.
263  m_RealTimeConnectivity = true;
264  m_CoroutineStackSize = AC_STACK::default_stack;
265  m_ShowRouterDebugGraphics = false;
266  m_DrawArcAccuracy = 10.0;
267  m_DrawArcCenterMaxAngle = 50.0;
268  m_MaxTangentAngleDeviation = 1.0;
269  m_MaxTrackLengthToKeep = 0.0005;
270  m_ExtraZoneDisplayModes = false;
271  m_DrawTriangulationOutlines = false;
272 
273  m_ExtraClearance = 0.0005;
274  m_DRCEpsilon = 0.0005; // 0.5um is small enough not to materially violate
275  // any constraints.
276 
277  m_HoleWallThickness = 0.020; // IPC-6012 says 15-18um; Cadence says at least
278  // 0.020 for a Class 2 board and at least 0.025
279  // for Class 3.
280 
281  m_MinPlotPenWidth = 0.0212; // 1 pixel at 1200dpi.
282 
283  m_DebugZoneFiller = false;
284  m_DebugPDFWriter = false;
285  m_SmallDrillMarkSize = 0.35;
286  m_HotkeysDumper = false;
287  m_DrawBoundingBoxes = false;
288  m_ShowPcbnewExportNetlist = false;
289  m_Skip3DModelFileCache = false;
290  m_Skip3DModelMemoryCache = false;
291  m_HideVersionFromTitle = false;
292  m_ShowEventCounters = false;
293  m_AllowManualCanvasScale = false;
294 
295  loadFromConfigFile();
296 }
ADVANCED_CFG::m_ShowEventCounters
bool m_ShowEventCounters
Shows debugging event counters in various places.
Definition: advanced_config.h:203
ADVANCED_CFG::m_HideVersionFromTitle
bool m_HideVersionFromTitle
Hides the build version from the KiCad manager frame title.
Definition: advanced_config.h:196
ADVANCED_CFG::m_DrawTriangulationOutlines
bool m_DrawTriangulationOutlines
When true, strokes the triangulations with visible color.
Definition: advanced_config.h:134
ADVANCED_CFG::m_DrawArcCenterMaxAngle
double m_DrawArcCenterMaxAngle
When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely...
Definition: advanced_config.h:79
ADVANCED_CFG::m_MaxTrackLengthToKeep
double m_MaxTrackLengthToKeep
Maximum track length to keep after doing an arc track resizing operation.
Definition: advanced_config.h:90
ADVANCED_CFG::m_DrawArcAccuracy
double m_DrawArcAccuracy
Distance from an arc end point and the estimated end point, when rotating from the start point to the...
Definition: advanced_config.h:73
ADVANCED_CFG::m_ShowRouterDebugGraphics
bool m_ShowRouterDebugGraphics
Show PNS router debug graphics.
Definition: advanced_config.h:123
ADVANCED_CFG::m_SmallDrillMarkSize
double m_SmallDrillMarkSize
The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is s...
Definition: advanced_config.h:162
ADVANCED_CFG::m_ShowPcbnewExportNetlist
bool m_ShowPcbnewExportNetlist
Enable exporting board editor netlist to a file for troubleshooting purposes.
Definition: advanced_config.h:177
ADVANCED_CFG::m_ExtraZoneDisplayModes
bool m_ExtraZoneDisplayModes
When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulati...
Definition: advanced_config.h:140
ADVANCED_CFG::loadFromConfigFile
void loadFromConfigFile()
Load the config from the normal config file.
Definition: advanced_config.cpp:306
ADVANCED_CFG::m_Skip3DModelMemoryCache
bool m_Skip3DModelMemoryCache
Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even...
Definition: advanced_config.h:190
ADVANCED_CFG::m_ExtraClearance
double m_ExtraClearance
Extra fill clearance for zone fills.
Definition: advanced_config.h:96
ADVANCED_CFG::m_DRCEpsilon
double m_DRCEpsilon
Epsilon for DRC tests.
Definition: advanced_config.h:102
ADVANCED_CFG::m_HotkeysDumper
bool m_HotkeysDumper
Enable the hotkeys dumper feature, used for generating documentation.
Definition: advanced_config.h:167
ADVANCED_CFG::m_MinPlotPenWidth
double m_MinPlotPenWidth
Sets an absolute minimum pen width for plotting.
Definition: advanced_config.h:146
ADVANCED_CFG::m_AllowManualCanvasScale
bool m_AllowManualCanvasScale
Definition: advanced_config.h:205
ADVANCED_CFG::m_MaxTangentAngleDeviation
double m_MaxTangentAngleDeviation
Maximum angle between the tangent line of an arc track and a connected straight track in order to com...
Definition: advanced_config.h:85
ADVANCED_CFG::m_DrawBoundingBoxes
bool m_DrawBoundingBoxes
Draw GAL bounding boxes in painters.
Definition: advanced_config.h:172
ADVANCED_CFG::m_CoroutineStackSize
int m_CoroutineStackSize
Set the stack size for coroutines.
Definition: advanced_config.h:118
ADVANCED_CFG::m_DebugPDFWriter
bool m_DebugPDFWriter
A mode that writes PDFs without compression.
Definition: advanced_config.h:156
AC_STACK::default_stack
static constexpr int default_stack
Definition: advanced_config.cpp:52
ADVANCED_CFG::m_Skip3DModelFileCache
bool m_Skip3DModelFileCache
Skip reading/writing 3d model file caches This does not prevent the models from being cached in memor...
Definition: advanced_config.h:184
ADVANCED_CFG::m_RealTimeConnectivity
bool m_RealTimeConnectivity
Do real-time connectivity.
Definition: advanced_config.h:113
ADVANCED_CFG::m_DebugZoneFiller
bool m_DebugZoneFiller
A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
Definition: advanced_config.h:151
AdvancedConfigMask
static const wxChar AdvancedConfigMask[]
Definition: advanced_config.cpp:42
ADVANCED_CFG::m_HoleWallThickness
double m_HoleWallThickness
Hole wall plating thickness.
Definition: advanced_config.h:108

References AdvancedConfigMask, AC_STACK::default_stack, loadFromConfigFile(), m_AllowManualCanvasScale, 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_ShowRouterDebugGraphics, m_Skip3DModelFileCache, m_Skip3DModelMemoryCache, and m_SmallDrillMarkSize.

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 299 of file advanced_config.cpp.

300 {
301  static ADVANCED_CFG instance;
302  return instance;
303 }
ADVANCED_CFG
Class containing "advanced" configuration options.
Definition: advanced_config.h:58

Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_EDITOR_CONTROL::AssignNetclass(), ZONE_FILLER::buildCopperItemClearances(), S3D_CACHE::checkCache(), PDF_PLOTTER::closePdfStream(), COROUTINE< int, const TOOL_EVENT & >::COROUTINE(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), 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(), ZONE::GetFilledPolysUseThickness(), BOARD_DESIGN_SETTINGS::GetHolePlatingThickness(), ROUTER_TOOL::handleCommonEvents(), SCH_EDITOR_CONTROL::HighlightNetCursor(), HOTKEY_STORE::Init(), PANEL_HOTKEYS_EDITOR::installButtons(), 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(), CONNECTION_GRAPH::Recalculate(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), BOARD_EDITOR_CONTROL::setTransitions(), PCBNEW_PRINTOUT::setupPainter(), PNS_KICAD_IFACE::SetView(), PDF_PLOTTER::startPdfStream(), 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 306 of file advanced_config.cpp.

307 {
308  const wxFileName k_advanced = getAdvancedCfgFilename();
309 
310  // If we are running headless, use the class defaults because we cannot instantiate wxConfig
311  if( !wxTheApp )
312  return;
313 
314  if( !k_advanced.FileExists() )
315  {
316  wxLogTrace( AdvancedConfigMask, wxT( "File does not exist %s" ), k_advanced.GetFullPath() );
317 
318  // load the defaults
319  wxConfig emptyConfig;
320  loadSettings( emptyConfig );
321 
322  return;
323  }
324 
325  wxLogTrace( AdvancedConfigMask, wxT( "Loading advanced config from: %s" ), k_advanced.GetFullPath() );
326 
327  wxFileConfig file_cfg( wxEmptyString, wxEmptyString, k_advanced.GetFullPath() );
328  loadSettings( file_cfg );
329 }
ADVANCED_CFG::loadSettings
void loadSettings(wxConfigBase &aCfg)
Definition: advanced_config.cpp:332
getAdvancedCfgFilename
static wxFileName getAdvancedCfgFilename()
Get the filename for the advanced config file.
Definition: advanced_config.cpp:250
AdvancedConfigMask
static const wxChar AdvancedConfigMask[]
Definition: advanced_config.cpp:42

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

Referenced by ADVANCED_CFG().

◆ loadSettings()

void ADVANCED_CFG::loadSettings ( wxConfigBase &  aCfg)
private

Definition at line 332 of file advanced_config.cpp.

333 {
334  std::vector<PARAM_CFG*> configParams;
335 
336  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::RealtimeConnectivity,
337  &m_RealTimeConnectivity, m_RealTimeConnectivity ) );
338 
339  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::ExtraFillMargin,
340  &m_ExtraClearance, m_ExtraClearance, 0.0, 1.0 ) );
341 
342  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCEpsilon,
343  &m_DRCEpsilon, m_DRCEpsilon, 0.0, 1.0 ) );
344 
345  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::HoleWallThickness,
346  &m_HoleWallThickness, m_HoleWallThickness, 0.0, 1.0 ) );
347 
348  configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::CoroutineStackSize,
349  &m_CoroutineStackSize, AC_STACK::default_stack,
350  AC_STACK::min_stack, AC_STACK::max_stack ) );
351 
352  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRouterDebugGraphics,
353  &m_ShowRouterDebugGraphics, m_ShowRouterDebugGraphics ) );
354 
355  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::CompactFileSave,
356  &m_CompactSave, m_CompactSave ) );
357 
358  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcAccuracy,
359  &m_DrawArcAccuracy, m_DrawArcAccuracy, 0.0, 100000.0 ) );
360 
361  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcCenterStartEndMaxAngle,
362  &m_DrawArcCenterMaxAngle, m_DrawArcCenterMaxAngle, 0.0, 100000.0 ) );
363 
364  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTangentTrackAngleDeviation,
365  &m_MaxTangentAngleDeviation, m_MaxTangentAngleDeviation, 0.0, 90.0 ) );
366 
367  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTrackLengthToKeep,
368  &m_MaxTrackLengthToKeep, m_MaxTrackLengthToKeep, 0.0, 1.0 ) );
369 
370  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ExtraZoneDisplayModes,
371  &m_ExtraZoneDisplayModes, m_ExtraZoneDisplayModes ) );
372 
373  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::StrokeTriangulation,
374  &m_DrawTriangulationOutlines, m_DrawTriangulationOutlines ) );
375 
376  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MinPlotPenWidth,
377  &m_MinPlotPenWidth, m_MinPlotPenWidth, 0.0, 1.0 ) );
378 
379  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugZoneFiller,
380  &m_DebugZoneFiller, m_DebugZoneFiller ) );
381 
382  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugPDFWriter,
383  &m_DebugPDFWriter, m_DebugPDFWriter ) );
384 
385  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::SmallDrillMarkSize,
386  &m_SmallDrillMarkSize, m_SmallDrillMarkSize, 0.0, 3.0 ) );
387 
388  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HotkeysDumper,
389  &m_HotkeysDumper, m_HotkeysDumper ) );
390 
391  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DrawBoundingBoxes,
392  &m_DrawBoundingBoxes, m_DrawBoundingBoxes ) );
393 
394  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowPcbnewExportNetlist,
395  &m_ShowPcbnewExportNetlist, m_ShowPcbnewExportNetlist ) );
396 
397  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelFileCache,
398  &m_Skip3DModelFileCache, m_Skip3DModelFileCache ) );
399 
400  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelMemoryCache,
401  &m_Skip3DModelMemoryCache, m_Skip3DModelMemoryCache ) );
402 
403  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HideVersionFromTitle,
404  &m_HideVersionFromTitle, m_HideVersionFromTitle ) );
405 
406  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRepairSchematic,
407  &m_ShowRepairSchematic, m_ShowRepairSchematic ) );
408 
409  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowEventCounters,
410  &m_ShowEventCounters, m_ShowEventCounters ) );
411 
412  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::AllowManualCanvasScale,
413  &m_AllowManualCanvasScale, m_AllowManualCanvasScale ) );
414 
415  // Special case for trace mask setting...we just grab them and set them immediately
416  // Because we even use wxLogTrace inside of advanced config
417  wxString traceMasks = wxEmptyString;
418  configParams.push_back( new PARAM_CFG_WXSTRING( true, AC_KEYS::TraceMasks, &traceMasks, wxEmptyString ) );
419 
420  // Load the config from file
421  wxConfigLoadSetups( &aCfg, configParams );
422 
423  // Now actually set the trace masks
424  wxStringTokenizer traceMaskTokenizer( traceMasks, wxT( "," ) );
425 
426  while( traceMaskTokenizer.HasMoreTokens() )
427  {
428  wxString mask = traceMaskTokenizer.GetNextToken();
429  wxLog::AddTraceMask( mask );
430  }
431 
432  dumpCfg( configParams );
433 
434  for( PARAM_CFG* param : configParams )
435  delete param;
436 }
AC_KEYS::Skip3DModelFileCache
static const wxChar Skip3DModelFileCache[]
Definition: advanced_config.cpp:172
ADVANCED_CFG::m_ShowEventCounters
bool m_ShowEventCounters
Shows debugging event counters in various places.
Definition: advanced_config.h:203
ADVANCED_CFG::m_HideVersionFromTitle
bool m_HideVersionFromTitle
Hides the build version from the KiCad manager frame title.
Definition: advanced_config.h:196
ADVANCED_CFG::m_CompactSave
bool m_CompactSave
Save files in compact display mode When is is not specified, points are written one per line.
Definition: advanced_config.h:129
wxConfigLoadSetups
void wxConfigLoadSetups(wxConfigBase *aCfg, const std::vector< PARAM_CFG * > &aList)
Use aList of PARAM_CFG object to load configuration values from aCfg.
Definition: config_params.cpp:54
AC_KEYS::DrawArcAccuracy
static const wxChar DrawArcAccuracy[]
For drawsegments - arcs.
Definition: advanced_config.cpp:116
AC_KEYS::HoleWallThickness
static const wxChar HoleWallThickness[]
Used to calculate the actual hole size from the finish hole size.
Definition: advanced_config.cpp:83
AC_KEYS::ShowEventCounters
static const wxChar ShowEventCounters[]
Definition: advanced_config.cpp:182
PARAM_CFG_DOUBLE
Configuration object for double precision floating point numbers.
Definition: config_params.h:170
ADVANCED_CFG::m_DrawTriangulationOutlines
bool m_DrawTriangulationOutlines
When true, strokes the triangulations with visible color.
Definition: advanced_config.h:134
AC_KEYS::MaxTrackLengthToKeep
static const wxChar MaxTrackLengthToKeep[]
For arc track interactive drag-resizing Maximum track length to keep after doing an arc track resizin...
Definition: advanced_config.cpp:137
ADVANCED_CFG::m_DrawArcCenterMaxAngle
double m_DrawArcCenterMaxAngle
When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely...
Definition: advanced_config.h:79
AC_KEYS::DrawArcCenterStartEndMaxAngle
static const wxChar DrawArcCenterStartEndMaxAngle[]
For drawsegments - arcs.
Definition: advanced_config.cpp:124
ADVANCED_CFG::m_MaxTrackLengthToKeep
double m_MaxTrackLengthToKeep
Maximum track length to keep after doing an arc track resizing operation.
Definition: advanced_config.h:90
ADVANCED_CFG::m_DrawArcAccuracy
double m_DrawArcAccuracy
Distance from an arc end point and the estimated end point, when rotating from the start point to the...
Definition: advanced_config.h:73
ADVANCED_CFG::m_ShowRouterDebugGraphics
bool m_ShowRouterDebugGraphics
Show PNS router debug graphics.
Definition: advanced_config.h:123
ADVANCED_CFG::m_SmallDrillMarkSize
double m_SmallDrillMarkSize
The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is s...
Definition: advanced_config.h:162
ADVANCED_CFG::m_ShowPcbnewExportNetlist
bool m_ShowPcbnewExportNetlist
Enable exporting board editor netlist to a file for troubleshooting purposes.
Definition: advanced_config.h:177
AC_KEYS::RealtimeConnectivity
static const wxChar RealtimeConnectivity[]
Testing mode for new connectivity algorithm.
Definition: advanced_config.cpp:90
AC_KEYS::MaxTangentTrackAngleDeviation
static const wxChar MaxTangentTrackAngleDeviation[]
For arc track interactive drag-resizing Maximum angle between the tangent line of an arc track and a ...
Definition: advanced_config.cpp:131
AC_KEYS::Skip3DModelMemoryCache
static const wxChar Skip3DModelMemoryCache[]
Definition: advanced_config.cpp:174
AC_KEYS::ShowRepairSchematic
static const wxChar ShowRepairSchematic[]
Definition: advanced_config.cpp:180
AC_KEYS::TraceMasks
static const wxChar TraceMasks[]
Definition: advanced_config.cpp:178
ADVANCED_CFG::m_ExtraZoneDisplayModes
bool m_ExtraZoneDisplayModes
When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulati...
Definition: advanced_config.h:140
AC_KEYS::DRCEpsilon
static const wxChar DRCEpsilon[]
A fudge factor for DRC.
Definition: advanced_config.cpp:76
AC_KEYS::ShowPcbnewExportNetlist
static const wxChar ShowPcbnewExportNetlist[]
Definition: advanced_config.cpp:170
AC_KEYS::DebugPDFWriter
static const wxChar DebugPDFWriter[]
Definition: advanced_config.cpp:158
dumpCfg
static void dumpCfg(const std::vector< PARAM_CFG * > &aArray)
Dump the configs in the given array to trace.
Definition: advanced_config.cpp:232
PARAM_CFG_INT
Configuration object for integers.
Definition: config_params.h:116
PARAM_CFG_BOOL
Configuration object for booleans.
Definition: config_params.h:192
AC_KEYS::SmallDrillMarkSize
static const wxChar SmallDrillMarkSize[]
The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is s...
Definition: advanced_config.cpp:164
ADVANCED_CFG::m_Skip3DModelMemoryCache
bool m_Skip3DModelMemoryCache
Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even...
Definition: advanced_config.h:190
AC_KEYS::DrawBoundingBoxes
static const wxChar DrawBoundingBoxes[]
Definition: advanced_config.cpp:168
AC_KEYS::ExtraZoneDisplayModes
static const wxChar ExtraZoneDisplayModes[]
When true, a third zone-display-mode is included which strokes the filled areas and fracture boundari...
Definition: advanced_config.cpp:148
ADVANCED_CFG::m_ExtraClearance
double m_ExtraClearance
Extra fill clearance for zone fills.
Definition: advanced_config.h:96
AC_KEYS::AllowManualCanvasScale
static const wxChar AllowManualCanvasScale[]
Definition: advanced_config.cpp:184
PARAM_CFG_WXSTRING
Configuration object for wxString objects.
Definition: config_params.h:213
ADVANCED_CFG::m_DRCEpsilon
double m_DRCEpsilon
Epsilon for DRC tests.
Definition: advanced_config.h:102
ADVANCED_CFG::m_HotkeysDumper
bool m_HotkeysDumper
Enable the hotkeys dumper feature, used for generating documentation.
Definition: advanced_config.h:167
ADVANCED_CFG::m_MinPlotPenWidth
double m_MinPlotPenWidth
Sets an absolute minimum pen width for plotting.
Definition: advanced_config.h:146
AC_KEYS::MinPlotPenWidth
static const wxChar MinPlotPenWidth[]
Absolute minimum pen width to send to the plotter.
Definition: advanced_config.cpp:154
ADVANCED_CFG::m_AllowManualCanvasScale
bool m_AllowManualCanvasScale
Definition: advanced_config.h:205
ADVANCED_CFG::m_ShowRepairSchematic
bool m_ShowRepairSchematic
Definition: advanced_config.h:198
ADVANCED_CFG::m_MaxTangentAngleDeviation
double m_MaxTangentAngleDeviation
Maximum angle between the tangent line of an arc track and a connected straight track in order to com...
Definition: advanced_config.h:85
ADVANCED_CFG::m_DrawBoundingBoxes
bool m_DrawBoundingBoxes
Draw GAL bounding boxes in painters.
Definition: advanced_config.h:172
ADVANCED_CFG::m_CoroutineStackSize
int m_CoroutineStackSize
Set the stack size for coroutines.
Definition: advanced_config.h:118
ADVANCED_CFG::m_DebugPDFWriter
bool m_DebugPDFWriter
A mode that writes PDFs without compression.
Definition: advanced_config.h:156
PARAM_CFG
A base class which establishes the interface functions ReadParam and SaveParam, which are implemented...
Definition: config_params.h:81
AC_KEYS::CoroutineStackSize
static const wxChar CoroutineStackSize[]
Configure the coroutine stack size in bytes.
Definition: advanced_config.cpp:96
AC_KEYS::HotkeysDumper
static const wxChar HotkeysDumper[]
Definition: advanced_config.cpp:166
AC_STACK::default_stack
static constexpr int default_stack
Definition: advanced_config.cpp:52
AC_KEYS::StrokeTriangulation
static const wxChar StrokeTriangulation[]
When true, GAL will stroke the triangulations (only used in OpenGL) with a visible color.
Definition: advanced_config.cpp:142
AC_KEYS::DebugZoneFiller
static const wxChar DebugZoneFiller[]
Definition: advanced_config.cpp:156
AC_STACK::max_stack
static constexpr int max_stack
Definition: advanced_config.cpp:53
AC_KEYS::ShowRouterDebugGraphics
static const wxChar ShowRouterDebugGraphics[]
Show PNS router debug graphics while routing.
Definition: advanced_config.cpp:101
ADVANCED_CFG::m_Skip3DModelFileCache
bool m_Skip3DModelFileCache
Skip reading/writing 3d model file caches This does not prevent the models from being cached in memor...
Definition: advanced_config.h:184
ADVANCED_CFG::m_RealTimeConnectivity
bool m_RealTimeConnectivity
Do real-time connectivity.
Definition: advanced_config.h:113
ADVANCED_CFG::m_DebugZoneFiller
bool m_DebugZoneFiller
A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
Definition: advanced_config.h:151
AC_KEYS::CompactFileSave
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...
Definition: advanced_config.cpp:107
AC_STACK::min_stack
static constexpr int min_stack
Definition: advanced_config.cpp:51
AC_KEYS::ExtraFillMargin
static const wxChar ExtraFillMargin[]
When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors d...
Definition: advanced_config.cpp:69
AC_KEYS::HideVersionFromTitle
static const wxChar HideVersionFromTitle[]
Definition: advanced_config.cpp:176
ADVANCED_CFG::m_HoleWallThickness
double m_HoleWallThickness
Hole wall plating thickness.
Definition: advanced_config.h:108

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, dumpCfg(), AC_KEYS::ExtraFillMargin, AC_KEYS::ExtraZoneDisplayModes, AC_KEYS::HideVersionFromTitle, AC_KEYS::HoleWallThickness, AC_KEYS::HotkeysDumper, 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_ShowRepairSchematic, m_ShowRouterDebugGraphics, m_Skip3DModelFileCache, m_Skip3DModelMemoryCache, m_SmallDrillMarkSize, 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::ShowRepairSchematic, AC_KEYS::ShowRouterDebugGraphics, AC_KEYS::Skip3DModelFileCache, AC_KEYS::Skip3DModelMemoryCache, AC_KEYS::SmallDrillMarkSize, AC_KEYS::StrokeTriangulation, AC_KEYS::TraceMasks, and wxConfigLoadSetups().

Referenced by loadFromConfigFile().

Member Data Documentation

◆ m_AllowManualCanvasScale

bool ADVANCED_CFG::m_AllowManualCanvasScale

Definition at line 205 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 129 of file advanced_config.h.

Referenced by PCB_PLUGIN::format(), formatPoly(), and loadSettings().

◆ m_CoroutineStackSize

int ADVANCED_CFG::m_CoroutineStackSize

Set the stack size for coroutines.

Definition at line 118 of file advanced_config.h.

Referenced by ADVANCED_CFG(), COROUTINE< int, const TOOL_EVENT & >::COROUTINE(), and loadSettings().

◆ m_DebugPDFWriter

bool ADVANCED_CFG::m_DebugPDFWriter

A mode that writes PDFs without compression.

Definition at line 156 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 151 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 172 of file advanced_config.h.

Referenced by ADVANCED_CFG(), KIGFX::SCH_PAINTER::Draw(), and loadSettings().

◆ m_DrawTriangulationOutlines

bool ADVANCED_CFG::m_DrawTriangulationOutlines

When true, strokes the triangulations with visible color.

Definition at line 134 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(), 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 140 of file advanced_config.h.

Referenced by ADVANCED_CFG(), HOTKEY_STORE::Init(), 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 196 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 108 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 167 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(), EDIT_TOOL::DragArcTrack(), 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 146 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 113 of file advanced_config.h.

Referenced by ADVANCED_CFG(), SCH_EDITOR_CONTROL::AssignNetclass(), and loadSettings().

◆ m_ShowEventCounters

bool ADVANCED_CFG::m_ShowEventCounters

Shows debugging event counters in various places.

Definition at line 203 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 177 of file advanced_config.h.

Referenced by ADVANCED_CFG(), and loadSettings().

◆ m_ShowRepairSchematic

bool ADVANCED_CFG::m_ShowRepairSchematic

Definition at line 198 of file advanced_config.h.

Referenced by loadSettings().

◆ m_ShowRouterDebugGraphics

bool ADVANCED_CFG::m_ShowRouterDebugGraphics

Show PNS router debug graphics.

Definition at line 123 of file advanced_config.h.

Referenced by ADVANCED_CFG(), ROUTER_TOOL::handleCommonEvents(), 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 184 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 190 of file advanced_config.h.

Referenced by ADVANCED_CFG(), S3D_CACHE::load(), 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 162 of file advanced_config.h.

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

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