KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Advanced Configuration Variables

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

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.
 
double ADVANCED_CFG::m_DrawArcCenterMaxAngle
 When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely high radii.
 
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.
 
double ADVANCED_CFG::m_MaxTrackLengthToKeep
 Maximum track length to keep after doing an arc track resizing operation.
 
double ADVANCED_CFG::m_ExtraClearance
 When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors do not overrun minimum clearance distances.
 
bool ADVANCED_CFG::m_EnableCreepageSlot
 Enable the minimum slot width check for creepage.
 
double ADVANCED_CFG::m_DRCEpsilon
 Epsilon for DRC tests.
 
double ADVANCED_CFG::m_SliverWidthTolerance
 Sliver width tolerance for DRC.
 
double ADVANCED_CFG::m_SliverMinimumLength
 Sliver length tolerance for DRC.
 
double ADVANCED_CFG::m_SliverAngleTolerance
 Sliver angle to tolerance for DRC.
 
double ADVANCED_CFG::m_HoleWallThickness
 Dimension used to calculate the actual hole size from the finish hole size.
 
int ADVANCED_CFG::m_CoroutineStackSize
 Configure the coroutine stack size in bytes.
 
int ADVANCED_CFG::m_UpdateUIEventInterval
 The update interval the wxWidgets sends wxUpdateUIEvents to windows.
 
bool ADVANCED_CFG::m_ShowRouterDebugGraphics
 Show PNS router debug graphics while routing.
 
bool ADVANCED_CFG::m_EnableRouterDump
 Enable PNS router to dump state information for debug purpose (press 0 while routing)
 
bool ADVANCED_CFG::m_HyperZoom
 Slide the zoom steps over for debugging things "up close".
 
bool ADVANCED_CFG::m_CompactSave
 Save files in compact display mode.
 
bool ADVANCED_CFG::m_DrawTriangulationOutlines
 Enable drawing the triangulation outlines with a visible color.
 
bool ADVANCED_CFG::m_ExtraZoneDisplayModes
 When true, adds zone-display-modes for stroking the zone fracture boundaries and the zone triangulation.
 
double ADVANCED_CFG::m_MinPlotPenWidth
 Absolute minimum pen width for plotting.
 
bool ADVANCED_CFG::m_DebugZoneFiller
 A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
 
bool ADVANCED_CFG::m_DebugPDFWriter
 A mode that writes PDFs without compression.
 
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".
 
bool ADVANCED_CFG::m_HotkeysDumper
 Enable the hotkeys dumper feature for generating documentation.
 
bool ADVANCED_CFG::m_DrawBoundingBoxes
 Draw GAL bounding boxes in painters.
 
bool ADVANCED_CFG::m_ShowPcbnewExportNetlist
 Enable exporting board editor netlist to a file for troubleshooting purposes.
 
bool ADVANCED_CFG::m_Skip3DModelFileCache
 Skip reading/writing 3D model file caches.
 
bool ADVANCED_CFG::m_Skip3DModelMemoryCache
 Skip reading/writing 3D model memory caches.
 
bool ADVANCED_CFG::m_HideVersionFromTitle
 Hide the build version from the KiCad manager frame title.
 
bool ADVANCED_CFG::m_ShowRepairSchematic
 Enable showing schematic repair output.
 
bool ADVANCED_CFG::m_ShowEventCounters
 Shows debugging event counters in various places.
 
int ADVANCED_CFG::m_MsgPanelShowUuids
 Show UUIDs of items in the message panel.
 
bool ADVANCED_CFG::m_AllowManualCanvasScale
 Allow manual scaling of canvas.
 
int ADVANCED_CFG::m_3DRT_BevelHeight_um
 Set the bevel height of layer items in 3D viewer when ray tracing.
 
double ADVANCED_CFG::m_3DRT_BevelExtentFactor
 3D-Viewer raytracing factor applied to Extent.z of the item layer.
 
bool ADVANCED_CFG::m_Use3DConnexionDriver
 Use the 3DConnexion Driver.
 
bool ADVANCED_CFG::m_IncrementalConnectivity
 Use the new incremental netlister for realtime jobs.
 
int ADVANCED_CFG::m_DisambiguationMenuDelay
 The number of milliseconds to wait in a click before showing a disambiguation menu.
 
bool ADVANCED_CFG::m_EnablePcbDesignBlocks
 Enable the new PCB Design Blocks feature.
 
