KiCad PCB EDA Suite
ZONE_CONTAINER Class Reference

Class ZONE_CONTAINER handles a list of polygons defining a copper zone. More...

#include <class_zone.h>

Inheritance diagram for ZONE_CONTAINER:
BOARD_CONNECTED_ITEM BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Classes

union  WX_VECTOR_CONVERTER
 Union to handle conversion between references to wxPoint and to VECTOR2I. More...
 

Public Types

enum  HATCH_STYLE { NO_HATCH, DIAGONAL_FULL, DIAGONAL_EDGE }
 Zone hatch styles. More...
 
typedef enum ZONE_CONTAINER::HATCH_STYLE HATCH_STYLE
 Zone hatch styles. More...
 

Public Member Functions

 ZONE_CONTAINER (BOARD *parent)
 
 ZONE_CONTAINER (const ZONE_CONTAINER &aZone)
 
ZONE_CONTAINERoperator= (const ZONE_CONTAINER &aOther)
 
 ~ZONE_CONTAINER ()
 
const wxPointGetPosition () const override
 Function GetPosition. More...
 
void SetPosition (const wxPoint &aPos) override
 
void SetPriority (unsigned aPriority)
 Function SetPriority. More...
 
unsigned GetPriority () const
 Function GetPriority. More...
 
void GetMsgPanelInfo (std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
void SetLayerSet (LSET aLayerSet)
 
virtual LSET GetLayerSet () const override
 Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...
 
void Draw (EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset) override
 Function Draw Draws the zone outline. More...
 
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) More...
 
void DrawWhileCreateOutline (EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE draw_mode=GR_OR)
 Function DrawWhileCreateOutline Draws the zone outline when it is created. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox (virtual) More...
 
int GetClearance (BOARD_CONNECTED_ITEM *aItem=NULL) const override
 Function GetClearance returns the clearance in internal units. More...
 
void TestForCopperIslandAndRemoveInsulatedIslands (BOARD *aPcb)
 Function TestForCopperIslandAndRemoveInsulatedIslands Remove insulated copper islands found in m_FilledPolysList. More...
 
bool IsOnCopperLayer () const
 Function IsOnCopperLayer. More...
 
bool CommonLayerExists (const LSET aLayerSet) const
 Function CommonLayerExist Test if this zone shares a common layer with the given layer set. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer) override
 Function SetLayer sets the layer this item is on. More...
 
virtual PCB_LAYER_ID GetLayer () const override
 Function GetLayer returns the primary layer this item is on. More...
 
virtual bool IsOnLayer (PCB_LAYER_ID) const override
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
void SetFillMode (int aFillMode)
 How to fill areas: 0 = use filled polygons, 1 => fill with segments. More...
 
int GetFillMode () const
 
void SetThermalReliefGap (int aThermalReliefGap)
 
int GetThermalReliefGap (D_PAD *aPad=NULL) const
 
void SetThermalReliefCopperBridge (int aThermalReliefCopperBridge)
 
int GetThermalReliefCopperBridge (D_PAD *aPad=NULL) const
 
void SetArcSegmentCount (int aArcSegCount)
 
int GetArcSegmentCount () const
 
bool IsFilled () const
 
void SetIsFilled (bool isFilled)
 
int GetZoneClearance () const
 
void SetZoneClearance (int aZoneClearance)
 
ZoneConnection GetPadConnection (D_PAD *aPad=NULL) const
 
void SetPadConnection (ZoneConnection aPadConnection)
 
int GetMinThickness () const
 
void SetMinThickness (int aMinThickness)
 
int GetSelectedCorner () const
 
void SetSelectedCorner (int aCorner)
 
void SetSelectedCorner (const wxPoint &aPosition)
 
int GetLocalFlags () const
 
void SetLocalFlags (int aFlags)
 
std::vector< SEGMENT > & FillSegments ()
 
const std::vector< SEGMENT > & FillSegments () const
 
SHAPE_POLY_SETOutline ()
 
const SHAPE_POLY_SETOutline () const
 
void SetOutline (SHAPE_POLY_SET *aOutline)
 
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. More...
 
bool HitTestInsideZone (const wxPoint &aPosition) const
 Function HitTest tests if a point is inside the zone area, i.e. More...
 
bool HitTestFilledArea (const wxPoint &aRefPos) const
 Function HitTestFilledArea tests if the given wxPoint is within the bounds of a filled area of this zone. More...
 
void TransformSolidAreasShapesToPolygonSet (SHAPE_POLY_SET &aCornerBuffer, int aCircleToSegmentsCount, double aCorrectionFactor) const
 Function TransformSolidAreasShapesToPolygonSet Convert solid areas full shapes to polygon set (the full shape is the polygon area with a thick outline) Used in 3D view Arcs (ends of segments) are approximated by segments. More...
 
bool BuildFilledSolidAreasPolygons (BOARD *aPcb, SHAPE_POLY_SET *aOutlineBuffer=NULL)
 Build the filled solid areas polygons from zone outlines (stored in m_Poly) The solid areas can be more than one on copper layers, and do not have holes ( holes are linked by overlapping segments to the main outline) in order to have drawable (and plottable) filled polygons. More...
 
void AddClearanceAreasPolygonsToPolysList (BOARD *aPcb)
 Function AddClearanceAreasPolygonsToPolysList Add non copper areas polygons (pads and tracks with clearance) to a filled copper area used in BuildFilledSolidAreasPolygons when calculating filled areas in a zone Non copper areas are pads and track and their clearance area The filled copper area must be computed before BuildFilledSolidAreasPolygons() call this function just after creating the filled copper area polygon (without clearance areas. More...
 
void AddClearanceAreasPolygonsToPolysList_NG (BOARD *aPcb)
 Function AddClearanceAreasPolygonsToPolysList Supports a min thickness area constraint. More...
 
void TransformOutlinesShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aMinClearanceValue, bool aUseNetClearance)
 Function TransformOutlinesShapeWithClearanceToPolygon Convert the outlines shape to a polygon with no holes inflated (optional) by max( aClearanceValue, the zone clearance) (holes are linked to external outline by overlapping segments) Used in filling zones calculations Circles (vias) and arcs (ends of tracks) are approximated by segments. More...
 
bool HitTestForCorner (const wxPoint &refPos, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
 Function HitTestForCorner tests if the given wxPoint is near a corner. More...
 
bool HitTestForCorner (const wxPoint &refPos) const
 Function HitTestForCorner tests if the given wxPoint is near a corner. More...
 
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. More...
 
bool HitTestForEdge (const wxPoint &refPos) const
 Function HitTestForEdge tests if the given wxPoint is near a segment defined by 2 corners. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const override
 
bool FillZoneAreasWithSegments ()
 Function FillZoneAreasWithSegments Fill sub areas in a zone with segments with m_ZoneMinThickness width A scan is made line per line, on the whole filled areas, with a step of m_ZoneMinThickness. More...
 
bool UnFill ()
 Function UnFill Removes the zone filling. More...
 
void Move (const wxPoint &offset) override
 Function Move Move the outlines. More...
 
void MoveEdge (const wxPoint &offset, int aEdge)
 Function MoveEdge Move the outline Edge. More...
 
void Rotate (const wxPoint &centre, double angle) override
 Function Rotate Move the outlines. More...
 
virtual void Flip (const wxPoint &aCentre) override
 Function Flip Flip this object, i.e. More...
 
void Mirror (const wxPoint &mirror_ref)
 Function Mirror Mirror the outlines , relative to a given horizontal axis the layer is not changed. More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
int GetNumCorners (void) const
 Access to m_Poly parameters. More...
 
SHAPE_POLY_SET::ITERATOR Iterate ()
 Function Iterate returns an iterator to visit all points of the zone's main outline without holes. More...
 
SHAPE_POLY_SET::ITERATOR IterateWithHoles ()
 Function IterateWithHoles returns an iterator to visit all points of the zone's main outline with holes. More...
 
SHAPE_POLY_SET::CONST_ITERATOR CIterateWithHoles () const
 Function CIterateWithHoles returns an iterator to visit all points of the zone's main outline with holes. More...
 
void RemoveAllContours (void)
 
const VECTOR2IGetCornerPosition (int aCornerIndex) const
 
void SetCornerPosition (int aCornerIndex, wxPoint new_pos)
 
void NewHole ()
 Function NewHole creates a new hole on the zone; i.e., a new contour on the zone's outline. More...
 
bool AppendCorner (wxPoint aPosition, int aHoleIdx, bool aAllowDuplication=false)
 Add a new corner to the zone outline (to the main outline or a hole) More...
 
HATCH_STYLE GetHatchStyle () const
 
void SetHatchStyle (HATCH_STYLE aStyle)
 
bool IsSame (const ZONE_CONTAINER &aZoneToCompare)
 Function IsSame tests if 2 zones are equivalent: 2 zones are equivalent if they have same parameters and same outlines info, filling is not taken into account. More...
 
void ClearFilledPolysList ()
 Function ClearFilledPolysList clears the list of filled polygons. More...
 
const SHAPE_POLY_SETGetFilledPolysList () const
 Function GetFilledPolysList returns a reference to the list of filled polygons. More...
 
void AddFilledPolysList (SHAPE_POLY_SET &aPolysList)
 Function AddFilledPolysList sets the list of filled polygons. More...
 
SHAPE_POLY_SETGetSmoothedPoly () const
 Function GetSmoothedPoly returns a pointer to the corner-smoothed version of m_Poly if it exists, otherwise it returns m_Poly. More...
 
void SetCornerSmoothingType (int aType)
 
int GetCornerSmoothingType () const
 
void SetCornerRadius (unsigned int aRadius)
 
unsigned int GetCornerRadius () const
 
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 hole inside the main outline More...
 
void AddFilledPolygon (SHAPE_POLY_SET &aPolygon)
 add a polygon to the zone filled areas list. More...
 
void AddFillSegments (std::vector< SEGMENT > &aSegments)
 
SHAPE_POLY_SETRawPolysList ()
 
wxString GetSelectMenuText () const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
bool GetIsKeepout () const
 Accessors to parameters used in Keepout zones: More...
 
bool GetDoNotAllowCopperPour () const
 
bool GetDoNotAllowVias () const
 
bool GetDoNotAllowTracks () const
 
void SetIsKeepout (bool aEnable)
 
void SetDoNotAllowCopperPour (bool aEnable)
 
void SetDoNotAllowVias (bool aEnable)
 
void SetDoNotAllowTracks (bool aEnable)
 
int GetHatchPitch () const
 Hatch related methods. More...
 
void SetHatch (int aHatchStyle, int aHatchPitch, bool aRebuildHatch)
 Function SetHatch sets all hatch parameters for the zone. More...
 
void SetHatchPitch (int aPitch)
 Function SetHatchPitch sets the hatch pitch parameter for the zone. More...
 
void UnHatch ()
 Function UnHatch clears the zone's hatch. More...
 
void Hatch ()
 Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's attribute m_HatchLines. More...
 
const std::vector< SEG > & GetHatchLines () const
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
bool IsConnected () const override
 > More...
 
NETINFO_ITEMGetNet () const
 Function GetNet Returns NET_INFO object for a given item. More...
 
void SetNet (NETINFO_ITEM *aNetInfo)
 Function SetNet Sets a NET_INFO object for the item. More...
 
int GetNetCode () const
 Function GetNetCode. More...
 
bool SetNetCode (int aNetCode, bool aNoAssert=false)
 Function SetNetCode sets net using a net code. More...
 
const wxString & GetNetname () const
 Function GetNetname. More...
 
const wxString & GetShortNetname () const
 Function GetShortNetname. More...
 
std::shared_ptr< NETCLASSGetNetClass () const
 Function GetNetClass returns the NETCLASS for this item. More...
 
wxString GetNetClassName () const
 Function GetNetClassName returns a pointer to the netclass of the zone. More...
 
void SetLocalRatsnestVisible (bool aVisible)
 
bool GetLocalRatsnestVisible () const
 
virtual const wxPoint GetCenter () const
 Function GetCenter() More...
 
BOARD_ITEMNext () const
 
BOARD_ITEMBack () const
 
BOARD_ITEM_CONTAINERGetParent () const
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
virtual void UnLink ()
 Function UnLink detaches this object from its owner. More...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre)
 
virtual BOARDGetBoard () const
 Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Function GetLayerName returns the name of the PCB layer on which the item resides. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (time_t aNewTimeStamp)
 
time_t GetTimeStamp () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static int GetDefaultHatchPitch ()
 Function GetDefaultHatchPitchMils. More...
 
static bool ClassOf (const EDA_ITEM *aItem)
 
static wxString ShowShape (STROKE_T aShape)
 Function ShowShape converts the enum STROKE_T integer value to a wxString. More...
 
static std::string FormatInternalUnits (int aValue)
 Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file. More...
 
static std::string FormatInternalUnits (const wxPoint &aPoint)
 
static std::string FormatInternalUnits (const wxSize &aSize)
 
static std::string FormatAngle (double aAngle)
 Function FormatAngle converts aAngle from board units to a string appropriate for writing to file. More...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Static Public Attributes

static wxPoint ZeroOffset
 A value of wxPoint(0,0) which can be passed to the Draw() functions. More...
 

Protected Member Functions

bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Static Protected Member Functions

static int getTrailingInt (wxString aStr)
 
static int getNextNumberInSequence (const std::set< int > &aSeq, bool aFillSequenceGaps)
 

Protected Attributes

NETINFO_ITEMm_netinfo
 Stores all informations about the net that item belongs to. More...
 
PCB_LAYER_ID m_Layer
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
time_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

void buildFeatureHoleList (BOARD *aPcb, SHAPE_POLY_SET &aFeatures)
 

Private Attributes

SHAPE_POLY_SETm_Poly
 Outline of the zone. More...
 
SHAPE_POLY_SETm_smoothedPoly
 
int m_cornerSmoothingType
 
unsigned int m_cornerRadius
 
LSET m_layerSet
 
unsigned m_priority
 
bool m_isKeepout
 
bool m_doNotAllowCopperPour
 
bool m_doNotAllowVias
 
bool m_doNotAllowTracks
 
ZoneConnection m_PadConnection
 
int m_ZoneClearance
 Clearance value in internal units. More...
 
int m_ZoneMinThickness
 Minimum thickness value in filled areas. More...
 
int m_ArcToSegmentsCount
 The number of segments to convert a circle to a polygon. More...
 
bool m_IsFilled
 True when a zone was filled, false after deleting the filled areas. More...
 
int m_ThermalReliefGap
 Width of the copper bridge in thermal reliefs. More...
 
int m_ThermalReliefCopperBridge
 
int m_FillMode
 How to fill areas: 0 => use filled polygons, 1 => fill with segments. More...
 
SHAPE_POLY_SET::VERTEX_INDEXm_CornerSelection
 The index of the corner being moved or nullptr if no corner is selected. More...
 
int m_localFlgs
 Variable used in polygon calculations. More...
 
std::vector< SEGMENTm_FillSegmList
 Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used. More...
 
SHAPE_POLY_SET m_FilledPolysList
 
SHAPE_POLY_SET m_RawPolysList
 
HATCH_STYLE m_hatchStyle
 
int m_hatchPitch
 
std::vector< SEGm_HatchLines
 

Detailed Description

Class ZONE_CONTAINER handles a list of polygons defining a copper zone.

A zone is described by a main polygon, a time stamp, a layer, and a net name. Other polygons inside the main polygon are holes in the zone.

Definition at line 78 of file class_zone.h.

Member Typedef Documentation

Member Enumeration Documentation

Zone hatch styles.

Enumerator
NO_HATCH 
DIAGONAL_FULL 
DIAGONAL_EDGE 

Definition at line 85 of file class_zone.h.

Constructor & Destructor Documentation

ZONE_CONTAINER::ZONE_CONTAINER ( BOARD parent)

Definition at line 53 of file class_zone.cpp.

References ZONE_SETTINGS::ExportSetting(), BOARD::GetZoneSettings(), m_cornerRadius, m_CornerSelection, m_cornerSmoothingType, m_FillMode, m_IsFilled, m_Poly, m_priority, m_smoothedPoly, SetDoNotAllowCopperPour(), SetDoNotAllowTracks(), SetDoNotAllowVias(), SetIsKeepout(), SetLocalFlags(), and ZONE_SETTINGS::SMOOTHING_NONE.

Referenced by Clone().

53  :
55 {
56  m_CornerSelection = nullptr; // no corner is selected
57  m_IsFilled = false; // fill status : true when the zone is filled
58  m_FillMode = 0; // How to fill areas: 0 = use filled polygons, != 0 fill with segments
59  m_priority = 0;
60  m_smoothedPoly = NULL;
62  SetIsKeepout( false );
63  SetDoNotAllowCopperPour( false ); // has meaning only if m_isKeepout == true
64  SetDoNotAllowVias( true ); // has meaning only if m_isKeepout == true
65  SetDoNotAllowTracks( true ); // has meaning only if m_isKeepout == true
66  m_cornerRadius = 0;
67  SetLocalFlags( 0 ); // flags tempoarry used in zone calculations
68  m_Poly = new SHAPE_POLY_SET(); // Outlines
69  aBoard->GetZoneSettings().ExportSetting( *this );
70 }
void SetDoNotAllowTracks(bool aEnable)
Definition: class_zone.h:680
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:788
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
void SetDoNotAllowVias(bool aEnable)
Definition: class_zone.h:679
SHAPE_POLY_SET * m_smoothedPoly
Definition: class_zone.h:742
Class SHAPE_POLY_SET.
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:775
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
unsigned m_priority
Definition: class_zone.h:752
int m_cornerSmoothingType
Definition: class_zone.h:743
unsigned int m_cornerRadius
Definition: class_zone.h:744
void SetDoNotAllowCopperPour(bool aEnable)
Definition: class_zone.h:678
void SetLocalFlags(int aFlags)
Definition: class_zone.h:257
void SetIsKeepout(bool aEnable)
Definition: class_zone.h:677
ZONE_CONTAINER::ZONE_CONTAINER ( const ZONE_CONTAINER aZone)

Definition at line 73 of file class_zone.cpp.

References SHAPE_POLY_SET::Append(), GetLayerSet(), GetLocalFlags(), BOARD_CONNECTED_ITEM::GetNetCode(), m_ArcToSegmentsCount, m_cornerRadius, m_CornerSelection, m_cornerSmoothingType, m_doNotAllowCopperPour, m_doNotAllowTracks, m_doNotAllowVias, m_FilledPolysList, m_FillMode, m_FillSegmList, m_HatchLines, m_hatchPitch, m_hatchStyle, m_IsFilled, m_isKeepout, m_PadConnection, m_Poly, m_priority, m_smoothedPoly, m_ThermalReliefCopperBridge, m_ThermalReliefGap, m_ZoneClearance, m_ZoneMinThickness, SetLayerSet(), SetLocalFlags(), and BOARD_CONNECTED_ITEM::SetNetCode().

