Handle a list of polygons defining a copper zone. More...

#include <zone.h>

Inheritance diagram for ZONE:

Public Member Functions
	ZONE (BOARD_ITEM_CONTAINER *parent, bool aInFP=false)
	The ctor to build ZONE, but compatible with FP_ZONE requirement. More...

	ZONE (const ZONE &aZone)

ZONE &	operator= (const ZONE &aOther)

	~ZONE ()

bool	IsConnected () const override
	Not all ZONEs are really BOARD_CONNECTED_ITEMs.... More...

NETCLASS *	GetNetClass () const override
	Return the NETCLASS for this item. More...

wxString	GetNetClassName () const override
	Returns the netclass of the zone. More...

void	InitDataFromSrcInCopyCtor (const ZONE &aZone)
	Copy aZone data to me. More...

wxPoint	GetPosition () const override

void	SetPosition (const wxPoint &aPos) override

void	SetPriority (unsigned aPriority)

unsigned	GetPriority () const

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

void	SetLayerSet (LSET aLayerSet) override

virtual LSET	GetLayerSet () const override
	Return a std::bitset of all layers on which the item physically resides. More...

wxString	GetZoneName () const

void	SetZoneName (const wxString &aName)

bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const override
	Compare the item against the search criteria in aSearchData. More...

const EDA_RECT	GetBoundingBox () const override

const EDA_RECT	GetCachedBoundingBox () const
	ONLY TO BE USED BY CLIENTS WHICH SET UP THE CACHE! More...

void	CacheBoundingBox ()

int	GetLocalClearance (wxString *aSource) const override
	Return any local clearances set in the "classic" (ie: pre-rule) system. More...

int	GetLocalClearance () const

void	SetLocalClearance (int aClearance)

bool	IsOnCopperLayer () const override

bool	CommonLayerExists (const LSET aLayerSet) const
	Test if this zone shares a common layer with the given layer set. More...

virtual void	SetLayer (PCB_LAYER_ID aLayer) override
	Set the layer this item is on. More...

virtual PCB_LAYER_ID	GetLayer () const override
	Return the primary layer this item is on. More...

virtual bool	IsOnLayer (PCB_LAYER_ID) const override
	Test to see if this object is on the given layer. More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

double	ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
	Return the level of detail (LOD) of the item. More...

void	SetFillMode (ZONE_FILL_MODE aFillMode)

ZONE_FILL_MODE	GetFillMode () const

void	SetThermalReliefGap (int aThermalReliefGap)

int	GetThermalReliefGap () const

int	GetThermalReliefGap (PAD aPad, wxString aSource=nullptr) const

void	SetThermalReliefSpokeWidth (int aThermalReliefSpokeWidth)

int	GetThermalReliefSpokeWidth () const

int	GetThermalReliefSpokeWidth (PAD aPad, wxString aSource=nullptr) const

double	CalculateFilledArea ()
	Compute the area currently occupied by the zone fill. More...

double	GetFilledArea ()
	This area is cached from the most recent call to CalculateFilledArea(). More...

std::mutex &	GetLock ()

int	GetFillFlag (PCB_LAYER_ID aLayer)

void	SetFillFlag (PCB_LAYER_ID aLayer, bool aFlag)

bool	IsFilled () const

void	SetIsFilled (bool isFilled)

bool	NeedRefill () const

void	SetNeedRefill (bool aNeedRefill)

ZONE_CONNECTION	GetPadConnection (PAD aPad, wxString aSource=nullptr) const

ZONE_CONNECTION	GetPadConnection () const

void	SetPadConnection (ZONE_CONNECTION aPadConnection)

int	GetMinThickness () const

void	SetMinThickness (int aMinThickness)

int	GetHatchThickness () const

void	SetHatchThickness (int aThickness)

int	GetHatchGap () const

void	SetHatchGap (int aStep)

double	GetHatchOrientation () const

void	SetHatchOrientation (double aStep)

int	GetHatchSmoothingLevel () const

void	SetHatchSmoothingLevel (int aLevel)

double	GetHatchSmoothingValue () const

void	SetHatchSmoothingValue (double aValue)

double	GetHatchHoleMinArea () const

void	SetHatchHoleMinArea (double aPct)

int	GetHatchBorderAlgorithm () const

void	SetHatchBorderAlgorithm (int aAlgo)

int	GetSelectedCorner () const

void	SetSelectedCorner (int aCorner)

void	SetSelectedCorner (const wxPoint &aPosition, int aAccuracy)

int	GetLocalFlags () const

void	SetLocalFlags (int aFlags)

std::vector< SEG > &	FillSegments (PCB_LAYER_ID aLayer)

const std::vector< SEG > &	FillSegments (PCB_LAYER_ID aLayer) const

SHAPE_POLY_SET *	Outline ()

const SHAPE_POLY_SET *	Outline () const

void	SetOutline (SHAPE_POLY_SET *aOutline)

virtual std::shared_ptr< SHAPE >	GetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER) const override
	Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...

bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if a point is near an outline edge or a corner of this zone. More...

bool	HitTestFilledArea (PCB_LAYER_ID aLayer, const wxPoint &aRefPos, int aAccuracy=0) const
	Test if the given wxPoint is within the bounds of a filled area of this zone. More...

bool	HitTestCutout (const VECTOR2I &aRefPos, int aOutlineIdx=nullptr, int aHoleIdx=nullptr) const
	Test if the given point is contained within a cutout of the zone. More...

bool	HitTestCutout (const wxPoint &aRefPos, int aOutlineIdx=nullptr, int aHoleIdx=nullptr) const

void	GetInteractingZones (PCB_LAYER_ID aLayer, std::vector< ZONE * > *aZones) const
	Some intersecting zones, despite being on the same layer with the same net, cannot be merged due to other parameters such as fillet radius. More...

void	TransformSolidAreasShapesToPolygon (PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aCornerBuffer, int aError=ARC_HIGH_DEF) const
	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	TransformSmoothedOutlineToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearance, SHAPE_POLY_SET *aBoardOutline) const
	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, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
	Convert the zone shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...

