zone.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#include <advanced_config.h>
#include <bitmaps.h>
#include <geometry/geometry_utils.h>
#include <geometry/shape_null.h>
#include <pcb_edit_frame.h>
#include <pcb_screen.h>
#include <board.h>
#include <board_design_settings.h>
#include <lset.h>
#include <pad.h>
#include <zone.h>
#include <footprint.h>
#include <string_utils.h>
#include <properties/property_validators.h>
#include <properties/property.h>
#include <properties/property_mgr.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
#include <trigo.h>
#include <i18n_utility.h>
#include <mutex>
#include <magic_enum.hpp>
 
#include <google/protobuf/any.pb.h>
#include <api/api_enums.h>
#include <api/api_utils.h>
#include <api/api_pcb_utils.h>
#include <api/board/board_types.pb.h>
 
 
ZONE::ZONE( BOARD_ITEM_CONTAINER* aParent ) :
        BOARD_CONNECTED_ITEM( aParent, PCB_ZONE_T ),
        m_Poly( nullptr ),
        m_cornerRadius( 0 ),
        m_priority( 0 ),
        m_isRuleArea( false ),
        m_placementAreaEnabled( false ),
        m_placementAreaSourceType( PLACEMENT_SOURCE_T::SHEETNAME ),
        m_teardropType( TEARDROP_TYPE::TD_NONE ),
        m_PadConnection( ZONE_CONNECTION::NONE ),
        m_ZoneClearance( 0 ),
        m_ZoneMinThickness( 0 ),
        m_islandRemovalMode( ISLAND_REMOVAL_MODE::ALWAYS ),
        m_isFilled( false ),
        m_thermalReliefGap( 0 ),
        m_thermalReliefSpokeWidth( 0 ),
        m_fillMode( ZONE_FILL_MODE::POLYGONS ),
        m_hatchThickness( 0 ),
        m_hatchGap( 0 ),
        m_hatchOrientation( ANGLE_0 ),
        m_hatchSmoothingLevel( 0 ),
        m_hatchHoleMinArea( 0 ),
        m_area( 0.0 ),
        m_outlinearea( 0.0 )
{
    m_Poly = new SHAPE_POLY_SET();    // Outlines
    SetLocalFlags( 0 );               // flags temporary used in zone calculations
    m_fillVersion = 5;                // set the "old" way to build filled polygon areas (< 6.0.x)
 
    if( GetParentFootprint() )
        SetIsRuleArea( true );        // Zones living in footprints have the rule area option
 
    if( aParent->GetBoard() )
        aParent->GetBoard()->GetDesignSettings().GetDefaultZoneSettings().ExportSetting( *this, false );
    else
        ZONE_SETTINGS().ExportSetting( *this, false );
 
    m_needRefill = false;   // True only after edits.
}
 
 
ZONE::ZONE( const ZONE& aZone ) :
        BOARD_CONNECTED_ITEM( aZone ),
        m_Poly( nullptr )
{
    InitDataFromSrcInCopyCtor( aZone );
}
 
 
ZONE& ZONE::operator=( const ZONE& aOther )
{
    BOARD_CONNECTED_ITEM::operator=( aOther );
 
    InitDataFromSrcInCopyCtor( aOther );
 
    return *this;
}
 
 
void ZONE::CopyFrom( const BOARD_ITEM* aOther )
{
    wxCHECK( aOther && aOther->Type() == PCB_ZONE_T, /* void */ );
    *this = *static_cast<const ZONE*>( aOther );
}
 
 
ZONE::~ZONE()
{
    delete m_Poly;
 
    if( BOARD* board = GetBoard() )
        board->IncrementTimeStamp();
}
 
 
void ZONE::InitDataFromSrcInCopyCtor( const ZONE& aZone, PCB_LAYER_ID aLayer )
{
    // members are expected non initialize in this.
    // InitDataFromSrcInCopyCtor() is expected to be called only from a copy constructor.
 
    // Copy only useful EDA_ITEM flags:
    m_flags                   = aZone.m_flags;
    m_forceVisible            = aZone.m_forceVisible;
 
    // Replace the outlines for aZone outlines.
    delete m_Poly;
    m_Poly = new SHAPE_POLY_SET( *aZone.m_Poly );
 
    m_cornerSmoothingType     = aZone.m_cornerSmoothingType;
    m_cornerRadius            = aZone.m_cornerRadius;
    m_zoneName                = aZone.m_zoneName;
    m_priority                = aZone.m_priority;
    m_isRuleArea              = aZone.m_isRuleArea;
    m_placementAreaEnabled    = aZone.m_placementAreaEnabled;
    m_placementAreaSourceType = aZone.m_placementAreaSourceType;
    m_placementAreaSource     = aZone.m_placementAreaSource;
 
    if( aLayer == UNDEFINED_LAYER )
        SetLayerSet( aZone.GetLayerSet() );
    else
        SetLayerSet( { aLayer } );
 
    m_doNotAllowZoneFills     = aZone.m_doNotAllowZoneFills;
    m_doNotAllowVias          = aZone.m_doNotAllowVias;
    m_doNotAllowTracks        = aZone.m_doNotAllowTracks;
    m_doNotAllowPads          = aZone.m_doNotAllowPads;
    m_doNotAllowFootprints    = aZone.m_doNotAllowFootprints;
 
    m_PadConnection           = aZone.m_PadConnection;
    m_ZoneClearance           = aZone.m_ZoneClearance;     // clearance value
    m_ZoneMinThickness        = aZone.m_ZoneMinThickness;
    m_fillVersion             = aZone.m_fillVersion;
    m_islandRemovalMode       = aZone.m_islandRemovalMode;
    m_minIslandArea           = aZone.m_minIslandArea;
 
    m_isFilled                = aZone.m_isFilled;
    m_needRefill              = aZone.m_needRefill.load();
    m_teardropType            = aZone.m_teardropType;
 
    m_thermalReliefGap        = aZone.m_thermalReliefGap;
    m_thermalReliefSpokeWidth = aZone.m_thermalReliefSpokeWidth;
 
    m_fillMode                = aZone.m_fillMode;         // solid vs. hatched
    m_hatchThickness          = aZone.m_hatchThickness;
    m_hatchGap                = aZone.m_hatchGap;
    m_hatchOrientation        = aZone.m_hatchOrientation;
    m_hatchSmoothingLevel     = aZone.m_hatchSmoothingLevel;
    m_hatchSmoothingValue     = aZone.m_hatchSmoothingValue;
    m_hatchBorderAlgorithm    = aZone.m_hatchBorderAlgorithm;
    m_hatchHoleMinArea        = aZone.m_hatchHoleMinArea;
    m_thievingSettings        = aZone.m_thievingSettings;
 
    aZone.GetLayerSet().RunOnLayers(
            [&]( PCB_LAYER_ID layer )
            {
                if( aLayer != UNDEFINED_LAYER && aLayer != layer )
                    return;
 
                std::shared_ptr<SHAPE_POLY_SET> fill = aZone.m_FilledPolysList.at( layer );
 
                if( fill )
                    m_FilledPolysList[layer] = std::make_shared<SHAPE_POLY_SET>( *fill );
                else
                    m_FilledPolysList[layer] = std::make_shared<SHAPE_POLY_SET>();
 
                m_filledPolysHash[layer]  = aZone.m_filledPolysHash.at( layer );
                m_insulatedIslands[layer] = aZone.m_insulatedIslands.at( layer );
            } );
 
    m_layerProperties         = aZone.m_layerProperties;
 
    m_borderStyle             = aZone.m_borderStyle;
    m_borderHatchPitch        = aZone.m_borderHatchPitch;
    m_borderHatchLines        = aZone.m_borderHatchLines;
 
    SetLocalFlags( aZone.GetLocalFlags() );
 
    m_netinfo                 = aZone.m_netinfo;
    m_area                    = aZone.m_area;
    m_outlinearea             = aZone.m_outlinearea;
}
 
 
EDA_ITEM* ZONE::Clone() const
{
    return new ZONE( *this );
}
 
 
ZONE* ZONE::Clone( PCB_LAYER_ID aLayer ) const
{
    ZONE* clone = new ZONE( BOARD_ITEM::GetParent() );
    clone->InitDataFromSrcInCopyCtor( *this, aLayer );
    return clone;
}
 
 
void ZONE::Serialize( google::protobuf::Any& aContainer ) const
{
    using namespace kiapi::board;
    types::Zone zone;
    using kiapi::common::PackVector2;
 
    zone.mutable_id()->set_value( m_Uuid.AsStdString() );
    PackLayerSet( *zone.mutable_layers(), GetLayerSet() );
 
    if( m_isRuleArea )
        zone.set_type( types::ZT_RULE_AREA );
    else if( m_teardropType != TEARDROP_TYPE::TD_NONE )
        zone.set_type( types::ZT_TEARDROP );
    else if( IsOnCopperLayer() )
        zone.set_type( types::ZT_COPPER );
    else
        zone.set_type( types::ZT_GRAPHICAL );
 
    kiapi::common::PackPolySet( *zone.mutable_outline(), *m_Poly );
 
    zone.set_name( m_zoneName.ToUTF8() );
    zone.set_priority( m_priority );
    zone.set_filled( m_isFilled );
 
    if( m_isRuleArea )
    {
        types::RuleAreaSettings* ra = zone.mutable_rule_area_settings();
        ra->set_keepout_copper( m_doNotAllowZoneFills );
        ra->set_keepout_footprints( m_doNotAllowFootprints );
        ra->set_keepout_pads( m_doNotAllowPads );
        ra->set_keepout_tracks( m_doNotAllowTracks );
        ra->set_keepout_vias( m_doNotAllowVias );
 
        ra->set_placement_enabled( m_placementAreaEnabled );
        ra->set_placement_source( m_placementAreaSource.ToUTF8() );
        ra->set_placement_source_type( ToProtoEnum<PLACEMENT_SOURCE_T,
                                                   types::PlacementRuleSourceType>( m_placementAreaSourceType ) );
    }
    else
    {
        types::CopperZoneSettings* cu = zone.mutable_copper_settings();
        cu->mutable_connection()->set_zone_connection(
                ToProtoEnum<ZONE_CONNECTION, types::ZoneConnectionStyle>( m_PadConnection ) );
 
        types::ThermalSpokeSettings* thermals = cu->mutable_connection()->mutable_thermal_spokes();
        thermals->mutable_width()->set_value_nm( m_thermalReliefSpokeWidth );
        thermals->mutable_gap()->set_value_nm( m_thermalReliefGap );
        // n.b. zones don't currently have an overall thermal angle override
 
        cu->mutable_clearance()->set_value_nm( m_ZoneClearance );
        cu->mutable_min_thickness()->set_value_nm( m_ZoneMinThickness );
        cu->set_island_mode(
                ToProtoEnum<ISLAND_REMOVAL_MODE, types::IslandRemovalMode>( m_islandRemovalMode ) );
        cu->set_min_island_area( m_minIslandArea );
        cu->set_fill_mode( ToProtoEnum<ZONE_FILL_MODE, types::ZoneFillMode>( m_fillMode ) );
 
        types::HatchFillSettings* hatch = cu->mutable_hatch_settings();
        hatch->mutable_thickness()->set_value_nm( m_hatchThickness );
        hatch->mutable_gap()->set_value_nm( m_hatchGap );
        hatch->mutable_orientation()->set_value_degrees( m_hatchOrientation.AsDegrees() );
        hatch->set_hatch_smoothing_ratio( m_hatchSmoothingValue );
        hatch->set_hatch_hole_min_area_ratio( m_hatchHoleMinArea );
 
        switch( m_hatchBorderAlgorithm )
        {
        default:
        case 0: hatch->set_border_mode( types::ZHFBM_USE_MIN_ZONE_THICKNESS ); break;
        case 1: hatch->set_border_mode( types::ZHFBM_USE_HATCH_THICKNESS );    break;
        }
 
        PackNet( cu->mutable_net() );
        cu->mutable_teardrop()->set_type(
                ToProtoEnum<TEARDROP_TYPE, types::TeardropType>( m_teardropType ) );
 
        types::ThievingFillSettings* thieving = cu->mutable_thieving_settings();
        thieving->set_pattern(
                ToProtoEnum<THIEVING_PATTERN, types::ThievingPattern>( m_thievingSettings.pattern ) );
        thieving->mutable_element_size()->set_value_nm( m_thievingSettings.element_size );
        thieving->mutable_gap()->set_value_nm( m_thievingSettings.gap );
        thieving->mutable_line_width()->set_value_nm( m_thievingSettings.line_width );
        thieving->set_stagger( m_thievingSettings.stagger );
        thieving->mutable_orientation()->set_value_degrees(
                m_thievingSettings.orientation.AsDegrees() );
    }
 
    for( const auto& [layer, shape] : m_FilledPolysList )
    {
        types::ZoneFilledPolygons* filledLayer = zone.add_filled_polygons();
        filledLayer->set_layer( ToProtoEnum<PCB_LAYER_ID, types::BoardLayer>( layer ) );
        kiapi::common::PackPolySet( *filledLayer->mutable_shapes(), *shape );
    }
 
    for( const auto& [layer, properties] : m_layerProperties )
    {
        types::ZoneLayerProperties* layerProperties = zone.add_layer_properties();
        layerProperties->set_layer( ToProtoEnum<PCB_LAYER_ID, types::BoardLayer>( layer ) );
 
        if( properties.hatching_offset.has_value() )
        {
            PackVector2( *layerProperties->mutable_hatching_offset(),
                         properties.hatching_offset.value() );
        }
    }
 
    zone.mutable_border()->set_style(
            ToProtoEnum<ZONE_BORDER_DISPLAY_STYLE, types::ZoneBorderStyle>( m_borderStyle ) );
    zone.mutable_border()->mutable_pitch()->set_value_nm( m_borderHatchPitch );
 
    aContainer.PackFrom( zone );
}
 
 
bool ZONE::Deserialize( const google::protobuf::Any& aContainer )
{
    using namespace kiapi::board;
    types::Zone zone;
    using kiapi::common::UnpackVector2;
 
    if( !aContainer.UnpackTo( &zone ) )
        return false;
 
    SetUuidDirect( KIID( zone.id().value() ) );
    SetLayerSet( UnpackLayerSet( zone.layers() ) );
    SetAssignedPriority( zone.priority() );
    SetZoneName( wxString::FromUTF8( zone.name() ) );
 
    if( zone.type() == types::ZoneType::ZT_RULE_AREA )
        m_isRuleArea = true;
 
    if( !m_Poly )
        SetOutline( new SHAPE_POLY_SET );
 
    *m_Poly = kiapi::common::UnpackPolySet( zone.outline() );
 
    if( m_Poly->OutlineCount() == 0 )
        return false;
 
    if( m_isRuleArea )
    {
        const types::RuleAreaSettings& ra = zone.rule_area_settings();
        m_doNotAllowZoneFills = ra.keepout_copper();
        m_doNotAllowFootprints = ra.keepout_footprints();
        m_doNotAllowPads = ra.keepout_pads();
        m_doNotAllowTracks = ra.keepout_tracks();
        m_doNotAllowVias = ra.keepout_vias();
 
        m_placementAreaEnabled = ra.placement_enabled();
        m_placementAreaSource = wxString::FromUTF8( ra.placement_source() );
        m_placementAreaSourceType = FromProtoEnum<PLACEMENT_SOURCE_T>( ra.placement_source_type() );
    }
    else
    {
        const types::CopperZoneSettings& cu = zone.copper_settings();
        m_PadConnection = FromProtoEnum<ZONE_CONNECTION>( cu.connection().zone_connection() );
        m_thermalReliefSpokeWidth = cu.connection().thermal_spokes().width().value_nm();
        m_thermalReliefGap = cu.connection().thermal_spokes().gap().value_nm();
        m_ZoneClearance = cu.clearance().value_nm();
        m_ZoneMinThickness = cu.min_thickness().value_nm();
        m_islandRemovalMode = FromProtoEnum<ISLAND_REMOVAL_MODE>( cu.island_mode() );
        m_minIslandArea = cu.min_island_area();
        // Route through SetFillMode so the thieving single-layer / net-less invariants
        // are enforced on protobuf imports — a direct m_fillMode assignment would leave
        // the multi-layer set unpacked at line 355 in place for ZFM_COPPER_THIEVING.
        SetFillMode( FromProtoEnum<ZONE_FILL_MODE>( cu.fill_mode() ) );
 
        m_hatchThickness = cu.hatch_settings().thickness().value_nm();
        m_hatchGap = cu.hatch_settings().gap().value_nm();
        m_hatchOrientation = EDA_ANGLE( cu.hatch_settings().orientation().value_degrees(), DEGREES_T );
        m_hatchSmoothingValue = cu.hatch_settings().hatch_smoothing_ratio();
        m_hatchHoleMinArea = cu.hatch_settings().hatch_hole_min_area_ratio();
 
        switch( cu.hatch_settings().border_mode() )
        {
        default:
        case types::ZHFBM_USE_MIN_ZONE_THICKNESS: m_hatchBorderAlgorithm = 0; break;
        case types::ZHFBM_USE_HATCH_THICKNESS:    m_hatchBorderAlgorithm = 1; break;
        }
 
        UnpackNet( cu.net() );
        m_teardropType = FromProtoEnum<TEARDROP_TYPE>( cu.teardrop().type() );
 
        if( cu.has_thieving_settings() )
        {
            const types::ThievingFillSettings& thieving = cu.thieving_settings();
            m_thievingSettings.pattern =
                    FromProtoEnum<THIEVING_PATTERN>( thieving.pattern() );
 
            auto assignIfPositive = []( int aProtoValue, int& aTarget )
            {
                if( aProtoValue > 0 )
                    aTarget = aProtoValue;
            };
 
            assignIfPositive( thieving.element_size().value_nm(), m_thievingSettings.element_size );
            assignIfPositive( thieving.gap().value_nm(),          m_thievingSettings.gap );
            assignIfPositive( thieving.line_width().value_nm(),   m_thievingSettings.line_width );
 
            m_thievingSettings.stagger = thieving.stagger();
            m_thievingSettings.orientation =
                    EDA_ANGLE( thieving.orientation().value_degrees(), DEGREES_T );
        }
 
        for( const auto& properties : zone.layer_properties() )
        {
            PCB_LAYER_ID layer = FromProtoEnum<PCB_LAYER_ID>( properties.layer() );
 
            ZONE_LAYER_PROPERTIES layerProperties;
 
            if( properties.has_hatching_offset() )
                layerProperties.hatching_offset = UnpackVector2( properties.hatching_offset() );
 
            m_layerProperties[layer] = layerProperties;
        }
    }
 
    m_borderStyle = FromProtoEnum<ZONE_BORDER_DISPLAY_STYLE>( zone.border().style() );
    m_borderHatchPitch = zone.border().pitch().value_nm();
 
    if( zone.filled() )
    {
        // TODO(JE) check what else has to happen here
        SetIsFilled( true );
        SetNeedRefill( false );
 
        for( const types::ZoneFilledPolygons& fillLayer : zone.filled_polygons() )
        {
            PCB_LAYER_ID layer = FromProtoEnum<PCB_LAYER_ID>( fillLayer.layer() );
            SHAPE_POLY_SET shape = kiapi::common::UnpackPolySet( fillLayer.shapes() );
            m_FilledPolysList[layer] = std::make_shared<SHAPE_POLY_SET>( shape );
        }
    }
 
    HatchBorder();
 
    return true;
}
 
 
bool ZONE::HigherPriority( const ZONE* aOther ) const
{
    // Teardrops are always higher priority than regular zones, so if one zone is a teardrop
    // and the other is not, then return higher priority as the teardrop
    if( ( m_teardropType == TEARDROP_TYPE::TD_NONE ) ^ ( aOther->m_teardropType == TEARDROP_TYPE::TD_NONE ) )
        return static_cast<int>( m_teardropType ) > static_cast<int>( aOther->m_teardropType );
 
    if( m_priority != aOther->m_priority )
        return m_priority > aOther->m_priority;
 
    return m_Uuid > aOther->m_Uuid;
}
 
 
bool ZONE::SameNet( const ZONE* aOther ) const
{
    return GetNetCode() == aOther->GetNetCode();
}
 
 
bool ZONE::UnFill()
{
    std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
    return unFillLocked();
}
 
 
bool ZONE::unFillLocked()
{
    bool change = false;
 
    for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
    {
        change |= !pair.second->IsEmpty();
        m_insulatedIslands[pair.first].clear();
 
        // Replace the shared_ptr with a new empty object rather than clearing the existing one.
        // This ensures that any CN_ZONE_LAYERs holding shared_ptr copies still have valid data
        // (the old, now orphaned SHAPE_POLY_SET) while we get a fresh container.
        pair.second = std::make_shared<SHAPE_POLY_SET>();
    }
 
    m_isFilled = false;
    m_fillFlags.reset();
 
    return change;
}
 
 
bool ZONE::IsConflicting() const
{
    return HasFlag( COURTYARD_CONFLICT );
}
 
 
VECTOR2I ZONE::GetPosition() const
{
    if( m_Poly->OutlineCount() == 0 || m_Poly->TotalVertices() == 0 )
        return VECTOR2I( 0, 0 );
 
    return GetCornerPosition( 0 );
}
 
 
PCB_LAYER_ID ZONE::GetLayer() const
{
    std::lock_guard<std::mutex> lock( m_layerSetMutex );
 
    if( m_layerSet.count() == 1 )
    {
        // GetFirstLayer would try to acquire the mutex again, so inline its logic here
        if( m_layerSet.count() == 0 )
            return UNDEFINED_LAYER;
 
        const LSEQ uiLayers = m_layerSet.UIOrder();
 
        if( uiLayers.size() )
            return uiLayers[0];
 
        return m_layerSet.Seq()[0];
    }
 
    return UNDEFINED_LAYER;
}
 
 
PCB_LAYER_ID ZONE::GetFirstLayer() const
{
    std::lock_guard<std::mutex> lock( m_layerSetMutex );
 
    if( m_layerSet.count() == 0 )
        return UNDEFINED_LAYER;
 
    const LSEQ uiLayers = m_layerSet.UIOrder();
 
    // This can't use m_layerSet.count() because it's possible to have a zone on
    // a rescue layer that is not in the UI order.
    if( uiLayers.size() )
        return uiLayers[0];
 
    // If it's not in the UI set at all, just return the first layer in the set.
    // (we know the count > 0)
    return m_layerSet.Seq()[0];
}
 
 
bool ZONE::IsOnCopperLayer() const
{
    std::lock_guard<std::mutex> lock( m_layerSetMutex );
    return ( m_layerSet & LSET::AllCuMask() ).count() > 0;
}
 
 
bool ZONE::SetNetCode( int aNetCode, bool aNoAssert )
{
    if( IsCopperThieving() )
        aNetCode = 0;
 
    return BOARD_CONNECTED_ITEM::SetNetCode( aNetCode, aNoAssert );
}
 
 
void ZONE::SetNet( NETINFO_ITEM* aNetInfo )
{
    if( IsCopperThieving() )
        aNetInfo = nullptr;
 
    BOARD_CONNECTED_ITEM::SetNet( aNetInfo );
}
 
 
void ZONE::SetLayer( PCB_LAYER_ID aLayer )
{
    SetLayerSet( LSET( { aLayer } ) );
}
 
 
void ZONE::SetFillMode( ZONE_FILL_MODE aFillMode )
{
    if( m_fillMode == aFillMode )
        return;
 
    SetNeedRefill( true );
    m_fillMode = aFillMode;
 
    // Thieving zones are net-less and single-layer; clamp on transition so a
    // multi-layer netted POLYGONS zone converted via the property panel or a
    // load-time SetLayerSet-then-SetFillMode sequence cannot keep stale state.
    if( m_fillMode == ZONE_FILL_MODE::COPPER_THIEVING )
    {
        BOARD_CONNECTED_ITEM::SetNetCode( 0, true );
        SetLayer( GetFirstLayer() );
    }
}
 
 
void ZONE::SetLayerSet( const LSET& aLayerSet )
{
    if( aLayerSet.count() == 0 )
        return;
 
    // Thieving zones are single-layer; clamp here so direct callers cannot violate
    // the invariant.  UIOrder().front() matches GetFirstLayer().
    const LSET effectiveSet = ( IsCopperThieving() && aLayerSet.count() > 1 )
                                      ? LSET( { aLayerSet.UIOrder().front() } )
                                      : aLayerSet;
 
    std::scoped_lock lock( m_layerSetMutex, m_filledPolysListMutex );
 
    if( m_layerSet != effectiveSet )
    {
        SetNeedRefill( true );
 
        unFillLocked();
 
        m_FilledPolysList.clear();
        m_filledPolysHash.clear();
        m_insulatedIslands.clear();
 
        effectiveSet.RunOnLayers(
                [&]( PCB_LAYER_ID layer )
                {
                    m_FilledPolysList[layer]  = std::make_shared<SHAPE_POLY_SET>();
                    m_filledPolysHash[layer]  = {};
                    m_insulatedIslands[layer] = {};
                } );
 
        std::erase_if( m_layerProperties,
                       [&]( const auto& item )
                       {
                           return !effectiveSet.Contains( item.first );
                       } );
    }
 
    m_layerSet = effectiveSet;
}
 
 
void ZONE::SetLayerProperties( const std::map<PCB_LAYER_ID, ZONE_LAYER_PROPERTIES>& aOther )
{
    m_layerProperties = aOther;
}
 
 
std::vector<int> ZONE::ViewGetLayers() const
{
    std::lock_guard<std::mutex> lock( m_layerSetMutex );
 
    std::vector<int> layers;
    layers.reserve( 2 * m_layerSet.count() + 1 );
 
    m_layerSet.RunOnLayers(
            [&]( PCB_LAYER_ID layer )
            {
                layers.push_back( layer );
                layers.push_back( layer + static_cast<int>( LAYER_ZONE_START ) );
            } );
 
    layers.push_back( LAYER_CONFLICTS_SHADOW );
 
    return layers;
}
 
 
double ZONE::ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const
{
    if( !aView )
        return LOD_SHOW;
 
    if( !aView->IsLayerVisibleCached( LAYER_ZONES ) )
        return LOD_HIDE;
 
    if( FOOTPRINT* parentFP = GetParentFootprint() )
    {
        const LSET zl = GetLayerSet();
        bool       onFront = ( zl & LSET::FrontMask() ).any();
        bool       onBack = ( zl & LSET::BackMask() ).any();
 
        if( !onFront && !onBack )
        {
            onFront = parentFP->GetLayer() == F_Cu;
            onBack = parentFP->GetLayer() == B_Cu;
        }
 
        const bool frHidden = !aView->IsLayerVisibleCached( LAYER_FOOTPRINTS_FR );
        const bool bkHidden = !aView->IsLayerVisibleCached( LAYER_FOOTPRINTS_BK );
 
        if( onFront && !onBack && frHidden )
            return LOD_HIDE;
 
        if( onBack && !onFront && bkHidden )
            return LOD_HIDE;
 
        if( onFront && onBack && frHidden && bkHidden )
            return LOD_HIDE;
    }
 
    // Other layers are shown without any conditions
    return LOD_SHOW;
}
 
 
bool ZONE::IsOnLayer( PCB_LAYER_ID aLayer ) const
{
    std::lock_guard<std::mutex> lock( m_layerSetMutex );
    return m_layerSet.test( aLayer );
}
 
 
const BOX2I ZONE::GetBoundingBox() const
{
    if( const BOARD* board = GetBoard() )
    {
        std::unordered_map<const ZONE*, BOX2I>& cache = board->m_ZoneBBoxCache;
 
        {
            std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
 
            auto cacheIter = cache.find( this );
 
            if( cacheIter != cache.end() )
                return cacheIter->second;
        }
 
        BOX2I bbox = m_Poly->BBox();
 
        {
            std::unique_lock<std::shared_mutex> writeLock( board->m_CachesMutex );
            cache[ this ] = bbox;
        }
 
        return bbox;
    }
 
    return m_Poly->BBox();
}
 
 
void ZONE::CacheBoundingBox()
{
    // GetBoundingBox() will cache it for us, and there's no sense duplicating the somewhat tricky
    // locking code.
    GetBoundingBox();
}
 
 
int ZONE::GetThermalReliefGap( PAD* aPad, wxString* aSource ) const
{
    if( aPad->GetLocalThermalGapOverride() == 0 )
    {
        if( aSource )
            *aSource = _( "zone" );
 
        return m_thermalReliefGap;
    }
 
    return aPad->GetLocalThermalGapOverride( aSource );
 
}
 
 
void ZONE::SetCornerRadius( unsigned int aRadius )
{
    if( m_cornerRadius != aRadius )
        SetNeedRefill( true );
 
    m_cornerRadius = aRadius;
}
 
 
static SHAPE_POLY_SET g_nullPoly;
 
 
HASH_128 ZONE::GetHashValue( PCB_LAYER_ID aLayer )
{
    if( !m_filledPolysHash.count( aLayer ) )
        return g_nullPoly.GetHash();
    else
        return m_filledPolysHash.at( aLayer );
}
 
 
void ZONE::BuildHashValue( PCB_LAYER_ID aLayer )
{
    std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
    if( !m_FilledPolysList.count( aLayer ) )
        m_filledPolysHash[aLayer] = g_nullPoly.GetHash();
    else
        m_filledPolysHash[aLayer] = m_FilledPolysList.at( aLayer )->GetHash();
}
 
 
bool ZONE::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
{
    // When looking for an "exact" hit aAccuracy will be 0 which works poorly for very thin
    // lines.  Give it a floor.
    int accuracy = std::max( aAccuracy, pcbIUScale.mmToIU( 0.1 ) );
 
    return HitTestForCorner( aPosition, accuracy * 2 ) || HitTestForEdge( aPosition, accuracy );
}
 
 
bool ZONE::HitTestForCorner( const VECTOR2I& refPos, int aAccuracy,
                             SHAPE_POLY_SET::VERTEX_INDEX* aCornerHit ) const
{
    return m_Poly->CollideVertex( VECTOR2I( refPos ), aCornerHit, aAccuracy );
}
 
 
bool ZONE::HitTestForEdge( const VECTOR2I& refPos, int aAccuracy,
                           SHAPE_POLY_SET::VERTEX_INDEX* aCornerHit ) const
{
    return m_Poly->CollideEdge( VECTOR2I( refPos ), aCornerHit, aAccuracy );
}
 
 
bool ZONE::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
{
    // Calculate bounding box for zone
    BOX2I bbox = GetBoundingBox();
    bbox.Normalize();
 
    BOX2I arect = aRect;
    arect.Normalize();
    arect.Inflate( aAccuracy );
 
    if( aContained )
    {
         return arect.Contains( bbox );
    }
    else
    {
        // Fast test: if aBox is outside the polygon bounding box, rectangles cannot intersect
        if( !arect.Intersects( bbox ) )
            return false;
 
        int count = m_Poly->TotalVertices();
 
        for( int ii = 0; ii < count; ii++ )
        {
            VECTOR2I vertex = m_Poly->CVertex( ii );
            VECTOR2I vertexNext = m_Poly->CVertex( ( ii + 1 ) % count );
 
            // Test if the point is within the rect
            if( arect.Contains( vertex ) )
                return true;
 
            // Test if this edge intersects the rect
            if( arect.Intersects( vertex, vertexNext ) )
                return true;
        }
 
        return false;
    }
}
 
 
bool ZONE::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
{
    if( aContained )
    {
        auto outlineIntersectingSelection =
                [&]()
                {
                    for( auto segment = m_Poly->IterateSegments(); segment; segment++ )
                    {
                        if( aPoly.Intersects( *segment ) )
                            return true;
                    }
 
                    return false;
                };
 
        // In the case of contained selection, all vertices of the zone outline must be inside
        // the selection polygon, so we can check only the first vertex.
        auto vertexInsideSelection =
                [&]()
                {
                    return aPoly.PointInside( m_Poly->CVertex( 0 ) );
                };
 
        return vertexInsideSelection() && !outlineIntersectingSelection();
    }
    else
    {
        // Touching selection - check if any segment of the zone contours collides with the
        // selection shape.
        for( auto segment = m_Poly->IterateSegmentsWithHoles(); segment; segment++ )
        {
            if( aPoly.PointInside( ( *segment ).A ) )
                return true;
 
            if( aPoly.Intersects( *segment ) )
                return true;
 
            // Note: aPoly.Collide() could be used instead of two test above, but it is 3x slower.
        }
 
        return false;
    }
}
 
 
std::optional<int> ZONE::GetLocalClearance() const
{
    return m_isRuleArea ? 0 : m_ZoneClearance;
}
 
 
bool ZONE::HitTestFilledArea( PCB_LAYER_ID aLayer, const VECTOR2I& aRefPos, int aAccuracy ) const
{
    // Rule areas have no filled area, but it's generally nice to treat their interior as if it were
    // filled so that people don't have to select them by their outline (which is min-width)
    if( GetIsRuleArea() )
        return m_Poly->Contains( aRefPos, -1, aAccuracy );
 
    std::shared_ptr<SHAPE_POLY_SET> fillPolys;
 
    {
        std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
        if( !m_FilledPolysList.count( aLayer ) )
            return false;
 
        fillPolys = m_FilledPolysList.at( aLayer );
    }
 
    return fillPolys->Contains( aRefPos, -1, aAccuracy );
}
 
 
bool ZONE::HitTestCutout( const VECTOR2I& aRefPos, int* aOutlineIdx, int* aHoleIdx ) const
{
    // Iterate over each outline polygon in the zone and then iterate over
    // each hole it has to see if the point is in it.
    for( int i = 0; i < m_Poly->OutlineCount(); i++ )
    {
        for( int j = 0; j < m_Poly->HoleCount( i ); j++ )
        {
            if( m_Poly->Hole( i, j ).PointInside( aRefPos ) )
            {
                if( aOutlineIdx )
                    *aOutlineIdx = i;
 
                if( aHoleIdx )
                    *aHoleIdx = j;
 
                return true;
            }
        }
    }
 
    return false;
}
 
 
void ZONE::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
{
    wxString msg = GetFriendlyName();
 
    aList.emplace_back( _( "Type" ), msg );
 
    if( GetIsRuleArea() )
    {
        msg.Empty();
 
        if( GetDoNotAllowVias() )
            AccumulateDescription( msg, _( "No vias" ) );
 
        if( GetDoNotAllowTracks() )
            AccumulateDescription( msg, _( "No tracks" ) );
 
        if( GetDoNotAllowPads() )
            AccumulateDescription( msg, _( "No pads" ) );
 
        if( GetDoNotAllowZoneFills() )
            AccumulateDescription( msg, _( "No zone fills" ) );
 
        if( GetDoNotAllowFootprints() )
            AccumulateDescription( msg, _( "No footprints" ) );
 
        if( !msg.IsEmpty() )
            aList.emplace_back( _( "Restrictions" ), msg );
 
        if( GetPlacementAreaEnabled() )
            aList.emplace_back( _( "Placement source" ), UnescapeString( GetPlacementAreaSource() ) );
    }
    else if( IsOnCopperLayer() )
    {
        if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
        {
            aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
 
            aList.emplace_back( _( "Resolved Netclass" ),
                                UnescapeString( GetEffectiveNetClass()->GetHumanReadableName() ) );
        }
 
        // Display priority level
        aList.emplace_back( _( "Priority" ), wxString::Format( wxT( "%d" ), GetAssignedPriority() ) );
    }
 
    if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
    {
        if( IsLocked() )
            aList.emplace_back( _( "Status" ), _( "Locked" ) );
    }
 
    LSEQ     layers = m_layerSet.Seq();
    wxString layerDesc;
 
    if( layers.size() == 1 )
    {
        layerDesc.Printf( _( "%s" ), GetBoard()->GetLayerName( layers[0] ) );
    }
    else if (layers.size() == 2 )
    {
        layerDesc.Printf( _( "%s and %s" ),
                          GetBoard()->GetLayerName( layers[0] ),
                          GetBoard()->GetLayerName( layers[1] ) );
    }
    else if (layers.size() == 3 )
    {
        layerDesc.Printf( _( "%s, %s and %s" ),
                          GetBoard()->GetLayerName( layers[0] ),
                          GetBoard()->GetLayerName( layers[1] ),
                          GetBoard()->GetLayerName( layers[2] ) );
    }
    else if( layers.size() > 3 )
    {
        layerDesc.Printf( _( "%s, %s and %d more" ),
                          GetBoard()->GetLayerName( layers[0] ),
                          GetBoard()->GetLayerName( layers[1] ),
                          static_cast<int>( layers.size() - 2 ) );
    }
 
    aList.emplace_back( _( "Layer" ), layerDesc );
 
    if( !m_zoneName.empty() )
        aList.emplace_back( _( "Name" ), m_zoneName );
 
    if( !GetIsRuleArea() )      // Show fill mode only for not rule areas
    {
        switch( m_fillMode )
        {
        case ZONE_FILL_MODE::POLYGONS:      msg = _( "Solid" ); break;
        case ZONE_FILL_MODE::HATCH_PATTERN: msg = _( "Hatched" ); break;
        default:                            msg = _( "Unknown" ); break;
        }
 
        aList.emplace_back( _( "Fill Mode" ), msg );
 
        aList.emplace_back( _( "Filled Area" ),
                            aFrame->MessageTextFromValue( m_area, true, EDA_DATA_TYPE::AREA ) );
 
        wxString source;
        int      clearance = GetOwnClearance( UNDEFINED_LAYER, &source );
 
        if( !source.IsEmpty() )
        {
            aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ), aFrame->MessageTextFromValue( clearance ) ),
                                wxString::Format( _( "(from %s)" ), source ) );
        }
    }
 
    int count = 0;
 
    if( GetIsRuleArea() )
    {
        double outline_area = CalculateOutlineArea();
        aList.emplace_back( _( "Outline Area" ),
                            aFrame->MessageTextFromValue( outline_area, true, EDA_DATA_TYPE::AREA ) );
 
        const SHAPE_POLY_SET* area_outline = Outline();
        count = area_outline->FullPointCount();
    }
    else if( !m_FilledPolysList.empty() )
    {
        for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& ii: m_FilledPolysList )
            count += ii.second->TotalVertices();
    }
 
    aList.emplace_back( _( "Corner Count" ), wxString::Format( wxT( "%d" ), count ) );
}
 
 
void ZONE::Move( const VECTOR2I& offset )
{
    /* move outlines */
    m_Poly->Move( offset );
 
    // Translate existing hatch lines instead of regenerating them. HatchBorder() is expensive
    // (O(n*m) segment intersections + point-in-polygon tests) and the hatch pattern is
    // invariant under translation.
    for( SEG& seg : m_borderHatchLines )
    {
        seg.A += offset;
        seg.B += offset;
    }
 
    /* move fills */
    for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
        pair.second->Move( offset );
 
    /*
     * move boundingbox cache
     *
     * While the cache will get nuked at the conclusion of the operation, we use it for some
     * things (such as drawing the parent group) during the move.
     */
    if( GetBoard() )
    {
        auto it = GetBoard()->m_ZoneBBoxCache.find( this );
 
        if( it != GetBoard()->m_ZoneBBoxCache.end() )
            it->second.Move( offset );
    }
}
 
 
wxString ZONE::GetFriendlyName() const
{
    if( GetIsRuleArea() )
        return _( "Rule Area" );
    else if( IsTeardropArea() )
        return _( "Teardrop Area" );
    else if( IsOnCopperLayer() )
        return _( "Copper Zone" );
    else
        return _( "Non-copper Zone" );
}
 
 
void ZONE::MoveEdge( const VECTOR2I& offset, int aEdge )
{
    int next_corner;
 
    if( m_Poly->GetNeighbourIndexes( aEdge, nullptr, &next_corner ) )
    {
        m_Poly->SetVertex( aEdge, m_Poly->CVertex( aEdge ) + VECTOR2I( offset ) );
        m_Poly->SetVertex( next_corner, m_Poly->CVertex( next_corner ) + VECTOR2I( offset ) );
        HatchBorder();
 
        SetNeedRefill( true );
    }
}
 
 
void ZONE::Rotate( const VECTOR2I& aCentre, const EDA_ANGLE& aAngle )
{
    m_Poly->Rotate( aAngle, aCentre );
    HatchBorder();
 
    /* rotate filled areas: */
    for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
        pair.second->Rotate( aAngle, aCentre );
}
 
 
void ZONE::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
{
    Mirror( aCentre, aFlipDirection );
 
    std::map<PCB_LAYER_ID, SHAPE_POLY_SET> fillsCopy;
 
    for( auto& [oldLayer, shapePtr] : m_FilledPolysList )
        fillsCopy[oldLayer] = *shapePtr;
 
    std::map<PCB_LAYER_ID, ZONE_LAYER_PROPERTIES> layerPropertiesCopy = m_layerProperties;
 
    LSET flipped;
 
    for( PCB_LAYER_ID layer : GetLayerSet() )
        flipped.set( GetBoard()->FlipLayer( layer ) );
 
    SetLayerSet( flipped );
 
    for( auto& [oldLayer, properties] : layerPropertiesCopy )
    {
        PCB_LAYER_ID newLayer = GetBoard()->FlipLayer( oldLayer );
        m_layerProperties[newLayer] = properties;
    }
 
    for( auto& [oldLayer, shape] : fillsCopy )
    {
        PCB_LAYER_ID newLayer = GetBoard()->FlipLayer( oldLayer );
        SetFilledPolysList( newLayer, shape );
    }
}
 
 
void ZONE::Mirror( const VECTOR2I& aMirrorRef, FLIP_DIRECTION aFlipDirection )
{
    m_Poly->Mirror( aMirrorRef, aFlipDirection );
 
    HatchBorder();
 
    for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
        pair.second->Mirror( aMirrorRef, aFlipDirection );
}
 
 
void ZONE::RemoveCutout( int aOutlineIdx, int aHoleIdx )
{
    // Ensure the requested cutout is valid
    if( m_Poly->OutlineCount() < aOutlineIdx || m_Poly->HoleCount( aOutlineIdx ) < aHoleIdx )
        return;
 
    SHAPE_POLY_SET cutPoly( m_Poly->Hole( aOutlineIdx, aHoleIdx ) );
 
    // Add the cutout back to the zone
    m_Poly->BooleanAdd( cutPoly );
 
    SetNeedRefill( true );
}
 
 
void ZONE::AddPolygon( const SHAPE_LINE_CHAIN& aPolygon )
{
    wxASSERT( aPolygon.IsClosed() );
 
    // Add the outline as a new polygon in the polygon set
    if( m_Poly->OutlineCount() == 0 )
        m_Poly->AddOutline( aPolygon );
    else
        m_Poly->AddHole( aPolygon );
 
    SetNeedRefill( true );
}
 
 
void ZONE::AddPolygon( std::vector<VECTOR2I>& aPolygon )
{
    if( aPolygon.empty() )
        return;
 
    SHAPE_LINE_CHAIN outline;
 
    // Create an outline and populate it with the points of aPolygon
    for( const VECTOR2I& pt : aPolygon )
        outline.Append( pt );
 
    outline.SetClosed( true );
 
    AddPolygon( outline );
}
 
 
bool ZONE::AppendCorner( VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication )
{
    // Ensure the main outline exists:
    if( m_Poly->OutlineCount() == 0 )
        m_Poly->NewOutline();
 
    // If aHoleIdx >= 0, the corner musty be added to the hole, index aHoleIdx.
    // (remember: the index of the first hole is 0)
    // Return error if it does not exist.
    if( aHoleIdx >= m_Poly->HoleCount( 0 ) )
        return false;
 
    m_Poly->Append( aPosition.x, aPosition.y, -1, aHoleIdx, aAllowDuplication );
 
    SetNeedRefill( true );
 
    return true;
}
 
 
wxString ZONE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
{
    LSEQ     layers = m_layerSet.Seq();
    wxString layerDesc;
 
    if( layers.size() == 1 )
    {
        layerDesc.Printf( _( "on %s" ), GetBoard()->GetLayerName( layers[0] ) );
    }
    else if (layers.size() == 2 )
    {
        layerDesc.Printf( _( "on %s and %s" ),
                          GetBoard()->GetLayerName( layers[0] ),
                          GetBoard()->GetLayerName( layers[1] ) );
    }
    else if (layers.size() == 3 )
    {
        layerDesc.Printf( _( "on %s, %s and %s" ),
                          GetBoard()->GetLayerName( layers[0] ),
                          GetBoard()->GetLayerName( layers[1] ),
                          GetBoard()->GetLayerName( layers[2] ) );
    }
    else if( layers.size() > 3 )
    {
        layerDesc.Printf( _( "on %s, %s and %zu more" ),
                          GetBoard()->GetLayerName( layers[0] ),
                          GetBoard()->GetLayerName( layers[1] ),
                          layers.size() - 2 );
    }
 
    if( GetIsRuleArea() )
    {
        if( GetZoneName().IsEmpty() )
        {
            return wxString::Format( _( "Rule Area %s" ),
                                     layerDesc );
        }
        else
        {
            return wxString::Format( _( "Rule area '%s' %s" ),
                                     GetZoneName(),
                                     layerDesc );
        }
    }
    else if( IsTeardropArea() )
    {
        return wxString::Format( _( "Teardrop %s %s" ),
                                 GetNetnameMsg(),
                                 layerDesc );
    }
    else
    {
        if( GetZoneName().IsEmpty() )
        {
            return wxString::Format( _( "Zone %s %s, priority %d" ),
                                     GetNetnameMsg(),
                                     layerDesc,
                                     GetAssignedPriority() );
        }
        else
        {
            return wxString::Format( _( "Zone '%s' %s %s, priority %d" ),
                                     GetZoneName(),
                                     GetNetnameMsg(),
                                     layerDesc,
                                     GetAssignedPriority() );
        }
    }
}
 
 
void ZONE::SetBorderDisplayStyle( ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle,
                                  int aBorderHatchPitch, bool aRebuildBorderHatch )
{
    aBorderHatchPitch = std::max( aBorderHatchPitch, pcbIUScale.mmToIU( ZONE_BORDER_HATCH_MINDIST_MM ) );
    aBorderHatchPitch = std::min( aBorderHatchPitch, pcbIUScale.mmToIU( ZONE_BORDER_HATCH_MAXDIST_MM ) );
    SetBorderHatchPitch( aBorderHatchPitch );
    m_borderStyle = aBorderHatchStyle;
 
    if( aRebuildBorderHatch )
        HatchBorder();
}
 
 
void ZONE::UnHatchBorder()
{
    m_borderHatchLines.clear();
}
 
 
void ZONE::HatchBorder()
{
    UnHatchBorder();
 
    if( m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::NO_HATCH
            || m_borderHatchPitch == 0
            || m_Poly->IsEmpty() )
    {
        return;
    }
 
    // set the "length" of hatch lines (the length on horizontal axis)
    int  hatch_line_len = m_borderHatchPitch;   // OK for DIAGONAL_EDGE style
 
    // Calculate spacing between 2 hatch lines
    int spacing = m_borderHatchPitch;           // OK for DIAGONAL_EDGE style
 
    if( m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL )
    {
        // The spacing is twice the spacing for DIAGONAL_EDGE because one
        // full diagonal replaces 2 edge diagonal hatch segments in code
        spacing = m_borderHatchPitch * 2;
        hatch_line_len = -1;    // Use full diagonal hatch line
    }
 
    // To have a better look, give a slope depending on the layer
    int                 layer = GetFirstLayer();
    std::vector<double> slopes;
 
    if( IsTeardropArea() )
        slopes = { 0.7, -0.7 };
    else if( layer & 1 )
        slopes = { 1 };
    else
        slopes = { -1 };
 
    m_borderHatchLines = m_Poly->GenerateHatchLines( slopes, spacing, hatch_line_len );
}
 
 
int ZONE::GetDefaultHatchPitch()
{
    return pcbIUScale.mmToIU( ZONE_BORDER_HATCH_DIST_MM );
}
 
 
BITMAPS ZONE::GetMenuImage() const
{
    return BITMAPS::add_zone;
}
 
 
void ZONE::swapData( BOARD_ITEM* aImage )
{
    assert( aImage->Type() == PCB_ZONE_T );
 
    std::swap( *static_cast<ZONE*>( this ), *static_cast<ZONE*>( aImage) );
}
 
 
void ZONE::CacheTriangulation( PCB_LAYER_ID aLayer, const SHAPE_POLY_SET::TASK_SUBMITTER& aSubmitter )
{
    if( aLayer == UNDEFINED_LAYER )
    {
        std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
        for( auto& [ layer, poly ] : m_FilledPolysList )
            poly->CacheTriangulation( false, aSubmitter );
 
        m_Poly->CacheTriangulation();
    }
    else
    {
        // Grab a shared_ptr copy under the lock, then triangulate outside it.
        // Each layer's SHAPE_POLY_SET is independent, so concurrent triangulation
        // of different layers is safe once we have the shared_ptr.
        std::shared_ptr<SHAPE_POLY_SET> poly;
 
        {
            std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
            auto it = m_FilledPolysList.find( aLayer );
 
            if( it != m_FilledPolysList.end() )
                poly = it->second;
        }
 
        if( poly )
            poly->CacheTriangulation( false, aSubmitter );
    }
}
 
 
bool ZONE::IsIsland( PCB_LAYER_ID aLayer, int aPolyIdx ) const
{
    if( GetNetCode() < 1 )
        return true;
 
    if( !m_insulatedIslands.count( aLayer ) )
        return false;
 
    return m_insulatedIslands.at( aLayer ).count( aPolyIdx );
}
 
 
void ZONE::GetInteractingZones( PCB_LAYER_ID aLayer, std::vector<ZONE*>* aSameNetCollidingZones,
                                std::vector<ZONE*>* aOtherNetIntersectingZones ) const
{
    int   epsilon = pcbIUScale.mmToIU( 0.001 );
    BOX2I bbox = GetBoundingBox();
 
    bbox.Inflate( epsilon );
 
    for( ZONE* candidate : GetBoard()->Zones() )
    {
        if( candidate == this )
            continue;
 
        if( !candidate->GetLayerSet().test( aLayer ) )
            continue;
 
        if( candidate->GetIsRuleArea() || candidate->IsTeardropArea() )
            continue;
 
        if( !candidate->GetBoundingBox().Intersects( bbox ) )
            continue;
 
        if( candidate->GetNetCode() == GetNetCode() )
        {
            if( m_Poly->Collide( candidate->m_Poly ) )
                aSameNetCollidingZones->push_back( candidate );
        }
        else
        {
            aOtherNetIntersectingZones->push_back( candidate );
        }
    }
}
 
 
bool ZONE::BuildSmoothedPoly( SHAPE_POLY_SET& aSmoothedPoly, PCB_LAYER_ID aLayer,
                              SHAPE_POLY_SET* aBoardOutline,
                              SHAPE_POLY_SET* aSmoothedPolyWithApron ) const
{
    if( GetNumCorners() <= 2 )  // malformed zone. polygon calculations will not like it ...
        return false;
 
    // Processing of arc shapes in zones is not yet supported because Clipper can't do boolean
    // operations on them.  The poly outline must be converted to segments first.
    SHAPE_POLY_SET flattened = m_Poly->CloneDropTriangulation();
    flattened.ClearArcs();
 
    if( GetIsRuleArea() )
    {
        // We like keepouts just the way they are....
        aSmoothedPoly = std::move( flattened );
        return true;
    }
 
    const BOARD* board = GetBoard();
    bool         keepExternalFillets = false;
    bool         smooth_requested = m_cornerSmoothingType == ZONE_SETTINGS::SMOOTHING_CHAMFER
                                    || m_cornerSmoothingType == ZONE_SETTINGS::SMOOTHING_FILLET;
 
    if( IsTeardropArea() )
    {
        // We use teardrop shapes with no smoothing; these shapes are already optimized
        smooth_requested = false;
    }
 
    if( board )
        keepExternalFillets = board->GetDesignSettings().m_ZoneKeepExternalFillets;
 
    auto smooth =
            [&]( SHAPE_POLY_SET& aPoly )
            {
                if( !smooth_requested )
                    return;
 
                switch( m_cornerSmoothingType )
                {
                case ZONE_SETTINGS::SMOOTHING_CHAMFER:
                    aPoly = aPoly.Chamfer( (int) m_cornerRadius );
                    break;
 
                case ZONE_SETTINGS::SMOOTHING_FILLET:
                    aPoly = aPoly.Fillet( (int) m_cornerRadius, GetMaxError() );
                    break;
 
                default:
                    break;
                }
            };
 
    SHAPE_POLY_SET* maxExtents = &flattened;
    SHAPE_POLY_SET  withFillets;
 
    aSmoothedPoly = flattened;
 
    // Should external fillets (that is, those applied to concave corners) be kept?  While it
    // seems safer to never have copper extend outside the zone outline, 5.1.x and prior did
    // indeed fill them so we leave the mode available.
    if( keepExternalFillets && smooth_requested )
    {
        withFillets = flattened;
        smooth( withFillets );
        withFillets.BooleanAdd( flattened );
        maxExtents = &withFillets;
    }
 
    // We now add in the areas of any same-net, intersecting zones.  This keeps us from smoothing
    // corners at an intersection (which often produces undesired divots between the intersecting
    // zones -- see #2752).
    //
    // After smoothing, we'll subtract back out everything outside of our zone.
    std::vector<ZONE*> sameNetCollidingZones;
    std::vector<ZONE*> diffNetIntersectingZones;
    GetInteractingZones( aLayer, &sameNetCollidingZones, &diffNetIntersectingZones );
 
    for( ZONE* sameNetZone : sameNetCollidingZones )
    {
        BOX2I sameNetBoundingBox = sameNetZone->GetBoundingBox();
 
        // Note: a two-pass algorithm could use sameNetZone's actual fill instead of its outline.
        // This would obviate the need for the below wrinkles, in addition to fixing both issues
        // in #16095.
        // (And we wouldn't need to collect all the diffNetIntersectingZones either.)
 
        SHAPE_POLY_SET sameNetPoly = sameNetZone->Outline()->CloneDropTriangulation();
        sameNetPoly.ClearArcs();
 
        SHAPE_POLY_SET diffNetPoly;
 
        // Of course there's always a wrinkle.  The same-net intersecting zone *might* get knocked
        // out along the border by a higher-priority, different-net zone.  #12797
        for( ZONE* diffNetZone : diffNetIntersectingZones )
        {
            if( diffNetZone->HigherPriority( sameNetZone )
                    && diffNetZone->GetBoundingBox().Intersects( sameNetBoundingBox ) )
            {
                SHAPE_POLY_SET diffNetOutline = diffNetZone->Outline()->CloneDropTriangulation();
                diffNetOutline.ClearArcs();
 
                diffNetPoly.BooleanAdd( diffNetOutline );
            }
        }
 
        // Second wrinkle.  After unioning the higher priority, different net zones together, we
        // need to check to see if they completely enclose our zone.  If they do, then we need to
        // treat the enclosed zone as isolated, not connected to the outer zone.  #13915
        bool isolated = false;
 
        if( diffNetPoly.OutlineCount() )
        {
            SHAPE_POLY_SET thisPoly = Outline()->CloneDropTriangulation();
            thisPoly.ClearArcs();
 
            thisPoly.BooleanSubtract( diffNetPoly );
            isolated = thisPoly.OutlineCount() == 0;
        }
 
        if( !isolated )
            aSmoothedPoly.BooleanAdd( sameNetPoly );
    }
 
    if( aBoardOutline )
    {
        SHAPE_POLY_SET boardOutline = aBoardOutline->CloneDropTriangulation();
        boardOutline.ClearArcs();
 
        aSmoothedPoly.BooleanIntersection( boardOutline );
    }
 
    SHAPE_POLY_SET withSameNetIntersectingZones = aSmoothedPoly.CloneDropTriangulation();
 
    smooth( aSmoothedPoly );
 
    if( aSmoothedPolyWithApron )
    {
        // The same-net intersecting-zone code above makes sure the corner-smoothing algorithm
        // doesn't produce divots.  But the min-thickness algorithm applied in fillCopperZone()
        // is *also* going to perform a deflate/inflate cycle, again leading to divots.  So we
        // pre-inflate the contour by the min-thickness within the same-net-intersecting-zones
        // envelope.
        SHAPE_POLY_SET poly = maxExtents->CloneDropTriangulation();
        poly.Inflate( m_ZoneMinThickness, CORNER_STRATEGY::ROUND_ALL_CORNERS, GetMaxError() );
 
        if( !keepExternalFillets )
            poly.BooleanIntersection( withSameNetIntersectingZones );
 
        *aSmoothedPolyWithApron = aSmoothedPoly;
        aSmoothedPolyWithApron->BooleanIntersection( poly );
    }
 
    aSmoothedPoly.BooleanIntersection( *maxExtents );
 
    return true;
}
 
 
double ZONE::CalculateFilledArea()
{
    m_area = 0.0;
 
    for( const auto& [layer, poly] : m_FilledPolysList )
        m_area += poly->Area();
 
    return m_area;
}
 
 
double ZONE::CalculateOutlineArea()
{
    m_outlinearea = std::abs( m_Poly->Area() );
    return m_outlinearea;
}
 
 
void ZONE::TransformSmoothedOutlineToPolygon( SHAPE_POLY_SET& aBuffer, int aClearance,
                                              int aMaxError, ERROR_LOC aErrorLoc,
                                              SHAPE_POLY_SET* aBoardOutline ) const
{
    // Creates the zone outline polygon (with holes if any)
    SHAPE_POLY_SET polybuffer;
 
    // TODO: using GetFirstLayer() means it only works for single-layer zones....
    BuildSmoothedPoly( polybuffer, GetFirstLayer(), aBoardOutline );
 
    // Calculate the polygon with clearance
    // holes are linked to the main outline, so only one polygon is created.
    if( aClearance )
    {
        if( aErrorLoc == ERROR_OUTSIDE )
            aClearance += GetMaxError();
 
        polybuffer.Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, GetMaxError() );
    }
 
    polybuffer.Fracture();
    aBuffer.Append( polybuffer );
}
 
 
std::shared_ptr<SHAPE> ZONE::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash ) const
{
    // Rule areas are never filled, so fall back to the outline.  DRC relies on this
    // to collide tracks, vias and pads against keepout areas.
    if( GetIsRuleArea() )
        return std::make_shared<SHAPE_POLY_SET>( *Outline() );
 
    std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
    if( m_FilledPolysList.find( aLayer ) == m_FilledPolysList.end() )
        return std::make_shared<SHAPE_NULL>();
    else
        return m_FilledPolysList.at( aLayer );
}
 
 
void ZONE::TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                    int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth ) const
{
    wxASSERT_MSG( !aIgnoreLineWidth, wxT( "IgnoreLineWidth has no meaning for zones." ) );
 
    std::shared_ptr<SHAPE_POLY_SET> fillPolys;
 
    {
        std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
        if( !m_FilledPolysList.count( aLayer ) )
            return;
 
        fillPolys = m_FilledPolysList.at( aLayer );
    }
 
    if( !aClearance )
    {
        aBuffer.Append( *fillPolys );
        return;
    }
 
    SHAPE_POLY_SET temp_buf = fillPolys->CloneDropTriangulation();
 
    // Rebuild filled areas only if clearance is not 0
    if( aClearance > 0 || aErrorLoc == ERROR_OUTSIDE )
    {
        if( aErrorLoc == ERROR_OUTSIDE )
            aClearance += aError;
 
        temp_buf.InflateWithLinkedHoles( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, aError );
    }
 
    aBuffer.Append( temp_buf );
}
 
 
void ZONE::TransformSolidAreasShapesToPolygon( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aBuffer ) const
{
    std::lock_guard<std::mutex> lock( m_filledPolysListMutex );
 
    if( m_FilledPolysList.count( aLayer ) && !m_FilledPolysList.at( aLayer )->IsEmpty() )
        aBuffer.Append( *m_FilledPolysList.at( aLayer ) );
}
 
 
void ZONE::SetLayerSetAndRemoveUnusedFills( const LSET& aLayerSet )
{
    if( aLayerSet.count() == 0 )
        return;
 
    std::scoped_lock lock( m_layerSetMutex, m_filledPolysListMutex );
 
    if( m_layerSet != aLayerSet )
    {
        aLayerSet.RunOnLayers(
                [&]( PCB_LAYER_ID layer )
                {
                    // Only keep layers that are present in the new set
                    if( !aLayerSet.Contains( layer ) )
                    {
                        m_FilledPolysList[layer]  = std::make_shared<SHAPE_POLY_SET>();
                        m_filledPolysHash[layer]  = {};
                        m_insulatedIslands[layer] = {};
                    }
                } );
    }
 
    m_layerSet = aLayerSet;
}
 
 
bool ZONE::operator==( const BOARD_ITEM& aOther ) const
{
    if( aOther.Type() != Type() )
        return false;
 
    const ZONE& other = static_cast<const ZONE&>( aOther );
    return *this == other;
}
 
 
bool ZONE::operator==( const ZONE& aOther ) const
 