bool ADVANCED_CFG::m_EnableGenerators
 Enable support for generators.
 
bool ADVANCED_CFG::m_EnableLibWithText
 Enable option to load lib files with text editor.
 
bool ADVANCED_CFG::m_EnableLibDir
 Enable option to open lib file directory.
 
double ADVANCED_CFG::m_PcbSelectionVisibilityRatio
 Board object selection visibility limit.
 
double ADVANCED_CFG::m_FontErrorSize
 Deviation between font's bezier curve ideal and the poligonized curve.
 
double ADVANCED_CFG::m_OcePluginLinearDeflection
 OCE (STEP/IGES) 3D Plugin Tesselation Linear Deflection.
 
double ADVANCED_CFG::m_OcePluginAngularDeflection
 OCE (STEP/IGES) 3D Plugin Tesselation Angular Deflection.
 
int ADVANCED_CFG::m_TriangulateSimplificationLevel
 The number of internal units that will be allowed to deflect from the base segment when creating a new segment.
 
int ADVANCED_CFG::m_TriangulateMinimumArea
 The minimum area of a polygon that can be left over after triangulation and still consider the triangulation successful.
 
bool ADVANCED_CFG::m_EnableCacheFriendlyFracture
 Enable the use of a cache-friendlier and therefore faster version of the polygon fracture algorithm.
 
bool ADVANCED_CFG::m_EnableAPILogging
 Log IPC API requests and responses.
 
int ADVANCED_CFG::m_MaxFilesystemWatchers
 Maximum number of filesystem watchers to use.
 
int ADVANCED_CFG::m_MinorSchematicGraphSize
 Set the number of items in a schematic graph for it to be considered "minor".
 
int ADVANCED_CFG::m_ResolveTextRecursionDepth
 The number of recursions to resolve text variables.
 
bool ADVANCED_CFG::m_EnableExtensionSnaps
 Enable snap anchors based on item line extensions.
 
int ADVANCED_CFG::m_ExtensionSnapTimeoutMs
 If extension snaps are enabled, this is the timeout in milliseconds before a hovered item gets extensions shown.
 
bool ADVANCED_CFG::m_ExtensionSnapActivateOnHover
 If extension snaps are enabled, 'activate' items on hover, even if not near a snap point.
 
bool ADVANCED_CFG::m_EnableSnapAnchorsDebug
 Enable snap anchors debug visualization.
 
double ADVANCED_CFG::m_MinParallelAngle
 Minimum overlapping angle for which an arc is considered to be parallel to its paired arc.
 
double ADVANCED_CFG::m_HoleWallPaintingMultiplier
 What factor to use when painting via and PTH pad hole walls, so that the painted hole wall can be overemphasized compared to physical reality to make the wall easier to see on-screen.
 
int ADVANCED_CFG::m_MaximumThreads
 Default value for the maximum number of threads to use for parallel processing.
 
double ADVANCED_CFG::m_MinimumMarkerSeparationDistance
 When finding overlapped marker a minium distance (in mm) between two DRC markers required to mark it as overlapped.
 
int ADVANCED_CFG::m_NetInspectorBulkUpdateOptimisationThreshold
 When updating the net inspector, it either recalculates all nets or iterates through items one-by-one.
 
int ADVANCED_CFG::m_ExcludeFromSimulationLineWidth
 The line width in mils for the exclude from simulation outline.
 
int ADVANCED_CFG::m_GitIconRefreshInterval
 The interval in milliseconds to refresh the git icons in the project tree.
 
bool ADVANCED_CFG::m_ConfigurableToolbars
 Enable the UI to configure toolbars.
 
int ADVANCED_CFG::m_MaxPastedTextLength
 Set the maximum number of characters that can be pasted without warning.
 
int ADVANCED_CFG::m_PNSProcessClusterTimeout
 Timeout for the PNS router's processCluster wallclock timeout, in milliseconds.
 

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:

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

Variable Documentation

◆ m_3DRT_BevelExtentFactor

double ADVANCED_CFG::m_3DRT_BevelExtentFactor

3D-Viewer raytracing factor applied to Extent.z of the item layer.

This is used for calculating the bevel's height.

Setting name: "V3DRT_BevelExtentFactor" Valid values: 0 to 100 Default value: 1/16

Definition at line 444 of file advanced_config.h.

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

◆ m_3DRT_BevelHeight_um

int ADVANCED_CFG::m_3DRT_BevelHeight_um