73  :
74  BOARD_CONNECTED_ITEM( aZone )
75 {
76  m_smoothedPoly = NULL;
77 
78  // Should the copy be on the same net?
79  SetNetCode( aZone.GetNetCode() );
80  m_Poly = new SHAPE_POLY_SET( *aZone.m_Poly );
81 
82  // For corner moving, corner index to drag, or nullptr if no selection
83  m_CornerSelection = nullptr;
84  m_IsFilled = aZone.m_IsFilled;
85  m_ZoneClearance = aZone.m_ZoneClearance; // clearance value
87  m_FillMode = aZone.m_FillMode; // Filling mode (segments/polygons)
88  m_priority = aZone.m_priority;
94  m_FillSegmList = aZone.m_FillSegmList; // vector <> copy
95 
96  m_isKeepout = aZone.m_isKeepout;
100 
103 
104  m_hatchStyle = aZone.m_hatchStyle;
105  m_hatchPitch = aZone.m_hatchPitch;
106  m_HatchLines = aZone.m_HatchLines;
107 
108  SetLayerSet( aZone.GetLayerSet() );
109  SetLocalFlags( aZone.GetLocalFlags() );
110 }
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:767
bool m_doNotAllowTracks
Definition: class_zone.h:764
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:788
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
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:237
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:217
SHAPE_POLY_SET * m_smoothedPoly
Definition: class_zone.h:742
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:772
int m_ThermalReliefCopperBridge
Definition: class_zone.h:781
std::vector< SEG > m_HatchLines
Definition: class_zone.h:811
ZoneConnection m_PadConnection
Definition: class_zone.h:766
Class SHAPE_POLY_SET.
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:775
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
unsigned m_priority
Definition: class_zone.h:752
bool m_doNotAllowVias
Definition: class_zone.h:763
int m_cornerSmoothingType
Definition: class_zone.h:743
bool SetNetCode(int aNetCode, bool aNoAssert=false)
Function SetNetCode sets net using a net code.
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
unsigned int m_cornerRadius
Definition: class_zone.h:744
int GetNetCode() const
Function GetNetCode.
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:809
bool m_doNotAllowCopperPour
Definition: class_zone.h:762
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:778
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
int GetLocalFlags() const
Definition: class_zone.h:256
void SetLocalFlags(int aFlags)
Definition: class_zone.h:257
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
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) ...
ZONE_CONTAINER::~ZONE_CONTAINER ( )

Definition at line 143 of file class_zone.cpp.

References m_CornerSelection, m_Poly, and m_smoothedPoly.

144 {
145  delete m_Poly;
146  delete m_smoothedPoly;
147  delete m_CornerSelection;
148 }
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:788
SHAPE_POLY_SET * m_smoothedPoly
Definition: class_zone.h:742
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741

Member Function Documentation

void ZONE_CONTAINER::AddClearanceAreasPolygonsToPolysList ( BOARD aPcb)

Function AddClearanceAreasPolygonsToPolysList Add non copper areas polygons (pads and tracks with clearance) to a filled copper area used in BuildFilledSolidAreasPolygons when calculating filled areas in a zone Non copper areas are pads and track and their clearance area The filled copper area must be computed before BuildFilledSolidAreasPolygons() call this function just after creating the filled copper area polygon (without clearance areas.

Parameters
aPcbthe current board _NG version uses SHAPE_POLY_SET instead of Boost.Polygon

Definition at line 585 of file zones_convert_brd_items_to_polygons_with_Boost.cpp.

586 {
587 }
void ZONE_CONTAINER::AddClearanceAreasPolygonsToPolysList_NG ( BOARD aPcb)

Function AddClearanceAreasPolygonsToPolysList Supports a min thickness area constraint.

Add non copper areas polygons (pads and tracks with clearance) to the filled copper area found in BuildFilledPolysListData after calculating filled areas in a zone Non filled copper areas are pads and track and their clearance areas The filled copper area must be computed just before. BuildFilledPolysListData() call this function just after creating the filled copper area polygon (without clearance areas) to do that this function: 1 - Creates the main outline (zone outline) using a correction to shrink the resulting area with m_ZoneMinThickness/2 value. The result is areas with a margin of m_ZoneMinThickness/2 When drawing outline with segments having a thickness of m_ZoneMinThickness, the outlines will match exactly the initial outlines 3 - Add all non filled areas (pads, tracks) in group B with a clearance of m_Clearance + m_ZoneMinThickness/2 in a buffer

  • If Thermal shapes are wanted, add non filled area, in order to create these thermal shapes 4 - calculates the polygon A - B 5 - put resulting list of polygons (filled areas) in m_FilledPolysList This zone contains pads with the same net. 6 - Remove insulated copper islands 7 - If Thermal shapes are wanted, remove unconnected stubs in thermal shapes: creates a buffer of polygons corresponding to stubs to remove sub them to the filled areas. Remove new insulated copper islands

Definition at line 479 of file zones_convert_brd_items_to_polygons_with_Boost.cpp.

References ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF, ARC_APPROX_SEGMENTS_COUNT_LOW_DEF, SHAPE_POLY_SET::BooleanSubtract(), buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), SHAPE_POLY_SET::Fracture(), BOARD_CONNECTED_ITEM::GetNetCode(), SHAPE_POLY_SET::Inflate(), SHAPE_FILE_IO::IOM_APPEND, SHAPE_POLY_SET::IsEmpty(), m_ArcToSegmentsCount, m_FilledPolysList, m_RawPolysList, m_smoothedPoly, m_ZoneMinThickness, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, POLY_CALC_MODE, CPOLYGONS_LIST::RemoveAllContours(), s_DumpZonesWhenFilling, s_thermalRot, SHAPE_POLY_SET::Simplify(), and TestForCopperIslandAndRemoveInsulatedIslands().

Referenced by BuildFilledSolidAreasPolygons().

480 {
481  int segsPerCircle;
482  double correctionFactor;
483  int outline_half_thickness = m_ZoneMinThickness / 2;
484 
485 
486  std::unique_ptr<SHAPE_FILE_IO> dumper( new SHAPE_FILE_IO(
487  s_DumpZonesWhenFilling ? "zones_dump.txt" : "", SHAPE_FILE_IO::IOM_APPEND ) );
488 
489  // Set the number of segments in arc approximations
491  segsPerCircle = ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF;
492  else
493  segsPerCircle = ARC_APPROX_SEGMENTS_COUNT_LOW_DEF;
494 
495  /* calculates the coeff to compensate radius reduction of holes clearance
496  * due to the segment approx.
497  * For a circle the min radius is radius * cos( 2PI / s_CircleToSegmentsCount / 2)
498  * s_Correction is 1 /cos( PI/s_CircleToSegmentsCount )
499  */
500  correctionFactor = 1.0 / cos( M_PI / (double) segsPerCircle );
501 
502  CPOLYGONS_LIST tmp;
503 
505  dumper->BeginGroup("clipper-zone");
506 
507  SHAPE_POLY_SET solidAreas = *m_smoothedPoly;
508 
509  solidAreas.Inflate( -outline_half_thickness, segsPerCircle );
510  solidAreas.Simplify( POLY_CALC_MODE );
511 
512  SHAPE_POLY_SET holes;
513 
515  dumper->Write( &solidAreas, "solid-areas" );
516 
517  tmp.RemoveAllContours();
518  buildFeatureHoleList( aPcb, holes );
519 
521  dumper->Write( &holes, "feature-holes" );
522 
523  holes.Simplify( POLY_CALC_MODE );
524 
526  dumper->Write( &holes, "feature-holes-postsimplify" );
527 
528  // Generate the filled areas (currently, without thermal shapes, which will
529  // be created later).
530  // Use SHAPE_POLY_SET::PM_STRICTLY_SIMPLE to generate strictly simple polygons
531  // needed by Gerber files and Fracture()
533 
535  dumper->Write( &solidAreas, "solid-areas-minus-holes" );
536 
537  SHAPE_POLY_SET areas_fractured = solidAreas;
538  areas_fractured.Fracture( POLY_CALC_MODE );
539 
541  dumper->Write( &areas_fractured, "areas_fractured" );
542 
543  m_FilledPolysList = areas_fractured;
544 
545  SHAPE_POLY_SET thermalHoles;
546 
547  // Test thermal stubs connections and add polygons to remove unconnected stubs.
548  // (this is a refinement for thermal relief shapes)
549  if( GetNetCode() > 0 )
550  BuildUnconnectedThermalStubsPolygonList( thermalHoles, aPcb, this,
551  correctionFactor, s_thermalRot );
552 
553  // remove copper areas corresponding to not connected stubs
554  if( !thermalHoles.IsEmpty() )
555  {
556  thermalHoles.Simplify( POLY_CALC_MODE );
557  // Remove unconnected stubs. Use SHAPE_POLY_SET::PM_STRICTLY_SIMPLE to
558  // generate strictly simple polygons
559  // needed by Gerber files and Fracture()
560  solidAreas.BooleanSubtract( thermalHoles, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
561 
563  dumper->Write( &thermalHoles, "thermal-holes" );
564 
565  // put these areas in m_FilledPolysList
566  SHAPE_POLY_SET th_fractured = solidAreas;
567  th_fractured.Fracture( POLY_CALC_MODE );
568 
570  dumper->Write ( &th_fractured, "th_fractured" );
571 
572  m_FilledPolysList = th_fractured;
573 
574  }
575 
577 
578  if( GetNetCode() > 0 )
580 
582  dumper->EndGroup();
583 }
#define ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF
Definition: pcbnew.h:42
Class SHAPE_FILE_IO.
Definition: shape_file_io.h:38
#define ARC_APPROX_SEGMENTS_COUNT_LOW_DEF
Definition: pcbnew.h:41
void buildFeatureHoleList(BOARD *aPcb, SHAPE_POLY_SET &aFeatures)
SHAPE_POLY_SET m_RawPolysList
Definition: class_zone.h:807
SHAPE_POLY_SET * m_smoothedPoly
Definition: class_zone.h:742
static const bool s_DumpZonesWhenFilling
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:772
void Inflate(int aFactor, int aCircleSegmentsCount)
Performs outline inflation/deflation, using round corners.
void TestForCopperIslandAndRemoveInsulatedIslands(BOARD *aPcb)
Function TestForCopperIslandAndRemoveInsulatedIslands Remove insulated copper islands found in m_Fill...
Class SHAPE_POLY_SET.
void Simplify(POLYGON_MODE aFastMode)
Simplifies the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFast...
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
void Fracture(POLYGON_MODE aFastMode)
Converts a set of polygons with holes to a singe outline with "slits"/"fractures" connecting the oute...
int GetNetCode() const
Function GetNetCode.
void BuildUnconnectedThermalStubsPolygonList(SHAPE_POLY_SET &aCornerBuffer, BOARD *aPcb, ZONE_CONTAINER *aZone, double aArcCorrection, double aRoundPadThermalRotation)
Function BuildUnconnectedThermalStubsPolygonList Creates a set of polygons corresponding to stubs cre...
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
void RemoveAllContours(void)
Definition: PolyLine.h:143
void BooleanSubtract(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Performs boolean polyset difference For aFastMode meaning, see function booleanOp ...
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
CPOLYGONS_LIST handle a list of contours (polygons corners).
Definition: PolyLine.h:114
void ZONE_CONTAINER::AddFilledPolygon ( SHAPE_POLY_SET aPolygon)
inline

add a polygon to the zone filled areas list.

these polygons have no hole, therefore any added polygon is a new filled area

Definition at line 648 of file class_zone.h.

References SHAPE_POLY_SET::Append(), and m_FilledPolysList.

649  {
650  m_FilledPolysList.Append( aPolygon );
651  }
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
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) ...
void ZONE_CONTAINER::AddFilledPolysList ( SHAPE_POLY_SET aPolysList)
inline

Function AddFilledPolysList sets the list of filled polygons.

Definition at line 609 of file class_zone.h.

References m_FilledPolysList.

Referenced by PlotSolderMaskLayer().

610  {
611  m_FilledPolysList = aPolysList;
612  }
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
void ZONE_CONTAINER::AddFillSegments ( std::vector< SEGMENT > &  aSegments)
inline

Definition at line 653 of file class_zone.h.

References m_FillSegmList.

654  {
655  m_FillSegmList.insert( m_FillSegmList.end(), aSegments.begin(), aSegments.end() );
656  }
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
void ZONE_CONTAINER::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 hole inside the main outline

Definition at line 1009 of file class_zone.cpp.

References SHAPE_POLY_SET::AddHole(), SHAPE_POLY_SET::AddOutline(), SHAPE_LINE_CHAIN::Append(), m_Poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::SetClosed().

1010 {
1011  if( aPolygon.empty() )
1012  return;
1013 
1014  SHAPE_LINE_CHAIN outline;
1015 
1016  // Create an outline and populate it with the points of aPolygon
1017  for( unsigned i = 0; i < aPolygon.size(); i++ )
1018  {
1019  outline.Append( VECTOR2I( aPolygon[i] ) );
1020  }
1021 
1022  outline.SetClosed( true );
1023 
1024  // Add the outline as a new polygon in the polygon set
1025  if( m_Poly->OutlineCount() == 0 )
1026  m_Poly->AddOutline( outline );
1027  else
1028  m_Poly->AddHole( outline );
1029 }
int OutlineCount() const
Returns the number of outlines in the set
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
void Append(int aX, int aY, bool aAllowDuplication=false)
Function Append()
void SetClosed(bool aClosed)
Function SetClosed()
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
int AddHole(const SHAPE_LINE_CHAIN &aHole, int aOutline=-1)
Adds a new hole to the given outline (default: last) and returns its index
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new outline to the set and returns its index
Class SHAPE_LINE_CHAIN.
bool ZONE_CONTAINER::AppendCorner ( wxPoint  aPosition,
int  aHoleIdx,
bool  aAllowDuplication = false 
)

Add a new corner to the zone outline (to the main outline or a hole)

Parameters
aPositionis the position of the new corner.
aHoleIdxis the index of the hole (-1 for the main outline, >= 0 for hole).
aAllowDuplicationis a flag to indicate whether it is allowed to add this corner even if it is duplicated.
Returns
true if the corner was added, false if error (aHoleIdx > hole count -1)

Definition at line 1032 of file class_zone.cpp.

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::HoleCount(), m_Poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::OutlineCount(), wxPoint::x, and wxPoint::y.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCB_EDIT_FRAME::Begin_Zone(), BOARD::InsertArea(), EAGLE_PLUGIN::loadPlain(), and EAGLE_PLUGIN::loadSignals().

1033 {
1034  // Ensure the main outline exists:
1035  if( m_Poly->OutlineCount() == 0 )
1036  m_Poly->NewOutline();
1037 
1038  // If aHoleIdx >= 0, the corner musty be added to the hole, index aHoleIdx.
1039  // (remember: the index of the first hole is 0)
1040  // Return error if if does dot exist.
1041  if( aHoleIdx >= m_Poly->HoleCount( 0 ) )
1042  return false;
1043 
1044  m_Poly->Append( aPosition.x, aPosition.y, -1, aHoleIdx, aAllowDuplication );
1045 
1046  return true;
1047 }
int HoleCount(int aOutline) const
Returns the number of holes in a given outline
int OutlineCount() const
Returns the number of outlines in the set
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
int NewOutline()
Creates a new empty polygon in the set and returns its index
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) ...
BOARD_ITEM* BOARD_ITEM::Back ( ) const
inlineinherited

Definition at line 117 of file class_board_item.h.

References EDA_ITEM::Pback.

Referenced by PCB_EDIT_FRAME::Delete_Segment_Edge(), and SwapItemData().

117 { return static_cast<BOARD_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:179
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
void ZONE_CONTAINER::buildFeatureHoleList ( BOARD aPcb,
SHAPE_POLY_SET aFeatures 
)
private

Definition at line 100 of file zones_convert_brd_items_to_polygons_with_Boost.cpp.

References SHAPE_POLY_SET::Append(), ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF, ARC_APPROX_SEGMENTS_COUNT_LOW_DEF, BuildConvexHull(), CommonLayerExists(), CreateThermalReliefPadPolygon(), CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL, BOARD::Drawings(), Edge_Cuts, BOARD::GetArea(), BOARD::GetAreaCount(), BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), BOARD_ITEM::GetBoard(), GetBoundingBox(), GetClearance(), D_PAD::GetClearance(), BOARD::GetDesignSettings(), GetDoNotAllowCopperPour(), GetIsKeepout(), GetLayer(), GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetCode(), GetPadConnection(), GetPriority(), GetThermalReliefCopperBridge(), GetThermalReliefGap(), GetZoneClearance(), EDA_RECT::Inflate(), SHAPE_POLY_SET::Inflate(), EDA_RECT::Intersects(), KiROUND(), m_ArcToSegmentsCount, BOARD::m_Modules, BOARD::m_Track, m_ZoneMinThickness, max, SHAPE_POLY_SET::NewOutline(), TRACK::Next(), BOARD_ITEM::Next(), MODULE::Next(), D_PAD::Next(), PAD_ATTRIB_STANDARD, PAD_DRILL_SHAPE_OBLONG, PAD_SHAPE_CIRCLE, PAD_SHAPE_CUSTOM, PAD_SHAPE_OVAL, PAD_ZONE_CONN_NONE, PAD_ZONE_CONN_THERMAL, PAD_ZONE_CONN_THT_THERMAL, PCB_LINE_T, PCB_MODULE_EDGE_T, PCB_TEXT_T, SHAPE_POLY_SET::RemoveAllContours(), s_thermalRot, D_PAD::SetOrientation(), D_PAD::SetPosition(), D_PAD::SetShape(), D_PAD::SetSize(), and TransformOutlinesShapeWithClearanceToPolygon().

Referenced by AddClearanceAreasPolygonsToPolysList_NG().

