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_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...
 

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

249 {
250  wxLogTrace( AdvancedConfigMask, "Init advanced config" );
251 
252  // Init defaults - this is done in case the config doesn't exist,
253  // then the values will remain as set here.
254  m_RealTimeConnectivity = true;
257  m_DrawArcAccuracy = 10.0;
260  m_MaxTrackLengthToKeep = 0.0001;
261  m_ExtraZoneDisplayModes = false;
263 
264  m_ExtraClearance = 0.0001;
265  m_DRCEpsilon = 0.0001; // 0.1um is small enough not to materially violate
266  // any constraints.
267 
268  m_HoleWallThickness = 0.020; // IPC-6012 says 15-18um; Cadence says at least
269  // 0.020 for a Class 2 board and at least 0.025
270  // for Class 3.
271 
272  m_MinPlotPenWidth = 0.0212; // 1 pixel at 1200dpi.
273 
274  m_DebugZoneFiller = false;
275  m_DebugPDFWriter = false;
276  m_SmallDrillMarkSize = 0.35;
277  m_HotkeysDumper = false;
278  m_DrawBoundingBoxes = false;
280  m_Skip3DModelFileCache = false;
281  m_Skip3DModelMemoryCache = false;
282  m_HideVersionFromTitle = false;
283 
285 }
bool m_HideVersionFromTitle
Hides the build version from the KiCad manager frame title.
bool m_DrawTriangulationOutlines
When true, strokes the triangulations with visible color.
double m_DrawArcCenterMaxAngle
When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely...
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_ShowRouterDebugGraphics
Show PNS router debug graphics.
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_ShowPcbnewExportNetlist
Enable exporting board editor netlist to a file for troubleshooting purposes.
bool m_ExtraZoneDisplayModes
When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulati...
void loadFromConfigFile()
Load the config from the normal config file.
bool m_Skip3DModelMemoryCache
Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even...
double m_ExtraClearance
Extra fill clearance for zone fills.
double m_DRCEpsilon
Epsilon for DRC tests.
bool m_HotkeysDumper
Enable the hotkeys dumper feature, used for generating documentation.
double m_MinPlotPenWidth
Sets an absolute minimum pen width for plotting.
double m_MaxTangentAngleDeviation
Maximum angle between the tangent line of an arc track and a connected straight track in order to com...
bool m_DrawBoundingBoxes
Draw GAL bounding boxes in painters.
int m_CoroutineStackSize
Set the stack size for coroutines.
bool m_DebugPDFWriter
A mode that writes PDFs without compression.
static constexpr int default_stack
bool m_Skip3DModelFileCache
Skip reading/writing 3d model file caches This does not prevent the models from being cached in memor...
bool m_RealTimeConnectivity
Do real-time connectivity.
bool m_DebugZoneFiller
A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
static const wxChar AdvancedConfigMask[]
double m_HoleWallThickness
Hole wall plating thickness.

References AdvancedConfigMask, AC_STACK::default_stack, loadFromConfigFile(), 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_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 288 of file advanced_config.cpp.

289 {
290  static ADVANCED_CFG instance;
291  return instance;
292 }
Class containing "advanced" configuration options.

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(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), EVT_MENU_RANGE(), EVT_UPDATE_UI_RANGE(), PCB_IO::format(), 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(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotLayerOutlines(), KICAD_MANAGER_FRAME::ProjectChanged(), CONNECTION_GRAPH::Recalculate(), PCB_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), 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(), and ZONE_FILLER::ZONE_FILLER().

◆ loadFromConfigFile()

void ADVANCED_CFG::loadFromConfigFile ( )
private

Load the config from the normal config file.

Definition at line 295 of file advanced_config.cpp.