Set the bevel height of layer items in 3D viewer when ray tracing.

Controls the start of curvature normal on the edge. The value is in micrometer. Good values should be around or less than the copper thickness.

Setting name: "V3DRT_BevelHeight_um" Valid values: 0 to std::numeric_limits<int>::max() Default value: 30

Definition at line 433 of file advanced_config.h.

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

◆ m_AllowManualCanvasScale

bool ADVANCED_CFG::m_AllowManualCanvasScale

Allow manual scaling of canvas.

Setting name: "AllowManualCanvasScale" Valid values: 0 or 1 Default value: 0

Definition at line 421 of file advanced_config.h.

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

◆ m_CompactSave

bool ADVANCED_CFG::m_CompactSave

Save files in compact display mode.

When set to true, this will wrap polygon point sets at 4 points per line rather than a single point per line. Single point per line helps with version control systems.

Setting name: "CompactSave" Valid values: 0 or 1 Default value: 0

Definition at line 256 of file advanced_config.h.

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

◆ m_ConfigurableToolbars

bool ADVANCED_CFG::m_ConfigurableToolbars

Enable the UI to configure toolbars.

Setting name: "ConfigurableToolbars" Default value: false

Definition at line 748 of file advanced_config.h.

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

◆ m_CoroutineStackSize

int ADVANCED_CFG::m_CoroutineStackSize

Configure the coroutine stack size in bytes.

Note
This should be allocated in multiples of the system page size (n*4096 is generally safe)

Setting name: "CoroutineStackSize" Valid values: 32 * 4096 to 4096 * 4096 Default value: 256 * 4096

Definition at line 203 of file advanced_config.h.

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

◆ m_DebugPDFWriter

bool ADVANCED_CFG::m_DebugPDFWriter

A mode that writes PDFs without compression.

Setting name: "DebugPDFWriter" Valid values: 0 or 1 Default value: 0

Definition at line 307 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and ADVANCED_CFG::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.

Setting name: "DebugZoneFiller" Valid values: 0 or 1 Default value: 0

Definition at line 298 of file advanced_config.h.

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

◆ m_DisambiguationMenuDelay

int ADVANCED_CFG::m_DisambiguationMenuDelay

The number of milliseconds to wait in a click before showing a disambiguation menu.

Setting name: "DisambiguationTime" Valid values: 50 or 10000 Default value: 300

Definition at line 471 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), PL_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

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

Setting name: "DrawArcAccuracy" Valid values: 0 to 100000 Default value: 10

Definition at line 84 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and ADVANCED_CFG::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.

Setting name: "DrawArcCenterStartEndMaxAngle" Valid values: 0 to 100000 Default value: 50

Definition at line 94 of file advanced_config.h.

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

◆ m_DrawBoundingBoxes

bool ADVANCED_CFG::m_DrawBoundingBoxes

Draw GAL bounding boxes in painters.

Setting name: "DrawBoundingBoxes" Valid values: 0 or 1 Default value: 0

Definition at line 335 of file advanced_config.h.

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

◆ m_DrawTriangulationOutlines

bool ADVANCED_CFG::m_DrawTriangulationOutlines

Enable drawing the triangulation outlines with a visible color.

Note
This only affects the OpenGL GAL.

Setting name: "StrokeTriangulation" Valid values: 0 or 1 Default value: 0

Definition at line 267 of file advanced_config.h.

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

◆ m_DRCEpsilon

double ADVANCED_CFG::m_DRCEpsilon

Epsilon for DRC tests.

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

Setting name: "DRCEpsilon" Valid values: 0 to 1 Default value: 0.0005

Definition at line 144 of file advanced_config.h.

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

◆ m_EnableAPILogging

bool ADVANCED_CFG::m_EnableAPILogging

Log IPC API requests and responses.

Setting name: "EnableAPILogging" Default value: false

Definition at line 607 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), KICAD_API_SERVER::handleApiEvent(), ADVANCED_CFG::loadSettings(), and KICAD_API_SERVER::Start().

◆ m_EnableCacheFriendlyFracture

bool ADVANCED_CFG::m_EnableCacheFriendlyFracture

Enable the use of a cache-friendlier and therefore faster version of the polygon fracture algorithm.

Setting name: "EnableCacheFriendlyFracture" Valid values: 0 or 1 Default value: 1

Definition at line 599 of file advanced_config.h.

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

◆ m_EnableCreepageSlot

bool ADVANCED_CFG::m_EnableCreepageSlot

Enable the minimum slot width check for creepage.

Setting name: "EnableCreepageSlot" Default value: false

Definition at line 133 of file advanced_config.h.

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

◆ m_EnableExtensionSnaps

bool ADVANCED_CFG::m_EnableExtensionSnaps

Enable snap anchors based on item line extensions.

This should be removed when extension snaps are tuned up.

Setting name: "EnableExtensionSnaps" Default value: true

Definition at line 644 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), and PCB_GRID_HELPER::nearestAnchor().

◆ m_EnableGenerators

bool ADVANCED_CFG::m_EnableGenerators

Enable support for generators.

Setting name: "EnableGenerators" Valid values: 0 or 1 Default value: 0

Definition at line 489 of file advanced_config.h.

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

◆ m_EnableLibDir

bool ADVANCED_CFG::m_EnableLibDir

Enable option to open lib file directory.

Reveals one additional field under common preferences to set system's file manager command in order for the context menu options to work. On windows common settings preselect the default explorer with a hardcoded value.

Examples, Linux: "nemo -n %F" "nautilus --browser %F" "dolphin --select %F" etc Win11: "explorer.exe /n,/select,%F"

Setting name: "EnableLibDir" Valid values: 0 or 1 Default value: 0

Definition at line 516 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), and ADVANCED_CFG::loadSettings().

◆ m_EnableLibWithText

bool ADVANCED_CFG::m_EnableLibWithText

Enable option to load lib files with text editor.

Setting name: "EnableLibWithText" Valid values: 0 or 1 Default value: 0

Definition at line 498 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), and ADVANCED_CFG::loadSettings().

◆ m_EnablePcbDesignBlocks

bool ADVANCED_CFG::m_EnablePcbDesignBlocks

Enable the new PCB Design Blocks feature.

Setting name: "EnablePcbDesignBlocks" Valid values: true or false Default value: false

Definition at line 480 of file advanced_config.h.

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

◆ m_EnableRouterDump

bool ADVANCED_CFG::m_EnableRouterDump

Enable PNS router to dump state information for debug purpose (press 0 while routing)

Setting name: "EnableRouterDump" Valid values: 0 or 1 Default value: 0

Definition at line 235 of file advanced_config.h.

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

◆ m_EnableSnapAnchorsDebug

bool ADVANCED_CFG::m_EnableSnapAnchorsDebug

Enable snap anchors debug visualization.

Setting name: "EnableSnapAnchorsDebug" Default value: false

Definition at line 677 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), GRID_HELPER::enableAndGetAnchorDebug(), and ADVANCED_CFG::loadSettings().

◆ m_ExcludeFromSimulationLineWidth

int ADVANCED_CFG::m_ExcludeFromSimulationLineWidth

The line width in mils for the exclude from simulation outline.

Setting name: "ExcludeFromSimulationLineWidth" Default value: 25

Definition at line 732 of file advanced_config.h.

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

◆ m_ExtensionSnapActivateOnHover

bool ADVANCED_CFG::m_ExtensionSnapActivateOnHover

If extension snaps are enabled, 'activate' items on hover, even if not near a snap point.

This just to experiment with tuning. It should either be removed or made configurable when we know what feels best.

Setting name: "ExtensionSnapActivateOnHover" Default value: true

Definition at line 669 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), PCB_GRID_HELPER::BestSnapAnchor(), and ADVANCED_CFG::loadSettings().

◆ m_ExtensionSnapTimeoutMs

int ADVANCED_CFG::m_ExtensionSnapTimeoutMs

If extension snaps are enabled, this is the timeout in milliseconds before a hovered item gets extensions shown.

This should be removed if a good value is agreed, or made configurable if there's no universal good value.

Setting name: "EnableExtensionSnapsMs" Default value: 500 Valid values: >0

Definition at line 657 of file advanced_config.h.

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

◆ m_ExtraClearance

double ADVANCED_CFG::m_ExtraClearance

When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors do not overrun minimum clearance distances.

This is the extra clearance in mm.

Setting name: "ExtraFillMargin" Valid values: 0 to 1 Default value: 0.0005

Definition at line 125 of file advanced_config.h.

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

◆ m_ExtraZoneDisplayModes

bool ADVANCED_CFG::m_ExtraZoneDisplayModes

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

Setting name: "ExtraZoneDisplayModes" Valid values: 0 or 1 Default value: 0

Definition at line 277 of file advanced_config.h.

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

◆ m_FontErrorSize

double ADVANCED_CFG::m_FontErrorSize

Deviation between font's bezier curve ideal and the poligonized curve.

This is 1/16 of the font's internal units.

Setting name: "FontErrorSize" Valid values: 0.01 to 100 Default value: 2

Definition at line 541 of file advanced_config.h.

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

◆ m_GitIconRefreshInterval

int ADVANCED_CFG::m_GitIconRefreshInterval

The interval in milliseconds to refresh the git icons in the project tree.

Setting name: "GitIconRefreshInterval" Default value: 10000

Definition at line 740 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), and PROJECT_TREE_PANE::updateGitStatusIconMap().

◆ m_HideVersionFromTitle

bool ADVANCED_CFG::m_HideVersionFromTitle

Hide the build version from the KiCad manager frame title.

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

Setting name: "HideVersionFromTitle" Valid values: 0 or 1 Default value: 0

Definition at line 379 of file advanced_config.h.

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

◆ m_HoleWallPaintingMultiplier

double ADVANCED_CFG::m_HoleWallPaintingMultiplier

What factor to use when painting via and PTH pad hole walls, so that the painted hole wall can be overemphasized compared to physical reality to make the wall easier to see on-screen.

Setting name: "HoleWallPaintingMultiplier" Default value: 1.5

Definition at line 696 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), KIGFX::PCB_PAINTER::draw(), and ADVANCED_CFG::loadSettings().

◆ m_HoleWallThickness

double ADVANCED_CFG::m_HoleWallThickness

Dimension used to calculate the actual hole size from the finish hole size.

Note
IPC-6012 says 0.015-0.018mm; Cadence says at least 0.020mm for a Class 2 board and at least 0.025mm for Class 3. Units are mm.

Setting name: "HoleWallPlatingThickness" Valid values: 1 to 90 Default value: 0.02

Definition at line 190 of file advanced_config.h.

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

◆ m_HotkeysDumper

bool ADVANCED_CFG::m_HotkeysDumper

Enable the hotkeys dumper feature for generating documentation.

Setting name: "HotkeysDumper" Valid values: 0 or 1 Default value: 0

Definition at line 326 of file advanced_config.h.

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

◆ m_HyperZoom

bool ADVANCED_CFG::m_HyperZoom

Slide the zoom steps over for debugging things "up close".

Setting name: "HyperZoom" Valid values: 0 or 1 Default value: 0

Definition at line 244 of file advanced_config.h.

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

◆ m_IncrementalConnectivity

bool ADVANCED_CFG::m_IncrementalConnectivity

Use the new incremental netlister for realtime jobs.

Setting name: "IncrementalConnectivity" Valid values: 0 or 1 Default value: 1

Definition at line 462 of file advanced_config.h.

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

◆ m_MaxFilesystemWatchers

int ADVANCED_CFG::m_MaxFilesystemWatchers

Maximum number of filesystem watchers to use.

Setting name: "MaxFilesystemWatchers" Valid values: 0 to 2147483647 Default value: 16384

Definition at line 616 of file advanced_config.h.

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

◆ m_MaximumThreads

int ADVANCED_CFG::m_MaximumThreads

Default value for the maximum number of threads to use for parallel processing.

Setting this value to 0 or less will mean that we use the number of cores available

Setting name: "MaximumThreads" Default value: 0

Definition at line 705 of file advanced_config.h.

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

◆ m_MaxPastedTextLength

int ADVANCED_CFG::m_MaxPastedTextLength

Set the maximum number of characters that can be pasted without warning.

Long text strings can cause the application to freeze for a long time and are probably not what the user intended.

Setting name: "MaxPastedTextLength" Default value: 100

Definition at line 758 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), SCH_EDITOR_CONTROL::Paste(), and PCB_CONTROL::Paste().

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

Setting name: "MaxTangentTrackAngleDeviation" Valid values: 0 to 90 Default value: 1

Definition at line 104 of file advanced_config.h.

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

◆ m_MaxTrackLengthToKeep

double ADVANCED_CFG::m_MaxTrackLengthToKeep

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

Units are mm.

Setting name: "MaxTrackLengthToKeep" Valid values: 0 to 1 Default value: 0.0005

Definition at line 113 of file advanced_config.h.

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

◆ m_MinimumMarkerSeparationDistance