101 {
102  int segsPerCircle;
103  double correctionFactor;
104 
105  // Set the number of segments in arc approximations
107  segsPerCircle = ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF;
108  else
109  segsPerCircle = ARC_APPROX_SEGMENTS_COUNT_LOW_DEF;
110 
111  /* calculates the coeff to compensate radius reduction of holes clearance
112  * due to the segment approx.
113  * For a circle the min radius is radius * cos( 2PI / s_CircleToSegmentsCount / 2)
114  * s_Correction is 1 /cos( PI/s_CircleToSegmentsCount )
115  */
116  correctionFactor = 1.0 / cos( M_PI / (double) segsPerCircle );
117 
118  aFeatures.RemoveAllContours();
119 
120  int outline_half_thickness = m_ZoneMinThickness / 2;
121 
122  // When removing holes, the holes must be expanded by outline_half_thickness
123  // to take in account the thickness of the zone outlines
124  int zone_clearance = GetClearance() + outline_half_thickness;
125 
126  // When holes are created by non copper items (edge cut items), use only
127  // the m_ZoneClearance parameter (zone clearance with no netclass clearance)
128  int zone_to_edgecut_clearance = GetZoneClearance() + outline_half_thickness;
129 
130  /* store holes (i.e. tracks and pads areas as polygons outlines)
131  * in a polygon list
132  */
133 
134  /* items ouside the zone bounding box are skipped
135  * the bounding box is the zone bounding box + the biggest clearance found in Netclass list
136  */
137  EDA_RECT item_boundingbox;
138  EDA_RECT zone_boundingbox = GetBoundingBox();
139  int biggest_clearance = aPcb->GetDesignSettings().GetBiggestClearanceValue();
140  biggest_clearance = std::max( biggest_clearance, zone_clearance );
141  zone_boundingbox.Inflate( biggest_clearance );
142 
143  /*
144  * First : Add pads. Note: pads having the same net as zone are left in zone.
145  * Thermal shapes will be created later if necessary
146  */
147 
148  /* Use a dummy pad to calculate hole clearance when a pad is not on all copper layers
149  * and this pad has a hole
150  * This dummy pad has the size and shape of the hole
151  * Therefore, this dummy pad is a circle or an oval.
152  * A pad must have a parent because some functions expect a non null parent
153  * to find the parent board, and some other data
154  */
155  MODULE dummymodule( aPcb ); // Creates a dummy parent
156  D_PAD dummypad( &dummymodule );
157 
158  for( MODULE* module = aPcb->m_Modules; module; module = module->Next() )
159  {
160  D_PAD* nextpad;
161 
162  for( D_PAD* pad = module->PadsList(); pad != NULL; pad = nextpad )
163  {
164  nextpad = pad->Next(); // pad pointer can be modified by next code, so
165  // calculate the next pad here
166 
167  if( !pad->IsOnLayer( GetLayer() ) )
168  {
169  /* Test for pads that are on top or bottom only and have a hole.
170  * There are curious pads but they can be used for some components that are
171  * inside the board (in fact inside the hole. Some photo diodes and Leds are
172  * like this)
173  */
174  if( pad->GetDrillSize().x == 0 && pad->GetDrillSize().y == 0 )
175  continue;
176 
177  // Use a dummy pad to calculate a hole shape that have the same dimension as
178  // the pad hole
179  dummypad.SetSize( pad->GetDrillSize() );
180  dummypad.SetOrientation( pad->GetOrientation() );
181  dummypad.SetShape( pad->GetDrillShape() == PAD_DRILL_SHAPE_OBLONG ?
183  dummypad.SetPosition( pad->GetPosition() );
184 
185  pad = &dummypad;
186  }
187 
188  // Note: netcode <=0 means not connected item
189  if( ( pad->GetNetCode() != GetNetCode() ) || ( pad->GetNetCode() <= 0 ) )
190  {
191  int item_clearance = pad->GetClearance() + outline_half_thickness;
192  item_boundingbox = pad->GetBoundingBox();
193  item_boundingbox.Inflate( item_clearance );
194 
195  if( item_boundingbox.Intersects( zone_boundingbox ) )
196  {
197  int clearance = std::max( zone_clearance, item_clearance );
198 
199  // PAD_SHAPE_CUSTOM can have a specific keepout, to avoid to break the shape
200  if( pad->GetShape() == PAD_SHAPE_CUSTOM &&
201  pad->GetCustomShapeInZoneOpt() == CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL )
202  {
203  // the pad shape in zone can be its convex hull or
204  // the shape itself
205  SHAPE_POLY_SET outline( pad->GetCustomShapeAsPolygon() );
206  outline.Inflate( KiROUND( clearance*correctionFactor) , segsPerCircle );
207  pad->CustomShapeAsPolygonToBoardPosition( &outline,
208  pad->GetPosition(), pad->GetOrientation() );
209 
210  if( pad->GetCustomShapeInZoneOpt() == CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL )
211  {
212  std::vector<wxPoint> convex_hull;
213  BuildConvexHull( convex_hull, outline );
214 
215  aFeatures.NewOutline();
216  for( unsigned ii = 0; ii < convex_hull.size(); ++ii )
217  aFeatures.Append( convex_hull[ii] );
218  }
219  else
220  aFeatures.Append( outline );
221  }
222  else
223  pad->TransformShapeWithClearanceToPolygon( aFeatures,
224  clearance,
225  segsPerCircle,
226  correctionFactor );
227  }
228 
229  continue;
230  }
231 
232  // Pads are removed from zone if the setup is PAD_ZONE_CONN_NONE
233  // or if they have a custom shape, because a thermal relief will break
234  // the shape
235  if( GetPadConnection( pad ) == PAD_ZONE_CONN_NONE ||
236  pad->GetShape() == PAD_SHAPE_CUSTOM )
237  {
238  int gap = zone_clearance;
239  int thermalGap = GetThermalReliefGap( pad );
240  gap = std::max( gap, thermalGap );
241  item_boundingbox = pad->GetBoundingBox();
242  item_boundingbox.Inflate( gap );
243 
244  if( item_boundingbox.Intersects( zone_boundingbox ) )
245  {
246  // PAD_SHAPE_CUSTOM has a specific keepout, to avoid to break the shape
247  // the pad shape in zone can be its convex hull or the shape itself
248  if( pad->GetShape() == PAD_SHAPE_CUSTOM &&
249  pad->GetCustomShapeInZoneOpt() == CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL )
250  {
251  // the pad shape in zone can be its convex hull or
252  // the shape itself
253  SHAPE_POLY_SET outline( pad->GetCustomShapeAsPolygon() );
254  outline.Inflate( KiROUND( gap*correctionFactor) , segsPerCircle );
255  pad->CustomShapeAsPolygonToBoardPosition( &outline,
256  pad->GetPosition(), pad->GetOrientation() );
257 
258  std::vector<wxPoint> convex_hull;
259  BuildConvexHull( convex_hull, outline );
260 
261  aFeatures.NewOutline();
262  for( unsigned ii = 0; ii < convex_hull.size(); ++ii )
263  aFeatures.Append( convex_hull[ii] );
264  }
265  else
266  pad->TransformShapeWithClearanceToPolygon( aFeatures,
267  gap, segsPerCircle, correctionFactor );
268  }
269  }
270  }
271  }
272 
273  /* Add holes (i.e. tracks and vias areas as polygons outlines)
274  * in cornerBufferPolysToSubstract
275  */
276  for( TRACK* track = aPcb->m_Track; track; track = track->Next() )
277  {
278  if( !track->IsOnLayer( GetLayer() ) )
279  continue;
280 
281  if( track->GetNetCode() == GetNetCode() && (GetNetCode() != 0) )
282  continue;
283 
284  int item_clearance = track->GetClearance() + outline_half_thickness;
285  item_boundingbox = track->GetBoundingBox();
286 
287  if( item_boundingbox.Intersects( zone_boundingbox ) )
288  {
289  int clearance = std::max( zone_clearance, item_clearance );
290  track->TransformShapeWithClearanceToPolygon( aFeatures,
291  clearance,
292  segsPerCircle,
293  correctionFactor );
294  }
295  }
296 
297  /* Add module edge items that are on copper layers
298  * Pcbnew allows these items to be on copper layers in microwave applictions
299  * This is a bad thing, but must be handled here, until a better way is found
300  */
301  for( MODULE* module = aPcb->m_Modules; module; module = module->Next() )
302  {
303  for( BOARD_ITEM* item = module->GraphicalItemsList(); item; item = item->Next() )
304  {
305  if( !item->IsOnLayer( GetLayer() ) && !item->IsOnLayer( Edge_Cuts ) )
306  continue;
307 
308  if( item->Type() != PCB_MODULE_EDGE_T )
309  continue;
310 
311  item_boundingbox = item->GetBoundingBox();
312 
313  if( item_boundingbox.Intersects( zone_boundingbox ) )
314  {
315  int zclearance = zone_clearance;
316 
317  if( item->IsOnLayer( Edge_Cuts ) )
318  // use only the m_ZoneClearance, not the clearance using
319  // the netclass value, because we do not have a copper item
320  zclearance = zone_to_edgecut_clearance;
321 
322  ( (EDGE_MODULE*) item )->TransformShapeWithClearanceToPolygon(
323  aFeatures, zclearance, segsPerCircle, correctionFactor );
324  }
325  }
326  }
327 
328  // Add graphic items (copper texts) and board edges
329  // Currently copper texts have no net, so only the zone_clearance
330  // is used.
331  for( auto item : aPcb->Drawings() )
332  {
333  if( item->GetLayer() != GetLayer() && item->GetLayer() != Edge_Cuts )
334  continue;
335 
336  int zclearance = zone_clearance;
337 
338  if( item->GetLayer() == Edge_Cuts )
339  // use only the m_ZoneClearance, not the clearance using
340  // the netclass value, because we do not have a copper item
341  zclearance = zone_to_edgecut_clearance;
342 
343  switch( item->Type() )
344  {
345  case PCB_LINE_T:
346  ( (DRAWSEGMENT*) item )->TransformShapeWithClearanceToPolygon(
347  aFeatures,
348  zclearance, segsPerCircle, correctionFactor );
349  break;
350 
351  case PCB_TEXT_T:
352  ( (TEXTE_PCB*) item )->TransformBoundingBoxWithClearanceToPolygon(
353  aFeatures, zclearance );
354  break;
355 
356  default:
357  break;
358  }
359  }
360 
361  // Add zones outlines having an higher priority and keepout
362  for( int ii = 0; ii < GetBoard()->GetAreaCount(); ii++ )
363  {
364  ZONE_CONTAINER* zone = GetBoard()->GetArea( ii );
365 
366  // If the zones share no common layers
367  if( !CommonLayerExists( zone->GetLayerSet() ) )
368  continue;
369 
370  if( !zone->GetIsKeepout() && zone->GetPriority() <= GetPriority() )
371  continue;
372 
373  if( zone->GetIsKeepout() && ! zone->GetDoNotAllowCopperPour() )
374  continue;
375 
376  // A highter priority zone or keepout area is found: remove this area
377  item_boundingbox = zone->GetBoundingBox();
378 
379  if( !item_boundingbox.Intersects( zone_boundingbox ) )
380  continue;
381 
382  // Add the zone outline area.
383  // However if the zone has the same net as the current zone,
384  // do not add any clearance.
385  // the zone will be connected to the current zone, but filled areas
386  // will use different parameters (clearance, thermal shapes )
387  bool same_net = GetNetCode() == zone->GetNetCode();
388  bool use_net_clearance = true;
389  int min_clearance = zone_clearance;
390 
391  // Do not forget to make room to draw the thick outlines
392  // of the hole created by the area of the zone to remove
393  int holeclearance = zone->GetClearance() + outline_half_thickness;
394 
395  // The final clearance is obviously the max value of each zone clearance
396  min_clearance = std::max( min_clearance, holeclearance );
397 
398  if( zone->GetIsKeepout() || same_net )
399  {
400  // Just take in account the fact the outline has a thickness, so
401  // the actual area to substract is inflated to take in account this fact
402  min_clearance = outline_half_thickness;
403  use_net_clearance = false;
404  }
405 
407  aFeatures, min_clearance, use_net_clearance );
408  }
409 
410  // Remove thermal symbols
411  for( MODULE* module = aPcb->m_Modules; module; module = module->Next() )
412  {
413  for( D_PAD* pad = module->PadsList(); pad != NULL; pad = pad->Next() )
414  {
415  // Rejects non-standard pads with tht-only thermal reliefs
417  && pad->GetAttribute() != PAD_ATTRIB_STANDARD )
418  continue;
419 
422  continue;
423 
424  if( !pad->IsOnLayer( GetLayer() ) )
425  continue;
426 
427  if( pad->GetNetCode() != GetNetCode() )
428  continue;
429 
430  item_boundingbox = pad->GetBoundingBox();
431  int thermalGap = GetThermalReliefGap( pad );
432  item_boundingbox.Inflate( thermalGap, thermalGap );
433 
434  if( item_boundingbox.Intersects( zone_boundingbox ) )
435  {
437  *pad, thermalGap,
440  segsPerCircle,
441  correctionFactor, s_thermalRot );
442  }
443  }
444  }
445 
446 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:78
#define ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF
Definition: pcbnew.h:42
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:201
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:106
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:673
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox (virtual)
Definition: class_zone.cpp:525
int GetBiggestClearanceValue()
Function GetBiggestClearanceValue.
#define ARC_APPROX_SEGMENTS_COUNT_LOW_DEF
Definition: pcbnew.h:41
MODULE * Next() const
Definition: class_module.h:120
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
int GetThermalReliefCopperBridge(D_PAD *aPad=NULL) const
Definition: class_zone.cpp:644
void BuildConvexHull(std::vector< wxPoint > &aResult, const std::vector< wxPoint > &aPoly)
Calculate the convex hull of a list of points in counter-clockwise order.
Definition: convex_hull.cpp:87
void TransformOutlinesShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, int aMinClearanceValue, bool aUseNetClearance)
Function TransformOutlinesShapeWithClearanceToPolygon Convert the outlines shape to a polygon with no...
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
Definition: class_zone.cpp:787
Pads are not covered.
Definition: zones.h:57
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
BOARD_ITEM * Next() const
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:237
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:772
ZoneConnection GetPadConnection(D_PAD *aPad=NULL) const
void Inflate(int aFactor, int aCircleSegmentsCount)
Performs outline inflation/deflation, using round corners.
Class SHAPE_POLY_SET.
int GetThermalReliefGap(D_PAD *aPad=NULL) const
Definition: class_zone.cpp:635
D_PAD * Next() const
Definition: class_pad.h:160
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
void SetSize(const wxSize &aSize)
Definition: class_pad.h:268
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1011
int NewOutline()
Creates a new empty polygon in the set and returns its index
Thermal relief only for THT pads.
Definition: zones.h:60
int GetNetCode() const
Function GetNetCode.
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
TRACK * Next() const
Definition: class_track.h:100
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:982
#define max(a, b)
Definition: auxiliary.h:86
DLIST< MODULE > m_Modules
Definition: class_board.h:245
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
Class EDA_RECT handles the component boundary box.
Usual pad.
Definition: pad_shapes.h:60
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
DLIST< TRACK > m_Track
Definition: class_board.h:246
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:119
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
Use thermal relief for pads.
Definition: zones.h:58
int GetZoneClearance() const
Definition: class_zone.h:218
DLIST_ITERATOR_WRAPPER< BOARD_ITEM > Drawings()
Definition: class_board.h:251
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
void CreateThermalReliefPadPolygon(SHAPE_POLY_SET &aCornerBuffer, D_PAD &aPad, int aThermalGap, int aCopperThickness, int aMinThicknessValue, int aCircleToSegmentsCount, double aCorrectionFactor, double aThermalRot)
Function CreateThermalReliefPadPolygon Add holes around a pad to create a thermal relief copper thick...
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) ...
bool ZONE_CONTAINER::BuildFilledSolidAreasPolygons ( BOARD aPcb,
SHAPE_POLY_SET aOutlineBuffer = NULL 
)

Build the filled solid areas polygons from zone outlines (stored in m_Poly) The solid areas can be more than one on copper layers, and do not have holes ( holes are linked by overlapping segments to the main outline) in order to have drawable (and plottable) filled polygons.

Returns
true if OK, false if the solid polygons cannot be built
Parameters
aPcbthe current board (can be NULL for non copper zones)
aOutlineBufferA reference to a SHAPE_POLY_SET buffer to store polygons, or NULL. if NULL (default):
  • m_FilledPolysList is used to store solid areas polygons.
  • on copper layers, tracks and other items shapes of other nets are removed from solid areas if not null: Only the zone outline (with holes, if any) is stored in aOutlineBuffer with holes linked. Therefore only one polygon is created

When aOutlineBuffer is not null, his function calls AddClearanceAreasPolygonsToPolysList() to add holes for pads and tracks and other items not in net.

Definition at line 58 of file zone_filling_algorithm.cpp.

References AddClearanceAreasPolygonsToPolysList_NG(), SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::Chamfer(), SHAPE_POLY_SET::Fillet(), FillZoneAreasWithSegments(), SHAPE_POLY_SET::Fracture(), GetNumCorners(), SHAPE_POLY_SET::Inflate(), IsOnCopperLayer(), m_ArcToSegmentsCount, m_cornerRadius, m_cornerSmoothingType, m_FilledPolysList, m_FillMode, m_IsFilled, m_Poly, m_smoothedPoly, m_ZoneMinThickness, SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::RemoveAllContours(), ZONE_SETTINGS::SMOOTHING_CHAMFER, and ZONE_SETTINGS::SMOOTHING_FILLET.

Referenced by export_vrml_zones(), PCB_EDIT_FRAME::Fill_Zone(), and TransformOutlinesShapeWithClearanceToPolygon().