{
    if( aOther.Type() != Type() )
        return false;
 
    const ZONE& other = static_cast<const ZONE&>( aOther );
 
    if( GetIsRuleArea() != other.GetIsRuleArea() )
        return false;
 
     if( GetIsRuleArea() )
     {
         if( GetDoNotAllowZoneFills() != other.GetDoNotAllowZoneFills() )
             return false;
 
         if( GetDoNotAllowTracks() != other.GetDoNotAllowTracks() )
             return false;
 
         if( GetDoNotAllowVias() != other.GetDoNotAllowVias() )
             return false;
 
         if( GetDoNotAllowFootprints() != other.GetDoNotAllowFootprints() )
             return false;
 
         if( GetDoNotAllowPads() != other.GetDoNotAllowPads() )
             return false;
 
         if( GetPlacementAreaEnabled() != other.GetPlacementAreaEnabled() )
             return false;
 
         if( GetPlacementAreaSourceType() != other.GetPlacementAreaSourceType() )
             return false;
 
         if( GetPlacementAreaSource() != other.GetPlacementAreaSource() )
             return false;
    }
    else
    {
        if( GetAssignedPriority() != other.GetAssignedPriority() )
            return false;
 
        if( GetMinThickness() != other.GetMinThickness() )
            return false;
 
        if( GetCornerSmoothingType() != other.GetCornerSmoothingType() )
            return false;
 
        if( GetCornerRadius() != other.GetCornerRadius() )
            return false;
 
        if( GetTeardropParams() != other.GetTeardropParams() )
            return false;
    }
 
    if( GetNumCorners() != other.GetNumCorners() )
        return false;
 
    for( int ii = 0; ii < GetNumCorners(); ii++ )
    {
        if( GetCornerPosition( ii ) != other.GetCornerPosition( ii ) )
            return false;
    }
 
    return true;
}
 
 
double ZONE::Similarity( const BOARD_ITEM& aOther ) const
{
    if( aOther.Type() != Type() )
        return 0.0;
 
    const ZONE& other = static_cast<const ZONE&>( aOther );
 
    if( GetIsRuleArea() != other.GetIsRuleArea() )
        return 0.0;
 
    double similarity = 1.0;
 
    if( GetLayerSet() != other.GetLayerSet() )
        similarity *= 0.9;
 
    if( GetNetCode() != other.GetNetCode() )
        similarity *= 0.9;
 
    if( !GetIsRuleArea() )
    {
        if( GetAssignedPriority() != other.GetAssignedPriority() )
            similarity *= 0.9;
 
        if( GetMinThickness() != other.GetMinThickness() )
            similarity *= 0.9;
 
        if( GetCornerSmoothingType() != other.GetCornerSmoothingType() )
            similarity *= 0.9;
 
        if( GetCornerRadius() != other.GetCornerRadius() )
            similarity *= 0.9;
 
        if( GetTeardropParams() != other.GetTeardropParams() )
            similarity *= 0.9;
    }
    else
    {
        if( GetDoNotAllowZoneFills() != other.GetDoNotAllowZoneFills() )
            similarity *= 0.9;
        if( GetDoNotAllowTracks() != other.GetDoNotAllowTracks() )
            similarity *= 0.9;
        if( GetDoNotAllowVias() != other.GetDoNotAllowVias() )
            similarity *= 0.9;
        if( GetDoNotAllowFootprints() != other.GetDoNotAllowFootprints() )
            similarity *= 0.9;
        if( GetDoNotAllowPads() != other.GetDoNotAllowPads() )
            similarity *= 0.9;
    }
 
    std::vector<VECTOR2I> corners;
    std::vector<VECTOR2I> otherCorners;
    VECTOR2I lastCorner( 0, 0 );
 
    for( int ii = 0; ii < GetNumCorners(); ii++ )
    {
        corners.push_back( lastCorner - GetCornerPosition( ii ) );
        lastCorner = GetCornerPosition( ii );
    }
 
    lastCorner = VECTOR2I( 0, 0 );
    for( int ii = 0; ii < other.GetNumCorners(); ii++ )
    {
        otherCorners.push_back( lastCorner - other.GetCornerPosition( ii ) );
        lastCorner = other.GetCornerPosition( ii );
    }
 
    size_t longest = alg::longest_common_subset( corners, otherCorners );
 
    similarity *= std::pow( 0.9, GetNumCorners() + other.GetNumCorners() - 2 * longest );
 
    return similarity;
}
 
 
static struct ZONE_DESC
{
    ZONE_DESC()
    {
        ENUM_MAP<PCB_LAYER_ID>& layerEnum = ENUM_MAP<PCB_LAYER_ID>::Instance();
 
        if( layerEnum.Choices().GetCount() == 0 )
        {
            layerEnum.Undefined( UNDEFINED_LAYER );
 
            for( PCB_LAYER_ID layer : LSET::AllLayersMask() )
                layerEnum.Map( layer, LSET::Name( layer ) );
        }
 
        ENUM_MAP<ZONE_CONNECTION>& zcMap = ENUM_MAP<ZONE_CONNECTION>::Instance();
 
        if( zcMap.Choices().GetCount() == 0 )
        {
            zcMap.Undefined( ZONE_CONNECTION::INHERITED );
            zcMap.Map( ZONE_CONNECTION::INHERITED,   _HKI( "Inherited" ) )
                 .Map( ZONE_CONNECTION::NONE,        _HKI( "None" ) )
                 .Map( ZONE_CONNECTION::THERMAL,     _HKI( "Thermal reliefs" ) )
                 .Map( ZONE_CONNECTION::FULL,        _HKI( "Solid" ) )
                 .Map( ZONE_CONNECTION::THT_THERMAL, _HKI( "Thermal reliefs for PTH" ) );
        }
 
        ENUM_MAP<ZONE_FILL_MODE>& zfmMap = ENUM_MAP<ZONE_FILL_MODE>::Instance();
 
        if( zfmMap.Choices().GetCount() == 0 )
        {
            zfmMap.Undefined( ZONE_FILL_MODE::POLYGONS );
            zfmMap.Map( ZONE_FILL_MODE::POLYGONS,        _HKI( "Solid fill" ) )
                  .Map( ZONE_FILL_MODE::HATCH_PATTERN,   _HKI( "Hatch pattern" ) )
                  .Map( ZONE_FILL_MODE::COPPER_THIEVING, _HKI( "Copper thieving" ) );
        }
 
        ENUM_MAP<THIEVING_PATTERN>& tpMap = ENUM_MAP<THIEVING_PATTERN>::Instance();
 
        if( tpMap.Choices().GetCount() == 0 )
        {
            tpMap.Undefined( THIEVING_PATTERN::DOTS );
            tpMap.Map( THIEVING_PATTERN::DOTS,    _HKI( "Dots" ) )
                 .Map( THIEVING_PATTERN::SQUARES, _HKI( "Squares" ) )
                 .Map( THIEVING_PATTERN::HATCH,   _HKI( "Hatch" ) );
        }
 
        ENUM_MAP<ISLAND_REMOVAL_MODE>& irmMap = ENUM_MAP<ISLAND_REMOVAL_MODE>::Instance();
 
        if( irmMap.Choices().GetCount() == 0 )
        {
            irmMap.Undefined( ISLAND_REMOVAL_MODE::ALWAYS );
            irmMap.Map( ISLAND_REMOVAL_MODE::ALWAYS, _HKI( "Always" ) )
                  .Map( ISLAND_REMOVAL_MODE::NEVER,  _HKI( "Never" ) )
                  .Map( ISLAND_REMOVAL_MODE::AREA,   _HKI( "Below area limit" ) );
        }
 
        ENUM_MAP<PLACEMENT_SOURCE_T>& rapstMap = ENUM_MAP<PLACEMENT_SOURCE_T>::Instance();
 
        if( rapstMap.Choices().GetCount() == 0 )
        {
            rapstMap.Undefined( PLACEMENT_SOURCE_T::SHEETNAME );
            rapstMap.Map( PLACEMENT_SOURCE_T::SHEETNAME,       _HKI( "Sheet Name" ) )
                    .Map( PLACEMENT_SOURCE_T::COMPONENT_CLASS, _HKI( "Component Class" ) )
                    .Map( PLACEMENT_SOURCE_T::GROUP_PLACEMENT, _HKI( "Group" ) );
        }
 
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        REGISTER_TYPE( ZONE );
        propMgr.InheritsAfter( TYPE_HASH( ZONE ), TYPE_HASH( BOARD_CONNECTED_ITEM ) );
 
        // Mask layer and position properties; they aren't useful in current form
        auto posX = new PROPERTY<ZONE, int>( _HKI( "Position X" ), NO_SETTER( ZONE, int ),
                                             static_cast<int ( ZONE::* )() const>( &ZONE::GetX ),
                                             PROPERTY_DISPLAY::PT_COORD,
                                             ORIGIN_TRANSFORMS::ABS_X_COORD );
        posX->SetIsHiddenFromPropertiesManager();
 
        auto posY = new PROPERTY<ZONE, int>( _HKI( "Position Y" ), NO_SETTER( ZONE, int ),
                                             static_cast<int ( ZONE::* )() const>( &ZONE::GetY ),
                                             PROPERTY_DISPLAY::PT_COORD,
                                             ORIGIN_TRANSFORMS::ABS_Y_COORD );
        posY->SetIsHiddenFromPropertiesManager();
 
        propMgr.ReplaceProperty( TYPE_HASH( BOARD_ITEM ), _HKI( "Position X" ), posX );
        propMgr.ReplaceProperty( TYPE_HASH( BOARD_ITEM ), _HKI( "Position Y" ), posY );
 
        auto isCopperZone =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                        return !zone->GetIsRuleArea() && IsCopperLayer( zone->GetFirstLayer() );
 
                    return false;
                };
 
