KiCad PCB EDA Suite
AC_KEYS Namespace Reference

List of known keys for advanced configuration options. More...

Variables

static const wxChar ExtraFillMargin [] = wxT( "ExtraFillMargin" )
 When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors do not overrun minimum clearance distances. More...
 
static const wxChar DRCEpsilon [] = wxT( "DRCEpsilon" )
 A fudge factor for DRC. More...
 
static const wxChar DRCSliverWidthTolerance [] = wxT( "DRCSliverWidthTolerance" )
 Angle and width tolerances for copper and solder mask sliver detection. More...
 
static const wxChar DRCSliverAngleTolerance [] = wxT( "DRCSliverAngleTolerance" )
 
static const wxChar HoleWallThickness [] = wxT( "HoleWallPlatingThickness" )
 Used to calculate the actual hole size from the finish hole size. More...
 
static const wxChar RealtimeConnectivity [] = wxT( "RealtimeConnectivity" )
 Testing mode for new connectivity algorithm. More...
 
static const wxChar CoroutineStackSize [] = wxT( "CoroutineStackSize" )
 Configure the coroutine stack size in bytes. More...
 
static const wxChar ShowRouterDebugGraphics [] = wxT( "ShowRouterDebugGraphics" )
 Show PNS router debug graphics while routing. More...
 
static const wxChar CompactFileSave [] = wxT( "CompactSave" )
 When set to true, this will wrap polygon point sets at 4 points per line rather than a single point per line. More...
 
static const wxChar DrawArcAccuracy [] = wxT( "DrawArcAccuracy" )
 For drawsegments - arcs. More...
 
static const wxChar DrawArcCenterStartEndMaxAngle [] = wxT( "DrawArcCenterStartEndMaxAngle" )
 For drawsegments - arcs. More...
 
static const wxChar MaxTangentTrackAngleDeviation [] = wxT( "MaxTangentTrackAngleDeviation" )
 For arc track interactive drag-resizing Maximum angle between the tangent line of an arc track and a connected straight track in order to commence arc dragging. More...
 
static const wxChar MaxTrackLengthToKeep [] = wxT( "MaxTrackLengthToKeep" )
 For arc track interactive drag-resizing Maximum track length to keep after doing an arc track resizing operation. More...
 
static const wxChar StrokeTriangulation [] = wxT( "StrokeTriangulation" )
 When true, GAL will stroke the triangulations (only used in OpenGL) with a visible color. More...
 
static const wxChar ExtraZoneDisplayModes [] = wxT( "ExtraZoneDisplayModes" )
 When true, a third zone-display-mode is included which strokes the filled areas and fracture boundaries. More...
 
static const wxChar MinPlotPenWidth [] = wxT( "MinPlotPenWidth" )
 Absolute minimum pen width to send to the plotter. More...
 
static const wxChar DebugZoneFiller [] = wxT( "DebugZoneFiller" )
 
static const wxChar DebugPDFWriter [] = wxT( "DebugPDFWriter" )
 
