39#include <math_for_graphics.h>
47#include <google/protobuf/any.pb.h>
51#include <api/board/board_types.pb.h>
59 m_isRuleArea( false ),
60 m_ruleAreaPlacementEnabled( false ),
65 m_ZoneMinThickness( 0 ),
68 m_thermalReliefGap( 0 ),
69 m_thermalReliefSpokeWidth( 0 ),
71 m_hatchThickness( 0 ),
74 m_hatchSmoothingLevel( 0 ),
75 m_hatchHoleMinArea( 0 ),
76 m_CornerSelection( nullptr ),
99 m_CornerSelection( nullptr )
121 board->IncrementTimeStamp();
209 return new ZONE( *
this );
219 PackLayerSet( *zone.mutable_layers(),
GetLayerSet() );
222 zone.set_type( types::ZT_RULE_AREA );
224 zone.set_type( types::ZT_TEARDROP );
226 zone.set_type( types::ZT_COPPER );
228 zone.set_type( types::ZT_GRAPHICAL );
238 types::RuleAreaSettings* ra = zone.mutable_rule_area_settings();
247 ra->set_placement_source_type(
248 ToProtoEnum<RULE_AREA_PLACEMENT_SOURCE_TYPE, types::PlacementRuleSourceType>(
253 types::CopperZoneSettings* cu = zone.mutable_copper_settings();
254 cu->mutable_connection()->set_zone_connection(
255 ToProtoEnum<ZONE_CONNECTION, types::ZoneConnectionStyle>(
m_PadConnection ) );
257 types::ThermalSpokeSettings* thermals = cu->mutable_connection()->mutable_thermal_spokes();
267 cu->set_fill_mode( ToProtoEnum<ZONE_FILL_MODE, types::ZoneFillMode>(
m_fillMode ) );
269 types::HatchFillSettings* hatch = cu->mutable_hatch_settings();
271 hatch->mutable_gap()->set_value_nm(
m_hatchGap );
279 case 0: hatch->set_border_mode( types::ZHFBM_USE_MIN_ZONE_THICKNESS );
break;
280 case 1: hatch->set_border_mode( types::ZHFBM_USE_HATCH_THICKNESS );
break;
283 cu->mutable_net()->mutable_code()->set_value(
GetNetCode() );
285 cu->mutable_teardrop()->set_type(
286 ToProtoEnum<TEARDROP_TYPE, types::TeardropType>(
m_teardropType ) );
291 types::ZoneFilledPolygons* filledLayer = zone.add_filled_polygons();
292 filledLayer->set_layer( ToProtoEnum<PCB_LAYER_ID, types::BoardLayer>( layer ) );
296 zone.mutable_border()->set_style(
297 ToProtoEnum<ZONE_BORDER_DISPLAY_STYLE, types::ZoneBorderStyle>(
m_borderStyle ) );
300 aContainer.PackFrom( zone );
309 if( !aContainer.UnpackTo( &zone ) )
317 if( zone.type() == types::ZoneType::ZT_RULE_AREA )
327 const types::RuleAreaSettings& ra = zone.rule_area_settings();
337 FromProtoEnum<RULE_AREA_PLACEMENT_SOURCE_TYPE>( ra.placement_source_type() );
341 const types::CopperZoneSettings& cu = zone.copper_settings();
342 m_PadConnection = FromProtoEnum<ZONE_CONNECTION>( cu.connection().zone_connection() );
349 m_fillMode = FromProtoEnum<ZONE_FILL_MODE>( cu.fill_mode() );
352 m_hatchGap = cu.hatch_settings().gap().value_nm();
358 switch( cu.hatch_settings().border_mode() )
366 m_teardropType = FromProtoEnum<TEARDROP_TYPE>( cu.teardrop().type() );
369 m_borderStyle = FromProtoEnum<ZONE_BORDER_DISPLAY_STYLE>( zone.border().style() );
378 for(
const types::ZoneFilledPolygons& fillLayer : zone.filled_polygons() )
380 PCB_LAYER_ID layer = FromProtoEnum<PCB_LAYER_ID>( fillLayer.layer() );
419 change |= !pair.second->IsEmpty();
421 pair.second->RemoveAllContours();
464 if( uiLayers.size() )
489 if( aLayerSet.count() == 0 )
517 std::vector<int> layers;
523 layers.push_back( layer );
536 constexpr double HIDE = std::numeric_limits<double>::max();
546 bool flipped = parentFP->GetLayer() ==
B_Cu;
571 std::unordered_map<const ZONE*, BOX2I>& cache = board->m_ZoneBBoxCache;
574 std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
576 auto cacheIter = cache.find(
this );
578 if( cacheIter != cache.end() )
579 return cacheIter->second;
585 std::unique_lock<std::shared_mutex> writeLock( board->m_CachesMutex );
586 cache[ this ] = bbox;
609 *aSource =
_(
"zone" );
695 for(
int ii = 0; ii < count; ii++ )
766 msg << wxT(
" " ) <<
_(
"Cutout" );
768 aList.emplace_back(
_(
"Type" ), msg );
790 aList.emplace_back(
_(
"Restrictions" ), msg );
794 aList.emplace_back(
_(
"Placement source" ),
804 aList.emplace_back(
_(
"Resolved Netclass" ),
809 aList.emplace_back(
_(
"Priority" ),
816 aList.emplace_back(
_(
"Status" ),
_(
"Locked" ) );
822 if( layers.size() == 1 )
826 else if (layers.size() == 2 )
828 layerDesc.Printf(
_(
"%s and %s" ),
832 else if (layers.size() == 3 )
834 layerDesc.Printf(
_(
"%s, %s and %s" ),
839 else if( layers.size() > 3 )
841 layerDesc.Printf(
_(
"%s, %s and %d more" ),
844 static_cast<int>( layers.size() - 2 ) );
847 aList.emplace_back(
_(
"Layer" ), layerDesc );
854 case ZONE_FILL_MODE::POLYGONS: msg =
_(
"Solid" );
break;
855 case ZONE_FILL_MODE::HATCH_PATTERN: msg =
_(
"Hatched" );
break;
856 default: msg =
_(
"Unknown" );
break;
859 aList.emplace_back(
_(
"Fill Mode" ), msg );
861 aList.emplace_back(
_(
"Filled Area" ),
867 if( !source.IsEmpty() )
869 aList.emplace_back( wxString::Format(
_(
"Min Clearance: %s" ),
871 wxString::Format(
_(
"(from %s)" ),
880 count += ii.second->TotalVertices();
882 aList.emplace_back(
_(
"Corner Count" ), wxString::Format( wxT(
"%d" ), count ) );
896 pair.second->Move( offset );
908 if( it !=
GetBoard()->m_ZoneBBoxCache.end() )
909 it->second.Move( offset );
917 return _(
"Rule Area" );
919 return _(
"Teardrop Area" );
921 return _(
"Copper Zone" );
923 return _(
"Non-copper Zone" );
949 pair.second->Rotate( aAngle, aCentre );
955 Mirror( aCentre, aFlipDirection );
957 std::map<PCB_LAYER_ID, SHAPE_POLY_SET> fillsCopy;
961 fillsCopy[oldLayer] = *shapePtr;
966 for(
auto& [oldLayer, shape] : fillsCopy )
981 pair.second->Mirror( aMirrorRef, aFlipDirection );
1016 if( aPolygon.empty() )
1022 for(
const VECTOR2I& pt : aPolygon )
1043 m_Poly->
Append( aPosition.
x, aPosition.
y, -1, aHoleIdx, aAllowDuplication );
1056 if( layers.size() == 1 )
1060 else if (layers.size() == 2 )
1062 layerDesc.Printf(
_(
"on %s and %s" ),
1066 else if (layers.size() == 3 )
1068 layerDesc.Printf(
_(
"on %s, %s and %s" ),
1073 else if( layers.size() > 3 )
1075 layerDesc.Printf(
_(
"on %s, %s and %zu more" ),
1078 layers.size() - 2 );
1085 return wxString::Format(
_(
"Rule Area Cutout %s" ), layerDesc );
1087 return wxString::Format(
_(
"Zone Cutout %s" ), layerDesc );
1092 return wxString::Format(
_(
"Rule Area %s" ), layerDesc );
1094 return wxString::Format(
_(
"Zone %s %s" ),
GetNetnameMsg(), layerDesc );
1106 int aBorderHatchPitch,
bool aRebuildBorderHatch )
1108 aBorderHatchPitch = std::max( aBorderHatchPitch,
1110 aBorderHatchPitch = std::min( aBorderHatchPitch,
1115 if( aRebuildBorderHatch )
1136 return tst.
x < ref.
x;
1159 if( iterator->x < min_x )
1160 min_x = iterator->x;
1162 if( iterator->x > max_x )
1163 max_x = iterator->x;
1165 if( iterator->y < min_y )
1166 min_y = iterator->y;
1168 if( iterator->y > max_y )
1169 max_y = iterator->y;
1175 if(
m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE )
1185 std::vector<int> slope_flags;
1188 slope_flags = { 1, -1 };
1189 else if( layer & 1 )
1190 slope_flags = { 1 };
1192 slope_flags = { -1 };
1194 for(
int slope_flag : slope_flags )
1196 double slope = 0.707106 * slope_flag;
1197 int64_t max_a, min_a;
1199 if( slope_flag == 1 )
1201 max_a = KiROUND<double, int64_t>( max_y - slope * min_x );
1202 min_a = KiROUND<double, int64_t>( min_y - slope * max_x );
1206 max_a = KiROUND<double, int64_t>( max_y - slope * max_x );
1207 min_a = KiROUND<double, int64_t>( min_y - slope * min_x );
1210 min_a = (min_a / spacing) * spacing;
1214 int offset = (layer * 7) / 8;
1218 std::vector<VECTOR2I> pointbuffer;
1219 pointbuffer.reserve( 256 );
1221 for( int64_t a = min_a; a < max_a; a += spacing )
1223 pointbuffer.clear();
1228 const SEG seg = *iterator;
1231 if( FindLineSegmentIntersection( a, slope, seg.
A.
x, seg.
A.
y, seg.
B.
x, seg.
B.
y, x, y ) )
1238 if( pointbuffer.size() > 2 )
1242 for(
size_t ip = 0; ip + 1 < pointbuffer.size(); ip += 2 )
1244 int dx = pointbuffer[ip + 1].x - pointbuffer[ip].x;
1249 if(
m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL
1250 ||
std::abs( dx ) < 2 * hatch_line_len )
1256 double dy = pointbuffer[ip + 1].y - pointbuffer[ip].y;
1260 dx = hatch_line_len;
1262 dx = -hatch_line_len;
1264 int x1 =
KiROUND( pointbuffer[ip].x + dx );
1265 int x2 =
KiROUND( pointbuffer[ip + 1].x - dx );
1266 int y1 =
KiROUND( pointbuffer[ip].y + dx * slope );
1267 int y2 =
KiROUND( pointbuffer[ip + 1].y - dx * slope );
1289 return BITMAPS::add_zone;
1297 std::swap( *
static_cast<ZONE*
>(
this ), *
static_cast<ZONE*
>( aImage) );
1306 poly->CacheTriangulation();
1331 std::vector<ZONE*>* aOtherNetIntersectingZones )
const
1340 if( candidate ==
this )
1343 if( !candidate->GetLayerSet().test( aLayer ) )
1346 if( candidate->GetIsRuleArea() || candidate->IsTeardropArea() )
1349 if( !candidate->GetBoundingBox().Intersects( bbox ) )
1352 if( candidate->GetNetCode() ==
GetNetCode() )
1355 aSameNetCollidingZones->push_back( candidate );
1359 aOtherNetIntersectingZones->push_back( candidate );
1380 aSmoothedPoly = flattened;
1386 bool keepExternalFillets =
false;
1393 smooth_requested =
false;
1407 if( !smooth_requested )
1428 aSmoothedPoly = flattened;
1433 if( keepExternalFillets && smooth_requested )
1435 withFillets = flattened;
1436 smooth( withFillets );
1438 maxExtents = &withFillets;
1446 std::vector<ZONE*> sameNetCollidingZones;
1447 std::vector<ZONE*> diffNetIntersectingZones;
1450 for(
ZONE* sameNetZone : sameNetCollidingZones )
1452 BOX2I sameNetBoundingBox = sameNetZone->GetBoundingBox();
1464 for(
ZONE* diffNetZone : diffNetIntersectingZones )
1466 if( diffNetZone->HigherPriority( sameNetZone )
1467 && diffNetZone->GetBoundingBox().Intersects( sameNetBoundingBox ) )
1476 bool isolated =
false;
1498 smooth( aSmoothedPoly );
1500 if( aSmoothedPolyWithApron )
1510 if( !keepExternalFillets )
1513 *aSmoothedPolyWithApron = aSmoothedPoly;
1531 std::shared_ptr<SHAPE_POLY_SET>& poly = pair.second;
1533 for(
int i = 0; i < poly->OutlineCount(); i++ )
1535 m_area += poly->Outline( i ).Area();
1537 for(
int j = 0; j < poly->HoleCount( i ); j++ )
1538 m_area -= poly->Hole( i, j ).Area();
1574 aClearance += maxError;
1576 polybuffer.
Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, maxError );
1580 aBuffer.
Append( polybuffer );
1587 return std::make_shared<SHAPE_NULL>();
1594 int aError,
ERROR_LOC aErrorLoc,
bool aIgnoreLineWidth )
const
1596 wxASSERT_MSG( !aIgnoreLineWidth, wxT(
"IgnoreLineWidth has no meaning for zones." ) );
1613 aClearance += aError;
1619 aBuffer.
Append( temp_buf );
1635 const ZONE& other =
static_cast<const ZONE&
>( aOther );
1636 return *
this == other;
1646 const ZONE& other =
static_cast<const ZONE&
>( aOther );
1713 const ZONE& other =
static_cast<const ZONE&
>( aOther );
1718 double similarity = 1.0;
1757 std::vector<VECTOR2I> corners;
1758 std::vector<VECTOR2I> otherCorners;
1788 if( layerEnum.
Choices().GetCount() == 0 )
1798 if( zcMap.
Choices().GetCount() == 0 )
1800 zcMap.
Undefined( ZONE_CONNECTION::INHERITED );
1801 zcMap.
Map( ZONE_CONNECTION::INHERITED,
_HKI(
"Inherited" ) )
1802 .
Map( ZONE_CONNECTION::NONE,
_HKI(
"None" ) )
1803 .
Map( ZONE_CONNECTION::THERMAL,
_HKI(
"Thermal reliefs" ) )
1804 .
Map( ZONE_CONNECTION::FULL,
_HKI(
"Solid" ) )
1805 .
Map( ZONE_CONNECTION::THT_THERMAL,
_HKI(
"Thermal reliefs for PTH" ) );
1810 if( zfmMap.
Choices().GetCount() == 0 )
1812 zfmMap.
Undefined( ZONE_FILL_MODE::POLYGONS );
1813 zfmMap.
Map( ZONE_FILL_MODE::POLYGONS,
_HKI(
"Solid fill" ) )
1814 .
Map( ZONE_FILL_MODE::HATCH_PATTERN,
_HKI(
"Hatch pattern" ) );
1819 if( irmMap.
Choices().GetCount() == 0 )
1821 irmMap.
Undefined( ISLAND_REMOVAL_MODE::ALWAYS );
1822 irmMap.
Map( ISLAND_REMOVAL_MODE::ALWAYS,
_HKI(
"Always" ) )
1823 .
Map( ISLAND_REMOVAL_MODE::NEVER,
_HKI(
"Never" ) )
1824 .
Map( ISLAND_REMOVAL_MODE::AREA,
_HKI(
"Below area limit" ) );
1830 if( rapstMap.
Choices().GetCount() == 0 )
1832 rapstMap.
Undefined( RULE_AREA_PLACEMENT_SOURCE_TYPE::SHEETNAME );
1833 rapstMap.
Map( RULE_AREA_PLACEMENT_SOURCE_TYPE::SHEETNAME,
_HKI(
"Sheet Name" ) )
1834 .
Map( RULE_AREA_PLACEMENT_SOURCE_TYPE::COMPONENT_CLASS,
1835 _HKI(
"Component Class" ) );
1845 PROPERTY_DISPLAY::PT_COORD,
1847 posX->SetIsHiddenFromPropertiesManager();
1851 PROPERTY_DISPLAY::PT_COORD,
1853 posY->SetIsHiddenFromPropertiesManager();
1861 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
1862 return !zone->GetIsRuleArea() &&
IsCopperLayer( zone->GetFirstLayer() );
1870 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
1871 return zone->GetIsRuleArea();
1876 auto isHatchedFill =
1879 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
1880 return zone->GetFillMode() == ZONE_FILL_MODE::HATCH_PATTERN;
1885 auto isAreaBasedIslandRemoval =
1888 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
1889 return zone->GetIslandRemovalMode() == ISLAND_REMOVAL_MODE::AREA;
1900 .SetIsHiddenFromPropertiesManager();
1903 _HKI(
"Net" ), isCopperZone );
1905 _HKI(
"Net Class" ), isCopperZone );
1909 .SetAvailableFunc( isCopperZone );
1914 const wxString groupKeepout =
_HKI(
"Keepout" );
1947 const wxString groupPlacement =
_HKI(
"Placement" );
1968 const wxString groupFill =
_HKI(
"Fill Style" );
1977 PROPERTY_DISPLAY::PT_DEGREE ),
1983 auto atLeastMinWidthValidator =
1986 int val = aValue.As<
int>();
1987 ZONE* zone =
dynamic_cast<ZONE*
>( aZone );
1988 wxCHECK( zone, std::nullopt );
1990 if( val < zone->GetMinThickness() )
1992 return std::make_unique<VALIDATION_ERROR_MSG>(
1993 _(
"Cannot be less than zone minimum width" ) );
1996 return std::nullopt;
2044 const wxString groupElectrical =
_HKI(
"Electrical" );
2048 PROPERTY_DISPLAY::PT_SIZE );
2051 clearanceOverride->SetValidator( PROPERTY_VALIDATORS::RangeIntValidator<0, maxClearance> );
2055 PROPERTY_DISPLAY::PT_SIZE );
2056 minWidth->SetAvailableFunc( isCopperZone );
2063 padConnections->SetAvailableFunc( isCopperZone );
2067 PROPERTY_DISPLAY::PT_SIZE );
2068 thermalGap->SetAvailableFunc( isCopperZone );
2073 PROPERTY_DISPLAY::PT_SIZE );
2074 thermalSpokeWidth->SetAvailableFunc( isCopperZone );
2075 thermalSpokeWidth->SetValidator( atLeastMinWidthValidator );
2077 propMgr.
AddProperty( clearanceOverride, groupElectrical );
2079 propMgr.
AddProperty( padConnections, groupElectrical );
2080 propMgr.
AddProperty( thermalGap, groupElectrical );
2081 propMgr.
AddProperty( thermalSpokeWidth, groupElectrical );
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
constexpr int ARC_HIGH_DEF
constexpr EDA_IU_SCALE pcbIUScale
BITMAPS
A list of all bitmap identifiers.
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
BASE_SET & reset(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.
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
wxString GetNetname() const
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.
TEARDROP_PARAMETERS & GetTeardropParams()
Container for design settings for a BOARD object.
ZONE_SETTINGS & GetDefaultZoneSettings()
bool m_ZoneKeepExternalFillets
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...
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
virtual bool IsLocked() const
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Information pertinent to a Pcbnew printed circuit board.
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayer) const
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.
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
KICAD_T Type() const
Returns the type of object.
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
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.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
std::string AsStdString() const
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
LSET is a set of PCB_LAYER_IDs.
LSEQ UIOrder() const
Returns the copper, technical and user layers in the order shown in layer widget.
static LSET AllLayersMask()
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=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
int GetLocalThermalGapOverride(wxString *aSource=nullptr) 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)
Provide class metadata.Helper macro to map type hashes to names.
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)
bool PointInside(const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const override
Check if point aP lies inside a closed shape.
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.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
Represent a set of closed polygons.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
bool CollideEdge(const VECTOR2I &aPoint, VERTEX_INDEX *aClosestVertex=nullptr, int aClearance=0) const
Check whether aPoint collides with any edge of any of the contours of the polygon.
void BooleanSubtract(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset difference For aFastMode meaning, see function booleanOp.
void InflateWithLinkedHoles(int aFactor, CORNER_STRATEGY aCornerStrategy, int aMaxError, POLYGON_MODE aFastMode)
Perform outline inflation/deflation, using round corners.
ITERATOR IterateWithHoles(int aOutline)
void Fracture(POLYGON_MODE aFastMode)
Convert a set of polygons with holes to a single outline with "slits"/"fractures" connecting the oute...
void ClearArcs()
Removes all arc references from all the outlines and holes in the polyset.
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new outline to the set and returns its index.
virtual void CacheTriangulation(bool aPartition=true, bool aSimplify=false)
Build a polygon triangulation, needed to draw a polygon on OpenGL and in some other calculations.
double Area()
Return the area of this poly set.
void SetVertex(const VERTEX_INDEX &aIndex, const VECTOR2I &aPos)
Accessor function to set the position of a specific point.
bool IsEmpty() const
Return true if the set is empty (no polygons at all)
void BooleanAdd(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset union For aFastMode meaning, see function booleanOp.
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.
void BooleanIntersection(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset intersection For aFastMode meaning, see function booleanOp.
void Inflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify=false)
Perform outline inflation/deflation.
int HoleCount(int aOutline) const
Returns the number of holes in a given outline.
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)
int AddHole(const SHAPE_LINE_CHAIN &aHole, int aOutline=-1)
Adds a new hole to the given outline (default: last) and returns its index.
bool GetNeighbourIndexes(int aGlobalIndex, int *aPrevious, int *aNext) const
Return the global indexes of the previous and the next corner of the aGlobalIndex-th corner of a cont...
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
SHAPE_LINE_CHAIN & Hole(int aOutline, int aHole)
Return the reference to aHole-th hole in the aIndex-th outline.
int NewOutline()
Creates a new empty polygon in the set and returns its index.
bool CollideVertex(const VECTOR2I &aPoint, VERTEX_INDEX *aClosestVertex=nullptr, int aClearance=0) const
Check whether aPoint collides with any vertex of any of the contours of the polygon.
void Mirror(const VECTOR2I &aRef, FLIP_DIRECTION aFlipDirection)
Mirror the line points about y or x (or both)
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 Move(const VECTOR2I &aVector) override
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1, int aAccuracy=0, bool aUseBBoxCaches=false) const
Return true if a given subpolygon contains the point aP.
SHAPE_POLY_SET CloneDropTriangulation() const
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().
ZONE_SETTINGS handles zones parameters.
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
Handle a list of polygons defining a copper zone.
void SetHatchThickness(int aThickness)
SHAPE_POLY_SET::VERTEX_INDEX * m_CornerSelection
The index of the corner being moved or nullptr if no corner is selected.
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.
void SetDoNotAllowPads(bool aEnable)
ZONE & operator=(const ZONE &aOther)
int m_cornerSmoothingType
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
std::optional< int > GetLocalClearance() const override
void SetRuleAreaPlacementEnabled(bool aEnabled)
void SetLocalClearance(std::optional< int > aClearance)
bool UnFill()
Removes the zone filling.
wxString GetRuleAreaPlacementSource() const
bool GetDoNotAllowVias() const
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
How to fill areas:
bool m_doNotAllowFootprints
void AddPolygon(std::vector< VECTOR2I > &aPolygon)
Add a polygon to the zone outline.
double m_hatchSmoothingValue
void SetLocalFlags(int aFlags)
void TransformSmoothedOutlineToPolygon(SHAPE_POLY_SET &aBuffer, 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,...
int m_thermalReliefSpokeWidth
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.
EDA_ANGLE m_hatchOrientation
void CacheTriangulation(PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
Create a list of triangles that "fill" the solid areas used for instance to draw these solid areas on...
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
void SetBorderDisplayStyle(ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle, int aBorderHatchPitch, bool aRebuilBorderdHatch)
Set all hatch parameters for the zone.
bool GetDoNotAllowPads() const
const BOX2I GetBoundingBox() const override
void SetMinThickness(int aMinThickness)
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)
bool m_doNotAllowCopperPour
bool GetRuleAreaPlacementEnabled() const
void SetHatchSmoothingValue(double aValue)
bool m_needRefill
False when a zone was refilled, true after changes in zone params.
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)
RULE_AREA_PLACEMENT_SOURCE_TYPE m_ruleAreaPlacementSourceType
void SetDoNotAllowCopperPour(bool aEnable)
void SetThermalReliefSpokeWidth(int aThermalReliefSpokeWidth)
virtual PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
LSET m_fillFlags
Temp variables used while filling.
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.
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.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
TEARDROP_TYPE m_teardropType
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
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void SetRuleAreaPlacementSourceType(RULE_AREA_PLACEMENT_SOURCE_TYPE aType)
void SetIsRuleArea(bool aEnable)
void SetDoNotAllowTracks(bool aEnable)
void SetFilledPolysList(PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPolysList)
Set the list of filled polygons.
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.
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.
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)
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
void InitDataFromSrcInCopyCtor(const ZONE &aZone)
Copy aZone data to me.
int GetHatchThickness() const
double GetHatchHoleMinArea() 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
void SetDoNotAllowVias(bool aEnable)
bool IsTeardropArea() const
std::vector< SEG > m_borderHatchLines
wxString m_ruleAreaPlacementSource
VECTOR2I GetPosition() const override
int GetThermalReliefSpokeWidth() const
int GetBorderHatchPitch() const
HatchBorder related methods.
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
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
bool GetDoNotAllowFootprints() const
ZONE_FILL_MODE GetFillMode() const
double m_hatchHoleMinArea
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
void SetDoNotAllowFootprints(bool aEnable)
bool GetDoNotAllowCopperPour() const
void SetBorderHatchPitch(int aPitch)
Set the hatch pitch parameter for the zone.
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...
bool m_ruleAreaPlacementEnabled
Placement rule area data.
double CalculateOutlineArea()
Compute the area of the zone outline (not the filled area).
RULE_AREA_PLACEMENT_SOURCE_TYPE GetRuleAreaPlacementSourceType() const
void SetHatchHoleMinArea(double aPct)
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...
ISLAND_REMOVAL_MODE m_islandRemovalMode
bool m_isFilled
True when a zone was filled, false after deleting the filled areas.
double GetHatchSmoothingValue() const
bool AppendCorner(VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
void MoveEdge(const VECTOR2I &offset, int aEdge)
Move the outline Edge.
int GetHatchSmoothingLevel() const
unsigned int GetCornerRadius() const
int GetCornerSmoothingType() const
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
bool IsOnCopperLayer() const override
double CalculateFilledArea()
Compute the area currently occupied by the zone fill.
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)
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 SetRuleAreaPlacementSource(const wxString &aSource)
int GetThermalReliefGap() const
void SetHatchGap(int aStep)
static int GetDefaultHatchPitch()
unsigned GetAssignedPriority() const
int GetNumCorners(void) const
Access to m_Poly parameters.
bool SameNet(const ZONE *aOther) const
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
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.
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)
Tests whether a layer is a copper layer.
@ LAYER_CONFLICTS_SHADOW
shadow layer for items flagged conficting
@ 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.
KICOMMON_API SHAPE_POLY_SET UnpackPolySet(const types::PolySet &aInput)
KICOMMON_API void PackPolySet(types::PolySet &aOutput, const SHAPE_POLY_SET &aInput)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
#define IMPLEMENT_ENUM_TO_WXANY(type)
#define NO_SETTER(owner, type)
std::optional< std::unique_ptr< VALIDATION_ERROR > > VALIDATOR_RESULT
Null optional means validation succeeded.
@ NONE
No connection to this item.
wxString UnescapeString(const wxString &aSource)
void AccumulateDescription(wxString &aDesc, const wxString &aItem)
Utility to build comma separated lists in messages.
constexpr int mmToIU(double mm) const
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...
TEARDROP_TYPE
define the type of a teardrop: on a via or pad, or a track end
@ PCB_ZONE_T
class ZONE, a copper pour area
VECTOR2< int32_t > VECTOR2I
static SHAPE_POLY_SET g_nullPoly
bool sortEndsByDescendingX(const VECTOR2I &ref, const VECTOR2I &tst)
static struct ZONE_DESC _ZONE_DESC
RULE_AREA_PLACEMENT_SOURCE_TYPE
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.
#define ZONE_BORDER_HATCH_DIST_MM
#define ZONE_BORDER_HATCH_MINDIST_MM
#define ZONE_THICKNESS_MIN_VALUE_MM
#define ZONE_BORDER_HATCH_MAXDIST_MM