        // Hide net-bearing and hatch/island properties for copper-thieving zones.
        // Same predicate gates both kinds of properties.
        auto isNonThievingCopperZone =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                    {
                        return !zone->GetIsRuleArea()
                                && IsCopperLayer( zone->GetFirstLayer() )
                                && !zone->IsCopperThieving();
                    }
 
                    return false;
                };
 
        auto isRuleArea =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                        return zone->GetIsRuleArea();
 
                    return false;
                };
 
        auto isHatchedFill =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                        return zone->GetFillMode() == ZONE_FILL_MODE::HATCH_PATTERN;
 
                    return false;
                };
 
        auto isThievingFill =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                        return zone->IsCopperThieving();
 
                    return false;
                };
 
        auto isThievingHatch =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                    {
                        return zone->IsCopperThieving()
                                && zone->GetThievingPattern() == THIEVING_PATTERN::HATCH;
                    }
 
                    return false;
                };
 
        auto isThievingNonHatch =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                    {
                        return zone->IsCopperThieving()
                                && zone->GetThievingPattern() != THIEVING_PATTERN::HATCH;
                    }
 
                    return false;
                };
 
        auto isAreaBasedIslandRemoval =
                []( INSPECTABLE* aItem ) -> bool
                {
                    if( ZONE* zone = dynamic_cast<ZONE*>( aItem ) )
                        return zone->GetIslandRemovalMode() == ISLAND_REMOVAL_MODE::AREA;
 
                    return false;
                };
 
        // Visible for thieving zones only; ordinary zones use a layer set, not a single layer.
        propMgr.ReplaceProperty( TYPE_HASH( BOARD_CONNECTED_ITEM ), _HKI( "Layer" ),
                                 new PROPERTY_ENUM<ZONE, PCB_LAYER_ID>( _HKI( "Layer" ),
                                                                        &ZONE::SetLayer, &ZONE::GetLayer ) )
                .SetAvailableFunc( isThievingFill );
 
        propMgr.OverrideAvailability( TYPE_HASH( ZONE ), TYPE_HASH( BOARD_CONNECTED_ITEM ), _HKI( "Net" ),
                                      isNonThievingCopperZone );
        propMgr.OverrideAvailability( TYPE_HASH( ZONE ), TYPE_HASH( BOARD_CONNECTED_ITEM ), _HKI( "Net Class" ),
                                      isNonThievingCopperZone );
 
        propMgr.AddProperty( new PROPERTY<ZONE, unsigned>( _HKI( "Priority" ), &ZONE::SetAssignedPriority,
                                                           &ZONE::GetAssignedPriority ) )
                .SetAvailableFunc( isCopperZone );
 
        propMgr.AddProperty( new PROPERTY<ZONE, wxString>( _HKI( "Name" ),
                    &ZONE::SetZoneName, &ZONE::GetZoneName ) );
 
        const wxString groupKeepout = _HKI( "Keepout" );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Keep Out Tracks" ),
                    &ZONE::SetDoNotAllowTracks, &ZONE::GetDoNotAllowTracks ),
                    groupKeepout )
                .SetAvailableFunc( isRuleArea );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Keep Out Vias" ),
                    &ZONE::SetDoNotAllowVias, &ZONE::GetDoNotAllowVias ),
                    groupKeepout )
                .SetAvailableFunc( isRuleArea );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Keep Out Pads" ),
                    &ZONE::SetDoNotAllowPads, &ZONE::GetDoNotAllowPads ),
                    groupKeepout )
                .SetAvailableFunc( isRuleArea );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Keep Out Zone Fills" ),
                    &ZONE::SetDoNotAllowZoneFills, &ZONE::GetDoNotAllowZoneFills ),
                    groupKeepout )
                .SetAvailableFunc( isRuleArea );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Keep Out Footprints" ),
                    &ZONE::SetDoNotAllowFootprints, &ZONE::GetDoNotAllowFootprints ),
                    groupKeepout )
                .SetAvailableFunc( isRuleArea );
 
 
        const wxString groupPlacement = _HKI( "Placement" );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Enable" ),
                    &ZONE::SetPlacementAreaEnabled, &ZONE::GetPlacementAreaEnabled ),
                    groupPlacement )
                .SetAvailableFunc( isRuleArea );
 
        propMgr.AddProperty( new PROPERTY_ENUM<ZONE, PLACEMENT_SOURCE_T>( _HKI( "Source Type" ),
                    &ZONE::SetPlacementAreaSourceType, &ZONE::GetPlacementAreaSourceType ),
                    groupPlacement )
                .SetAvailableFunc( isRuleArea );
 
        propMgr.AddProperty( new PROPERTY<ZONE, wxString>( _HKI( "Source Name" ),
                    &ZONE::SetPlacementAreaSource, &ZONE::GetPlacementAreaSource ),
                    groupPlacement )
                .SetAvailableFunc( isRuleArea );
 
 
        const wxString groupFill = _HKI( "Fill Style" );
 
        propMgr.AddProperty( new PROPERTY_ENUM<ZONE, ZONE_FILL_MODE>( _HKI( "Fill Mode" ),
                    &ZONE::SetFillMode, &ZONE::GetFillMode ),
                    groupFill )
                .SetAvailableFunc( isCopperZone );
 
        propMgr.AddProperty( new PROPERTY<ZONE, EDA_ANGLE>( _HKI( "Hatch Orientation" ),
                    &ZONE::SetHatchOrientation, &ZONE::GetHatchOrientation,
                    PROPERTY_DISPLAY::PT_DEGREE ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isHatchedFill );
 
        auto atLeastMinWidthValidator =
                []( const wxAny&& aValue, EDA_ITEM* aZone ) -> VALIDATOR_RESULT
                {
                    int   val = aValue.As<int>();
                    ZONE* zone = dynamic_cast<ZONE*>( aZone );
                    wxCHECK( zone, std::nullopt );
 
                    if( val < zone->GetMinThickness() )
                        return std::make_unique<VALIDATION_ERROR_MSG>( _( "Cannot be less than zone minimum width" ) );
 
                    return std::nullopt;
                };
 
        propMgr.AddProperty( new PROPERTY<ZONE, int>( _HKI( "Hatch Width" ),
                    &ZONE::SetHatchThickness, &ZONE::GetHatchThickness, PROPERTY_DISPLAY::PT_SIZE ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isHatchedFill )
                .SetValidator( atLeastMinWidthValidator );
 
        propMgr.AddProperty( new PROPERTY<ZONE, int>( _HKI( "Hatch Gap" ),
                    &ZONE::SetHatchGap, &ZONE::GetHatchGap, PROPERTY_DISPLAY::PT_SIZE ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isHatchedFill )
                .SetValidator( atLeastMinWidthValidator );
 
        propMgr.AddProperty( new PROPERTY<ZONE, double>( _HKI( "Hatch Minimum Hole Ratio" ),
                     &ZONE::SetHatchHoleMinArea, &ZONE::GetHatchHoleMinArea ),
                     groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isHatchedFill )
                .SetValidator( PROPERTY_VALIDATORS::PositiveRatioValidator );
 
        // TODO: Smoothing effort needs to change to enum (in dialog too)
        propMgr.AddProperty( new PROPERTY<ZONE, int>( _HKI( "Smoothing Effort" ),
                    &ZONE::SetHatchSmoothingLevel, &ZONE::GetHatchSmoothingLevel ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isHatchedFill );
 
        propMgr.AddProperty( new PROPERTY<ZONE, double>( _HKI( "Smoothing Amount" ),
                    &ZONE::SetHatchSmoothingValue, &ZONE::GetHatchSmoothingValue ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isHatchedFill );
 
        propMgr.AddProperty( new PROPERTY_ENUM<ZONE, THIEVING_PATTERN>( _HKI( "Thieving Pattern" ),
                    &ZONE::SetThievingPattern, &ZONE::GetThievingPattern ),
                    groupFill )
                .SetAvailableFunc( isThievingFill );
 
        propMgr.AddProperty( new PROPERTY<ZONE, int>( _HKI( "Thieving Element Size" ),
                    &ZONE::SetThievingElementSize, &ZONE::GetThievingElementSize,
                    PROPERTY_DISPLAY::PT_SIZE ),
                    groupFill )
                .SetAvailableFunc( isThievingFill )
                .SetWriteableFunc( isThievingNonHatch )
                .SetValidator( PROPERTY_VALIDATORS::PositiveIntValidator );
 
        // Gap is meaningful for all three patterns: edge-to-edge spacing between
        // adjacent stamps for dots/squares, line-to-line edge spacing for hatch.
        propMgr.AddProperty( new PROPERTY<ZONE, int>( _HKI( "Thieving Gap" ),
                    &ZONE::SetThievingGap, &ZONE::GetThievingGap, PROPERTY_DISPLAY::PT_SIZE ),
                    groupFill )
                .SetAvailableFunc( isThievingFill )
                .SetValidator( PROPERTY_VALIDATORS::PositiveIntValidator );
 
        propMgr.AddProperty( new PROPERTY<ZONE, int>( _HKI( "Thieving Line Width" ),
                    &ZONE::SetThievingLineWidth, &ZONE::GetThievingLineWidth,
                    PROPERTY_DISPLAY::PT_SIZE ),
                    groupFill )
                .SetAvailableFunc( isThievingFill )
                .SetWriteableFunc( isThievingHatch )
                .SetValidator( PROPERTY_VALIDATORS::PositiveIntValidator );
 
        propMgr.AddProperty( new PROPERTY<ZONE, bool>( _HKI( "Thieving Stagger" ),
                    &ZONE::SetThievingStagger, &ZONE::GetThievingStagger ),
                    groupFill )
                .SetAvailableFunc( isThievingFill );
 
        propMgr.AddProperty( new PROPERTY<ZONE, EDA_ANGLE>( _HKI( "Thieving Orientation" ),
                    &ZONE::SetThievingOrientation, &ZONE::GetThievingOrientation,
                    PROPERTY_DISPLAY::PT_DEGREE ),
                    groupFill )
                .SetAvailableFunc( isThievingFill );
 
        propMgr.AddProperty( new PROPERTY_ENUM<ZONE, ISLAND_REMOVAL_MODE>( _HKI( "Remove Islands" ),
                    &ZONE::SetIslandRemovalMode, &ZONE::GetIslandRemovalMode ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone );
 
        propMgr.AddProperty( new PROPERTY<ZONE, long long int>( _HKI( "Minimum Island Area" ),
                    &ZONE::SetMinIslandArea, &ZONE::GetMinIslandArea, PROPERTY_DISPLAY::PT_AREA ),
                    groupFill )
                .SetAvailableFunc( isNonThievingCopperZone )
                .SetWriteableFunc( isAreaBasedIslandRemoval );
 
        const wxString groupElectrical = _HKI( "Electrical" );
 
        auto clearance = new PROPERTY<ZONE, std::optional<int>>( _HKI( "Clearance" ),
                    &ZONE::SetLocalClearance, &ZONE::GetLocalClearance, PROPERTY_DISPLAY::PT_SIZE );
        clearance->SetAvailableFunc( isCopperZone );
        constexpr int maxClearance = pcbIUScale.mmToIU( ZONE_CLEARANCE_MAX_VALUE_MM );
        clearance->SetValidator( PROPERTY_VALIDATORS::RangeIntValidator<0, maxClearance> );
 
        auto minWidth = new PROPERTY<ZONE, int>( _HKI( "Minimum Width" ),
                    &ZONE::SetMinThickness, &ZONE::GetMinThickness, PROPERTY_DISPLAY::PT_SIZE );
        minWidth->SetAvailableFunc( isCopperZone );
        constexpr int minMinWidth = pcbIUScale.mmToIU( ZONE_THICKNESS_MIN_VALUE_MM );
        minWidth->SetValidator( PROPERTY_VALIDATORS::RangeIntValidator<minMinWidth, INT_MAX> );
 
        // Pad connections and thermal-relief controls require a net to act on.
        // Thieving zones are netless and explicitly use ZONE_CONNECTION::NONE,
        // so hide these for them while keeping them visible for solid + hatched zones.
        auto padConnections = new PROPERTY_ENUM<ZONE, ZONE_CONNECTION>( _HKI( "Pad Connections" ),
                    &ZONE::SetPadConnection, &ZONE::GetPadConnection );
        padConnections->SetAvailableFunc( isNonThievingCopperZone );
 
        auto thermalGap = new PROPERTY<ZONE, int>( _HKI( "Thermal Relief Gap" ),
                    &ZONE::SetThermalReliefGap, &ZONE::GetThermalReliefGap, PROPERTY_DISPLAY::PT_SIZE );
        thermalGap->SetAvailableFunc( isNonThievingCopperZone );
        thermalGap->SetValidator( PROPERTY_VALIDATORS::PositiveIntValidator );
 
        auto thermalSpokeWidth = new PROPERTY<ZONE, int>( _HKI( "Thermal Relief Spoke Width" ),
                    &ZONE::SetThermalReliefSpokeWidth, &ZONE::GetThermalReliefSpokeWidth, PROPERTY_DISPLAY::PT_SIZE );
        thermalSpokeWidth->SetAvailableFunc( isNonThievingCopperZone );
        thermalSpokeWidth->SetValidator( atLeastMinWidthValidator );
 
        propMgr.AddProperty( clearance, groupElectrical );
        propMgr.AddProperty( minWidth, groupElectrical );
        propMgr.AddProperty( padConnections, groupElectrical );
        propMgr.AddProperty( thermalGap, groupElectrical );
        propMgr.AddProperty( thermalSpokeWidth, groupElectrical );
    }
} _ZONE_DESC;
 
IMPLEMENT_ENUM_TO_WXANY( PLACEMENT_SOURCE_T )
IMPLEMENT_ENUM_TO_WXANY( ZONE_CONNECTION )
IMPLEMENT_ENUM_TO_WXANY( ZONE_FILL_MODE )
IMPLEMENT_ENUM_TO_WXANY( THIEVING_PATTERN )
IMPLEMENT_ENUM_TO_WXANY( ISLAND_REMOVAL_MODE )