59 {
60  /* convert outlines + holes to outlines without holes (adding extra segments if necessary)
61  * m_Poly data is expected normalized, i.e. NormalizeAreaOutlines was used after building
62  * this zone
63  */
64 
65  if( GetNumCorners() <= 2 ) // malformed zone. polygon calculations do not like it ...
66  return false;
67 
68  // Make a smoothed polygon out of the user-drawn polygon if required
69  if( m_smoothedPoly )
70  {
71  delete m_smoothedPoly;
72  m_smoothedPoly = NULL;
73  }
74 
75  switch( m_cornerSmoothingType )
76  {
80  break;
81 
85  break;
86 
87  default:
88  // Acute angles between adjacent edges can create issues in calculations,
89  // in inflate/deflate outlines transforms, especially when the angle is very small.
90  // We can avoid issues by creating a very small chamfer which remove acute angles,
91  // or left it without chamfer and use only CPOLYGONS_LIST::InflateOutline to create
92  // clearance areas
94  *m_smoothedPoly = m_Poly->Chamfer( Millimeter2iu( 0.0 ) );
95  break;
96  }
97 
98  if( aOutlineBuffer )
99  aOutlineBuffer->Append( *m_smoothedPoly );
100 
101  /* For copper layers, we now must add holes in the Polygon list.
102  * holes are pads and tracks with their clearance area
103  * For non copper layers, just recalculate the m_FilledPolysList
104  * with m_ZoneMinThickness taken in account
105  */
106  else
107  {
109 
110  if( IsOnCopperLayer() )
111  {
113 
114  if( m_FillMode ) // if fill mode uses segments, create them:
115  {
117  return false;
118  }
119  }
120  else
121  {
122  m_FillMode = 0; // Fill by segments is no more used in non copper layers
123  // force use solid polygons (usefull only for old boards)
125 
126  // The filled areas are deflated by -m_ZoneMinThickness / 2, because
127  // the outlines are drawn with a line thickness = m_ZoneMinThickness to
128  // give a good shape with the minimal thickness
131  }
132 
133  m_IsFilled = true;
134  }
135 
136  return true;
137 }
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:480
SHAPE_POLY_SET * m_smoothedPoly
Definition: class_zone.h:742
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:772
void Inflate(int aFactor, int aCircleSegmentsCount)
Performs outline inflation/deflation, using round corners.
SHAPE_POLY_SET Fillet(int aRadius, int aSegments)
Function Fillet returns a filleted version of the polygon set.
Class SHAPE_POLY_SET.
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:775
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
int m_cornerSmoothingType
Definition: class_zone.h:743
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
bool FillZoneAreasWithSegments()
Function FillZoneAreasWithSegments Fill sub areas in a zone with segments with m_ZoneMinThickness wid...
void Fracture(POLYGON_MODE aFastMode)
Converts a set of polygons with holes to a singe outline with "slits"/"fractures" connecting the oute...
unsigned int m_cornerRadius
Definition: class_zone.h:744
void AddClearanceAreasPolygonsToPolysList_NG(BOARD *aPcb)
Function AddClearanceAreasPolygonsToPolysList Supports a min thickness area constraint.
bool IsOnCopperLayer() const
Function IsOnCopperLayer.
Definition: class_zone.cpp:188
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
SHAPE_POLY_SET Chamfer(int aDistance)
Function Chamfer returns a chamfered version of the polygon set.
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline) ...
SHAPE_POLY_SET::CONST_ITERATOR ZONE_CONTAINER::CIterateWithHoles ( ) const
inline

Function CIterateWithHoles returns an iterator to visit all points of the zone's main outline with holes.

Returns
SHAPE_POLY_SET::ITERATOR - an iterator to visit the zone vertices with holes.

Definition at line 510 of file class_zone.h.

References SHAPE_POLY_SET::CIterateWithHoles(), and m_Poly.

Referenced by KIGFX::PCB_PAINTER::draw().

511  {
512  return m_Poly->CIterateWithHoles();
513  }
CONST_ITERATOR CIterateWithHoles(int aOutline) const
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
static bool BOARD_CONNECTED_ITEM::ClassOf ( const EDA_ITEM aItem)
inlinestaticinherited

Definition at line 56 of file class_board_connected_item.h.

References PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, and EDA_ITEM::Type().

