KiCad PCB EDA Suite
class_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) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2017 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 
30 #ifndef CLASS_ZONE_H_
31 #define CLASS_ZONE_H_
32 
33 
34 #include <vector>
35 #include <gr_basic.h>
36 #include <class_board_item.h>
37 #include <board_connected_item.h>
39 #include <PolyLine.h>
41 #include <zone_settings.h>
42 
43 
44 class EDA_RECT;
45 class LINE_READER;
46 class EDA_DRAW_PANEL;
47 class PCB_EDIT_FRAME;
48 class BOARD;
49 class ZONE_CONTAINER;
51 
52 typedef std::vector<SEG> ZONE_SEGMENT_FILL;
53 
61 {
62 public:
63 
68 
69  ZONE_CONTAINER( BOARD* parent );
70 
71  ZONE_CONTAINER( const ZONE_CONTAINER& aZone );
72  ZONE_CONTAINER& operator=( const ZONE_CONTAINER &aOther );
73 
75 
76  static inline bool ClassOf( const EDA_ITEM* aItem )
77  {
78  return aItem && ( ( PCB_ZONE_AREA_T == aItem->Type() ) ||
79  ( PCB_ZONE_T == aItem->Type() ) );
80  }
81 
94  const wxPoint GetPosition() const override;
95  void SetPosition( const wxPoint& aPos ) override {}
96 
101  void SetPriority( unsigned aPriority ) { m_priority = aPriority; }
102 
107  unsigned GetPriority() const { return m_priority; }
108 
109  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
110 
111  void SetLayerSet( LSET aLayerSet );
112 
113  virtual LSET GetLayerSet() const override;
114 
123  void Draw( EDA_DRAW_PANEL* panel,
124  wxDC* DC,
125  GR_DRAWMODE aDrawMode,
126  const wxPoint& offset = ZeroOffset ) override;
127 
136  void DrawFilledArea( EDA_DRAW_PANEL* panel,
137  wxDC* DC,
138  GR_DRAWMODE aDrawMode,
139  const wxPoint& offset = ZeroOffset );
140 
150  void DrawWhileCreateOutline( EDA_DRAW_PANEL* panel, wxDC* DC,
151  GR_DRAWMODE draw_mode = GR_OR );
152 
156  const EDA_RECT GetBoundingBox() const override;
157 
158  int GetClearance( BOARD_CONNECTED_ITEM* aItem = NULL ) const override;
159 
164  bool IsOnCopperLayer() const;
165 
170  bool CommonLayerExists( const LSET aLayerSet ) const;
171 
172  virtual void SetLayer( PCB_LAYER_ID aLayer ) override;
173 
174  virtual PCB_LAYER_ID GetLayer() const override;
175 
176  virtual bool IsOnLayer( PCB_LAYER_ID ) const override;
177 
178  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
179 
180  void SetFillMode( ZONE_FILL_MODE aFillMode ) { m_FillMode = aFillMode; }
182 
183  void SetThermalReliefGap( int aThermalReliefGap ) { m_ThermalReliefGap = aThermalReliefGap; }
184  int GetThermalReliefGap( D_PAD* aPad = NULL ) const;
185 
186  void SetThermalReliefCopperBridge( int aThermalReliefCopperBridge )
187  {
188  m_ThermalReliefCopperBridge = aThermalReliefCopperBridge;
189  }
190  int GetThermalReliefCopperBridge( D_PAD* aPad = NULL ) const;
191 
192  void SetArcSegmentCount( int aArcSegCount ) { m_ArcToSegmentsCount = aArcSegCount; }
193  int GetArcSegmentCount() const { return m_ArcToSegmentsCount; }
194 
195  bool IsFilled() const { return m_IsFilled; }
196  void SetIsFilled( bool isFilled ) { m_IsFilled = isFilled; }
197 
198  int GetZoneClearance() const { return m_ZoneClearance; }
199  void SetZoneClearance( int aZoneClearance ) { m_ZoneClearance = aZoneClearance; }
200 
201  ZoneConnection GetPadConnection( D_PAD* aPad = NULL ) const;
202  void SetPadConnection( ZoneConnection aPadConnection ) { m_PadConnection = aPadConnection; }
203 
204  int GetMinThickness() const { return m_ZoneMinThickness; }
205  void SetMinThickness( int aMinThickness ) { m_ZoneMinThickness = aMinThickness; }
206 
207  int GetSelectedCorner() const
208  {
209  // Transform relative indices to global index
210  int globalIndex;
211  m_Poly->GetGlobalIndex( *m_CornerSelection, globalIndex );
212 
213  return globalIndex;
214  }
215 
216  void SetSelectedCorner( int aCorner )
217  {
218  SHAPE_POLY_SET::VERTEX_INDEX selectedCorner;
219 
220  // If the global index of the corner is correct, assign it to m_CornerSelection
221  if( m_Poly->GetRelativeIndices( aCorner, &selectedCorner ) )
222  {
223  if( m_CornerSelection == nullptr )
225 
226  *m_CornerSelection = selectedCorner;
227  }
228  else
229  throw( std::out_of_range( "aCorner-th vertex does not exist" ) );
230  }
231 
233  // Like HitTest but selects the current corner to be operated on
234  void SetSelectedCorner( const wxPoint& aPosition );
235 
236  int GetLocalFlags() const { return m_localFlgs; }
237  void SetLocalFlags( int aFlags ) { m_localFlgs = aFlags; }
238 
240  const ZONE_SEGMENT_FILL& FillSegments() const { return m_FillSegmList; }
241 
243  const SHAPE_POLY_SET* Outline() const { return const_cast< SHAPE_POLY_SET* >( m_Poly ); }
244 
245  void SetOutline( SHAPE_POLY_SET* aOutline ) { m_Poly = aOutline; }
246 
253  virtual bool HitTest( const wxPoint& aPosition ) const override;
254 
262  bool HitTestInsideZone( const wxPoint& aPosition ) const
263  {
264  return m_Poly->Contains( VECTOR2I( aPosition ), 0 );
265  }
266 
273  bool HitTestFilledArea( const wxPoint& aRefPos ) const;
274 
287  int aCircleToSegmentsCount,
288  double aCorrectionFactor ) const;
289 
305  int aMinClearanceValue,
306  bool aUseNetClearance ) const;
307 
309  int aClearanceValue,
310  int aCircleToSegmentsCount,
311  double aCorrectionFactor ) const override;
312 
322  bool HitTestForCorner( const wxPoint& refPos, SHAPE_POLY_SET::VERTEX_INDEX& aCornerHit ) const;
323 
331  bool HitTestForCorner( const wxPoint& refPos ) const;
332 
341  bool HitTestForEdge( const wxPoint& refPos, SHAPE_POLY_SET::VERTEX_INDEX& aCornerHit ) const;
342 
349  bool HitTestForEdge( const wxPoint& refPos ) const;
350 
354  bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
355 
356 
363  bool UnFill();
364 
365  /* Geometric transformations: */
366 
372  void Move( const wxPoint& offset ) override;
373 
380  void MoveEdge( const wxPoint& offset, int aEdge );
381 
388  void Rotate( const wxPoint& centre, double angle ) override;
389 
396  virtual void Flip( const wxPoint& aCentre ) override;
397 
404  void Mirror( const wxPoint& mirror_ref );
405 
411  wxString GetClass() const override
412  {
413  return wxT( "ZONE_CONTAINER" );
414  }
415 
420  int GetNumCorners( void ) const
421  {
422  return m_Poly->TotalVertices();
423  }
424 
431  {
432  return m_Poly->Iterate();
433  }
434 
441  {
442  return m_Poly->IterateWithHoles();
443  }
444 
451  {
452  return m_Poly->CIterateWithHoles();
453  }
454 
455  void RemoveAllContours( void )
456  {
458  }
459 
460  const VECTOR2I& GetCornerPosition( int aCornerIndex ) const
461  {
463 
464  // Convert global to relative indices
465  if( !m_Poly->GetRelativeIndices( aCornerIndex, &index ) )
466  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
467 
468  return m_Poly->CVertex( index );
469  }
470 
471  void SetCornerPosition( int aCornerIndex, wxPoint new_pos )
472  {
473  SHAPE_POLY_SET::VERTEX_INDEX relativeIndices;
474 
475  // Convert global to relative indices
476  if( m_Poly->GetRelativeIndices( aCornerIndex, &relativeIndices ) )
477  {
478  m_Poly->Vertex( relativeIndices ).x = new_pos.x;
479  m_Poly->Vertex( relativeIndices ).y = new_pos.y;
480  }
481  else
482  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
483  }
484 
489  void NewHole()
490  {
491  m_Poly->NewHole();
492  }
493 
502  bool AppendCorner( wxPoint aPosition, int aHoleIdx, bool aAllowDuplication = false );
503 
504  HATCH_STYLE GetHatchStyle() const
505  {
506  return m_hatchStyle;
507  }
508 
509  void SetHatchStyle( HATCH_STYLE aStyle )
510  {
511  m_hatchStyle = aStyle;
512  }
513 
521  bool IsSame( const ZONE_CONTAINER &aZoneToCompare );
522 
528  {
530  }
531 
538  //TODO - This should be called for each layer on which the zone exists
539 
541  {
542  return m_FilledPolysList;
543  }
544 
545  void CacheTriangulation();
546 
551  void SetFilledPolysList( SHAPE_POLY_SET& aPolysList )
552  {
553  m_FilledPolysList = aPolysList;
554  }
555 
560  void SetRawPolysList( SHAPE_POLY_SET& aPolysList )
561  {
562  m_RawPolysList = aPolysList;
563  }
564 
565 
572  bool BuildSmoothedPoly( SHAPE_POLY_SET& aSmoothedPoly ) const;
573 
574  void SetCornerSmoothingType( int aType ) { m_cornerSmoothingType = aType; };
575 
577 
578  void SetCornerRadius( unsigned int aRadius );
579 
580  unsigned int GetCornerRadius() const { return m_cornerRadius; };
581 
587  void AddPolygon( std::vector< wxPoint >& aPolygon );
588 
589  void SetFillSegments( const ZONE_SEGMENT_FILL& aSegments )
590  {
591  m_FillSegmList = aSegments;
592  }
593 
595  {
596  return m_RawPolysList;
597  }
598 
599  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
600 
601  BITMAP_DEF GetMenuImage() const override;
602 
603  EDA_ITEM* Clone() const override;
604 
608  bool GetIsKeepout() const { return m_isKeepout; }
610  bool GetDoNotAllowVias() const { return m_doNotAllowVias; }
611  bool GetDoNotAllowTracks() const { return m_doNotAllowTracks; }
612 
613  void SetIsKeepout( bool aEnable ) { m_isKeepout = aEnable; }
614  void SetDoNotAllowCopperPour( bool aEnable ) { m_doNotAllowCopperPour = aEnable; }
615  void SetDoNotAllowVias( bool aEnable ) { m_doNotAllowVias = aEnable; }
616  void SetDoNotAllowTracks( bool aEnable ) { m_doNotAllowTracks = aEnable; }
617 
626  int GetHatchPitch() const;
627 
632  static int GetDefaultHatchPitch();
633 
643  void SetHatch( int aHatchStyle, int aHatchPitch, bool aRebuildHatch );
644 
650  void SetHatchPitch( int aPitch );
651 
656  void UnHatch();
657 
663  void Hatch();
664 
665  const std::vector<SEG>& GetHatchLines() const { return m_HatchLines; }
666 
667  bool GetHV45() const { return m_hv45; }
668  void SetHV45( bool aConstrain ) { m_hv45 = aConstrain; }
669 
670 #if defined(DEBUG)
671  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
672 #endif
673 
674  virtual void SwapData( BOARD_ITEM* aImage ) override;
675 
676 private:
677 
680  unsigned int m_cornerRadius;
681 
683 
684  /* Priority: when a zone outline is inside and other zone, if its priority is higher
685  * the other zone priority, it will be created inside.
686  * if priorities are equal, a DRC error is set
687  */
688  unsigned m_priority;
689 
690  /* A zone outline can be a keepout zone.
691  * It will be never filled, and DRC should test for pads, tracks and vias
692  */
694 
695  /* For keepout zones only:
696  * what is not allowed inside the keepout ( pads, tracks and vias )
697  */
701 
705 
709 
712 
715 
718 
719 
722 
725 
728 
733 
734  /* set of filled polygons used to draw a zone as a filled area.
735  * from outlines (m_Poly) but unlike m_Poly these filled polygons have no hole
736  * (they are all in one piece) In very simple cases m_FilledPolysList is same
737  * as m_Poly. In less simple cases (when m_Poly has holes) m_FilledPolysList is
738  * a polygon equivalent to m_Poly, without holes but with extra outline segment
739  * connecting "holes" with external main outline. In complex cases an outline
740  * described by m_Poly can have many filled areas
741  */
744 
745  HATCH_STYLE m_hatchStyle; // hatch style, see enum above
746  int m_hatchPitch; // for DIAGONAL_EDGE, distance between 2 hatch lines
747  std::vector<SEG> m_HatchLines; // hatch lines
748  std::vector<int> m_insulatedIslands;
749 
750  bool m_hv45; // constrain edges to horizontal, vertical or 45ยบ
751 
775  typedef union {
779 
780  // Sanity check: assure that the conversion VECTOR2I->wxPoint using the previous union is
781  // correct, making sure that the access for x and y attributes is still safe.
782  static_assert(offsetof(wxPoint,x) == offsetof(VECTOR2I,x),
783  "wxPoint::x and VECTOR2I::x have different offsets");
784 
785  static_assert(offsetof(wxPoint,y) == offsetof(VECTOR2I,y),
786  "wxPoint::y and VECTOR2I::y have different offsets");
787 
788 };
789 
790 
791 #endif // CLASS_ZONE_H_
void SetFilledPolysList(SHAPE_POLY_SET &aPolysList)
Function SetFilledPolysList sets the list of filled polygons.
Definition: class_zone.h:551
void SetDoNotAllowTracks(bool aEnable)
Definition: class_zone.h:616
void MoveEdge(const wxPoint &offset, int aEdge)
Function MoveEdge Move the outline Edge.
Definition: class_zone.cpp:914
int NewHole(int aOutline=-1)
Creates a new hole in a given outline
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void SetCornerSmoothingType(int aType)
Definition: class_zone.h:574
void SetHatchPitch(int aPitch)
Function SetHatchPitch sets the hatch pitch parameter for the zone.
void Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset) override
Function Draw Draws the zone outline.
Definition: class_zone.cpp:276
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
std::vector< SEG > ZONE_SEGMENT_FILL
Definition: class_zone.h:50
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:703
void DrawWhileCreateOutline(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE draw_mode=GR_OR)
Function DrawWhileCreateOutline Draws the zone outline when it is created.
Definition: class_zone.cpp:545
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:420
PNG memory record (file in memory).
Definition: bitmap_types.h:41
bool CommonLayerExists(const LSET aLayerSet) const
Function CommonLayerExist Test if this zone shares a common layer with the given layer set...
Definition: class_zone.cpp:194
bool HitTestForEdge(const wxPoint &refPos, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
Function HitTestForEdge tests if the given wxPoint is near a segment defined by 2 corners...
Definition: class_zone.cpp:695
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: class_zone.cpp:150
int GetMinThickness() const
Definition: class_zone.h:204
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
bool GetDoNotAllowCopperPour() const
Definition: class_zone.h:609
bool m_doNotAllowTracks
Definition: class_zone.h:700
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox (virtual)
Definition: class_zone.cpp:518
int GetArcSegmentCount() const
Definition: class_zone.h:193
void SetCornerRadius(unsigned int aRadius)
Definition: class_zone.cpp:646
Classes BOARD_ITEM and BOARD_CONNECTED_ITEM.
SHAPE_POLY_SET::VERTEX_INDEX * m_CornerSelection
The index of the corner being moved or nullptr if no corner is selected.
Definition: class_zone.h:724
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
virtual bool IsOnLayer(PCB_LAYER_ID) const override
Function IsOnLayer tests to see if this object is on the given layer.
Definition: class_zone.cpp:265
std::vector< int > m_insulatedIslands
Definition: class_zone.h:748
void DrawFilledArea(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset)
Function DrawDrawFilledArea Draws the filled area for this zone (polygon list .m_FilledPolysList) ...
Definition: class_zone.cpp:406
bool IsFilled() const
Definition: class_zone.h:195
ZoneConnection
How pads are covered by copper in zone.
Definition: zones.h:50
CONST_ITERATOR CIterateWithHoles(int aOutline) const
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:175
bool BuildSmoothedPoly(SHAPE_POLY_SET &aSmoothedPoly) const
Function GetSmoothedPoly returns a pointer to the corner-smoothed version of m_Poly if it exists...
ZONE_SEGMENT_FILL & FillSegments()
Definition: class_zone.h:239
int TotalVertices() const
Returns total number of vertices stored in the set.
SHAPE_POLY_SET * Outline()
Definition: class_zone.h:242
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1, bool aIgnoreHoles=false) const
Returns true if a given subpolygon contains the point aP.
Struct VERTEX_INDEX.
int GetCornerSmoothingType() const
Definition: class_zone.h:576
void SetArcSegmentCount(int aArcSegCount)
Definition: class_zone.h:192
void SetHatch(int aHatchStyle, int aHatchPitch, bool aRebuildHatch)
Function SetHatch sets all hatch parameters for the zone.
void SetFillSegments(const ZONE_SEGMENT_FILL &aSegments)
Definition: class_zone.h:589
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:732
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
SHAPE_POLY_SET::CONST_ITERATOR CIterateWithHoles() const
Function CIterateWithHoles returns an iterator to visit all points of the zone&#39;s main outline with ho...
Definition: class_zone.h:450
const ZONE_SEGMENT_FILL & FillSegments() const
Definition: class_zone.h:240
int m_localFlgs
Variable used in polygon calculations.
Definition: class_zone.h:727
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
int GetThermalReliefCopperBridge(D_PAD *aPad=NULL) const
Definition: class_zone.cpp:637
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_zone.h:76
void SetIsFilled(bool isFilled)
Definition: class_zone.h:196
const wxPoint GetPosition() const override
Function GetPosition.
Definition: class_zone.cpp:169
Class BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected an...
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
Definition: class_zone.h:460
unsigned int GetCornerRadius() const
Definition: class_zone.h:580
void SetOutline(SHAPE_POLY_SET *aOutline)
Definition: class_zone.h:245
static int GetDefaultHatchPitch()
Function GetDefaultHatchPitchMils.
int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
Definition: class_zone.cpp:780
const std::vector< SEG > & GetHatchLines() const
Definition: class_zone.h:665
static wxPoint ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
struct SHAPE_POLY_SET::VERTEX_INDEX VERTEX_INDEX
Struct VERTEX_INDEX.
void SetDoNotAllowVias(bool aEnable)
Definition: class_zone.h:615
SHAPE_POLY_SET m_RawPolysList
Definition: class_zone.h:743
void TransformSolidAreasShapesToPolygonSet(SHAPE_POLY_SET &aCornerBuffer, int aCircleToSegmentsCount, double aCorrectionFactor) const
Function TransformSolidAreasShapesToPolygonSet Convert solid areas full shapes to polygon set (the fu...
VECTOR2I & Vertex(int aIndex, int aOutline, int aHole)
Returns the index-th vertex in a given hole outline within a given outline
void SetPriority(unsigned aPriority)
Function SetPriority.
Definition: class_zone.h:101
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:608
virtual LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
Definition: class_zone.cpp:230
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:210
SHAPE_POLY_SET::ITERATOR Iterate()
Function Iterate returns an iterator to visit all points of the zone&#39;s main outline without holes...
Definition: class_zone.h:430
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:708
PCB_LAYER_ID
A quick note on layer IDs:
Class LSET is a set of PCB_LAYER_IDs.
int m_ThermalReliefCopperBridge
Definition: class_zone.h:717
ZoneConnection GetPadConnection(D_PAD *aPad=NULL) const
Definition: class_zone.cpp:997
std::vector< SEG > m_HatchLines
Definition: class_zone.h:747
ZoneConnection m_PadConnection
Definition: class_zone.h:702
ZONE_CONTAINER & operator=(const ZONE_CONTAINER &aOther)
Definition: class_zone.cpp:113
bool IsSame(const ZONE_CONTAINER &aZoneToCompare)
Function IsSame tests if 2 zones are equivalent: 2 zones are equivalent if they have same parameters ...
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
ITERATOR IterateWithHoles(int aOutline)
Function IterateWithHoles.
Class SHAPE_POLY_SET.
void NewHole()
Function NewHole creates a new hole on the zone; i.e., a new contour on the zone&#39;s outline...
Definition: class_zone.h:489
bool HitTestInsideZone(const wxPoint &aPosition) const
Function HitTest tests if a point is inside the zone area, i.e.
Definition: class_zone.h:262
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:711
virtual void Flip(const wxPoint &aCentre) override
Function Flip Flip this object, i.e.
Definition: class_zone.cpp:957
bool GetRelativeIndices(int aGlobalIdx, VERTEX_INDEX *aRelativeIndices) const
Function GetRelativeIndices.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:678
int GetThermalReliefGap(D_PAD *aPad=NULL) const
Definition: class_zone.cpp:628
ZONE_CONTAINER(BOARD *parent)
Definition: class_zone.cpp:52
unsigned m_priority
Definition: class_zone.h:688
void Rotate(const wxPoint &centre, double angle) override
Function Rotate Move the outlines.
Definition: class_zone.cpp:927
bool m_doNotAllowVias
Definition: class_zone.h:699
ZONE_FILL_MODE GetFillMode() const
Definition: class_zone.h:181
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
Definition: class_zone.cpp:202
bool UnFill()
Function UnFill Removes the zone filling.
Definition: class_zone.cpp:156
int m_cornerSmoothingType
Definition: class_zone.h:679
void CacheTriangulation()
class SEGZONE, a segment used to fill a zone area (segment on a copper layer)
Definition: typeinfo.h:97
const SHAPE_POLY_SET * Outline() const
Definition: class_zone.h:243
HATCH_STYLE
Zone hatch styles.
Definition: class_zone.h:67
void SetZoneClearance(int aZoneClearance)
Definition: class_zone.h:199
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on...
Definition: class_zone.cpp:244
void AddPolygon(std::vector< wxPoint > &aPolygon)
add a polygon to the zone outline if the zone outline is empty, this is the main outline else it is a...
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:742
const SHAPE_POLY_SET & GetFilledPolysList() const
Function GetFilledPolysList returns a reference to the list of filled polygons.
Definition: class_zone.h:540
void SetSelectedCorner(int aCorner)
Definition: class_zone.h:216
void SetRawPolysList(SHAPE_POLY_SET &aPolysList)
Function SetFilledPolysList sets the list of filled polygons.
Definition: class_zone.h:560
unsigned int m_cornerRadius
Definition: class_zone.h:680
void SetThermalReliefCopperBridge(int aThermalReliefCopperBridge)
Definition: class_zone.h:186
void Move(const wxPoint &offset) override
Function Move Move the outlines.
Definition: class_zone.cpp:897
bool GetGlobalIndex(VERTEX_INDEX aRelativeIndices, int &aGlobalIdx)
Function GetGlobalIndex computes the global index of a vertex from the relative indices of polygon...
Definition: gr_basic.h:38
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:745
void SetDoNotAllowCopperPour(bool aEnable)
Definition: class_zone.h:614
void TransformOutlinesShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, int aMinClearanceValue, bool aUseNetClearance) const
Function TransformOutlinesShapeWithClearanceToPolygon Convert the outlines shape to a polygon with no...
bool m_doNotAllowCopperPour
Definition: class_zone.h:698
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_zone.h:411
bool IsOnCopperLayer() const
Function IsOnCopperLayer.
Definition: class_zone.cpp:181
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:714
bool GetDoNotAllowTracks() const
Definition: class_zone.h:611
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:704
void SetFillMode(ZONE_FILL_MODE aFillMode)
Definition: class_zone.h:180
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:721
void SetCornerPosition(int aCornerIndex, wxPoint new_pos)
Definition: class_zone.h:471
Board layer functions and definitions.
void UnHatch()
Function UnHatch clears the zone&#39;s hatch.
int GetLocalFlags() const
Definition: class_zone.h:236
bool GetDoNotAllowVias() const
Definition: class_zone.h:610
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
SHAPE_POLY_SET::ITERATOR IterateWithHoles()
Function IterateWithHoles returns an iterator to visit all points of the zone&#39;s main outline with hol...
Definition: class_zone.h:440
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
Class ITERATOR_TEMPLATE.
virtual bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if a point is near an outline edge or a corner of this zone.
Definition: class_zone.cpp:654
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
bool HitTestFilledArea(const wxPoint &aRefPos) const
Function HitTestFilledArea tests if the given wxPoint is within the bounds of a filled area of this z...
Definition: class_zone.cpp:807
void SetHV45(bool aConstrain)
Definition: class_zone.h:668
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class PCB_EDIT_FRAME is the main frame for Pcbnew.
HATCH_STYLE GetHatchStyle() const
Definition: class_zone.h:504
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone&#39;s...
void SetHatchStyle(HATCH_STYLE aStyle)
Definition: class_zone.h:509
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
void SetLocalFlags(int aFlags)
Definition: class_zone.h:237
bool GetHV45() const
Definition: class_zone.h:667
int GetSelectedCorner() const
Definition: class_zone.h:207
void SetPosition(const wxPoint &aPos) override
Definition: class_zone.h:95
bool AppendCorner(wxPoint aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
int GetHatchPitch() const
Hatch related methods.
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor) const override
void Mirror(const wxPoint &mirror_ref)
Function Mirror Mirror the outlines , relative to a given horizontal axis the layer is not changed...
Definition: class_zone.cpp:973
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
void SetIsKeepout(bool aEnable)
Definition: class_zone.h:613
void SetPadConnection(ZoneConnection aPadConnection)
Definition: class_zone.h:202
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:107
Class BOARD_CONNECTED_ITEM.
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
bool HitTestForCorner(const wxPoint &refPos, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
Function HitTestForCorner tests if the given wxPoint is near a corner.
Definition: class_zone.cpp:679
void SetMinThickness(int aMinThickness)
Definition: class_zone.h:205
SHAPE_POLY_SET & RawPolysList()
Definition: class_zone.h:594
ZONE_FILL_MODE
Definition: zone_settings.h:38
void SetThermalReliefGap(int aThermalReliefGap)
Definition: class_zone.h:183
EDA_UNITS_T
Definition: common.h:159
int GetZoneClearance() const
Definition: class_zone.h:198
Union to handle conversion between references to wxPoint and to VECTOR2I.
Definition: class_zone.h:775
void ClearFilledPolysList()
Function ClearFilledPolysList clears the list of filled polygons.
Definition: class_zone.h:527
void RemoveAllContours(void)
Definition: class_zone.h:455
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it&#39;s internal state for displ...
Definition: class_zone.cpp:813