bool	HitTestForCorner (const wxPoint &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
	Test if the given wxPoint is near a corner. More...

bool	HitTestForCorner (const wxPoint &refPos, int aAccuracy) const
	Test if the given wxPoint is near a corner. More...

bool	HitTestForEdge (const wxPoint &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
	Test if the given wxPoint is near a segment defined by 2 corners. More...

bool	HitTestForEdge (const wxPoint &refPos, int aAccuracy) const
	Test 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 ()
	Removes the zone filling. More...

void	Move (const wxPoint &offset) override
	Move the outlines. More...

void	MoveEdge (const wxPoint &offset, int aEdge)
	Move the outline Edge. More...

void	Rotate (const wxPoint &aCentre, double aAngle) override
	Move the outlines. More...

virtual void	Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
	Flip this object, i.e. More...

void	Mirror (const wxPoint &aMirrorRef, bool aMirrorLeftRight)
	Mirror the outlines relative to a given horizontal axis the layer is not changed. More...

wxString	GetClass () const override

int	GetNumCorners (void) const
	Access to m_Poly parameters. More...

SHAPE_POLY_SET::ITERATOR	Iterate ()
	Return an iterator to visit all points of the zone's main outline without holes. More...

SHAPE_POLY_SET::ITERATOR	IterateWithHoles ()
	Return an iterator to visit all points of the zone's main outline with holes. More...

SHAPE_POLY_SET::CONST_ITERATOR	CIterateWithHoles () const
	Return an iterator to visit all points of the zone's main outline with holes. More...

void	RemoveAllContours (void)

const VECTOR2I &	GetCornerPosition (int aCornerIndex) const

void	SetCornerPosition (int aCornerIndex, const wxPoint &new_pos)

void	NewHole ()
	Create 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...

ZONE_BORDER_DISPLAY_STYLE	GetHatchStyle () const

void	SetHatchStyle (ZONE_BORDER_DISPLAY_STYLE aStyle)

bool	IsSame (const ZONE &aZoneToCompare)
	Test if 2 zones are equivalent. More...

bool	HasFilledPolysForLayer (PCB_LAYER_ID aLayer) const

const SHAPE_POLY_SET &	GetFilledPolysList (PCB_LAYER_ID aLayer) const

void	CacheTriangulation (PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
	Create a list of triangles that "fill" the solid areas used for instance to draw these solid areas on OpenGL. More...

void	SetFilledPolysList (PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPolysList)
	Set the list of filled polygons. More...

void	SetRawPolysList (PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPolysList)
	Set the list of filled polygons. More...

bool	IsIsland (PCB_LAYER_ID aLayer, int aPolyIdx) const
	Check if a given filled polygon is an insulated island. More...

void	SetIsIsland (PCB_LAYER_ID aLayer, int aPolyIdx)

bool	BuildSmoothedPoly (SHAPE_POLY_SET &aSmoothedPoly, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aBoardOutline, SHAPE_POLY_SET aSmoothedPolyWithApron=nullptr) const

void	SetCornerSmoothingType (int aType)

int	GetCornerSmoothingType () const

void	SetCornerRadius (unsigned int aRadius)

unsigned int	GetCornerRadius () const

bool	GetFilledPolysUseThickness () const

bool	GetFilledPolysUseThickness (PCB_LAYER_ID aLayer) const

int	GetFillVersion () const

void	SetFillVersion (int aVersion)

void	RemoveCutout (int aOutlineIdx, int aHoleIdx)
	Remove a cutout from the zone. More...

void	AddPolygon (std::vector< wxPoint > &aPolygon)
	Add a polygon to the zone outline. More...

void	AddPolygon (const SHAPE_LINE_CHAIN &aPolygon)

void	SetFillSegments (PCB_LAYER_ID aLayer, const std::vector< SEG > &aSegments)

SHAPE_POLY_SET &	RawPolysList (PCB_LAYER_ID aLayer)

wxString	GetSelectMenuText (EDA_UNITS aUnits) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...

EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...

bool	GetIsRuleArea () const
	Accessors to parameters used in Rule Area zones: More...

bool	GetDoNotAllowCopperPour () const

bool	GetDoNotAllowVias () const

bool	GetDoNotAllowTracks () const

bool	GetDoNotAllowPads () const

bool	GetDoNotAllowFootprints () const

bool	IsKeepout () const

bool	KeepoutAll () const

void	SetIsRuleArea (bool aEnable)

void	SetDoNotAllowCopperPour (bool aEnable)

void	SetDoNotAllowVias (bool aEnable)

void	SetDoNotAllowTracks (bool aEnable)

void	SetDoNotAllowPads (bool aEnable)

void	SetDoNotAllowFootprints (bool aEnable)

const ISLAND_REMOVAL_MODE	GetIslandRemovalMode () const

void	SetIslandRemovalMode (ISLAND_REMOVAL_MODE aRemove)

long long int	GetMinIslandArea () const

void	SetMinIslandArea (long long int aArea)

int	GetBorderHatchPitch () const
	HatchBorder related methods. More...

void	SetBorderDisplayStyle (ZONE_BORDER_DISPLAY_STYLE aHatchStyle, int aHatchPitch, bool aRebuildHatch)
	Set all hatch parameters for the zone. More...

void	SetHatchPitch (int aPitch)
	Set the hatch pitch parameter for the zone. More...

void	UnHatchBorder ()
	Clear the zone's hatch. More...

void	HatchBorder ()
	Compute the hatch lines depending on the hatch parameters and stores it in the zone's attribute m_borderHatchLines. More...

const std::vector< SEG > &	GetHatchLines () const

bool	GetHV45 () const

void	SetHV45 (bool aConstrain)

void	BuildHashValue (PCB_LAYER_ID aLayer)
	Build the hash value of m_FilledPolysList, and store it internally in m_filledPolysHash. More...

MD5_HASH	GetHashValue (PCB_LAYER_ID aLayer)

virtual void	SwapData (BOARD_ITEM *aImage) override
	Swap data between aItem and aImage. More...

NETINFO_ITEM *	GetNet () const
	Return #NET_INFO object for a given item. More...

void	SetNet (NETINFO_ITEM *aNetInfo)
	Set a NET_INFO object for the item. More...

int	GetNetCode () const

bool	SetNetCode (int aNetCode, bool aNoAssert)
	Set net using a net code. More...

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

wxString	GetShortNetname () const

virtual int	GetOwnClearance (PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
	Return an item's "own" clearance in internal units. More...

virtual int	GetLocalClearanceOverrides (wxString *aSource) const
	Return any local clearance overrides set in the "classic" (ie: pre-rule) system. More...

virtual NETCLASS *	GetEffectiveNetclass () const
	Return the NETCLASS for this item, or the default netclass if none is defined. More...

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

virtual wxPoint	GetCenter () const
	This defaults to the center of the bounding box if not overridden. More...

void	SetX (int aX)

void	SetY (int aY)

BOARD_ITEM_CONTAINER *	GetParent () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

virtual BOARD_ITEM *	Duplicate () const
	Create a copy of this BOARD_ITEM. More...

bool	IsTrack () const
	Test to see if this object is a track or via (or microvia). More...

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)
	Modify the 'lock' status for of the item. More...

void	DeleteStructure ()
	Delete this object after removing from its parent if it has one. More...

void	Move (const VECTOR2I &aMoveVector)

void	Rotate (const VECTOR2I &aRotCentre, double aAngle)

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)

virtual const BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...

virtual BOARD *	GetBoard ()

wxString	GetLayerName () const
	Return the name of the PCB layer on which the item resides. More...

KICAD_T	Type () const
	Returns the type of object. More...

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Check whether the item is one of the listed types. More...

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual const wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty)

template<typename T >
T	Get (PROPERTY_BASE *aProperty)

template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

static int	GetDefaultHatchPitch ()

template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

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

Protected Member Functions
virtual wxString	layerMaskDescribe () const
	Return a string (to be shown to the user) describing a layer mask. More...

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

Protected Attributes
SHAPE_POLY_SET *	m_Poly
	Outline of the zone. More...

int	m_cornerSmoothingType

unsigned int	m_cornerRadius

wxString	m_zoneName
	An optional unique name for this zone, used for identifying it in DRC checking. More...

LSET	m_layerSet

unsigned	m_priority

bool	m_isRuleArea

bool	m_doNotAllowCopperPour

bool	m_doNotAllowVias

bool	m_doNotAllowTracks

bool	m_doNotAllowPads

bool	m_doNotAllowFootprints

ZONE_CONNECTION	m_PadConnection

int	m_ZoneClearance

int	m_ZoneMinThickness

int	m_fillVersion

ISLAND_REMOVAL_MODE	m_islandRemovalMode

long long int	m_minIslandArea
	When island removal mode is set to AREA, islands below this area will be removed. More...

bool	m_isFilled
	True when a zone was filled, false after deleting the filled areas. More...

bool	m_needRefill
	False when a zone was refilled, true after changes in zone params. More...

int	m_thermalReliefGap

int	m_thermalReliefSpokeWidth

ZONE_FILL_MODE	m_fillMode
	How to fill areas: More...

int	m_hatchThickness

int	m_hatchGap

double	m_hatchOrientation

int	m_hatchSmoothingLevel

double	m_hatchSmoothingValue

double	m_hatchHoleMinArea

int	m_hatchBorderAlgorithm

SHAPE_POLY_SET::VERTEX_INDEX *	m_CornerSelection
	The index of the corner being moved or nullptr if no corner is selected. More...

int	m_localFlgs

std::map< PCB_LAYER_ID, std::vector< SEG > >	m_FillSegmList
	Segments used to fill the zone (#m_FillMode ==1 ), when fill zone by segment is used. More...

std::map< PCB_LAYER_ID, SHAPE_POLY_SET >	m_FilledPolysList

std::map< PCB_LAYER_ID, SHAPE_POLY_SET >	m_RawPolysList

EDA_RECT	m_bboxCache
	Temp variables used while filling. More...

std::map< PCB_LAYER_ID, bool >	m_fillFlags

std::map< PCB_LAYER_ID, MD5_HASH >	m_filledPolysHash
	A hash value used in zone filling calculations to see if the filled areas are up to date. More...

ZONE_BORDER_DISPLAY_STYLE	m_borderStyle

int	m_borderHatchPitch

std::vector< SEG >	m_borderHatchLines

std::map< PCB_LAYER_ID, std::set< int > >	m_insulatedIslands
	For each layer, a set of insulated islands that were not removed. More...

bool	m_hv45

double	m_area

std::mutex	m_lock
	Lock used for multi-threaded filling on multi-layer zones. More...

NETINFO_ITEM *	m_netinfo
	Store all information about the net that item belongs to. More...

PCB_LAYER_ID	m_layer

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Detailed Description

Handle a list of polygons defining a copper zone.

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

a item ZONE is living in a board a variant FP_ZONE is living in a footprint

Definition at line 56 of file zone.h.

Constructor & Destructor Documentation

◆ ZONE() [1/2]

ZONE::ZONE	(	BOARD_ITEM_CONTAINER *	parent,
		bool	aInFP = `false`
	)

The ctor to build ZONE, but compatible with FP_ZONE requirement.

if aInFP is true, a FP_ZONE is actually built (same item, but with a specific type id: The type is PCB_ZONE_T for a ZONE The type is PCB_FP_ZONE_T for a FP_ZONE

Definition at line 44 of file zone.cpp.

  :
  BOARD_CONNECTED_ITEM( aParent, aInFP ? PCB_FP_ZONE_T : PCB_ZONE_T ),
  m_area( 0.0 )
 {
  m_CornerSelection = nullptr; // no corner is selected
  m_isFilled = false; // fill status : true when the zone is filled
  m_fillMode = ZONE_FILL_MODE::POLYGONS;
  m_borderStyle = ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE;
  m_borderHatchPitch = GetDefaultHatchPitch();
  m_hv45 = false;
  m_hatchThickness = 0;
  m_hatchGap = 0;
  m_hatchOrientation = 0.0;
  m_hatchSmoothingLevel = 0; // Grid pattern smoothing type. 0 = no smoothing
  m_hatchSmoothingValue = 0.1; // Grid pattern chamfer value relative to the gap value
  // used only if m_hatchSmoothingLevel > 0
  m_hatchHoleMinArea = 0.3; // Min size before holes are dropped (ratio of hole size)
  m_hatchBorderAlgorithm = 1; // 0 = use zone min thickness; 1 = use hatch width
  m_priority = 0;
  m_cornerSmoothingType = ZONE_SETTINGS::SMOOTHING_NONE;
  SetIsRuleArea( aInFP ); // Zones living in footprints have the rule area option
  SetDoNotAllowCopperPour( false ); // has meaning only if m_isRuleArea == true
  SetDoNotAllowVias( true ); // has meaning only if m_isRuleArea == true
  SetDoNotAllowTracks( true ); // has meaning only if m_isRuleArea == true
  SetDoNotAllowPads( true ); // has meaning only if m_isRuleArea == true
  SetDoNotAllowFootprints( false ); // has meaning only if m_isRuleArea == true
  m_cornerRadius = 0;
  SetLocalFlags( 0 ); // flags temporary used in zone calculations
  m_Poly = new SHAPE_POLY_SET(); // Outlines
  m_fillVersion = 5; // set the "old" way to build filled polygon areas (< 6.0.x)
  m_islandRemovalMode = ISLAND_REMOVAL_MODE::ALWAYS;
  aParent->GetZoneSettings().ExportSetting( *this );
 
  m_ZoneMinThickness = Mils2iu( ZONE_THICKNESS_MIL );
  m_thermalReliefSpokeWidth = Mils2iu( ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL );
  m_thermalReliefGap = Mils2iu( ZONE_THERMAL_RELIEF_GAP_MIL );
 
  m_needRefill = false; // True only after edits.
 }

References ALWAYS, DIAGONAL_EDGE, ZONE_SETTINGS::ExportSetting(), GetDefaultHatchPitch(), BOARD_ITEM_CONTAINER::GetZoneSettings(), m_borderHatchPitch, m_borderStyle, m_cornerRadius, m_CornerSelection, m_cornerSmoothingType, m_fillMode, m_fillVersion, m_hatchBorderAlgorithm, m_hatchGap, m_hatchHoleMinArea, m_hatchOrientation, m_hatchSmoothingLevel, m_hatchSmoothingValue, m_hatchThickness, m_hv45, m_isFilled, m_islandRemovalMode, m_needRefill, m_Poly, m_priority, m_thermalReliefGap, m_thermalReliefSpokeWidth, m_ZoneMinThickness, POLYGONS, SetDoNotAllowCopperPour(), SetDoNotAllowFootprints(), SetDoNotAllowPads(), SetDoNotAllowTracks(), SetDoNotAllowVias(), SetIsRuleArea(), SetLocalFlags(), ZONE_SETTINGS::SMOOTHING_NONE, ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL, ZONE_THERMAL_RELIEF_GAP_MIL, and ZONE_THICKNESS_MIL.

Referenced by Clone().

◆ ZONE() [2/2]

ZONE::ZONE ( const ZONE & aZone )

Definition at line 85 of file zone.cpp.

  : BOARD_CONNECTED_ITEM( aZone ),
  m_Poly( nullptr ),
  m_CornerSelection( nullptr )
 {
  InitDataFromSrcInCopyCtor( aZone );
 }

References InitDataFromSrcInCopyCtor().

◆ ~ZONE()

ZONE::~ZONE ( )

Definition at line 104 of file zone.cpp.

 {
  delete m_Poly;
  delete m_CornerSelection;
 }

References m_CornerSelection, and m_Poly.

Member Function Documentation

◆ AddPolygon() [1/2]

void ZONE::AddPolygon ( std::vector< wxPoint > & aPolygon )

Add a polygon to the zone outline.

If the zone outline is empty, this is the main outline. Otherwise it is a hole inside the main outline.

Definition at line 833 of file zone.cpp.

 {
  if( aPolygon.empty() )
  return;
 
  SHAPE_LINE_CHAIN outline;
 
  // Create an outline and populate it with the points of aPolygon
  for( const wxPoint& pt : aPolygon)
  outline.Append( pt );
 
  outline.SetClosed( true );
 
  AddPolygon( outline );
 }

References SHAPE_LINE_CHAIN::Append(), and SHAPE_LINE_CHAIN::SetClosed().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getZoneFromCadstarShape(), and EAGLE_PLUGIN::loadPolygon().

◆ AddPolygon() [2/2]

void ZONE::AddPolygon ( const SHAPE_LINE_CHAIN & aPolygon )

Definition at line 819 of file zone.cpp.

 {
  wxASSERT( aPolygon.IsClosed() );
 
  // Add the outline as a new polygon in the polygon set
  if( m_Poly->OutlineCount() == 0 )
  m_Poly->AddOutline( aPolygon );
  else
  m_Poly->AddHole( aPolygon );
 
  SetNeedRefill( true );
 }

References SHAPE_POLY_SET::AddHole(), SHAPE_POLY_SET::AddOutline(), SHAPE_LINE_CHAIN::IsClosed(), m_Poly, SHAPE_POLY_SET::OutlineCount(), and SetNeedRefill().

◆ AppendCorner()

bool ZONE::AppendCorner	(	wxPoint	aPosition,
		int	aHoleIdx,
		bool	aAllowDuplication = `false`
	)

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

Parameters

aPosition	is the position of the new corner.
aHoleIdx	is the index of the hole (-1 for the main outline, >= 0 for hole).
aAllowDuplication	is 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 850 of file zone.cpp.

 {
  // Ensure the main outline exists:
  if( m_Poly->OutlineCount() == 0 )
  m_Poly->NewOutline();
 
  // If aHoleIdx >= 0, the corner musty be added to the hole, index aHoleIdx.
  // (remember: the index of the first hole is 0)
  // Return error if if does dot exist.
  if( aHoleIdx >= m_Poly->HoleCount( 0 ) )
  return false;
 
  m_Poly->Append( aPosition.x, aPosition.y, -1, aHoleIdx, aAllowDuplication );
 
  SetNeedRefill( true );
 
  return true;
 }

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::HoleCount(), m_Poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::OutlineCount(), and SetNeedRefill().

Referenced by BOARD::AddArea(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packageRectangle(), and ALTIUM_PCB::ParseFills6Data().

◆ BuildHashValue()

void ZONE::BuildHashValue ( PCB_LAYER_ID aLayer )

Build the hash value of m_FilledPolysList, and store it internally in m_filledPolysHash.

Used in zone filling calculations, to know if m_FilledPolysList is up to date.

Definition at line 395 of file zone.cpp.

 {
  if( !m_FilledPolysList.count( aLayer ) )
  m_filledPolysHash[aLayer] = g_nullPoly.GetHash();
  else
  m_filledPolysHash[aLayer] = m_FilledPolysList.at( aLayer ).GetHash();
 }

References g_nullPoly, SHAPE_POLY_SET::GetHash(), m_filledPolysHash, and m_FilledPolysList.

◆ BuildSmoothedPoly()

bool ZONE::BuildSmoothedPoly	(	SHAPE_POLY_SET &	aSmoothedPoly,
		PCB_LAYER_ID	aLayer,
		SHAPE_POLY_SET *	aBoardOutline,
		SHAPE_POLY_SET *	aSmoothedPolyWithApron = `nullptr`
	)		const

Definition at line 1179 of file zone.cpp.

 {
  if( GetNumCorners() <= 2 ) // malformed zone. polygon calculations will not like it ...
  return false;
 
  // Processing of arc shapes in zones is not yet supported because Clipper can't do boolean
  // operations on them. The poly outline must be flattened first.
  SHAPE_POLY_SET flattened = *m_Poly;
  flattened.ClearArcs();
 
  if( GetIsRuleArea() )
  {
  // We like keepouts just the way they are....
  aSmoothedPoly = flattened;
  return true;
  }
 
  const BOARD* board = GetBoard();
  int maxError = ARC_HIGH_DEF;
  bool keepExternalFillets = false;
 
  if( board )
  {
  BOARD_DESIGN_SETTINGS& bds = board->GetDesignSettings();
 
  maxError = bds.m_MaxError;
  keepExternalFillets = bds.m_ZoneKeepExternalFillets;
  }
 
  auto smooth = [&]( SHAPE_POLY_SET& aPoly )
  {
  switch( m_cornerSmoothingType )
  {
  case ZONE_SETTINGS::SMOOTHING_CHAMFER:
  aPoly = aPoly.Chamfer( (int) m_cornerRadius );
  break;
 
  case ZONE_SETTINGS::SMOOTHING_FILLET:
  {
  aPoly = aPoly.Fillet( (int) m_cornerRadius, maxError );
  break;
  }
 
  default:
  break;
  }
  };
 
  std::vector<ZONE*> interactingZones;
  GetInteractingZones( aLayer, &interactingZones );
 
  SHAPE_POLY_SET* maxExtents = &flattened;
  SHAPE_POLY_SET withFillets;
 
  aSmoothedPoly = flattened;
 
  // Should external fillets (that is, those applied to concave corners) be kept? While it
  // seems safer to never have copper extend outside the zone outline, 5.1.x and prior did
  // indeed fill them so we leave the mode available.
  if( keepExternalFillets )
  {
  withFillets = flattened;
  smooth( withFillets );
  withFillets.BooleanAdd( flattened, SHAPE_POLY_SET::PM_FAST );
  maxExtents = &withFillets;
  }
 
  for( ZONE* zone : interactingZones )
  {
  SHAPE_POLY_SET flattened_outline = *zone->Outline();
  flattened_outline.ClearArcs();
  aSmoothedPoly.BooleanAdd( flattened_outline, SHAPE_POLY_SET::PM_FAST );
  }
 
  if( aBoardOutline )
  {
  SHAPE_POLY_SET poly = *aBoardOutline;
  aSmoothedPoly.BooleanIntersection( poly, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
  }
 
  smooth( aSmoothedPoly );
 
  if( aSmoothedPolyWithApron )
  {
  SHAPE_POLY_SET poly = *maxExtents;
  poly.Inflate( m_ZoneMinThickness, 64 );
  *aSmoothedPolyWithApron = aSmoothedPoly;
  aSmoothedPolyWithApron->BooleanIntersection( poly, SHAPE_POLY_SET::PM_FAST );
  }
 
  aSmoothedPoly.BooleanIntersection( *maxExtents, SHAPE_POLY_SET::PM_FAST );
 
  return true;
 }

References SHAPE_POLY_SET::BooleanAdd(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::ClearArcs(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetInteractingZones(), GetIsRuleArea(), GetNumCorners(), SHAPE_POLY_SET::Inflate(), m_cornerRadius, m_cornerSmoothingType, BOARD_DESIGN_SETTINGS::m_MaxError, m_Poly, BOARD_DESIGN_SETTINGS::m_ZoneKeepExternalFillets, m_ZoneMinThickness, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, ZONE_SETTINGS::SMOOTHING_CHAMFER, and ZONE_SETTINGS::SMOOTHING_FILLET.

Referenced by ZONE_FILLER::fillSingleZone(), and TransformSmoothedOutlineToPolygon().

◆ CacheBoundingBox()

void ZONE::CacheBoundingBox ( )

inline

Definition at line 146 of file zone.h.

146 { m_bboxCache = GetBoundingBox(); }

ZONE::m_bboxCache

EDA_RECT m_bboxCache

Temp variables used while filling.

Definition: zone.h:920

ZONE::GetBoundingBox

const EDA_RECT GetBoundingBox() const override

Definition: zone.cpp:326

References GetBoundingBox(), and m_bboxCache.

Referenced by PNS_KICAD_IFACE_BASE::syncZone().

◆ CacheTriangulation()

void ZONE::CacheTriangulation ( PCB_LAYER_ID aLayer = UNDEFINED_LAYER )

Create a list of triangles that "fill" the solid areas used for instance to draw these solid areas on OpenGL.

Definition at line 1122 of file zone.cpp.

 {
  if( aLayer == UNDEFINED_LAYER )
  {
  for( std::pair<const PCB_LAYER_ID, SHAPE_POLY_SET>& pair : m_FilledPolysList )
  pair.second.CacheTriangulation();
  }
  else
  {
  if( m_FilledPolysList.count( aLayer ) )
  m_FilledPolysList[ aLayer ].CacheTriangulation();
  }
 }

References m_FilledPolysList, and UNDEFINED_LAYER.

◆ CalculateFilledArea()

double ZONE::CalculateFilledArea ( )

Compute the area currently occupied by the zone fill.

Returns: the currently filled area

Definition at line 1277 of file zone.cpp.

 {
  m_area = 0.0;
 
  // Iterate over each outline polygon in the zone and then iterate over
  // each hole it has to compute the total area.
  for( std::pair<const PCB_LAYER_ID, SHAPE_POLY_SET>& pair : m_FilledPolysList )
  {
  SHAPE_POLY_SET& poly = pair.second;
 
  for( int i = 0; i < poly.OutlineCount(); i++ )
  {
  m_area += poly.Outline( i ).Area();
 
  for( int j = 0; j < poly.HoleCount( i ); j++ )
  m_area -= poly.Hole( i, j ).Area();
  }
  }
 
  return m_area;
 }

References SHAPE_LINE_CHAIN::Area(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), m_area, m_FilledPolysList, SHAPE_POLY_SET::Outline(), and SHAPE_POLY_SET::OutlineCount().

◆ CIterateWithHoles()

SHAPE_POLY_SET::CONST_ITERATOR ZONE::CIterateWithHoles ( ) const

inline

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

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

Definition at line 553 of file zone.h.

  {
  return m_Poly->CIterateWithHoles();
  }

References SHAPE_POLY_SET::CIterateWithHoles(), and m_Poly.

◆ ClassOf()

static bool ZONE::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 74 of file zone.h.

  {
  return aItem && aItem->Type() == PCB_ZONE_T;
  }

References PCB_ZONE_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

  {
  ClearFlags( GetEditFlags() );
  }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by FOOTPRINT::Add(), BOARD::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

131 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

  {
  ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
  DO_NOT_DRAW );
  }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

  {
  m_viewPrivData = nullptr;
  }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * ZONE::Clone ( ) const

overridevirtual

Create 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.

Reimplemented in FP_ZONE.

Definition at line 186 of file zone.cpp.

 {
  return new ZONE( *this );
 }

References ZONE().

◆ CommonLayerExists()

bool ZONE::CommonLayerExists ( const LSET aLayerSet ) const

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

Definition at line 234 of file zone.cpp.

 {
  LSET common = GetLayerSet() & aLayerSet;
 
  return common.count() > 0;
 }

References GetLayerSet().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

Delete this object after removing from its parent if it has one.

Definition at line 128 of file board_item.cpp.

 {
  BOARD_ITEM_CONTAINER* parent = GetParent();
 
  if( parent )
  parent->Remove( this );
 
  delete this;
 }

References BOARD_ITEM::GetParent(), and BOARD_ITEM_CONTAINER::Remove().

Referenced by BOARD::PadDelete(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const

inlinevirtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 171 of file board_item.h.

  {
  EDA_ITEM* dupe = Clone();
  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
 
  return static_cast<BOARD_ITEM*>( dupe );
  }

References EDA_ITEM::Clone(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOOST_AUTO_TEST_CASE(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ FillSegments() [1/2]

std::vector<SEG>& ZONE::FillSegments ( PCB_LAYER_ID aLayer )

inline

Definition at line 308 of file zone.h.

  {
  wxASSERT( m_FillSegmList.count( aLayer ) );
  return m_FillSegmList.at( aLayer );
  }

References m_FillSegmList.

Referenced by PCB_PLUGIN::format().

◆ FillSegments() [2/2]

const std::vector<SEG>& ZONE::FillSegments ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 314 of file zone.h.

  {
  wxASSERT( m_FillSegmList.count( aLayer ) );
  return m_FillSegmList.at( aLayer );
  }

References m_FillSegmList.

◆ Flip() [1/2]

void BOARD_ITEM::Flip	(	const VECTOR2I &	aCentre,
		bool	aFlipLeftRight
	)

inlineinherited

Definition at line 269 of file board_item.h.

  {
  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
  }

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

◆ Flip() [2/2]

void ZONE::Flip	(	const wxPoint &	aCentre,
		bool	aFlipLeftRight
	)

overridevirtual

Flip this object, i.e.

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

Parameters

aCentre is the rotation point.

Reimplemented from BOARD_ITEM.

Definition at line 747 of file zone.cpp.

 {
  Mirror( aCentre, aFlipLeftRight );
  int copperLayerCount = GetBoard()->GetCopperLayerCount();
 
  if( GetIsRuleArea() )
  SetLayerSet( FlipLayerMask( GetLayerSet(), copperLayerCount ) );
  else
  SetLayer( FlipLayer( GetLayer(), copperLayerCount ) );
 }

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

  {
  PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
  return object ? aProperty->getter( object ) : wxAny();
  }

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

  {
  PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
  return object ? aProperty->get<T>( object ) : T();
  }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [3/3]

template<typename T >

boost::optional<T> INSPECTABLE::Get ( const wxString & aProperty )

inlineinherited

Definition at line 104 of file inspectable.h.

  {
  PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
  boost::optional<T> ret = T();
 
  if( prop )
  {
  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
  if( object )
  ret = prop->get<T>( object );
  }
 
  return ret;
  }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 36 of file board_item.cpp.

 {
  if( Type() == PCB_T )
  return static_cast<const BOARD*>( this );
 
  BOARD_ITEM* parent = GetParent();
 
  if( parent )
  return parent->GetBoard();
 
  return nullptr;
 }

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

Referenced by ZONE_FILLER::addHoleKnockout(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), BuildSmoothedPoly(), calcIsInsideArea(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), PCB_LAYER_VALUE::EqualTo(), existsOnLayer(), exprFromTo(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), PCB_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), Flip(), PCB_EXPR_CONTEXT::GetBoard(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), PCB_VIA::GetEffectiveShape(), GetInteractingZones(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), GetSelectMenuText(), DRC_ENGINE::GetShape(), FP_TEXT::GetShownText(), PAD::GetSolderMaskMargin(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), isInsideArea(), isInsideCourtyard(), BOARD_ITEM::IsLocked(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), PAD::MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), TransformSmoothedOutlineToPolygon(), TransformSolidAreasShapesToPolygon(), PCB_TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), PCB_VIA::ViewGetLOD(), and PAD::ViewGetLOD().

◆ GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 50 of file board_item.cpp.

 {
  if( Type() == PCB_T )
  return static_cast<BOARD*>( this );
 
  BOARD_ITEM* parent = GetParent();
 
  if( parent )
  return parent->GetBoard();
 
  return nullptr;
 }

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

◆ GetBorderHatchPitch()

int ZONE::GetBorderHatchPitch ( ) const

HatchBorder related methods.

Returns: the zone hatch pitch in iu.

Definition at line 904 of file zone.cpp.

 {
  return m_borderHatchPitch;
 }

References m_borderHatchPitch.

Referenced by PCB_PLUGIN::format().

◆ GetBoundingBox()

const EDA_RECT ZONE::GetBoundingBox ( ) const

overridevirtual

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

Reimplemented from EDA_ITEM.

Definition at line 326 of file zone.cpp.

 {
  auto bb = m_Poly->BBox();
 
  EDA_RECT ret( (wxPoint) bb.GetOrigin(), wxSize( bb.GetWidth(), bb.GetHeight() ) );
 
  return ret;
 }

References SHAPE_POLY_SET::BBox(), and m_Poly.

Referenced by CacheBoundingBox(), HitTest(), FABMASTER::orderZones(), and ALTIUM_PCB::ParsePolygons6Data().

◆ GetCachedBoundingBox()

const EDA_RECT ZONE::GetCachedBoundingBox ( ) const

inline

ONLY TO BE USED BY CLIENTS WHICH SET UP THE CACHE!

Definition at line 145 of file zone.h.

145 { return m_bboxCache; }

ZONE::m_bboxCache

EDA_RECT m_bboxCache

Temp variables used while filling.

Definition: zone.h:920

References m_bboxCache.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildThermalSpokes(), calcIsInsideArea(), ZONE_FILLER::Fill(), hasThermalConnection(), and ZONE_FILLER::subtractHigherPriorityZones().

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

This defaults to the center of the bounding box if not overridden.

Returns: center point of the item

Reimplemented in PCB_ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 81 of file board_item.h.

  {
  return GetBoundingBox().GetCenter();
  }

References EDA_ITEM::GetBoundingBox(), and EDA_RECT::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ GetClass()

wxString ZONE::GetClass ( ) const

inlineoverridevirtual

Returns: the class name.

Implements EDA_ITEM.

Definition at line 515 of file zone.h.

  {
  return wxT( "ZONE" );
  }

◆ GetCornerPosition()

const VECTOR2I& ZONE::GetCornerPosition ( int aCornerIndex ) const

inline

Definition at line 563 of file zone.h.

  {
  SHAPE_POLY_SET::VERTEX_INDEX index;
 
  // Convert global to relative indices
  if( !m_Poly->GetRelativeIndices( aCornerIndex, &index ) )
  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
 
  return m_Poly->CVertex( index );
  }

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

Referenced by GetPosition().

◆ GetCornerRadius()

unsigned int ZONE::GetCornerRadius ( ) const

inline

Definition at line 687 of file zone.h.

687 { return m_cornerRadius; }

ZONE::m_cornerRadius

unsigned int m_cornerRadius

Definition: zone.h:824

References m_cornerRadius.

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

◆ GetCornerSmoothingType()

int ZONE::GetCornerSmoothingType ( ) const

inline

Definition at line 683 of file zone.h.

683 { return m_cornerSmoothingType; }

ZONE::m_cornerSmoothingType

int m_cornerSmoothingType

Definition: zone.h:823

References m_cornerSmoothingType.

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

◆ GetDefaultHatchPitch()

int ZONE::GetDefaultHatchPitch ( )

static

Returns: the default hatch pitch in internal units.

Definition at line 1102 of file zone.cpp.

 {
  return Mils2iu( 20 );
 }

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPlain(), LEGACY_PLUGIN::loadZONE_CONTAINER(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), ALTIUM_PCB::ParseTracks6Data(), PCB_PARSER::parseZONE(), and ZONE().

◆ GetDoNotAllowCopperPour()

bool ZONE::GetDoNotAllowCopperPour ( ) const

inline

Definition at line 734 of file zone.h.

734 { return m_doNotAllowCopperPour; }

ZONE::m_doNotAllowCopperPour

bool m_doNotAllowCopperPour

Definition: zone.h:845

References m_doNotAllowCopperPour.

Referenced by PCB_PLUGIN::format(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), and ZONE_SETTINGS::operator<<().

◆ GetDoNotAllowFootprints()

bool ZONE::GetDoNotAllowFootprints ( ) const

inline

Definition at line 738 of file zone.h.

738 { return m_doNotAllowFootprints; }

ZONE::m_doNotAllowFootprints

bool m_doNotAllowFootprints

Definition: zone.h:849

References m_doNotAllowFootprints.

Referenced by PNS::ITEM::collideSimple(), PCB_PLUGIN::format(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), and ZONE_SETTINGS::operator<<().

◆ GetDoNotAllowPads()

bool ZONE::GetDoNotAllowPads ( ) const

inline

Definition at line 737 of file zone.h.

737 { return m_doNotAllowPads; }

ZONE::m_doNotAllowPads

bool m_doNotAllowPads

Definition: zone.h:848

References m_doNotAllowPads.

Referenced by PNS::ITEM::collideSimple(), PCB_PLUGIN::format(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), and ZONE_SETTINGS::operator<<().

◆ GetDoNotAllowTracks()

bool ZONE::GetDoNotAllowTracks ( ) const

inline

Definition at line 736 of file zone.h.

736 { return m_doNotAllowTracks; }

ZONE::m_doNotAllowTracks

bool m_doNotAllowTracks

Definition: zone.h:847

References m_doNotAllowTracks.

Referenced by PNS::ITEM::collideSimple(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), ZONE_SETTINGS::operator<<(), and PNS_KICAD_IFACE_BASE::syncZone().

◆ GetDoNotAllowVias()

bool ZONE::GetDoNotAllowVias ( ) const

inline

Definition at line 735 of file zone.h.

735 { return m_doNotAllowVias; }

ZONE::m_doNotAllowVias

bool m_doNotAllowVias

Definition: zone.h:846

References m_doNotAllowVias.

Referenced by PNS::ITEM::collideSimple(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), and ZONE_SETTINGS::operator<<().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

  {
  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
  | IS_WIRE_IMAGE | STRUCT_DELETED );
 
  return m_flags & mask;
  }

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveNetclass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetclass ( ) const

virtualinherited

Return the NETCLASS for this item, or the default netclass if none is defined.

Note: Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Definition at line 66 of file board_connected_item.cpp.

 {
  // NB: we must check the net first, as when it is 0 GetNetClass() will return the
  // orphaned net netclass, not the default netclass.
  if( !m_netinfo || m_netinfo->GetNetCode() == 0 )
  return GetBoard()->GetDesignSettings().GetDefault();
  else
  return GetNetClass();
 }

References BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetNetClass(), NETINFO_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::m_netinfo.

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > ZONE::GetEffectiveShape ( PCB_LAYER_ID aLayer = UNDEFINED_LAYER ) const

overridevirtual

Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

This routine returns a COMPOUND shape (set of simple shapes which make up the pad for use with routing, collision determination, etc).

Note: This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).

Parameters

aLayer in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.

Reimplemented from BOARD_ITEM.

Definition at line 1393 of file zone.cpp.

 {
  std::shared_ptr<SHAPE> shape;
 
  if( m_FilledPolysList.find( aLayer ) == m_FilledPolysList.end() )
  {
  shape = std::make_shared<SHAPE_NULL>();
  }
  else
  {
  shape.reset( m_FilledPolysList.at( aLayer ).Clone() );
  }
 
  return shape;
 }

References m_FilledPolysList.

◆ GetFilledArea()

double ZONE::GetFilledArea ( )

inline

This area is cached from the most recent call to CalculateFilledArea().

Returns: the filled area

Definition at line 217 of file zone.h.

  {
  return m_area;
  }

References m_area.

◆ GetFilledPolysList()

const SHAPE_POLY_SET& ZONE::GetFilledPolysList ( PCB_LAYER_ID aLayer ) const

inline

Returns: a reference to the list of filled polygons.

Definition at line 635 of file zone.h.

  {
  wxASSERT( m_FilledPolysList.count( aLayer ) );
  return m_FilledPolysList.at( aLayer );
  }

References m_FilledPolysList.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addSolidAreasShapes(), CN_ZONE_LAYER::AnchorCount(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), CN_VISITOR::checkZoneZoneConnection(), CN_ZONE_LAYER::CN_ZONE_LAYER(), KIGFX::PCB_PAINTER::draw(), CN_CONNECTIVITY_ALGO::FindIsolatedCopperIslands(), PCB_PLUGIN::format(), and CN_ZONE_LAYER::GetAnchor().

◆ GetFilledPolysUseThickness() [1/2]

bool ZONE::GetFilledPolysUseThickness ( ) const

inline

Definition at line 689 of file zone.h.

689 { return m_fillVersion == 5; }

ZONE::m_fillVersion

int m_fillVersion

Definition: zone.h:854

References m_fillVersion.

Referenced by BOARD_ADAPTER::addSolidAreasShapes(), CN_VISITOR::checkZoneZoneConnection(), ZONE_FILLER::computeRawFilledArea(), CN_ZONE_LAYER::ContainsPoint(), KIGFX::PCB_PAINTER::draw(), ZONE_FILLER::fillSingleZone(), PCB_PLUGIN::format(), GetFilledPolysUseThickness(), ALTIUM_PCB::ParseRegions6Data(), BRDITEMS_PLOTTER::PlotFilledAreas(), and TransformSolidAreasShapesToPolygon().

◆ GetFilledPolysUseThickness() [2/2]

bool ZONE::GetFilledPolysUseThickness ( PCB_LAYER_ID aLayer ) const

Definition at line 374 of file zone.cpp.

 {
  if( ADVANCED_CFG::GetCfg().m_DebugZoneFiller && LSET::InternalCuMask().Contains( aLayer ) )
  return false;
 
  return GetFilledPolysUseThickness();
 }

References ADVANCED_CFG::GetCfg(), GetFilledPolysUseThickness(), and LSET::InternalCuMask().

◆ GetFillFlag()

int ZONE::GetFillFlag ( PCB_LAYER_ID aLayer )

inline

Definition at line 227 of file zone.h.

  {
  return m_fillFlags.count( aLayer ) ? m_fillFlags[ aLayer ] : false;
  }

References m_fillFlags.

◆ GetFillMode()

ZONE_FILL_MODE ZONE::GetFillMode ( ) const

inline

Definition at line 181 of file zone.h.

181 { return m_fillMode; }

ZONE::m_fillMode

ZONE_FILL_MODE m_fillMode

How to fill areas:

Definition: zone.h:884

References m_fillMode.

Referenced by ZONE_FILLER::computeRawFilledArea(), ZONE_FILLER::fillSingleZone(), PCB_PLUGIN::format(), IsSame(), and ZONE_SETTINGS::operator<<().

◆ GetFillVersion()

int ZONE::GetFillVersion ( ) const

inline

Definition at line 692 of file zone.h.

692 { return m_fillVersion; }

ZONE::m_fillVersion

int m_fillVersion

Definition: zone.h:854

References m_fillVersion.

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

154 { return m_flags; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), calcIsInsideArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

258 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetHashValue()

MD5_HASH ZONE::GetHashValue ( PCB_LAYER_ID aLayer )

Returns: the hash value previously calculated by BuildHashValue().

Definition at line 386 of file zone.cpp.

 {
  if( !m_filledPolysHash.count( aLayer ) )
  return g_nullPoly.GetHash();
  else
  return m_filledPolysHash.at( aLayer );
 }

References g_nullPoly, SHAPE_POLY_SET::GetHash(), and m_filledPolysHash.

◆ GetHatchBorderAlgorithm()

int ZONE::GetHatchBorderAlgorithm ( ) const

inline

Definition at line 271 of file zone.h.

271 { return m_hatchBorderAlgorithm; }

ZONE::m_hatchBorderAlgorithm

int m_hatchBorderAlgorithm

Definition: zone.h:894

References m_hatchBorderAlgorithm.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHatchGap()

int ZONE::GetHatchGap ( ) const

inline

Definition at line 256 of file zone.h.

256 { return m_hatchGap; }

ZONE::m_hatchGap

int m_hatchGap

Definition: zone.h:886

References m_hatchGap.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHatchHoleMinArea()

double ZONE::GetHatchHoleMinArea ( ) const

inline

Definition at line 268 of file zone.h.

268 { return m_hatchHoleMinArea; }

ZONE::m_hatchHoleMinArea

double m_hatchHoleMinArea

Definition: zone.h:893

References m_hatchHoleMinArea.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHatchLines()

const std::vector<SEG>& ZONE::GetHatchLines ( ) const

inline

Definition at line 799 of file zone.h.

799 { return m_borderHatchLines; }

ZONE::m_borderHatchLines

std::vector< SEG > m_borderHatchLines

Definition: zone.h:928

References m_borderHatchLines.

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

◆ GetHatchOrientation()

double ZONE::GetHatchOrientation ( ) const

inline

Definition at line 259 of file zone.h.

259 { return m_hatchOrientation; }

ZONE::m_hatchOrientation

double m_hatchOrientation

Definition: zone.h:887

References m_hatchOrientation.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHatchSmoothingLevel()

int ZONE::GetHatchSmoothingLevel ( ) const

inline

Definition at line 262 of file zone.h.

262 { return m_hatchSmoothingLevel; }

ZONE::m_hatchSmoothingLevel

int m_hatchSmoothingLevel

Definition: zone.h:888

References m_hatchSmoothingLevel.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHatchSmoothingValue()

double ZONE::GetHatchSmoothingValue ( ) const

inline

Definition at line 265 of file zone.h.

265 { return m_hatchSmoothingValue; }

ZONE::m_hatchSmoothingValue

double m_hatchSmoothingValue

Definition: zone.h:892

References m_hatchSmoothingValue.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHatchStyle()

ZONE_BORDER_DISPLAY_STYLE ZONE::GetHatchStyle ( ) const

inline

Definition at line 613 of file zone.h.

613 { return m_borderStyle; }

ZONE::m_borderStyle

ZONE_BORDER_DISPLAY_STYLE m_borderStyle

Definition: zone.h:926

References m_borderStyle.

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

◆ GetHatchThickness()

int ZONE::GetHatchThickness ( ) const

inline

Definition at line 253 of file zone.h.

253 { return m_hatchThickness; }

ZONE::m_hatchThickness

int m_hatchThickness

Definition: zone.h:885

References m_hatchThickness.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), PCB_PLUGIN::format(), and ZONE_SETTINGS::operator<<().

◆ GetHV45()

bool ZONE::GetHV45 ( ) const

inline

Definition at line 801 of file zone.h.

801 { return m_hv45; }

ZONE::m_hv45

bool m_hv45

Definition: zone.h:933

References m_hv45.

Referenced by DRAWING_TOOL::DrawZone(), and ZONE_SETTINGS::operator<<().

◆ GetInteractingZones()

void ZONE::GetInteractingZones	(	PCB_LAYER_ID	aLayer,
		std::vector< ZONE * > *	aZones
	)		const

Some intersecting zones, despite being on the same layer with the same net, cannot be merged due to other parameters such as fillet radius.

The copper pour will end up effectively merged though, so we need to do some calculations with them in mind.

Definition at line 1149 of file zone.cpp.

 {
  int epsilon = Millimeter2iu( 0.001 );
 
  for( ZONE* candidate : GetBoard()->Zones() )
  {
  if( candidate == this )
  continue;
 
  if( !candidate->GetLayerSet().test( aLayer ) )
  continue;
 
  if( candidate->GetIsRuleArea() )
  continue;
 
  if( candidate->GetNetCode() != GetNetCode() )
  continue;
 
  for( auto iter = m_Poly->CIterate(); iter; iter++ )
  {
  if( candidate->m_Poly->Collide( iter.Get(), epsilon ) )
  {
  aZones->push_back( candidate );
  break;
  }
  }
  }
 }

References SHAPE_POLY_SET::CIterate(), BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNetCode(), m_Poly, and Millimeter2iu().

Referenced by BuildSmoothedPoly().

◆ GetIslandRemovalMode()

const ISLAND_REMOVAL_MODE ZONE::GetIslandRemovalMode ( ) const

inline

Definition at line 749 of file zone.h.

749 { return m_islandRemovalMode; }

ZONE::m_islandRemovalMode

ISLAND_REMOVAL_MODE m_islandRemovalMode

Definition: zone.h:856

References m_islandRemovalMode.

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

◆ GetIsRuleArea()

bool ZONE::GetIsRuleArea ( ) const

inline

Accessors to parameters used in Rule Area zones:

Definition at line 733 of file zone.h.

733 { return m_isRuleArea; }

ZONE::m_isRuleArea

bool m_isRuleArea

Definition: zone.h:840

References m_isRuleArea.

Referenced by BuildSmoothedPoly(), PCB_EDIT_FRAME::Edit_Zone_Params(), Flip(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), GetMsgPanelInfo(), GetNetClass(), GetNetClassName(), GetSelectMenuText(), HitTestFilledArea(), IsConnected(), isKeepoutZone(), IsSame(), PCB_SELECTION_TOOL::itemPassesFilter(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), ZONE_SETTINGS::operator<<(), DRC_TEST_PROVIDER_DISALLOW::Run(), SetLayerSet(), PNS_KICAD_IFACE_BASE::syncZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetLayer()

PCB_LAYER_ID ZONE::GetLayer ( ) const

overridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 222 of file zone.cpp.

 {
  return BOARD_ITEM::GetLayer();
 }

References BOARD_ITEM::GetLayer().

Referenced by BOARD::Add(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), Flip(), DSN::SPECCTRA_DB::FromBOARD(), GetMsgPanelInfo(), HatchBorder(), BOARD::NormalizeAreaPolygon(), FABMASTER::orderZones(), BRDITEMS_PLOTTER::PlotFilledAreas(), BOARD::TestZoneIntersection(), TransformSmoothedOutlineToPolygon(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

Return the name of the PCB layer on which the item resides.

Returns: the layer name associated with this item.

Definition at line 75 of file board_item.cpp.

 {
  const BOARD* board = GetBoard();
 
  if( board )
  return board->GetLayerName( m_layer );
 
  // If no parent, return standard name
  return BOARD::GetStandardLayerName( m_layer );
 }

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

Referenced by PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), PCB_DIMENSION_BASE::GetSelectMenuText(), PCB_TEXT::GetShownText(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

LSET ZONE::GetLayerSet ( ) const

overridevirtual

Return a std::bitset of all layers on which the item physically resides.

Reimplemented from BOARD_ITEM.

Definition at line 295 of file zone.cpp.

 {
  return m_layerSet;
 }

References m_layerSet.

Referenced by CN_CONNECTIVITY_ALGO::Add(), calcIsInsideArea(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), CommonLayerExists(), Flip(), PCB_PLUGIN::format(), InitDataFromSrcInCopyCtor(), BOARD_INSPECTION_TOOL::InspectClearance(), IsSame(), ZONE_SETTINGS::operator<<(), DRC_ENGINE::RunTests(), SaveCopyOfZones(), PCB_SELECTION_TOOL::Selectable(), and PNS_KICAD_IFACE_BASE::syncZone().

◆ GetLocalClearance() [1/2]

int ZONE::GetLocalClearance ( wxString * aSource ) const

overridevirtual

Return any local clearances set in the "classic" (ie: pre-rule) system.

These are things like zone clearance which are NOT an override.

Parameters

aSource [out] optionally reports the source as a user-readable string

Returns: the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 498 of file zone.cpp.

 {
  if( m_isRuleArea )
  return 0;
 
  if( aSource )
  *aSource = _( "zone" );
 
  return m_ZoneClearance;
 }

References _, m_isRuleArea, and m_ZoneClearance.

Referenced by ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildThermalSpokes(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), PCB_PLUGIN::format(), BOARD_INSPECTION_TOOL::InspectClearance(), and ZONE_SETTINGS::operator<<().

◆ GetLocalClearance() [2/2]

int ZONE::GetLocalClearance ( ) const

inline

Definition at line 157 of file zone.h.

157 { return GetLocalClearance( nullptr ); }

ZONE::GetLocalClearance

int GetLocalClearance() const

Definition: zone.h:157

References GetLocalClearance().

Referenced by GetLocalClearance(), and ZONE_DESC::ZONE_DESC().

◆ GetLocalClearanceOverrides()

virtual int BOARD_CONNECTED_ITEM::GetLocalClearanceOverrides ( wxString * aSource ) const

inlinevirtualinherited

Return any local clearance overrides set in the "classic" (ie: pre-rule) system.

Parameters

aSource [out] optionally reports the source as a user-readable string.

Returns: the clearance in internal units.

Reimplemented in PAD.

Definition at line 142 of file board_connected_item.h.

142 { return 0; }

Referenced by DRC_ENGINE::EvalRules().

◆ GetLocalFlags()

int ZONE::GetLocalFlags ( ) const

inline

Definition at line 305 of file zone.h.

305 { return m_localFlgs; }

ZONE::m_localFlgs

int m_localFlgs

Definition: zone.h:900

References m_localFlgs.

Referenced by InitDataFromSrcInCopyCtor().

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 184 of file board_connected_item.h.

  {
  return m_localRatsnestVisible;
  }

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ GetLock()

std::mutex& ZONE::GetLock ( )

inline

Definition at line 222 of file zone.h.

  {
  return m_lock;
  }

References m_lock.

Referenced by ZONE_FILLER::Fill().

◆ GetMenuImage()

BITMAPS ZONE::GetMenuImage ( ) const

overridevirtual

Return 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 1108 of file zone.cpp.

 {
  return BITMAPS::add_zone;
 }

References add_zone.

◆ GetMinIslandArea()

long long int ZONE::GetMinIslandArea ( ) const

inline

Definition at line 752 of file zone.h.

752 { return m_minIslandArea; }

ZONE::m_minIslandArea

long long int m_minIslandArea

When island removal mode is set to AREA, islands below this area will be removed.

Definition: zone.h:862

References m_minIslandArea.

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

◆ GetMinThickness()

int ZONE::GetMinThickness ( ) const

inline

Definition at line 244 of file zone.h.

244 { return m_ZoneMinThickness; }

ZONE::m_ZoneMinThickness

int m_ZoneMinThickness

Definition: zone.h:853

References m_ZoneMinThickness.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_ADAPTER::addSolidAreasShapes(), CN_VISITOR::checkZoneZoneConnection(), ZONE_FILLER::computeRawFilledArea(), CN_ZONE_LAYER::ContainsPoint(), KIGFX::PCB_PAINTER::draw(), ZONE_FILLER::fillSingleZone(), PCB_PLUGIN::format(), IsSame(), ZONE_SETTINGS::operator<<(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseRegions6Data(), BRDITEMS_PLOTTER::PlotFilledAreas(), TransformSolidAreasShapesToPolygon(), and ZONE_DESC::ZONE_DESC().

◆ GetMsgPanelInfo()

void ZONE::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 550 of file zone.cpp.

 {
  EDA_UNITS units = aFrame->GetUserUnits();
  wxString msg;
 
  if( GetIsRuleArea() )
  msg = _( "Rule Area" );
  else if( IsOnCopperLayer() )
  msg = _( "Copper Zone" );
  else
  msg = _( "Non-copper Zone" );
 
  // Display Cutout instead of Outline for holes inside a zone (i.e. when num contour !=0).
  // Check whether the selected corner is in a hole; i.e., in any contour but the first one.
  if( m_CornerSelection != nullptr && m_CornerSelection->m_contour > 0 )
  msg << wxT( " " ) << _( "Cutout" );
 
  aList.emplace_back( _( "Type" ), msg );
 
  if( GetIsRuleArea() )
  {
  msg.Empty();
 
  if( GetDoNotAllowVias() )
  AccumulateDescription( msg, _( "No vias" ) );
 
  if( GetDoNotAllowTracks() )
  AccumulateDescription( msg, _( "No tracks" ) );
 
  if( GetDoNotAllowPads() )
  AccumulateDescription( msg, _( "No pads" ) );
 
  if( GetDoNotAllowCopperPour() )
  AccumulateDescription( msg, _( "No copper zones" ) );
 
  if( GetDoNotAllowFootprints() )
  AccumulateDescription( msg, _( "No footprints" ) );
 
  if( !msg.IsEmpty() )
  aList.emplace_back( MSG_PANEL_ITEM( _( "Restrictions" ), msg ) );
  }
  else if( IsOnCopperLayer() )
  {
  if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
  {
  aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
 
  aList.emplace_back( _( "Net Class" ), UnescapeString( GetNetClass()->GetName() ) );
  }
 
  // Display priority level
  aList.emplace_back( _( "Priority" ), wxString::Format( "%d", GetPriority() ) );
  }
 
  if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
  {
  if( IsLocked() )
  aList.emplace_back( _( "Status" ), _( "Locked" ) );
  }
 
  wxString layerDesc;
  int count = 0;
 
  for( PCB_LAYER_ID layer : m_layerSet.Seq() )
  {
  if( count == 0 )
  layerDesc = GetBoard()->GetLayerName( layer );
 
  count++;
  }
 
  if( count > 1 )
  layerDesc.Printf( _( "%s and %d more" ), layerDesc, count - 1 );
 
  aList.emplace_back( _( "Layer" ), layerDesc );
 
  if( !m_zoneName.empty() )
  aList.emplace_back( _( "Name" ), m_zoneName );
 
  switch( m_fillMode )
  {
  case ZONE_FILL_MODE::POLYGONS: msg = _( "Solid" ); break;
  case ZONE_FILL_MODE::HATCH_PATTERN: msg = _( "Hatched" ); break;
  default: msg = _( "Unknown" ); break;
  }
 
  aList.emplace_back( _( "Fill Mode" ), msg );
 
  msg = MessageTextFromValue( units, m_area, true, EDA_DATA_TYPE::AREA );
  aList.emplace_back( _( "Filled Area" ), msg );
 
  wxString source;
  int clearance = GetOwnClearance( GetLayer(), &source );
 
  if( !source.IsEmpty() )
  {
  aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
  MessageTextFromValue( units, clearance ) ),
  wxString::Format( _( "(from %s)" ),
  source ) );
  }
 
  // Useful for statistics, especially when zones are complex the number of hatches
  // and filled polygons can explain the display and DRC calculation time:
  msg.Printf( wxT( "%d" ), (int) m_borderHatchLines.size() );
  aList.emplace_back( MSG_PANEL_ITEM( _( "HatchBorder Lines" ), msg ) );
 
  PCB_LAYER_ID layer = m_layer;
 
  // NOTE: This brings in dependence on PCB_EDIT_FRAME to the qa tests, which isn't ideal.
  // TODO: Figure out a way for items to know the active layer without the whole edit frame?
 #if 0
  if( PCB_EDIT_FRAME* pcbframe = dynamic_cast<PCB_EDIT_FRAME*>( aFrame ) )
  {
  if( m_FilledPolysList.count( pcbframe->GetActiveLayer() ) )
  layer = pcbframe->GetActiveLayer();
  }
 #endif
 
  if( !GetIsRuleArea() )
  {
  auto layer_it = m_FilledPolysList.find( layer );
 
  if( layer_it == m_FilledPolysList.end() )
  layer_it = m_FilledPolysList.begin();
 
  if( layer_it != m_FilledPolysList.end() )
  {
  msg.Printf( wxT( "%d" ), layer_it->second.TotalVertices() );
  aList.emplace_back( MSG_PANEL_ITEM( _( "Corner Count" ), msg ) );
  }
  }
 }

References _, AccumulateDescription(), AREA, Format(), BOARD_ITEM::GetBoard(), GetDoNotAllowCopperPour(), GetDoNotAllowFootprints(), GetDoNotAllowPads(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetIsRuleArea(), GetLayer(), BOARD::GetLayerName(), GetNetClass(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_CONNECTED_ITEM::GetOwnClearance(), GetPriority(), EDA_BASE_FRAME::GetUserUnits(), HATCH_PATTERN, BOARD_ITEM::IsLocked(), IsOnCopperLayer(), m_area, m_borderHatchLines, SHAPE_POLY_SET::VERTEX_INDEX::m_contour, m_CornerSelection, m_FilledPolysList, m_fillMode, BOARD_ITEM::m_layer, m_layerSet, m_zoneName, MessageTextFromValue(), PCB_EDIT_FRAME_NAME, POLYGONS, LSET::Seq(), and UnescapeString().

◆ GetNet()

NETINFO_ITEM* BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return #NET_INFO object for a given item.

Definition at line 75 of file board_connected_item.h.

  {
  return m_netinfo;
  }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), isCoupledDiffPair(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), EDA_3D_CANVAS::OnMouseMove(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow().

◆ GetNetClass()

NETCLASS* ZONE::GetNetClass ( ) const

inlineoverridevirtual

Return the NETCLASS for this item.

Note: Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 87 of file zone.h.

  {
  if( GetIsRuleArea() )
  return nullptr;
 
  return BOARD_CONNECTED_ITEM::GetNetClass();
  }

References GetIsRuleArea(), and BOARD_CONNECTED_ITEM::GetNetClass().

Referenced by GetMsgPanelInfo().

◆ GetNetClassName()

wxString ZONE::GetNetClassName ( ) const

inlineoverridevirtual

Returns 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.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 95 of file zone.h.

  {
  if( GetIsRuleArea() )
  return "UNDEFINED";
 
  return BOARD_CONNECTED_ITEM::GetNetClassName();
  }

References GetIsRuleArea(), and BOARD_CONNECTED_ITEM::GetNetClassName().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 100 of file board_connected_item.cpp.

 {
  return m_netinfo ? m_netinfo->GetNetCode() : -1;
 }

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

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), connectedItemFilter(), CreateRoutesSection(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), ZONE_FILLER::Fill(), PNS::NODE::FindItemByParent(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), GetInteractingZones(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CONNECTIVITY_DATA::GetRatsnestForPad(), hasThermalConnection(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::IsConnectedOnLayer(), IsIsland(), IsSame(), ZONE_FILLER::knockoutThermalReliefs(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), BOARD::NormalizeAreaPolygon(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), PCB_SELECTION_TOOL::selectNet(), ZONE_FILLER::subtractHigherPriorityZones(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD::TracksInNet(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 126 of file board_connected_item.cpp.

 {
  return m_netinfo ? m_netinfo->GetNetname() : wxString();
 }

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CN_CLUSTER::OriginNetName(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const

inherited

Returns: the full netname or "<no net>" in square braces, followed by "(Not Found)" if the netcode is undefined.

Definition at line 132 of file board_connected_item.cpp.

 {
  if( !GetBoard() )
  return wxT( "[** NO BOARD DEFINED **]" );
 
  wxString netname = GetNetname();
 
  if( !netname.length() )
  return wxT( "[<no net>]" );
  else if( GetNetCode() < 0 )
  return wxT( "[" + UnescapeString( netname ) + "](" + _( "Not Found" ) + ")" );
  else
  return wxT( "[" + UnescapeString( netname ) + "]" );
 }

References _, BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), and UnescapeString().

Referenced by PCB_TRACK::GetSelectMenuText(), PCB_VIA::GetSelectMenuText(), PAD::GetSelectMenuText(), and GetSelectMenuText().

◆ GetNumCorners()

int ZONE::GetNumCorners ( void ) const

inline

Access to m_Poly parameters.

Definition at line 523 of file zone.h.

  {
  return m_Poly->TotalVertices();
  }

References m_Poly, and SHAPE_POLY_SET::TotalVertices().

Referenced by BuildSmoothedPoly(), and PCB_PLUGIN::format().

◆ GetOwnClearance()

int BOARD_CONNECTED_ITEM::GetOwnClearance	(	PCB_LAYER_ID	aLayer,
		wxString *	aSource = `nullptr`
	)		const

virtualinherited

Return an item's "own" clearance in internal units.

Parameters

aLayer	the layer in question.
aSource	[out] optionally reports the source as a user-readable string.

Returns: the clearance in internal units.

Definition at line 77 of file board_connected_item.cpp.

 {
  DRC_CONSTRAINT constraint;
 
  if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
  {
  BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
  constraint = bds.m_DRCEngine->EvalRules( CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
  }
 
  if( constraint.Value().HasMin() )
  {
  if( aSource )
  *aSource = constraint.GetName();
 
  return constraint.Value().Min();
  }
 
  return 0;
 }

References CLEARANCE_CONSTRAINT, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMin(), BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Min(), and DRC_CONSTRAINT::Value().

Referenced by KIGFX::PCB_PAINTER::draw(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::ViewBBox().

◆ GetPadConnection() [1/2]

ZONE_CONNECTION ZONE::GetPadConnection	(	PAD *	aPad,
		wxString *	aSource = `nullptr`
	)		const

Definition at line 788 of file zone.cpp.

 {
  if( aPad == nullptr || aPad->GetEffectiveZoneConnection() == ZONE_CONNECTION::INHERITED )
  {
  if( aSource )
  *aSource = _( "zone" );
 
  return m_PadConnection;
  }
  else
  {
  return aPad->GetEffectiveZoneConnection( aSource );
  }
 }

References _, PAD::GetEffectiveZoneConnection(), INHERITED, and m_PadConnection.

Referenced by ZONE_FILLER::buildCopperItemClearances(), PCB_PLUGIN::format(), hasThermalConnection(), BOARD_INSPECTION_TOOL::InspectClearance(), and ZONE_SETTINGS::operator<<().

◆ GetPadConnection() [2/2]

ZONE_CONNECTION ZONE::GetPadConnection ( ) const

inline

Definition at line 241 of file zone.h.

241 { return m_PadConnection; }

ZONE::m_PadConnection

ZONE_CONNECTION m_PadConnection

Definition: zone.h:851

References m_PadConnection.

Referenced by ZONE_DESC::ZONE_DESC().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 135 of file board_item.h.

135 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:478

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:52

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 179 of file board_item.cpp.

 {
  BOARD_ITEM_CONTAINER* ancestor = GetParent();
 
  while( ancestor && ancestor->Type() == PCB_GROUP_T )
  ancestor = ancestor->GetParent();
 
  return ( ancestor && ancestor->Type() == PCB_FOOTPRINT_T ) ? ancestor : nullptr;
 }

References BOARD_ITEM::GetParent(), PCB_FOOTPRINT_T, PCB_GROUP_T, and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), PNS::ITEM::collideSimple(), and CONVERT_TOOL::CreatePolys().

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 60 of file board_item.h.

60 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:319

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), PCB_EDIT_FRAME::ExchangeFootprint(), getTopLevelGroup(), BOARD_ITEM::IsLocked(), memberOf(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), EDIT_TOOL::Remove(), FOOTPRINT::Remove(), BOARD::Remove(), GROUP_TOOL::RemoveFromGroup(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetPosition()

wxPoint ZONE::GetPosition ( ) const

overridevirtual

Returns: a wxPoint, position of the first point of the outline

Reimplemented from EDA_ITEM.

Definition at line 216 of file zone.cpp.

 {
  return (wxPoint) GetCornerPosition( 0 );
 }

References GetCornerPosition().

Referenced by EAGLE_PLUGIN::loadPlain().

◆ GetPriority()

unsigned ZONE::GetPriority ( ) const

inline

Returns: the priority level of this zone.

Definition at line 122 of file zone.h.

122 { return m_priority; }

ZONE::m_priority

unsigned m_priority

Definition: zone.h:835

References m_priority.

Referenced by ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::Fill(), PCB_PLUGIN::format(), GetMsgPanelInfo(), IsSame(), ZONE_SETTINGS::operator<<(), ZONE_FILLER::subtractHigherPriorityZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), ZONE_DESC::ZONE_DESC(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetSelectedCorner()

int ZONE::GetSelectedCorner ( ) const

inline

Definition at line 274 of file zone.h.

  {
  // Transform relative indices to global index
  int globalIndex = -1;
 
  if( m_CornerSelection )
  m_Poly->GetGlobalIndex( *m_CornerSelection, globalIndex );
 
  return globalIndex;
  }

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

◆ GetSelectMenuText()

wxString ZONE::GetSelectMenuText ( EDA_UNITS aUnits ) const

overridevirtual

Return 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 870 of file zone.cpp.

 {
  wxString layerDesc;
  int count = 0;
 
  for( PCB_LAYER_ID layer : m_layerSet.Seq() )
  {
  if( count == 0 )
  layerDesc = GetBoard()->GetLayerName( layer );
 
  count++;
  }
 
  if( count > 1 )
  layerDesc.Printf( _( "%s and %d more" ), layerDesc, count - 1 );
 
  // Check whether the selected contour is a hole (contour index > 0)
  if( m_CornerSelection != nullptr && m_CornerSelection->m_contour > 0 )
  {
  if( GetIsRuleArea() )
  return wxString::Format( _( "Rule Area Cutout on %s" ), layerDesc );
  else
  return wxString::Format( _( "Zone Cutout on %s" ), layerDesc );
  }
  else
  {
  if( GetIsRuleArea() )
  return wxString::Format( _( "Rule Area on %s" ), layerDesc );
  else
  return wxString::Format( _( "Zone %s on %s" ), GetNetnameMsg(), layerDesc );
  }
 }

References _, Format(), BOARD_ITEM::GetBoard(), GetIsRuleArea(), BOARD::GetLayerName(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), SHAPE_POLY_SET::VERTEX_INDEX::m_contour, m_CornerSelection, m_layerSet, and LSET::Seq().

Referenced by PNS_KICAD_IFACE_BASE::syncZone().

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 148 of file board_connected_item.cpp.

 {
  return m_netinfo->GetShortNetname();
 }

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

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

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

  {
  return m_status & type;
  }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

149 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:477

References EDA_ITEM::m_status.

◆ GetThermalReliefGap() [1/2]

int ZONE::GetThermalReliefGap ( ) const

inline

Definition at line 191 of file zone.h.

191 { return m_thermalReliefGap; }

ZONE::m_thermalReliefGap

int m_thermalReliefGap

Definition: zone.h:874

References m_thermalReliefGap.

Referenced by ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildThermalSpokes(), PCB_PLUGIN::format(), hasThermalConnection(), BOARD_INSPECTION_TOOL::InspectClearance(), ZONE_FILLER::knockoutThermalReliefs(), ZONE_SETTINGS::operator<<(), and ZONE_DESC::ZONE_DESC().

◆ GetThermalReliefGap() [2/2]

int ZONE::GetThermalReliefGap	(	PAD *	aPad,
		wxString *	aSource = `nullptr`
	)		const

Definition at line 336 of file zone.cpp.

 {
  if( aPad->GetEffectiveThermalGap() == 0 )
  {
  if( aSource )
  *aSource = _( "zone" );
 
  return m_thermalReliefGap;
  }
 
  return aPad->GetEffectiveThermalGap( aSource );
 
 }

References _, PAD::GetEffectiveThermalGap(), and m_thermalReliefGap.

◆ GetThermalReliefSpokeWidth() [1/2]

int ZONE::GetThermalReliefSpokeWidth ( ) const

inline

Definition at line 202 of file zone.h.

202 { return m_thermalReliefSpokeWidth; }

ZONE::m_thermalReliefSpokeWidth

int m_thermalReliefSpokeWidth

Definition: zone.h:875

References m_thermalReliefSpokeWidth.

Referenced by ZONE_FILLER::buildThermalSpokes(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), and ZONE_DESC::ZONE_DESC().

◆ GetThermalReliefSpokeWidth() [2/2]

int ZONE::GetThermalReliefSpokeWidth	(	PAD *	aPad,
		wxString *	aSource = `nullptr`
	)		const

Definition at line 351 of file zone.cpp.

 {
  if( aPad->GetEffectiveThermalSpokeWidth() == 0 )
  {
  if( aSource )
   *aSource = _( "zone" );
 
  return m_thermalReliefSpokeWidth;
  }
 
  return aPad->GetEffectiveThermalSpokeWidth( aSource );
 }

References _, PAD::GetEffectiveThermalSpokeWidth(), and m_thermalReliefSpokeWidth.

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 64 of file board_item.h.

  {
  wxPoint p = GetPosition();
  return p.x;
  }

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), BOARD_ITEM::SetY(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 70 of file board_item.h.

  {
  wxPoint p = GetPosition();
  return p.y;
  }

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), BOARD_ITEM::SetX(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetZoneName()

wxString ZONE::GetZoneName ( ) const

inline

Definition at line 129 of file zone.h.

129 { return m_zoneName; }

ZONE::m_zoneName

wxString m_zoneName

An optional unique name for this zone, used for identifying it in DRC checking.

Definition: zone.h:827

References m_zoneName.

Referenced by PCB_PLUGIN::format(), PNS::ROUTER::isStartingPointRoutable(), Matches(), ZONE_SETTINGS::operator<<(), PNS_KICAD_IFACE_BASE::syncZone(), and ZONE_DESC::ZONE_DESC().

◆ HasFilledPolysForLayer()

bool ZONE::HasFilledPolysForLayer ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 627 of file zone.h.

  {
  return m_FilledPolysList.count( aLayer ) > 0;
  }

References m_FilledPolysList.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), and ALTIUM_PCB::ParseRegions6Data().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

155 { return ( m_flags & aFlag ) == aFlag; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

◆ HatchBorder()

void ZONE::HatchBorder ( )

Compute the hatch lines depending on the hatch parameters and stores it in the zone's attribute m_borderHatchLines.

Definition at line 941 of file zone.cpp.

 {
  UnHatchBorder();
 
  if( m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::NO_HATCH
  || m_borderHatchPitch == 0
  || m_Poly->IsEmpty() )
  {
  return;
  }
 
  // define range for hatch lines
  int min_x = m_Poly->CVertex( 0 ).x;
  int max_x = m_Poly->CVertex( 0 ).x;
  int min_y = m_Poly->CVertex( 0 ).y;
  int max_y = m_Poly->CVertex( 0 ).y;
 
  for( auto iterator = m_Poly->IterateWithHoles(); iterator; iterator++ )
  {
  if( iterator->x < min_x )
  min_x = iterator->x;
 
  if( iterator->x > max_x )
  max_x = iterator->x;
 
  if( iterator->y < min_y )
  min_y = iterator->y;
 
  if( iterator->y > max_y )
  max_y = iterator->y;
  }
 
  // Calculate spacing between 2 hatch lines
  int spacing;
 
  if( m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE )
  spacing = m_borderHatchPitch;
  else
  spacing = m_borderHatchPitch * 2;
 
  // set the "length" of hatch lines (the length on horizontal axis)
  int hatch_line_len = m_borderHatchPitch;
 
  // To have a better look, give a slope depending on the layer
  LAYER_NUM layer = GetLayer();
  int slope_flag = (layer & 1) ? 1 : -1; // 1 or -1
  double slope = 0.707106 * slope_flag; // 45 degrees slope
  int max_a, min_a;
 
  if( slope_flag == 1 )
  {
  max_a = KiROUND( max_y - slope * min_x );
  min_a = KiROUND( min_y - slope * max_x );
  }
  else
  {
  max_a = KiROUND( max_y - slope * max_x );
  min_a = KiROUND( min_y - slope * min_x );
  }
 
  min_a = (min_a / spacing) * spacing;
 
  // calculate an offset depending on layer number,
  // for a better look of hatches on a multilayer board
  int offset = (layer * 7) / 8;
  min_a += offset;
 
  // loop through hatch lines
  #define MAXPTS 200 // Usually we store only few values per one hatch line
  // depending on the complexity of the zone outline
 
  static std::vector<VECTOR2I> pointbuffer;
  pointbuffer.clear();
  pointbuffer.reserve( MAXPTS + 2 );
 
  for( int a = min_a; a < max_a; a += spacing )
  {
  // get intersection points for this hatch line
 
  // Note: because we should have an even number of intersections with the
  // current hatch line and the zone outline (a closed polygon,
  // or a set of closed polygons), if an odd count is found
  // we skip this line (should not occur)
  pointbuffer.clear();
 
  // Iterate through all vertices
  for( auto iterator = m_Poly->IterateSegmentsWithHoles(); iterator; iterator++ )
  {
  double x, y;
  bool ok;
 
  SEG segment = *iterator;
 
  ok = FindLineSegmentIntersection( a, slope, segment.A.x, segment.A.y, segment.B.x,
  segment.B.y, x, y );
 
  if( ok )
  {
  VECTOR2I point( KiROUND( x ), KiROUND( y ) );
  pointbuffer.push_back( point );
  }
 
  if( pointbuffer.size() >= MAXPTS ) // overflow
  {
  wxASSERT( 0 );
  break;
  }
  }
 
  // ensure we have found an even intersection points count
  // because intersections are the ends of segments
  // inside the polygon(s) and a segment has 2 ends.
  // if not, this is a strange case (a bug ?) so skip this hatch
  if( pointbuffer.size() % 2 != 0 )
  continue;
 
  // sort points in order of descending x (if more than 2) to
  // ensure the starting point and the ending point of the same segment
  // are stored one just after the other.
  if( pointbuffer.size() > 2 )
  sort( pointbuffer.begin(), pointbuffer.end(), sortEndsByDescendingX );
 
  // creates lines or short segments inside the complex polygon
  for( unsigned ip = 0; ip < pointbuffer.size(); ip += 2 )
  {
  int dx = pointbuffer[ip + 1].x - pointbuffer[ip].x;
 
  // Push only one line for diagonal hatch,
  // or for small lines < twice the line length
  // else push 2 small lines
  if( m_borderStyle == ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL
  || std::abs( dx ) < 2 * hatch_line_len )
  {
  m_borderHatchLines.emplace_back( SEG( pointbuffer[ip], pointbuffer[ ip + 1] ) );
  }
  else
  {
  double dy = pointbuffer[ip + 1].y - pointbuffer[ip].y;
  slope = dy / dx;
 
  if( dx > 0 )
  dx = hatch_line_len;
  else
  dx = -hatch_line_len;
 
  int x1 = KiROUND( pointbuffer[ip].x + dx );
  int x2 = KiROUND( pointbuffer[ip + 1].x - dx );
  int y1 = KiROUND( pointbuffer[ip].y + dx * slope );
  int y2 = KiROUND( pointbuffer[ip + 1].y - dx * slope );
 
  m_borderHatchLines.emplace_back( SEG( pointbuffer[ip].x, pointbuffer[ip].y,
  x1, y1 ) );
 
  m_borderHatchLines.emplace_back( SEG( pointbuffer[ip+1].x, pointbuffer[ip+1].y,
  x2, y2 ) );
  }
  }
  }
 }

References SEG::A, SEG::B, SHAPE_POLY_SET::CVertex(), DIAGONAL_EDGE, DIAGONAL_FULL, GetLayer(), SHAPE_POLY_SET::IsEmpty(), SHAPE_POLY_SET::IterateSegmentsWithHoles(), SHAPE_POLY_SET::IterateWithHoles(), KiROUND(), m_borderHatchLines, m_borderHatchPitch, m_borderStyle, m_Poly, MAXPTS, NO_HATCH, sortEndsByDescendingX(), UnHatchBorder(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CONVERT_TOOL::CreatePolys(), Mirror(), Move(), MoveEdge(), BOARD::NormalizeAreaPolygon(), EDIT_TOOL::Remove(), Rotate(), SetBorderDisplayStyle(), and PCB_POINT_EDITOR::updateItem().

◆ HitTest() [1/2]

bool ZONE::HitTest	(	const wxPoint &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if a point is near an outline edge or a corner of this zone.

Parameters

aPosition the wxPoint to test

Returns: true if a hit, else false

Reimplemented from EDA_ITEM.

Definition at line 404 of file zone.cpp.

 {
  // When looking for an "exact" hit aAccuracy will be 0 which works poorly for very thin
  // lines. Give it a floor.
  int accuracy = std::max( aAccuracy, Millimeter2iu( 0.1 ) );
 
  return HitTestForCorner( aPosition, accuracy * 2 ) || HitTestForEdge( aPosition, accuracy );
 }

References HitTestForCorner(), HitTestForEdge(), and Millimeter2iu().

◆ HitTest() [2/2]

bool ZONE::HitTest	(	const EDA_RECT &	aRect,
		bool	aContained = `true`,
		int	aAccuracy = `0`
	)		const

overridevirtual

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 457 of file zone.cpp.

 {
  // Calculate bounding box for zone
  EDA_RECT bbox = GetBoundingBox();
  bbox.Normalize();
 
  EDA_RECT arect = aRect;
  arect.Normalize();
  arect.Inflate( aAccuracy );
 
  if( aContained )
  {
  return arect.Contains( bbox );
  }
  else
  {
  // Fast test: if aBox is outside the polygon bounding box, rectangles cannot intersect
  if( !arect.Intersects( bbox ) )
  return false;
 
  int count = m_Poly->TotalVertices();
 
  for( int ii = 0; ii < count; ii++ )
  {
  auto vertex = m_Poly->CVertex( ii );
  auto vertexNext = m_Poly->CVertex( ( ii + 1 ) % count );
 
  // Test if the point is within the rect
  if( arect.Contains( ( wxPoint ) vertex ) )
  return true;
 
  // Test if this edge intersects the rect
  if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
  return true;
  }
 
  return false;
  }
 }

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

◆ HitTestCutout() [1/2]

bool ZONE::HitTestCutout	(	const VECTOR2I &	aRefPos,
		int *	aOutlineIdx = `nullptr`,
		int *	aHoleIdx = `nullptr`
	)		const

Test if the given point is contained within a cutout of the zone.

Parameters

aRefPos	is the point to test
aOutlineIdx	is the index of the outline containing the cutout
aHoleIdx	is the index of the hole

Returns: true if aRefPos is inside a zone cutout

Definition at line 525 of file zone.cpp.

 {
  // Iterate over each outline polygon in the zone and then iterate over
  // each hole it has to see if the point is in it.
  for( int i = 0; i < m_Poly->OutlineCount(); i++ )
  {
  for( int j = 0; j < m_Poly->HoleCount( i ); j++ )
  {
  if( m_Poly->Hole( i, j ).PointInside( aRefPos ) )
  {
  if( aOutlineIdx )
   *aOutlineIdx = i;
 
  if( aHoleIdx )
  *aHoleIdx = j;
 
  return true;
  }
  }
  }
 
  return false;
 }

References SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), m_Poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN_BASE::PointInside().

Referenced by HitTestCutout(), and EDIT_TOOL::Remove().

◆ HitTestCutout() [2/2]

bool ZONE::HitTestCutout	(	const wxPoint &	aRefPos,
		int *	aOutlineIdx = `nullptr`,
		int *	aHoleIdx = `nullptr`
	)		const

inline

Definition at line 358 of file zone.h.

  {
  return HitTestCutout( VECTOR2I( aRefPos.x, aRefPos.y ), aOutlineIdx, aHoleIdx );
  }

References HitTestCutout().

◆ HitTestFilledArea()

bool ZONE::HitTestFilledArea	(	PCB_LAYER_ID	aLayer,
		const wxPoint &	aRefPos,
		int	aAccuracy = `0`
	)		const

Test if the given wxPoint is within the bounds of a filled area of this zone.

Parameters

aLayer	is the layer to test on
aRefPos	A wxPoint to test
aAccuracy	Expand the distance by which the areas are expanded for the hittest

Returns: true if a hit, else false

Definition at line 510 of file zone.cpp.

 {
  // Rule areas have no filled area, but it's generally nice to treat their interior as if it were
  // filled so that people don't have to select them by their outline (which is min-width)
  if( GetIsRuleArea() )
  return m_Poly->Contains( VECTOR2I( aRefPos.x, aRefPos.y ), -1, aAccuracy );
 
  if( !m_FilledPolysList.count( aLayer ) )
  return false;
 
  return m_FilledPolysList.at( aLayer ).Contains( VECTOR2I( aRefPos.x, aRefPos.y ), -1,
  aAccuracy );
 }

References SHAPE_POLY_SET::Contains(), GetIsRuleArea(), m_FilledPolysList, and m_Poly.

Referenced by CN_ANCHOR::ConnectedItemsCount(), GENERAL_COLLECTOR::Inspect(), and CN_ANCHOR::IsDangling().

◆ HitTestForCorner() [1/2]

bool ZONE::HitTestForCorner	(	const wxPoint &	refPos,
		int	aAccuracy,
		SHAPE_POLY_SET::VERTEX_INDEX &	aCornerHit
	)		const

Test if the given wxPoint is near a corner.

Parameters

refPos	is the wxPoint to test.
aAccuracy	increase the item bounding box by this amount.
aCornerHit	[out] is the index of the closest vertex found, useless when return value is false.

Returns: true if some corner was found to be closer to refPos than aClearance; false otherwise.

Definition at line 429 of file zone.cpp.

 {
  return m_Poly->CollideVertex( VECTOR2I( refPos ), aCornerHit, aAccuracy );
 }

References SHAPE_POLY_SET::CollideVertex(), and m_Poly.

Referenced by HitTest(), HitTestForCorner(), GENERAL_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::Main(), and SetSelectedCorner().

◆ HitTestForCorner() [2/2]

bool ZONE::HitTestForCorner	(	const wxPoint &	refPos,
		int	aAccuracy
	)		const

Test if the given wxPoint is near a corner.

Parameters

refPos	is the wxPoint to test.
aAccuracy	increase the item bounding box by this amount.

Returns: true if some corner was found to be closer to refPos than aClearance; false otherwise.

Definition at line 436 of file zone.cpp.

 {
  SHAPE_POLY_SET::VERTEX_INDEX dummy;
  return HitTestForCorner( refPos, aAccuracy, dummy );
 }

References dummy(), and HitTestForCorner().

◆ HitTestForEdge() [1/2]

bool ZONE::HitTestForEdge	(	const wxPoint &	refPos,
		int	aAccuracy,
		SHAPE_POLY_SET::VERTEX_INDEX &	aCornerHit
	)		const

Test if the given wxPoint is near a segment defined by 2 corners.

Parameters

refPos	is the wxPoint to test.
aAccuracy	increase the item bounding box by this amount.
aCornerHit	[out] is the index of the closest vertex found, useless when return value is false.

Returns: true if some edge was found to be closer to refPos than aClearance.

Definition at line 443 of file zone.cpp.

 {
  return m_Poly->CollideEdge( VECTOR2I( refPos ), aCornerHit, aAccuracy );
 }

References SHAPE_POLY_SET::CollideEdge(), and m_Poly.

Referenced by HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), HitTestForEdge(), GENERAL_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::Main(), and SetSelectedCorner().

◆ HitTestForEdge() [2/2]

bool ZONE::HitTestForEdge	(	const wxPoint &	refPos,
		int	aAccuracy
	)		const

Test if the given wxPoint is near a segment defined by 2 corners.

Parameters

refPos	is the wxPoint to test.
aAccuracy	increase the item bounding box by this amount.

Returns: true if some edge was found to be closer to refPos than aClearance.

Definition at line 450 of file zone.cpp.

 {
  SHAPE_POLY_SET::VERTEX_INDEX dummy;
  return HitTestForEdge( refPos, aAccuracy, dummy );
 }

References dummy(), and HitTestForEdge().

◆ InitDataFromSrcInCopyCtor()

void ZONE::InitDataFromSrcInCopyCtor ( const ZONE & aZone )

Copy aZone data to me.

Definition at line 111 of file zone.cpp.

 {
  // members are expected non initialize in this.
  // InitDataFromSrcInCopyCtor() is expected to be called
  // only from a copy constructor.
 
  // Copy only useful EDA_ITEM flags:
  m_flags = aZone.m_flags;
  m_forceVisible = aZone.m_forceVisible;
 
  // Replace the outlines for aZone outlines.
  delete m_Poly;
  m_Poly = new SHAPE_POLY_SET( *aZone.m_Poly );
 
  m_cornerSmoothingType = aZone.m_cornerSmoothingType;
  m_cornerRadius = aZone.m_cornerRadius;
  m_zoneName = aZone.m_zoneName;
  m_priority = aZone.m_priority;
  m_isRuleArea = aZone.m_isRuleArea;
  SetLayerSet( aZone.GetLayerSet() );
 
  m_doNotAllowCopperPour = aZone.m_doNotAllowCopperPour;
  m_doNotAllowVias = aZone.m_doNotAllowVias;
  m_doNotAllowTracks = aZone.m_doNotAllowTracks;
  m_doNotAllowPads = aZone.m_doNotAllowPads;
  m_doNotAllowFootprints = aZone.m_doNotAllowFootprints;
 
  m_PadConnection = aZone.m_PadConnection;
  m_ZoneClearance = aZone.m_ZoneClearance; // clearance value
  m_ZoneMinThickness = aZone.m_ZoneMinThickness;
  m_fillVersion = aZone.m_fillVersion;
  m_islandRemovalMode = aZone.m_islandRemovalMode;
  m_minIslandArea = aZone.m_minIslandArea;
 
  m_isFilled = aZone.m_isFilled;
  m_needRefill = aZone.m_needRefill;
 
  m_thermalReliefGap = aZone.m_thermalReliefGap;
  m_thermalReliefSpokeWidth = aZone.m_thermalReliefSpokeWidth;
 
  m_fillMode = aZone.m_fillMode; // solid vs. hatched
  m_hatchThickness = aZone.m_hatchThickness;
  m_hatchGap = aZone.m_hatchGap;
  m_hatchOrientation = aZone.m_hatchOrientation;
  m_hatchSmoothingLevel = aZone.m_hatchSmoothingLevel;
  m_hatchSmoothingValue = aZone.m_hatchSmoothingValue;
  m_hatchBorderAlgorithm = aZone.m_hatchBorderAlgorithm;
  m_hatchHoleMinArea = aZone.m_hatchHoleMinArea;
 
  // For corner moving, corner index to drag, or nullptr if no selection
  delete m_CornerSelection;
  m_CornerSelection = nullptr;
 
  for( PCB_LAYER_ID layer : aZone.GetLayerSet().Seq() )
  {
  m_FilledPolysList[layer] = aZone.m_FilledPolysList.at( layer );
  m_RawPolysList[layer] = aZone.m_RawPolysList.at( layer );
  m_filledPolysHash[layer] = aZone.m_filledPolysHash.at( layer );
  m_FillSegmList[layer] = aZone.m_FillSegmList.at( layer ); // vector <> copy
  m_insulatedIslands[layer] = aZone.m_insulatedIslands.at( layer );
  }
 
  m_borderStyle = aZone.m_borderStyle;
  m_borderHatchPitch = aZone.m_borderHatchPitch;
  m_borderHatchLines = aZone.m_borderHatchLines;
 
  SetLocalFlags( aZone.GetLocalFlags() );
 
  m_netinfo = aZone.m_netinfo;
 
  m_hv45 = aZone.m_hv45;
  m_area = aZone.m_area;
 }

References GetLayerSet(), GetLocalFlags(), m_area, m_borderHatchLines, m_borderHatchPitch, m_borderStyle, m_cornerRadius, m_CornerSelection, m_cornerSmoothingType, m_doNotAllowCopperPour, m_doNotAllowFootprints, m_doNotAllowPads, m_doNotAllowTracks, m_doNotAllowVias, m_filledPolysHash, m_FilledPolysList, m_fillMode, m_FillSegmList, m_fillVersion, EDA_ITEM::m_flags, EDA_ITEM::m_forceVisible, m_hatchBorderAlgorithm, m_hatchGap, m_hatchHoleMinArea, m_hatchOrientation, m_hatchSmoothingLevel, m_hatchSmoothingValue, m_hatchThickness, m_hv45, m_insulatedIslands, m_isFilled, m_islandRemovalMode, m_isRuleArea, m_minIslandArea, m_needRefill, BOARD_CONNECTED_ITEM::m_netinfo, m_PadConnection, m_Poly, m_priority, m_RawPolysList, m_thermalReliefGap, m_thermalReliefSpokeWidth, m_ZoneClearance, m_ZoneMinThickness, m_zoneName, LSET::Seq(), SetLayerSet(), and SetLocalFlags().

Referenced by FP_ZONE::FP_ZONE(), operator=(), CLIPBOARD_IO::SaveSelection(), and ZONE().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & BRIGHTENED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ IsConnected()

bool ZONE::IsConnected ( ) const

inlineoverridevirtual

Not all ZONEs are really BOARD_CONNECTED_ITEMs....

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 82 of file zone.h.

  {
  return !GetIsRuleArea();
  }

References GetIsRuleArea().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & ENTERED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFilled()

bool ZONE::IsFilled ( ) const

inline

Definition at line 234 of file zone.h.

234 { return m_isFilled; }

ZONE::m_isFilled

bool m_isFilled

True when a zone was filled, false after deleting the filled areas.

Definition: zone.h:865

References m_isFilled.

Referenced by calcIsInsideArea(), PCB_EDIT_FRAME::Edit_Zone_Params(), and PCB_PLUGIN::format().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

205 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:479

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsIsland()

bool ZONE::IsIsland	(	PCB_LAYER_ID	aLayer,
		int	aPolyIdx
	)		const

Check if a given filled polygon is an insulated island.

Parameters

aLayer	is the layer to test
aPolyIdx	is an index into m_FilledPolysList[aLayer]

Returns: true if the given polygon is insulated (i.e. has no net connection)

Definition at line 1137 of file zone.cpp.

 {
  if( GetNetCode() < 1 )
  return true;
 
  if( !m_insulatedIslands.count( aLayer ) )
  return false;
 
  return m_insulatedIslands.at( aLayer ).count( aPolyIdx );
 }

References BOARD_CONNECTED_ITEM::GetNetCode(), and m_insulatedIslands.

Referenced by PCB_PLUGIN::format().

◆ IsKeepout()

bool ZONE::IsKeepout ( ) const

Definition at line 1326 of file zone.cpp.

 {
  return m_doNotAllowCopperPour || m_doNotAllowVias || m_doNotAllowTracks || m_doNotAllowPads ||
  m_doNotAllowFootprints;
 }

References m_doNotAllowCopperPour, m_doNotAllowFootprints, m_doNotAllowPads, m_doNotAllowTracks, and m_doNotAllowVias.

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Returns: true if the object is locked, else false.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 64 of file board_item.cpp.

 {
  if( GetParentGroup() )
  return GetParentGroup()->IsLocked();
 
  const BOARD* board = GetBoard();
 
  return board && board->GetBoardUse() != BOARD_USE::FPHOLDER && GetState( LOCKED );
 }

References FPHOLDER, BOARD_ITEM::GetBoard(), BOARD::GetBoardUse(), BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetState(), BOARD_ITEM::IsLocked(), and LOCKED.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PCB_CONTROL::DeleteItemCursor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_PLUGIN::format(), PCB_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), PAD::IsLocked(), BOARD_ITEM::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), POSITION_RELATIVE_TOOL::PositionRelative(), processTextItem(), PCB_SELECTION_TOOL::RequestSelection(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

117 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_MOVING; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_SHAPE::CalcArcAngles(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ConvertDeMorgan(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsOnCopperLayer()

bool ZONE::IsOnCopperLayer ( ) const

overridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 228 of file zone.cpp.

 {
  return ( m_layerSet & LSET::AllCuMask() ).count() > 0;
 }

References LSET::AllCuMask(), and m_layerSet.

Referenced by ZONE_FILLER::fillSingleZone(), GetMsgPanelInfo(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), and BRDITEMS_PLOTTER::PlotFilledAreas().

◆ IsOnLayer()

bool ZONE::IsOnLayer ( PCB_LAYER_ID aLayer ) const

overridevirtual

Test to see if this object is on the given layer.

Virtual so objects like PAD, which reside on multiple layers can do their own form of testing.

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 320 of file zone.cpp.

 {
  return m_layerSet.test( aLayer );
 }

References m_layerSet.

Referenced by KIGFX::PCB_PAINTER::draw(), DSN::SPECCTRA_DB::FromBOARD(), BOARD_INSPECTION_TOOL::InspectClearance(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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_SYMBOL, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 402 of file eda_item.h.

402 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSame()

bool ZONE::IsSame ( const ZONE & aZoneToCompare )

Test if 2 zones are equivalent.

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.

Zones are equivalent if they have same parameters and same outline info.

Note: Filling is not taken into account.

Parameters

aZoneToCompare	is the zone to compare with "this"
aZoneToCompare	= zone to compare with "this"

Definition at line 60 of file zones_functions_for_undo_redo.cpp.

 {
  // compare basic parameters:
  if( GetLayerSet() != aZoneToCompare.GetLayerSet() )
  return false;
 
  if( GetNetCode() != aZoneToCompare.GetNetCode() )
  return false;
 
  if( GetPriority() != aZoneToCompare.GetPriority() )
  return false;
 
  // Compare zone specific parameters
  if( GetIsRuleArea() != aZoneToCompare.GetIsRuleArea() )
  return false;
 
  if( GetIsRuleArea() )
  {
  if( GetDoNotAllowCopperPour() != aZoneToCompare.GetDoNotAllowCopperPour() )
  return false;
 
  if( GetDoNotAllowVias() != aZoneToCompare.GetDoNotAllowVias() )
  return false;
 
  if( GetDoNotAllowTracks() != aZoneToCompare.GetDoNotAllowTracks() )
  return false;
 
  if( GetDoNotAllowPads() != aZoneToCompare.GetDoNotAllowPads() )
  return false;
 
  if( GetDoNotAllowFootprints() != aZoneToCompare.GetDoNotAllowFootprints() )
  return false;
  }
 
  if( m_ZoneClearance != aZoneToCompare.m_ZoneClearance )
  return false;
 
  if( m_ZoneMinThickness != aZoneToCompare.GetMinThickness() )
  return false;
 
  if( m_fillMode != aZoneToCompare.GetFillMode() )
  return false;
 
  if( m_PadConnection != aZoneToCompare.m_PadConnection )
  return false;
 
  if( m_thermalReliefGap != aZoneToCompare.m_thermalReliefGap )
  return false;
 
  if( m_thermalReliefSpokeWidth != aZoneToCompare.m_thermalReliefSpokeWidth )
  return false;
 
  if( m_zoneName != aZoneToCompare.m_zoneName )
  return false;
 
  if( m_islandRemovalMode != aZoneToCompare.m_islandRemovalMode )
  return false;
 
  if( m_minIslandArea != aZoneToCompare.m_minIslandArea )
  return false;
 
 
  // Compare outlines
  wxASSERT( m_Poly ); // m_Poly == NULL Should never happen
  wxASSERT( aZoneToCompare.Outline() );
 
  if( Outline() != aZoneToCompare.Outline() ) // Compare vector
  return false;
 
  return true;
 }

References GetDoNotAllowCopperPour(), GetDoNotAllowFootprints(), GetDoNotAllowPads(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetFillMode(), GetIsRuleArea(), GetLayerSet(), GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), GetPriority(), m_fillMode, m_islandRemovalMode, m_minIslandArea, m_PadConnection, m_Poly, m_thermalReliefGap, m_thermalReliefSpokeWidth, m_ZoneClearance, m_ZoneMinThickness, m_zoneName, and Outline().

Referenced by UpdateCopyOfZonesList().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & SELECTED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

Test to see if this object is a track or via (or microvia).

Returns: true if a track or via, else false.

Definition at line 210 of file board_item.h.

  {
  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
  }

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

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T aScanTypes[] ) const

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 182 of file eda_item.h.

  {
  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
  return true;
 
  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
  {
  if( m_structType == *p )
  return true;
  }
 
  return false;
  }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ Iterate()

SHAPE_POLY_SET::ITERATOR ZONE::Iterate ( )

inline

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

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

Definition at line 533 of file zone.h.

  {
  return m_Poly->Iterate();
  }

References SHAPE_POLY_SET::Iterate(), and m_Poly.

◆ IterateForward() [1/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward	(	std::deque< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const KICAD_T	scanTypes[]
	)

inlinestaticinherited

This changes first parameter to avoid the DList and use the main queue instead.

Definition at line 294 of file eda_item.h.

  {
  for( auto it : aList )
  {
  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
  == SEARCH_RESULT::QUIT )
  return SEARCH_RESULT::QUIT;
  }
 
  return SEARCH_RESULT::CONTINUE;
  }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward	(	std::vector< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const KICAD_T	scanTypes[]
	)

inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 313 of file eda_item.h.

  {
  for( auto it : aList )
  {
  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
  == SEARCH_RESULT::QUIT )
  return SEARCH_RESULT::QUIT;
  }
 
  return SEARCH_RESULT::CONTINUE;
  }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ IterateWithHoles()

SHAPE_POLY_SET::ITERATOR ZONE::IterateWithHoles ( )

inline

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

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

Definition at line 543 of file zone.h.

  {
  return m_Poly->IterateWithHoles();
  }

References SHAPE_POLY_SET::IterateWithHoles(), and m_Poly.

Referenced by DSN::SPECCTRA_DB::FromBOARD(), and DSN::SPECCTRA_DB::makeIMAGE().

◆ KeepoutAll()

bool ZONE::KeepoutAll ( ) const

Definition at line 1333 of file zone.cpp.

 {
  return m_doNotAllowCopperPour && m_doNotAllowVias && m_doNotAllowTracks && m_doNotAllowPads &&
  m_doNotAllowFootprints;
 }

References m_doNotAllowCopperPour, m_doNotAllowFootprints, m_doNotAllowPads, m_doNotAllowTracks, and m_doNotAllowVias.

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

Return a string (to be shown to the user) describing a layer mask.

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 87 of file board_item.cpp.

 {
  const BOARD* board = GetBoard();
  LSET layers = GetLayerSet();
 
  // Try to be smart and useful. Check all copper first.
  if( layers[F_Cu] && layers[B_Cu] )
  return _( "all copper layers" );
 
  LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
  LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
 
  for( LSET testLayers : { copperLayers, techLayers, layers } )
  {
  for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
  {
  if( testLayers[ bit ] )
  {
  wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
 
  if( testLayers.count() > 1 )
  layerInfo << wxS( " " ) + _( "and others" );
 
  return layerInfo;
  }
  }
  }
 
  // No copper, no technicals: no layer
  return _( "no layers" );
 }

References _, LSET::AllCuMask(), LSET::AllTechMask(), B_Cu, F_Cu, BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_LAYER_ID_COUNT, and PCBNEW_LAYER_ID_START.

Referenced by PCB_TRACK::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::GetSelectMenuText().

◆ Matches() [1/2]

bool ZONE::Matches	(	const wxFindReplaceData &	aSearchData,
		void *	aAuxData
	)		const

inlineoverridevirtual

Compare 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

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns: True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 132 of file zone.h.

  {
  return BOARD_ITEM::Matches( GetZoneName(), aSearchData );
  }

References GetZoneName(), and EDA_ITEM::Matches().

Referenced by DIALOG_FIND::search().

◆ Matches() [2/2]

bool EDA_ITEM::Matches	(	const wxString &	aText,
		const wxFindReplaceData &	aSearchData
	)		const

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
 
  // Don't match if searching for replaceable item and the item doesn't support text replace.
  if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
  return false;
 
  if( !( flags & wxFR_MATCHCASE ) )
  {
  text.MakeUpper();
  searchText.MakeUpper();
  }
 
  if( flags & wxFR_WHOLEWORD )
  {
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  return false;
 
  ii = next;
  next += searchText.length();
 
  bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
  if( startOK && endOK )
  return true;
  else
  ii++;
  }
 
  return false;
  }
  else if( flags & FR_MATCH_WILDCARD )
  {
  return text.Matches( searchText );
  }
  else
  {
  return text.Find( searchText ) != wxNOT_FOUND;
  }
 }

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

◆ Mirror()

void ZONE::Mirror	(	const wxPoint &	aMirrorRef,
		bool	aMirrorLeftRight
	)

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

Parameters

aMirrorRef	is axis position
aMirrorLeftRight	mirror across Y axis (otherwise mirror across X)

Definition at line 759 of file zone.cpp.

 {
  // ZONEs mirror about the x-axis (why?!?)
  m_Poly->Mirror( aMirrorLeftRight, !aMirrorLeftRight, VECTOR2I( aMirrorRef ) );
 
  HatchBorder();
 
  for( std::pair<const PCB_LAYER_ID, SHAPE_POLY_SET>& pair : m_FilledPolysList )
  pair.second.Mirror( aMirrorLeftRight, !aMirrorLeftRight, VECTOR2I( aMirrorRef ) );
 
  for( std::pair<const PCB_LAYER_ID, std::vector<SEG> >& pair : m_FillSegmList )
  {
  for( SEG& seg : pair.second )
  {
  if( aMirrorLeftRight )
  {
  MIRROR( seg.A.x, aMirrorRef.x );
  MIRROR( seg.B.x, aMirrorRef.x );
  }
  else
  {
  MIRROR( seg.A.y, aMirrorRef.y );
  MIRROR( seg.B.y, aMirrorRef.y );
  }
  }
  }
 }

References SEG::A, SEG::B, HatchBorder(), m_FilledPolysList, m_FillSegmList, m_Poly, MIRROR(), SHAPE_POLY_SET::Mirror(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Flip(), and EDIT_TOOL::Mirror().

◆ Move() [1/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 243 of file board_item.h.

  {
  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
  }

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

◆ Move() [2/2]

void ZONE::Move ( const wxPoint & offset )

overridevirtual

Move the outlines.

Parameters

offset is moving vector

Reimplemented from BOARD_ITEM.

Definition at line 685 of file zone.cpp.

 {
  /* move outlines */
  m_Poly->Move( offset );
 
  HatchBorder();
 
  for( std::pair<const PCB_LAYER_ID, SHAPE_POLY_SET>& pair : m_FilledPolysList )
  pair.second.Move( offset );
 
  for( std::pair<const PCB_LAYER_ID, std::vector<SEG> >& pair : m_FillSegmList )
  {
  for( SEG& seg : pair.second )
  {
  seg.A += VECTOR2I( offset );
  seg.B += VECTOR2I( offset );
  }
  }
 }

References SEG::A, SEG::B, HatchBorder(), m_FilledPolysList, m_FillSegmList, m_Poly, and SHAPE_POLY_SET::Move().

◆ MoveEdge()

void ZONE::MoveEdge	(	const wxPoint &	offset,
		int	aEdge
	)

Move the outline Edge.

Parameters

offset	is moving vector
aEdge	is start point of the outline edge

Definition at line 706 of file zone.cpp.

 {
  int next_corner;
 
  if( m_Poly->GetNeighbourIndexes( aEdge, nullptr, &next_corner ) )
  {
  m_Poly->SetVertex( aEdge, m_Poly->CVertex( aEdge ) + VECTOR2I( offset ) );
  m_Poly->SetVertex( next_corner, m_Poly->CVertex( next_corner ) + VECTOR2I( offset ) );
  HatchBorder();
 
  SetNeedRefill( true );
  }
 }

References SHAPE_POLY_SET::CVertex(), SHAPE_POLY_SET::GetNeighbourIndexes(), HatchBorder(), m_Poly, SetNeedRefill(), and SHAPE_POLY_SET::SetVertex().

◆ NeedRefill()

bool ZONE::NeedRefill ( ) const

inline

Definition at line 237 of file zone.h.

237 { return m_needRefill; }

ZONE::m_needRefill

bool m_needRefill

False when a zone was refilled, true after changes in zone params.

Definition: zone.h:872

References m_needRefill.

◆ NewHole()

void ZONE::NewHole ( )

inline

Create a new hole on the zone; i.e., a new contour on the zone's outline.

Definition at line 597 of file zone.h.

  {
  m_Poly->NewHole();
  }

References m_Poly, and SHAPE_POLY_SET::NewHole().

Referenced by EAGLE_PLUGIN::loadPlain(), and EAGLE_PLUGIN::packageCircle().

◆ operator<()

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 234 of file eda_item.cpp.

 {
  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
  GetClass() ) );
 
  return false;
 }

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

◆ operator=()

ZONE & ZONE::operator= ( const ZONE & aOther )

Definition at line 94 of file zone.cpp.

 {
  BOARD_CONNECTED_ITEM::operator=( aOther );
 
  InitDataFromSrcInCopyCtor( aOther );
 
  return *this;
 }

References InitDataFromSrcInCopyCtor(), and EDA_ITEM::operator=().

Referenced by FP_ZONE::operator=().

◆ Outline() [1/2]

SHAPE_POLY_SET* ZONE::Outline ( )

inline

Definition at line 320 of file zone.h.

320 { return m_Poly; }

ZONE::m_Poly

SHAPE_POLY_SET * m_Poly

Outline of the zone.

Definition: zone.h:822

References m_Poly.

Referenced by PCB_POINT_EDITOR::addCorner(), ZONE_FILLER::addHatchFillTypeOnZone(), calcIsInsideArea(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), IsSame(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), PCB_POINT_EDITOR::makePoints(), BOARD::NormalizeAreaPolygon(), EAGLE_PLUGIN::packagePolygon(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), ALTIUM_PCB::ParseTracks6Data(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_POINT_EDITOR::removeCorner(), PNS_KICAD_IFACE_BASE::syncZone(), BOARD::TestZoneIntersection(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

◆ Outline() [2/2]

const SHAPE_POLY_SET* ZONE::Outline ( ) const

inline

Definition at line 321 of file zone.h.

321 { return m_Poly; }

ZONE::m_Poly

SHAPE_POLY_SET * m_Poly

Outline of the zone.

Definition: zone.h:822

References m_Poly.

◆ RawPolysList()

SHAPE_POLY_SET& ZONE::RawPolysList ( PCB_LAYER_ID aLayer )

inline

Definition at line 718 of file zone.h.

  {
  wxASSERT( m_RawPolysList.count( aLayer ) );
  return m_RawPolysList.at( aLayer );
  }

References m_RawPolysList.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), and ALTIUM_PCB::ParseRegions6Data().

◆ RemoveAllContours()

void ZONE::RemoveAllContours ( void )

inline

Definition at line 558 of file zone.h.

  {
  m_Poly->RemoveAllContours();
  }

References m_Poly, and SHAPE_POLY_SET::RemoveAllContours().

◆ RemoveCutout()

void ZONE::RemoveCutout	(	int	aOutlineIdx,
		int	aHoleIdx
	)

Remove a cutout from the zone.

Parameters

aOutlineIdx	is the zone outline the hole belongs to
aHoleIdx	is the hole in the outline to remove

Definition at line 804 of file zone.cpp.

 {
  // Ensure the requested cutout is valid
  if( m_Poly->OutlineCount() < aOutlineIdx || m_Poly->HoleCount( aOutlineIdx ) < aHoleIdx )
  return;
 
  SHAPE_POLY_SET cutPoly( m_Poly->Hole( aOutlineIdx, aHoleIdx ) );
 
  // Add the cutout back to the zone
  m_Poly->BooleanAdd( cutPoly, SHAPE_POLY_SET::PM_FAST );
 
  SetNeedRefill( true );
 }

References SHAPE_POLY_SET::BooleanAdd(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), m_Poly, SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, and SetNeedRefill().

Referenced by EDIT_TOOL::Remove().

◆ Replace() [1/2]

bool EDA_ITEM::Replace	(	const wxFindReplaceData &	aSearchData,
		wxString &	aText
	)

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
  wxString result;
  bool replaced = false;
 
  if( flags & wxFR_MATCHCASE )
  {
  text = text.Upper();
  searchText = searchText.Upper();
  }
 
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  {
  result += aText.Mid( ii, wxString::npos );
  break;
  }
 
  if( next > ii )
  result += aText.Mid( ii, next - ii );
 
  ii = next;
  next += searchText.length();
 
  bool startOK;
  bool endOK;
 
  if( flags & wxFR_WHOLEWORD )
  {
  startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
  }
  else
  {
  startOK = true;
  endOK = true;
  }
 
  if( startOK && endOK )
  {
  result += aSearchData.GetReplaceString();
  replaced = true;
  ii = next;
  }
  else
  {
  result += aText.GetChar( ii );
  ii++;
  }
  }
 
  aText = result;
  return replaced;
 }

References next(), and text.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace	(	const wxFindReplaceData &	aSearchData,
		void *	aAuxData = `nullptr`
	)

inlinevirtualinherited

Perform 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

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A 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_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

  {
  return false;
  }

◆ Rotate() [1/2]

void BOARD_ITEM::Rotate	(	const VECTOR2I &	aRotCentre,
		double	aAngle
	)

inlineinherited

Definition at line 256 of file board_item.h.

  {
  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
  }

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

◆ Rotate() [2/2]

void ZONE::Rotate	(	const wxPoint &	aCentre,
		double	aAngle
	)

overridevirtual

Move the outlines.

Parameters

aCentre	is rot centre
aAngle	is in 0.1 degree

Reimplemented from BOARD_ITEM.

Definition at line 721 of file zone.cpp.

 {
  aAngle = -DECIDEG2RAD( aAngle );
 
  m_Poly->Rotate( aAngle, VECTOR2I( aCentre ) );
  HatchBorder();
 
  /* rotate filled areas: */
  for( std::pair<const PCB_LAYER_ID, SHAPE_POLY_SET>& pair : m_FilledPolysList )
  pair.second.Rotate( aAngle, VECTOR2I( aCentre ) );
 
  for( std::pair<const PCB_LAYER_ID, std::vector<SEG> >& pair : m_FillSegmList )
  {
  for( SEG& seg : pair.second )
  {
  wxPoint a( seg.A );
  RotatePoint( &a, aCentre, aAngle );
  seg.A = a;
  wxPoint b( seg.B );
  RotatePoint( &b, aCentre, aAngle );
  seg.B = a;
  }
  }
 }

References SEG::A, SEG::B, DECIDEG2RAD(), HatchBorder(), m_FilledPolysList, m_FillSegmList, m_Poly, SHAPE_POLY_SET::Rotate(), and RotatePoint().

Referenced by EAGLE_PLUGIN::loadPlain(), DSN::SPECCTRA_DB::makeIMAGE(), EAGLE_PLUGIN::packageRectangle(), and ALTIUM_PCB::ParseFills6Data().

◆ Set() [1/3]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxAny &	aValue
	)

inlineinherited

Definition at line 42 of file inspectable.h.

  {
  PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 
  if( object )
  aProperty->setter( object, aValue );
 
  return object != nullptr;
  }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 55 of file inspectable.h.

  {
  PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 
  if( object )
  aProperty->set<T>( object, aValue );
 
  return object != nullptr;
  }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 68 of file inspectable.h.

  {
  PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
  void* object = nullptr;
 
  if( prop )
  {
  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
  if( object )
  prop->set<T>( object, aValue );
  }
 
  return object != nullptr;
  }

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ SetBorderDisplayStyle()

void ZONE::SetBorderDisplayStyle	(	ZONE_BORDER_DISPLAY_STYLE	aHatchStyle,
		int	aHatchPitch,
		bool	aRebuildHatch
	)

Set all hatch parameters for the zone.

Parameters

aHatchStyle	is the style of the hatch, specified as one of HATCH_STYLE possible values.
aHatchPitch	is the hatch pitch in iu.
aRebuildHatch	is a flag to indicate whether to re-hatch after having set the previous parameters.

Definition at line 910 of file zone.cpp.

 {
  SetHatchPitch( aHatchPitch );
  m_borderStyle = aHatchStyle;
 
  if( aRebuildHatch )
  HatchBorder();
 }

References HatchBorder(), m_borderStyle, and SetHatchPitch().

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), and ALTIUM_PCB::ParseTracks6Data().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetCornerPosition()

void ZONE::SetCornerPosition	(	int	aCornerIndex,
		const wxPoint &	new_pos
	)

inline

Definition at line 574 of file zone.h.

  {
  SHAPE_POLY_SET::VERTEX_INDEX relativeIndices;
 
  // Convert global to relative indices
  if( m_Poly->GetRelativeIndices( aCornerIndex, &relativeIndices ) )
  {
  if( m_Poly->CVertex( relativeIndices ).x != new_pos.x
  || m_Poly->CVertex( relativeIndices ).y != new_pos.y )
  {
  SetNeedRefill( true );
  m_Poly->SetVertex( relativeIndices, new_pos );
  }
  }
  else
  {
  throw( std::out_of_range( "aCornerIndex-th vertex does not exist" ) );
  }
  }

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZONE() [1/2]

◆ ZONE() [2/2]

◆ ~ZONE()

Member Function Documentation

◆ AddPolygon() [1/2]

◆ AddPolygon() [2/2]

◆ AppendCorner()

◆ BuildHashValue()

◆ BuildSmoothedPoly()

◆ CacheBoundingBox()

◆ CacheTriangulation()

◆ CalculateFilledArea()

◆ CIterateWithHoles()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ CommonLayerExists()

◆ DeleteStructure()

◆ Duplicate()

◆ FillSegments() [1/2]

◆ FillSegments() [2/2]

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBorderHatchPitch()

◆ GetBoundingBox()

◆ GetCachedBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetCornerPosition()

◆ GetCornerRadius()

◆ GetCornerSmoothingType()

◆ GetDefaultHatchPitch()

◆ GetDoNotAllowCopperPour()

◆ GetDoNotAllowFootprints()

◆ GetDoNotAllowPads()

◆ GetDoNotAllowTracks()

◆ GetDoNotAllowVias()

◆ GetEditFlags()

◆ GetEffectiveNetclass()

◆ GetEffectiveShape()

◆ GetFilledArea()

◆ GetFilledPolysList()

◆ GetFilledPolysUseThickness() [1/2]

◆ GetFilledPolysUseThickness() [2/2]

◆ GetFillFlag()

◆ GetFillMode()

◆ GetFillVersion()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetHashValue()

◆ GetHatchBorderAlgorithm()

◆ GetHatchGap()

◆ GetHatchHoleMinArea()

◆ GetHatchLines()

◆ GetHatchOrientation()

◆ GetHatchSmoothingLevel()

◆ GetHatchSmoothingValue()

◆ GetHatchStyle()

◆ GetHatchThickness()

◆ GetHV45()

◆ GetInteractingZones()

◆ GetIslandRemovalMode()