KiCad PCB EDA Suite
zones.h File Reference

Go to the source code of this file.

Macros

#define ZONE_NET_OUTLINES_STYLE_KEY   wxT( "Zone_Ouline_Hatch_Opt" )
 
#define ZONE_NET_SORT_OPTION_KEY   wxT( "Zone_NetSort_Opt" )
 
#define ZONE_NET_FILTER_STRING_KEY   wxT( "Zone_Filter_Opt" )
 
#define ZONE_THERMAL_RELIEF_GAP_STRING_KEY   wxT( "Zone_TH_Gap" )
 
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_STRING_KEY   wxT( "Zone_TH_Copper_Width" )
 
#define ZONE_CLEARANCE_WIDTH_STRING_KEY   wxT( "Zone_Clearance" )
 
#define ZONE_MIN_THICKNESS_WIDTH_STRING_KEY   wxT( "Zone_Thickness" )
 
#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  ZoneConnection {
  PAD_ZONE_CONN_INHERITED = -1, PAD_ZONE_CONN_NONE, PAD_ZONE_CONN_THERMAL, PAD_ZONE_CONN_FULL,
  PAD_ZONE_CONN_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 43 of file zones.h.

◆ ZONE_CLEARANCE_MIL

#define ZONE_CLEARANCE_MIL   20

Definition at line 42 of file zones.h.

◆ ZONE_CLEARANCE_WIDTH_STRING_KEY

#define ZONE_CLEARANCE_WIDTH_STRING_KEY   wxT( "Zone_Clearance" )

Definition at line 34 of file zones.h.

◆ ZONE_EXPORT_VALUES

#define ZONE_EXPORT_VALUES   1004

Definition at line 46 of file zones.h.

◆ ZONE_MIN_THICKNESS_WIDTH_STRING_KEY

#define ZONE_MIN_THICKNESS_WIDTH_STRING_KEY   wxT( "Zone_Thickness" )

Definition at line 35 of file zones.h.

◆ ZONE_NET_FILTER_STRING_KEY

#define ZONE_NET_FILTER_STRING_KEY   wxT( "Zone_Filter_Opt" )

Definition at line 31 of file zones.h.

◆ ZONE_NET_OUTLINES_STYLE_KEY

#define ZONE_NET_OUTLINES_STYLE_KEY   wxT( "Zone_Ouline_Hatch_Opt" )

Definition at line 29 of file zones.h.

◆ ZONE_NET_SORT_OPTION_KEY

#define ZONE_NET_SORT_OPTION_KEY   wxT( "Zone_NetSort_Opt" )

Definition at line 30 of file zones.h.

◆ ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL

#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL   20

Definition at line 39 of file zones.h.

◆ ZONE_THERMAL_RELIEF_COPPER_WIDTH_STRING_KEY

#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_STRING_KEY   wxT( "Zone_TH_Copper_Width" )

Definition at line 33 of file zones.h.

◆ ZONE_THERMAL_RELIEF_GAP_MIL

#define ZONE_THERMAL_RELIEF_GAP_MIL   20

Definition at line 38 of file zones.h.

◆ ZONE_THERMAL_RELIEF_GAP_STRING_KEY

#define ZONE_THERMAL_RELIEF_GAP_STRING_KEY   wxT( "Zone_TH_Gap" )

Definition at line 32 of file zones.h.

◆ ZONE_THICKNESS_MIL

#define ZONE_THICKNESS_MIL   10

Definition at line 40 of file zones.h.

◆ ZONE_THICKNESS_MIN_VALUE_MIL

#define ZONE_THICKNESS_MIN_VALUE_MIL   1

Definition at line 41 of file zones.h.

Enumeration Type Documentation

◆ ZoneConnection

How pads are covered by copper in zone.

Enumerator
PAD_ZONE_CONN_INHERITED 
PAD_ZONE_CONN_NONE 

Pads are not covered.

PAD_ZONE_CONN_THERMAL 

Use thermal relief for pads.

PAD_ZONE_CONN_FULL 

pads are covered by copper

PAD_ZONE_CONN_THT_THERMAL 

Thermal relief only for THT pads.

Definition at line 50 of file zones.h.

50  {
56 };
Pads are not covered.
Definition: zones.h:52
Thermal relief only for THT pads.
Definition: zones.h:55
Use thermal relief for pads.
Definition: zones.h:53
pads are covered by copper
Definition: zones.h:54

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 96 of file dialog_copper_zones.cpp.

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

Referenced by PCB_EDIT_FRAME::Begin_Zone(), ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), 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 55 of file dialog_keepout_area_properties.cpp.

56 {
57  DIALOG_KEEPOUT_AREA_PROPERTIES dlg( aCaller, aSettings );
58 
59  return dlg.ShowModal();
60 }

Referenced by PCB_EDIT_FRAME::Begin_Zone(), ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), 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 65 of file dialog_non_copper_zones_properties.cpp.

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

Referenced by PCB_EDIT_FRAME::Begin_Zone(), ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), and PCB_EDITOR_CONTROL::ZoneDuplicate().