296 {
297  const wxFileName k_advanced = getAdvancedCfgFilename();
298 
299  // If we are running headless, use the class defaults because we cannot instantiate wxConfig
300  if( !wxTheApp )
301  return;
302 
303  if( !k_advanced.FileExists() )
304  {
305  wxLogTrace( AdvancedConfigMask, "File does not exist %s", k_advanced.GetFullPath() );
306 
307  // load the defaults
308  wxConfig emptyConfig;
309  loadSettings( emptyConfig );
310 
311  return;
312  }
313 
314  wxLogTrace( AdvancedConfigMask, "Loading advanced config from: %s", k_advanced.GetFullPath() );
315 
316  wxFileConfig file_cfg( "", "", k_advanced.GetFullPath() );
317  loadSettings( file_cfg );
318 }
void loadSettings(wxConfigBase &aCfg)
static wxFileName getAdvancedCfgFilename()
Get the filename for the advanced config file.
static const wxChar AdvancedConfigMask[]

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

Referenced by ADVANCED_CFG().

◆ loadSettings()

void ADVANCED_CFG::loadSettings ( wxConfigBase &  aCfg)
private

Definition at line 321 of file advanced_config.cpp.

322 {
323  std::vector<PARAM_CFG*> configParams;
324 
325  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::RealtimeConnectivity,
326  &m_RealTimeConnectivity, true ) );
327 
328  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::ExtraFillMargin,
329  &m_ExtraClearance, 0.0005, 0.0, 1.0 ) );
330 
331  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCEpsilon,
332  &m_DRCEpsilon, 0.0005, 0.0, 1.0 ) );
333 
334  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::HoleWallThickness,
335  &m_HoleWallThickness, 0.020, 0.0, 1.0 ) );
336 
337  configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::CoroutineStackSize,
340 
341  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRouterDebugGraphics,
342  &m_ShowRouterDebugGraphics, false ) );
343 
344  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::CompactFileSave,
345  &m_CompactSave, false ) );
346 
347  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcAccuracy,
348  &m_DrawArcAccuracy, 10.0, 0.0, 100000.0 ) );
349 
350  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcCenterStartEndMaxAngle,
351  &m_DrawArcCenterMaxAngle, 50.0, 0.0, 100000.0 ) );
352 
353  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTangentTrackAngleDeviation,
354  &m_MaxTangentAngleDeviation, 1.0, 0.0, 90.0 ) );
355 
356  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTrackLengthToKeep,
357  &m_MaxTrackLengthToKeep, 0.0005, 0.0, 1.0 ) );
358 
359  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ExtraZoneDisplayModes,
360  &m_ExtraZoneDisplayModes, false ) );
361 
362  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::StrokeTriangulation,
363  &m_DrawTriangulationOutlines, false ) );
364 
365  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MinPlotPenWidth,
366  &m_MinPlotPenWidth, 0.0212, 0.0, 1.0 ) );
367 
368  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugZoneFiller,
369  &m_DebugZoneFiller, false ) );
370 
371  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugPDFWriter,
372  &m_DebugPDFWriter, false ) );
373 
374  configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::SmallDrillMarkSize,
375  &m_SmallDrillMarkSize, 0.35, 0.0, 3.0 ) );
376 
377  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HotkeysDumper,
378  &m_HotkeysDumper, false ) );
379 
380  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DrawBoundingBoxes,
381  &m_DrawBoundingBoxes, false ) );
382 
383  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowPcbnewExportNetlist,
384  &m_ShowPcbnewExportNetlist, false ) );
385 
386  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelFileCache,
387  &m_Skip3DModelFileCache, false ) );
388 
389  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelMemoryCache,
390  &m_Skip3DModelMemoryCache, false ) );
391 
392  configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HideVersionFromTitle,
393  &m_HideVersionFromTitle, false ) );
394 
395  wxConfigLoadSetups( &aCfg, configParams );
396 
397  dumpCfg( configParams );
398 
399  for( PARAM_CFG* param : configParams )
400  delete param;
401 }
static const wxChar Skip3DModelFileCache[]
bool m_HideVersionFromTitle
Hides the build version from the KiCad manager frame title.
bool m_CompactSave
Save files in compact display mode When is is not specified, points are written one per line.
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 DrawArcAccuracy[]
For drawsegments - arcs.
static const wxChar HoleWallThickness[]
Used to calculate the actual hole size from the finish hole size.
Configuration object for double precision floating point numbers.
bool m_DrawTriangulationOutlines
When true, strokes the triangulations with visible color.
static const wxChar MaxTrackLengthToKeep[]
For arc track interactive drag-resizing Maximum track length to keep after doing an arc track resizin...
double m_DrawArcCenterMaxAngle
When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely...
static const wxChar DrawArcCenterStartEndMaxAngle[]
For drawsegments - arcs.
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_ShowRouterDebugGraphics
Show PNS router debug graphics.
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_ShowPcbnewExportNetlist
Enable exporting board editor netlist to a file for troubleshooting purposes.
static const wxChar RealtimeConnectivity[]
Testing mode for new connectivity algorithm.
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 Skip3DModelMemoryCache[]
bool m_ExtraZoneDisplayModes
When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone triangulati...
static const wxChar DRCEpsilon[]
A fudge factor for DRC.
static const wxChar ShowPcbnewExportNetlist[]
static const wxChar DebugPDFWriter[]
static void dumpCfg(const std::vector< PARAM_CFG * > &aArray)
Dump the configs in the given array to trace.
Configuration object for integers.
Configuration object for booleans.
static const wxChar SmallDrillMarkSize[]
The diameter of the drill marks on print and plot outputs (in mm), when the "Drill marks" option is s...
bool m_Skip3DModelMemoryCache
Skip reading/writing 3d model memory caches This ensures 3d models are always reloaded from disk even...
static const wxChar DrawBoundingBoxes[]
static const wxChar ExtraZoneDisplayModes[]
When true, a third zone-display-mode is included which strokes the filled areas and fracture boundari...
double m_ExtraClearance
Extra fill clearance for zone fills.
double m_DRCEpsilon
Epsilon for DRC tests.
bool m_HotkeysDumper
Enable the hotkeys dumper feature, used for generating documentation.
double m_MinPlotPenWidth
Sets an absolute minimum pen width for plotting.
static const wxChar MinPlotPenWidth[]
Absolute minimum pen width to send to the plotter.
double m_MaxTangentAngleDeviation
Maximum angle between the tangent line of an arc track and a connected straight track in order to com...
bool m_DrawBoundingBoxes
Draw GAL bounding boxes in painters.
int m_CoroutineStackSize
Set the stack size for coroutines.
bool m_DebugPDFWriter
A mode that writes PDFs without compression.
A base class which establishes the interface functions ReadParam and SaveParam, which are implemented...
Definition: config_params.h:81
static const wxChar CoroutineStackSize[]
Configure the coroutine stack size in bytes.
static const wxChar HotkeysDumper[]
static constexpr int default_stack
static const wxChar StrokeTriangulation[]
When true, GAL will stroke the triangulations (only used in OpenGL) with a visible color.
static const wxChar DebugZoneFiller[]
static constexpr int max_stack
static const wxChar ShowRouterDebugGraphics[]
Show PNS router debug graphics while routing.
bool m_Skip3DModelFileCache
Skip reading/writing 3d model file caches This does not prevent the models from being cached in memor...
bool m_RealTimeConnectivity
Do real-time connectivity.
bool m_DebugZoneFiller
A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
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 constexpr int min_stack
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 HideVersionFromTitle[]
double m_HoleWallThickness
Hole wall plating thickness.

References 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_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_ShowPcbnewExportNetlist, 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::ShowPcbnewExportNetlist, AC_KEYS::ShowRouterDebugGraphics, AC_KEYS::Skip3DModelFileCache, AC_KEYS::Skip3DModelMemoryCache, AC_KEYS::SmallDrillMarkSize, AC_KEYS::StrokeTriangulation, and wxConfigLoadSetups().

Referenced by loadFromConfigFile().

Member Data Documentation

◆ 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_IO::format(), loadSettings(), and SCH_SEXPR_PLUGIN_CACHE::savePolyLine().

◆ 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_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_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: