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

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

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

double	ADVANCED_CFG::m_MaxTrackLengthToKeep
	Maximum track length to keep after doing an arc track resizing operation. More...

double	ADVANCED_CFG::m_ExtraClearance
	Extra fill clearance for zone fills. More...

double	ADVANCED_CFG::m_DRCEpsilon
	Epsilon for DRC tests. More...

double	ADVANCED_CFG::m_SliverWidthTolerance
	Sliver tolerances for DRC. More...

double	ADVANCED_CFG::m_SliverMinimumLength

double	ADVANCED_CFG::m_SliverAngleTolerance

double	ADVANCED_CFG::m_HoleWallThickness
	Hole wall plating thickness. More...

int	ADVANCED_CFG::m_CoroutineStackSize
	Set the stack size for coroutines. More...

int	ADVANCED_CFG::m_UpdateUIEventInterval
	The update interval the wxWidgets sends wxUpdateUIEvents to windows. More...

bool	ADVANCED_CFG::m_ShowRouterDebugGraphics
	Show PNS router debug graphics. More...

bool	ADVANCED_CFG::m_CompactSave
	Save files in compact display mode When is is not specified, points are written one per line. More...

bool	ADVANCED_CFG::m_DrawTriangulationOutlines
	When true, strokes the triangulations with visible color. More...

bool	ADVANCED_CFG::m_ExtraZoneDisplayModes
	When true, adds zone-display-modes for stroking the zone fracture boundaries and the zone triangulation. More...

double	ADVANCED_CFG::m_MinPlotPenWidth
	Sets an absolute minimum pen width for plotting. More...

bool	ADVANCED_CFG::m_DebugZoneFiller
	A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu. More...

bool	ADVANCED_CFG::m_DebugPDFWriter
	A mode that writes PDFs without compression. More...

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". More...

bool	ADVANCED_CFG::m_HotkeysDumper
	Enable the hotkeys dumper feature, used for generating documentation. More...

bool	ADVANCED_CFG::m_DrawBoundingBoxes
	Draw GAL bounding boxes in painters. More...

bool	ADVANCED_CFG::m_ShowPcbnewExportNetlist
	Enable exporting board editor netlist to a file for troubleshooting purposes. More...

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

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

bool	ADVANCED_CFG::m_HideVersionFromTitle
	Hides the build version from the KiCad manager frame title. More...

bool	ADVANCED_CFG::m_ShowRepairSchematic

bool	ADVANCED_CFG::m_ShowEventCounters
	Shows debugging event counters in various places. More...

bool	ADVANCED_CFG::m_AllowManualCanvasScale

bool	ADVANCED_CFG::m_ShowPropertiesPanel
	Show the properties panel in applications that it hasn't been fully released for. More...

int	ADVANCED_CFG::m_3DRT_BevelHeight_um
	3D-Viewer, Raytracing Bevel height of layer items. More...

double	ADVANCED_CFG::m_3DRT_BevelExtentFactor
	3D-Viewer raytracing factor applied to Extent.z of the item layer. More...

bool	ADVANCED_CFG::m_UseClipper2
	Use Clipper2 instead of Clipper1. More...

bool	ADVANCED_CFG::m_Use3DConnexionDriver
	Use the 3DConnexion Driver. More...

bool	ADVANCED_CFG::m_IncrementalConnectivity
	Use the new incremental netlister for realtime jobs. More...

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

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 on calculation of the bevel's height.

Definition at line 243 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

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

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

Definition at line 236 of file advanced_config.h.

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

◆ m_AllowManualCanvasScale

bool ADVANCED_CFG::m_AllowManualCanvasScale

Definition at line 224 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 is is not specified, points are written one per line.

Definition at line 147 of file advanced_config.h.

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

◆ m_CoroutineStackSize

int ADVANCED_CFG::m_CoroutineStackSize

Set the stack size for coroutines.

Definition at line 126 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.

Definition at line 174 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.

Definition at line 169 of file advanced_config.h.

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

Definition at line 85 of file advanced_config.h.

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

◆ m_DrawBoundingBoxes

bool ADVANCED_CFG::m_DrawBoundingBoxes

Draw GAL bounding boxes in painters.

Definition at line 190 of file advanced_config.h.

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

◆ m_DrawTriangulationOutlines

bool ADVANCED_CFG::m_DrawTriangulationOutlines

When true, strokes the triangulations with visible color.

Definition at line 152 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 that for zone tests this is essentially additive with m_ExtraClearance. Units are mm.

Definition at line 108 of file advanced_config.h.

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

Definition at line 158 of file advanced_config.h.

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

Referenced by ADVANCED_CFG::ADVANCED_CFG(), and ADVANCED_CFG::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 121 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, used for generating documentation.

Definition at line 185 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.

Definition at line 258 of file advanced_config.h.

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

Definition at line 96 of file advanced_config.h.

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

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

◆ m_ShowEventCounters

bool ADVANCED_CFG::m_ShowEventCounters

Shows debugging event counters in various places.

Definition at line 222 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.

Definition at line 195 of file advanced_config.h.

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

◆ m_ShowPropertiesPanel

bool ADVANCED_CFG::m_ShowPropertiesPanel

Show the properties panel in applications that it hasn't been fully released for.

Definition at line 229 of file advanced_config.h.

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

◆ m_ShowRepairSchematic

bool ADVANCED_CFG::m_ShowRepairSchematic

Definition at line 217 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.

Definition at line 141 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.

Definition at line 202 of file advanced_config.h.

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