ZONE_SETTINGS handles zones parameters. More...

#include <zone_settings.h>

Public Types
enum	{ SMOOTHING_UNDEFINED = -1 , SMOOTHING_NONE = 0 , SMOOTHING_CHAMFER , SMOOTHING_FILLET , SMOOTHING_LAST }

Public Member Functions
	ZONE_SETTINGS ()

bool	operator== (const ZONE_SETTINGS &aOther) const

bool	operator!= (const ZONE_SETTINGS &aOther) const

ZONE_SETTINGS &	operator<< (const ZONE &aSource)
	operator << ( const ZONE& ) was Function ImportSetting copies settings from a given zone into this object.

void	SetupLayersList (wxDataViewListCtrl aList, PCB_BASE_FRAME aFrame, LSET aLayers, bool aFpEditorMode)
	A helper routine for the various zone dialogs (copper, non-copper, keepout).

void	ExportSetting (ZONE &aTarget, bool aFullExport=true) const
	Function ExportSetting copy settings to a given zone.

void	SetCornerSmoothingType (int aType)

int	GetCornerSmoothingType () const

void	SetCornerRadius (int aRadius)

unsigned int	GetCornerRadius () const

ZONE_CONNECTION	GetPadConnection () const

void	SetPadConnection (ZONE_CONNECTION aPadConnection)

bool	GetIsRuleArea () const
	Accessors to parameters used in Rule Area zones:

RULE_AREA_TYPE	GetRuleAreaType () const

const wxString &	GetRuleAreaExpression () const

bool	GetDoNotAllowCopperPour () const

bool	GetDoNotAllowVias () const

bool	GetDoNotAllowTracks () const

bool	GetDoNotAllowPads () const

bool	GetDoNotAllowFootprints () const

void	SetIsRuleArea (bool aEnable)

void	SetRuleAreaType (RULE_AREA_TYPE aType)

void	SetRuleAreaExpression (const wxString &aExpr)

void	SetDoNotAllowCopperPour (bool aEnable)

void	SetDoNotAllowVias (bool aEnable)

void	SetDoNotAllowTracks (bool aEnable)

void	SetDoNotAllowPads (bool aEnable)

void	SetDoNotAllowFootprints (bool aEnable)

ISLAND_REMOVAL_MODE	GetIslandRemovalMode () const

void	SetIslandRemovalMode (ISLAND_REMOVAL_MODE aRemove)

long long int	GetMinIslandArea () const

void	SetMinIslandArea (long long int aArea)

Static Public Member Functions
static const ZONE_SETTINGS &	GetDefaultSettings ()

Public Attributes
unsigned	m_ZonePriority

ZONE_FILL_MODE	m_FillMode

int	m_ZoneClearance

int	m_ZoneMinThickness

int	m_HatchThickness

int	m_HatchGap

EDA_ANGLE	m_HatchOrientation

int	m_HatchSmoothingLevel

double	m_HatchSmoothingValue

double	m_HatchHoleMinArea

int	m_HatchBorderAlgorithm

int	m_NetcodeSelection

wxString	m_Name

LSET	m_Layers

