KiCad PCB EDA Suite
zones.h File Reference

Go to the source code of this file.

Macros

#define ZONE_NET_OUTLINES_HATCH_OPTION_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
 

Enumerations

enum  ZONE_EDIT_T { ZONE_ABORT, ZONE_OK, ZONE_EXPORT_VALUES }
 Exit codes for zone editing dialogs. More...
 
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

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

Macro Definition Documentation

#define ZONE_CLEARANCE_MAX_VALUE_MIL   500

Definition at line 43 of file zones.h.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

#define ZONE_CLEARANCE_MIL   20

Definition at line 42 of file zones.h.

Referenced by PCB_EDIT_FRAME::Begin_Zone(), and ZONE_SETTINGS::ZONE_SETTINGS().

#define ZONE_CLEARANCE_WIDTH_STRING_KEY   wxT( "Zone_Clearance" )

Definition at line 34 of file zones.h.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and PCB_EDIT_FRAME::Begin_Zone().

#define ZONE_MIN_THICKNESS_WIDTH_STRING_KEY   wxT( "Zone_Thickness" )

Definition at line 35 of file zones.h.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and PCB_EDIT_FRAME::Begin_Zone().

#define ZONE_NET_FILTER_STRING_KEY   wxT( "Zone_Filter_Opt" )
#define ZONE_NET_OUTLINES_HATCH_OPTION_KEY   wxT( "Zone_Ouline_Hatch_Opt" )
#define ZONE_NET_SORT_OPTION_KEY   wxT( "Zone_NetSort_Opt" )
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL   20

Definition at line 39 of file zones.h.

Referenced by PCB_EDIT_FRAME::Begin_Zone(), and ZONE_SETTINGS::ZONE_SETTINGS().

#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_STRING_KEY   wxT( "Zone_TH_Copper_Width" )

Definition at line 33 of file zones.h.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and PCB_EDIT_FRAME::Begin_Zone().

#define ZONE_THERMAL_RELIEF_GAP_MIL   20

Definition at line 38 of file zones.h.

Referenced by PCB_EDIT_FRAME::Begin_Zone(), and ZONE_SETTINGS::ZONE_SETTINGS().

#define ZONE_THERMAL_RELIEF_GAP_STRING_KEY   wxT( "Zone_TH_Gap" )

Definition at line 32 of file zones.h.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and PCB_EDIT_FRAME::Begin_Zone().

#define ZONE_THICKNESS_MIL   10

Definition at line 40 of file zones.h.

Referenced by PCB_EDIT_FRAME::Begin_Zone(), and ZONE_SETTINGS::ZONE_SETTINGS().

#define ZONE_THICKNESS_MIN_VALUE_MIL   1

Definition at line 41 of file zones.h.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

Enumeration Type Documentation

Exit codes for zone editing dialogs.

Enumerator
ZONE_ABORT 

if no change

ZONE_OK 

if new values were accepted

ZONE_EXPORT_VALUES 

if values were exported to others zones

Definition at line 47 of file zones.h.

47  {
48  ZONE_ABORT,
49  ZONE_OK,
51 };
if new values were accepted
Definition: zones.h:49
if values were exported to others zones
Definition: zones.h:50
if no change
Definition: zones.h:48

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 55 of file zones.h.

55  {
61 };
Pads are not covered.
Definition: zones.h:57
Thermal relief only for THT pads.
Definition: zones.h:60
Use thermal relief for pads.
Definition: zones.h:58
pads are covered by copper
Definition: zones.h:59

Function Documentation

ZONE_EDIT_T 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
ZONE_EDIT_T - tells if user aborted, changed only one zone, or all of them.

Definition at line 130 of file dialog_copper_zones.cpp.

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().

131 {
132  DIALOG_COPPER_ZONE dlg( aCaller, aSettings );
133 
134  ZONE_EDIT_T result = ZONE_EDIT_T( dlg.ShowModal() );
135  return result;
136 }
ZONE_EDIT_T
Exit codes for zone editing dialogs.
Definition: zones.h:47
Class DIALOG_COPPER_ZONE is the derived class from dialog_copper_zone_frame created by wxFormBuilder...
ZONE_EDIT_T 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
ZONE_EDIT_T - tells if user aborted, changed only one zone, or all of them.

Definition at line 97 of file dialog_keepout_area_properties.cpp.

References ZONE_ABORT, and ZONE_OK.

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().

98 {
99  DIALOG_KEEPOUT_AREA_PROPERTIES dlg( aCaller, aSettings );
100 
101  ZONE_EDIT_T result = ZONE_ABORT;
102 
103  if( dlg.ShowModal() == wxID_OK )
104  result = ZONE_OK;
105 
106  return result;
107 }
ZONE_EDIT_T
Exit codes for zone editing dialogs.
Definition: zones.h:47
if new values were accepted
Definition: zones.h:49
if no change
Definition: zones.h:48
Class DIALOG_KEEPOUT_AREA_PROPERTIES is the derived class from dialog_copper_zone_frame created by wx...
ZONE_EDIT_T InvokeNonCopperZonesEditor ( PCB_BASE_FRAME aParent,
ZONE_CONTAINER aZone,
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().
aZoneis the ZONE_CONTAINER to edit.
aSettingspoints to the ZONE_SETTINGS to edit.
Returns
ZONE_EDIT_T - tells if user aborted, changed only one zone, or all of them.

Definition at line 80 of file dialog_non_copper_zones_properties.cpp.

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().

82 {
83  DIALOG_NON_COPPER_ZONES_EDITOR dlg( aParent, aZone, aSettings );
84 
85  ZONE_EDIT_T result = ZONE_EDIT_T( dlg.ShowModal() );
86 
87  return result;
88 }
ZONE_EDIT_T
Exit codes for zone editing dialogs.
Definition: zones.h:47
Class DIALOG_NON_COPPER_ZONES_EDITOR is a dialog editor for non copper zones properties, derived from DIALOG_NONCOPPER_ZONES_PROPERTIES_BASE, which is maintained and created by wxFormBuilder.