KiCad PCB EDA Suite
zones.h File Reference

Go to the source code of this file.

Macros

#define ZONE_THERMAL_RELIEF_GAP_MIL   20
 
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL   20
 
#define ZONE_THICKNESS_MIL   10
 
#define ZONE_THICKNESS_MIN_VALUE_MIL   1
 
#define ZONE_CLEARANCE_MIL   20
 
#define ZONE_CLEARANCE_MAX_VALUE_MIL   500
 
#define ZONE_EXPORT_VALUES   1004
 

Enumerations

enum  ZONE_CONNECTION {
  ZONE_CONNECTION::INHERITED = -1, ZONE_CONNECTION::NONE, ZONE_CONNECTION::THERMAL, ZONE_CONNECTION::FULL,
  ZONE_CONNECTION::THT_THERMAL
}
 How pads are covered by copper in zone. More...
 

Functions

int InvokeNonCopperZonesEditor (PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings)
 Function InvokeNonCopperZonesEditor invokes up a modal dialog window for non-copper zone editing. More...
 
int InvokeCopperZonesEditor (PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
 Function InvokeCopperZonesEditor invokes up a modal dialog window for copper zone editing. More...
 
int InvokeKeepoutAreaEditor (PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
 Function InvokeKeepoutAreaEditor invokes up a modal dialog window for copper zone editing. More...
 

Macro Definition Documentation

◆ ZONE_CLEARANCE_MAX_VALUE_MIL

#define ZONE_CLEARANCE_MAX_VALUE_MIL   500

Definition at line 34 of file zones.h.

◆ ZONE_CLEARANCE_MIL

#define ZONE_CLEARANCE_MIL   20

Definition at line 33 of file zones.h.

◆ ZONE_EXPORT_VALUES

#define ZONE_EXPORT_VALUES   1004

Definition at line 37 of file zones.h.

◆ ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL

#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL   20

Definition at line 30 of file zones.h.

◆ ZONE_THERMAL_RELIEF_GAP_MIL

#define ZONE_THERMAL_RELIEF_GAP_MIL   20

Definition at line 29 of file zones.h.

◆ ZONE_THICKNESS_MIL

#define ZONE_THICKNESS_MIL   10

Definition at line 31 of file zones.h.

◆ ZONE_THICKNESS_MIN_VALUE_MIL

#define ZONE_THICKNESS_MIN_VALUE_MIL   1

Definition at line 32 of file zones.h.

Enumeration Type Documentation

◆ ZONE_CONNECTION

enum ZONE_CONNECTION
strong

How pads are covered by copper in zone.

Enumerator
INHERITED 
NONE 

Pads are not covered.

THERMAL 

Use thermal relief for pads.

FULL 

pads are covered by copper

THT_THERMAL 

Thermal relief only for THT pads.

Definition at line 41 of file zones.h.

42 {
43  INHERITED = -1,
44  NONE,
45  THERMAL,
46  FULL,
48 };
pads are covered by copper
Thermal relief only for THT pads.
Use thermal relief for pads.

Function Documentation

◆ InvokeCopperZonesEditor()

int InvokeCopperZonesEditor ( PCB_BASE_FRAME aCaller,
ZONE_SETTINGS aSettings 
)

Function InvokeCopperZonesEditor invokes up a modal dialog window for copper zone editing.

Parameters
aCalleris the PCB_BASE_FRAME calling parent window for the modal dialog, and it gives access to the BOARD through PCB_BASE_FRAME::GetBoard().
aSettingspoints to the ZONE_SETTINGS to edit.
Returns
int - tells if user aborted, changed only one zone, or all of them.

Definition at line 97 of file dialog_copper_zones.cpp.

98 {
99  DIALOG_COPPER_ZONE dlg( aCaller, aSettings );
100 
101  return dlg.ShowModal();
102 }

Referenced by ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

◆ InvokeKeepoutAreaEditor()

int InvokeKeepoutAreaEditor ( PCB_BASE_FRAME aCaller,
ZONE_SETTINGS aSettings 
)

Function InvokeKeepoutAreaEditor invokes up a modal dialog window for copper zone editing.

Parameters
aCalleris the PCB_BASE_FRAME calling parent window for the modal dialog, and it gives access to the BOARD through PCB_BASE_FRAME::GetBoard().
aSettingspoints to the ZONE_SETTINGS to edit.
Returns
int - tells if user aborted, changed only one zone, or all of them.

Definition at line 61 of file dialog_keepout_area_properties.cpp.

62 {
63  DIALOG_KEEPOUT_AREA_PROPERTIES dlg( aCaller, aSettings );
64 
65  return dlg.ShowModal();
66 }

Referenced by ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

◆ InvokeNonCopperZonesEditor()

int InvokeNonCopperZonesEditor ( PCB_BASE_FRAME aParent,
ZONE_SETTINGS aSettings 
)

Function InvokeNonCopperZonesEditor invokes up a modal dialog window for non-copper zone editing.

Parameters
aParentis the PCB_BASE_FRAME calling parent window for the modal dialog, and it gives access to the BOARD through PCB_BASE_FRAME::GetBoard().
aSettingspoints to the ZONE_SETTINGS to edit.
Returns
int - tells if user aborted, changed only one zone, or all of them.

Definition at line 66 of file dialog_non_copper_zones_properties.cpp.

67 {
68  DIALOG_NON_COPPER_ZONES_EDITOR dlg( aParent, aSettings );
69 
70  return dlg.ShowModal();
71 }

Referenced by ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), and PCB_EDITOR_CONTROL::ZoneDuplicate().