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 wxPoint GetPosition () 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...
 
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 (ZONE_FILL_MODE aFillMode)
 
ZONE_FILL_MODE 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)
 
ZONE_SEGMENT_FILLFillSegments ()
 
const ZONE_SEGMENT_FILLFillSegments () 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...
 
void TransformOutlinesShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aMinClearanceValue, bool aUseNetClearance) const
 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...
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor) const override
 
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 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 CacheTriangulation ()
 
void SetFilledPolysList (SHAPE_POLY_SET &aPolysList)
 Function SetFilledPolysList sets the list of filled polygons. More...
 
void SetRawPolysList (SHAPE_POLY_SET &aPolysList)
 Function SetFilledPolysList sets the list of filled polygons. More...
 
bool BuildSmoothedPoly (SHAPE_POLY_SET &aSmoothedPoly) 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 SetFillSegments (const ZONE_SEGMENT_FILL &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 (timestamp_t aNewTimeStamp)
 
timestamp_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 (const 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...
 
timestamp_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 Attributes

SHAPE_POLY_SETm_Poly
 Outline of the zone. More...
 
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
 
ZONE_FILL_MODE m_FillMode
 How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => 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...
 
ZONE_SEGMENT_FILL m_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
 
std::vector< int > m_insulatedIslands
 

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 60 of file class_zone.h.

Member Typedef Documentation

Member Enumeration Documentation

Zone hatch styles.

Enumerator
NO_HATCH 
DIAGONAL_FULL 
DIAGONAL_EDGE 

Definition at line 67 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, SetDoNotAllowCopperPour(), SetDoNotAllowTracks(), SetDoNotAllowVias(), SetIsKeepout(), SetLocalFlags(), ZONE_SETTINGS::SMOOTHING_NONE, and ZFM_POLYGONS.

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
59  m_priority = 0;
61  SetIsKeepout( false );
62  SetDoNotAllowCopperPour( false ); // has meaning only if m_isKeepout == true
63  SetDoNotAllowVias( true ); // has meaning only if m_isKeepout == true
64  SetDoNotAllowTracks( true ); // has meaning only if m_isKeepout == true
65  m_cornerRadius = 0;
66  SetLocalFlags( 0 ); // flags tempoarry used in zone calculations
67  m_Poly = new SHAPE_POLY_SET(); // Outlines
68  aBoard->GetZoneSettings().ExportSetting( *this );
69 }
void SetDoNotAllowTracks(bool aEnable)
Definition: class_zone.h:610
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:716
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:609
Class SHAPE_POLY_SET.
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:703
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
unsigned m_priority
Definition: class_zone.h:680
int m_cornerSmoothingType
Definition: class_zone.h:671
unsigned int m_cornerRadius
Definition: class_zone.h:672
void SetDoNotAllowCopperPour(bool aEnable)
Definition: class_zone.h:608
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
void SetLocalFlags(int aFlags)
Definition: class_zone.h:231
void SetIsKeepout(bool aEnable)
Definition: class_zone.h:607
ZONE_CONTAINER::ZONE_CONTAINER ( const ZONE_CONTAINER aZone)

Definition at line 72 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_ThermalReliefCopperBridge, m_ThermalReliefGap, m_ZoneClearance, m_ZoneMinThickness, SetLayerSet(), SetLocalFlags(), and BOARD_CONNECTED_ITEM::SetNetCode().

72  :
73  BOARD_CONNECTED_ITEM( aZone )
74 {
75  // Should the copy be on the same net?
76  SetNetCode( aZone.GetNetCode() );
77  m_Poly = new SHAPE_POLY_SET( *aZone.m_Poly );
78 
79  // For corner moving, corner index to drag, or nullptr if no selection
80  m_CornerSelection = nullptr;
81  m_IsFilled = aZone.m_IsFilled;
82  m_ZoneClearance = aZone.m_ZoneClearance; // clearance value
84  m_FillMode = aZone.m_FillMode; // Filling mode (segments/polygons)
85  m_priority = aZone.m_priority;
91  m_FillSegmList = aZone.m_FillSegmList; // vector <> copy
92 
93  m_isKeepout = aZone.m_isKeepout;
97 
100 
101  m_hatchStyle = aZone.m_hatchStyle;
102  m_hatchPitch = aZone.m_hatchPitch;
103  m_HatchLines = aZone.m_HatchLines;
104 
105  SetLayerSet( aZone.GetLayerSet() );
106  SetLocalFlags( aZone.GetLocalFlags() );
107 }
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:695
bool m_doNotAllowTracks
Definition: class_zone.h:692
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:716
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
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:227
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:207
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:700
int m_ThermalReliefCopperBridge
Definition: class_zone.h:709
std::vector< SEG > m_HatchLines
Definition: class_zone.h:739
ZoneConnection m_PadConnection
Definition: class_zone.h:694
Class SHAPE_POLY_SET.
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:703
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
unsigned m_priority
Definition: class_zone.h:680
bool m_doNotAllowVias
Definition: class_zone.h:691
int m_cornerSmoothingType
Definition: class_zone.h:671
bool SetNetCode(int aNetCode, bool aNoAssert=false)
Function SetNetCode sets net using a net code.
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
unsigned int m_cornerRadius
Definition: class_zone.h:672
int GetNetCode() const
Function GetNetCode.
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:737
bool m_doNotAllowCopperPour
Definition: class_zone.h:690
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:706
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:696
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
int GetLocalFlags() const
Definition: class_zone.h:230
void SetLocalFlags(int aFlags)
Definition: class_zone.h:231
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 140 of file class_zone.cpp.

References m_CornerSelection, and m_Poly.

141 {
142  delete m_Poly;
143  delete m_CornerSelection;
144 }
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:716
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670

Member Function Documentation

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 1003 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().

1004 {
1005  if( aPolygon.empty() )
1006  return;
1007 
1008  SHAPE_LINE_CHAIN outline;
1009 
1010  // Create an outline and populate it with the points of aPolygon
1011  for( unsigned i = 0; i < aPolygon.size(); i++ )
1012  {
1013  outline.Append( VECTOR2I( aPolygon[i] ) );
1014  }
1015 
1016  outline.SetClosed( true );
1017 
1018  // Add the outline as a new polygon in the polygon set
1019  if( m_Poly->OutlineCount() == 0 )
1020  m_Poly->AddOutline( outline );
1021  else
1022  m_Poly->AddHole( outline );
1023 }
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:670
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 1026 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().

1027 {
1028  // Ensure the main outline exists:
1029  if( m_Poly->OutlineCount() == 0 )
1030  m_Poly->NewOutline();
1031 
1032  // If aHoleIdx >= 0, the corner musty be added to the hole, index aHoleIdx.
1033  // (remember: the index of the first hole is 0)
1034  // Return error if if does dot exist.
1035  if( aHoleIdx >= m_Poly->HoleCount( 0 ) )
1036  return false;
1037 
1038  m_Poly->Append( aPosition.x, aPosition.y, -1, aHoleIdx, aAllowDuplication );
1039 
1040  return true;
1041 }
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:670
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:192
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
bool ZONE_CONTAINER::BuildSmoothedPoly ( SHAPE_POLY_SET aSmoothedPoly) const

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 1315 of file class_zone.cpp.

References SHAPE_POLY_SET::Chamfer(), SHAPE_POLY_SET::Fillet(), GetNumCorners(), m_ArcToSegmentsCount, m_cornerRadius, m_cornerSmoothingType, m_Poly, ZONE_SETTINGS::SMOOTHING_CHAMFER, and ZONE_SETTINGS::SMOOTHING_FILLET.

Referenced by ZONE_FILLER::fillSingleZone(), DRC::TestZoneToZoneOutline(), and TransformOutlinesShapeWithClearanceToPolygon().

1316 {
1317  if( GetNumCorners() <= 2 ) // malformed zone. polygon calculations do not like it ...
1318  return false;
1319 
1320  // Make a smoothed polygon out of the user-drawn polygon if required
1321  switch( m_cornerSmoothingType )
1322  {
1324  aSmoothedPoly = m_Poly->Chamfer( m_cornerRadius );
1325  break;
1326 
1328  aSmoothedPoly = m_Poly->Fillet( m_cornerRadius, m_ArcToSegmentsCount );
1329  break;
1330 
1331  default:
1332  // Acute angles between adjacent edges can create issues in calculations,
1333  // in inflate/deflate outlines transforms, especially when the angle is very small.
1334  // We can avoid issues by creating a very small chamfer which remove acute angles,
1335  // or left it without chamfer and use only CPOLYGONS_LIST::InflateOutline to create
1336  // clearance areas
1337  aSmoothedPoly = m_Poly->Chamfer( Millimeter2iu( 0.0 ) );
1338  break;
1339  }
1340 
1341  return true;
1342 };
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:414
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:700
SHAPE_POLY_SET Fillet(int aRadius, int aSegments)
Function Fillet returns a filleted version of the polygon set.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
int m_cornerSmoothingType
Definition: class_zone.h:671
unsigned int m_cornerRadius
Definition: class_zone.h:672
SHAPE_POLY_SET Chamfer(int aDistance)
Function Chamfer returns a chamfered version of the polygon set.
void ZONE_CONTAINER::CacheTriangulation ( )

Definition at line 1310 of file class_zone.cpp.

References SHAPE_POLY_SET::CacheTriangulation(), and m_FilledPolysList.

1311 {
1313 }
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
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 444 of file class_zone.h.

References SHAPE_POLY_SET::CIterateWithHoles(), and m_Poly.

445  {
446  return m_Poly->CIterateWithHoles();
447  }
CONST_ITERATOR CIterateWithHoles(int aOutline) const
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
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:225
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 260 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

260 { 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:281
void ZONE_CONTAINER::ClearFilledPolysList ( )
inline

Function ClearFilledPolysList clears the list of filled polygons.

Definition at line 521 of file class_zone.h.

References m_FilledPolysList, and SHAPE_POLY_SET::RemoveAllContours().

Referenced by POINT_EDITOR::updateItem().

522  {
524  }
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
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 281 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(), 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(), 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(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::savePin(), 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().

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

Definition at line 259 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

259 { 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:281
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 147 of file class_zone.cpp.

References ZONE_CONTAINER().

148 {
149  return new ZONE_CONTAINER( *this );
150 }
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 191 of file class_zone.cpp.

References GetLayerSet().

Referenced by ZONE_FILLER::buildZoneFeatureHoleList(), DRC::doTrackKeepoutDrc(), and DRC::testKeepoutAreas().

192 {
193  LSET common = GetLayerSet() & aLayerSet;
194 
195  return common.count() > 0;
196 }
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:227
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 273 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().

275 {
276  if( !DC )
277  return;
278 
279  wxPoint seg_start, seg_end;
280  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
281  BOARD* brd = GetBoard();
282 
283  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
284 
285  PCB_LAYER_ID draw_layer = UNDEFINED_LAYER;
286 
287  LSET layers = GetLayerSet() & brd->GetVisibleLayers();
288 
289  // If there are no visible layers and the zone is not highlighted, return
290  if( layers.count() == 0 && !( aDrawMode & GR_HIGHLIGHT ) )
291  {
292  return;
293  }
294 
295  /* Keepout zones can exist on multiple layers
296  * Thus, determining which color to use to render them is a bit tricky.
297  * In descending order of priority:
298  *
299  * 1. If in GR_HIGHLIGHT mode:
300  * a. If zone is on selected layer, use layer color!
301  * b. Else, use grey
302  * 1. Not in GR_HIGHLIGHT mode
303  * a. If zone is on selected layer, use layer color
304  * b. Else, use color of top-most (visible) layer
305  *
306  */
307  if( GetIsKeepout() )
308  {
309  // At least one layer must be provided!
310  assert( GetLayerSet().count() > 0 );
311 
312  // Not on any visible layer?
313  if( layers.count() == 0 && !( aDrawMode & GR_HIGHLIGHT ) )
314  {
315  return;
316  }
317 
318  // Is keepout zone present on the selected layer?
319  if( layers.test( curr_layer ) )
320  {
321  draw_layer = curr_layer;
322  }
323  else
324  {
325  // Select the first (top) visible layer
326  if( layers.count() > 0 )
327  {
328  draw_layer = layers.Seq()[0];
329  }
330  else
331  {
332  draw_layer = GetLayerSet().Seq()[0];
333  }
334  }
335 
336  }
337  /* Non-keepout zones are easier to deal with
338  */
339  else
340  {
341  if( brd->IsLayerVisible( GetLayer() ) == false && !( aDrawMode & GR_HIGHLIGHT ) )
342  {
343  return;
344  }
345 
346  draw_layer = GetLayer();
347  }
348 
349  assert( draw_layer != UNDEFINED_LAYER );
350 
351  auto color = frame->Settings().Colors().GetLayerColor( draw_layer );
352 
353  GRSetDrawMode( DC, aDrawMode );
354  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
355 
356  if( displ_opts->m_ContrastModeDisplay )
357  {
358  if( !IsOnLayer( curr_layer ) )
359  {
361  }
362  }
363 
364  if( ( aDrawMode & GR_HIGHLIGHT ) && !( aDrawMode & GR_AND ) )
365  {
366  color.SetToLegacyHighlightColor();
367  }
368 
369  color.a = 0.588;
370 
371  // draw the lines
372  std::vector<wxPoint> lines;
373  lines.reserve( (GetNumCorners() * 2) + 2 );
374 
375  // Iterate through the segments of the outline
376  for( auto iterator = m_Poly->IterateSegmentsWithHoles(); iterator; iterator++ )
377  {
378  // Create the segment
379  SEG segment = *iterator;
380 
381  lines.push_back( static_cast<wxPoint>( segment.A ) + offset );
382  lines.push_back( static_cast<wxPoint>( segment.B ) + offset );
383  }
384 
385  GRLineArray( panel->GetClipBox(), DC, lines, 0, color );
386 
387  // draw hatches
388  lines.clear();
389  lines.reserve( (m_HatchLines.size() * 2) + 2 );
390 
391  for( unsigned ic = 0; ic < m_HatchLines.size(); ic++ )
392  {
393  seg_start = static_cast<wxPoint>( m_HatchLines[ic].A ) + offset;
394  seg_end = static_cast<wxPoint>( m_HatchLines[ic].B ) + offset;
395  lines.push_back( seg_start );
396  lines.push_back( seg_end );
397  }
398 
399  GRLineArray( panel->GetClipBox(), DC, lines, 0, color );
400 }
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:414
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:318
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:262
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:602
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:364
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:227
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:739
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
EDA_RECT * GetClipBox()
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:181
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:194
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:456
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:188
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 403 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, VECTOR2< T >::y, and ZFM_POLYGONS.

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

405 {
406 
407  static std::vector <wxPoint> CornersBuffer;
408  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
409 
410  // outline_mode is false to show filled polys,
411  // and true to show polygons outlines only (test and debug purposes)
412  bool outline_mode = displ_opts->m_DisplayZonesMode == 2 ? true : false;
413 
414  if( DC == NULL )
415  return;
416 
417  if( displ_opts->m_DisplayZonesMode == 1 ) // Do not show filled areas
418  return;
419 
420  if( m_FilledPolysList.IsEmpty() ) // Nothing to draw
421  return;
422 
423  BOARD* brd = GetBoard();
424  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
425 
426  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
427  auto color = frame->Settings().Colors().GetLayerColor( GetLayer() );
428 
429  if( brd->IsLayerVisible( GetLayer() ) == false && !( aDrawMode & GR_HIGHLIGHT ) )
430  return;
431 
432  GRSetDrawMode( DC, aDrawMode );
433 
434  if( displ_opts->m_ContrastModeDisplay )
435  {
436  if( !IsOnLayer( curr_layer ) )
438  }
439 
440  if( ( aDrawMode & GR_HIGHLIGHT ) && !( aDrawMode & GR_AND ) )
441  color.SetToLegacyHighlightColor();
442 
443  color.a = 0.588;
444 
445 
446  for ( int ic = 0; ic < m_FilledPolysList.OutlineCount(); ic++ )
447  {
448  const SHAPE_LINE_CHAIN& path = m_FilledPolysList.COutline( ic );
449 
450  CornersBuffer.clear();
451 
452  wxPoint p0;
453 
454  for( int j = 0; j < path.PointCount(); j++ )
455  {
456  const VECTOR2I& corner = path.CPoint( j );
457 
458  wxPoint coord( corner.x + offset.x, corner.y + offset.y );
459 
460  if( j == 0 )
461  p0 = coord;
462 
463  CornersBuffer.push_back( coord );
464  }
465 
466  CornersBuffer.push_back( p0 );
467 
468  // Draw outlines:
469  if( ( m_ZoneMinThickness > 1 ) || outline_mode )
470  {
471  int ilim = CornersBuffer.size() - 1;
472 
473  for( int is = 0, ie = ilim; is <= ilim; ie = is, is++ )
474  {
475  int x0 = CornersBuffer[is].x;
476  int y0 = CornersBuffer[is].y;
477  int x1 = CornersBuffer[ie].x;
478  int y1 = CornersBuffer[ie].y;
479 
480  // Draw only basic outlines, not extra segments.
481  if( !displ_opts->m_DisplayPcbTrackFill || GetState( FORCE_SKETCH ) )
482  GRCSegm( panel->GetClipBox(), DC,
483  x0, y0, x1, y1,
485  else
486  GRFillCSegm( panel->GetClipBox(), DC,
487  x0, y0, x1, y1, m_ZoneMinThickness, color );
488  }
489  }
490 
491  // Draw areas:
492  if( m_FillMode == ZFM_POLYGONS && !outline_mode )
493  GRPoly( panel->GetClipBox(), DC, CornersBuffer.size(), &CornersBuffer[0],
494  true, 0, color, color );
495  }
496 
497  if( m_FillMode == 1 && !outline_mode ) // filled with segments
498  {
499  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
500  {
501  wxPoint start = (wxPoint) ( m_FillSegmList[ic].A + VECTOR2I(offset) );
502  wxPoint end = (wxPoint) ( m_FillSegmList[ic].B + VECTOR2I(offset) );
503 
504  if( !displ_opts->m_DisplayPcbTrackFill || GetState( FORCE_SKETCH ) )
505  GRCSegm( panel->GetClipBox(), DC, start.x, start.y, end.x, end.y,
507  else
508  GRFillCSegm( panel->GetClipBox(), DC, start.x, start.y, end.x, end.y,
510  }
511  }
512 }
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:796
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:318
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:262
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
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:510
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
int OutlineCount() const
Returns the number of outlines in the set
int GetState(int type) const
Definition: base_struct.h:264
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
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:613
EDA_RECT * GetClipBox()
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:181
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:696
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
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:194
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:188
#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...
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 542 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().

544 {
545  GR_DRAWMODE current_gr_mode = draw_mode;
546  bool is_close_segment = false;
547 
548  if( !DC )
549  return;
550 
551  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
552 
553  auto frame = static_cast<PCB_BASE_FRAME*> ( panel->GetParent() );
554  auto color = frame->Settings().Colors().GetLayerColor( GetLayer() );
555 
556  auto displ_opts = (PCB_DISPLAY_OPTIONS*)( panel->GetDisplayOptions() );
557 
558  if( displ_opts->m_ContrastModeDisplay )
559  {
560  if( !IsOnLayer( curr_layer ) )
562  }
563 
564  // Object to iterate through the corners of the outlines
566 
567  // Segment start and end
568  VECTOR2I seg_start, seg_end;
569 
570  // Remember the first point of this contour
571  VECTOR2I contour_first_point = *iterator;
572 
573  // Iterate through all the corners of the outlines and build the segments to draw
574  while( iterator )
575  {
576  // Get the first point of the current segment
577  seg_start = *iterator;
578 
579  // Get the last point of the current segment, handling the case where the end of the
580  // contour is reached, when the last point of the segment is the first point of the
581  // contour
582  if( !iterator.IsEndContour() )
583  {
584  // Set GR mode to default
585  current_gr_mode = draw_mode;
586 
587  SHAPE_POLY_SET::ITERATOR iterator_copy = iterator;
588  iterator_copy++;
589  if( iterator_copy.IsEndContour() )
590  current_gr_mode = GR_XOR;
591 
592  is_close_segment = false;
593 
594  iterator++;
595  seg_end = *iterator;
596  }
597  else
598  {
599  is_close_segment = true;
600 
601  seg_end = contour_first_point;
602 
603  // Reassign first point of the contour to the next contour start
604  iterator++;
605 
606  if( iterator )
607  contour_first_point = *iterator;
608 
609  // Set GR mode to XOR
610  current_gr_mode = GR_XOR;
611  }
612 
613  GRSetDrawMode( DC, current_gr_mode );
614 
615  if( is_close_segment )
616  GRLine( panel->GetClipBox(), DC, seg_start.x, seg_start.y, seg_end.x, seg_end.y, 0,
617  WHITE );
618  else
619  GRLine( panel->GetClipBox(), DC, seg_start.x, seg_start.y, seg_end.x, seg_end.y, 0,
620  color );
621  }
622 }
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:318
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:262
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
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:37
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
EDA_RECT * GetClipBox()
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:181
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:380
Class ITERATOR_TEMPLATE.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:194
Definition: colors.h:49
void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_panel.cpp:188
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
ZONE_SEGMENT_FILL& ZONE_CONTAINER::FillSegments ( )
inline

Definition at line 233 of file class_zone.h.

References m_FillSegmList.

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

233 { return m_FillSegmList; }
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
const ZONE_SEGMENT_FILL& ZONE_CONTAINER::FillSegments ( ) const
inline

Definition at line 234 of file class_zone.h.

References m_FillSegmList.

234 { return m_FillSegmList; }
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
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 954 of file class_zone.cpp.

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

955 {
956  Mirror( aCentre );
957  int copperLayerCount = GetBoard()->GetCopperLayerCount();
958 
959  if( GetIsKeepout() )
960  {
961  SetLayerSet( FlipLayerMask( GetLayerSet(), copperLayerCount ) );
962  }
963  else
964  {
965  SetLayer( FlipLayer( GetLayer(), copperLayerCount ) );
966  }
967 }
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:518
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:472
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:172
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:602
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:227
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:207
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
Definition: class_zone.cpp:199
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:970
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 171 of file class_board_item.cpp.

172 {
173  char temp[50];
174 
175  int len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
176 
177  return std::string( temp, len );
178 }
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 90 of file class_board_item.cpp.

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

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

Definition at line 181 of file class_board_item.cpp.

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

182 {
183  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
184 }
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 187 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits().

188 {
189  return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
190 }
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 187 of file class_zone.h.

References m_ArcToSegmentsCount.

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

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

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

Definition at line 64 of file class_board_item.cpp.

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

Referenced by 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(), Flip(), VIA::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().

65 {
66  if( Type() == PCB_T )
67  return (BOARD*) this;
68 
69  BOARD_ITEM* parent = GetParent();
70 
71  if( parent )
72  return parent->GetBoard();
73 
74  return NULL;
75 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
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 515 of file class_zone.cpp.

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

Referenced by ZONE_FILLER::buildZoneFeatureHoleList(), BOARD::ComputeBoundingBox(), PCB_EDIT_FRAME::Delete_Zone_Contour(), HitTest(), and PCB_EDIT_FRAME::Remove_Zone_Corner().

516 {
517  const int PRELOAD = 0x7FFFFFFF; // Biggest integer (32 bits)
518 
519  int ymax = -PRELOAD;
520  int ymin = PRELOAD;
521  int xmin = PRELOAD;
522  int xmax = -PRELOAD;
523 
524  int count = GetNumCorners();
525 
526  for( int i = 0; i<count; ++i )
527  {
528  wxPoint corner = static_cast<wxPoint>( GetCornerPosition( i ) );
529 
530  ymax = std::max( ymax, corner.y );
531  xmax = std::max( xmax, corner.x );
532  ymin = std::min( ymin, corner.y );
533  xmin = std::min( xmin, corner.x );
534  }
535 
536  EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin + 1, ymax - ymin + 1 ) );
537 
538  return ret;
539 }
int GetNumCorners(void) const
Access to m_Poly parameters.
Definition: class_zone.h:414
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
Definition: class_zone.h:454
#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 BOARD::chainMarkedSegments(), 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 405 of file class_zone.h.

406  {
407  return wxT( "ZONE_CONTAINER" );
408  }
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 777 of file class_zone.cpp.

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

Referenced by ZONE_FILLER::buildZoneFeatureHoleList(), GERBER_JOBFILE_WRITER::CreateJobFile(), DRC::TestZoneToZoneOutline(), and TransformOutlinesShapeWithClearanceToPolygon().

778 {
779  int myClearance = m_ZoneClearance;
780 
781 #if 1 // Maybe the netclass clearance should not come into play for a zone?
782  // At least the policy decision can be controlled by the zone
783  // itself, i.e. here. On reasons of insufficient documentation,
784  // the user will be less bewildered if we simply respect the
785  // "zone clearance" setting in the zone properties dialog. (At least
786  // until there is a UI boolean for this.)
787 
788  NETCLASSPTR myClass = GetNetClass();
789 
790  if( myClass )
791  myClearance = std::max( myClearance, myClass->GetClearance() );
792 #endif
793 
794  if( aItem )
795  {
796  int hisClearance = aItem->GetClearance( NULL );
797  myClearance = std::max( hisClearance, myClearance );
798  }
799 
800  return myClearance;
801 }
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:695
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 454 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().

455  {
457 
458  // Convert global to relative indices
459  if( !m_Poly->GetRelativeIndices( aCornerIndex, &index ) )
460  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
461 
462  return m_Poly->CVertex( index );
463  }
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:670
unsigned int ZONE_CONTAINER::GetCornerRadius ( ) const
inline

Definition at line 574 of file class_zone.h.

References m_cornerRadius.

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

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

Definition at line 570 of file class_zone.h.

References m_cornerSmoothingType.

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

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

Function GetDefaultHatchPitchMils.

Returns
int - the default hatch pitch in internal units.

Definition at line 1292 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().

1293 {
1294  return Mils2iu( 20 );
1295 }
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
ZONE_FILL_MODE ZONE_CONTAINER::GetFillMode ( ) const
inline

Definition at line 175 of file class_zone.h.

References m_FillMode.

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

175 { return m_FillMode; }
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 282 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(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), 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(), 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(), EDA_DRAW_PANEL::OnMouseEvent(), 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(), SCH_EDIT_FRAME::OrientComponent(), 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_EDIT_FRAME::SchematicCleanUp(), 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().

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

Definition at line 659 of file class_zone.h.

References m_HatchLines.

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

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

Hatch related methods.

Function GetHatchPitch

Returns
int - the zone hatch pitch in iu.

Definition at line 1094 of file class_zone.cpp.

References m_hatchPitch.

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

1095 {
1096  return m_hatchPitch;
1097 }
HATCH_STYLE ZONE_CONTAINER::GetHatchStyle ( ) const
inline

Definition at line 498 of file class_zone.h.

References m_hatchStyle.

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

499  {
500  return m_hatchStyle;
501  }
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:737
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 172 of file class_zone.cpp.

References BOARD_ITEM::GetLayer().

Referenced by PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_SelectItems(), ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), ZONE_FILLER::buildZoneFeatureHoleList(), 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(), 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::TestAreaIntersection(), BOARD::TestAreaIntersections(), DRC::TestZoneToZoneOutline(), and PCB_EDITOR_CONTROL::ZoneMerge().

173 {
174  return BOARD_ITEM::GetLayer();
175 }
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 78 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(), GetMsgPanelInfo(), EDGE_MODULE::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().

79 {
80  BOARD* board = GetBoard();
81 
82  if( board )
83  return board->GetLayerName( m_Layer );
84 
85  // If no parent, return standard name
87 }
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 227 of file class_zone.cpp.

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

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

228 {
229  // TODO - Enable multi-layer zones for all zone types
230  // not just keepout zones
231  if( GetIsKeepout() )
232  {
233  return m_layerSet;
234  }
235  else
236  {
237  return LSET( m_Layer );
238  }
239 }
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:602
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 230 of file class_zone.h.

References m_localFlgs.

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

230 { return m_localFlgs; }
int m_localFlgs
Variable used in polygon calculations.
Definition: class_zone.h:719
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 1298 of file class_zone.cpp.

1299 {
1300  return add_zone_xpm;
1301 }
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 810 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().

811 {
812  wxString msg;
813 
814  msg = _( "Zone Outline" );
815 
816  // Display Cutout instead of Outline for holes inside a zone
817  // i.e. when num contour !=0
818  // Check whether the selected corner is in a hole; i.e., in any contour but the first one.
819  if( m_CornerSelection != nullptr && m_CornerSelection->m_contour > 0 )
820  msg << wxT( " " ) << _( "(Cutout)" );
821 
822  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg, DARKCYAN ) );
823 
824  if( GetIsKeepout() )
825  {
826  msg.Empty();
827 
828  if( GetDoNotAllowVias() )
829  AccumulateDescription( msg, _( "No via" ) );
830 
831  if( GetDoNotAllowTracks() )
832  AccumulateDescription( msg, _("No track") );
833 
835  AccumulateDescription( msg, _("No copper pour") );
836 
837  aList.push_back( MSG_PANEL_ITEM( _( "Keepout" ), msg, RED ) );
838  }
839  else if( IsOnCopperLayer() )
840  {
841  if( GetNetCode() >= 0 )
842  {
843  NETINFO_ITEM* net = GetNet();
844 
845  if( net )
846  msg = net->GetNetname();
847  else // Should not occur
848  msg = _( "<unknown>" );
849  }
850  else // a netcode < 0 is an error
851  msg = wxT( "<error>" );
852 
853  aList.push_back( MSG_PANEL_ITEM( _( "NetName" ), msg, RED ) );
854 
855  // Display net code : (useful in test or debug)
856  msg.Printf( wxT( "%d" ), GetNetCode() );
857  aList.push_back( MSG_PANEL_ITEM( _( "NetCode" ), msg, RED ) );
858 
859  // Display priority level
860  msg.Printf( wxT( "%d" ), GetPriority() );
861  aList.push_back( MSG_PANEL_ITEM( _( "Priority" ), msg, BLUE ) );
862  }
863  else
864  {
865  aList.push_back( MSG_PANEL_ITEM( _( "Non Copper Zone" ), wxEmptyString, RED ) );
866  }
867 
868  aList.push_back( MSG_PANEL_ITEM( _( "Layer" ), GetLayerName(), BROWN ) );
869 
870  msg.Printf( wxT( "%d" ), (int) m_Poly->TotalVertices() );
871  aList.push_back( MSG_PANEL_ITEM( _( "Corners" ), msg, BLUE ) );
872 
873  if( m_FillMode )
874  msg = _( "Segments" );
875  else
876  msg = _( "Polygons" );
877 
878  aList.push_back( MSG_PANEL_ITEM( _( "Fill Mode" ), msg, BROWN ) );
879 
880  // Useful for statistics :
881  msg.Printf( wxT( "%d" ), (int) m_HatchLines.size() );
882  aList.push_back( MSG_PANEL_ITEM( _( "Hatch Lines" ), msg, BLUE ) );
883 
884  if( !m_FilledPolysList.IsEmpty() )
885  {
886  msg.Printf( wxT( "%d" ), m_FilledPolysList.TotalVertices() );
887  aList.push_back( MSG_PANEL_ITEM( _( "Corner Count" ), msg, BLUE ) );
888  }
889 }
Definition: colors.h:57
bool GetDoNotAllowCopperPour() const
Definition: class_zone.h:603
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:716
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:602
std::vector< SEG > m_HatchLines
Definition: class_zone.h:739
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
Definition: colors.h:60
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
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:178
bool GetDoNotAllowTracks() const
Definition: class_zone.h:605
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
bool GetDoNotAllowVias() const
Definition: class_zone.h:604
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:101
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:225
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 PCB_EDIT_FRAME::Attribut_net(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), Build_Work(), ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), ZONE_FILLER::buildZoneFeatureHoleList(), PCB_EDIT_FRAME::Change_Net_Tracks_And_Vias_Sizes(), Collect_TrackSegmentsToDrag(), BOARD::CombineAllAreasInNet(), ZONE_FILLER::computeRawFilledAreas(), connectedItemFilter(), 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(), 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(), ROUTER_TOOL::NeighboringSegmentFilter(), 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::TestAreaIntersections(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC::testZones(), DRC::TestZoneToZoneOutline(), 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.
const wxString& BOARD_CONNECTED_ITEM::GetNetname ( ) const
inlineinherited
int BOARD_ITEM::getNextNumberInSequence ( const std::set< int > &  aSeq,
bool  aFillSequenceGaps 
)
staticprotectedinherited

Definition at line 224 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

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

Access to m_Poly parameters.

Definition at line 414 of file class_zone.h.

References m_Poly, and SHAPE_POLY_SET::TotalVertices().

Referenced by PCB_EDIT_FRAME::Begin_Zone(), BuildSmoothedPoly(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), Draw(), PCB_EDIT_FRAME::End_Zone(), PCB_IO::format(), GetBoundingBox(), BOARD::OnAreaPolygonModified(), ZONE_CREATE_HELPER::performZoneCutout(), and Show_New_Edge_While_Move_Mouse().

415  {
416  return m_Poly->TotalVertices();
417  }
int TotalVertices() const
Returns total number of vertices stored in the set.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
ZoneConnection ZONE_CONTAINER::GetPadConnection ( D_PAD aPad = NULL) const

Definition at line 994 of file class_zone.cpp.

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

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

995 {
996  if( aPad == NULL || aPad->GetZoneConnection() == PAD_ZONE_CONN_INHERITED )
997  return m_PadConnection;
998  else
999  return aPad->GetZoneConnection();
1000 }
ZoneConnection m_PadConnection
Definition: class_zone.h:694
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(), DIALOG_EDIT_FPTEXT::DIALOG_EDIT_FPTEXT(), 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(), SELECTION_TOOL::guessSelectionCandidates(), 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:195
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 166 of file class_zone.cpp.

References GetCornerPosition().

Referenced by DRC::fillMarker().

167 {
168  return (wxPoint) GetCornerPosition( 0 );
169 }
const VECTOR2I & GetCornerPosition(int aCornerIndex) const
Definition: class_zone.h:454
unsigned ZONE_CONTAINER::GetPriority ( ) const
inline
int ZONE_CONTAINER::GetSelectedCorner ( ) const
inline

Definition at line 201 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().

202  {
203  // Transform relative indices to global index
204  int globalIndex;
205  m_Poly->GetGlobalIndex( *m_CornerSelection, globalIndex );
206 
207  return globalIndex;
208  }
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:716
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
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 1044 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 DRC::TestZoneToZoneOutline().

1045 {
1046  wxString text;
1047  NETINFO_ITEM* net;
1048  BOARD* board = GetBoard();
1049 
1050  // Check whether the selected contour is a hole (contour index > 0)
1051  if( m_CornerSelection != nullptr && m_CornerSelection->m_contour > 0 )
1052  text << wxT( " " ) << _( "(Cutout)" );
1053 
1054  if( GetIsKeepout() )
1055  text << wxT( " " ) << _( "(Keepout)" );
1056 
1057  text << wxString::Format( wxT( " (%08lX)" ), m_TimeStamp );
1058 
1059  // Display net name for copper zones
1060  if( !GetIsKeepout() )
1061  {
1062  if( GetNetCode() >= 0 )
1063  {
1064  if( board )
1065  {
1066  net = GetNet();
1067 
1068  if( net )
1069  {
1070  text << wxT( " [" ) << net->GetNetname() << wxT( "]" );
1071  }
1072  }
1073  else
1074  {
1075  text << _( "** NO BOARD DEFINED **" );
1076  }
1077  }
1078  else
1079  { // A netcode < 0 is an error:
1080  // Netname not found or area not initialised
1081  text << wxT( " [" ) << GetNetname() << wxT( "]" );
1082  text << wxT( " <" ) << _( "Not Found" ) << wxT( ">" );
1083  }
1084  }
1085 
1086  wxString msg;
1087  msg.Printf( _( "Zone Outline %s on %s" ), GetChars( text ),
1088  GetChars( GetLayerName() ) );
1089 
1090  return msg;
1091 }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:196
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:716
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:602
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.
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 277 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

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

Definition at line 634 of file class_zone.cpp.

References D_PAD::GetThermalWidth(), and m_ThermalReliefCopperBridge.

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

635 {
636  if( aPad == NULL || aPad->GetThermalWidth() == 0 )
638  else
639  return aPad->GetThermalWidth();
640 }
int m_ThermalReliefCopperBridge
Definition: class_zone.h:709
int GetThermalWidth() const
Definition: class_pad.cpp:661
int ZONE_CONTAINER::GetThermalReliefGap ( D_PAD aPad = NULL) const

Definition at line 625 of file class_zone.cpp.

References D_PAD::GetThermalGap(), and m_ThermalReliefGap.

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

626 {
627  if( aPad == NULL || aPad->GetThermalGap() == 0 )
628  return m_ThermalReliefGap;
629  else
630  return aPad->GetThermalGap();
631 }
int GetThermalGap() const
Definition: class_pad.cpp:672
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:706
int BOARD_ITEM::getTrailingInt ( const wxString &  aStr)
staticprotectedinherited

Definition at line 201 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

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

References SEG::A, abs, 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().

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

References HitTestForCorner(), and HitTestForEdge().

Referenced by PCB_EDIT_FRAME::Block_SelectItems().

652 {
653  return HitTestForCorner( aPosition ) || HitTestForEdge( aPosition );
654 }
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:692
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:676
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 708 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().

709 {
710  // Calculate bounding box for zone
711  EDA_RECT bbox = GetBoundingBox();
712  bbox.Normalize();
713 
714  EDA_RECT arect = aRect;
715  arect.Normalize();
716  arect.Inflate( aAccuracy );
717 
718  if( aContained )
719  {
720  return arect.Contains( bbox );
721  }
722  else // Test for intersection between aBox and the polygon
723  // For a polygon, using its bounding box has no sense here
724  {
725  // Fast test: if aBox is outside the polygon bounding box,
726  // rectangles cannot intersect
727  if( !arect.Intersects( bbox ) )
728  return false;
729 
730  // aBox is inside the polygon bounding box,
731  // and can intersect the polygon: use a fine test.
732  // aBox intersects the polygon if at least one aBox corner
733  // is inside the polygon
734 
735  /*
736  wxPoint origin = arect.GetOrigin();
737 
738  int w = arect.GetWidth();
739  int h = arect.GetHeight();
740 
741 
742  if ( HitTestInsideZone( origin ) ||
743  HitTestInsideZone( origin + wxPoint( w, 0 ) ) ||
744  HitTestInsideZone( origin + wxPoint( w, h ) ) ||
745  HitTestInsideZone( origin + wxPoint( 0, h ) ) )
746  {
747  return true;
748  }
749  */
750 
751  // No corner inside aBox, but outlines can intersect aBox
752  // if one of outline corners is inside aBox
753  int count = m_Poly->TotalVertices();
754  for( int ii =0; ii < count; ii++ )
755  {
756  auto vertex = m_Poly->Vertex( ii );
757  auto vertexNext = m_Poly->Vertex( ( ii + 1 ) % count );
758 
759  // Test if the point is within the rect
760  if( arect.Contains( ( wxPoint ) vertex ) )
761  {
762  return true;
763  }
764 
765  // Test if this edge intersects the rect
766  if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
767  {
768  return true;
769  }
770  }
771 
772  return false;
773  }
774 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox (virtual)
Definition: class_zone.cpp:515
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:670
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 804 of file class_zone.cpp.

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

Referenced by BOARD::HitTestForAnyFilledArea().

805 {
806  return m_FilledPolysList.Contains( VECTOR2I( aRefPos.x, aRefPos.y ) );
807 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
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 676 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().

678 {
679  int distmax = Millimeter2iu( MAX_DIST_IN_MM );
680 
681  return m_Poly->CollideVertex( VECTOR2I( refPos ), aCornerHit, distmax );
682 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
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:674
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 685 of file class_zone.cpp.

References dummy(), and HitTestForCorner().

686 {
688  return HitTestForCorner( refPos, dummy );
689 }
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:676
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 692 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().

694 {
695  int distmax = Millimeter2iu( MAX_DIST_IN_MM );
696 
697  return m_Poly->CollideEdge( VECTOR2I( refPos ), aCornerHit, distmax );
698 }
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:670
#define MAX_DIST_IN_MM
Definition: class_zone.cpp:674
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 701 of file class_zone.cpp.

References dummy(), and HitTestForEdge().

702 {
704  return HitTestForEdge( refPos, dummy );
705 }
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:692
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 256 of file class_zone.h.

References SHAPE_POLY_SET::Contains(), and m_Poly.

257  {
258  return m_Poly->Contains( VECTOR2I( aPosition ), 0 );
259  }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
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 251 of file base_struct.h.

References BRIGHTENED.

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

251 { 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:202
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 189 of file class_zone.h.

References m_IsFilled.

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params(), export_vrml_zones(), PCB_IO::format(), and ZONE_CREATE_HELPER::performZoneCutout().

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

Definition at line 250 of file base_struct.h.

References HIGHLIGHTED.

250 { 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:202
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 244 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

244 { 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:202
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 243 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().

243 { 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:202
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 178 of file class_zone.cpp.

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

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

179 {
180  if( GetIsKeepout() )
181  {
182  return ( m_layerSet & LSET::AllCuMask() ).count() > 0;
183  }
184  else
185  {
186  return IsCopperLayer( GetLayer() );
187  }
188 }
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:673
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:602
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 262 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().

263 {
264  if( GetIsKeepout() )
265  {
266  return m_layerSet.test( aLayer );
267  }
268 
269  return BOARD_ITEM::IsOnLayer( aLayer );
270 }
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:602
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 471 of file base_struct.h.

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

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

Definition at line 249 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

249 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
#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:695
int GetMinThickness() const
Definition: class_zone.h:198
bool GetDoNotAllowCopperPour() const
Definition: class_zone.h:603
int GetArcSegmentCount() const
Definition: class_zone.h:187
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
SHAPE_POLY_SET * Outline()
Definition: class_zone.h:236
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:602
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:700
int m_ThermalReliefCopperBridge
Definition: class_zone.h:709
ZoneConnection m_PadConnection
Definition: class_zone.h:694
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
ZONE_FILL_MODE GetFillMode() const
Definition: class_zone.h:175
int GetNetCode() const
Function GetNetCode.
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:706
bool GetDoNotAllowTracks() const
Definition: class_zone.h:605
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:696
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
bool GetDoNotAllowVias() const
Definition: class_zone.h:604
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:101
bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 248 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().

248 { 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:202
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:225
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 247 of file base_struct.h.

References IS_WIRE_IMAGE.

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

247 { 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:202
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 424 of file class_zone.h.

References SHAPE_POLY_SET::Iterate(), and m_Poly.

425  {
426  return m_Poly->Iterate();
427  }
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:670
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:178
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:191
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 434 of file class_zone.h.

References SHAPE_POLY_SET::IterateWithHoles(), and m_Poly.

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

435  {
436  return m_Poly->IterateWithHoles();
437  }
ITERATOR IterateWithHoles(int aOutline)
Function IterateWithHoles.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
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 427 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().

428  {
429  return false;
430  }
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:471
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 970 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().

971 {
972  for( auto iterator = m_Poly->IterateWithHoles(); iterator; iterator++ )
973  {
974  int py = mirror_ref.y - iterator->y;
975  iterator->y = py + mirror_ref.y;
976  }
977 
978  Hatch();
979 
980  for( auto ic = m_FilledPolysList.Iterate(); ic; ++ic )
981  {
982  int py = mirror_ref.y - ic->y;
983  ic->y = py + mirror_ref.y;
984  }
985 
986  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
987  {
988  MIRROR( m_FillSegmList[ic].A.y, mirror_ref.y );
989  MIRROR( m_FillSegmList[ic].B.y, mirror_ref.y );
990  }
991 }
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
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:670
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
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 894 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().

895 {
896  /* move outlines */
897  m_Poly->Move( VECTOR2I( offset ) );
898 
899  Hatch();
900 
901  m_FilledPolysList.Move( VECTOR2I( offset.x, offset.y ) );
902 
903  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
904  {
905  m_FillSegmList[ic].A += VECTOR2I(offset);
906  m_FillSegmList[ic].B += VECTOR2I(offset);
907  }
908 }
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
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:670
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
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 911 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().

912 {
913  int next_corner;
914 
915  if( m_Poly->GetNeighbourIndexes( aEdge, nullptr, &next_corner ) )
916  {
917  m_Poly->Vertex( aEdge ) += VECTOR2I( offset );
918  m_Poly->Vertex( next_corner ) += VECTOR2I( offset );
919  Hatch();
920  }
921 }
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:670
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 483 of file class_zone.h.

References m_Poly, and SHAPE_POLY_SET::NewHole().

484  {
485  m_Poly->NewHole();
486  }
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:670
BOARD_ITEM* BOARD_ITEM::Next ( ) const
inlineinherited

Definition at line 116 of file class_board_item.h.

References EDA_ITEM::Pnext.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), MODULE::BuildPolyCourtyard(), BOARD::ComputeBoundingBox(), BOARD::ConvertBrdLayerToPolygonalContours(), CopyMarkedItems(), DeleteMarkedItems(), PCB_EDIT_FRAME::DoGenFootprintsReport(), MODULE::Draw(), BOARD::Draw(), MODULE::DrawEdgesOnly(), DrawMovingBlockOutlines(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Width(), export_vrml_module(), MODULE::Flip(), PCB_IO::format(), PCB_BASE_FRAME::GetFootprintFromBoardByReference(), MODULE::GetFootprintRect(), hash_eda(), hashModule(), MODULE::HitTest(), PCB_EDIT_FRAME::ImportSpecctraSession(), MirrorMarkedItems(), MODULE::MODULE(), MODULE::MoveAnchorPosition(), MODULE::operator=(), PlaceCells(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), PlotSolderMaskLayer(), PlotStandardLayer(), Print_Module(), FOOTPRINT_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::RedrawActiveWindow(), PCB_BASE_FRAME::ResetModuleTextSizes(), RotateMarkedItems(), MODULE::RunOnChildren(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), MODULE::SetOrientation(), MODULE::SetPosition(), PCB_EDIT_FRAME::Swap_Layers(), SwapItemData(), TestForExistingItem(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), and MODULE::ViewGetLayers().

116 { return static_cast<BOARD_ITEM*>( Pnext ); }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:191
bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 241 of file base_struct.cpp.

References Format(), GetChars(), and EDA_ITEM::GetClass().

242 {
243  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
244  GetChars( GetClass() ) ) );
245 
246  return false;
247 }
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
virtual wxString GetClass() const =0
Function GetClass returns the class name.
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
ZONE_CONTAINER & ZONE_CONTAINER::operator= ( const ZONE_CONTAINER aOther)

Definition at line 110 of file class_zone.cpp.

References SHAPE_POLY_SET::Append(), GetHatchPitch(), GetHatchStyle(), GetLayerSet(), m_ArcToSegmentsCount, m_CornerSelection, m_FilledPolysList, m_FillMode, m_FillSegmList, m_HatchLines, m_PadConnection, m_Poly, m_ThermalReliefCopperBridge, m_ThermalReliefGap, m_ZoneClearance, m_ZoneMinThickness, EDA_ITEM::operator=(), SHAPE_POLY_SET::RemoveAllContours(), SetHatchPitch(), SetHatchStyle(), and SetLayerSet().

111 {
113 
114  // Replace the outlines for aOther outlines.
115  delete m_Poly;
116  m_Poly = new SHAPE_POLY_SET( *aOther.m_Poly );
117 
118  m_CornerSelection = nullptr; // for corner moving, corner index to (null if no selection)
119  m_ZoneClearance = aOther.m_ZoneClearance; // clearance value
121  m_FillMode = aOther.m_FillMode; // filling mode (segments/polygons)
126  SetHatchStyle( aOther.GetHatchStyle() );
127  SetHatchPitch( aOther.GetHatchPitch() );
128  m_HatchLines = aOther.m_HatchLines; // copy vector <SEG>
131  m_FillSegmList.clear();
133 
134  SetLayerSet( aOther.GetLayerSet() );
135 
136  return *this;
137 }
void SetHatchPitch(int aPitch)
Function SetHatchPitch sets the hatch pitch parameter for the zone.
int m_ZoneClearance
Clearance value in internal units.
Definition: class_zone.h:695
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:716
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
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:227
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:207
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:700
int m_ThermalReliefCopperBridge
Definition: class_zone.h:709
std::vector< SEG > m_HatchLines
Definition: class_zone.h:739
ZoneConnection m_PadConnection
Definition: class_zone.h:694
Class SHAPE_POLY_SET.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
int m_ThermalReliefGap
Width of the copper bridge in thermal reliefs.
Definition: class_zone.h:706
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:696
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
HATCH_STYLE GetHatchStyle() const
Definition: class_zone.h:498
void SetHatchStyle(HATCH_STYLE aStyle)
Definition: class_zone.h:503
int GetHatchPitch() const
Hatch related methods.
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) ...
const SHAPE_POLY_SET* ZONE_CONTAINER::Outline ( ) const
inline

Definition at line 237 of file class_zone.h.

References m_Poly.

237 { return const_cast< SHAPE_POLY_SET* >( m_Poly ); }
Class SHAPE_POLY_SET.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
SHAPE_POLY_SET& ZONE_CONTAINER::RawPolysList ( )
inline

Definition at line 588 of file class_zone.h.

References m_RawPolysList.

589  {
590  return m_RawPolysList;
591  }
SHAPE_POLY_SET m_RawPolysList
Definition: class_zone.h:735
void ZONE_CONTAINER::RemoveAllContours ( void  )
inline

Definition at line 449 of file class_zone.h.

References m_Poly, and SHAPE_POLY_SET::RemoveAllContours().

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

450  {
452  }
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

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.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 211 of file base_struct.cpp.

References GetChars(), EDA_ITEM::GetClass(), and EDA_ITEM::IsReplaceable().

Referenced by SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

212 {
213  wxCHECK_MSG( IsReplaceable(), false,
214  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
215 
216  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
217 
218  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
219  aSearchData.GetFindString() :
220  aSearchData.GetFindString().Upper() );
221 
222  if( result == wxNOT_FOUND )
223  return false;
224 
225  wxString prefix = aText.Left( result );
226  wxString suffix;
227 
228  if( aSearchData.GetFindString().length() + result < aText.length() )
229  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
230 
231  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
232  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
233  GetChars( suffix ) );
234 
235  aText = prefix + aSearchData.GetReplaceString() + suffix;
236 
237  return true;
238 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:471
const wxString traceFindReplace
Flag to enable find and replace debug tracing.
Definition: base_struct.cpp:58
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
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 459 of file base_struct.h.

459 { return false; }
void BOARD_ITEM::Rotate ( const VECTOR2I aRotCentre,
double  aAngle 
)
inlineinherited

Definition at line 255 of file class_board_item.h.

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

256  {
257  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
258  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.
void ZONE_CONTAINER::Rotate ( const wxPoint centre,
double  angle 
)
overridevirtual

Function Rotate Move the outlines.

Parameters
centre= rot centre
angle= in 0.1 degree

Reimplemented from BOARD_ITEM.

Definition at line 924 of file class_zone.cpp.

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

925 {
926  wxPoint pos;
927 
928  for( auto iterator = m_Poly->IterateWithHoles(); iterator; iterator++ )
929  {
930  pos = static_cast<wxPoint>( *iterator );
931  RotatePoint( &pos, centre, angle );
932  iterator->x = pos.x;
933  iterator->y = pos.y;
934  }
935 
936  Hatch();
937 
938  /* rotate filled areas: */
939  for( auto ic = m_FilledPolysList.Iterate(); ic; ++ic )
940  RotatePoint( &ic->x, &ic->y, centre.x, centre.y, angle );
941 
942  for( unsigned ic = 0; ic < m_FillSegmList.size(); ic++ )
943  {
944  wxPoint a ( m_FillSegmList[ic].A );
945  RotatePoint( &a, centre, angle );
946  m_FillSegmList[ic].A = a;
947  wxPoint b ( m_FillSegmList[ic].B );
948  RotatePoint( &b, centre, angle );
949  m_FillSegmList[ic].B = a;
950  }
951 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
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...
ITERATOR IterateWithHoles(int aOutline)
Function IterateWithHoles.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
void ZONE_CONTAINER::SetArcSegmentCount ( int  aArcSegCount)
inline

Definition at line 186 of file class_zone.h.

References m_ArcToSegmentsCount.

Referenced by ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadSignals(), and PlotSolderMaskLayer().

186 { m_ArcToSegmentsCount = aArcSegCount; }
int m_ArcToSegmentsCount
The number of segments to convert a circle to a polygon.
Definition: class_zone.h:700
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 239 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

239 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:192
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 256 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

256 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:280
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
void ZONE_CONTAINER::SetCornerPosition ( int  aCornerIndex,
wxPoint  new_pos 
)
inline

Definition at line 465 of file class_zone.h.

References SHAPE_POLY_SET::GetRelativeIndices(), m_Poly, SHAPE_POLY_SET::Vertex(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

Referenced by Show_New_Edge_While_Move_Mouse().

466  {
467  SHAPE_POLY_SET::VERTEX_INDEX relativeIndices;
468 
469  // Convert global to relative indices
470  if( m_Poly->GetRelativeIndices( aCornerIndex, &relativeIndices ) )
471  {
472  m_Poly->Vertex( relativeIndices ).x = new_pos.x;
473  m_Poly->Vertex( relativeIndices ).y = new_pos.y;
474  }
475  else
476  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
477  }
Struct VERTEX_INDEX.
VECTOR2I & Vertex(int aIndex, int aOutline, int aHole)
Returns the index-th vertex in a given hole outline within a given outline
bool GetRelativeIndices(int aGlobalIdx, VERTEX_INDEX *aRelativeIndices) const
Function GetRelativeIndices.
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
void ZONE_CONTAINER::SetCornerRadius ( unsigned int  aRadius)

Definition at line 643 of file class_zone.cpp.

References m_cornerRadius, and MAX_ZONE_CORNER_RADIUS_MILS.

Referenced by ZONE_SETTINGS::ExportSetting().

644 {
645  m_cornerRadius = aRadius;
646  if( m_cornerRadius > (unsigned int) Mils2iu( MAX_ZONE_CORNER_RADIUS_MILS ) )
648 }
unsigned int m_cornerRadius
Definition: class_zone.h:672
#define MAX_ZONE_CORNER_RADIUS_MILS
void ZONE_CONTAINER::SetCornerSmoothingType ( int  aType)
inline

Definition at line 568 of file class_zone.h.

References m_cornerSmoothingType.

Referenced by ZONE_SETTINGS::ExportSetting().

568 { m_cornerSmoothingType = aType; };
int m_cornerSmoothingType
Definition: class_zone.h:671
void ZONE_CONTAINER::SetDoNotAllowCopperPour ( bool  aEnable)
inline
void ZONE_CONTAINER::SetDoNotAllowTracks ( bool  aEnable)
inline

Definition at line 610 of file class_zone.h.

References m_doNotAllowTracks.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), and ZONE_CONTAINER().

610 { m_doNotAllowTracks = aEnable; }
bool m_doNotAllowTracks
Definition: class_zone.h:692
void ZONE_CONTAINER::SetDoNotAllowVias ( bool  aEnable)
inline

Definition at line 609 of file class_zone.h.

References m_doNotAllowVias.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), and ZONE_CONTAINER().

609 { m_doNotAllowVias = aEnable; }
bool m_doNotAllowVias
Definition: class_zone.h:691
void ZONE_CONTAINER::SetFilledPolysList ( SHAPE_POLY_SET aPolysList)
inline

Function SetFilledPolysList sets the list of filled polygons.

Definition at line 545 of file class_zone.h.

References m_FilledPolysList.

Referenced by PlotSolderMaskLayer().

546  {
547  m_FilledPolysList = aPolysList;
548  }
SHAPE_POLY_SET m_FilledPolysList
Definition: class_zone.h:734
void ZONE_CONTAINER::SetFillMode ( ZONE_FILL_MODE  aFillMode)
inline

Definition at line 174 of file class_zone.h.

References m_FillMode.

Referenced by export_vrml_zones(), and ZONE_SETTINGS::ExportSetting().

174 { m_FillMode = aFillMode; }
ZONE_FILL_MODE m_FillMode
How to fill areas: ZFM_POLYGONS => use filled polygons, ZFM_SEGMENTS => fill with segments...
Definition: class_zone.h:713
void ZONE_CONTAINER::SetFillSegments ( const ZONE_SEGMENT_FILL aSegments)
inline

Definition at line 583 of file class_zone.h.

References m_FillSegmList.

584  {
585  m_FillSegmList = aSegments;
586  }
ZONE_SEGMENT_FILL m_FillSegmList
Segments used to fill the zone (m_FillMode ==1 ), when fill zone by segment is used.
Definition: class_zone.h:724
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 280 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::CopySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), PCB_EDIT_FRAME::EditDimension(), LIB_PIN::EnableEditMode(), PCB_EDIT_FRAME::FlipTextePcb(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), 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(), SCH_EDIT_FRAME::Load_Component(), PCB_BASE_FRAME::LoadModuleFromLibrary(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), 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::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

280 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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.

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 292 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

292 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:199
void ZONE_CONTAINER::SetHatch ( int  aHatchStyle,
int  aHatchPitch,
bool  aRebuildHatch 
)

Function SetHatch sets all hatch parameters for the zone.

Parameters
aHatchStyleis the style of the hatch, specified as one of HATCH_STYLE possible values.
aHatchPitchis the hatch pitch in iu.
aRebuildHatchis a flag to indicate whether to re-hatch after having set the previous parameters.

Definition at line 1100 of file class_zone.cpp.

References Hatch(), m_hatchStyle, and SetHatchPitch().

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

1101 {
1102  SetHatchPitch( aHatchPitch );
1103  m_hatchStyle = (ZONE_CONTAINER::HATCH_STYLE) aHatchStyle;
1104 
1105  if( aRebuildHatch )
1106  Hatch();
1107 }
void SetHatchPitch(int aPitch)
Function SetHatchPitch sets the hatch pitch parameter for the zone.
HATCH_STYLE
Zone hatch styles.
Definition: class_zone.h:67
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:737
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone's...
void ZONE_CONTAINER::SetHatchPitch ( int  aPitch)

Function SetHatchPitch sets the hatch pitch parameter for the zone.

Parameters
aPitchis the hatch pitch in iu.

Definition at line 1110 of file class_zone.cpp.

References m_hatchPitch.

Referenced by operator=(), and SetHatch().

1111 {
1112  m_hatchPitch = aPitch;
1113 }
void ZONE_CONTAINER::SetHatchStyle ( HATCH_STYLE  aStyle)
inline

Definition at line 503 of file class_zone.h.

References m_hatchStyle.

Referenced by BOARD::InsertArea(), EAGLE_PLUGIN::loadSignals(), and operator=().

504  {
505  m_hatchStyle = aStyle;
506  }
HATCH_STYLE m_hatchStyle
Definition: class_zone.h:737
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 255 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

255 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:280
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void ZONE_CONTAINER::SetIsFilled ( bool  isFilled)
inline

Definition at line 190 of file class_zone.h.

References m_IsFilled.

190 { m_IsFilled = isFilled; }
bool m_IsFilled
True when a zone was filled, false after deleting the filled areas.
Definition: class_zone.h:703
void ZONE_CONTAINER::SetIsKeepout ( bool  aEnable)
inline
void ZONE_CONTAINER::SetLayer ( PCB_LAYER_ID  aLayer)
overridevirtual

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number. is virtual because some items (in fact: class DIMENSION) have a slightly different initialization

Reimplemented from BOARD_ITEM.

Definition at line 199 of file class_zone.cpp.

References BOARD_ITEM::m_Layer, and SetLayerSet().

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

200 {
201  SetLayerSet( LSET( aLayer ) );
202 
203  m_Layer = aLayer;
204 }
PCB_LAYER_ID m_Layer
void SetLayerSet(LSET aLayerSet)
Definition: class_zone.cpp:207
Class LSET is a set of PCB_LAYER_IDs.
void ZONE_CONTAINER::SetLayerSet ( LSET  aLayerSet)

Definition at line 207 of file class_zone.cpp.

References LSET::AllCuMask(), GetIsKeepout(), BOARD_ITEM::m_Layer, m_layerSet, and LSET::Seq().

Referenced by ZONE_SETTINGS::ExportSetting(), Flip(), operator=(), SetLayer(), and ZONE_CONTAINER().

208 {
209  if( GetIsKeepout() )
210  {
211  // Keepouts can only exist on copper layers
212  aLayerSet &= LSET::AllCuMask();
213  }
214 
215  if( aLayerSet.count() == 0 )
216  {
217  return;
218  }
219 
220  m_layerSet = aLayerSet;
221 
222  // Set the single layer to the first selected layer
223  m_Layer = aLayerSet.Seq()[0];
224 }
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:673
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:602
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:364
PCB_LAYER_ID m_Layer
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 241 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

241 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:193
void ZONE_CONTAINER::SetLocalFlags ( int  aFlags)
inline

Definition at line 231 of file class_zone.h.

References m_localFlgs.

Referenced by BOARD::CombineAreas(), BOARD::NormalizeAreaPolygon(), and ZONE_CONTAINER().

231 { m_localFlgs = aFlags; }
int m_localFlgs
Variable used in polygon calculations.
Definition: class_zone.h:719
void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool  aVisible)
inlineinherited

Definition at line 163 of file class_board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

164  {
165  m_localRatsnestVisible = aVisible;
166  }
virtual void BOARD_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Function SetLocked modifies 'lock' status for of the item.

Reimplemented in MODULE, and TRACK.

Definition at line 204 of file class_board_item.h.

205  {
206  // only MODULEs & TRACKs can be locked at this time.
207  }
void ZONE_CONTAINER::SetMinThickness ( int  aMinThickness)
inline

Definition at line 199 of file class_zone.h.

References m_ZoneMinThickness.

Referenced by ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadSignals(), and PlotSolderMaskLayer().

199 { m_ZoneMinThickness = aMinThickness; }
int m_ZoneMinThickness
Minimum thickness value in filled areas.
Definition: class_zone.h:696
void EDA_ITEM::SetModified ( )
inherited
void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM aNetInfo)
inlineinherited

Function SetNet Sets a NET_INFO object for the item.

Definition at line 93 of file class_board_connected_item.h.

References BOARD_ITEM::GetBoard(), and BOARD_CONNECTED_ITEM::m_netinfo.

94  {
95  assert( aNetInfo->GetBoard() == GetBoard() );
96  m_netinfo = aNetInfo;
97  }
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
bool BOARD_CONNECTED_ITEM::SetNetCode ( int  aNetCode,
bool  aNoAssert = false 
)
inherited

Function SetNetCode sets net using a net code.

Parameters
aNetCodeis a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssertif true, do not assert that the net exists. Otherwise, item is assigned to the unconnected net.
Returns
true on success, false if the net did not exist

Definition at line 46 of file class_board_connected_item.cpp.

References BOARD::FindNet(), BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::m_netinfo, and NETINFO_LIST::ORPHANED_ITEM.

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToModule(), DIALOG_TRACK_VIA_PROPERTIES::Apply(), PCB_EDIT_FRAME::Begin_Zone(), D_PAD::CopyNetlistSettings(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), ZONE_SETTINGS::ExportSetting(), genPlacementRoutingMatrix(), BOARD::InsertArea(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), PCB_EDIT_FRAME::Other_Layer_Route(), BOARD::ReplaceNetlist(), CLIPBOARD_IO::SaveSelection(), BOARD::SetAreasNetCodesFromNetNames(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and ZONE_CONTAINER().

47 {
48  // if aNetCode < 0 ( typically NETINFO_LIST::FORCE_ORPHANED )
49  // or no parent board,
50  // set the m_netinfo to the dummy NETINFO_LIST::ORPHANED
51 
52  BOARD* board = GetBoard();
53  //auto connectivity = board ? board->GetConnectivity() : nullptr;
54  //bool addRatsnest = false;
55 
56  //if( connectivity )
57  //addRatsnest = connectivity->Remove( this );
58 
59  if( ( aNetCode >= 0 ) && board )
60  m_netinfo = board->FindNet( aNetCode );
61  else
63 
64  if( !aNoAssert )
65  assert( m_netinfo );
66 
67  // Add only if it was previously added to the ratsnest
68  //if( addRatsnest )
69  // connectivity->Add( this );
70 
71  return ( m_netinfo != NULL );
72 }
static NETINFO_ITEM ORPHANED_ITEM
NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net li...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
NETINFO_ITEM * m_netinfo
Stores all informations about the net that item belongs to.
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.
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 238 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

238 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:191
void ZONE_CONTAINER::SetOutline ( SHAPE_POLY_SET aOutline)
inline

Definition at line 239 of file class_zone.h.

References m_Poly.

Referenced by BOARD::CombineAreas(), and BOARD::NormalizeAreaPolygon().

239 { m_Poly = aOutline; }
SHAPE_POLY_SET * m_Poly
Outline of the zone.
Definition: class_zone.h:670
void ZONE_CONTAINER::SetPadConnection ( ZoneConnection  aPadConnection)
inline

Definition at line 196 of file class_zone.h.

References m_PadConnection.

Referenced by ZONE_SETTINGS::ExportSetting(), and EAGLE_PLUGIN::loadSignals().

196 { m_PadConnection = aPadConnection; }
ZoneConnection m_PadConnection
Definition: class_zone.h:694
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 240 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_MODULE_BOARD_EDITOR::OnEditReference(), DIALOG_MODULE_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

240 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:195
void ZONE_CONTAINER::SetPosition ( const wxPoint aPos)
inlineoverridevirtual

Implements BOARD_ITEM.

Definition at line 89 of file class_zone.h.

89 {}
void ZONE_CONTAINER::SetPriority ( unsigned  aPriority)
inline

Function SetPriority.

Parameters
aPriority= the priority level

Definition at line 95 of file class_zone.h.

References m_priority.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), and EAGLE_PLUGIN::loadSignals().

95 { m_priority = aPriority; }
unsigned m_priority
Definition: class_zone.h:680
void ZONE_CONTAINER::SetRawPolysList ( SHAPE_POLY_SET aPolysList)
inline

Function SetFilledPolysList sets the list of filled polygons.

Definition at line 554 of file class_zone.h.

References m_RawPolysList.

555  {
556  m_RawPolysList = aPolysList;
557  }
SHAPE_POLY_SET m_RawPolysList
Definition: class_zone.h:735
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 254 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::pasteClipboard(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SELECTION_TOOL::selectVisually().

254 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:134
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:280
void ZONE_CONTAINER::SetSelectedCorner ( int  aCorner)
inline

Definition at line 210 of file class_zone.h.

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

Referenced by PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), PCB_EDIT_FRAME::Process_Special_Functions(), and PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge().

211  {
212  SHAPE_POLY_SET::VERTEX_INDEX selectedCorner;
213 
214  // If the global index of the corner is correct, assign it to m_CornerSelection
215  if( m_Poly->GetRelativeIndices( aCorner, &selectedCorner ) )
216  {
217  if( m_CornerSelection == nullptr )
219 
220  *m_CornerSelection = selectedCorner;
221  }
222  else
223  throw( std::out_of_range( "aCorner-th vertex does not exist" ) );
224  }
SHAPE_POLY_SET::VERTEX_INDEX * m_CornerSelection
The index of the corner being m