43#include <magic_enum.hpp>
45#include <google/protobuf/any.pb.h>
49#include <api/board/board_types.pb.h>
114 *
this = *
static_cast<const ZONE*
>( aOther );
218 return new ZONE( *
this );
236 ZONE* newZone =
static_cast<ZONE*
>( dupe );
253 zone.mutable_id()->set_value(
m_Uuid.AsStdString() );
257 zone.set_type( types::ZT_RULE_AREA );
259 zone.set_type( types::ZT_TEARDROP );
261 zone.set_type( types::ZT_COPPER );
263 zone.set_type( types::ZT_GRAPHICAL );
272 zone.mutable_parent()->set_value( parent->m_Uuid.AsStdString() );
274 zone.mutable_parent()->set_value(
board->m_Uuid.AsStdString() );
278 types::RuleAreaSettings* ra = zone.mutable_rule_area_settings();
292 types::CopperZoneSettings* cu = zone.mutable_copper_settings();
293 cu->mutable_connection()->set_zone_connection(
296 types::ThermalSpokeSettings* thermals = cu->mutable_connection()->mutable_thermal_spokes();
308 cu->set_corner_smoothing(
314 types::HatchFillSettings* hatch = cu->mutable_hatch_settings();
316 hatch->mutable_gap()->set_value_nm(
m_hatchGap );
317 hatch->mutable_orientation()->set_value_degrees(
m_hatchOrientation.GetAngle().AsDegrees() );
324 case 0: hatch->set_border_mode( types::ZHFBM_USE_MIN_ZONE_THICKNESS );
break;
325 case 1: hatch->set_border_mode( types::ZHFBM_USE_HATCH_THICKNESS );
break;
329 cu->mutable_teardrop()->set_type(
332 types::ThievingFillSettings* thieving = cu->mutable_thieving_settings();
333 thieving->set_pattern(
339 thieving->mutable_orientation()->set_value_degrees(
m_thievingSettings.orientation.GetAngle().AsDegrees() );
344 types::ZoneFilledPolygons* filledLayer = zone.add_filled_polygons();
351 types::ZoneLayerProperties* layerProperties = zone.add_layer_properties();
354 if( properties.hatching_offset.has_value() )
356 PackVector2( *layerProperties->mutable_hatching_offset(),
357 properties.hatching_offset.value() );
361 zone.mutable_border()->set_style(
366 aContainer.PackFrom( zone );
376 if( !aContainer.UnpackTo( &zone ) )
385 if( zone.type() == types::ZoneType::ZT_RULE_AREA )
393 if(
m_Poly->OutlineCount() == 0 )
398 const types::RuleAreaSettings& ra = zone.rule_area_settings();
411 const types::CopperZoneSettings& cu = zone.copper_settings();
426 if( cu.has_corner_radius() )
432 m_hatchGap = cu.hatch_settings().gap().value_nm();
437 switch( cu.hatch_settings().border_mode() )
447 if( cu.has_thieving_settings() )
449 const types::ThievingFillSettings& thieving = cu.thieving_settings();
453 auto assignIfPositive = [](
int aProtoValue,
int& aTarget )
455 if( aProtoValue > 0 )
456 aTarget = aProtoValue;
459 assignIfPositive( thieving.element_size().value_nm(),
m_thievingSettings.element_size );
468 for(
const auto& properties : zone.layer_properties() )
474 if( properties.has_hatching_offset() )
475 layerProperties.
hatching_offset = UnpackVector2( properties.hatching_offset() );
489 for(
const types::ZoneFilledPolygons& fillLayer : zone.filled_polygons() )
542 change |= !pair.second->IsEmpty();
548 pair.second = std::make_shared<SHAPE_POLY_SET>();
566 if(
m_Poly->OutlineCount() == 0 ||
m_Poly->TotalVertices() == 0 )
585 if( uiLayers.size() )
606 if( uiLayers.size() )
667 if( aLayerSet.count() == 0 )
697 [&](
const auto& item )
699 return !effectiveSet.
Contains( item.first );
717 std::vector<int> layers;
723 layers.push_back( layer );
747 if( !onFront && !onBack )
749 onFront = parentFP->GetLayer() ==
F_Cu;
750 onBack = parentFP->GetLayer() ==
B_Cu;
756 if( onFront && !onBack && frHidden )
759 if( onBack && !onFront && bkHidden )
762 if( onFront && onBack && frHidden && bkHidden )
796 std::unordered_map<const ZONE*, BOX2I>& cache =
board->m_ZoneBBoxCache;
799 std::shared_lock<std::shared_mutex> readLock(
board->m_CachesMutex );
801 auto cacheIter = cache.find(
this );
803 if( cacheIter != cache.end() )
804 return cacheIter->second;
810 std::unique_lock<std::shared_mutex> writeLock(
board->m_CachesMutex );
811 cache[ this ] = bbox;
825 std::unique_lock<std::shared_mutex> writeLock(
board->m_CachesMutex );
826 board->m_ZoneBBoxCache.erase(
this );
851 std::unique_lock<std::shared_mutex> writeLock(
board->m_CachesMutex );
852 board->m_ZoneBBoxCache[
this] = bbox;
868 *aSource =
_(
"zone" );
923 poly =
m_Poly->CloneDropTriangulation();
933 poly =
m_Poly->CloneDropTriangulation();
955 libPos = fp->GetTransform().InverseApply( refPos );
957 return m_Poly->CollideVertex( libPos, aCornerHit, aAccuracy );
966 libPos = fp->GetTransform().InverseApply( refPos );
968 return m_Poly->CollideEdge( libPos, aCornerHit, aAccuracy );
995 for(
int ii = 0; ii < count; ii++ )
998 const VECTOR2I& vertexNext = boardOutline.
CVertex( ( ii + 1 ) % count );
1020 auto outlineIntersectingSelection =
1034 auto vertexInsideSelection =
1040 return vertexInsideSelection() && !outlineIntersectingSelection();
1077 libPos = fp->GetTransform().InverseApply( aRefPos );
1079 return m_Poly->Contains( libPos, -1, aAccuracy );
1082 std::shared_ptr<SHAPE_POLY_SET> fillPolys;
1093 return fillPolys->Contains( aRefPos, -1, aAccuracy );
1102 libPos = fp->GetTransform().InverseApply( aRefPos );
1106 for(
int i = 0; i <
m_Poly->OutlineCount(); i++ )
1108 for(
int j = 0; j <
m_Poly->HoleCount( i ); j++ )
1110 if(
m_Poly->Hole( i, j ).PointInside( libPos ) )
1131 aList.emplace_back(
_(
"Type" ), msg );
1152 if( !msg.IsEmpty() )
1153 aList.emplace_back(
_(
"Restrictions" ), msg );
1164 aList.emplace_back(
_(
"Resolved Netclass" ),
1175 aList.emplace_back(
_(
"Status" ),
_(
"Locked" ) );
1181 if( layers.size() == 1 )
1185 else if( layers.size() == 2 )
1189 else if( layers.size() == 3 )
1194 else if( layers.size() > 3 )
1197 static_cast<int>( layers.size() - 2 ) );
1200 aList.emplace_back(
_(
"Layer" ), layerDesc );
1211 default: msg =
_(
"Unknown" );
break;
1214 aList.emplace_back(
_(
"Fill Mode" ), msg );
1216 aList.emplace_back(
_(
"Filled Area" ),
1225 wxString::Format(
_(
"(from %s)" ),
source ) );
1234 aList.emplace_back(
_(
"Outline Area" ),
1244 count += ii.second->TotalVertices();
1247 aList.emplace_back(
_(
"Corner Count" ), wxString::Format( wxT(
"%d" ), count ) );
1261 m_Poly->Move( outlineOffset );
1268 seg.A += outlineOffset;
1269 seg.B += outlineOffset;
1274 pair.second->Move( offset );
1286 if( it !=
GetBoard()->m_ZoneBBoxCache.end() )
1287 it->second.Move( offset );
1299 return _(
"Rule Area" );
1301 return _(
"Teardrop Area" );
1303 return _(
"Copper Zone" );
1305 return _(
"Non-copper Zone" );
1313 if(
m_Poly->GetNeighbourIndexes( aEdge,
nullptr, &next_corner ) )
1323 m_Poly->SetVertex( aEdge,
m_Poly->CVertex( aEdge ) + libOffset );
1324 m_Poly->SetVertex( next_corner,
m_Poly->CVertex( next_corner ) + libOffset );
1337 outlineCentre = fp->GetTransform().InverseApply( aCentre );
1339 m_Poly->Rotate( aAngle, outlineCentre );
1345 pair.second->Rotate( aAngle, aCentre );
1352 if( aRatioX == 1.0 && aRatioY == 1.0 )
1365 Mirror( aCentre, aFlipDirection );
1367 std::map<PCB_LAYER_ID, SHAPE_POLY_SET> fillsCopy;
1370 fillsCopy[oldLayer] = *shapePtr;
1372 std::map<PCB_LAYER_ID, ZONE_LAYER_PROPERTIES> layerPropertiesCopy =
m_layerProperties;
1381 for(
auto& [oldLayer, properties] : layerPropertiesCopy )
1387 for(
auto& [oldLayer, shape] : fillsCopy )
1400 outlineRef = fp->GetTransform().InverseApply( aMirrorRef );
1402 m_Poly->Mirror( outlineRef, aFlipDirection );
1408 pair.second->Mirror( aMirrorRef, aFlipDirection );
1415 if(
m_Poly->OutlineCount() < aOutlineIdx ||
m_Poly->HoleCount( aOutlineIdx ) < aHoleIdx )
1421 m_Poly->BooleanAdd( cutPoly );
1432 if(
m_Poly->OutlineCount() == 0 )
1433 m_Poly->AddOutline( aPolygon );
1435 m_Poly->AddHole( aPolygon );
1443 if( aPolygon.empty() )
1449 for(
const VECTOR2I& pt : aPolygon )
1461 if(
m_Poly->OutlineCount() == 0 )
1467 if( aHoleIdx >=
m_Poly->HoleCount( 0 ) )
1470 m_Poly->Append( aPosition.
x, aPosition.
y, -1, aHoleIdx, aAllowDuplication );
1487 return board->GetLayerName( aLayer );
1492 if( layers.size() == 1 )
1494 layerDesc.Printf(
_(
"on %s" ), layerName( layers[0] ) );
1496 else if (layers.size() == 2 )
1498 layerDesc.Printf(
_(
"on %s and %s" ),
1499 layerName( layers[0] ),
1500 layerName( layers[1] ) );
1502 else if (layers.size() == 3 )
1504 layerDesc.Printf(
_(
"on %s, %s and %s" ),
1505 layerName( layers[0] ),
1506 layerName( layers[1] ),
1507 layerName( layers[2] ) );
1509 else if( layers.size() > 3 )
1511 layerDesc.Printf(
_(
"on %s, %s and %zu more" ),
1512 layerName( layers[0] ),
1513 layerName( layers[1] ),
1514 layers.size() - 2 );
1521 return wxString::Format(
_(
"Rule Area %s" ), layerDesc );
1525 return wxString::Format(
_(
"Rule area '%s' %s" ),
1532 return wxString::Format(
_(
"Teardrop %s %s" ),
1540 return wxString::Format(
_(
"Zone %s %s, priority %d" ),
1547 return wxString::Format(
_(
"Zone '%s' %s %s, priority %d" ),
1558 bool aRebuildBorderHatch )
1565 if( aRebuildBorderHatch )
1598 hatch_line_len = -1;
1603 std::vector<double> slopes;
1606 slopes = { 0.7, -0.7 };
1607 else if( layer & 1 )
1650 std::swap( *
static_cast<ZONE*
>(
this ), *
static_cast<ZONE*
>( aImage) );
1658 std::vector<PCB_LAYER_ID> layers;
1663 layers.push_back( layer );
1671 m_Poly->CacheTriangulation();
1682 poly->CacheTriangulation(
false, aSubmitter );
1684 m_Poly->CacheTriangulation();
1691 std::shared_ptr<SHAPE_POLY_SET> poly;
1703 poly->CacheTriangulation(
false, aSubmitter );
1721 std::vector<ZONE*>* aOtherNetIntersectingZones )
const
1733 if( candidate ==
this )
1736 if( !candidate->GetLayerSet().test( aLayer ) )
1739 if( candidate->GetIsRuleArea() || candidate->IsTeardropArea() )
1742 if( !candidate->GetBoundingBox().Intersects( bbox ) )
1745 if( candidate->GetNetCode() ==
GetNetCode() )
1750 const SHAPE_POLY_SET* candidateOutline = &candidateOutlineStorage;
1758 if( candidate->GetParentFootprint() )
1759 candidateOutlineStorage = candidate->GetBoardOutline();
1761 candidateOutline = candidate->
Outline();
1763 if( selfOutline->
Collide( candidateOutline ) )
1764 aSameNetCollidingZones->push_back( candidate );
1768 aOtherNetIntersectingZones->push_back( candidate );
1788 aSmoothedPoly = std::move( flattened );
1793 bool keepExternalFillets =
false;
1801 smooth_requested =
false;
1805 keepExternalFillets =
board->GetDesignSettings().m_ZoneKeepExternalFillets;
1810 if( !smooth_requested )
1831 aSmoothedPoly = flattened;
1836 if( keepExternalFillets && smooth_requested )
1838 withFillets = flattened;
1839 smooth( withFillets );
1841 maxExtents = &withFillets;
1849 std::vector<ZONE*> sameNetCollidingZones;
1850 std::vector<ZONE*> diffNetIntersectingZones;
1853 for(
ZONE* sameNetZone : sameNetCollidingZones )
1855 BOX2I sameNetBoundingBox = sameNetZone->GetBoundingBox();
1869 for(
ZONE* diffNetZone : diffNetIntersectingZones )
1871 if( diffNetZone->HigherPriority( sameNetZone )
1872 && diffNetZone->GetBoundingBox().Intersects( sameNetBoundingBox ) )
1884 bool isolated =
false;
1909 smooth( aSmoothedPoly );
1911 if( aSmoothedPolyWithApron )
1921 if( !keepExternalFillets )
1924 *aSmoothedPolyWithApron = aSmoothedPoly;
1971 aBuffer.
Append( polybuffer );
1985 return std::make_shared<SHAPE_POLY_SET>( *
Outline() );
1991 return std::make_shared<SHAPE_NULL>();
2003 bool filled =
false;
2004 double largest = 0.0;
2013 if( fill->OutlineCount() == 0 )
2017 largest = std::max( largest, fill->Area() );
2036 int aError,
ERROR_LOC aErrorLoc,
bool aIgnoreLineWidth )
const
2038 wxASSERT_MSG( !aIgnoreLineWidth, wxT(
"IgnoreLineWidth has no meaning for zones." ) );
2040 std::shared_ptr<SHAPE_POLY_SET> fillPolys;
2053 aBuffer.
Append( *fillPolys );
2063 aClearance += aError;
2068 aBuffer.
Append( temp_buf );
2083 if( aLayerSet.count() == 0 )
2112 const ZONE& other =
static_cast<const ZONE&
>( aOther );
2113 return *
this == other;
2123 const ZONE& other =
static_cast<const ZONE&
>( aOther );
2190 const ZONE& other =
static_cast<const ZONE&
>( aOther );
2195 double similarity = 1.0;
2234 std::vector<VECTOR2I> corners;
2235 std::vector<VECTOR2I> otherCorners;
2265 if( layerEnum.
Choices().GetCount() == 0 )
2275 if( zcMap.
Choices().GetCount() == 0 )
2287 if( zfmMap.
Choices().GetCount() == 0 )
2297 if( tpMap.
Choices().GetCount() == 0 )
2307 if( irmMap.
Choices().GetCount() == 0 )
2317 if( rapstMap.
Choices().GetCount() == 0 )
2345 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2346 return !zone->GetIsRuleArea() &&
IsCopperLayer( zone->GetFirstLayer() );
2353 auto isNonThievingCopperZone =
2356 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2358 return !zone->GetIsRuleArea() &&
IsCopperLayer( zone->GetFirstLayer() )
2359 && !zone->IsCopperThieving();
2368 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2369 return zone->GetIsRuleArea();
2374 auto isHatchedFill =
2377 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2383 auto isThievingFill =
2386 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2387 return zone->IsCopperThieving();
2392 auto isThievingHatch =
2395 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2401 auto isThievingNonHatch =
2404 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2410 auto isAreaBasedIslandRemoval =
2413 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
2426 isNonThievingCopperZone );
2428 isNonThievingCopperZone );
2437 const wxString groupKeepout =
_HKI(
"Keepout" );
2465 const wxString groupPlacement =
_HKI(
"Placement" );
2483 const wxString groupFill =
_HKI(
"Fill Style" );
2496 auto atLeastMinWidthValidator =
2499 int val = aValue.As<
int>();
2500 ZONE* zone =
dynamic_cast<ZONE*
>( aZone );
2501 wxCHECK( zone, std::nullopt );
2503 if( val < zone->GetMinThickness() )
2504 return std::make_unique<VALIDATION_ERROR_MSG>(
_(
"Cannot be less than zone minimum width" ) );
2506 return std::nullopt;
2594 const wxString groupElectrical =
_HKI(
"Electrical" );
KICOMMON_API types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
KICOMMON_API KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
constexpr EDA_IU_SCALE pcbIUScale
BITMAPS
A list of all bitmap identifiers.
BASE_SET & set(size_t pos)
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
wxString GetNetnameMsg() const
virtual NETCLASS * GetEffectiveNetClass() const
Return the NETCLASS for this item.
virtual bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
wxString GetNetname() const
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
void PackNet(kiapi::board::types::Net *aProto) const
virtual void SetNet(NETINFO_ITEM *aNetInfo)
Set a NET_INFO object for the item.
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
virtual int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
Return an item's "own" clearance in internal units.
void UnpackNet(const kiapi::board::types::Net &aProto)
Assigns a net to this item from an API message.
TEARDROP_PARAMETERS & GetTeardropParams()
ZONE_SETTINGS & GetDefaultZoneSettings()
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype, PCB_LAYER_ID aLayer=F_Cu)
void SetUuidDirect(const KIID &aUuid)
Raw UUID assignment.
virtual BOARD_ITEM * Duplicate(bool addToParentGroup, BOARD_COMMIT *aCommit=nullptr) const
Create a copy of this BOARD_ITEM.
PCB_LAYER_ID GetFlippedLayer(PCB_LAYER_ID aLayer) const
Return the layer paired with aLayer on the opposite side of the board.
static double polygonArea(SHAPE_POLY_SET &aPolySet)
Area of aPolySet with every contour closed first, holes subtracted.
bool IsLocked() const override
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
BOARD_ITEM & operator=(const BOARD_ITEM &aOther)
BOARD_ITEM_CONTAINER * GetParent() const
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
std::unordered_map< const ZONE *, BOX2I > m_ZoneBBoxCache
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
constexpr bool Contains(const Vec &aPoint) const
constexpr bool Intersects(const BOX2< Vec > &aRect) const
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
ENUM_MAP & Map(T aValue, const wxString &aName)
static ENUM_MAP< T > & Instance()
ENUM_MAP & Undefined(T aValue)
Class that other classes need to inherit from, in order to be inspectable.
static constexpr double LOD_HIDE
Return this constant from ViewGetLOD() to hide the item unconditionally.
static constexpr double LOD_SHOW
Return this constant from ViewGetLOD() to show the item unconditionally.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
bool IsLayerVisibleCached(int aLayer) const
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
LSET is a set of PCB_LAYER_IDs.
static const LSET & FrontMask()
Return a mask holding all technical layers and the external CU layer on front side.
LSEQ UIOrder() const
Return the copper, technical and user layers in the order shown in layer widget.
static const LSET & BackMask()
Return a mask holding all technical layers and the external CU layer on back side.
void RunOnLayers(const std::function< void(PCB_LAYER_ID)> &aFunction) const
Execute a function on each layer of the LSET.
static LSET AllCuMask(int aCuLayerCount)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
static const LSET & AllLayersMask()
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
bool Contains(PCB_LAYER_ID aLayer) const
See if the layer set contains a PCB layer.
Handle the data for a net.
int GetLocalThermalGapOverride(wxString *aSource) const
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
PROPERTY_BASE & SetWriteableFunc(std::function< bool(INSPECTABLE *)> aFunc)
PROPERTY_BASE & SetValidator(PROPERTY_VALIDATOR_FN &&aValidator)
PROPERTY_BASE & SetIsCopyable(bool aIsCopyable=true)
PROPERTY_BASE & SetIsHiddenFromPropertiesManager(bool aHide=true)
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
void OverrideAvailability(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName, std::function< bool(INSPECTABLE *)> aFunc)
Sets an override availability functor for a base class property of a given derived class.
PROPERTY_BASE & ReplaceProperty(size_t aBase, const wxString &aName, PROPERTY_BASE *aNew, const wxString &aGroup=wxEmptyString)
Replace an existing property for a specific type.
static VALIDATOR_RESULT PositiveRatioValidator(const wxAny &&aValue, EDA_ITEM *aItem)
static VALIDATOR_RESULT PositiveIntValidator(const wxAny &&aValue, EDA_ITEM *aItem)
static VALIDATOR_RESULT RangeIntValidator(const wxAny &&aValue, EDA_ITEM *aItem)
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
bool IsClosed() const override
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
bool Intersects(const SEG &aSeg) const
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
bool PointInside(const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const override
Check if point aP lies inside a closed shape.
Represent a set of closed polygons.
void BooleanAdd(const SHAPE_POLY_SET &b)
Perform boolean polyset union.
ITERATOR IterateWithHoles(int aOutline)
void ClearArcs()
Removes all arc references from all the outlines and holes in the polyset.
void SetVertex(const VERTEX_INDEX &aIndex, const VECTOR2I &aPos)
Accessor function to set the position of a specific point.
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
int TotalVertices() const
Return total number of vertices stored in the set.
int FullPointCount() const
Return the number of points in the shape poly set.
void Inflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify=false)
Perform outline inflation/deflation.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
void BooleanIntersection(const SHAPE_POLY_SET &b)
Perform boolean polyset intersection.
SEGMENT_ITERATOR IterateSegments(int aFirst, int aLast, bool aIterateHoles=false)
Return an iterator object, for iterating between aFirst and aLast outline, with or without holes (def...
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Return the index-th vertex in a given hole outline within a given outline.
int OutlineCount() const
Return the number of outlines in the set.
void InflateWithLinkedHoles(int aFactor, CORNER_STRATEGY aCornerStrategy, int aMaxError)
Perform outline inflation/deflation, using round corners.
void Fracture(bool aSimplify=true)
Convert a set of polygons with holes to a single outline with "slits"/"fractures" connecting the oute...
SHAPE_POLY_SET CloneDropTriangulation() const
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
std::function< void(std::function< void()>)> TASK_SUBMITTER
Callback that submits a unit of work for asynchronous execution.
SEGMENT_ITERATOR IterateSegmentsWithHoles()
Returns an iterator object, for all outlines in the set (with holes)
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Copy settings to a given zone.
Handle a list of polygons defining a copper zone.
void SetHatchThickness(int aThickness)
void CacheTriangulation(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, const SHAPE_POLY_SET::TASK_SUBMITTER &aSubmitter={})
void SetNeedRefill(bool aNeedRefill)
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if a point is near an outline edge or a corner of this zone.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
wxString m_placementAreaSource
bool m_isRuleArea
A zone outline can be a rule area.
void SetDoNotAllowPads(bool aEnable)
void SetLayerProperties(const std::map< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES > &aOther)
ZONE & operator=(const ZONE &aOther)
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
PLACEMENT_SOURCE_T m_placementAreaSourceType
std::optional< int > GetLocalClearance() const override
void SetLocalClearance(std::optional< int > aClearance)
bool UnFill()
Removes the zone filling.
bool GetDoNotAllowVias() const
bool AppendCorner(const VECTOR2I &aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
void TransformSolidAreasShapesToPolygon(PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aBuffer) const
Convert solid areas full shapes to polygon set (the full shape is the polygon area with a thick outli...
void SetCornerRadius(unsigned int aRadius)
ZONE_FILL_MODE m_fillMode
THIEVING_SETTINGS m_thievingSettings
bool m_doNotAllowFootprints
bool unFillLocked()
Internal implementation of UnFill() that assumes the caller already holds m_filledPolysListMutex.
void TransformSmoothedOutlineToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, SHAPE_POLY_SET *aBoardOutline) const
Convert the outlines shape to a polygon with no holes inflated (optional) by max( aClearanceValue,...
BOARD_ITEM * Duplicate(bool addToParentGroup, BOARD_COMMIT *aCommit=nullptr) const override
Create a copy of this BOARD_ITEM.
int GetThievingLineWidth() const
void AddPolygon(std::vector< VECTOR2I > &aPolygon)
Add a polygon to the zone outline.
double m_hatchSmoothingValue
void SetLocalFlags(int aFlags)
int m_thermalReliefSpokeWidth
wxString GetPlacementAreaSource() const
bool HitTestCutout(const VECTOR2I &aRefPos, int *aOutlineIdx=nullptr, int *aHoleIdx=nullptr) const
Test if the given point is contained within a cutout of the zone.
void Mirror(const VECTOR2I &aMirrorRef, FLIP_DIRECTION aFlipDirection) override
Mirror the outlines relative to a given horizontal axis the layer is not changed.
std::map< PCB_LAYER_ID, std::set< int > > m_insulatedIslands
For each layer, a set of insulated islands that were not removed.
wxString m_zoneName
An optional unique name for this zone, used for identifying it in DRC checking.
void HatchBorder()
Compute the hatch lines depending on the hatch parameters and stores it in the zone's attribute m_bor...
std::map< PCB_LAYER_ID, std::shared_ptr< SHAPE_POLY_SET > > m_FilledPolysList
std::shared_ptr< SHAPE_POLY_SET > GetFilledPolysList(PCB_LAYER_ID aLayer) const
bool GetDoNotAllowPads() const
const BOX2I GetBoundingBox() const override
void SetMinThickness(int aMinThickness)
void SetPlacementAreaSource(const wxString &aSource)
BOX2I computeBoundingBox() const
Compute the bbox from scratch. Shared so the cached value can't diverge from the live one.
void SetThievingOrientation(const EDA_ANGLE &aOrientation)
double ViewGetLOD(int aLayer, const KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
PLACEMENT_SOURCE_T GetPlacementAreaSourceType() const
std::mutex m_filledPolysListMutex
void SetThievingPattern(THIEVING_PATTERN aPattern)
wxString GetFriendlyName() const override
bool GetDoNotAllowTracks() const
int GetLocalFlags() const
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
void SetHatchOrientation(const EDA_ANGLE &aStep)
void SetBorderDisplayStyle(ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle, int aBorderHatchPitch, bool aRebuildBorderHatch)
Set all hatch parameters for the zone.
void SetThievingElementSize(int aSize)
void SetHatchSmoothingValue(double aValue)
void CacheOutlineTriangulation()
Triangulate the zone outline only.
std::map< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES > m_layerProperties
void OnFootprintTransformed() override
Hook for items inside a footprint to refresh after the FP transform changes (translate,...
bool HitTestForCorner(const VECTOR2I &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX *aCornerHit=nullptr) const
Test if the given VECTOR2I is near a corner.
void SetHatchSmoothingLevel(int aLevel)
void SetThermalReliefSpokeWidth(int aThermalReliefSpokeWidth)
virtual PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
void SetPlacementAreaSourceType(PLACEMENT_SOURCE_T aType)
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
SHAPE_POLY_SET * Outline()
ZONE(BOARD_ITEM_CONTAINER *parent)
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
bool SetNetCode(int aNetCode, bool aNoAssert) override
Override that clamps the netcode to 0 when this zone is in copper-thieving fill mode.
void Move(const VECTOR2I &offset) override
Move the outlines.
bool IsIsland(PCB_LAYER_ID aLayer, int aPolyIdx) const
Check if a given filled polygon is an insulated island.
std::atomic< int > m_bboxCacheTimeStamp
bool IsCopperThieving() const
BOX2I m_bboxCache
Lock-free bbox cache, valid while m_bboxCacheTimeStamp matches the board timestamp.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
TEARDROP_TYPE m_teardropType
A zone outline can be a teardrop zone with different rules for priority (always bigger priority than ...
std::map< PCB_LAYER_ID, HASH_128 > m_filledPolysHash
A hash value used in zone filling calculations to see if the filled areas are up to date.
long long int GetMinIslandArea() const
int m_hatchSmoothingLevel
void SetThievingStagger(bool aStagger)
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void SetIsRuleArea(bool aEnable)
void CopyFrom(const BOARD_ITEM *aOther) override
void SetThievingGap(int aGap)
void SetDoNotAllowTracks(bool aEnable)
void SetFilledPolysList(PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPolysList)
Set the list of filled polygons.
bool m_placementAreaEnabled
Placement rule area data.
const wxString & GetZoneName() const
void CacheBoundingBox()
Used to preload the zone bounding box cache so we don't have to worry about mutex-locking it each tim...
int GetMinThickness() const
virtual void swapData(BOARD_ITEM *aImage) override
bool HitTestForEdge(const VECTOR2I &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX *aCornerHit=nullptr) const
Test if the given VECTOR2I is near a segment defined by 2 corners.
SHAPE_POLY_SET GetBoardOutline() const
void RemoveCutout(int aOutlineIdx, int aHoleIdx)
Remove a cutout from the zone.
void Rotate(const VECTOR2I &aCentre, const EDA_ANGLE &aAngle) override
Rotate the outlines.
ZONE_SETTINGS::CORNER_SMOOTHING GetCornerSmoothingType() const
bool HigherPriority(const ZONE *aOther) const
bool HitTestFilledArea(PCB_LAYER_ID aLayer, const VECTOR2I &aRefPos, int aAccuracy=0) const
Test if the given VECTOR2I is within the bounds of a filled area of this zone.
void SetIsFilled(bool isFilled)
std::mutex m_layerSetMutex
void SetFillMode(ZONE_FILL_MODE aFillMode)
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
ZONE_CONNECTION GetPadConnection() const
bool HasFilledPolysForLayer(PCB_LAYER_ID aLayer) const
int GetHatchThickness() const
double GetHatchHoleMinArea() const
void invalidateBoundingBoxCache() const
void SetLayerSet(const LSET &aLayerSet) override
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
virtual bool IsOnLayer(PCB_LAYER_ID) const override
Test to see if this object is on the given layer.
int m_hatchBorderAlgorithm
bool GetPlacementAreaEnabled() const
void SetDoNotAllowVias(bool aEnable)
bool IsTeardropArea() const
std::vector< SEG > m_borderHatchLines
VECTOR2I GetPosition() const override
int GetThermalReliefSpokeWidth() const
void SetNet(NETINFO_ITEM *aNetInfo) override
Override that drops aNetInfo when this zone is in copper-thieving fill mode.
virtual void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
void BuildHashValue(PCB_LAYER_ID aLayer)
Build the hash value of m_FilledPolysList, and store it internally in m_filledPolysHash.
void SetThermalReliefGap(int aThermalReliefGap)
EDA_ANGLE GetHatchOrientation() const
bool BuildSmoothedPoly(SHAPE_POLY_SET &aSmoothedPoly, PCB_LAYER_ID aLayer, SHAPE_POLY_SET *aBoardOutline, SHAPE_POLY_SET *aSmoothedPolyWithApron=nullptr) const
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT, DRC_CONSTRAINT_T aUsage=NULL_CONSTRAINT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
EDA_ORIENTATION m_hatchOrientation
bool GetDoNotAllowFootprints() const
ZONE_FILL_MODE GetFillMode() const
double m_hatchHoleMinArea
std::vector< PCB_LAYER_ID > GetFilledLayers() const
Create a list of triangles that "fill" the solid areas used for instance to draw these solid areas on...
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
bool GetThievingStagger() const
void SetDoNotAllowFootprints(bool aEnable)
void SetBorderHatchPitch(int aPitch)
void SetThievingLineWidth(int aWidth)
void GetInteractingZones(PCB_LAYER_ID aLayer, std::vector< ZONE * > *aSameNetCollidingZones, std::vector< ZONE * > *aOtherNetIntersectingZones) const
Some intersecting zones, despite being on the same layer with the same net, cannot be merged due to o...
void SetLayerSetAndRemoveUnusedFills(const LSET &aLayerSet)
Set the zone to be on the aLayerSet layers and only remove the fill polygons from the unused layers,...
double CalculateOutlineArea()
Compute the area of the zone outline (not the filled area).
int GetThievingGap() const
void SetHatchHoleMinArea(double aPct)
unsigned m_priority
Priority: when a zone outline is inside and other zone, if its priority is higher the other zone prio...
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
bool IsConflicting() const
For rule areas which exclude footprints (and therefore participate in courtyard conflicts during move...
bool m_doNotAllowZoneFills
For keepout zones only: what is not allowed inside the keepout ( pads, tracks and vias )
ISLAND_REMOVAL_MODE m_islandRemovalMode
std::vector< SEG > GetHatchLines() const
bool m_isFilled
True when a zone was filled, false after deleting the filled areas.
double GetHatchSmoothingValue() const
std::atomic< bool > m_needRefill
False when a zone was refilled, true after changes in zone params.
THIEVING_PATTERN GetThievingPattern() const
bool GetDoNotAllowZoneFills() const
void MoveEdge(const VECTOR2I &offset, int aEdge)
Move the outline Edge.
int GetHatchSmoothingLevel() const
unsigned int GetCornerRadius() const
int GetThievingElementSize() const
SHAPE_POLY_SET GetLibraryOutline() const
bool IsOnCopperLayer() const override
double CalculateFilledArea()
Compute the area currently occupied by the zone fill.
void SetDoNotAllowZoneFills(bool aEnable)
void OnFootprintRescaled(double aRatioX, double aRatioY, double aLinearFactor, const VECTOR2I &aAnchor, const EDA_ANGLE &aParentRotate) override
Apply a parent footprint scale to this item.
ZONE_SETTINGS::CORNER_SMOOTHING m_cornerSmoothingType
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the zone shape to a closed polygon Used in filling zones calculations Circles and arcs are ap...
void SetAssignedPriority(unsigned aPriority)
unsigned int m_cornerRadius
void SetPadConnection(ZONE_CONNECTION aPadConnection)
void SetZoneName(const wxString &aName)
bool operator==(const ZONE &aOther) const
void UnHatchBorder()
Clear the zone's hatch.
void SetIslandRemovalMode(ISLAND_REMOVAL_MODE aRemove)
EDA_ANGLE GetThievingOrientation() const
double GetCoverageArea(int aTextMargin) const override
Return the board area this item covers, used to rank candidates under the cursor so a click on a smal...
void SetOutline(SHAPE_POLY_SET *aOutline)
PCB_LAYER_ID GetFirstLayer() const
void SetMinIslandArea(long long int aArea)
virtual std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
HASH_128 GetHashValue(PCB_LAYER_ID aLayer)
ZONE_CONNECTION m_PadConnection
void InitDataFromSrcInCopyCtor(const ZONE &aZone, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
Copy aZone data to me.
int GetThermalReliefGap() const
void SetHatchGap(int aStep)
static int GetDefaultHatchPitch()
void SetPlacementAreaEnabled(bool aEnabled)
unsigned GetAssignedPriority() const
int GetNumCorners(void) const
Access to m_Poly parameters.
bool SameNet(const ZONE *aOther) const
ZONE_BORDER_DISPLAY_STYLE m_borderStyle
long long int m_minIslandArea
When island removal mode is set to AREA, islands below this area will be removed.
A type-safe container of any type.
@ ROUND_ALL_CORNERS
All angles are rounded.
static constexpr EDA_ANGLE ANGLE_0
#define PCB_EDIT_FRAME_NAME
#define COURTYARD_CONFLICT
temporary set when moving footprints having courtyard overlapping
a few functions useful in geometry calculations.
Some functions to handle hotkeys in KiCad.
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
@ LAYER_CONFLICTS_SHADOW
Shadow layer for items flagged conflicting.
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored).
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
PCB_LAYER_ID
A quick note on layer IDs:
size_t longest_common_subset(const _Container &__c1, const _Container &__c2)
Returns the length of the longest common subset of values between two containers.
void PackLayerSet(google::protobuf::RepeatedField< int > &aOutput, const LSET &aLayerSet)
LSET UnpackLayerSet(const google::protobuf::RepeatedField< int > &aProtoLayerSet)
KICOMMON_API void PackPolySet(types::PolySet &aOutput, const SHAPE_POLY_SET &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackCustomProperties(google::protobuf::RepeatedPtrField< types::CustomProperty > *aOutput, const EDA_ITEM &aItem)
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void UnpackCustomProperties(const google::protobuf::RepeatedPtrField< types::CustomProperty > &aInput, EDA_ITEM &aItem)
KICOMMON_API SHAPE_POLY_SET UnpackPolySet(const types::PolySet &aInput, const EDA_IU_SCALE &aScale)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
#define TYPE_HASH(x)
Macro to generate unique identifier for a type.
#define IMPLEMENT_ENUM_TO_WXANY(type)
#define NO_SETTER(owner, type)
Macro to define read-only fields (no setter method available)
@ PT_DEGREE
Angle expressed in degrees.
@ PT_COORD
Coordinate expressed in distance units (mm/inch)
@ PT_AREA
Area expressed in distance units-squared (mm/inch)
@ PT_SIZE
Size expressed in distance units (mm/inch)
#define REGISTER_TYPE(x)
Helper macro to map type hashes to names.
std::optional< std::unique_ptr< VALIDATION_ERROR > > VALIDATOR_RESULT
Null optional means validation succeeded.
wxString UnescapeString(const wxString &aSource)
void AccumulateDescription(wxString &aDesc, const wxString &aItem)
Utility to build comma separated lists in messages.
A storage class for 128-bit hash value.
Structure to hold the necessary information in order to index a vertex on a SHAPE_POLY_SET object: th...
std::optional< VECTOR2I > hatching_offset
TEARDROP_TYPE
define the type of a teardrop: on a via or pad, or a track end
wxString result
Test unit parsing edge cases and error handling.
@ PCB_ZONE_T
class ZONE, a copper pour area
VECTOR2< int32_t > VECTOR2I
static SHAPE_POLY_SET g_nullPoly
static struct ZONE_DESC _ZONE_DESC
THIEVING_PATTERN
Shape stamped onto the grid for a copper-thieving fill.
ISLAND_REMOVAL_MODE
Whether or not to remove isolated islands from a zone.
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.
#define ZONE_CLEARANCE_MAX_VALUE_MM
ZONE_CONNECTION
How pads are covered by copper in zone.
@ THERMAL
Use thermal relief for pads.
@ THT_THERMAL
Thermal relief only for THT pads.
@ NONE
Pads are not covered.
@ FULL
pads are covered by copper
#define ZONE_BORDER_HATCH_DIST_MM
#define ZONE_BORDER_HATCH_MINDIST_MM
#define ZONE_THICKNESS_MIN_VALUE_MM
#define ZONE_BORDER_HATCH_MAXDIST_MM