double ADVANCED_CFG::m_MinimumMarkerSeparationDistance

When finding overlapped marker a minium distance (in mm) between two DRC markers required to mark it as overlapped.

Setting name: "MinimumMarkerSeparationDistance" Default value: 0.15

Definition at line 714 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and DIALOG_DRC::OnDRCItemSelected().

◆ m_MinorSchematicGraphSize

int ADVANCED_CFG::m_MinorSchematicGraphSize

Set the number of items in a schematic graph for it to be considered "minor".

Setting name: "MinorSchematicGraphSize" Valid values: 0 to 2147483647 Default value: 10000

Definition at line 625 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), CONNECTION_GRAPH::IsMinor(), and ADVANCED_CFG::loadSettings().

◆ m_MinParallelAngle

double ADVANCED_CFG::m_MinParallelAngle

Minimum overlapping angle for which an arc is considered to be parallel to its paired arc.

Setting name: "MinParallelAngle" Default value: 0.001

Definition at line 686 of file advanced_config.h.

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

◆ m_MinPlotPenWidth

double ADVANCED_CFG::m_MinPlotPenWidth

Absolute minimum pen width for plotting.

Note
Some formats (PDF, for example) don't like ultra-thin lines. PDF seems happy enough with 0.0212mm which equates to 1px @ 1200dpi. Units are mm.

Setting name: "MinPlotPenWidth" Valid values: 0 to 1 Default value: 0.0212

Definition at line 289 of file advanced_config.h.

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

◆ m_MsgPanelShowUuids

int ADVANCED_CFG::m_MsgPanelShowUuids

Show UUIDs of items in the message panel.

Can be useful when debugging against a specific item saved in a file.

0: do not show (default) 1: show full UUID 2: show only first 8 characters of UUID

Setting name: "MsgPanelShowUuids" Default value: 0

Definition at line 412 of file advanced_config.h.

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

◆ m_NetInspectorBulkUpdateOptimisationThreshold

int ADVANCED_CFG::m_NetInspectorBulkUpdateOptimisationThreshold

When updating the net inspector, it either recalculates all nets or iterates through items one-by-one.

This value controls the threshold at which all nets are recalculated rather than iterating over the items.

Setting name: "NetInspectorBulkUpdateOptimisationThreshold" Default value: 25

Definition at line 724 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), and PCB_NET_INSPECTOR_PANEL::updateBoardItems().

◆ m_OcePluginAngularDeflection

double ADVANCED_CFG::m_OcePluginAngularDeflection

OCE (STEP/IGES) 3D Plugin Tesselation Angular Deflection.

Angular deflection specifies the maximum deviation angle (in degrees) between the normals of adjacent facets in the tessellated model. Lower values result in smoother curved surfaces by creating more facets to closely approximate the curve.

Setting name: "OcePluginAngularDeflection" Valid values: 0.1 to 180 Default value: 30

Definition at line 568 of file advanced_config.h.

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

◆ m_OcePluginLinearDeflection

double ADVANCED_CFG::m_OcePluginLinearDeflection

OCE (STEP/IGES) 3D Plugin Tesselation Linear Deflection.

Linear deflection determines the maximum distance between the original geometry and the tessellated representation, measured in millimeters (mm), influencing the precision of flat surfaces.

Setting name: "OcePluginLinearDeflection" Valid values: 0.01 to 1.0 Default value: 0.14

Definition at line 554 of file advanced_config.h.

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

◆ m_PcbSelectionVisibilityRatio

double ADVANCED_CFG::m_PcbSelectionVisibilityRatio

Board object selection visibility limit.

This ratio is used to determine if an object in a selected object layer stack is visible. All alpha ratios less or equal to this value are considered invisible to the user and will be pruned from the list of selections. Valid values are between 0 and less than 1. A value of 1 disables this feature. Reasonable values are between 0.01 and 0.03 depending on the layer colors.

Setting name: "PcbSelectionVisibilityRatio" Valid values: 0.0 to 1.0 Default value: 1

Definition at line 531 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), and PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates().

◆ m_PNSProcessClusterTimeout

int ADVANCED_CFG::m_PNSProcessClusterTimeout

Timeout for the PNS router's processCluster wallclock timeout, in milliseconds.

Setting name: "PNSProcessClusterTimeoutMs" Valid values: 10 to 10000 Default value: 100

Definition at line 767 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), and PNS::WALKAROUND::singleStep().