57  {
58  if( aItem == NULL )
59  return false;
60 
61  switch( aItem->Type() )
62  {
63  case PCB_PAD_T:
64  case PCB_TRACE_T:
65  case PCB_VIA_T:
66  case PCB_ZONE_AREA_T:
67  return true;
68 
69  default:
70  return false;
71  }
72  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 247 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

247 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
void ZONE_CONTAINER::ClearFilledPolysList ( )
inline

Function ClearFilledPolysList clears the list of filled polygons.

Definition at line 587 of file class_zone.h.

References m_FilledPolysList, and SHAPE_POLY_SET::RemoveAllContours().

Referenced by PCB_EDIT_FRAME::Fill_Zone(), POINT_EDITOR::updateItem(), and PCB_EDITOR_CONTROL::ZoneUnfillAll().

588  {
590  }
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 268 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_PART::DeleteSelectedItems(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Zone(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_EAGLE_PLUGIN::loadSheet(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), LIB_PIN::Save(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

268 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 246 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

246 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
void EDA_ITEM::ClearSelected ( )
inlineinherited
EDA_ITEM * ZONE_CONTAINER::Clone ( ) const
overridevirtual

Function Clone creates a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 151 of file class_zone.cpp.

References ZONE_CONTAINER().

152 {
153  return new ZONE_CONTAINER( *this );
154 }
ZONE_CONTAINER(BOARD *parent)
Definition: class_zone.cpp:53
bool ZONE_CONTAINER::CommonLayerExists ( const LSET  aLayerSet) const

Function CommonLayerExist Test if this zone shares a common layer with the given layer set.

Definition at line 201 of file class_zone.cpp.

References GetLayerSet().

Referenced by buildFeatureHoleList(), DRC::doTrackKeepoutDrc(), and DRC::testKeepoutAreas().

202 {
203  LSET common = GetLayerSet() & aLayerSet;
204 
205  return common.count() > 0;
206 }
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:237
Class LSET is a set of PCB_LAYER_IDs.
void BOARD_ITEM::DeleteStructure ( )
inherited
void ZONE_CONTAINER::Draw ( EDA_DRAW_PANEL panel,
wxDC *  DC,
GR_DRAWMODE  aDrawMode,
const wxPoint offset = ZeroOffset 
)
overridevirtual

Function Draw Draws the zone outline.

Parameters
panel= current Draw Panel
DC= current Device Context
aDrawMode= GR_OR, GR_XOR, GR_COPY ..
offset= Draw offset (usually wxPoint(0,0))

Implements BOARD_ITEM.

Definition at line 283 of file class_zone.cpp.

References SEG::A, SEG::B, color, DARKDARKGRAY, BOARD_ITEM::GetBoard(), EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), GetIsKeepout(), GetLayer(), GetLayerSet(), GetNumCorners(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), BOARD::GetVisibleLayers(), GR_AND, GR_HIGHLIGHT, GRLineArray(), GRSetDrawMode(), BOARD::IsLayerVisible(), IsOnLayer(), SHAPE_POLY_SET::IterateSegmentsWithHoles(), m_HatchLines, m_Poly, LSET::Seq(), and UNDEFINED_LAYER.

Referenced by BOARD::Draw(), BOARD::DrawHighLight(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD::RedrawAreasOutlines(), and Show_Zone_Corner_Or_Outline_While_Move_Mouse().

285 {
286  if( !DC )
287  return;
288 
289  wxPoint seg_start, seg_end;
290  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
291  BOARD* brd = GetBoard();
292 
293  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
294 
295  PCB_LAYER_ID draw_layer = UNDEFINED_LAYER;
296 
297  LSET layers = GetLayerSet() & brd->GetVisibleLayers();
298 
299  // If there are no visible layers and the zone is not highlighted, return
300  if( layers.count() == 0 && !( aDrawMode & GR_HIGHLIGHT ) )
301  {
302  return;
303  }
304 
305  /* Keepout zones can exist on multiple layers
306  * Thus, determining which color to use to render them is a bit tricky.
307  * In descending order of priority:
308  *
309  * 1. If in GR_HIGHLIGHT mode:
310  * a. If zone is on selected layer, use layer color!
311  * b. Else, use grey
312  * 1. Not in GR_HIGHLIGHT mode
313  * a. If zone is on selected layer, use layer color
314  * b. Else, use color of top-most (visible) layer
315  *
316  */
317  if( GetIsKeepout() )
318  {
319  // At least one layer must be provided!
320  assert( GetLayerSet().count() > 0 );
321 
322  // Not on any visible layer?
323  if( layers.count() == 0 && !( aDrawMode & GR_HIGHLIGHT ) )
324  {
325  return;
326  }
327 
328  // Is keepout zone present on the selected layer?
329  if( layers.test( curr_layer ) )
330  {
331  draw_layer = curr_layer;
332  }
333  else
334  {
335  // Select the first (top) visible layer
336  if( layers.count() > 0 )
337  {
338  draw_layer = layers.Seq()[0];
339  }
340  else
341  {
342  draw_layer = GetLayerSet().Seq()[0];
343  }
344  }
345 
346  }
347  /* Non-keepout zones are easier to deal with
348  */
349  else
350  {
351  if( brd->IsLayerVisible( GetLayer() ) == false && !( aDrawMode & GR_HIGHLIGHT ) )
352  {
353  return;
354  }
355 
356  draw_layer = GetLayer();
357  }
358 
359  assert( draw_layer != UNDEFINED_LAYER );
360 
361  auto color = frame->Settings().Colors().GetLayerColor( draw_layer );
362 
363  GRSetDrawMode( DC, aDrawMode );
364  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
365 
366  if( displ_opts->m_ContrastModeDisplay )
367  {
368  if( !IsOnLayer( curr_layer ) )
369  {
371  }
372  }
373 
374  if( ( aDrawMode & GR_HIGHLIGHT ) && !( aDrawMode & GR_AND ) )
375  {
376  color.SetToLegacyHighlightColor();
377  }
378 
379  color.a = 0.588;
380 
381  // draw the lines
382  std::vector<wxPoint> lines;
383  lines.reserve( (GetNumCorners() * 2) + 2 );
384 
385  // Iterate through the segments of the outline
386  for( auto iterator = m_Poly->IterateSegmentsWithHoles(); iterator; iterator++ )
387  {
388  // Create the segment
389  SEG segment = *iterator;
390 
391  lines.push_back( static_cast<wxPoint>( segment.A ) + offset );
392  lines.push_back( static_cast<wxPoint>( segment.B ) + offset );
393  }
394 
395  GRLineArray( panel->GetClipBox(), DC, lines, 0, color );
396 
397  // draw hatches
398  lines.clear();
399  lines.reserve( (m_HatchLines.size() * 2) + 2 );
400 
401  for( unsigned ic = 0; ic < m_HatchLines.size(); ic++ )
402  {
403  seg_start = static_cast<wxPoint>( m_HatchLines[ic].A ) + offset;
404  seg_end = static_cast<wxPoint>( m_HatchLines[ic].B ) + offset;
405  lines.push_back( seg_start );
406  lines.push_back( seg_end );
407  }
408 
409  GRLineArray( panel->GetClipBox(), DC, lines, 0, color );
410 }
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:480
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:296
SEGMENT_ITERATOR IterateSegmentsWithHoles()
Returns an iterator object, for all outlines in the set (with holes)
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:272
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Function Seq returns an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:337
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:237
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
Class LSET is a set of PCB_LAYER_IDs.
std::vector< SEG > m_HatchLines
Definition: class_zone.h:811
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
EDA_RECT * GetClipBox()
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:174
Definition: seg.h:36
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
VECTOR2I A
Definition: seg.h:46
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:187
void GRLineArray(EDA_RECT *aClipBox, wxDC *aDC, std::vector< wxPoint > &aLines, int aWidth, COLOR4D aColor)
Function GRLineArray draws an array of lines (not a polygon).
Definition: gr_basic.cpp:434
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_panel.cpp:181
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:451
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
VECTOR2I B
Definition: seg.h:47
void ZONE_CONTAINER::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)

Parameters
panel= current Draw Panel
DC= current Device Context
offset= Draw offset (usually wxPoint(0,0))
aDrawMode= GR_OR, GR_XOR, GR_COPY ..

Definition at line 413 of file class_zone.cpp.

References color, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), DARKDARKGRAY, FORCE_SKETCH, BOARD_ITEM::GetBoard(), EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), GetLayer(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), EDA_ITEM::GetState(), GR_AND, GR_HIGHLIGHT, GRCSegm(), GRFillCSegm(), GRPoly(), GRSetDrawMode(), SHAPE_POLY_SET::IsEmpty(), BOARD::IsLayerVisible(), IsOnLayer(), m_FilledPolysList, m_FillMode, m_FillSegmList, m_ZoneMinThickness, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

Referenced by BOARD::Draw(), PCB_EDIT_FRAME::PrintPage(), BOARD::RedrawFilledAreas(), and PCB_EDIT_FRAME::Remove_Zone_Corner().

415 {
416 
417  static std::vector <wxPoint> CornersBuffer;
418  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
419 
420  // outline_mode is false to show filled polys,
421  // and true to show polygons outlines only (test and debug purposes)
422  bool outline_mode = displ_opts->m_DisplayZonesMode == 2 ? true : false;
423 
424  if( DC == NULL )
425  return;
426 
427  if( displ_opts->m_DisplayZonesMode == 1 ) // Do not show filled areas
428  return;
429 
430  if( m_FilledPolysList.IsEmpty() ) // Nothing to draw
431  return;
432 
433  BOARD* brd = GetBoard();
434  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
435 
436  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
437  auto color = frame->Settings().Colors().GetLayerColor( GetLayer() );
438 
439  if( brd->IsLayerVisible( GetLayer() ) == false && !( aDrawMode & GR_HIGHLIGHT ) )
440  return;
441 
442  GRSetDrawMode( DC, aDrawMode );
443 
444  if( displ_opts->m_ContrastModeDisplay )
445  {
446  if( !IsOnLayer( curr_layer ) )
448  }
449 
450  if( ( aDrawMode & GR_HIGHLIGHT ) && !( aDrawMode & GR_AND ) )
451  color.SetToLegacyHighlightColor();
452 
453  color.a = 0.588;
454 
455 
456  for ( int ic = 0; ic < m_FilledPolysList.OutlineCount(); ic++ )
457  {
458  const SHAPE_LINE_CHAIN& path = m_FilledPolysList.COutline( ic );
459 
460  CornersBuffer.clear();
461 
462  wxPoint p0;
463 
464  for( int j = 0; j < path.PointCount(); j++ )
465  {
466  const VECTOR2I& corner = path.CPoint( j );
467 
468  wxPoint coord( corner.x + offset.x, corner.y + offset.y );
469 
470  if( j == 0 )
471  p0 = coord;
472 
473  CornersBuffer.push_back( coord );
474  }
475 
476  CornersBuffer.push_back( p0 );
477 
478  // Draw outlines:
479  if( ( m_ZoneMinThickness > 1 ) || outline_mode )
480  {
481  int ilim = CornersBuffer.size() - 1;
482 
483  for( int is = 0, ie = ilim; is <= ilim; ie = is, is++ )
484  {
485  int x0 = CornersBuffer[is].x;
486  int y0 = CornersBuffer[is].y;
487  int x1 = CornersBuffer[ie].x;
488  int y1 = CornersBuffer[ie].y;
489 
490  // Draw only basic outlines, not extra segments.
491  if( !displ_opts->m_DisplayPcbTrackFill || GetState( FORCE_SKETCH ) )
492  GRCSegm( panel->GetClipBox(), DC,
493  x0, y0, x1, y1,
495  else
496  GRFillCSegm( panel->GetClipBox(), DC,
497  x0, y0, x1, y1, m_ZoneMinThickness, color );
498  }
499  }
500 
501  // Draw areas:
502  if( m_FillMode == 0 && !outline_mode )
503  GRPoly( panel->GetClipBox(), DC, CornersBuffer.size(), &CornersBuffer[0],
504  true, 0, color, color );
505  }
506 
507  if( m_FillMode == 1 && !outline_mode ) // filled with segments
508  {
509  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
510  {
511  wxPoint start = m_FillSegmList[ic].m_Start + offset;
512  wxPoint end = m_FillSegmList[ic].m_End + offset;
513 
514  if( !displ_opts->m_DisplayPcbTrackFill || GetState( FORCE_SKETCH ) )
515  GRCSegm( panel->GetClipBox(), DC, start.x, start.y, end.x, end.y,
517  else
518  GRFillCSegm( panel->GetClipBox(), DC, start.x, start.y, end.x, end.y,
520  }
521  }
522 }
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:774
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:296
int PointCount() const
Function PointCount()
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:272
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
void GRCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, int aPenSize, COLOR4D Color)
Definition: gr_basic.cpp:488
int OutlineCount() const
Returns the number of outlines in the set
int GetState(int type) const
Definition: base_struct.h:251
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
void GRFillCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:591
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
EDA_RECT * GetClipBox()
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:174
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
Class SHAPE_LINE_CHAIN.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:187
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_panel.cpp:181
#define FORCE_SKETCH
Definition: pcbnew.h:68
const VECTOR2I & CPoint(int aIndex) const
Function CPoint()
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:451
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void ZONE_CONTAINER::DrawWhileCreateOutline ( EDA_DRAW_PANEL panel,
wxDC *  DC,
GR_DRAWMODE  draw_mode = GR_OR 
)

Function DrawWhileCreateOutline Draws the zone outline when it is created.

The moving edges are in XOR graphic mode, old segment in draw_mode graphic mode (usually GR_OR). The closing edge has its own shape.

Parameters
panel= current Draw Panel
DC= current Device Context
draw_mode= draw mode: OR, XOR ..

Definition at line 552 of file class_zone.cpp.

References color, DARKDARKGRAY, EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), GetLayer(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), GR_XOR, GRLine(), GRSetDrawMode(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsEndContour(), IsOnLayer(), SHAPE_POLY_SET::Iterate(), m_Poly, WHITE, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Abort_Zone_Create_Outline(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::End_Zone(), and Show_New_Edge_While_Move_Mouse().

554 {
555  GR_DRAWMODE current_gr_mode = draw_mode;
556  bool is_close_segment = false;
557 
558  if( !DC )
559  return;
560 
561  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
562 
563  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
564  auto color = frame->Settings().Colors().GetLayerColor( GetLayer() );
565 
566  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
567 
568  if( displ_opts->m_ContrastModeDisplay )
569  {
570  if( !IsOnLayer( curr_layer ) )
572  }
573 
574  // Object to iterate through the corners of the outlines
576 
577  // Segment start and end
578  VECTOR2I seg_start, seg_end;
579 
580  // Remember the first point of this contour
581  VECTOR2I contour_first_point = *iterator;
582 
583  // Iterate through all the corners of the outlines and build the segments to draw
584  while( iterator )
585  {
586  // Get the first point of the current segment
587  seg_start = *iterator;
588 
589  // Get the last point of the current segment, handling the case where the end of the
590  // contour is reached, when the last point of the segment is the first point of the
591  // contour
592  if( !iterator.IsEndContour() )
593  {
594  // Set GR mode to default
595  current_gr_mode = draw_mode;
596 
597  SHAPE_POLY_SET::ITERATOR iterator_copy = iterator;
598  iterator_copy++;
599  if( iterator_copy.IsEndContour() )
600  current_gr_mode = GR_XOR;
601 
602  is_close_segment = false;
603 
604  iterator++;
605  seg_end = *iterator;
606  }
607  else
608  {
609  is_close_segment = true;
610 
611  seg_end = contour_first_point;
612 
613  // Reassign first point of the contour to the next contour start
614  iterator++;
615 
616  if( iterator )
617  contour_first_point = *iterator;
618 
619  // Set GR mode to XOR
620  current_gr_mode = GR_XOR;
621  }
622 
623  GRSetDrawMode( DC, current_gr_mode );
624 
625  if( is_close_segment )
626  GRLine( panel->GetClipBox(), DC, seg_start.x, seg_start.y, seg_end.x, seg_end.y, 0,
627  WHITE );
628  else
629  GRLine( panel->GetClipBox(), DC, seg_start.x, seg_start.y, seg_end.x, seg_end.y, 0,
630  color );
631  }
632 }
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:296
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:272
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
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...
bool IsEndContour() const
Function IsEndContour.
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:41
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
EDA_RECT * GetClipBox()
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:174
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:358
Class ITERATOR_TEMPLATE.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:187
Definition: colors.h:49
void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_panel.cpp:181
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
std::vector<SEGMENT>& ZONE_CONTAINER::FillSegments ( )
inline

Definition at line 259 of file class_zone.h.

References m_FillSegmList.

Referenced by PCB_IO::format(), and BRDITEMS_PLOTTER::PlotFilledAreas().

259 { return m_FillSegmList; }
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
const std::vector<SEGMENT>& ZONE_CONTAINER::FillSegments ( ) const
inline

Definition at line 260 of file class_zone.h.

References m_FillSegmList.

260 { return m_FillSegmList; }
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
bool ZONE_CONTAINER::FillZoneAreasWithSegments ( )

Function FillZoneAreasWithSegments Fill sub areas in a zone with segments with m_ZoneMinThickness width A scan is made line per line, on the whole filled areas, with a step of m_ZoneMinThickness.

all intersecting points with the horizontal infinite line and polygons to fill are calculated a list of SEGZONE items is built, line per line

Returns
true if success, false on error

Definition at line 151 of file zone_filling_algorithm.cpp.

References SHAPE_LINE_CHAIN::Append(), SHAPE_POLY_SET::COutline(), fillPolygonWithHorizontalSegments(), SEGMENT::m_End, m_FilledPolysList, m_FillSegmList, m_IsFilled, SEGMENT::m_Start, m_ZoneMinThickness, max, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::Point(), SHAPE_LINE_CHAIN::PointCount(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

Referenced by BuildFilledSolidAreasPolygons().

152 {
153  bool success = true;
154  // segments are on something like a grid. Give it a minimal size
155  // to avoid too many segments, and use the m_ZoneMinThickness when (this is usually the case)
156  // the size is > mingrid_size.
157  // This is not perfect, but the actual purpose of this code
158  // is to allow filling zones on a grid, with grid size > m_ZoneMinThickness,
159  // in order to have really a grid.
160  //
161  // Using a user selectable grid size is for future Kicad versions.
162  // For now the area is fully filled.
163  int mingrid_size = Millimeter2iu( 0.05 );
164  int grid_size = std::max( mingrid_size, m_ZoneMinThickness );
165  // Make segments slightly overlapping to ensure a good full filling
166  grid_size -= grid_size/20;
167 
168  // All filled areas are in m_FilledPolysList
169  // m_FillSegmList will contain the horizontal and vertical segments
170  // the segment width is m_ZoneMinThickness.
171  m_FillSegmList.clear();
172 
173  // Creates the horizontal segments
174  for ( int index = 0; index < m_FilledPolysList.OutlineCount(); index++ )
175  {
176  const SHAPE_LINE_CHAIN& outline0 = m_FilledPolysList.COutline( index );
177  success = fillPolygonWithHorizontalSegments( outline0, m_FillSegmList, grid_size );
178 
179  if( !success )
180  break;
181 
182  // Creates the vertical segments. Because the filling algo creates horizontal segments,
183  // to reuse the fillPolygonWithHorizontalSegments function, we rotate the polygons to fill
184  // then fill them, then inverse rotate the result
185  SHAPE_LINE_CHAIN outline90;
186  outline90.Append( outline0 );
187 
188  // Rotate 90 degrees the outline:
189  for( int ii = 0; ii < outline90.PointCount(); ii++ )
190  {
191  VECTOR2I& point = outline90.Point( ii );
192  std::swap( point.x, point.y );
193  point.y = -point.y;
194  }
195 
196  int first_point = m_FillSegmList.size();
197  success = fillPolygonWithHorizontalSegments( outline90, m_FillSegmList, grid_size );
198 
199  if( !success )
200  break;
201 
202  // Rotate -90 degrees the segments:
203  for( unsigned ii = first_point; ii < m_FillSegmList.size(); ii++ )
204  {
205  SEGMENT& segm = m_FillSegmList[ii];
206  std::swap( segm.m_Start.x, segm.m_Start.y );
207  std::swap( segm.m_End.x, segm.m_End.y );
208  segm.m_Start.x = - segm.m_Start.x;
209  segm.m_End.x = - segm.m_End.x;
210  }
211  }
212 
213  if( success )
214  m_IsFilled = true;
215  else
216  m_FillSegmList.clear();
217 
218  return success;
219 }
wxPoint m_End
Definition: class_zone.h:60
int PointCount() const
Function PointCount()
bool fillPolygonWithHorizontalSegments(const SHAPE_LINE_CHAIN &aPolygon, std::vector< SEGMENT > &aFillSegmList, int aStep)
Helper function fillPolygonWithHorizontalSegments fills a polygon with horizontal segments...
int OutlineCount() const
Returns the number of outlines in the set
void Append(int aX, int aY, bool aAllowDuplication=false)
Function Append()
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:775
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
#define max(a, b)
Definition: auxiliary.h:86
Class SHAPE_LINE_CHAIN.
Struct SEGMENT is a simple container used when filling areas with segments.
Definition: class_zone.h:57
VECTOR2I & Point(int aIndex)
Function Point()
wxPoint m_Start
Definition: class_zone.h:59
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
void BOARD_ITEM::Flip ( const VECTOR2I aCentre)
inlineinherited

Definition at line 270 of file class_board_item.h.

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

271  {
272  Flip( wxPoint( aCentre.x, aCentre.y ) );
273  }
virtual void Flip(const wxPoint &aCentre)
Function Flip Flip this object, i.e.
void ZONE_CONTAINER::Flip ( const wxPoint aCentre)
overridevirtual

Function Flip Flip this object, i.e.

change the board side for this object (like Mirror() but changes layer)

Parameters
aCentre- the rotation point.

Reimplemented from BOARD_ITEM.

Definition at line 960 of file class_zone.cpp.

References FlipLayer(), FlipLayerMask(), BOARD_ITEM::GetBoard(), BOARD::GetCopperLayerCount(), GetIsKeepout(), GetLayer(), GetLayerSet(), Mirror(), SetLayer(), and SetLayerSet().

961 {
962  Mirror( aCentre );
963  int copperLayerCount = GetBoard()->GetCopperLayerCount();
964 
965  if( GetIsKeepout() )
966  {
967  SetLayerSet( FlipLayerMask( GetLayerSet(), copperLayerCount ) );
968  }
969  else
970  {
971  SetLayer( FlipLayer( GetLayer(), copperLayerCount ) );
972  }
973 }
LSET FlipLayerMask(LSET aMask, int aCopperLayersCount)
Calculate the mask layer when flipping a footprint BACK and FRONT copper layers, mask, paste, solder layers are swapped internal layers are flipped only if the copper layers count is known.
Definition: lset.cpp:491
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:445
int GetCopperLayerCount() const
Function GetCopperLayerCount.
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
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:237
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:217
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
Definition: class_zone.cpp:209
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
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:976
std::string BOARD_ITEM::FormatAngle ( double  aAngle)
staticinherited

Function FormatAngle converts aAngle from board units to a string appropriate for writing to file.

Note
Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.
Parameters
aAngleA angle value to convert.
Returns
A std::string object containing the converted angle.

Definition at line 170 of file class_board_item.cpp.

171 {
172  char temp[50];
173 
174  int len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
175 
176  return std::string( temp, len );
177 }
std::string BOARD_ITEM::FormatInternalUnits ( int  aValue)
staticinherited

Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file.

Note
Internal units for board items can be either deci-mils or nanometers depending on how KiCad is build.
Parameters
aValueA coordinate value to convert.
Returns
A std::string object containing the converted value.

Definition at line 89 of file class_board_item.cpp.

Referenced by checkConnectedTo(), ConvertOutlineToPolygon(), BOARD_ITEM::FormatInternalUnits(), and BOARD::TracksInNetBetweenPoints().

90 {
91 #if 1
92 
93  char buf[50];
94  int len;
95  double mm = aValue / IU_PER_MM;
96 
97  if( mm != 0.0 && fabs( mm ) <= 0.0001 )
98  {
99  len = sprintf( buf, "%.10f", mm );
100 
101  while( --len > 0 && buf[len] == '0' )
102  buf[len] = '\0';
103 
104  if( buf[len] == '.' )
105  buf[len] = '\0';
106  else
107  ++len;
108  }
109  else
110  {
111  len = sprintf( buf, "%.10g", mm );
112  }
113 
114  return std::string( buf, len );
115 
116 #else
117 
118  // Assume aValue is in nanometers, and that we want the result in millimeters,
119  // and that int is 32 bits wide. Then perform an alternative algorithm.
120  // Can be used to verify that the above algorithm is correctly generating text.
121  // Convert aValue into an integer string, then insert a decimal point manually.
122  // Results are the same as above general purpose algorithm.
123 
124  wxASSERT( sizeof(int) == 4 );
125 
126  if( aValue == 0 )
127  return std::string( 1, '0' );
128  else
129  {
130  char buf[50];
131  int len = sprintf( buf, aValue > 0 ? "%06d" : "%07d", aValue ); // optionally pad w/leading zeros
132 
133  std::string ret( buf, len );
134 
135  std::string::iterator it = ret.end() - 1; // last byte
136 
137  // insert '.' at 6 positions from end, dividing by 10e6 (a million), nm => mm
138  std::string::iterator decpoint = ret.end() - 6;
139 
140  // truncate trailing zeros, up to decimal point position
141  for( ; *it=='0' && it >= decpoint; --it )
142  ret.erase( it ); // does not invalidate iterators it or decpoint
143 
144  if( it >= decpoint )
145  {
146  ret.insert( decpoint, '.' );
147 
148  // decpoint is invalidated here, after insert()
149 
150 #if 1 // want a leading zero when decimal point is in first position?
151  if( ret[0] == '.' )
152  {
153  // insert leading zero ahead of decimal point.
154  ret.insert( ret.begin(), '0' );
155  }
156  else if( ret[0]=='-' && ret[1]=='.' )
157  {
158  ret.insert( ret.begin() + 1, '0' );
159  }
160 #endif
161  }
162 
163  return ret;
164  }
165 
166 #endif
167 }
std::string BOARD_ITEM::FormatInternalUnits ( const wxPoint aPoint)
staticinherited

Definition at line 180 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits(), wxPoint::x, and wxPoint::y.

181 {
182  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
183 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
std::string BOARD_ITEM::FormatInternalUnits ( const wxSize &  aSize)
staticinherited

Definition at line 186 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits().

187 {
188  return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
189 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
int ZONE_CONTAINER::GetArcSegmentCount ( ) const
inline

Definition at line 213 of file class_zone.h.

References m_ArcToSegmentsCount.

Referenced by PCB_IO::format(), IsSame(), and ZONE_SETTINGS::operator<<().

213 { return m_ArcToSegmentsCount; }
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:772
BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 63 of file class_board_item.cpp.

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

Referenced by buildFeatureHoleList(), DeleteMarkedItems(), TEXTE_PCB::Draw(), PCB_TARGET::Draw(), EDGE_MODULE::Draw(), Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), DIMENSION::Draw(), MODULE::Draw(), SEGZONE::Draw(), VIA::Draw(), D_PAD::Draw(), MODULE::DrawAncre(), DrawFilledArea(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), EVT_COMMAND_RANGE(), TEXTE_PCB::Flip(), TRACK::Flip(), VIA::Flip(), Flip(), BOARD_ITEM::GetBoard(), MODULE::GetBoundingBox(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), VIA::GetSelectMenuText(), GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), and VIA::ViewGetLOD().

64 {
65  if( Type() == PCB_T )
66  return (BOARD*) this;
67 
68  BOARD_ITEM* parent = GetParent();
69 
70  if( parent )
71  return parent->GetBoard();
72 
73  return NULL;
74 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
BOARD_ITEM_CONTAINER * GetParent() const
Definition: typeinfo.h:85
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const EDA_RECT ZONE_CONTAINER::GetBoundingBox ( ) const
overridevirtual

Function GetBoundingBox (virtual)

Returns
an EDA_RECT that is the bounding box of the zone outline

Reimplemented from EDA_ITEM.

Definition at line 525 of file class_zone.cpp.

References GetCornerPosition(), GetNumCorners(), max, min, wxPoint::x, and wxPoint::y.

Referenced by buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), BOARD::ComputeBoundingBox(), PCB_EDIT_FRAME::Delete_Zone_Contour(), HitTest(), and PCB_EDIT_FRAME::Remove_Zone_Corner().

526 {
527  const int PRELOAD = 0x7FFFFFFF; // Biggest integer (32 bits)
528 
529  int ymax = -PRELOAD;
530  int ymin = PRELOAD;
531  int xmin = PRELOAD;
532  int xmax = -PRELOAD;
533 
534  int count = GetNumCorners();
535 
536  for( int i = 0; i<count; ++i )
537  {
538  wxPoint corner = static_cast<wxPoint>( GetCornerPosition( i ) );
539 
540  ymax = std::max( ymax, corner.y );
541  xmax = std::max( xmax, corner.x );
542  ymin = std::min( ymin, corner.y );
543  xmin = std::min( xmin, corner.x );
544  }
545 
546  EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin + 1, ymax - ymin + 1 ) );
547 
548  return ret;
549 }
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:480
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
Definition: class_zone.h:520
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
#define min(a, b)
Definition: auxiliary.h:85
virtual const wxPoint BOARD_ITEM::GetCenter ( ) const
inlinevirtualinherited

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless overridden

Returns
centre point of the item

Reimplemented in DRAWSEGMENT.

Definition at line 97 of file class_board_item.h.

References BOARD_ITEM::GetPosition().

Referenced by LEGACY_ARRAY_CREATOR::getRotationCentre(), and DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::TransformItem().

97 { return GetPosition(); }
virtual const wxPoint & GetPosition() const =0
wxString ZONE_CONTAINER::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 471 of file class_zone.h.

472  {
473  return wxT( "ZONE_CONTAINER" );
474  }
int ZONE_CONTAINER::GetClearance ( BOARD_CONNECTED_ITEM aItem = NULL) const
overridevirtual

Function GetClearance returns the clearance in internal units.

If aItem is not NULL then the returned clearance is the greater of this object's NETCLASS clearance and aItem's NETCLASS clearance. If aItem is NULL, then this objects clearance is returned.

Parameters
aItemis another BOARD_CONNECTED_ITEM or NULL
Returns
int - the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 787 of file class_zone.cpp.

References BOARD_CONNECTED_ITEM::GetClearance(), BOARD_CONNECTED_ITEM::GetNetClass(), m_ZoneClearance, and max.

Referenced by buildFeatureHoleList(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines(), and TransformOutlinesShapeWithClearanceToPolygon().

788 {
789  int myClearance = m_ZoneClearance;
790 
791 #if 1 // Maybe the netclass clearance should not come into play for a zone?
792  // At least the policy decision can be controlled by the zone
793  // itself, i.e. here. On reasons of insufficient documentation,
794  // the user will be less bewildered if we simply respect the
795  // "zone clearance" setting in the zone properties dialog. (At least
796  // until there is a UI boolean for this.)
797 
798  NETCLASSPTR myClass = GetNetClass();
799 
800  if( myClass )
801  myClearance = std::max( myClearance, myClass->GetClearance() );
802 #endif
803 
804  if( aItem )
805  {
806  int hisClearance = aItem->GetClearance( NULL );
807  myClearance = std::max( hisClearance, myClearance );
808  }
809 
810  return myClearance;
811 }
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:767
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const
Function GetClearance returns the clearance in internal units.
#define max(a, b)
Definition: auxiliary.h:86
const VECTOR2I& ZONE_CONTAINER::GetCornerPosition ( int  aCornerIndex) const
inline

Definition at line 520 of file class_zone.h.

References SHAPE_POLY_SET::CVertex(), SHAPE_POLY_SET::GetRelativeIndices(), and m_Poly.

Referenced by PCB_EDIT_FRAME::Begin_Zone(), GetBoundingBox(), GetPosition(), ZONE_CREATE_HELPER::performZoneCutout(), Show_New_Edge_While_Move_Mouse(), and PCB_EDIT_FRAME::Start_Move_Zone_Corner().

521  {
523 
524  // Convert global to relative indices
525  if( !m_Poly->GetRelativeIndices( aCornerIndex, &index ) )
526  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
527 
528  return m_Poly->CVertex( index );
529  }
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
Struct VERTEX_INDEX.
bool GetRelativeIndices(int aGlobalIdx, VERTEX_INDEX *aRelativeIndices) const
Function GetRelativeIndices.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
unsigned int ZONE_CONTAINER::GetCornerRadius ( ) const
inline

Definition at line 634 of file class_zone.h.

References m_cornerRadius.

Referenced by PCB_IO::format(), and ZONE_SETTINGS::operator<<().

634 { return m_cornerRadius; };
unsigned int m_cornerRadius
Definition: class_zone.h:744
int ZONE_CONTAINER::GetCornerSmoothingType ( ) const
inline

Definition at line 630 of file class_zone.h.

References m_cornerSmoothingType.

Referenced by PCB_IO::format(), and ZONE_SETTINGS::operator<<().

630 { return m_cornerSmoothingType; };
int m_cornerSmoothingType
Definition: class_zone.h:743
int ZONE_CONTAINER::GetDefaultHatchPitch ( )
static

Function GetDefaultHatchPitchMils.

Returns
int - the default hatch pitch in internal units.

Definition at line 1298 of file class_zone.cpp.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadZONE_CONTAINER(), and PCB_PARSER::parseZONE_CONTAINER().

1299 {
1300  return Mils2iu( 20 );
1301 }
bool ZONE_CONTAINER::GetDoNotAllowCopperPour ( ) const
inline
bool ZONE_CONTAINER::GetDoNotAllowTracks ( ) const
inline
bool ZONE_CONTAINER::GetDoNotAllowVias ( ) const
inline
const SHAPE_POLY_SET& ZONE_CONTAINER::GetFilledPolysList ( ) const
inline
int ZONE_CONTAINER::GetFillMode ( ) const
inline

Definition at line 201 of file class_zone.h.

References m_FillMode.

Referenced by PCB_IO::format(), IsSame(), ZONE_SETTINGS::operator<<(), and BRDITEMS_PLOTTER::PlotFilledAreas().

201 { return m_FillMode; }
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 269 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), LIB_EDIT_FRAME::LoadOneSymbol(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow().

269 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
const std::vector<SEG>& ZONE_CONTAINER::GetHatchLines ( ) const
inline

Definition at line 729 of file class_zone.h.

References m_HatchLines.

Referenced by KIGFX::PCB_PAINTER::draw().

729 { return m_HatchLines; }
std::vector< SEG > m_HatchLines
Definition: class_zone.h:811
int ZONE_CONTAINER::GetHatchPitch ( ) const

Hatch related methods.

Function GetHatchPitch

Returns
int - the zone hatch pitch in iu.

Definition at line 1100 of file class_zone.cpp.

References m_hatchPitch.

Referenced by PCB_IO::format(), and operator=().

1101 {
1102  return m_hatchPitch;
1103 }
HATCH_STYLE ZONE_CONTAINER::GetHatchStyle ( ) const
inline

Definition at line 564 of file class_zone.h.

References m_hatchStyle.

Referenced by PCB_IO::format(), BOARD::NormalizeAreaPolygon(), ZONE_SETTINGS::operator<<(), and operator=().

565  {
566  return m_hatchStyle;
567  }
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:809
PCB_LAYER_ID ZONE_CONTAINER::GetLayer ( ) const
overridevirtual

Function GetLayer returns the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 182 of file class_zone.cpp.

References BOARD_ITEM::GetLayer().

Referenced by PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_SelectItems(), buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), BOARD::CombineAllAreasInNet(), BOARD::ConvertBrdLayerToPolygonalContours(), GERBER_JOBFILE_WRITER::CreateJobFile(), CINFO3D_VISU::createLayers(), DRC::doEdgeZoneDrc(), Draw(), DrawFilledArea(), DRAWING_TOOL::DrawVia(), DrawWhileCreateOutline(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::End_Zone(), export_vrml_zones(), Flip(), DSN::SPECCTRA_DB::FromBOARD(), Hatch(), BOARD::HitTestForAnyFilledArea(), DIALOG_NON_COPPER_ZONES_EDITOR::Init(), IsOnCopperLayer(), IsSame(), BOARD::NormalizeAreaPolygon(), BOARD::OnAreaPolygonModified(), ZONE_SETTINGS::operator<<(), BRDITEMS_PLOTTER::PlotFilledAreas(), PlotSilkScreen(), PlotSolderMaskLayer(), PlotStandardLayer(), PCB_EDIT_FRAME::PrintPage(), BOARD::RedrawAreasOutlines(), BOARD::RedrawFilledAreas(), PCB_EDIT_FRAME::Remove_Zone_Corner(), SaveCopyOfZones(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines(), BOARD::TestAreaIntersection(), BOARD::TestAreaIntersections(), and PCB_EDITOR_CONTROL::ZoneMerge().

183 {
184  return BOARD_ITEM::GetLayer();
185 }
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
wxString BOARD_ITEM::GetLayerName ( ) const
inherited

Function GetLayerName returns the name of the PCB layer on which the item resides.

Returns
wxString containing the layer name associated with this item.

Definition at line 77 of file class_board_item.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_Layer.

Referenced by PCB_IO::format(), PCB_IO::formatLayer(), TEXTE_PCB::GetMsgPanelInfo(), EDGE_MODULE::GetMsgPanelInfo(), GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_PCB::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), DIMENSION::GetSelectMenuText(), DRAWSEGMENT::GetSelectMenuText(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), MODULE::GetSelectMenuText(), and GetSelectMenuText().

78 {
79  BOARD* board = GetBoard();
80 
81  if( board )
82  return board->GetLayerName( m_Layer );
83 
84  // If no parent, return standard name
86 }
PCB_LAYER_ID m_Layer
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:647
LSET ZONE_CONTAINER::GetLayerSet ( ) const
overridevirtual

Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides.

Returns
int - a layer mask, see layers_id_colors_visibility.h.

Reimplemented from BOARD_ITEM.

Definition at line 237 of file class_zone.cpp.

References GetIsKeepout(), BOARD_ITEM::m_Layer, and m_layerSet.

Referenced by buildFeatureHoleList(), CommonLayerExists(), Draw(), Flip(), PCB_IO::format(), ZONE_SETTINGS::operator<<(), operator=(), SELECTION_TOOL::selectable(), and ZONE_CONTAINER().

238 {
239  // TODO - Enable multi-layer zones for all zone types
240  // not just keepout zones
241  if( GetIsKeepout() )
242  {
243  return m_layerSet;
244  }
245  else
246  {
247  return LSET( m_Layer );
248  }
249 }
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
PCB_LAYER_ID m_Layer
Class LSET is a set of PCB_LAYER_IDs.
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
int ZONE_CONTAINER::GetLocalFlags ( ) const
inline

Definition at line 256 of file class_zone.h.

References m_localFlgs.

Referenced by BOARD::CombineAllAreasInNet(), and ZONE_CONTAINER().

256 { return m_localFlgs; }
int m_localFlgs
Variable used in polygon calculations.
Definition: class_zone.h:791
bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const
inlineinherited
BITMAP_DEF ZONE_CONTAINER::GetMenuImage ( ) const
overridevirtual

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1304 of file class_zone.cpp.

1305 {
1306  return add_zone_xpm;
1307 }
void ZONE_CONTAINER::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 820 of file class_zone.cpp.

References AccumulateDescription(), BLUE, BROWN, DARKCYAN, GetDoNotAllowCopperPour(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetIsKeepout(), BOARD_ITEM::GetLayerName(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), GetPriority(), SHAPE_POLY_SET::IsEmpty(), IsOnCopperLayer(), SHAPE_POLY_SET::VERTEX_INDEX::m_contour, m_CornerSelection, m_FilledPolysList, m_FillMode, m_HatchLines, m_Poly, RED, and SHAPE_POLY_SET::TotalVertices().

821 {
822  wxString msg;
823 
824  msg = _( "Zone Outline" );
825 
826  // Display Cutout instead of Outline for holes inside a zone
827  // i.e. when num contour !=0
828  // Check whether the selected corner is in a hole; i.e., in any contour but the first one.
829  if( m_CornerSelection != nullptr && m_CornerSelection->m_contour > 0 )
830  msg << wxT( " " ) << _( "(Cutout)" );
831 
832  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg, DARKCYAN ) );
833 
834  if( GetIsKeepout() )
835  {
836  msg.Empty();
837 
838  if( GetDoNotAllowVias() )
839  AccumulateDescription( msg, _( "No via" ) );
840 
841  if( GetDoNotAllowTracks() )
842  AccumulateDescription( msg, _("No track") );
843 
845  AccumulateDescription( msg, _("No copper pour") );
846 
847  aList.push_back( MSG_PANEL_ITEM( _( "Keepout" ), msg, RED ) );
848  }
849  else if( IsOnCopperLayer() )
850  {
851  if( GetNetCode() >= 0 )
852  {
853  NETINFO_ITEM* net = GetNet();
854 
855  if( net )
856  msg = net->GetNetname();
857  else // Should not occur
858  msg = _( "<unknown>" );
859  }
860  else // a netcode < 0 is an error
861  msg = wxT( "<error>" );
862 
863  aList.push_back( MSG_PANEL_ITEM( _( "NetName" ), msg, RED ) );
864 
865  // Display net code : (useful in test or debug)
866  msg.Printf( wxT( "%d" ), GetNetCode() );
867  aList.push_back( MSG_PANEL_ITEM( _( "NetCode" ), msg, RED ) );
868 
869  // Display priority level
870  msg.Printf( wxT( "%d" ), GetPriority() );
871  aList.push_back( MSG_PANEL_ITEM( _( "Priority" ), msg, BLUE ) );
872  }
873  else
874  {
875  aList.push_back( MSG_PANEL_ITEM( _( "Non Copper Zone" ), wxEmptyString, RED ) );
876  }
877 
878  aList.push_back( MSG_PANEL_ITEM( _( "Layer" ), GetLayerName(), BROWN ) );
879 
880  msg.Printf( wxT( "%d" ), (int) m_Poly->TotalVertices() );
881  aList.push_back( MSG_PANEL_ITEM( _( "Corners" ), msg, BLUE ) );
882 
883  if( m_FillMode )
884  msg = _( "Segments" );
885  else
886  msg = _( "Polygons" );
887 
888  aList.push_back( MSG_PANEL_ITEM( _( "Fill Mode" ), msg, BROWN ) );
889 
890  // Useful for statistics :
891  msg.Printf( wxT( "%d" ), (int) m_HatchLines.size() );
892  aList.push_back( MSG_PANEL_ITEM( _( "Hatch Lines" ), msg, BLUE ) );
893 
894  if( !m_FilledPolysList.IsEmpty() )
895  {
896  msg.Printf( wxT( "%d" ), m_FilledPolysList.TotalVertices() );
897  aList.push_back( MSG_PANEL_ITEM( _( "Corner Count" ), msg, BLUE ) );
898  }
899 }
Definition: colors.h:57
bool GetDoNotAllowCopperPour() const
Definition: class_zone.h:673
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:788
int TotalVertices() const
Returns total number of vertices stored in the set.
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
std::vector< SEG > m_HatchLines
Definition: class_zone.h:811
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
Definition: colors.h:60
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
int GetNetCode() const
Function GetNetCode.
void AccumulateDescription(wxString &aDesc, const wxString &aItem)
Utility to build comma separated lists in messages.
Definition: macros.h:65
Class NETINFO_ITEM handles the data for a net.
Definition: class_netinfo.h:69
bool IsOnCopperLayer() const
Function IsOnCopperLayer.
Definition: class_zone.cpp:188
bool GetDoNotAllowTracks() const
Definition: class_zone.h:675
bool GetDoNotAllowVias() const
Definition: class_zone.h:674
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
const wxString & GetNetname() const
Function GetNetname.
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:119
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
Definition: colors.h:62
NETCLASSPTR BOARD_CONNECTED_ITEM::GetNetClass ( ) const
inherited

Function GetNetClass returns the NETCLASS for this item.

Definition at line 104 of file class_board_connected_item.cpp.

References DBG, BOARD::FindNet(), BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), NETINFO_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetCode(), and EDA_ITEM::Type().

Referenced by DIALOG_TRACK_VIA_PROPERTIES::Apply(), DRC::doTrackDrc(), BOARD_CONNECTED_ITEM::GetClearance(), GetClearance(), VIA::GetDrillValue(), TRACK::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClassName(), and ROUTER_TOOL::prepareInteractive().

105 {
106  // It is important that this be implemented without any sequential searching.
107  // Simple array lookups should be fine, performance-wise.
108  BOARD* board = GetBoard();
109 
110  // DO NOT use wxASSERT, because GetNetClass is called inside an OnPaint event
111  // and a call to wxASSERT can crash the application.
112 
113  if( board == NULL ) // Should not occur
114  {
115  DBG(printf( "%s: NULL board,type %d", __func__, Type() );)
116 
117  return NETCLASSPTR();
118  }
119 
120  NETCLASSPTR netclass;
121  NETINFO_ITEM* net = board->FindNet( GetNetCode() );
122 
123  if( net )
124  {
125  netclass = net->GetNetClass();
126 
127  //DBG( if(!netclass) printf( "%s: NULL netclass,type %d", __func__, Type() );)
128  }
129 
130  if( netclass )
131  return netclass;
132  else
133  return board->GetDesignSettings().GetDefault();
134 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
NETCLASSPTR GetDefault() const
Function GetDefault.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
int GetNetCode() const
Function GetNetCode.
Class NETINFO_ITEM handles the data for a net.
Definition: class_netinfo.h:69
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
NETCLASSPTR GetNetClass()
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
#define DBG(x)
Definition: fctsys.h:33
wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const
inherited

Function GetNetClassName returns a pointer to the netclass of the zone.

If the net is not found (can happen when a netlist is reread, and the net name does not exist, return the default net class (should not return a null pointer).

Returns
the Net Class name of this item

Definition at line 137 of file class_board_connected_item.cpp.

References NETCLASS::Default, BOARD_CONNECTED_ITEM::GetNetClass(), and name.

Referenced by PCB_EDIT_FRAME::createPopUpMenuForFpPads(), and PCB_EDIT_FRAME::createPopupMenuForTracks().

138 {
139  wxString name;
140  NETCLASSPTR myclass = GetNetClass();
141 
142  if( myclass )
143  name = myclass->GetName();
144  else
145  name = NETCLASS::Default;
146 
147  return name;
148 }
std::shared_ptr< NETCLASS > GetNetClass() const
Function GetNetClass returns the NETCLASS for this item.
static const char Default[]
the name of the default NETCLASS
const char * name
int BOARD_CONNECTED_ITEM::GetNetCode ( ) const
inlineinherited

Function GetNetCode.

Returns
int - the net code.

Definition at line 103 of file class_board_connected_item.h.

References NETINFO_ITEM::GetNet(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by AddClearanceAreasPolygonsToPolysList_NG(), PCB_EDIT_FRAME::Attribut_net(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), Build_Work(), buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), PCB_EDIT_FRAME::Change_Net_Tracks_And_Vias_Sizes(), Collect_TrackSegmentsToDrag(), BOARD::CombineAllAreasInNet(), D_PAD::CopyNetlistSettings(), CreateRoutesSection(), CreateSignalsSection(), PCB_EDIT_FRAME::Delete_net(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Track(), DRC::doEdgeZoneDrc(), DRC::doPadToPadsDrc(), DRC::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), VIA::Draw(), BOARD::DrawHighLight(), D_PAD::DrawShape(), TRACK::DrawShortNetname(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::End_Zone(), PCB_EDIT_FRAME::EraseRedundantTrack(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::Fill_Zone(), PNS::NODE::FindItemByParent(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), TRACK::GetBestInsertPoint(), CONNECTIVITY_DATA::GetConnectedItems(), TRACK::GetEndNetCode(), GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), TRACK::GetSelectMenuText(), VIA::GetSelectMenuText(), GetSelectMenuText(), TRACK::GetStartNetCode(), TRACK::GetTrack(), hash_eda(), BOARD::HitTestForAnyFilledArea(), IsSame(), LocateIntrusion(), Magnetize(), DSN::SPECCTRA_DB::makeIMAGE(), CONNECTIVITY_DATA::NearestUnconnectedTargets(), BOARD::NormalizeAreaPolygon(), BOARD::OnAreaPolygonModified(), ZONE_SETTINGS::operator<<(), PlaceCells(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_EDIT_FRAME::Process_Special_Functions(), PushTrack(), PCB_EDIT_FRAME::Remove_One_Track(), PCB_EDIT_FRAME::Remove_Zone_Corner(), TRACKS_CLEANER::removeDuplicatesOfTrack(), BOARD::ReplaceNetlist(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), BOARD::SetAreasNetCodesFromNetNames(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PNS_KICAD_IFACE::syncPad(), PNS_KICAD_IFACE::syncTrack(), PNS_KICAD_IFACE::syncVia(), BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines(), BOARD::TestAreaIntersections(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC::testZones(), TrackListSortByNetcode(), BOARD::TracksInNet(), NETINFO_MAPPING::Update(), ZONE_CONTAINER(), and PCB_EDITOR_CONTROL::ZoneMerge().

104  {
105  return m_netinfo->GetNet();
106  }
int GetNet() const
Function GetNet.
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
int BOARD_ITEM::getNextNumberInSequence ( const std::set< int > &  aSeq,
bool  aFillSequenceGaps 
)
staticprotectedinherited

Definition at line 223 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

224 {
225  if( aSeq.empty() )
226  return 1;
227 
228  // By default go to the end of the sequence
229  int candidate = *aSeq.rbegin();
230 
231  // Filling in gaps in pad numbering
232  if( aFillSequenceGaps )
233  {
234  // start at the beginning
235  candidate = *aSeq.begin();
236 
237  for( auto it : aSeq )
238  {
239  if( it - candidate > 1 )
240  break;
241 
242  candidate = it;
243  }
244  }
245 
246  ++candidate;
247 
248  return candidate;
249 }
int ZONE_CONTAINER::GetNumCorners ( void  ) const
inline
ZoneConnection ZONE_CONTAINER::GetPadConnection ( D_PAD aPad = NULL) const

Definition at line 1000 of file class_zone.cpp.

References D_PAD::GetZoneConnection(), m_PadConnection, and PAD_ZONE_CONN_INHERITED.

Referenced by buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), PCB_IO::format(), and ZONE_SETTINGS::operator<<().

1001 {
1002  if( aPad == NULL || aPad->GetZoneConnection() == PAD_ZONE_CONN_INHERITED )
1003  return m_PadConnection;
1004  else
1005  return aPad->GetZoneConnection();
1006 }
ZoneConnection m_PadConnection
Definition: class_zone.h:766
ZoneConnection GetZoneConnection() const
Definition: class_pad.cpp:650
BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 118 of file class_board_item.h.

References EDA_ITEM::m_Parent.

Referenced by Abort_Move_ModuleOutline(), AbortMoveTextModule(), POINT_EDITOR::addCorner(), CmpHoleSorting(), compute_Ratsnest_PlaceModule(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::DeleteTextModule(), DialogEditModuleText::DialogEditModuleText(), KIGFX::PCB_PAINTER::draw(), TEXTE_MODULE::DrawUmbilical(), PCB_EDIT_FRAME::duplicateItems(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), LEGACY_ARRAY_CREATOR::getModule(), EDGE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetShownText(), GENERAL_COLLECTOR::Inspect(), LEGACY_PLUGIN::loadMODULE_TEXT(), PCB_EDIT_FRAME::moveExact(), FOOTPRINT_EDIT_FRAME::OnRightClick(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_BASE_FRAME::PlaceTexteModule(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotTextModule(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_FRAME::ResetTextSize(), PCB_BASE_FRAME::RotateTextModule(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), PCB_BASE_FRAME::StartMoveTexteModule(), and SwapItemData().

118 { return (BOARD_ITEM_CONTAINER*) m_Parent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:182
Abstract interface for BOARD_ITEMs capable of storing other items inside.
const wxPoint & ZONE_CONTAINER::GetPosition ( ) const
overridevirtual

Function GetPosition.

Returns a reference to the first corner of the polygon set.

Warning
The implementation of this function relies on the fact that wxPoint and VECTOR2I have the same layout. If you intend to use the returned reference directly, please note that you are only allowed to use members x and y. Any use on anything that is not one of these members will have undefined behaviour.
Returns
a wxPoint, position of the first point of the outline

Implements BOARD_ITEM.

Definition at line 170 of file class_zone.cpp.

References GetCornerPosition(), and ZONE_CONTAINER::WX_VECTOR_CONVERTER::wx.

Referenced by DRC::fillMarker().

171 {
172  const WX_VECTOR_CONVERTER* pos;
173 
174  // The retrieved vertex is a VECTOR2I. Casting it to a union WX_VECTOR_CONVERTER, we can later
175  // return the object shaped as a wxPoint. See the definition of the union in class_zone.h for
176  // more information on this hack.
177  pos = reinterpret_cast<const WX_VECTOR_CONVERTER*>( &GetCornerPosition( 0 ) );
178  return pos->wx;
179 }
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
Definition: class_zone.h:520
unsigned ZONE_CONTAINER::GetPriority ( ) const
inline
int ZONE_CONTAINER::GetSelectedCorner ( ) const
inline

Definition at line 227 of file class_zone.h.

References SHAPE_POLY_SET::GetGlobalIndex(), m_CornerSelection, and m_Poly.

Referenced by Abort_Zone_Move_Corner_Or_Outlines(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Zone_Contour(), PCB_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Remove_Zone_Corner(), and Show_Zone_Corner_Or_Outline_While_Move_Mouse().

228  {
229  // Transform relative indices to global index
230  int globalIndex;
231  m_Poly->GetGlobalIndex( *m_CornerSelection, globalIndex );
232 
233  return globalIndex;
234  }
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:788
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
bool GetGlobalIndex(VERTEX_INDEX aRelativeIndices, int &aGlobalIdx)
Function GetGlobalIndex computes the global index of a vertex from the relative indices of polygon...
wxString ZONE_CONTAINER::GetSelectMenuText ( ) const
overridevirtual

Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1050 of file class_zone.cpp.

References Format(), BOARD_ITEM::GetBoard(), GetChars(), GetIsKeepout(), BOARD_ITEM::GetLayerName(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), NETINFO_ITEM::GetNetname(), SHAPE_POLY_SET::VERTEX_INDEX::m_contour, m_CornerSelection, and EDA_ITEM::m_TimeStamp.

Referenced by DRC::fillMarker(), and BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines().

1051 {
1052  wxString text;
1053  NETINFO_ITEM* net;
1054  BOARD* board = GetBoard();
1055 
1056  // Check whether the selected contour is a hole (contour index > 0)
1057  if( m_CornerSelection != nullptr && m_CornerSelection->m_contour > 0 )
1058  text << wxT( " " ) << _( "(Cutout)" );
1059 
1060  if( GetIsKeepout() )
1061  text << wxT( " " ) << _( "(Keepout)" );
1062 
1063  text << wxString::Format( wxT( " (%08lX)" ), m_TimeStamp );
1064 
1065  // Display net name for copper zones
1066  if( !GetIsKeepout() )
1067  {
1068  if( GetNetCode() >= 0 )
1069  {
1070  if( board )
1071  {
1072  net = GetNet();
1073 
1074  if( net )
1075  {
1076  text << wxT( " [" ) << net->GetNetname() << wxT( "]" );
1077  }
1078  }
1079  else
1080  {
1081  text << _( "** NO BOARD DEFINED **" );
1082  }
1083  }
1084  else
1085  { // A netcode < 0 is an error:
1086  // Netname not found or area not initialised
1087  text << wxT( " [" ) << GetNetname() << wxT( "]" );
1088  text << wxT( " <" ) << _( "Not Found" ) << wxT( ">" );
1089  }
1090  }
1091 
1092  wxString msg;
1093  msg.Printf( _( "Zone Outline %s on %s" ), GetChars( text ),
1094  GetChars( GetLayerName() ) );
1095 
1096  return msg;
1097 }
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:183
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:788
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
int GetNetCode() const
Function GetNetCode.
Class NETINFO_ITEM handles the data for a net.
Definition: class_netinfo.h:69
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
const wxString & GetNetname() const
Function GetNetname.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const wxString & GetNetname() const
Function GetNetname.
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
const wxString& BOARD_CONNECTED_ITEM::GetShortNetname ( ) const
inlineinherited

Function GetShortNetname.

Returns
wxString - the short netname

Definition at line 131 of file class_board_connected_item.h.

References NETINFO_ITEM::GetShortNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by KIGFX::PCB_PAINTER::draw(), and D_PAD::DrawShape().

132  {
133  return m_netinfo->GetShortNetname();
134  }
const wxString & GetShortNetname() const
Function GetShortNetname.
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
SHAPE_POLY_SET* ZONE_CONTAINER::GetSmoothedPoly ( ) const
inline

Function GetSmoothedPoly returns a pointer to the corner-smoothed version of m_Poly if it exists, otherwise it returns m_Poly.

Returns
SHAPE_POLY_SET* - pointer to the polygon.

Definition at line 620 of file class_zone.h.

References m_Poly, and m_smoothedPoly.

Referenced by BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines().

621  {
622  if( m_smoothedPoly )
623  return m_smoothedPoly;
624  else
625  return m_Poly;
626  };
SHAPE_POLY_SET * m_smoothedPoly
Definition: class_zone.h:742
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 264 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

264 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:175
int ZONE_CONTAINER::GetThermalReliefCopperBridge ( D_PAD aPad = NULL) const

Definition at line 644 of file class_zone.cpp.

References D_PAD::GetThermalWidth(), and m_ThermalReliefCopperBridge.

Referenced by buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), PCB_IO::format(), and ZONE_SETTINGS::operator<<().

645 {
646  if( aPad == NULL || aPad->GetThermalWidth() == 0 )
648  else
649  return aPad->GetThermalWidth();
650 }
int m_ThermalReliefCopperBridge
Definition: class_zone.h:781
int GetThermalWidth() const
Definition: class_pad.cpp:661
int ZONE_CONTAINER::GetThermalReliefGap ( D_PAD aPad = NULL) const

Definition at line 635 of file class_zone.cpp.

References D_PAD::GetThermalGap(), and m_ThermalReliefGap.

Referenced by buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), PCB_IO::format(), and ZONE_SETTINGS::operator<<().

636 {
637  if( aPad == NULL || aPad->GetThermalGap() == 0 )
638  return m_ThermalReliefGap;
639  else
640  return aPad->GetThermalGap();
641 }
int GetThermalGap() const
Definition: class_pad.cpp:672
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:778
int BOARD_ITEM::getTrailingInt ( wxString  aStr)
staticprotectedinherited

Definition at line 200 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

201 {
202  int number = 0;
203  int base = 1;
204 
205  // Trim and extract the trailing numeric part
206  int index = aStr.Len() - 1;
207  while( index >= 0 )
208  {
209  const char chr = aStr.GetChar( index );
210 
211  if( chr < '0' || chr > '9' )
212  break;
213 
214  number += ( chr - '0' ) * base;
215  base *= 10;
216  index--;
217  }
218 
219  return number;
220 }
int ZONE_CONTAINER::GetZoneClearance ( ) const
inline

Definition at line 218 of file class_zone.h.

References m_ZoneClearance.

Referenced by buildFeatureHoleList(), BuildUnconnectedThermalStubsPolygonList(), DRC::doEdgeZoneDrc(), PCB_IO::format(), and ZONE_SETTINGS::operator<<().

218 { return m_ZoneClearance; }
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:767
void ZONE_CONTAINER::Hatch ( )

Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's attribute m_HatchLines.

Definition at line 1136 of file class_zone.cpp.

References SEG::A, SEG::B, DIAGONAL_EDGE, DIAGONAL_FULL, FindLineSegmentIntersection(), GetLayer(), SHAPE_POLY_SET::IsEmpty(), SHAPE_POLY_SET::IterateSegmentsWithHoles(), SHAPE_POLY_SET::IterateWithHoles(), KiROUND(), m_HatchLines, m_hatchPitch, m_hatchStyle, m_Poly, MAXPTS, NO_HATCH, sortEndsByDescendingX(), UnHatch(), SHAPE_POLY_SET::Vertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by POINT_EDITOR::addCorner(), BOARD::CombineAreas(), ZONE_CREATE_HELPER::commitZone(), PCB_EDIT_FRAME::duplicateZone(), Mirror(), Move(), MoveEdge(), BOARD::NormalizeAreaPolygon(), Rotate(), SetHatch(), and POINT_EDITOR::updateItem().

1137 {
1138  UnHatch();
1139 
1140  if( m_hatchStyle == NO_HATCH || m_hatchPitch == 0 || m_Poly->IsEmpty() )
1141  return;
1142 
1143  // define range for hatch lines
1144  int min_x = m_Poly->Vertex( 0 ).x;
1145  int max_x = m_Poly->Vertex( 0 ).x;
1146  int min_y = m_Poly->Vertex( 0 ).y;
1147  int max_y = m_Poly->Vertex( 0 ).y;
1148 
1149  for( auto iterator = m_Poly->IterateWithHoles(); iterator; iterator++ )
1150  {
1151  if( iterator->x < min_x )
1152  min_x = iterator->x;
1153 
1154  if( iterator->x > max_x )
1155  max_x = iterator->x;
1156 
1157  if( iterator->y < min_y )
1158  min_y = iterator->y;
1159 
1160  if( iterator->y > max_y )
1161  max_y = iterator->y;
1162  }
1163 
1164  // Calculate spacing between 2 hatch lines
1165  int spacing;
1166 
1167  if( m_hatchStyle == DIAGONAL_EDGE )
1168  spacing = m_hatchPitch;
1169  else
1170  spacing = m_hatchPitch * 2;
1171 
1172  // set the "length" of hatch lines (the length on horizontal axis)
1173  int hatch_line_len = m_hatchPitch;
1174 
1175  // To have a better look, give a slope depending on the layer
1176  LAYER_NUM layer = GetLayer();
1177  int slope_flag = (layer & 1) ? 1 : -1; // 1 or -1
1178  double slope = 0.707106 * slope_flag; // 45 degrees slope
1179  int max_a, min_a;
1180 
1181  if( slope_flag == 1 )
1182  {
1183  max_a = KiROUND( max_y - slope * min_x );
1184  min_a = KiROUND( min_y - slope * max_x );
1185  }
1186  else
1187  {
1188  max_a = KiROUND( max_y - slope * max_x );
1189  min_a = KiROUND( min_y - slope * min_x );
1190  }
1191 
1192  min_a = (min_a / spacing) * spacing;
1193 
1194  // calculate an offset depending on layer number,
1195  // for a better look of hatches on a multilayer board
1196  int offset = (layer * 7) / 8;
1197  min_a += offset;
1198 
1199  // loop through hatch lines
1200  #define MAXPTS 200 // Usually we store only few values per one hatch line
1201  // depending on the complexity of the zone outline
1202 
1203  static std::vector<VECTOR2I> pointbuffer;
1204  pointbuffer.clear();
1205  pointbuffer.reserve( MAXPTS + 2 );
1206 
1207  for( int a = min_a; a < max_a; a += spacing )
1208  {
1209  // get intersection points for this hatch line
1210 
1211  // Note: because we should have an even number of intersections with the
1212  // current hatch line and the zone outline (a closed polygon,
1213  // or a set of closed polygons), if an odd count is found
1214  // we skip this line (should not occur)
1215  pointbuffer.clear();
1216 
1217  // Iterate through all vertices
1218  for( auto iterator = m_Poly->IterateSegmentsWithHoles(); iterator; iterator++ )
1219  {
1220  double x, y, x2, y2;
1221  int ok;
1222 
1223  SEG segment = *iterator;
1224 
1225  ok = FindLineSegmentIntersection( a, slope,
1226  segment.A.x, segment.A.y,
1227  segment.B.x, segment.B.y,
1228  &x, &y, &x2, &y2 );
1229 
1230  if( ok )
1231  {
1232  VECTOR2I point( KiROUND( x ), KiROUND( y ) );
1233  pointbuffer.push_back( point );
1234  }
1235 
1236  if( ok == 2 )
1237  {
1238  VECTOR2I point( KiROUND( x2 ), KiROUND( y2 ) );
1239  pointbuffer.push_back( point );
1240  }
1241 
1242  if( pointbuffer.size() >= MAXPTS ) // overflow
1243  {
1244  wxASSERT( 0 );
1245  break;
1246  }
1247  }
1248 
1249  // ensure we have found an even intersection points count
1250  // because intersections are the ends of segments
1251  // inside the polygon(s) and a segment has 2 ends.
1252  // if not, this is a strange case (a bug ?) so skip this hatch
1253  if( pointbuffer.size() % 2 != 0 )
1254  continue;
1255 
1256  // sort points in order of descending x (if more than 2) to
1257  // ensure the starting point and the ending point of the same segment
1258  // are stored one just after the other.
1259  if( pointbuffer.size() > 2 )
1260  sort( pointbuffer.begin(), pointbuffer.end(), sortEndsByDescendingX );
1261 
1262  // creates lines or short segments inside the complex polygon
1263  for( unsigned ip = 0; ip < pointbuffer.size(); ip += 2 )
1264  {
1265  int dx = pointbuffer[ip + 1].x - pointbuffer[ip].x;
1266 
1267  // Push only one line for diagonal hatch,
1268  // or for small lines < twice the line length
1269  // else push 2 small lines
1270  if( m_hatchStyle == DIAGONAL_FULL || fabs( dx ) < 2 * hatch_line_len )
1271  {
1272  m_HatchLines.push_back( SEG( pointbuffer[ip], pointbuffer[ip + 1] ) );
1273  }
1274  else
1275  {
1276  double dy = pointbuffer[ip + 1].y - pointbuffer[ip].y;
1277  slope = dy / dx;
1278 
1279  if( dx > 0 )
1280  dx = hatch_line_len;
1281  else
1282  dx = -hatch_line_len;
1283 
1284  int x1 = KiROUND( pointbuffer[ip].x + dx );
1285  int x2 = KiROUND( pointbuffer[ip + 1].x - dx );
1286  int y1 = KiROUND( pointbuffer[ip].y + dx * slope );
1287  int y2 = KiROUND( pointbuffer[ip + 1].y - dx * slope );
1288 
1289  m_HatchLines.push_back(SEG(pointbuffer[ip].x, pointbuffer[ip].y, x1, y1));
1290 
1291  m_HatchLines.push_back( SEG( pointbuffer[ip+1].x, pointbuffer[ip+1].y, x2, y2 ) );
1292  }
1293  }
1294  }
1295 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:106
SEGMENT_ITERATOR IterateSegmentsWithHoles()
Returns an iterator object, for all outlines in the set (with holes)
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
VECTOR2I & Vertex(int aIndex, int aOutline, int aHole)
Returns the index-th vertex in a given hole outline within a given outline
#define MAXPTS
bool sortEndsByDescendingX(const VECTOR2I &ref, const VECTOR2I &tst)
std::vector< SEG > m_HatchLines
Definition: class_zone.h:811
ITERATOR IterateWithHoles(int aOutline)
Function IterateWithHoles.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
bool FindLineSegmentIntersection(double a, double b, int xi, int yi, int xf, int yf, double *x1, double *y1, double *x2, double *y2, double *dist)
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:809
Definition: seg.h:36
void UnHatch()
Function UnHatch clears the zone's hatch.
VECTOR2I A
Definition: seg.h:46
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
VECTOR2I B
Definition: seg.h:47
bool ZONE_CONTAINER::HitTest ( const wxPoint aPosition) const
overridevirtual

Function HitTest tests if a point is near an outline edge or a corner of this zone.

Parameters
aPositionthe wxPoint to test
Returns
bool - true if a hit, else false

Reimplemented from BOARD_ITEM.

Definition at line 661 of file class_zone.cpp.

References HitTestForCorner(), and HitTestForEdge().

Referenced by PCB_EDIT_FRAME::Block_SelectItems().

662 {
663  return HitTestForCorner( aPosition ) || HitTestForEdge( aPosition );
664 }
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:702
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:686
bool ZONE_CONTAINER::HitTest ( const EDA_RECT aRect,
bool  aContained = true,
int  aAccuracy = 0 
) const
overridevirtual

Parameters
aRectA reference to an EDA_RECT object containg the area to test.
aContainedTest if aRect contains this object completly.
aAccuracyIncrease the item bounding box by this amount.
Returns
bool - True if aRect contains this object completly or if aRect intersects the object and aContained is False, otherwise false.

Reimplemented from BOARD_ITEM.

Definition at line 718 of file class_zone.cpp.

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), m_Poly, EDA_RECT::Normalize(), SHAPE_POLY_SET::TotalVertices(), and SHAPE_POLY_SET::Vertex().

719 {
720  // Calculate bounding box for zone
721  EDA_RECT bbox = GetBoundingBox();
722  bbox.Normalize();
723 
724  EDA_RECT arect = aRect;
725  arect.Normalize();
726  arect.Inflate( aAccuracy );
727 
728  if( aContained )
729  {
730  return arect.Contains( bbox );
731  }
732  else // Test for intersection between aBox and the polygon
733  // For a polygon, using its bounding box has no sense here
734  {
735  // Fast test: if aBox is outside the polygon bounding box,
736  // rectangles cannot intersect
737  if( !arect.Intersects( bbox ) )
738  return false;
739 
740  // aBox is inside the polygon bounding box,
741  // and can intersect the polygon: use a fine test.
742  // aBox intersects the polygon if at least one aBox corner
743  // is inside the polygon
744 
745  /*
746  wxPoint origin = arect.GetOrigin();
747 
748  int w = arect.GetWidth();
749  int h = arect.GetHeight();
750 
751 
752  if ( HitTestInsideZone( origin ) ||
753  HitTestInsideZone( origin + wxPoint( w, 0 ) ) ||
754  HitTestInsideZone( origin + wxPoint( w, h ) ) ||
755  HitTestInsideZone( origin + wxPoint( 0, h ) ) )
756  {
757  return true;
758  }
759  */
760 
761  // No corner inside aBox, but outlines can intersect aBox
762  // if one of outline corners is inside aBox
763  int count = m_Poly->TotalVertices();
764  for( int ii =0; ii < count; ii++ )
765  {
766  auto vertex = m_Poly->Vertex( ii );
767  auto vertexNext = m_Poly->Vertex( ( ii + 1 ) % count );
768 
769  // Test if the point is within the rect
770  if( arect.Contains( ( wxPoint ) vertex ) )
771  {
772  return true;
773  }
774 
775  // Test if this edge intersects the rect
776  if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
777  {
778  return true;
779  }
780  }
781 
782  return false;
783  }
784 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox (virtual)
Definition: class_zone.cpp:525
bool Contains(const wxPoint &aPoint) const
Function Contains.
int TotalVertices() const
Returns total number of vertices stored in the set.
VECTOR2I & Vertex(int aIndex, int aOutline, int aHole)
Returns the index-th vertex in a given hole outline within a given outline
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
void Normalize()
Function Normalize ensures that the height ant width are positive.
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
Class EDA_RECT handles the component boundary box.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
bool ZONE_CONTAINER::HitTestFilledArea ( const wxPoint aRefPos) const

Function HitTestFilledArea tests if the given wxPoint is within the bounds of a filled area of this zone.

Parameters
aRefPosA wxPoint to test
Returns
bool - true if a hit, else false

Definition at line 814 of file class_zone.cpp.

References SHAPE_POLY_SET::Contains(), m_FilledPolysList, wxPoint::x, and wxPoint::y.

Referenced by BuildUnconnectedThermalStubsPolygonList(), and BOARD::HitTestForAnyFilledArea().

815 {
816  return m_FilledPolysList.Contains( VECTOR2I( aRefPos.x, aRefPos.y ) );
817 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1) const
Returns true if a given subpolygon contains the point aP.
bool ZONE_CONTAINER::HitTestForCorner ( const wxPoint refPos,
SHAPE_POLY_SET::VERTEX_INDEX aCornerHit 
) const

Function HitTestForCorner tests if the given wxPoint is near a corner.

Parameters
refPosis the wxPoint to test.
aCornerHit[out] is the index of the closest vertex found, useless when return value is false.
Returns
bool - true if some corner was found to be closer to refPos than aClearance; false otherwise.

Definition at line 686 of file class_zone.cpp.

References SHAPE_POLY_SET::CollideVertex(), m_Poly, and MAX_DIST_IN_MM.

Referenced by PCB_EDIT_FRAME::createPopUpMenuForZones(), HitTest(), HitTestForCorner(), and SetSelectedCorner().

688 {
689  int distmax = Millimeter2iu( MAX_DIST_IN_MM );
690 
691  return m_Poly->CollideVertex( VECTOR2I( refPos ), aCornerHit, distmax );
692 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
bool CollideVertex(const VECTOR2I &aPoint, VERTEX_INDEX &aClosestVertex, int aClearance=0)
Function CollideVertex Checks whether aPoint collides with any vertex of any of the contours of the p...
#define MAX_DIST_IN_MM
Definition: class_zone.cpp:684
bool ZONE_CONTAINER::HitTestForCorner ( const wxPoint refPos) const

Function HitTestForCorner tests if the given wxPoint is near a corner.

Parameters
refPosis the wxPoint to test.
Returns
bool - true if some corner was found to be closer to refPos than aClearance; false otherwise.

Definition at line 695 of file class_zone.cpp.

References dummy(), and HitTestForCorner().

696 {
698  return HitTestForCorner( refPos, dummy );
699 }
Struct VERTEX_INDEX.
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
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:686
bool ZONE_CONTAINER::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.

Parameters
refPosis the wxPoint to test.
aCornerHit[out] is the index of the closest vertex found, useless when return value is false.
Returns
bool - true if some edge was found to be closer to refPos than aClearance.

Definition at line 702 of file class_zone.cpp.

References SHAPE_POLY_SET::CollideEdge(), m_Poly, and MAX_DIST_IN_MM.

Referenced by PCB_EDIT_FRAME::createPopUpMenuForZones(), HitTest(), HitTestForEdge(), and SetSelectedCorner().

704 {
705  int distmax = Millimeter2iu( MAX_DIST_IN_MM );
706 
707  return m_Poly->CollideEdge( VECTOR2I( refPos ), aCornerHit, distmax );
708 }
bool CollideEdge(const VECTOR2I &aPoint, VERTEX_INDEX &aClosestVertex, int aClearance=0)
Function CollideEdge Checks whether aPoint collides with any edge of any of the contours of the polyg...
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
#define MAX_DIST_IN_MM
Definition: class_zone.cpp:684
bool ZONE_CONTAINER::HitTestForEdge ( const wxPoint refPos) const

Function HitTestForEdge tests if the given wxPoint is near a segment defined by 2 corners.

Parameters
refPosis the wxPoint to test.
Returns
bool - true if some edge was found to be closer to refPos than aClearance.

Definition at line 711 of file class_zone.cpp.

References dummy(), and HitTestForEdge().

712 {
714  return HitTestForEdge( refPos, dummy );
715 }
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:702
Struct VERTEX_INDEX.
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
bool ZONE_CONTAINER::HitTestInsideZone ( const wxPoint aPosition) const
inline

Function HitTest tests if a point is inside the zone area, i.e.

inside the main outline and outside holes.

Parameters
aPosition: the wxPoint to test
Returns
bool - true if a hit, else false

Definition at line 282 of file class_zone.h.

References SHAPE_POLY_SET::Contains(), and m_Poly.

283  {
284  return m_Poly->Contains( VECTOR2I( aPosition ), 0 );
285  }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1) const
Returns true if a given subpolygon contains the point aP.
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 238 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

238 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool BOARD_CONNECTED_ITEM::IsConnected ( ) const
inlineoverridevirtualinherited

>

Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns
True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented from BOARD_ITEM.

Definition at line 75 of file class_board_connected_item.h.

76  {
77  return true;
78  }
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool ZONE_CONTAINER::IsFilled ( ) const
inline

Definition at line 215 of file class_zone.h.

References m_IsFilled.

Referenced by export_vrml_zones(), POINT_EDITOR::finishItem(), PCB_IO::format(), and ZONE_CREATE_HELPER::performZoneCutout().

215 { return m_IsFilled; }
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:775
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

References HIGHLIGHTED.

237 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
virtual bool BOARD_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

Returns
bool - true if the object is locked, else false

Reimplemented in MODULE, and TRACK.

Definition at line 194 of file class_board_item.h.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), GENERAL_COLLECTOR::Inspect(), PCB_EDITOR_CONTROL::modifyLockSelected(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

195  {
196  // only MODULEs & TRACKs can be locked at this time.
197  return false;
198  }
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

231 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:123
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 230 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

230 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool ZONE_CONTAINER::IsOnCopperLayer ( ) const

Function IsOnCopperLayer.

Returns
true if this zone is on a copper layer, false if on a technical layer

Definition at line 188 of file class_zone.cpp.

References LSET::AllCuMask(), GetIsKeepout(), GetLayer(), IsCopperLayer(), and m_layerSet.

Referenced by PCB_EDIT_FRAME::Begin_Zone(), BuildFilledSolidAreasPolygons(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRC::doEdgeZoneDrc(), PCB_EDIT_FRAME::End_Zone(), GetMsgPanelInfo(), BRDITEMS_PLOTTER::PlotFilledAreas(), BOARD::ReplaceNetlist(), BOARD::SetAreasNetCodesFromNetNames(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), BOARD::Test_Drc_Areas_Outlines_To_Areas_Outlines(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC::testZones(), and TransformOutlinesShapeWithClearanceToPolygon().

189 {
190  if( GetIsKeepout() )
191  {
192  return ( m_layerSet & LSET::AllCuMask() ).count() > 0;
193  }
194  else
195  {
196  return IsCopperLayer( GetLayer() );
197  }
198 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:646
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
bool ZONE_CONTAINER::IsOnLayer ( PCB_LAYER_ID  aLayer) const
overridevirtual

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can do their own form of testing.

Parameters
aLayerThe layer to test for.
Returns
bool - true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 272 of file class_zone.cpp.

References GetIsKeepout(), BOARD_ITEM::IsOnLayer(), and m_layerSet.

Referenced by CINFO3D_VISU::createLayers(), DRC::doTrackKeepoutDrc(), Draw(), KIGFX::PCB_PAINTER::draw(), DrawFilledArea(), DrawWhileCreateOutline(), DSN::SPECCTRA_DB::FromBOARD(), and DRC::testKeepoutAreas().

273 {
274  if( GetIsKeepout() )
275  {
276  return m_layerSet.test( aLayer );
277  }
278 
279  return BOARD_ITEM::IsOnLayer( aLayer );
280 }
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Function IsOnLayer tests to see if this object is on the given layer.
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 458 of file base_struct.h.

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

458 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 236 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

236 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
bool ZONE_CONTAINER::IsSame ( const ZONE_CONTAINER aZoneToCompare)

Function IsSame tests if 2 zones are equivalent: 2 zones are equivalent if they have same parameters and same outlines info, filling is not taken into account.

Function IsSame test is 2 zones are equivalent: 2 zones are equivalent if they have same parameters and same outlines info relative to filling is not take in account.

Parameters
aZoneToCompare= zone to compare with "this"

Definition at line 64 of file zones_functions_for_undo_redo.cpp.

References GetArcSegmentCount(), GetDoNotAllowCopperPour(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetFillMode(), GetIsKeepout(), GetLayer(), GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), GetPriority(), m_ArcToSegmentsCount, m_FillMode, m_PadConnection, m_Poly, m_ThermalReliefCopperBridge, m_ThermalReliefGap, m_ZoneClearance, m_ZoneMinThickness, and Outline().

Referenced by UpdateCopyOfZonesList().

65 {
66  // compare basic parameters:
67  if( GetLayer() != aZoneToCompare.GetLayer() )
68  return false;
69 
70  if( GetNetCode() != aZoneToCompare.GetNetCode() )
71  return false;
72 
73  if( GetPriority() != aZoneToCompare.GetPriority() )
74  return false;
75 
76  // Compare zone specific parameters
77  if( GetIsKeepout() != aZoneToCompare.GetIsKeepout() )
78  return false;
79 
80  if( GetIsKeepout() )
81  {
82  if( GetDoNotAllowCopperPour() != aZoneToCompare.GetDoNotAllowCopperPour() )
83  return false;
84 
85  if( GetDoNotAllowVias() != aZoneToCompare.GetDoNotAllowVias() )
86  return false;
87 
88  if( GetDoNotAllowTracks() != aZoneToCompare.GetDoNotAllowTracks() )
89  return false;
90  }
91 
92  if( m_ArcToSegmentsCount != aZoneToCompare.GetArcSegmentCount() )
93  return false;
94 
95  if( m_ZoneClearance != aZoneToCompare.m_ZoneClearance )
96  return false;
97 
98  if( m_ZoneMinThickness != aZoneToCompare.GetMinThickness() )
99  return false;
100 
101  if( m_FillMode != aZoneToCompare.GetFillMode() )
102  return false;
103 
104  if( m_PadConnection != aZoneToCompare.m_PadConnection )
105  return false;
106 
107  if( m_ThermalReliefGap != aZoneToCompare.m_ThermalReliefGap )
108  return false;
109 
111  return false;
112 
113 
114  // Compare outlines
115  wxASSERT( m_Poly ); // m_Poly == NULL Should never happen
116  wxASSERT( aZoneToCompare.Outline() );
117 
118  if( Outline() != aZoneToCompare.Outline() ) // Compare vector
119  return false;
120 
121  return true;
122 }
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:767
int GetMinThickness() const
Definition: class_zone.h:224
bool GetDoNotAllowCopperPour() const
Definition: class_zone.h:673
int GetArcSegmentCount() const
Definition: class_zone.h:213
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:182
SHAPE_POLY_SET * Outline()
Definition: class_zone.h:262
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:672
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:772
int m_ThermalReliefCopperBridge
Definition: class_zone.h:781
ZoneConnection m_PadConnection
Definition: class_zone.h:766
int m_FillMode
How to fill areas: 0 => use filled polygons, 1 => fill with segments.
Definition: class_zone.h:785
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
int GetNetCode() const
Function GetNetCode.
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:778
bool GetDoNotAllowTracks() const
Definition: class_zone.h:675
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:768
int GetFillMode() const
Definition: class_zone.h:201
bool GetDoNotAllowVias() const
Definition: class_zone.h:674
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:119
bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 235 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), RotateMarkedItems(), SELECTION_TOOL::SanitizeSelection(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::unselect(), and SELECTION_TOOL::unselect().

235 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:134
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

Function IsTrack tests to see if this object is a track or via (or microvia).

form of testing.

Returns
bool - true if a track or via, else false.

Definition at line 185 of file class_board_item.h.

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

Referenced by PCB_EDIT_FRAME::OnHotKey(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

186  {
187  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
188  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 234 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

234 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
SHAPE_POLY_SET::ITERATOR ZONE_CONTAINER::Iterate ( )
inline

Function Iterate returns an iterator to visit all points of the zone's main outline without holes.

Returns
SHAPE_POLY_SET::ITERATOR - an iterator to visit the zone vertices without holes.

Definition at line 490 of file class_zone.h.

References SHAPE_POLY_SET::Iterate(), and m_Poly.

491  {
492  return m_Poly->Iterate();
493  }
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 * m_Poly
Outline of the zone.
Definition: class_zone.h:741
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 132 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:178
SHAPE_POLY_SET::ITERATOR ZONE_CONTAINER::IterateWithHoles ( )
inline

Function IterateWithHoles returns an iterator to visit all points of the zone's main outline with holes.

Returns
SHAPE_POLY_SET::ITERATOR - an iterator to visit the zone vertices with holes.

Definition at line 500 of file class_zone.h.

References SHAPE_POLY_SET::IterateWithHoles(), and m_Poly.

Referenced by PCB_IO::format(), and DSN::SPECCTRA_DB::FromBOARD().

501  {
502  return m_Poly->IterateWithHoles();
503  }
ITERATOR IterateWithHoles(int aOutline)
Function IterateWithHoles.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

Function Matches compares the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 414 of file base_struct.h.

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), and SCH_SHEET::Matches().

415  {
416  return false;
417  }
bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 184 of file base_struct.cpp.

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

185 {
186  wxString text = aText;
187  wxString searchText = aSearchData.GetFindString();
188 
189  // Don't match if searching for replaceable item and the item doesn't support text replace.
190  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
191  return false;
192 
193  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
194  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
195 
196  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
197  {
198  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
199  return text.Matches( searchText );
200 
201  return text.MakeUpper().Matches( searchText.MakeUpper() );
202  }
203 
204  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
205  return aText.Find( searchText ) != wxNOT_FOUND;
206 
207  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
208 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:458
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
void ZONE_CONTAINER::Mirror ( const wxPoint mirror_ref)

Function Mirror Mirror the outlines , relative to a given horizontal axis the layer is not changed.

Parameters
mirror_ref= vertical axis position

Definition at line 976 of file class_zone.cpp.

References Hatch(), SHAPE_POLY_SET::Iterate(), SHAPE_POLY_SET::IterateWithHoles(), m_FilledPolysList, m_FillSegmList, m_Poly, MIRROR(), and wxPoint::y.

Referenced by Flip().

977 {
978  for( auto iterator = m_Poly->IterateWithHoles(); iterator; iterator++ )
979  {
980  int py = mirror_ref.y - iterator->y;
981  iterator->y = py + mirror_ref.y;
982  }
983 
984  Hatch();
985 
986  for( auto ic = m_FilledPolysList.Iterate(); ic; ++ic )
987  {
988  int py = mirror_ref.y - ic->y;
989  ic->y = py + mirror_ref.y;
990  }
991 
992  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
993  {
994  MIRROR( m_FillSegmList[ic].m_Start.y, mirror_ref.y );
995  MIRROR( m_FillSegmList[ic].m_End.y, mirror_ref.y );
996  }
997 }
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...
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:111
ITERATOR IterateWithHoles(int aOutline)
Function IterateWithHoles.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 239 of file class_board_item.h.

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

240  {
241  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
242  }
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.
void ZONE_CONTAINER::Move ( const wxPoint offset)
overridevirtual

Function Move Move the outlines.

Parameters
offset= moving vector

Reimplemented from BOARD_ITEM.

Definition at line 904 of file class_zone.cpp.

References Hatch(), m_FilledPolysList, m_FillSegmList, m_Poly, SHAPE_POLY_SET::Move(), wxPoint::x, and wxPoint::y.

Referenced by Abort_Zone_Move_Corner_Or_Outlines(), and Show_Zone_Corner_Or_Outline_While_Move_Mouse().

905 {
906  /* move outlines */
907  m_Poly->Move( VECTOR2I( offset ) );
908 
909  Hatch();
910 
911  m_FilledPolysList.Move( VECTOR2I( offset.x, offset.y ) );
912 
913  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
914  {
915  m_FillSegmList[ic].m_Start += offset;
916  m_FillSegmList[ic].m_End += offset;
917  }
918 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
void Move(const VECTOR2I &aVector) override
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:806
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
std::vector< SEGMENT > m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:796
void ZONE_CONTAINER::MoveEdge ( const wxPoint offset,
int  aEdge 
)

Function MoveEdge Move the outline Edge.

Parameters
offset= moving vector
aEdge= start point of the outline edge

Definition at line 921 of file class_zone.cpp.

References SHAPE_POLY_SET::GetNeighbourIndexes(), Hatch(), m_Poly, and SHAPE_POLY_SET::Vertex().

Referenced by Abort_Zone_Move_Corner_Or_Outlines(), and Show_Zone_Corner_Or_Outline_While_Move_Mouse().

922 {
923  int next_corner;
924 
925  if( m_Poly->GetNeighbourIndexes( aEdge, nullptr, &next_corner ) )
926  {
927  m_Poly->Vertex( aEdge ) += VECTOR2I( offset );
928  m_Poly->Vertex( next_corner ) += VECTOR2I( offset );
929  Hatch();
930  }
931 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
VECTOR2I & Vertex(int aIndex, int aOutline, int aHole)
Returns the index-th vertex in a given hole outline within a given outline
bool GetNeighbourIndexes(int aGlobalIndex, int *aPrevious, int *aNext)
Returns the global indexes of the previous and the next corner of the aGlobalIndex-th corner of a con...
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
void ZONE_CONTAINER::NewHole ( )
inline

Function NewHole creates a new hole on the zone; i.e., a new contour on the zone's outline.

Definition at line 549 of file class_zone.h.

References m_Poly, and SHAPE_POLY_SET::NewHole().

550  {
551  m_Poly->NewHole();
552  }
int NewHole(int aOutline=-1)
Creates a new hole in a given outline
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:741