ZONE_BORDER_DISPLAY_STYLE	m_ZoneBorderDisplayStyle
	Option to show the zone area (outlines only, short hatches or full hatches.

int	m_BorderHatchPitch

long	m_ThermalReliefGap

long	m_ThermalReliefSpokeWidth

bool	m_Locked

TEARDROP_TYPE	m_TeardropType

Private Attributes
int	m_cornerSmoothingType

unsigned int	m_cornerRadius

ZONE_CONNECTION	m_padConnection

bool	m_isRuleArea

RULE_AREA_TYPE	m_ruleAreaType

bool	m_keepoutDoNotAllowCopperPour

bool	m_keepoutDoNotAllowVias

bool	m_keepoutDoNotAllowTracks

bool	m_keepoutDoNotAllowPads

bool	m_keepoutDoNotAllowFootprints

wxString	m_ruleAreaExpression

ISLAND_REMOVAL_MODE	m_removeIslands

long long int	m_minIslandArea

Detailed Description

ZONE_SETTINGS handles zones parameters.

Because a zone can be on copper or non copper layers, and can be also a keepout area, some parameters are irrelevant depending on the type of zone

Definition at line 77 of file zone_settings.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SMOOTHING_UNDEFINED
SMOOTHING_NONE
SMOOTHING_CHAMFER
SMOOTHING_FILLET
SMOOTHING_LAST

Definition at line 81 of file zone_settings.h.

Constructor & Destructor Documentation

◆ ZONE_SETTINGS()

ZONE_SETTINGS::ZONE_SETTINGS ( )

Definition at line 38 of file zone_settings.cpp.

References ANGLE_0, F_Cu, EDA_IU_SCALE::IU_PER_MM, m_BorderHatchPitch, m_cornerRadius, m_cornerSmoothingType, m_FillMode, m_HatchBorderAlgorithm, m_HatchGap, m_HatchHoleMinArea, m_HatchOrientation, m_HatchSmoothingLevel, m_HatchSmoothingValue, m_HatchThickness, m_Layers, m_Locked, m_minIslandArea, m_Name, m_NetcodeSelection, m_padConnection, m_removeIslands, m_ruleAreaType, m_TeardropType, m_ThermalReliefGap, m_ThermalReliefSpokeWidth, m_ZoneBorderDisplayStyle, m_ZoneClearance, m_ZoneMinThickness, m_ZonePriority, EDA_IU_SCALE::mmToIU(), pcbIUScale, BASE_SET::reset(), BASE_SET::set(), SetDoNotAllowCopperPour(), SetDoNotAllowFootprints(), SetDoNotAllowPads(), SetDoNotAllowTracks(), SetDoNotAllowVias(), SetIsRuleArea(), SMOOTHING_NONE, ZONE_BORDER_HATCH_DIST_MM, ZONE_CLEARANCE_MM, ZONE_THERMAL_RELIEF_COPPER_WIDTH_MM, ZONE_THERMAL_RELIEF_GAP_MM, and ZONE_THICKNESS_MM.

Member Function Documentation

◆ ExportSetting()

void ZONE_SETTINGS::ExportSetting	(	ZONE &	aTarget,
		bool	aFullExport = `true`
	)		const

Function ExportSetting copy settings to a given zone.

Parameters

aTarget	the given zone
aFullExport	if false: some parameters are NOT exported because they must not be exported when export settings from a zone to others zones Currently: m_NetcodeSelection

Definition at line 178 of file zone_settings.cpp.

References GetDoNotAllowCopperPour(), GetDoNotAllowFootprints(), GetDoNotAllowPads(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetIslandRemovalMode(), GetIsRuleArea(), GetMinIslandArea(), GetRuleAreaExpression(), GetRuleAreaType(), m_BorderHatchPitch, m_cornerRadius, m_cornerSmoothingType, m_FillMode, m_HatchBorderAlgorithm, m_HatchGap, m_HatchHoleMinArea, m_HatchOrientation, m_HatchSmoothingLevel, m_HatchSmoothingValue, m_HatchThickness, m_isRuleArea, m_Layers, m_Locked, m_Name, m_NetcodeSelection, m_padConnection, m_TeardropType, m_ThermalReliefGap, m_ThermalReliefSpokeWidth, m_ZoneBorderDisplayStyle, m_ZoneClearance, m_ZoneMinThickness, m_ZonePriority, ZONE::SetAssignedPriority(), ZONE::SetBorderDisplayStyle(), ZONE::SetCornerRadius(), ZONE::SetCornerSmoothingType(), ZONE::SetDoNotAllowCopperPour(), ZONE::SetDoNotAllowFootprints(), ZONE::SetDoNotAllowPads(), ZONE::SetDoNotAllowTracks(), ZONE::SetDoNotAllowVias(), ZONE::SetFillMode(), ZONE::SetHatchBorderAlgorithm(), ZONE::SetHatchGap(), ZONE::SetHatchHoleMinArea(), ZONE::SetHatchOrientation(), ZONE::SetHatchSmoothingLevel(), ZONE::SetHatchSmoothingValue(), ZONE::SetHatchThickness(), ZONE::SetIslandRemovalMode(), ZONE::SetIsRuleArea(), ZONE::SetLayerSet(), ZONE::SetLocalClearance(), BOARD_ITEM::SetLocked(), ZONE::SetMinIslandArea(), ZONE::SetMinThickness(), BOARD_CONNECTED_ITEM::SetNetCode(), ZONE::SetPadConnection(), ZONE::SetRuleAreaExpression(), ZONE::SetRuleAreaType(), ZONE::SetTeardropAreaType(), ZONE::SetThermalReliefGap(), ZONE::SetThermalReliefSpokeWidth(), and ZONE::SetZoneName().

Referenced by ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), TEARDROP_MANAGER::createTeardrop(), ZONE_CREATE_HELPER::createZoneFromExisting(), PCB_EDIT_FRAME::Edit_Zone_Params(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), ZONE::ZONE(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

◆ GetCornerRadius()

unsigned int ZONE_SETTINGS::GetCornerRadius ( ) const

inline

Definition at line 190 of file zone_settings.h.

References m_cornerRadius.

Referenced by DIALOG_COPPER_ZONE::TransferDataToWindow(), and DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow().

◆ GetCornerSmoothingType()

int ZONE_SETTINGS::GetCornerSmoothingType ( ) const

inline

Definition at line 187 of file zone_settings.h.

References m_cornerSmoothingType.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow().

◆ GetDefaultSettings()

const ZONE_SETTINGS & ZONE_SETTINGS::GetDefaultSettings ( )

static

Returns: Default ZONE_SETTINGS

Definition at line 248 of file zone_settings.cpp.

Referenced by TEARDROP_MANAGER::createTeardrop().

◆ GetDoNotAllowCopperPour()

bool ZONE_SETTINGS::GetDoNotAllowCopperPour ( ) const

inline

Definition at line 201 of file zone_settings.h.

References m_keepoutDoNotAllowCopperPour.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetDoNotAllowFootprints()

bool ZONE_SETTINGS::GetDoNotAllowFootprints ( ) const

inline

Definition at line 205 of file zone_settings.h.

References m_keepoutDoNotAllowFootprints.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetDoNotAllowPads()

bool ZONE_SETTINGS::GetDoNotAllowPads ( ) const

inline

Definition at line 204 of file zone_settings.h.

References m_keepoutDoNotAllowPads.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetDoNotAllowTracks()

bool ZONE_SETTINGS::GetDoNotAllowTracks ( ) const

inline

Definition at line 203 of file zone_settings.h.

References m_keepoutDoNotAllowTracks.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetDoNotAllowVias()

bool ZONE_SETTINGS::GetDoNotAllowVias ( ) const

inline

Definition at line 202 of file zone_settings.h.

References m_keepoutDoNotAllowVias.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetIslandRemovalMode()

ISLAND_REMOVAL_MODE ZONE_SETTINGS::GetIslandRemovalMode ( ) const

inline

Definition at line 216 of file zone_settings.h.

References m_removeIslands.

Referenced by ExportSetting(), DIALOG_COPPER_ZONE::OnNetSelectionUpdated(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ GetIsRuleArea()

bool ZONE_SETTINGS::GetIsRuleArea ( ) const

inline

Accessors to parameters used in Rule Area zones:

Definition at line 198 of file zone_settings.h.

References m_isRuleArea.

Referenced by ExportSetting().

◆ GetMinIslandArea()

long long int ZONE_SETTINGS::GetMinIslandArea ( ) const

inline

Definition at line 219 of file zone_settings.h.

References m_minIslandArea.

Referenced by ExportSetting(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ GetPadConnection()

ZONE_CONNECTION ZONE_SETTINGS::GetPadConnection ( ) const

inline

Definition at line 192 of file zone_settings.h.

References m_padConnection.

Referenced by DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ GetRuleAreaExpression()

const wxString & ZONE_SETTINGS::GetRuleAreaExpression ( ) const

inline

Definition at line 200 of file zone_settings.h.

References m_ruleAreaExpression.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetRuleAreaType()

RULE_AREA_TYPE ZONE_SETTINGS::GetRuleAreaType ( ) const

inline

Definition at line 199 of file zone_settings.h.

References m_ruleAreaType.

Referenced by ExportSetting(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ operator!=()

bool ZONE_SETTINGS::operator!= ( const ZONE_SETTINGS & aOther ) const

inline

Definition at line 151 of file zone_settings.h.

References operator==().

◆ operator<<()

ZONE_SETTINGS & ZONE_SETTINGS::operator<< ( const ZONE & aSource )

operator << ( const ZONE& ) was Function ImportSetting copies settings from a given zone into this object.

Parameters

aSource the given zone

Definition at line 133 of file zone_settings.cpp.

References ZONE::GetAssignedPriority(), ZONE::GetBorderHatchPitch(), ZONE::GetCornerRadius(), ZONE::GetCornerSmoothingType(), ZONE::GetDoNotAllowCopperPour(), ZONE::GetDoNotAllowFootprints(), ZONE::GetDoNotAllowPads(), ZONE::GetDoNotAllowTracks(), ZONE::GetDoNotAllowVias(), ZONE::GetFillMode(), ZONE::GetHatchBorderAlgorithm(), ZONE::GetHatchGap(), ZONE::GetHatchHoleMinArea(), ZONE::GetHatchOrientation(), ZONE::GetHatchSmoothingLevel(), ZONE::GetHatchSmoothingValue(), ZONE::GetHatchStyle(), ZONE::GetHatchThickness(), ZONE::GetIslandRemovalMode(), ZONE::GetIsRuleArea(), ZONE::GetLayerSet(), ZONE::GetLocalClearance(), ZONE::GetMinIslandArea(), ZONE::GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), ZONE::GetPadConnection(), ZONE::GetRuleAreaExpression(), ZONE::GetRuleAreaType(), ZONE::GetTeardropAreaType(), ZONE::GetThermalReliefGap(), ZONE::GetThermalReliefSpokeWidth(), ZONE::GetZoneName(), BOARD_ITEM::IsLocked(), m_BorderHatchPitch, m_cornerRadius, m_cornerSmoothingType, m_FillMode, m_HatchBorderAlgorithm, m_HatchGap, m_HatchHoleMinArea, m_HatchOrientation, m_HatchSmoothingLevel, m_HatchSmoothingValue, m_HatchThickness, m_isRuleArea, m_keepoutDoNotAllowCopperPour, m_keepoutDoNotAllowFootprints, m_keepoutDoNotAllowPads, m_keepoutDoNotAllowTracks, m_keepoutDoNotAllowVias, m_Layers, m_Locked, m_minIslandArea, m_Name, m_NetcodeSelection, m_padConnection, m_removeIslands, m_ruleAreaExpression, m_ruleAreaType, m_TeardropType, m_ThermalReliefGap, m_ThermalReliefSpokeWidth, m_ZoneBorderDisplayStyle, m_ZoneClearance, m_ZoneMinThickness, and m_ZonePriority.

◆ operator==()

bool ZONE_SETTINGS::operator== ( const ZONE_SETTINGS & aOther ) const

◆ SetCornerRadius()

void ZONE_SETTINGS::SetCornerRadius ( int aRadius )

Definition at line 230 of file zone_settings.cpp.

References m_cornerRadius.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow().

◆ SetCornerSmoothingType()

void ZONE_SETTINGS::SetCornerSmoothingType ( int aType )

inline

Definition at line 186 of file zone_settings.h.

References m_cornerSmoothingType.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow().

◆ SetDoNotAllowCopperPour()

void ZONE_SETTINGS::SetDoNotAllowCopperPour ( bool aEnable )

inline

Definition at line 210 of file zone_settings.h.

References m_keepoutDoNotAllowCopperPour.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetDoNotAllowFootprints()

void ZONE_SETTINGS::SetDoNotAllowFootprints ( bool aEnable )

inline

Definition at line 214 of file zone_settings.h.

References m_keepoutDoNotAllowFootprints.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetDoNotAllowPads()

void ZONE_SETTINGS::SetDoNotAllowPads ( bool aEnable )

inline

Definition at line 213 of file zone_settings.h.

References m_keepoutDoNotAllowPads.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetDoNotAllowTracks()

void ZONE_SETTINGS::SetDoNotAllowTracks ( bool aEnable )

inline

Definition at line 212 of file zone_settings.h.

References m_keepoutDoNotAllowTracks.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetDoNotAllowVias()

void ZONE_SETTINGS::SetDoNotAllowVias ( bool aEnable )

inline

Definition at line 211 of file zone_settings.h.

References m_keepoutDoNotAllowVias.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetIslandRemovalMode()

void ZONE_SETTINGS::SetIslandRemovalMode ( ISLAND_REMOVAL_MODE aRemove )

inline

Definition at line 217 of file zone_settings.h.

References m_removeIslands.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), and DIALOG_COPPER_ZONE::OnNetSelectionUpdated().

◆ SetIsRuleArea()

void ZONE_SETTINGS::SetIsRuleArea ( bool aEnable )

inline

Definition at line 207 of file zone_settings.h.

References m_isRuleArea.

Referenced by ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), and ZONE_SETTINGS().

◆ SetMinIslandArea()

void ZONE_SETTINGS::SetMinIslandArea ( long long int aArea )

inline

Definition at line 220 of file zone_settings.h.

References m_minIslandArea.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

◆ SetPadConnection()

void ZONE_SETTINGS::SetPadConnection ( ZONE_CONNECTION aPadConnection )

inline

Definition at line 193 of file zone_settings.h.

References m_padConnection.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions().

◆ SetRuleAreaExpression()

void ZONE_SETTINGS::SetRuleAreaExpression ( const wxString & aExpr )

inline

Definition at line 209 of file zone_settings.h.

References m_ruleAreaExpression.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow().

◆ SetRuleAreaType()

void ZONE_SETTINGS::SetRuleAreaType ( RULE_AREA_TYPE aType )

inline

Definition at line 208 of file zone_settings.h.

References m_ruleAreaType.

Referenced by DIALOG_RULE_AREA_PROPERTIES::OnRuleTypeSelect(), and DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow().

◆ SetupLayersList()

void ZONE_SETTINGS::SetupLayersList	(	wxDataViewListCtrl *	aList,
		PCB_BASE_FRAME *	aFrame,
		LSET	aLayers,
		bool	aFpEditorMode
	)

A helper routine for the various zone dialogs (copper, non-copper, keepout).

Parameters

aList	the wxDataViewListCtrl to populate
aFrame	the parent editor frame
aFpEditorMode	true to show a single "Inner Layers" item for all inner copper layers

Definition at line 258 of file zone_settings.cpp.

References _, CHECKERBOARD_SIZE(), PCB_BASE_FRAME::GetBoard(), COLOR_SETTINGS::GetColor(), PCB_BASE_FRAME::GetColorSettings(), BOARD::GetLayerName(), KIUI::GetTextSize(), In1_Cu, LAYER_BITMAP_SIZE(), LAYER_PCB_BACKGROUND, m_Layers, COLOR_SWATCH::MakeBitmap(), BASE_SET::set(), and LSET::UIOrder().