static const wxChar SmallDrillMarkSize [] = wxT( "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...
 
static const wxChar HotkeysDumper [] = wxT( "HotkeysDumper" )
 
static const wxChar DrawBoundingBoxes [] = wxT( "DrawBoundingBoxes" )
 
static const wxChar ShowPcbnewExportNetlist [] = wxT( "ShowPcbnewExportNetlist" )
 
static const wxChar Skip3DModelFileCache [] = wxT( "Skip3DModelFileCache" )
 
static const wxChar Skip3DModelMemoryCache [] = wxT( "Skip3DModelMemoryCache" )
 
static const wxChar HideVersionFromTitle [] = wxT( "HideVersionFromTitle" )
 
static const wxChar TraceMasks [] = wxT( "TraceMasks" )
 
static const wxChar ShowRepairSchematic [] = wxT( "ShowRepairSchematic" )
 
static const wxChar ShowEventCounters [] = wxT( "ShowEventCounters" )
 
static const wxChar AllowManualCanvasScale [] = wxT( "AllowManualCanvasScale" )
 
static const wxChar UpdateUIEventInterval [] = wxT( "UpdateUIEventInterval" )
 
static const wxChar ShowPropertiesPanel [] = wxT( "ShowPropertiesPanel" )
 
static const wxChar V3DRT_BevelHeight_um [] = wxT( "V3DRT_BevelHeight_um" )
 
static const wxChar V3DRT_BevelExtentFactor [] = wxT( "V3DRT_BevelExtentFactor" )
 

Detailed Description

List of known keys for advanced configuration options.

Set these options in the file kicad_advanced in the KiCad config directory.

Variable Documentation

◆ AllowManualCanvasScale

const wxChar AC_KEYS::AllowManualCanvasScale[] = wxT( "AllowManualCanvasScale" )
static

Definition at line 190 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ CompactFileSave

const wxChar AC_KEYS::CompactFileSave[] = wxT( "CompactSave" )
static

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

Definition at line 113 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ CoroutineStackSize

const wxChar AC_KEYS::CoroutineStackSize[] = wxT( "CoroutineStackSize" )
static

Configure the coroutine stack size in bytes.

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

Definition at line 102 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DebugPDFWriter

const wxChar AC_KEYS::DebugPDFWriter[] = wxT( "DebugPDFWriter" )
static

Definition at line 164 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DebugZoneFiller

const wxChar AC_KEYS::DebugZoneFiller[] = wxT( "DebugZoneFiller" )
static

Definition at line 162 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DrawArcAccuracy

const wxChar AC_KEYS::DrawArcAccuracy[] = wxT( "DrawArcAccuracy" )
static

For drawsegments - arcs.

Distance from an arc end point and the estimated end point, when rotating from the start point to the end point. 0 will not allow any approximate result, and the arc will not show. Squared value for performances, in system unit.

Definition at line 122 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DrawArcCenterStartEndMaxAngle

const wxChar AC_KEYS::DrawArcCenterStartEndMaxAngle[] = wxT( "DrawArcCenterStartEndMaxAngle" )
static

For drawsegments - arcs.

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

Definition at line 130 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DrawBoundingBoxes

const wxChar AC_KEYS::DrawBoundingBoxes[] = wxT( "DrawBoundingBoxes" )
static

Definition at line 174 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DRCEpsilon

const wxChar AC_KEYS::DRCEpsilon[] = wxT( "DRCEpsilon" )
static

A fudge factor for DRC.

Required to prevent false positives due to rounding errors, errors in polygonalization, etc. Previous versions hard-coded various values from 0.000005mm to 0.002mm.

Definition at line 76 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DRCSliverAngleTolerance

const wxChar AC_KEYS::DRCSliverAngleTolerance[] = wxT( "DRCSliverAngleTolerance" )
static

Definition at line 82 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ DRCSliverWidthTolerance

const wxChar AC_KEYS::DRCSliverWidthTolerance[] = wxT( "DRCSliverWidthTolerance" )
static

Angle and width tolerances for copper and solder mask sliver detection.

Definition at line 81 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ExtraFillMargin

const wxChar AC_KEYS::ExtraFillMargin[] = wxT( "ExtraFillMargin" )
static

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 in mm.

Definition at line 69 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ExtraZoneDisplayModes

const wxChar AC_KEYS::ExtraZoneDisplayModes[] = wxT( "ExtraZoneDisplayModes" )
static

When true, a third zone-display-mode is included which strokes the filled areas and fracture boundaries.

Definition at line 154 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ HideVersionFromTitle

const wxChar AC_KEYS::HideVersionFromTitle[] = wxT( "HideVersionFromTitle" )
static

Definition at line 182 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ HoleWallThickness

const wxChar AC_KEYS::HoleWallThickness[] = wxT( "HoleWallPlatingThickness" )
static

Used to calculate the actual hole size from the finish hole size.

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.

Definition at line 89 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ HotkeysDumper

const wxChar AC_KEYS::HotkeysDumper[] = wxT( "HotkeysDumper" )
static

Definition at line 172 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ MaxTangentTrackAngleDeviation

const wxChar AC_KEYS::MaxTangentTrackAngleDeviation[] = wxT( "MaxTangentTrackAngleDeviation" )
static

For arc track interactive drag-resizing 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 137 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ MaxTrackLengthToKeep

const wxChar AC_KEYS::MaxTrackLengthToKeep[] = wxT( "MaxTrackLengthToKeep" )
static

For arc track interactive drag-resizing Maximum track length to keep after doing an arc track resizing operation.

Units are mm.

Definition at line 143 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ MinPlotPenWidth

const wxChar AC_KEYS::MinPlotPenWidth[] = wxT( "MinPlotPenWidth" )
static

Absolute minimum pen width to send to the plotter.

PDF seems happy enough with 0.0212mm (which equates to 1px @ 1200dpi).

Definition at line 160 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ RealtimeConnectivity

const wxChar AC_KEYS::RealtimeConnectivity[] = wxT( "RealtimeConnectivity" )
static

Testing mode for new connectivity algorithm.

Setting this to on will cause all modifications to the netlist to be recalculated on the fly. This may be slower than the standard process at the moment

Definition at line 96 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ShowEventCounters

const wxChar AC_KEYS::ShowEventCounters[] = wxT( "ShowEventCounters" )
static

Definition at line 188 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ShowPcbnewExportNetlist

const wxChar AC_KEYS::ShowPcbnewExportNetlist[] = wxT( "ShowPcbnewExportNetlist" )
static

Definition at line 176 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ShowPropertiesPanel

const wxChar AC_KEYS::ShowPropertiesPanel[] = wxT( "ShowPropertiesPanel" )
static

Definition at line 194 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ShowRepairSchematic

const wxChar AC_KEYS::ShowRepairSchematic[] = wxT( "ShowRepairSchematic" )
static

Definition at line 186 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ ShowRouterDebugGraphics

const wxChar AC_KEYS::ShowRouterDebugGraphics[] = wxT( "ShowRouterDebugGraphics" )
static

Show PNS router debug graphics while routing.

Definition at line 107 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ Skip3DModelFileCache

const wxChar AC_KEYS::Skip3DModelFileCache[] = wxT( "Skip3DModelFileCache" )
static

Definition at line 178 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ Skip3DModelMemoryCache

const wxChar AC_KEYS::Skip3DModelMemoryCache[] = wxT( "Skip3DModelMemoryCache" )
static

Definition at line 180 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ SmallDrillMarkSize

const wxChar AC_KEYS::SmallDrillMarkSize[] = wxT( "SmallDrillMarkSize" )
static

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

Referenced by ADVANCED_CFG::loadSettings().

◆ StrokeTriangulation

const wxChar AC_KEYS::StrokeTriangulation[] = wxT( "StrokeTriangulation" )
static

When true, GAL will stroke the triangulations (only used in OpenGL) with a visible color.

Definition at line 148 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ TraceMasks

const wxChar AC_KEYS::TraceMasks[] = wxT( "TraceMasks" )
static

Definition at line 184 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ UpdateUIEventInterval

const wxChar AC_KEYS::UpdateUIEventInterval[] = wxT( "UpdateUIEventInterval" )
static

Definition at line 192 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ V3DRT_BevelExtentFactor

const wxChar AC_KEYS::V3DRT_BevelExtentFactor[] = wxT( "V3DRT_BevelExtentFactor" )
static

Definition at line 198 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().

◆ V3DRT_BevelHeight_um

const wxChar AC_KEYS::V3DRT_BevelHeight_um[] = wxT( "V3DRT_BevelHeight_um" )
static

Definition at line 196 of file advanced_config.cpp.

Referenced by ADVANCED_CFG::loadSettings().