KiCad PCB EDA Suite
Loading...
Searching...
No Matches
zone.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef ZONE_H
26#define ZONE_H
27
28
29#include <mutex>
30#include <vector>
31#include <gr_basic.h>
32#include <board_item.h>
34#include <layer_ids.h>
35#include <lset.h>
37#include <zone_settings.h>
39
40
41class LINE_READER;
42class PCB_EDIT_FRAME;
43class BOARD;
44class ZONE;
45class MSG_PANEL_ITEM;
46
47
60{
61 std::vector<int> m_IsolatedOutlines;
63};
64
65
73{
74public:
75 ZONE( BOARD_ITEM_CONTAINER* parent );
76
77 ZONE( const ZONE& aZone );
78 ZONE& operator=( const ZONE &aOther );
79
80 ~ZONE();
81
82 static inline bool ClassOf( const EDA_ITEM* aItem )
83 {
84 return aItem && aItem->Type() == PCB_ZONE_T;
85 }
86
87 void Serialize( google::protobuf::Any &aContainer ) const override;
88 bool Deserialize( const google::protobuf::Any &aContainer ) override;
89
93 bool IsConnected() const override
94 {
95 return !GetIsRuleArea();
96 }
97
101 void InitDataFromSrcInCopyCtor( const ZONE& aZone );
102
107 bool IsConflicting() const;
108
112 VECTOR2I GetPosition() const override;
113 void SetPosition( const VECTOR2I& aPos ) override {}
114
118 void SetAssignedPriority( unsigned aPriority ) { m_priority = aPriority; }
119
123 unsigned GetAssignedPriority() const { return m_priority; }
124
125 bool HigherPriority( const ZONE* aOther ) const;
126
127 bool SameNet( const ZONE* aOther ) const;
128
129 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
130 wxString GetFriendlyName() const override;
131
132 void SetLayerSet( const LSET& aLayerSet ) override;
133 virtual LSET GetLayerSet() const override { return m_layerSet; }
134
135 const wxString& GetZoneName() const { return m_zoneName; }
136 void SetZoneName( const wxString& aName ) { m_zoneName = aName; }
137
138 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override
139 {
140 return BOARD_ITEM::Matches( GetZoneName(), aSearchData );
141 }
142
146 const BOX2I GetBoundingBox() const override;
147
152 void CacheBoundingBox();
153
157 std::optional<int> GetLocalClearance() const override;
158 void SetLocalClearance( std::optional<int> aClearance ) { m_ZoneClearance = aClearance.value(); }
159
166 std::optional<int> GetLocalClearance( wxString* aSource ) const override
167 {
168 if( m_isRuleArea )
169 return std::optional<int>();
170
171 if( aSource )
172 *aSource = _( "zone" );
173
174 return GetLocalClearance();
175 }
176
180 bool IsOnCopperLayer() const override;
181
182 virtual void SetLayer( PCB_LAYER_ID aLayer ) override;
183
184 virtual PCB_LAYER_ID GetLayer() const override;
185
186 // Return the first layer in GUI sequence.
188
189 virtual bool IsOnLayer( PCB_LAYER_ID ) const override;
190
191 virtual std::vector<int> ViewGetLayers() const override;
192
193 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
194
195 void SetFillMode( ZONE_FILL_MODE aFillMode ) { m_fillMode = aFillMode; }
197
198 void SetThermalReliefGap( int aThermalReliefGap )
199 {
200 if( m_thermalReliefGap != aThermalReliefGap )
201 SetNeedRefill( true );
202
203 m_thermalReliefGap = aThermalReliefGap;
204 }
205
207 int GetThermalReliefGap( PAD* aPad, wxString* aSource = nullptr ) const;
208
209 void SetThermalReliefSpokeWidth( int aThermalReliefSpokeWidth )
210 {
211 if( m_thermalReliefSpokeWidth != aThermalReliefSpokeWidth )
212 SetNeedRefill( true );
213
214 m_thermalReliefSpokeWidth = aThermalReliefSpokeWidth;
215 }
216
218
224 double CalculateFilledArea();
225
230 double CalculateOutlineArea();
231
238 {
239 return m_area;
240 }
241
248 {
249 return m_outlinearea;
250 }
251
252 std::mutex& GetLock()
253 {
254 return m_lock;
255 }
256
258 {
259 return m_fillFlags.test( aLayer );
260 }
261
262 void SetFillFlag( PCB_LAYER_ID aLayer, bool aFlag ) { m_fillFlags.set( aLayer, aFlag ); }
263
264 bool IsFilled() const { return m_isFilled; }
265 void SetIsFilled( bool isFilled ) { m_isFilled = isFilled; }
266
267 bool NeedRefill() const { return m_needRefill; }
268 void SetNeedRefill( bool aNeedRefill ) { m_needRefill = aNeedRefill; }
269
271 void SetPadConnection( ZONE_CONNECTION aPadConnection ) { m_PadConnection = aPadConnection; }
272
273 int GetMinThickness() const { return m_ZoneMinThickness; }
274 void SetMinThickness( int aMinThickness )
275 {
276 if( m_ZoneMinThickness != aMinThickness
277 || ( m_fillMode == ZONE_FILL_MODE::HATCH_PATTERN
278 && ( m_hatchThickness < aMinThickness || m_hatchGap < aMinThickness ) ) )
279 {
280 SetNeedRefill( true );
281 }
282
283 m_ZoneMinThickness = aMinThickness;
284 m_hatchThickness = std::max( m_hatchThickness, aMinThickness );
285 m_hatchGap = std::max( m_hatchGap, aMinThickness );
286 }
287
288 int GetHatchThickness() const { return m_hatchThickness; }
289 void SetHatchThickness( int aThickness ) { m_hatchThickness = aThickness; }
290
291 int GetHatchGap() const { return m_hatchGap; }
292 void SetHatchGap( int aStep ) { m_hatchGap = aStep; }
293
295 void SetHatchOrientation( const EDA_ANGLE& aStep ) { m_hatchOrientation = aStep; }
296
298 void SetHatchSmoothingLevel( int aLevel ) { m_hatchSmoothingLevel = aLevel; }
299
301 void SetHatchSmoothingValue( double aValue ) { m_hatchSmoothingValue = aValue; }
302
303 double GetHatchHoleMinArea() const { return m_hatchHoleMinArea; }
304 void SetHatchHoleMinArea( double aPct ) { m_hatchHoleMinArea = aPct; }
305
307 void SetHatchBorderAlgorithm( int aAlgo ) { m_hatchBorderAlgorithm = aAlgo; }
308
310 {
311 // Transform relative indices to global index
312 int globalIndex = -1;
313
315 m_Poly->GetGlobalIndex( *m_CornerSelection, globalIndex );
316
317 return globalIndex;
318 }
319
320 void SetSelectedCorner( int aCorner )
321 {
322 SHAPE_POLY_SET::VERTEX_INDEX selectedCorner;
323
324 // If the global index of the corner is correct, assign it to m_CornerSelection
325 if( m_Poly->GetRelativeIndices( aCorner, &selectedCorner ) )
326 {
327 if( m_CornerSelection == nullptr )
329
330 *m_CornerSelection = selectedCorner;
331 }
332 else
333 throw( std::out_of_range( "aCorner-th vertex does not exist" ) );
334 }
335
337 int GetLocalFlags() const { return m_localFlgs; }
338 void SetLocalFlags( int aFlags ) { m_localFlgs = aFlags; }
339
341 const SHAPE_POLY_SET* Outline() const { return m_Poly; }
342
343 void SetOutline( SHAPE_POLY_SET* aOutline ) { m_Poly = aOutline; }
344
345 // @copydoc BOARD_ITEM::GetEffectiveShape
346 virtual std::shared_ptr<SHAPE>
348 FLASHING aFlash = FLASHING::DEFAULT ) const override;
349
356 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
357
366 bool HitTestFilledArea( PCB_LAYER_ID aLayer, const VECTOR2I& aRefPos, int aAccuracy = 0 ) const;
367
376 bool HitTestCutout( const VECTOR2I& aRefPos, int* aOutlineIdx = nullptr,
377 int* aHoleIdx = nullptr ) const;
378
384 void GetInteractingZones( PCB_LAYER_ID aLayer, std::vector<ZONE*>* aSameNetCollidingZones,
385 std::vector<ZONE*>* aOtherNetIntersectingZones ) const;
386
398
410 void TransformSmoothedOutlineToPolygon( SHAPE_POLY_SET& aBuffer, int aClearance,
411 int aError, ERROR_LOC aErrorLoc,
412 SHAPE_POLY_SET* aBoardOutline ) const;
413
427 int aClearance, int aError, ERROR_LOC aErrorLoc,
428 bool ignoreLineWidth = false ) const override;
429
440 bool HitTestForCorner( const VECTOR2I& refPos, int aAccuracy,
441 SHAPE_POLY_SET::VERTEX_INDEX* aCornerHit = nullptr ) const;
442
452 bool HitTestForEdge( const VECTOR2I& refPos, int aAccuracy,
453 SHAPE_POLY_SET::VERTEX_INDEX* aCornerHit = nullptr ) const;
454
458 bool HitTest( const BOX2I& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
459
465 bool UnFill();
466
467 /* Geometric transformations: */
468
474 void Move( const VECTOR2I& offset ) override;
475
482 void MoveEdge( const VECTOR2I& offset, int aEdge );
483
489 void Rotate( const VECTOR2I& aCentre, const EDA_ANGLE& aAngle ) override;
490
498 virtual void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
499
506 void Mirror( const VECTOR2I& aMirrorRef, FLIP_DIRECTION aFlipDirection ) override;
507
511 wxString GetClass() const override
512 {
513 return wxT( "ZONE" );
514 }
515
519 int GetNumCorners( void ) const
520 {
521 return m_Poly->TotalVertices();
522 }
523
530 {
531 return m_Poly->Iterate();
532 }
533
540 {
541 return m_Poly->IterateWithHoles();
542 }
543
550 {
551 return m_Poly->CIterateWithHoles();
552 }
553
554 void RemoveAllContours( void )
555 {
557 }
558
559 const VECTOR2I& GetCornerPosition( int aCornerIndex ) const
560 {
562
563 // Convert global to relative indices
564 if( !m_Poly->GetRelativeIndices( aCornerIndex, &index ) )
565 throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
566
567 return m_Poly->CVertex( index );
568 }
569
570 void SetCornerPosition( int aCornerIndex, const VECTOR2I& new_pos )
571 {
572 SHAPE_POLY_SET::VERTEX_INDEX relativeIndices;
573
574 // Convert global to relative indices
575 if( m_Poly->GetRelativeIndices( aCornerIndex, &relativeIndices ) )
576 {
577 if( m_Poly->CVertex( relativeIndices ).x != new_pos.x
578 || m_Poly->CVertex( relativeIndices ).y != new_pos.y )
579 {
580 SetNeedRefill( true );
581 m_Poly->SetVertex( relativeIndices, new_pos );
582 }
583 }
584 else
585 {
586 throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
587 }
588 }
589
593 void NewHole()
594 {
595 m_Poly->NewHole();
596 }
597
607 bool AppendCorner( VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication = false );
608
611
613 {
614 return m_FilledPolysList.count( aLayer ) > 0;
615 }
616
620 const std::shared_ptr<SHAPE_POLY_SET>& GetFilledPolysList( PCB_LAYER_ID aLayer ) const
621 {
622 wxASSERT( m_FilledPolysList.count( aLayer ) );
623 return m_FilledPolysList.at( aLayer );
624 }
625
627 {
628 wxASSERT( m_FilledPolysList.count( aLayer ) );
629 return m_FilledPolysList.at( aLayer ).get();
630 }
631
637
641 void SetFilledPolysList( PCB_LAYER_ID aLayer, const SHAPE_POLY_SET& aPolysList )
642 {
643 m_FilledPolysList[aLayer] = std::make_shared<SHAPE_POLY_SET>( aPolysList );
644 }
645
653 bool IsIsland( PCB_LAYER_ID aLayer, int aPolyIdx ) const;
654
655 void SetIsIsland( PCB_LAYER_ID aLayer, int aPolyIdx )
656 {
657 m_insulatedIslands[aLayer].insert( aPolyIdx );
658 }
659
660 bool BuildSmoothedPoly( SHAPE_POLY_SET& aSmoothedPoly, PCB_LAYER_ID aLayer,
661 SHAPE_POLY_SET* aBoardOutline,
662 SHAPE_POLY_SET* aSmoothedPolyWithApron = nullptr ) const;
663
664 void SetCornerSmoothingType( int aType ) { m_cornerSmoothingType = aType; };
665
667
668 void SetCornerRadius( unsigned int aRadius );
669
670 unsigned int GetCornerRadius() const { return m_cornerRadius; }
671
678 void RemoveCutout( int aOutlineIdx, int aHoleIdx );
679
686 void AddPolygon( std::vector<VECTOR2I>& aPolygon );
687
688 void AddPolygon( const SHAPE_LINE_CHAIN& aPolygon );
689
690 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
691
692 BITMAPS GetMenuImage() const override;
693
694 EDA_ITEM* Clone() const override;
695
699 bool IsTeardropArea() const { return m_teardropType != TEARDROP_TYPE::TD_NONE; }
700
706
711
716 {
719 }
720
724 bool GetIsRuleArea() const { return m_isRuleArea; }
727 {
729 }
732 bool GetDoNotAllowVias() const { return m_doNotAllowVias; }
734 bool GetDoNotAllowPads() const { return m_doNotAllowPads; }
736
737 void SetIsRuleArea( bool aEnable ) { m_isRuleArea = aEnable; }
738 void SetRuleAreaPlacementEnabled( bool aEnabled ) { m_ruleAreaPlacementEnabled = aEnabled; }
740 {
742 }
743 void SetRuleAreaPlacementSource( const wxString& aSource )
744 {
746 }
747 void SetDoNotAllowCopperPour( bool aEnable ) { m_doNotAllowCopperPour = aEnable; }
748 void SetDoNotAllowVias( bool aEnable ) { m_doNotAllowVias = aEnable; }
749 void SetDoNotAllowTracks( bool aEnable ) { m_doNotAllowTracks = aEnable; }
750 void SetDoNotAllowPads( bool aEnable ) { m_doNotAllowPads = aEnable; }
751 void SetDoNotAllowFootprints( bool aEnable ) { m_doNotAllowFootprints = aEnable; }
752
755
756 long long int GetMinIslandArea() const { return m_minIslandArea; }
757 void SetMinIslandArea( long long int aArea ) { m_minIslandArea = aArea; }
758
766 int GetBorderHatchPitch() const;
767
771 static int GetDefaultHatchPitch();
772
782 void SetBorderDisplayStyle( ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle, int aBorderHatchPitch,
783 bool aRebuilBorderdHatch );
784
790 void SetBorderHatchPitch( int aPitch );
791
795 void UnHatchBorder();
796
801 void HatchBorder();
802
803 const std::vector<SEG>& GetHatchLines() const { return m_borderHatchLines; }
804
809 void BuildHashValue( PCB_LAYER_ID aLayer );
810
815
816 double Similarity( const BOARD_ITEM& aOther ) const override;
817
818 bool operator==( const ZONE& aOther ) const;
819 bool operator==( const BOARD_ITEM& aOther ) const override;
820
821#if defined(DEBUG)
822 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
823
824 void SetFillPoly( PCB_LAYER_ID aLayer, SHAPE_POLY_SET* aPoly )
825 {
826 m_FilledPolysList[ aLayer ] = std::make_shared<SHAPE_POLY_SET>( *aPoly );
827 SetFillFlag( aLayer, true );
828 }
829
830#endif
831
832protected:
833 virtual void swapData( BOARD_ITEM* aImage ) override;
834
835protected:
838 unsigned int m_cornerRadius;
839
841 wxString m_zoneName;
842
844
845 /* Priority: when a zone outline is inside and other zone, if its priority is higher
846 * the other zone priority, it will be created inside.
847 * if priorities are equal, a DRC error is set
848 */
849 unsigned m_priority;
850
851 /* A zone outline can be a keepout zone.
852 * It will be never filled, and DRC should test for pads, tracks and vias
853 */
855
862
863 /* A zone outline can be a teardrop zone with different rules for priority
864 * (always bigger priority than copper zones) and never removed from a
865 * copper zone having the same netcode
866 */
868
869 /* For keepout zones only:
870 * what is not allowed inside the keepout ( pads, tracks and vias )
871 */
877
879 int m_ZoneClearance; // Clearance value in internal units.
880 int m_ZoneMinThickness; // Minimum thickness value in filled areas.
881 int m_fillVersion; // See BOARD_DESIGN_SETTINGS for version
882 // differences.
884
889 long long int m_minIslandArea;
890
893
900
901 int m_thermalReliefGap; // Width of the gap in thermal reliefs.
902 int m_thermalReliefSpokeWidth; // Width of the copper bridge in thermal reliefs.
903
904
912 int m_hatchThickness; // thickness of lines (if 0 -> solid shape)
913 int m_hatchGap; // gap between lines (0 -> solid shape
914 EDA_ANGLE m_hatchOrientation; // orientation of grid lines
915 int m_hatchSmoothingLevel; // 0 = no smoothing
916 // 1 = fillet
917 // 2 = arc low def
918 // 3 = arc high def
919 double m_hatchSmoothingValue; // hole chamfer/fillet size (ratio of hole size)
920 double m_hatchHoleMinArea; // min size before holes are dropped (ratio)
921 int m_hatchBorderAlgorithm; // 0 = use min zone thickness
922 // 1 = use hatch thickness
923
926
927 int m_localFlgs; // Variable used in polygon calculations.
928
929 /* set of filled polygons used to draw a zone as a filled area.
930 * from outlines (m_Poly) but unlike m_Poly these filled polygons have no hole
931 * (they are all in one piece) In very simple cases m_FilledPolysList is same
932 * as m_Poly. In less simple cases (when m_Poly has holes) m_FilledPolysList is
933 * a polygon equivalent to m_Poly, without holes but with extra outline segment
934 * connecting "holes" with external main outline. In complex cases an outline
935 * described by m_Poly can have many filled areas
936 */
937 std::map<PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>> m_FilledPolysList;
938
941
943 std::map<PCB_LAYER_ID, HASH_128> m_filledPolysHash;
944
945 ZONE_BORDER_DISPLAY_STYLE m_borderStyle; // border display style, see enum above
946 int m_borderHatchPitch; // for DIAGONAL_EDGE, distance between 2 lines
947 std::vector<SEG> m_borderHatchLines; // hatch lines
948
950 std::map<PCB_LAYER_ID, std::set<int>> m_insulatedIslands;
951
952 double m_area; // The filled zone area
953 double m_outlinearea; // The outline zone area
954
956 std::mutex m_lock;
957};
958
959
960#ifndef SWIG
965#endif
966
967#endif // ZONE_H
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
Definition: approximation.h:32
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
BASE_SET & set(size_t pos)
Definition: base_set.h:115
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
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...
Definition: board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:290
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:377
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:93
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:36
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
Definition: pad.h:54
The main frame for Pcbnew.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Base class for iterating over all vertices in a given SHAPE_POLY_SET.
Represent a set of closed polygons.
void RemoveAllContours()
Remove all outlines & holes (clears) the polygon set.
ITERATOR IterateWithHoles(int aOutline)
void SetVertex(const VERTEX_INDEX &aIndex, const VECTOR2I &aPos)
Accessor function to set the position of a specific point.
int TotalVertices() const
Return total number of vertices stored in the set.
bool GetRelativeIndices(int aGlobalIdx, VERTEX_INDEX *aRelativeIndices) const
Convert a global vertex index —i.e., a number that globally identifies a vertex in a concatenated lis...
bool GetGlobalIndex(VERTEX_INDEX aRelativeIndices, int &aGlobalIdx) const
Compute the global index of a vertex from the relative indices of polygon, contour and vertex.
int NewHole(int aOutline=-1)
Creates a new hole in a given outline.
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Return an object to iterate through the points of the polygons between aFirst and aLast.
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Return the index-th vertex in a given hole outline within a given outline.
CONST_ITERATOR CIterateWithHoles(int aOutline) const
Handle a list of polygons defining a copper zone.
Definition: zone.h:73
void SetHatchThickness(int aThickness)
Definition: zone.h:289
SHAPE_POLY_SET::VERTEX_INDEX * m_CornerSelection
The index of the corner being moved or nullptr if no corner is selected.
Definition: zone.h:925
void SetNeedRefill(bool aNeedRefill)
Definition: zone.h:268
double GetOutlineArea()
This area is cached from the most recent call to CalculateOutlineArea().
Definition: zone.h:247
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.
Definition: zone.cpp:649
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: zone.cpp:1051
void SetHatchBorderAlgorithm(int aAlgo)
Definition: zone.h:307
int m_borderHatchPitch
Definition: zone.h:946
const SHAPE_POLY_SET * Outline() const
Definition: zone.h:341
bool m_isRuleArea
Definition: zone.h:854
void SetDoNotAllowPads(bool aEnable)
Definition: zone.h:750
int GetHatchBorderAlgorithm() const
Definition: zone.h:306
ZONE & operator=(const ZONE &aOther)
Definition: zone.cpp:105
int m_cornerSmoothingType
Definition: zone.h:837
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
Definition: zone.h:724
std::optional< int > GetLocalClearance() const override
Definition: zone.cpp:714
void SetRuleAreaPlacementEnabled(bool aEnabled)
Definition: zone.h:738
void SetLocalClearance(std::optional< int > aClearance)
Definition: zone.h:158
bool m_doNotAllowVias
Definition: zone.h:873
bool UnFill()
Removes the zone filling.
Definition: zone.cpp:413
wxString GetRuleAreaPlacementSource() const
Definition: zone.h:730
bool NeedRefill() const
Definition: zone.h:267
bool GetDoNotAllowVias() const
Definition: zone.h:732
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...
Definition: zone.cpp:1623
void SetCornerRadius(unsigned int aRadius)
Definition: zone.cpp:619
ZONE_FILL_MODE m_fillMode
How to fill areas:
Definition: zone.h:911
const std::vector< SEG > & GetHatchLines() const
Definition: zone.h:803
void SetPosition(const VECTOR2I &aPos) override
Definition: zone.h:113
bool m_doNotAllowFootprints
Definition: zone.h:876
int m_ZoneMinThickness
Definition: zone.h:880
void AddPolygon(std::vector< VECTOR2I > &aPolygon)
Add a polygon to the zone outline.
Definition: zone.cpp:1014
double m_hatchSmoothingValue
Definition: zone.h:919
const std::shared_ptr< SHAPE_POLY_SET > & GetFilledPolysList(PCB_LAYER_ID aLayer) const
Definition: zone.h:620
void SetLocalFlags(int aFlags)
Definition: zone.h:338
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,...
Definition: zone.cpp:1553
void SetCornerSmoothingType(int aType)
Definition: zone.h:664
int m_thermalReliefSpokeWidth
Definition: zone.h:902
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.
Definition: zone.cpp:734
EDA_ANGLE m_hatchOrientation
Definition: zone.h:914
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...
Definition: zone.cpp:1301
void Mirror(const VECTOR2I &aMirrorRef, FLIP_DIRECTION aFlipDirection) override
Mirror the outlines relative to a given horizontal axis the layer is not changed.
Definition: zone.cpp:974
std::map< PCB_LAYER_ID, std::set< int > > m_insulatedIslands
For each layer, a set of insulated islands that were not removed.
Definition: zone.h:950
wxString m_zoneName
An optional unique name for this zone, used for identifying it in DRC checking.
Definition: zone.h:841
void HatchBorder()
Compute the hatch lines depending on the hatch parameters and stores it in the zone's attribute m_bor...
Definition: zone.cpp:1140
std::map< PCB_LAYER_ID, std::shared_ptr< SHAPE_POLY_SET > > m_FilledPolysList
Definition: zone.h:937
std::optional< int > GetLocalClearance(wxString *aSource) const override
Return any local clearances set in the "classic" (ie: pre-rule) system.
Definition: zone.h:166
void SetBorderDisplayStyle(ZONE_BORDER_DISPLAY_STYLE aBorderHatchStyle, int aBorderHatchPitch, bool aRebuilBorderdHatch)
Set all hatch parameters for the zone.
Definition: zone.cpp:1105
bool GetDoNotAllowPads() const
Definition: zone.h:734
const BOX2I GetBoundingBox() const override
Definition: zone.cpp:567
void SetMinThickness(int aMinThickness)
Definition: zone.h:274
double GetFilledArea()
This area is cached from the most recent call to CalculateFilledArea().
Definition: zone.h:237
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: zone.h:138
double m_outlinearea
Definition: zone.h:953
wxString GetFriendlyName() const override
Definition: zone.cpp:914
bool GetDoNotAllowTracks() const
Definition: zone.h:733
int GetLocalFlags() const
Definition: zone.h:337
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: zone.cpp:207
void SetHatchOrientation(const EDA_ANGLE &aStep)
Definition: zone.h:295
wxString GetClass() const override
Definition: zone.h:511
bool m_doNotAllowCopperPour
Definition: zone.h:872
bool GetRuleAreaPlacementEnabled() const
Definition: zone.h:725
void SetHatchSmoothingValue(double aValue)
Definition: zone.h:301
bool m_needRefill
False when a zone was refilled, true after changes in zone params.
Definition: zone.h:899
SHAPE_POLY_SET::ITERATOR IterateWithHoles()
Return an iterator to visit all points of the zone's main outline with holes.
Definition: zone.h:539
bool IsFilled() const
Definition: zone.h:264
bool HitTestForCorner(const VECTOR2I &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX *aCornerHit=nullptr) const
Test if the given VECTOR2I is near a corner.
Definition: zone.cpp:659
void SetHatchSmoothingLevel(int aLevel)
Definition: zone.h:298
bool m_doNotAllowTracks
Definition: zone.h:874
bool IsConnected() const override
Not all ZONEs are really BOARD_CONNECTED_ITEMs....
Definition: zone.h:93
RULE_AREA_PLACEMENT_SOURCE_TYPE m_ruleAreaPlacementSourceType
Definition: zone.h:860
void SetDoNotAllowCopperPour(bool aEnable)
Definition: zone.h:747
void SetThermalReliefSpokeWidth(int aThermalReliefSpokeWidth)
Definition: zone.h:209
virtual PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: zone.cpp:443
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
Definition: zone.cpp:481
ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
Definition: zone.h:753
LSET m_fillFlags
Temp variables used while filling.
Definition: zone.h:940
void SetSelectedCorner(int aCorner)
Definition: zone.h:320
int GetSelectedCorner() const
Definition: zone.h:309
SHAPE_POLY_SET * Outline()
Definition: zone.h:340
void SetHatchStyle(ZONE_BORDER_DISPLAY_STYLE aStyle)
Definition: zone.h:610
bool m_doNotAllowPads
Definition: zone.h:875
void NewHole()
Create a new hole on the zone; i.e., a new contour on the zone's outline.
Definition: zone.h:593
void SetFillFlag(PCB_LAYER_ID aLayer, bool aFlag)
Definition: zone.h:262
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition: zone.cpp:213
void SetCornerPosition(int aCornerIndex, const VECTOR2I &new_pos)
Definition: zone.h:570
void Move(const VECTOR2I &offset) override
Move the outlines.
Definition: zone.cpp:887
bool IsIsland(PCB_LAYER_ID aLayer, int aPolyIdx) const
Check if a given filled polygon is an insulated island.
Definition: zone.cpp:1318
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: zone.h:836
TEARDROP_TYPE m_teardropType
Definition: zone.h:867
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.
Definition: zone.h:943
~ZONE()
Definition: zone.cpp:115
long long int GetMinIslandArea() const
Definition: zone.h:756
int m_hatchSmoothingLevel
Definition: zone.h:915
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
Definition: zone.cpp:1708
SHAPE_POLY_SET * GetFill(PCB_LAYER_ID aLayer)
Definition: zone.h:626
LSET m_layerSet
Definition: zone.h:843
void SetRuleAreaPlacementSourceType(RULE_AREA_PLACEMENT_SOURCE_TYPE aType)
Definition: zone.h:739
void SetIsRuleArea(bool aEnable)
Definition: zone.h:737
int m_ZoneClearance
Definition: zone.h:879
void SetDoNotAllowTracks(bool aEnable)
Definition: zone.h:749
void SetFilledPolysList(PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPolysList)
Set the list of filled polygons.
Definition: zone.h:641
const wxString & GetZoneName() const
Definition: zone.h:135
void CacheBoundingBox()
Used to preload the zone bounding box cache so we don't have to worry about mutex-locking it each tim...
Definition: zone.cpp:596
int GetMinThickness() const
Definition: zone.h:273
virtual void swapData(BOARD_ITEM *aImage) override
Definition: zone.cpp:1293
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.
Definition: zone.cpp:666
static bool ClassOf(const EDA_ITEM *aItem)
Definition: zone.h:82
void RemoveCutout(int aOutlineIdx, int aHoleIdx)
Remove a cutout from the zone.
Definition: zone.cpp:985
void Rotate(const VECTOR2I &aCentre, const EDA_ANGLE &aAngle) override
Rotate the outlines.
Definition: zone.cpp:942
bool HigherPriority(const ZONE *aOther) const
Definition: zone.cpp:390
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.
Definition: zone.cpp:720
void SetIsFilled(bool isFilled)
Definition: zone.h:265
void SetFillMode(ZONE_FILL_MODE aFillMode)
Definition: zone.h:195
int GetFillFlag(PCB_LAYER_ID aLayer)
Definition: zone.h:257
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: zone.cpp:1287
int m_hatchGap
Definition: zone.h:913
ZONE_CONNECTION GetPadConnection() const
Definition: zone.h:270
void InitDataFromSrcInCopyCtor(const ZONE &aZone)
Copy aZone data to me.
Definition: zone.cpp:125
bool HasFilledPolysForLayer(PCB_LAYER_ID aLayer) const
Definition: zone.h:612
int GetHatchThickness() const
Definition: zone.h:288
double GetHatchHoleMinArea() const
Definition: zone.h:303
void SetLayerSet(const LSET &aLayerSet) override
Definition: zone.cpp:487
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.
Definition: zone.cpp:759
virtual bool IsOnLayer(PCB_LAYER_ID) const override
Test to see if this object is on the given layer.
Definition: zone.cpp:561
int m_hatchBorderAlgorithm
Definition: zone.h:921
void SetDoNotAllowVias(bool aEnable)
Definition: zone.h:748
bool IsTeardropArea() const
Definition: zone.h:699
std::vector< SEG > m_borderHatchLines
Definition: zone.h:947
wxString m_ruleAreaPlacementSource
Definition: zone.h:861
VECTOR2I GetPosition() const override
Definition: zone.cpp:437
int GetThermalReliefSpokeWidth() const
Definition: zone.h:217
int GetBorderHatchPitch() const
HatchBorder related methods.
Definition: zone.cpp:1099
virtual void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition: zone.cpp:953
ZONE_BORDER_DISPLAY_STYLE GetHatchStyle() const
Definition: zone.h:609
void BuildHashValue(PCB_LAYER_ID aLayer)
Build the hash value of m_FilledPolysList, and store it internally in m_filledPolysHash.
Definition: zone.cpp:640
void SetThermalReliefGap(int aThermalReliefGap)
Definition: zone.h:198
EDA_ANGLE GetHatchOrientation() const
Definition: zone.h:294
bool BuildSmoothedPoly(SHAPE_POLY_SET &aSmoothedPoly, PCB_LAYER_ID aLayer, SHAPE_POLY_SET *aBoardOutline, SHAPE_POLY_SET *aSmoothedPolyWithApron=nullptr) const
Definition: zone.cpp:1365
int m_fillVersion
Definition: zone.h:881
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
Definition: zone.h:559
bool GetDoNotAllowFootprints() const
Definition: zone.h:735
ZONE_FILL_MODE GetFillMode() const
Definition: zone.h:196
double m_hatchHoleMinArea
Definition: zone.h:920
SHAPE_POLY_SET::CONST_ITERATOR CIterateWithHoles() const
Return an iterator to visit all points of the zone's main outline with holes.
Definition: zone.h:549
SHAPE_POLY_SET::ITERATOR Iterate()
Return an iterator to visit all points of the zone's main outline without holes.
Definition: zone.h:529
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition: zone.h:133
void SetDoNotAllowFootprints(bool aEnable)
Definition: zone.h:751
bool GetDoNotAllowCopperPour() const
Definition: zone.h:731
bool HasKeepoutParametersSet() const
Accessor to determine if any keepout parameters are set.
Definition: zone.h:715
void SetBorderHatchPitch(int aPitch)
Set the hatch pitch parameter for the zone.
Definition: zone.cpp:1120
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...
Definition: zone.cpp:1330
bool m_ruleAreaPlacementEnabled
Placement rule area data.
Definition: zone.h:859
int GetHatchGap() const
Definition: zone.h:291
double CalculateOutlineArea()
Compute the area of the zone outline (not the filled area).
Definition: zone.cpp:1546
RULE_AREA_PLACEMENT_SOURCE_TYPE GetRuleAreaPlacementSourceType() const
Definition: zone.h:726
std::mutex m_lock
Lock used for multi-threaded filling on multi-layer zones.
Definition: zone.h:956
void SetHatchHoleMinArea(double aPct)
Definition: zone.h:304
unsigned m_priority
Definition: zone.h:849
TEARDROP_TYPE GetTeardropAreaType() const
Definition: zone.h:710
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition: zone.cpp:304
bool IsConflicting() const
For rule areas which exclude footprints (and therefore participate in courtyard conflicts during move...
Definition: zone.cpp:431
ISLAND_REMOVAL_MODE m_islandRemovalMode
Definition: zone.h:883
bool m_isFilled
True when a zone was filled, false after deleting the filled areas.
Definition: zone.h:892
double GetHatchSmoothingValue() const
Definition: zone.h:300
bool AppendCorner(VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
Definition: zone.cpp:1031
void MoveEdge(const VECTOR2I &offset, int aEdge)
Move the outline Edge.
Definition: zone.cpp:927
int GetHatchSmoothingLevel() const
Definition: zone.h:297
unsigned int GetCornerRadius() const
Definition: zone.h:670
int GetCornerSmoothingType() const
Definition: zone.h:666
int m_thermalReliefGap
Definition: zone.h:901
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: zone.cpp:534
void SetIsIsland(PCB_LAYER_ID aLayer, int aPolyIdx)
Definition: zone.h:655
int m_localFlgs
Definition: zone.h:927
bool IsOnCopperLayer() const override
Definition: zone.cpp:475
double CalculateFilledArea()
Compute the area currently occupied by the zone fill.
Definition: zone.cpp:1523
int m_hatchThickness
Definition: zone.h:912
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...
Definition: zone.cpp:1593
void SetAssignedPriority(unsigned aPriority)
Definition: zone.h:118
double m_area
Definition: zone.h:952
unsigned int m_cornerRadius
Definition: zone.h:838
void SetPadConnection(ZONE_CONNECTION aPadConnection)
Definition: zone.h:271
std::mutex & GetLock()
Definition: zone.h:252
void SetZoneName(const wxString &aName)
Definition: zone.h:136
bool operator==(const ZONE &aOther) const
Definition: zone.cpp:1640
void SetTeardropAreaType(TEARDROP_TYPE aType)
Set the type of teardrop if the zone is a teardrop area for non teardrop area, the type must be TEARD...
Definition: zone.h:705
void UnHatchBorder()
Clear the zone's hatch.
Definition: zone.cpp:1126
void SetIslandRemovalMode(ISLAND_REMOVAL_MODE aRemove)
Definition: zone.h:754
void SetOutline(SHAPE_POLY_SET *aOutline)
Definition: zone.h:343
PCB_LAYER_ID GetFirstLayer() const
Definition: zone.cpp:453
void SetMinIslandArea(long long int aArea)
Definition: zone.h:757
virtual std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
Definition: zone.cpp:515
HASH_128 GetHashValue(PCB_LAYER_ID aLayer)
Definition: zone.cpp:631
ZONE_CONNECTION m_PadConnection
Definition: zone.h:878
void SetRuleAreaPlacementSource(const wxString &aSource)
Definition: zone.h:743
int GetThermalReliefGap() const
Definition: zone.h:206
void RemoveAllContours(void)
Definition: zone.h:554
void SetHatchGap(int aStep)
Definition: zone.h:292
static int GetDefaultHatchPitch()
Definition: zone.cpp:1281
unsigned GetAssignedPriority() const
Definition: zone.h:123
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: zone.h:519
bool SameNet(const ZONE *aOther) const
Definition: zone.cpp:407
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.
Definition: zone.cpp:1584
ZONE_BORDER_DISPLAY_STYLE m_borderStyle
Definition: zone.h:945
long long int m_minIslandArea
When island removal mode is set to AREA, islands below this area will be removed.
Definition: zone.h:889
#define _(s)
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:147
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
FLIP_DIRECTION
Definition: mirror.h:27
#define DECLARE_ENUM_TO_WXANY(type)
Definition: property.h:729
A storage class for 128-bit hash value.
Definition: hash_128.h:36
A struct recording the isolated and single-pad islands within a zone.
Definition: zone.h:60
std::vector< int > m_SingleConnectionOutlines
Definition: zone.h:62
std::vector< int > m_IsolatedOutlines
Definition: zone.h:61
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
Definition: typeinfo.h:107
Class ZONE_SETTINGS used to handle zones parameters in dialogs.
RULE_AREA_PLACEMENT_SOURCE_TYPE
Definition: zone_settings.h:66
ISLAND_REMOVAL_MODE
Whether or not to remove isolated islands from a zone.
Definition: zone_settings.h:59
ZONE_FILL_MODE
Definition: zone_settings.h:42
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.
Definition: zone_settings.h:50
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition: zones.h:47