◆ m_ResolveTextRecursionDepth

int ADVANCED_CFG::m_ResolveTextRecursionDepth

The number of recursions to resolve text variables.

Setting name: "ResolveTextRecursionDepth" Valid values: 0 to 10 Default value: 3

Definition at line 634 of file advanced_config.h.

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

◆ m_ShowEventCounters

bool ADVANCED_CFG::m_ShowEventCounters

Shows debugging event counters in various places.

Setting name: "ShowEventCounters" Valid values: 0 or 1 Default value: 0

Definition at line 397 of file advanced_config.h.

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

◆ m_ShowPcbnewExportNetlist

bool ADVANCED_CFG::m_ShowPcbnewExportNetlist

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

Setting name: "ShowPcbnewExportNetlist" Valid values: 0 or 1 Default value: 0

Definition at line 344 of file advanced_config.h.

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

◆ m_ShowRepairSchematic

bool ADVANCED_CFG::m_ShowRepairSchematic

Enable showing schematic repair output.

Setting name: "ShowRepairSchematic" Valid values: 0 or 1 Default value: 0

Definition at line 388 of file advanced_config.h.

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

◆ m_ShowRouterDebugGraphics

bool ADVANCED_CFG::m_ShowRouterDebugGraphics

Show PNS router debug graphics while routing.

Setting name: "ShowRouterDebugGraphics" Valid values: 0 or 1 Default value: 0

Definition at line 226 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and ADVANCED_CFG::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.

Setting name: "Skip3DModelFileCache" Valid values: 0 or 1 Default value: 0

Definition at line 356 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and ADVANCED_CFG::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.

Setting name: "Skip3DModelMemoryCache" Valid values: 0 or 1 Default value: 0

Definition at line 368 of file advanced_config.h.

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

◆ m_SliverAngleTolerance

double ADVANCED_CFG::m_SliverAngleTolerance

Sliver angle to tolerance for DRC.

Units are mm.

Setting name: "DRCSliverAngleTolerance" Valid values: 1 to 90 Default value: 20

Definition at line 177 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), ADVANCED_CFG::loadSettings(), and DRC_TEST_PROVIDER_SLIVER_CHECKER::Run().

◆ m_SliverMinimumLength

double ADVANCED_CFG::m_SliverMinimumLength

Sliver length tolerance for DRC.

Units are mm.

Setting name: "DRCSliverMinimumLength" Valid values: 1e-9 to 10 Default value: 0.0008

Definition at line 166 of file advanced_config.h.

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

◆ m_SliverWidthTolerance

double ADVANCED_CFG::m_SliverWidthTolerance

Sliver width tolerance for DRC.

Units are mm.

Setting name: "DRCSliverWidthTolerance" Valid values: 0.01 to 0.25 Default value: 0.08

Definition at line 155 of file advanced_config.h.

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and ADVANCED_CFG::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".

Setting name: "SmallDrillMarkSize" Valid values: 0 to 3 Default value: 0.35

Definition at line 317 of file advanced_config.h.

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

◆ m_TriangulateMinimumArea

int ADVANCED_CFG::m_TriangulateMinimumArea

The minimum area of a polygon that can be left over after triangulation and still consider the triangulation successful.

This is internal units, so it is square nm in pcbnew.

Setting name: "TriangulateMinimumArea" Valid values: 25 to 100000 Default value: 1000

Definition at line 589 of file advanced_config.h.

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

◆ m_TriangulateSimplificationLevel

int ADVANCED_CFG::m_TriangulateSimplificationLevel

The number of internal units that will be allowed to deflect from the base segment when creating a new segment.

Setting name: "TriangulateSimplificationLevel" Valid values: 5 to 1000 Default value: 50

Definition at line 578 of file advanced_config.h.

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

◆ m_UpdateUIEventInterval

int ADVANCED_CFG::m_UpdateUIEventInterval

The update interval the wxWidgets sends wxUpdateUIEvents to windows.

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.

Setting name: "UpdateUIEventInterval" Valid values: -1 to 100000 Default value: 0

Definition at line 217 of file advanced_config.h.

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

◆ m_Use3DConnexionDriver

bool ADVANCED_CFG::m_Use3DConnexionDriver

Use the 3DConnexion Driver.

Setting name: "3DConnexionDriver" Valid values: 0 or 1 Default value: 1

Definition at line 453 of file advanced_config.h.

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