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

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

bool	IsConflicting () const
	For rule areas which exclude footprints (and therefore participate in courtyard conflicts during move). More...

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPos) override

void	SetAssignedPriority (unsigned aPriority)

unsigned	GetAssignedPriority () const

bool	HigherPriority (const ZONE *aOther) const

bool	SameNet (const ZONE *aOther) 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...

wxString	GetFriendlyName () const override

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 EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
	Compare the item against the search criteria in aSearchData. More...

const BOX2I	GetBoundingBox () const override

void	CacheBoundingBox ()
	Used to preload the zone bounding box cache so we don't have to worry about mutex-locking it each time. More...

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

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

PCB_LAYER_ID	GetFirstLayer () const

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

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

double	CalculateOutlineArea ()
	Compute the area of the zone outline (not the filled area). More...

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

double	GetOutlineArea ()
	This area is cached from the most recent call to CalculateOutlineArea(). 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 () 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)

EDA_ANGLE	GetHatchOrientation () const

void	SetHatchOrientation (const EDA_ANGLE &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)

int	GetLocalFlags () const

void	SetLocalFlags (int aFlags)

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, FLASHING aFlash=FLASHING::DEFAULT) const override
	Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...

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

bool	HitTestFilledArea (PCB_LAYER_ID aLayer, const VECTOR2I &aRefPos, int aAccuracy=0) const
	Test if the given VECTOR2I is within the bounds of a filled area of this zone. 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...

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

void	TransformSolidAreasShapesToPolygon (PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aBuffer) const
	Convert solid areas full shapes to polygon set (the full shape is the polygon area with a thick outline) Used in 3D view Arcs (ends of segments) are approximated by segments. More...

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

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

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

bool	HitTest (const BOX2I &aRect, bool aContained=true, int aAccuracy=0) const override
	Test if aRect intersects this item. More...

bool	UnFill ()
	Removes the zone filling. More...

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

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

void	Rotate (const VECTOR2I &aCentre, const EDA_ANGLE &aAngle) override
	Rotate the outlines. More...

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

void	Mirror (const VECTOR2I &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 VECTOR2I &new_pos)

void	NewHole ()
	Create a new hole on the zone; i.e., a new contour on the zone's outline. More...

bool	AppendCorner (VECTOR2I 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 std::shared_ptr< SHAPE_POLY_SET > &	GetFilledPolysList (PCB_LAYER_ID aLayer) const

SHAPE_POLY_SET *	GetFill (PCB_LAYER_ID aLayer)

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

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

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

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

void	AddPolygon (const SHAPE_LINE_CHAIN &aPolygon)

wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider) const override
	Return a user-visible description string of this item. 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	IsTeardropArea () const

void	SetTeardropAreaType (TEARDROP_TYPE aType)
	Set the type of teardrop if the zone is a teardrop area for non teardrop area, the type must be TEARDROP_TYPE::TD_NONE. More...

TEARDROP_TYPE	GetTeardropAreaType () const

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

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 aBorderHatchStyle, int aBorderHatchPitch, bool aRebuilBorderdHatch)
	Set all hatch parameters for the zone. More...

void	SetBorderHatchPitch (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

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)

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

wxString	GetUnescapedShortNetname () 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. More...

wxString	GetNetClassName () const
	Returns the name of the effective netclass. More...

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

virtual bool	HasHole () const

virtual bool	IsTented () const

virtual std::shared_ptr< SHAPE_SEGMENT >	GetEffectiveHoleShape () const

BOARD_ITEM_CONTAINER *	GetParent () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

virtual bool	HasLineStroke () const
	Check if this item has line stoke properties. More...

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

void	SwapItemData (BOARD_ITEM *aImage)
	Swap data between aItem and aImage. More...

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

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

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	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

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	XorFlags (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	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

virtual bool	IsType (const std::vector< 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 VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...

virtual INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

wxString	GetTypeDesc () const
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...

virtual bool	Replace (const EDA_SEARCH_DATA &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) const

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

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

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

static int	GetDefaultHatchPitch ()

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

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

static bool	Replace (const EDA_SEARCH_DATA &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 VECTOR2I	ZeroOffset
	A value of wxPoint(0,0) which can be passed to the Draw() functions. More...

Protected Member Functions
virtual void	swapData (BOARD_ITEM *aImage) override

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

bool	Matches (const wxString &aText, const EDA_SEARCH_DATA &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

TEARDROP_TYPE	m_teardropType

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

EDA_ANGLE	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::shared_ptr< SHAPE_POLY_SET > >	m_FilledPolysList

LSET	m_fillFlags
	Temp variables used while filling. More...

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

double	m_area

double	m_outlinearea

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

bool	m_isKnockout

bool	m_isLocked

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

Private Attributes
bool	m_localRatsnestVisible

KICAD_T	m_structType
	Run time identification, keep private so it can never be changed after a ctor sets it. More...

VIEW_ITEM_DATA *	m_viewPrivData

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

 :
 BOARD_CONNECTED_ITEM( aParent, aInFP ? PCB_FP_ZONE_T : PCB_ZONE_T ),
 m_area( 0.0 ),
 m_outlinearea( 0.0 )
{
 m_Poly = new SHAPE_POLY_SET(); // Outlines
 m_cornerSmoothingType = ZONE_SETTINGS::SMOOTHING_NONE;
 m_cornerRadius = 0;
 m_zoneName = wxEmptyString;
 m_CornerSelection = nullptr; // no corner is selected
 m_isFilled = false; // fill status : true when the zone is filled
 m_teardropType = TEARDROP_TYPE::TD_NONE;
 m_islandRemovalMode = ISLAND_REMOVAL_MODE::ALWAYS;
 m_borderStyle = ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE;
 m_borderHatchPitch = GetDefaultHatchPitch();
 m_priority = 0;
 SetIsRuleArea( aInFP ); // Zones living in footprints have the rule area option
 SetLocalFlags( 0 ); // flags temporary used in zone calculations
 m_fillVersion = 5; // set the "old" way to build filled polygon areas (< 6.0.x)
 
 m_ZoneMinThickness = EDA_UNIT_UTILS::Mils2IU( pcbIUScale, ZONE_THICKNESS_MIL );
 m_thermalReliefSpokeWidth = EDA_UNIT_UTILS::Mils2IU( pcbIUScale, ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL );
 m_thermalReliefGap = EDA_UNIT_UTILS::Mils2IU( pcbIUScale, ZONE_THERMAL_RELIEF_GAP_MIL );
 
 aParent->GetZoneSettings().ExportSetting( *this );
 
 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_fillVersion, m_isFilled, m_islandRemovalMode, m_needRefill, m_Poly, m_priority, m_teardropType, m_thermalReliefGap, m_thermalReliefSpokeWidth, m_ZoneMinThickness, m_zoneName, EDA_UNIT_UTILS::Mils2IU(), pcbIUScale, SetIsRuleArea(), SetLocalFlags(), ZONE_SETTINGS::SMOOTHING_NONE, TD_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 73 of file zone.cpp.

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

References InitDataFromSrcInCopyCtor().

◆ ~ZONE()

ZONE::~ZONE ( )

Definition at line 92 of file zone.cpp.

{
 delete m_Poly;
 delete m_CornerSelection;
 
 if( BOARD* board = GetBoard() )
 board->IncrementTimeStamp();
}

References BOARD_ITEM::GetBoard(), m_CornerSelection, and m_Poly.

Member Function Documentation

◆ AddPolygon() [1/2]

void ZONE::AddPolygon ( const SHAPE_LINE_CHAIN & aPolygon )

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

◆ AddPolygon() [2/2]

void ZONE::AddPolygon ( std::vector< VECTOR2I > & 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 743 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 VECTOR2I& pt : aPolygon )
 outline.Append( pt );
 
 outline.SetClosed( true );
 
 AddPolygon( outline );
}

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

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

◆ AppendCorner()

bool ZONE::AppendCorner	(	VECTOR2I	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 760 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 it does not 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(), SetNeedRefill(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ 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 396 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.

Referenced by ZONE_FILLER::Fill().

◆ 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 1069 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 converted to segments first.
 SHAPE_POLY_SET flattened = m_Poly->CloneDropTriangulation();
 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;
 bool smooth_requested = m_cornerSmoothingType == ZONE_SETTINGS::SMOOTHING_CHAMFER
 || m_cornerSmoothingType == ZONE_SETTINGS::SMOOTHING_FILLET;
 
 if( IsTeardropArea() )
 {
 // We use teardrop shapes with no smoothing; these shapes are already optimized
 smooth_requested = false;
 }
 
 if( board )
 {
 BOARD_DESIGN_SETTINGS& bds = board->GetDesignSettings();
 
 maxError = bds.m_MaxError;
 keepExternalFillets = bds.m_ZoneKeepExternalFillets;
 }
 
 auto smooth = [&]( SHAPE_POLY_SET& aPoly )
 {
 if( !smooth_requested )
 return;
 
 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;
 }
 };
 
 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 && smooth_requested )
 {
 withFillets = flattened;
 smooth( withFillets );
 withFillets.BooleanAdd( flattened, SHAPE_POLY_SET::PM_FAST );
 maxExtents = &withFillets;
 }
 
 // We now add in the areas of any same-net, intersecting zones. This keeps us from smoothing
 // corners at an intersection (which often produces undesired divots between the intersecting
 // zones -- see #2752).
 //
 // After smoothing, we'll subtract back out everything outside of our zone.
 std::vector<ZONE*> sameNetCollidingZones;
 std::vector<ZONE*> otherNetIntersectingZones;
 GetInteractingZones( aLayer, &sameNetCollidingZones, &otherNetIntersectingZones );
 
 for( ZONE* sameNetZone : sameNetCollidingZones )
 {
 BOX2I sameNetBoundingBox = sameNetZone->GetBoundingBox();
 SHAPE_POLY_SET sameNetPoly = sameNetZone->Outline()->CloneDropTriangulation();
 
 sameNetPoly.ClearArcs();
 
 // Of course there's always a wrinkle. The same-net intersecting zone *might* get knocked
 // out along the border by a higher-priority, different-net zone. #12797
 for( ZONE* otherNetZone : otherNetIntersectingZones )
 {
 if( otherNetZone->HigherPriority( sameNetZone )
 && otherNetZone->GetBoundingBox().Intersects( sameNetBoundingBox ) )
 {
 sameNetPoly.BooleanSubtract( *otherNetZone->Outline(), SHAPE_POLY_SET::PM_FAST );
 }
 }
 
 aSmoothedPoly.BooleanAdd( sameNetPoly, SHAPE_POLY_SET::PM_FAST );
 }
 
 if( aBoardOutline )
 aSmoothedPoly.BooleanIntersection( *aBoardOutline, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
 
 smooth( aSmoothedPoly );
 
 if( aSmoothedPolyWithApron )
 {
 SHAPE_POLY_SET poly = maxExtents->CloneDropTriangulation();
 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 ARC_HIGH_DEF, SHAPE_POLY_SET::BooleanAdd(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), SHAPE_POLY_SET::ClearArcs(), SHAPE_POLY_SET::CloneDropTriangulation(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetInteractingZones(), GetIsRuleArea(), GetNumCorners(), SHAPE_POLY_SET::Inflate(), IsTeardropArea(), 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 ( )

Used to preload the zone bounding box cache so we don't have to worry about mutex-locking it each time.

Definition at line 345 of file zone.cpp.

{
 BOARD* board = GetBoard();
 std::unordered_map<const ZONE*, BOX2I>& cache = board->m_ZoneBBoxCache;
 
 auto cacheIter = cache.find( this );
 
 if( cacheIter == cache.end() )
 {
 std::unique_lock<std::mutex> cacheLock( board->m_CachesMutex );
 cache[ this ] = m_Poly->BBox();
 }
}

References SHAPE_POLY_SET::BBox(), BOARD_ITEM::GetBoard(), BOARD::m_CachesMutex, m_Poly, and BOARD::m_ZoneBBoxCache.

◆ 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 1005 of file zone.cpp.

{
 if( aLayer == UNDEFINED_LAYER )
 {
 for( auto& [ layer, poly ] : m_FilledPolysList )
 poly->CacheTriangulation();
 
 m_Poly->CacheTriangulation( false );
 }
 else
 {
 if( m_FilledPolysList.count( aLayer ) )
 m_FilledPolysList[ aLayer ]->CacheTriangulation();
 }
}

References SHAPE_POLY_SET::CacheTriangulation(), m_FilledPolysList, m_Poly, and UNDEFINED_LAYER.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), and ZONE_FILLER::Fill().

◆ CalculateFilledArea()

double ZONE::CalculateFilledArea ( )

Compute the area currently occupied by the zone fill.

Returns: the currently filled area

Definition at line 1195 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, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
 {
 std::shared_ptr<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 m_area, and m_FilledPolysList.

Referenced by TEARDROP_MANAGER::createTeardrop(), and ZONE_FILLER::Fill().

◆ CalculateOutlineArea()

double ZONE::CalculateOutlineArea ( )

Compute the area of the zone outline (not the filled area).

Returns: the currently calculated area

Definition at line 1218 of file zone.cpp.

{
 m_outlinearea = std::abs( m_Poly->Area() );
 return m_outlinearea;
}

References std::abs(), SHAPE_POLY_SET::Area(), m_outlinearea, and m_Poly.

◆ 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 520 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 119 of file eda_item.h.

119{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:141

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 158 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), 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 141 of file eda_item.h.

141{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), 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(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:47

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< T >::saveCopyInUndoList(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 153 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and 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 180 of file zone.cpp.

{
 return new ZONE( *this );
}

References ZONE().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 150 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 DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 184 of file board_item.cpp.

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

References PCB_GROUP::AddItem(), EDA_ITEM::Clone(), BOARD_ITEM::GetParentGroup(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FOOTPRINT::Duplicate(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), and ARRAY_CREATOR::Invoke().

◆ Flip()

void ZONE::Flip	(	const VECTOR2I &	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 695 of file zone.cpp.

{
 Mirror( aCentre, aFlipLeftRight );
 
 SetLayerSet( FlipLayerMask( GetLayerSet(), GetBoard()->GetCopperLayerCount() ) );
}

References FlipLayerMask(), BOARD_ITEM::GetBoard(), GetLayerSet(), Mirror(), and SetLayerSet().

◆ Get() [1/3]

template<typename T >

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

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 );
 std::optional<T> ret;
 
 if( prop )
 {
 const 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().

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

◆ GetAssignedPriority()

unsigned ZONE::GetAssignedPriority ( ) const

inline

Returns: the priority level of this zone.

Definition at line 112 of file zone.h.

112{ return m_priority; }

References m_priority.

Referenced by KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), GetMsgPanelInfo(), ZONE_SEARCH_HANDLER::GetResultCell(), IsSame(), FOOTPRINT::cmp_zones::operator()(), ZONE_SETTINGS::operator<<(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), ZONE_DESC::ZONE_DESC(), BOARD_EDITOR_CONTROL::ZoneMerge(), and zonesNeedUpdate().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 43 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 BOARD_ADAPTER::addShape(), FOOTPRINT::BuildCourtyardCaches(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), BuildSmoothedPoly(), CacheBoundingBox(), collidesWithArea(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), existsOnLayerFunc(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), Flip(), PCB_PLUGIN::format(), fromToFunc(), BOARD_ITEM::GetBoard(), PCB_EXPR_CONTEXT::GetBoard(), NETINFO_ITEM::GetBoundingBox(), GetBoundingBox(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), FOOTPRINT::GetCourtyard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), getFieldFunc(), GetInteractingZones(), GetItemDescription(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_MARKER::GetSeverity(), PAD::GetSolderMaskExpansion(), PCB_VIA::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraint(), inDiffPairFunc(), ROUTER_TOOL::Init(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), BOARD_ITEM::IsLocked(), PCB_VIA::IsTented(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), PAD::MergePrimitivesAsPolygon(), Move(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), EAGLE_PLUGIN::packageWire(), padsNeedUpdate(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), BOARD_CONNECTED_ITEM::SetNetCode(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), TransformSmoothedOutlineToPolygon(), BOARD::UpdateRatsnestExclusions(), FOOTPRINT::ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLOD(), PCB_BITMAP::ViewGetLOD(), PCB_VIA::ViewGetLOD(), FOOTPRINT::~FOOTPRINT(), and ~ZONE().

◆ GetBorderHatchPitch()

int ZONE::GetBorderHatchPitch ( ) const

HatchBorder related methods.

Returns: the zone hatch pitch in iu.

Definition at line 814 of file zone.cpp.

{
 return m_borderHatchPitch;
}

References m_borderHatchPitch.

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

◆ GetBoundingBox()

const BOX2I ZONE::GetBoundingBox ( ) const

overridevirtual

Returns: the bounding box of the zone outline.

Reimplemented from EDA_ITEM.

Definition at line 323 of file zone.cpp.

{
 if( const BOARD* board = GetBoard() )
 {
 std::unordered_map<const ZONE*, BOX2I>& cache = board->m_ZoneBBoxCache;
 auto cacheIter = cache.find( this );
 
 if( cacheIter != cache.end() )
 return cacheIter->second;
 
 BOX2I bbox = m_Poly->BBox();
 
 std::unique_lock<std::mutex> cacheLock( const_cast<BOARD*>( board )->m_CachesMutex );
 cache[ this ] = bbox;
 
  return bbox;
 }
 
 return m_Poly->BBox();
}

References SHAPE_POLY_SET::BBox(), BOARD_ITEM::GetBoard(), and m_Poly.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildThermalSpokes(), collidesWithArea(), ZONE_FILLER::Fill(), ZONE_FILLER::fillNonCopperZone(), GetInteractingZones(), HitTest(), ZONE_FILLER::knockoutThermalReliefs(), ALTIUM_PCB::ParsePolygons6Data(), DRC_TEST_PROVIDER_DISALLOW::Run(), ZONE_FILLER::subtractHigherPriorityZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), and DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer().

◆ GetCenter()

virtual VECTOR2I 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 PAD, PCB_MARKER, PCB_SHAPE, and PCB_ARC.

Definition at line 93 of file board_item.h.

 {
 return GetBoundingBox().GetCenter();
 }

References EDA_ITEM::GetBoundingBox(), and BOX2< Vec >::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_SELECTION_TOOL::FindItem(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ GetClass()

wxString ZONE::GetClass ( ) const

inlineoverridevirtual

Returns: the class name.

Implements EDA_ITEM.

Definition at line 482 of file zone.h.

 {
 return wxT( "ZONE" );
 }

◆ GetCornerPosition()

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

inline

Definition at line 530 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 652 of file zone.h.

652{ return m_cornerRadius; }

References m_cornerRadius.

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

◆ GetCornerSmoothingType()

int ZONE::GetCornerSmoothingType ( ) const

inline

Definition at line 648 of file zone.h.

648{ return m_cornerSmoothingType; }

References m_cornerSmoothingType.

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

◆ GetDefaultHatchPitch()

int ZONE::GetDefaultHatchPitch ( )

static

Returns: the default hatch pitch in internal units.

Definition at line 985 of file zone.cpp.

{
 return EDA_UNIT_UTILS::Mils2IU( pcbIUScale, ZONE_BORDER_HATCH_DIST_MIL );
}

References EDA_UNIT_UTILS::Mils2IU(), pcbIUScale, and ZONE_BORDER_HATCH_DIST_MIL.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), ALTIUM_PCB::HelperPcpShapeAsBoardKeepoutRegion(), ALTIUM_PCB::HelperPcpShapeAsFootprintKeepoutRegion(), EAGLE_PLUGIN::loadPlain(), LEGACY_PLUGIN::loadZONE_CONTAINER(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), ALTIUM_PCB::ParsePolygons6Data(), PCB_PARSER::parseZONE(), and ZONE().

◆ GetDoNotAllowCopperPour()

bool ZONE::GetDoNotAllowCopperPour ( ) const

inline

Definition at line 698 of file zone.h.

698{ return m_doNotAllowCopperPour; }

ZONE::m_doNotAllowCopperPour

bool m_doNotAllowCopperPour

Definition: zone.h:818

References m_doNotAllowCopperPour.

Referenced by KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), ZONE_SETTINGS::operator<<(), DRC_TEST_PROVIDER_DISALLOW::Run(), and zonesNeedUpdate().

◆ GetDoNotAllowFootprints()

bool ZONE::GetDoNotAllowFootprints ( ) const

inline

Definition at line 702 of file zone.h.

702{ return m_doNotAllowFootprints; }

ZONE::m_doNotAllowFootprints

bool m_doNotAllowFootprints

Definition: zone.h:822

References m_doNotAllowFootprints.

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

◆ GetDoNotAllowPads()

bool ZONE::GetDoNotAllowPads ( ) const

inline

Definition at line 701 of file zone.h.

701{ return m_doNotAllowPads; }

ZONE::m_doNotAllowPads

bool m_doNotAllowPads

Definition: zone.h:821

References m_doNotAllowPads.

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

◆ GetDoNotAllowTracks()

bool ZONE::GetDoNotAllowTracks ( ) const

inline

Definition at line 700 of file zone.h.

700{ return m_doNotAllowTracks; }

ZONE::m_doNotAllowTracks

bool m_doNotAllowTracks

Definition: zone.h:820

References m_doNotAllowTracks.

Referenced by KI_TEST::CheckFpZone(), PNS::ITEM::collideSimple(), PCB_PLUGIN::format(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), ZONE_SETTINGS::operator<<(), PNS_KICAD_IFACE_BASE::syncZone(), and zonesNeedUpdate().

◆ GetDoNotAllowVias()

bool ZONE::GetDoNotAllowVias ( ) const

inline

Definition at line 699 of file zone.h.

699{ return m_doNotAllowVias; }

ZONE::m_doNotAllowVias

bool m_doNotAllowVias

Definition: zone.h:819

References m_doNotAllowVias.

Referenced by KI_TEST::CheckFpZone(), PNS::ITEM::collideSimple(), DRAWING_TOOL::DrawVia(), PCB_PLUGIN::format(), GetMsgPanelInfo(), isKeepoutZone(), IsSame(), ZONE_SETTINGS::operator<<(), and zonesNeedUpdate().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

 {
 constexpr int mask =
 ( IS_NEW | IS_PASTED | IS_MOVING | IS_BROKEN | IS_CHANGED | STRUCT_DELETED );
 
 return m_flags & mask;
 }

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectiveHoleShape()

std::shared_ptr< SHAPE_SEGMENT > BOARD_ITEM::GetEffectiveHoleShape ( ) const

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 229 of file board_item.cpp.

{
 static std::shared_ptr<SHAPE_SEGMENT> slot;
 
 UNIMPLEMENTED_FOR( GetClass() );
 
 return slot;
}

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

Referenced by collidesWithArea(), DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetEffectiveNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetClass ( ) const

virtualinherited

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.

Definition at line 97 of file board_connected_item.cpp.

{
 if( m_netinfo && m_netinfo->GetNetClass() )
 return m_netinfo->GetNetClass();
 else
 return GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass.get();
}

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

Referenced by PCB_VIA::GetDrillValue(), BOARD_INSPECTION_TOOL::getItemDescription(), PAD::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClassName(), PCB_EXPR_NETCLASS_REF::GetValue(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > ZONE::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`,
		FLASHING	aFlash = `FLASHING::DEFAULT`
	)		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.
aFlash	optional parameter allowing a caller to force the pad to be flashed (or not flashed) on the current layer (default is to honour the pad's setting and the current connections for the given layer).

Reimplemented from BOARD_ITEM.

Definition at line 1311 of file zone.cpp.

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

References m_FilledPolysList.

◆ GetFill()

SHAPE_POLY_SET * ZONE::GetFill ( PCB_LAYER_ID aLayer )

inline

Definition at line 608 of file zone.h.

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

References m_FilledPolysList.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), ZONE_FILLER::Fill(), CONNECTIVITY_DATA::IsConnectedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), and ALTIUM_PCB::ParseRegions6Data().

◆ GetFilledArea()

double ZONE::GetFilledArea ( )

inline

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

Returns: the filled area

Definition at line 215 of file zone.h.

 {
 return m_area;
 }

References m_area.

◆ GetFilledPolysList()

const std::shared_ptr< SHAPE_POLY_SET > & ZONE::GetFilledPolysList ( PCB_LAYER_ID aLayer ) const

inline

Returns: a reference to the list of filled polygons.

Definition at line 602 of file zone.h.

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

References m_FilledPolysList.

Referenced by CN_LIST::Add(), DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), 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(), ZONE_FILLER::Fill(), CN_CONNECTIVITY_ALGO::FindIsolatedCopperIslands(), PCB_PLUGIN::format(), CN_ZONE_LAYER::GetAnchor(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer().

◆ GetFillFlag()

int ZONE::GetFillFlag ( PCB_LAYER_ID aLayer )

inline

Definition at line 235 of file zone.h.

 {
 return m_fillFlags.test( aLayer );
 }

References m_fillFlags.

◆ GetFillMode()

ZONE_FILL_MODE ZONE::GetFillMode ( ) const

inline

Definition at line 174 of file zone.h.

174{ return m_fillMode; }

ZONE::m_fillMode

ZONE_FILL_MODE m_fillMode

How to fill areas:

Definition: zone.h:857

References m_fillMode.

Referenced by KI_TEST::CheckFpZone(), ZONE_FILLER::fillCopperZone(), ZONE_FILLER::fillNonCopperZone(), PCB_PLUGIN::format(), IsSame(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetFirstLayer()

PCB_LAYER_ID ZONE::GetFirstLayer ( ) const

Definition at line 245 of file zone.cpp.

{
 if( m_layerSet.size() )
 return m_layerSet.UIOrder()[0];
 else
 return UNDEFINED_LAYER;
}

References m_layerSet, LSET::UIOrder(), and UNDEFINED_LAYER.

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_PLUGIN::format(), HatchBorder(), TEARDROP_MANAGER::setTeardropPriorities(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), and TransformSmoothedOutlineToPolygon().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

142{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), BOARD_COMMIT::dirtyIntersectingZones(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), 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 VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFriendlyName()

wxString ZONE::GetFriendlyName ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 656 of file zone.cpp.

{
 if( GetIsRuleArea() )
 return _( "Rule Area" );
 else if( IsTeardropArea() )
 return _( "Teardrop Area" );
 else if( IsOnCopperLayer() )
 return _( "Copper Zone" );
 else
 return _( "Non-copper Zone" );
}

References _, GetIsRuleArea(), IsOnCopperLayer(), and IsTeardropArea().

Referenced by GetMsgPanelInfo().

◆ GetHashValue()

MD5_HASH ZONE::GetHashValue ( PCB_LAYER_ID aLayer )

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

Definition at line 387 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.

Referenced by ZONE_FILLER::Fill().

◆ GetHatchBorderAlgorithm()

int ZONE::GetHatchBorderAlgorithm ( ) const

inline

Definition at line 278 of file zone.h.

278{ return m_hatchBorderAlgorithm; }

ZONE::m_hatchBorderAlgorithm

int m_hatchBorderAlgorithm

Definition: zone.h:867

References m_hatchBorderAlgorithm.

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

◆ GetHatchGap()

int ZONE::GetHatchGap ( ) const

inline

Definition at line 263 of file zone.h.

263{ return m_hatchGap; }

ZONE::m_hatchGap

int m_hatchGap

Definition: zone.h:859

References m_hatchGap.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetHatchHoleMinArea()

double ZONE::GetHatchHoleMinArea ( ) const

inline

Definition at line 275 of file zone.h.

275{ return m_hatchHoleMinArea; }

ZONE::m_hatchHoleMinArea

double m_hatchHoleMinArea

Definition: zone.h:866

References m_hatchHoleMinArea.

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

◆ GetHatchLines()

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

inline

Definition at line 761 of file zone.h.

761{ return m_borderHatchLines; }

ZONE::m_borderHatchLines

std::vector< SEG > m_borderHatchLines

Definition: zone.h:893

References m_borderHatchLines.

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

◆ GetHatchOrientation()

EDA_ANGLE ZONE::GetHatchOrientation ( ) const

inline

Definition at line 266 of file zone.h.

266{ return m_hatchOrientation; }

ZONE::m_hatchOrientation

EDA_ANGLE m_hatchOrientation

Definition: zone.h:860

References m_hatchOrientation.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetHatchSmoothingLevel()

int ZONE::GetHatchSmoothingLevel ( ) const

inline

Definition at line 269 of file zone.h.

269{ return m_hatchSmoothingLevel; }

ZONE::m_hatchSmoothingLevel

int m_hatchSmoothingLevel

Definition: zone.h:861

References m_hatchSmoothingLevel.

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

◆ GetHatchSmoothingValue()

double ZONE::GetHatchSmoothingValue ( ) const

inline

Definition at line 272 of file zone.h.

272{ return m_hatchSmoothingValue; }

ZONE::m_hatchSmoothingValue

double m_hatchSmoothingValue

Definition: zone.h:865

References m_hatchSmoothingValue.

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

◆ GetHatchStyle()

ZONE_BORDER_DISPLAY_STYLE ZONE::GetHatchStyle ( ) const

inline

Definition at line 580 of file zone.h.

580{ return m_borderStyle; }

References m_borderStyle.

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

◆ GetHatchThickness()

int ZONE::GetHatchThickness ( ) const

inline

Definition at line 260 of file zone.h.

260{ return m_hatchThickness; }

ZONE::m_hatchThickness

int m_hatchThickness

Definition: zone.h:858

References m_hatchThickness.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetInteractingZones()

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

Some intersecting zones, despite being on the same layer with the same net, cannot be merged due to 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 1034 of file zone.cpp.

{
 int epsilon = pcbIUScale.mmToIU( 0.001 );
 BOX2I bbox = GetBoundingBox();
 
 bbox.Inflate( epsilon );
 
 for( ZONE* candidate : GetBoard()->Zones() )
 {
 if( candidate == this )
 continue;
 
 if( !candidate->GetLayerSet().test( aLayer ) )
 continue;
 
 if( candidate->GetIsRuleArea() || candidate->IsTeardropArea() )
 continue;
 
 if( !candidate->GetBoundingBox().Intersects( bbox ) )
 continue;
 
 if( candidate->GetNetCode() == GetNetCode() )
  {
 if( m_Poly->Collide( candidate->m_Poly ) )
 aSameNetCollidingZones->push_back( candidate );
 }
 else
 {
 aOtherNetIntersectingZones->push_back( candidate );
 }
 }
}

References SHAPE_POLY_SET::Collide(), BOARD_ITEM::GetBoard(), GetBoundingBox(), BOARD_CONNECTED_ITEM::GetNetCode(), BOX2< Vec >::Inflate(), m_Poly, EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by BuildSmoothedPoly().

◆ GetIslandRemovalMode()

const ISLAND_REMOVAL_MODE ZONE::GetIslandRemovalMode ( ) const

inline

Definition at line 711 of file zone.h.

711{ return m_islandRemovalMode; }

References m_islandRemovalMode.

Referenced by KI_TEST::CheckFpZone(), ZONE_FILLER::Fill(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), and zonesNeedUpdate().

◆ GetIsRuleArea()

bool ZONE::GetIsRuleArea ( ) const

inline

Accessors to parameters used in Rule Area zones:

Definition at line 697 of file zone.h.

697{ return m_isRuleArea; }

ZONE::m_isRuleArea

bool m_isRuleArea

Definition: zone.h:807

References m_isRuleArea.

Referenced by BuildSmoothedPoly(), KI_TEST::CheckFpZone(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), ZONE_FILLER::Fill(), PCB_PLUGIN::format(), GetFriendlyName(), GetItemDescription(), GetMsgPanelInfo(), HitTestFilledArea(), IsConnected(), isKeepoutZone(), IsSame(), PCB_SELECTION_TOOL::itemPassesFilter(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), ZONE_SETTINGS::operator<<(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), PNS_KICAD_IFACE_BASE::syncZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), BOARD_EDITOR_CONTROL::ZoneMerge(), and zonesNeedUpdate().

◆ GetItemDescription()

wxString ZONE::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

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 780 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 DRC_ENGINE::EvalRules(), and PNS_KICAD_IFACE_BASE::syncZone().

◆ GetLayer()

PCB_LAYER_ID ZONE::GetLayer ( ) const

overridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 239 of file zone.cpp.

{
 return BOARD_ITEM::GetLayer();
}

References BOARD_ITEM::GetLayer().

Referenced by DRAWING_TOOL::DrawZone(), ZONE_DESC::ZONE_DESC(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

◆ 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 94 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 FP_SHAPE::GetItemDescription(), PCB_DIMENSION_BASE::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_TEXTBOX::GetItemDescription(), PCB_TRACK::GetItemDescription(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

virtual LSET ZONE::GetLayerSet ( ) const

inlineoverridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 122 of file zone.h.

122{ return m_layerSet; }

References m_layerSet.

Referenced by CN_CONNECTIVITY_ALGO::Add(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), KI_TEST::CheckFpZone(), collidesWithArea(), ZONE_FILLER::Fill(), Flip(), PCB_PLUGIN::format(), ZONE_SEARCH_HANDLER::GetResultCell(), InitDataFromSrcInCopyCtor(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), IsSame(), FOOTPRINT::cmp_zones::operator()(), ZONE_SETTINGS::operator<<(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), PCB_SELECTION_TOOL::Selectable(), PNS_KICAD_IFACE_BASE::syncZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), BOARD::TestZoneIntersection(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), BOARD_EDITOR_CONTROL::ZoneMerge(), and zonesNeedUpdate().

◆ GetLocalClearance() [1/2]

int ZONE::GetLocalClearance ( ) const

inline

Definition at line 152 of file zone.h.

152{ return GetLocalClearance( nullptr ); }

ZONE::GetLocalClearance

int GetLocalClearance() const

Definition: zone.h:152

References GetLocalClearance().

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

◆ GetLocalClearance() [2/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 470 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::buildThermalSpokes(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), BOARD_INSPECTION_TOOL::InspectClearance(), ZONE_FILLER::knockoutThermalReliefs(), ZONE_SETTINGS::operator<<(), and zonesNeedUpdate().

◆ 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 147 of file board_connected_item.h.

147{ return 0; }

Referenced by DRC_ENGINE::EvalRules().

◆ GetLocalFlags()

int ZONE::GetLocalFlags ( ) const

inline

Definition at line 309 of file zone.h.

309{ return m_localFlgs; }

ZONE::m_localFlgs

int m_localFlgs

Definition: zone.h:873

References m_localFlgs.

Referenced by InitDataFromSrcInCopyCtor().

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 176 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 230 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 991 of file zone.cpp.

{
 return BITMAPS::add_zone;
}

References add_zone.

◆ GetMinIslandArea()

long long int ZONE::GetMinIslandArea ( ) const

inline

Definition at line 714 of file zone.h.

714{ 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:835

References m_minIslandArea.

Referenced by KI_TEST::CheckFpZone(), ZONE_FILLER::Fill(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), and zonesNeedUpdate().

◆ GetMinThickness()

int ZONE::GetMinThickness ( ) const

inline

Definition at line 251 of file zone.h.

251{ return m_ZoneMinThickness; }

References m_ZoneMinThickness.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), KI_TEST::CheckFpZone(), DRC_ENGINE::EvalRules(), ZONE_FILLER::Fill(), ZONE_FILLER::fillCopperZone(), ZONE_FILLER::fillNonCopperZone(), PCB_PLUGIN::format(), IsSame(), ZONE_SETTINGS::operator<<(), ALTIUM_PCB::ParsePolygons6Data(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ 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 521 of file zone.cpp.

{
 wxString msg = GetFriendlyName();
 
 // 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( _( "Restrictions" ), msg );
 }
 else if( IsOnCopperLayer() )
 {
 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
 {
 aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
 
 aList.emplace_back( _( "Resolved Netclass" ),
 UnescapeString( GetEffectiveNetClass()->GetName() ) );
 }
 
 // Display priority level
 aList.emplace_back( _( "Priority" ),
 wxString::Format( wxT( "%d" ), GetAssignedPriority() ) );
 }
 
 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 );
 
 aList.emplace_back( _( "Filled Area" ),
 aFrame->MessageTextFromValue( m_area, true, EDA_DATA_TYPE::AREA ) );
 
 wxString source;
 int clearance = GetOwnClearance( UNDEFINED_LAYER, &source );
 
 if( !source.IsEmpty() )
 {
 aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
 aFrame->MessageTextFromValue( clearance ) ),
 wxString::Format( _( "(from %s)" ),
 source ) );
 }
 
 if( !m_FilledPolysList.empty() )
 {
 count = 0;
 
 for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& ii: m_FilledPolysList )
 count += ii.second->TotalVertices();
 
 aList.emplace_back( _( "Corner Count" ), wxString::Format( wxT( "%d" ), count ) );
 }
}

References _, AccumulateDescription(), AREA, Format(), GetAssignedPriority(), BOARD_ITEM::GetBoard(), GetDoNotAllowCopperPour(), GetDoNotAllowFootprints(), GetDoNotAllowPads(), GetDoNotAllowTracks(), GetDoNotAllowVias(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), GetFriendlyName(), GetIsRuleArea(), BOARD::GetLayerName(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_CONNECTED_ITEM::GetOwnClearance(), HATCH_PATTERN, BOARD_ITEM::IsLocked(), IsOnCopperLayer(), m_area, SHAPE_POLY_SET::VERTEX_INDEX::m_contour, m_CornerSelection, m_FilledPolysList, m_fillMode, m_layerSet, m_zoneName, UNITS_PROVIDER::MessageTextFromValue(), PCB_EDIT_FRAME_NAME, POLYGONS, LSET::Seq(), UNDEFINED_LAYER, 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(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const

inherited

Returns the name of the effective netclass.

Primarily for the use of the property system.

Definition at line 106 of file board_connected_item.cpp.

{
 return GetEffectiveNetClass()->GetName();
}

References BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), and NETCLASS::GetName().

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and main().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 89 of file board_connected_item.cpp.

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

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

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 112 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(), PAD::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), ZONE_SEARCH_HANDLER::GetResultCell(), PCB_EXPR_NETNAME_REF::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), 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 118 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 ) + wxT( "](" ) + _( "Not Found" ) + wxT( ")" );
 else
 return wxT( "[" ) + UnescapeString( netname ) + wxT( "]" );
}

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

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

◆ GetNumCorners()

int ZONE::GetNumCorners ( void ) const

inline

Access to m_Poly parameters.

Definition at line 490 of file zone.h.

 {
 return m_Poly->TotalVertices();
 }

References m_Poly, and SHAPE_POLY_SET::TotalVertices().

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

◆ GetOutlineArea()

double ZONE::GetOutlineArea ( )

inline

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

Returns: the outline area

Definition at line 225 of file zone.h.

 {
 return m_outlinearea;
 }

References m_outlinearea.

Referenced by TEARDROP_MANAGER::setTeardropPriorities().

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

Reimplemented in PAD.

Definition at line 66 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(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), and GetMsgPanelInfo().

◆ GetPadConnection()

ZONE_CONNECTION ZONE::GetPadConnection ( ) const

inline

Definition at line 248 of file zone.h.

248{ return m_PadConnection; }

ZONE::m_PadConnection

ZONE_CONNECTION m_PadConnection

Definition: zone.h:824

References m_PadConnection.

Referenced by KI_TEST::CheckFpZone(), DRC_ENGINE::EvalRules(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 163 of file board_item.h.

163{ return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 239 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(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), PNS::ITEM::collideSimple(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), PCB_SHAPE::GetParentFootprint(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), DRC_ENGINE::IsNetTieExclusion(), LEGACY_PLUGIN::loadMODULE_TEXT(), PAD_TOOL::RecombinePad(), PAD::SameLogicalPadAs(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), and zonesNeedUpdate().

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 72 of file board_item.h.

72{ return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:334

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), BOARD_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), getClosestGroup(), BOARD::GroupLegalOps(), BOARD_ITEM::IsLocked(), memberOfFunc(), BOARD::Move(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), BOARD::Remove(), FOOTPRINT::Remove(), GROUP_TOOL::RemoveFromGroup(), BOARD_ITEM::SwapItemData(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and PCB_GROUP::WithinScope().

◆ GetPosition()

VECTOR2I ZONE::GetPosition ( ) const

overridevirtual

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

Reimplemented from EDA_ITEM.

Definition at line 233 of file zone.cpp.

{
 return GetCornerPosition( 0 );
}

References GetCornerPosition().

Referenced by EAGLE_PLUGIN::loadPlain().

◆ GetSelectedCorner()

int ZONE::GetSelectedCorner ( ) const

inline

Definition at line 281 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.

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 134 of file board_connected_item.cpp.

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

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

Referenced by PAD::IsFreePad(), and PAD::IsNoConnectPad().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 123 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

136{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 82 of file board_item.cpp.

{
 wxCHECK( false, STROKE_PARAMS( pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ) ) );
}

References DEFAULT_LINE_WIDTH, EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by CONVERT_TOOL::CreatePolys(), and PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ GetTeardropAreaType()

TEARDROP_TYPE ZONE::GetTeardropAreaType ( ) const

inline

Returns: the type of the teardrop ( has meaning only if the zone is a teardrop area)

Definition at line 692 of file zone.h.

692{ return m_teardropType; }

References m_teardropType.

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

◆ GetThermalReliefGap() [1/2]

int ZONE::GetThermalReliefGap ( ) const

inline

Definition at line 184 of file zone.h.

184{ return m_thermalReliefGap; }

References m_thermalReliefGap.

Referenced by KI_TEST::CheckFpZone(), DRC_ENGINE::EvalRules(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetThermalReliefGap() [2/2]

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

Definition at line 360 of file zone.cpp.

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

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

◆ GetThermalReliefSpokeWidth()

int ZONE::GetThermalReliefSpokeWidth ( ) const

inline

Definition at line 195 of file zone.h.

195{ return m_thermalReliefSpokeWidth; }

References m_thermalReliefSpokeWidth.

Referenced by KI_TEST::CheckFpZone(), DRC_ENGINE::EvalRules(), PCB_PLUGIN::format(), ZONE_SETTINGS::operator<<(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ GetUnescapedShortNetname()

wxString BOARD_CONNECTED_ITEM::GetUnescapedShortNetname ( ) const

inherited

Returns: the unescaped short netname.

Definition at line 140 of file board_connected_item.cpp.

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

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

Referenced by KIGFX::PCB_PAINTER::draw(), and PCB_TRACK::ViewGetLOD().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 76 of file board_item.h.

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

References EDA_ITEM::GetPosition(), and VECTOR2< T >::x.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetY(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 82 of file board_item.h.

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

References EDA_ITEM::GetPosition(), and VECTOR2< T >::y.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetX(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ GetZoneName()

wxString ZONE::GetZoneName ( ) const

inline

Definition at line 124 of file zone.h.

124{ return m_zoneName; }

References m_zoneName.

Referenced by KI_TEST::CheckFpZone(), PCB_PLUGIN::format(), ZONE_SEARCH_HANDLER::GetResultCell(), PNS::ROUTER::isStartingPointRoutable(), Matches(), EDA_3D_CANVAS::OnMouseMove(), ZONE_SETTINGS::operator<<(), PNS_KICAD_IFACE_BASE::syncZone(), ZONE_DESC::ZONE_DESC(), and zonesNeedUpdate().

◆ HasFilledPolysForLayer()

bool ZONE::HasFilledPolysForLayer ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 594 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 143 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and EE_SELECTION_TOOL::selectMultiple().

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 128 of file board_item.h.

 {
 return false;
 }

Referenced by DRAWING_TOOL::DrawVia(), hasDrilledHole(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and PCB_CONTROL::UpdateMessagePanel().

◆ HasLineStroke()

virtual bool BOARD_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented in PCB_SHAPE.

Definition at line 172 of file board_item.h.

172{ return false; }

◆ 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 855 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
 int layer = GetFirstLayer();
 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
 std::vector<VECTOR2I> pointbuffer;
 pointbuffer.reserve( 256 );
 
 for( int a = min_a; a < max_a; a += spacing )
 {
 pointbuffer.clear();
 
 // Iterate through all vertices
 for( auto iterator = m_Poly->IterateSegmentsWithHoles(); iterator; iterator++ )
 {
 const SEG seg = *iterator;
 double x, y;
 
 if( FindLineSegmentIntersection( a, slope, seg.A.x, seg.A.y, seg.B.x, seg.B.y, x, y ) )
 pointbuffer.emplace_back( KiROUND( x ), KiROUND( y ) );
 }
 
 // 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( size_t ip = 0; ip + 1 < 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, std::abs(), SEG::B, SHAPE_POLY_SET::CVertex(), DIAGONAL_EDGE, DIAGONAL_FULL, GetFirstLayer(), SHAPE_POLY_SET::IsEmpty(), SHAPE_POLY_SET::IterateSegmentsWithHoles(), SHAPE_POLY_SET::IterateWithHoles(), KiROUND(), m_borderHatchLines, m_borderHatchPitch, m_borderStyle, m_Poly, NO_HATCH, sortEndsByDescendingX(), UnHatchBorder(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_POINT_EDITOR::addCorner(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), Mirror(), Move(), MoveEdge(), Rotate(), SetBorderDisplayStyle(), and PCB_POINT_EDITOR::updateItem().

◆ HigherPriority()

bool ZONE::HigherPriority ( const ZONE * aOther ) const

Definition at line 186 of file zone.cpp.

{
 // Teardrops are always higher priority than regular zones, so if one zone is a teardrop
 // and the other is not, then return higher priority as the teardrop
 if( ( m_teardropType == TEARDROP_TYPE::TD_NONE )
 ^ ( aOther->m_teardropType == TEARDROP_TYPE::TD_NONE ) )
 {
 return static_cast<int>( m_teardropType ) > static_cast<int>( aOther->m_teardropType );
 }
 
 if( m_priority != aOther->m_priority )
 return m_priority > aOther->m_priority;
 
 return m_Uuid > aOther->m_Uuid;
}

References m_priority, m_teardropType, EDA_ITEM::m_Uuid, and TD_NONE.

Referenced by ZONE_FILLER::Fill().

◆ HitTest() [1/2]

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

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I 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 429 of file zone.cpp.

{
 // Calculate bounding box for zone
 BOX2I bbox = GetBoundingBox();
 bbox.Normalize();
 
 BOX2I 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++ )
 {
 VECTOR2I vertex = m_Poly->CVertex( ii );
 VECTOR2I vertexNext = m_Poly->CVertex( ( ii + 1 ) % count );
 
 // Test if the point is within the rect
 if( arect.Contains( vertex ) )
 return true;
 
 // Test if this edge intersects the rect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }
 
 return false;
 }
}

References BOX2< Vec >::Contains(), SHAPE_POLY_SET::CVertex(), GetBoundingBox(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), m_Poly, BOX2< Vec >::Normalize(), and SHAPE_POLY_SET::TotalVertices().

◆ HitTest() [2/2]

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

overridevirtual

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

Parameters

aPosition the VECTOR2I to test

Returns: true if a hit, else false

Reimplemented from EDA_ITEM.

Definition at line 405 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, pcbIUScale.mmToIU( 0.1 ) );
 
 return HitTestForCorner( aPosition, accuracy * 2 ) || HitTestForEdge( aPosition, accuracy );
}

References HitTestForCorner(), HitTestForEdge(), EDA_IU_SCALE::mmToIU(), and pcbIUScale.

◆ HitTestCutout()

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 496 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 EDIT_TOOL::DeleteItems().

◆ HitTestFilledArea()

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

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

Parameters

aLayer	is the layer to test on
aRefPos	A VECTOR2I 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 482 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( aRefPos, -1, aAccuracy );
 
 if( !m_FilledPolysList.count( aLayer ) )
 return false;
 
 return m_FilledPolysList.at( aLayer )->Contains( aRefPos, -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()

bool ZONE::HitTestForCorner	(	const VECTOR2I &	refPos,
		int	aAccuracy,
		SHAPE_POLY_SET::VERTEX_INDEX *	aCornerHit = `nullptr`
	)		const

Test if the given VECTOR2I is near a corner.

Parameters

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

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

Definition at line 415 of file zone.cpp.

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

References SHAPE_POLY_SET::CollideVertex(), and m_Poly.

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

◆ HitTestForEdge()

bool ZONE::HitTestForEdge	(	const VECTOR2I &	refPos,
		int	aAccuracy,
		SHAPE_POLY_SET::VERTEX_INDEX *	aCornerHit = `nullptr`
	)		const

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

Parameters

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

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

Definition at line 422 of file zone.cpp.

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

References SHAPE_POLY_SET::CollideEdge(), and m_Poly.

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

◆ InitDataFromSrcInCopyCtor()

void ZONE::InitDataFromSrcInCopyCtor ( const ZONE & aZone )

Copy aZone data to me.

Definition at line 102 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_teardropType = aZone.m_teardropType;
 
 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() )
 {
 std::shared_ptr<SHAPE_POLY_SET> fill = aZone.m_FilledPolysList.at( layer );
 
 if( fill )
 m_FilledPolysList[layer] = std::make_shared<SHAPE_POLY_SET>( *fill );
 else
 m_FilledPolysList[layer] = std::make_shared<SHAPE_POLY_SET>();
 
 m_filledPolysHash[layer] = aZone.m_filledPolysHash.at( layer );
 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_area = aZone.m_area;
 m_outlinearea = aZone.m_outlinearea;
}

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_fillVersion, EDA_ITEM::m_flags, EDA_ITEM::m_forceVisible, m_hatchBorderAlgorithm, m_hatchGap, m_hatchHoleMinArea, m_hatchOrientation, m_hatchSmoothingLevel, m_hatchSmoothingValue, m_hatchThickness, m_insulatedIslands, m_isFilled, m_islandRemovalMode, m_isRuleArea, m_minIslandArea, m_needRefill, BOARD_CONNECTED_ITEM::m_netinfo, m_outlinearea, m_PadConnection, m_Poly, m_priority, m_teardropType, 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 108 of file eda_item.h.

108{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ IsConflicting()

bool ZONE::IsConflicting ( ) const

For rule areas which exclude footprints (and therefore participate in courtyard conflicts during move).

Definition at line 227 of file zone.cpp.

{
 return HasFlag( COURTYARD_CONFLICT );
}

References COURTYARD_CONFLICT, and EDA_ITEM::HasFlag().

Referenced by ViewGetLayers().

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

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & ENTERED; }

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 242 of file zone.h.

242{ return m_isFilled; }

References m_isFilled.

Referenced by KI_TEST::CheckFpZone(), collidesWithArea(), PCB_PLUGIN::format(), CONNECTIVITY_DATA::IsConnectedOnLayer(), and DRC_TEST_PROVIDER_DISALLOW::Run().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 201 of file eda_item.h.

201{ return m_forceVisible; }

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

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 250 of file board_item.h.

250{ return m_isKnockout; }

BOARD_ITEM::m_isKnockout

bool m_isKnockout

Definition: board_item.h:330

References BOARD_ITEM::m_isKnockout.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), PCB_TEXT::GetBoundingBox(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXT_DESC::PCB_TEXT_DESC(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), and PCB_TEXT::TextHitTest().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Reimplemented in FOOTPRINT, and PAD.

Definition at line 71 of file board_item.cpp.

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

References FPHOLDER, BOARD_ITEM::GetBoard(), BOARD::GetBoardUse(), BOARD_ITEM::GetParentGroup(), BOARD_ITEM::IsLocked(), and BOARD_ITEM::m_isLocked.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpZone(), PCB_CONTROL::DeleteItemCursor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromSESSION(), PCB_GROUP::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), PCB_SELECTION_CONDITIONS::HasLockedItems(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), BOARD_ITEM::IsLocked(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), 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_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), BOARD_ITEM::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), and PCB_VIA::ViewGetLayers().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ 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 254 of file zone.cpp.

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

References LSET::AllCuMask(), and m_layerSet.

Referenced by ZONE_FILLER::Fill(), ZONE_FILLER::fillSingleZone(), PCB_PLUGIN::format(), GetFriendlyName(), GetMsgPanelInfo(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), BRDITEMS_PLOTTER::PlotFilledAreas(), DRC_TEST_PROVIDER_DISALLOW::Run(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

◆ 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 317 of file zone.cpp.

{
 return m_layerSet.test( aLayer );
}

References m_layerSet.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), KIGFX::PCB_PAINTER::draw(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), 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 LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ 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 54 of file zones_functions_for_undo_redo.cpp.

{
 // compare basic parameters:
 if( GetLayerSet() != aZoneToCompare.GetLayerSet() )
 return false;
 
 if( GetNetCode() != aZoneToCompare.GetNetCode() )
 return false;
 
 if( GetAssignedPriority() != aZoneToCompare.GetAssignedPriority() )
 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 GetAssignedPriority(), GetDoNotAllowCopperPour(), GetDoNotAllowFootprints(), GetDoNotAllowPads(), GetDoNotAllowTracks(), GetDoNotAllowVias(), GetFillMode(), GetIsRuleArea(), GetLayerSet(), GetMinThickness(), BOARD_CONNECTED_ITEM::GetNetCode(), 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 106 of file eda_item.h.

106{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:54

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsTeardropArea()

bool ZONE::IsTeardropArea ( ) const

inline

Returns: true if the zone is a teardrop area

Definition at line 681 of file zone.h.

681{ return m_teardropType != TEARDROP_TYPE::TD_NONE; }

References m_teardropType, and TD_NONE.

Referenced by ZONE_FILLER::buildCopperItemClearances(), BuildSmoothedPoly(), DRC_ENGINE::EvalRules(), PCB_PLUGIN::format(), GetFriendlyName(), and ZONE_FILLER::knockoutThermalReliefs().

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA.

Definition at line 133 of file board_item.h.

 {
 return false;
 }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), and DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ IsType()

virtual bool EDA_ITEM::IsType ( const std::vector< 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 SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 181 of file eda_item.h.

 {
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ 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 500 of file zone.h.

 {
 return m_Poly->Iterate();
 }

References SHAPE_POLY_SET::Iterate(), and m_Poly.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_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 510 of file zone.h.

 {
 return m_Poly->IterateWithHoles();
 }

References SHAPE_POLY_SET::IterateWithHoles(), and m_Poly.

Referenced by DSN::SPECCTRA_DB::makeIMAGE().

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 106 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 PAD::GetItemDescription(), PAD::GetMsgPanelInfo(), and PCB_TRACK::GetMsgPanelInfo().

◆ Matches() [1/2]

bool ZONE::Matches	(	const EDA_SEARCH_DATA &	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 127 of file zone.h.

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

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

Referenced by DIALOG_FIND::search(), and ZONE_SEARCH_HANDLER::Search().

◆ Matches() [2/2]

bool EDA_ITEM::Matches	(	const wxString &	aText,
		const EDA_SEARCH_DATA &	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 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::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( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ Mirror()

void ZONE::Mirror	(	const VECTOR2I &	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 703 of file zone.cpp.

{
 m_Poly->Mirror( aMirrorLeftRight, !aMirrorLeftRight, aMirrorRef );
 
 HatchBorder();
 
 for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
 pair.second->Mirror( aMirrorLeftRight, !aMirrorLeftRight, aMirrorRef );
}

References HatchBorder(), m_FilledPolysList, m_Poly, and SHAPE_POLY_SET::Mirror().

Referenced by Flip().

◆ Move()

void ZONE::Move ( const VECTOR2I & offset )

overridevirtual

Move the outlines.

Parameters

offset is moving vector

Reimplemented from BOARD_ITEM.

Definition at line 629 of file zone.cpp.

{
 /* move outlines */
 m_Poly->Move( offset );
 
 HatchBorder();
 
 /* move fills */
 for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
 pair.second->Move( offset );
 
 /*
 * move boundingbox cache
 *
 * While the cache will get nuked at the conclusion of the operation, we use it for some
 * things (such as drawing the parent group) during the move.
 */
 if( GetBoard() )
 {
 auto it = GetBoard()->m_ZoneBBoxCache.find( this );
 
 if( it != GetBoard()->m_ZoneBBoxCache.end() )
 it->second.Move( offset );
 }
}

References BOARD_ITEM::GetBoard(), HatchBorder(), m_FilledPolysList, m_Poly, BOARD::m_ZoneBBoxCache, and SHAPE_POLY_SET::Move().

◆ MoveEdge()

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

Move the outline Edge.

Parameters

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

Definition at line 669 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 245 of file zone.h.

245{ return m_needRefill; }

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 564 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 231 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 82 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 312 of file zone.h.

312{ return m_Poly; }

References m_Poly.

Referenced by PCB_POINT_EDITOR::addCorner(), ZONE_FILLER::addHatchFillTypeOnZone(), BOARD::BOARD(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), KI_TEST::CheckFpZone(), collidesWithArea(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), CONVERT_TOOL::CreatePolys(), TEARDROP_MANAGER::createTeardrop(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), ZONE_FILLER::Fill(), PCB_BASE_FRAME::FocusOnItems(), PCB_PLUGIN::format(), ALTIUM_PCB::HelperPcpShapeAsBoardKeepoutRegion(), ALTIUM_PCB::HelperPcpShapeAsFootprintKeepoutRegion(), IsSame(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromClosedGraphics(), FOOTPRINT::cmp_zones::operator()(), EAGLE_PLUGIN::packagePolygon(), ALTIUM_PCB::ParsePolygons6Data(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_POINT_EDITOR::removeCorner(), DRC_TEST_PROVIDER_DISALLOW::Run(), PNS_KICAD_IFACE_BASE::syncZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), BOARD::TestZoneIntersection(), PCB_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), and zonesNeedUpdate().

◆ Outline() [2/2]

const SHAPE_POLY_SET * ZONE::Outline ( ) const

inline

Definition at line 313 of file zone.h.

313{ return m_Poly; }

References m_Poly.

◆ RemoveAllContours()

void ZONE::RemoveAllContours ( void )

inline

Definition at line 525 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 714 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::DeleteItems().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 163 of file eda_item.h.

163{ return false; }

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	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 LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

◆ Replace() [2/2]

bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	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 168 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.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( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::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.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, text, and WHOLEWORD.

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

◆ Rotate()

void ZONE::Rotate	(	const VECTOR2I &	aCentre,
		const EDA_ANGLE &	aAngle
	)

overridevirtual

Rotate the outlines.

Parameters

aCentre is rot centre

Reimplemented from BOARD_ITEM.

Definition at line 684 of file zone.cpp.

{
 m_Poly->Rotate( aAngle, VECTOR2I( aCentre ) );
 HatchBorder();
 
 /* rotate filled areas: */
 for( std::pair<const PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>>& pair : m_FilledPolysList )
 pair.second->Rotate( aAngle, aCentre );
}

References HatchBorder(), m_FilledPolysList, m_Poly, and SHAPE_POLY_SET::Rotate().

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

◆ SameNet()

bool ZONE::SameNet ( const ZONE * aOther ) const

Definition at line 203 of file zone.cpp.

{
 return GetNetCode() == aOther->GetNetCode();
}

References BOARD_CONNECTED_ITEM::GetNetCode().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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().

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetAssignedPriority()

void ZONE::SetAssignedPriority ( unsigned aPriority )

inline

Parameters

aPriority is the priority level.

Definition at line 107 of file zone.h.

107{ m_priority = aPriority; }

References m_priority.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadZone(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetBorderDisplayStyle()

void ZONE::SetBorderDisplayStyle	(	ZONE_BORDER_DISPLAY_STYLE	aBorderHatchStyle,
		int	aBorderHatchPitch,
		bool	aRebuilBorderdHatch
	)

Set all hatch parameters for the zone.

Parameters

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

Definition at line 820 of file zone.cpp.

{
 aBorderHatchPitch = std::max( aBorderHatchPitch,
 pcbIUScale.mmToIU( ZONE_BORDER_HATCH_MINDIST_MM ) );
 aBorderHatchPitch = std::min( aBorderHatchPitch,
 pcbIUScale.mmToIU( ZONE_BORDER_HATCH_MAXDIST_MM ) );
 SetBorderHatchPitch( aBorderHatchPitch );
 m_borderStyle = aBorderHatchStyle;
 
 if( aRebuildBorderHatch )
 HatchBorder();
}

References HatchBorder(), m_borderStyle, EDA_IU_SCALE::mmToIU(), pcbIUScale, SetBorderHatchPitch(), ZONE_BORDER_HATCH_MAXDIST_MM, and ZONE_BORDER_HATCH_MINDIST_MM.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperPcpShapeAsBoardKeepoutRegion(), ALTIUM_PCB::HelperPcpShapeAsFootprintKeepoutRegion(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), and ALTIUM_PCB::ParsePolygons6Data().

◆ SetBorderHatchPitch()

void ZONE::SetBorderHatchPitch ( int aPitch )

Set the hatch pitch parameter for the zone.

Parameters

aPitch is the hatch pitch in iu.

Definition at line 835 of file zone.cpp.

{
 m_borderHatchPitch = aPitch;
}

References m_borderHatchPitch.

Referenced by SetBorderDisplayStyle().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

116{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:139

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCornerPosition()

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

inline

Definition at line 541 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" ) );
 }
 }

References SHAPE_POLY_SET::CVertex(), SHAPE_POLY_SET::GetRelativeIndices(), m_Poly, SetNeedRefill(), SHAPE_POLY_SET::SetVertex(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetCornerRadius()

void ZONE::SetCornerRadius ( unsigned int aRadius )

Definition at line 375 of file zone.cpp.

{
 if( m_cornerRadius != aRadius )
 SetNeedRefill( true );
 
 m_cornerRadius = aRadius;
}

References m_cornerRadius, and SetNeedRefill().

Referenced by ZONE_SETTINGS::ExportSetting().

◆ SetCornerSmoothingType()

void ZONE::SetCornerSmoothingType ( int aType )

inline

Definition at line 646 of file zone.h.

646{ m_cornerSmoothingType = aType; };

References m_cornerSmoothingType.

Referenced by ZONE_SETTINGS::ExportSetting().

◆ SetDoNotAllowCopperPour()

void ZONE::SetDoNotAllowCopperPour ( bool aEnable )

inline

Definition at line 705 of file zone.h.

705{ m_doNotAllowCopperPour = aEnable; }

References m_doNotAllowCopperPour.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperSetZoneKeepoutRestrictions(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), EAGLE_PLUGIN::loadPolygon(), FABMASTER::loadZone(), and EAGLE_PLUGIN::setKeepoutSettingsToZone().

◆ SetDoNotAllowFootprints()

void ZONE::SetDoNotAllowFootprints ( bool aEnable )

inline

Definition at line 709 of file zone.h.

709{ m_doNotAllowFootprints = aEnable; }

References m_doNotAllowFootprints.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperSetZoneKeepoutRestrictions(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), EAGLE_PLUGIN::loadPolygon(), FABMASTER::loadZone(), and EAGLE_PLUGIN::setKeepoutSettingsToZone().

◆ SetDoNotAllowPads()

void ZONE::SetDoNotAllowPads ( bool aEnable )

inline

Definition at line 708 of file zone.h.

708{ m_doNotAllowPads = aEnable; }

References m_doNotAllowPads.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperSetZoneKeepoutRestrictions(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), EAGLE_PLUGIN::loadPolygon(), FABMASTER::loadZone(), and EAGLE_PLUGIN::setKeepoutSettingsToZone().

◆ SetDoNotAllowTracks()

void ZONE::SetDoNotAllowTracks ( bool aEnable )

inline

Definition at line 707 of file zone.h.

707{ m_doNotAllowTracks = aEnable; }

References m_doNotAllowTracks.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperSetZoneKeepoutRestrictions(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), EAGLE_PLUGIN::loadPolygon(), FABMASTER::loadZone(), and EAGLE_PLUGIN::setKeepoutSettingsToZone().

◆ SetDoNotAllowVias()

void ZONE::SetDoNotAllowVias ( bool aEnable )

inline

Definition at line 706 of file zone.h.

706{ m_doNotAllowVias = aEnable; }

References m_doNotAllowVias.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperSetZoneKeepoutRestrictions(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), EAGLE_PLUGIN::loadPolygon(), FABMASTER::loadZone(), and EAGLE_PLUGIN::setKeepoutSettingsToZone().

◆ SetFilledPolysList()

void ZONE::SetFilledPolysList	(	PCB_LAYER_ID	aLayer,
		const SHAPE_POLY_SET &	aPolysList
	)

inline

Set the list of filled polygons.

Definition at line 623 of file zone.h.

 {
 m_FilledPolysList[aLayer] = std::make_shared<SHAPE_POLY_SET>( aPolysList );
 }

References m_FilledPolysList.

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

◆ SetFillFlag()

void ZONE::SetFillFlag	(	PCB_LAYER_ID	aLayer,
		bool	aFlag
	)

inline

Definition at line 240 of file zone.h.

240{ m_fillFlags.set( aLayer, aFlag ); }

References m_fillFlags.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), and ZONE_FILLER::Fill().

◆ SetFillMode()

void ZONE::SetFillMode ( ZONE_FILL_MODE aFillMode )

inline

Definition at line 173 of file zone.h.

173{ m_fillMode = aFillMode; }

References m_fillMode.

Referenced by ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::getZoneFromCadstarShape(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 139 of file eda_item.h.

139{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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.

Parameters

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

Definition at line 199 of file eda_item.h.

199{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ SetHatchBorderAlgorithm()

void ZONE::SetHatchBorderAlgorithm ( int aAlgo )

inline

Definition at line 279 of file zone.h.

279{ m_hatchBorderAlgorithm = aAlgo; }

References m_hatchBorderAlgorithm.

Referenced by ZONE_SETTINGS::ExportSetting().

◆ SetHatchGap()

void ZONE::SetHatchGap ( int aStep )

inline

Definition at line 264 of file zone.h.

264{ m_hatchGap = aStep; }

References m_hatchGap.

Referenced by ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetHatchHoleMinArea()

void ZONE::SetHatchHoleMinArea ( double aPct )

inline

Definition at line 276 of file zone.h.

276{ m_hatchHoleMinArea = aPct; }

References m_hatchHoleMinArea.

Referenced by ZONE_SETTINGS::ExportSetting().

◆ SetHatchOrientation()

void ZONE::SetHatchOrientation ( const EDA_ANGLE & aStep )

inline

Definition at line 267 of file zone.h.

267{ m_hatchOrientation = aStep; }

References m_hatchOrientation.

Referenced by ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetHatchSmoothingLevel()

void ZONE::SetHatchSmoothingLevel ( int aLevel )

inline

Definition at line 270 of file zone.h.

270{ m_hatchSmoothingLevel = aLevel; }

References m_hatchSmoothingLevel.

Referenced by ZONE_SETTINGS::ExportSetting().

◆ SetHatchSmoothingValue()

void ZONE::SetHatchSmoothingValue ( double aValue )

inline

Definition at line 273 of file zone.h.

273{ m_hatchSmoothingValue = aValue; }

References m_hatchSmoothingValue.

Referenced by ZONE_SETTINGS::ExportSetting().

◆ SetHatchStyle()

void ZONE::SetHatchStyle ( ZONE_BORDER_DISPLAY_STYLE aStyle )

inline

Definition at line 581 of file zone.h.

581{ m_borderStyle = aStyle; }

References m_borderStyle.

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

◆ SetHatchThickness()

void ZONE::SetHatchThickness ( int aThickness )

inline

Definition at line 261 of file zone.h.

261{ m_hatchThickness = aThickness; }

References m_hatchThickness.

Referenced by ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetIsFilled()

void ZONE::SetIsFilled ( bool isFilled )

inline

Definition at line 243 of file zone.h.

243{ m_isFilled = isFilled; }

References m_isFilled.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), TEARDROP_MANAGER::createTeardrop(), ZONE_FILLER::Fill(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), and ALTIUM_PCB::ParseRegions6Data().

◆ SetIsIsland()

void ZONE::SetIsIsland	(	PCB_LAYER_ID	aLayer,
		int	aPolyIdx
	)

inline

Definition at line 637 of file zone.h.

 {
 m_insulatedIslands[aLayer].insert( aPolyIdx );
 }

References m_insulatedIslands.

Referenced by ZONE_FILLER::Fill().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 251 of file board_item.h.

251{ m_isKnockout = aKnockout; }

References BOARD_ITEM::m_isKnockout.

Referenced by PCB_TEXT_DESC::PCB_TEXT_DESC().

◆ SetIslandRemovalMode()

void ZONE::SetIslandRemovalMode ( ISLAND_REMOVAL_MODE aRemove )

inline

Definition at line 712 of file zone.h.

712{ m_islandRemovalMode = aRemove; }

References m_islandRemovalMode.

Referenced by TEARDROP_MANAGER::createTeardrop(), ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), and CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates().

◆ SetIsRuleArea()

void ZONE::SetIsRuleArea ( bool aEnable )

inline

Definition at line 704 of file zone.h.

704{ m_isRuleArea = aEnable; }

References m_isRuleArea.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), ZONE_SETTINGS::ExportSetting(), ALTIUM_PCB::HelperPcpShapeAsBoardKeepoutRegion(), ALTIUM_PCB::HelperPcpShapeAsFootprintKeepoutRegion(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), EAGLE_PLUGIN::loadPolygon(), FABMASTER::loadZone(), EAGLE_PLUGIN::setKeepoutSettingsToZone(), and ZONE().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

◆ SetLayer()

void ZONE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Set the layer this item is on.

This method is virtual because some items (in fact: class DIMENSION) have a slightly different initialization.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 260 of file zone.cpp.

{
 SetLayerSet( LSET( aLayer ) );
}

References SetLayerSet().

Referenced by BOARD::AddArea(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), TEARDROP_MANAGER::createTeardrop(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadZone(), PlotSolderMaskLayer(), EAGLE_PLUGIN::setKeepoutSettingsToZone(), and ZONE_DESC::ZONE_DESC().

◆ SetLayerSet()

void ZONE::SetLayerSet ( LSET aLayerSet )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 266 of file zone.cpp.

{
 if( aLayerSet.count() == 0 )
 return;
 
 if( m_layerSet != aLayerSet )
 {
 SetNeedRefill( true );
 
 UnFill();
 
 m_FilledPolysList.clear();
 m_filledPolysHash.clear();
 m_insulatedIslands.clear();
 
 for( PCB_LAYER_ID layer : aLayerSet.Seq() )
 {
 m_FilledPolysList[layer] = std::make_shared<SHAPE_POLY_SET>();
 m_filledPolysHash[layer] = {};
 m_insulatedIslands[layer] = {};
 }
 }
 
 m_layerSet = aLayerSet;
}

References m_filledPolysHash, m_FilledPolysList, m_insulatedIslands, m_layerSet, LSET::Seq(), SetNeedRefill(), and UnFill().

Referenced by BOARD::BOARD(), ZONE_SETTINGS::ExportSetting(), Flip(), ALTIUM_PCB::HelperSetZoneLayers(), InitDataFromSrcInCopyCtor(), CADSTAR_PCB_ARCHIVE_LOADER::loadAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), FABMASTER::loadZone(), EAGLE_PLUGIN::setKeepoutSettingsToZone(), and SetLayer().

◆ SetLocalClearance()

void ZONE::SetLocalClearance ( int aClearance )

inline

Definition at line 153 of file zone.h.

153{ m_ZoneClearance = aClearance; }

References m_ZoneClearance.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToBoard(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), TEARDROP_MANAGER::createTeardrop(), ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadZone(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetLocalFlags()

void ZONE::SetLocalFlags ( int aFlags )

inline

Definition at line 310 of file zone.h.

310{ m_localFlgs = aFlags; }

References m_localFlgs.

Referenced by InitDataFromSrcInCopyCtor(), and ZONE().

◆ SetLocalRatsnestVisible()

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool aVisible )

inlineinherited

Definition at line 171 of file board_connected_item.h.

 {
 m_localRatsnestVisible = aVisible;
 }

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

◆ SetMinIslandArea()

void ZONE::SetMinIslandArea ( long long int aArea )

inline

Definition at line 715 of file zone.h.

715{ m_minIslandArea = aArea; }

References m_minIslandArea.

Referenced by ZONE_SETTINGS::ExportSetting(), and CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates().

◆ SetMinThickness()

void ZONE::SetMinThickness ( int aMinThickness )

inline

Definition at line 252 of file zone.h.

 {
 if( m_ZoneMinThickness != aMinThickness )
 SetNeedRefill( true );
 
 m_ZoneMinThickness = aMinThickness;
 }

References m_ZoneMinThickness, and SetNeedRefill().

Referenced by BOARD::BOARD(), TEARDROP_MANAGER::createTeardrop(), ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), PlotSolderMaskLayer(), and ZONE_DESC::ZONE_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );
 
 // If this a child object, then the parent modification state also needs to be set.
 if( m_parent )
 m_parent->SetModified();
}

References IS_CHANGED, EDA_ITEM::m_parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), PCB_PARSER::parseZONE(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetNeedRefill()

void ZONE::SetNeedRefill ( bool aNeedRefill )

inline

Definition at line 246 of file zone.h.

246{ m_needRefill = aNeedRefill; }

References m_needRefill.

Referenced by PCB_POINT_EDITOR::addCorner(), AddPolygon(), AppendCorner(), ZONE_FILLER::fillSingleZone(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), MoveEdge(), ALTIUM_PCB::ParseRegions6Data(), PCB_POINT_EDITOR::removeCorner(), RemoveCutout(), SetCornerPosition(), SetCornerRadius(), SetLayerSet(), SetMinThickness(), SetThermalReliefGap(), SetThermalReliefSpokeWidth(), and PCB_POINT_EDITOR::updateItem().

◆ SetNet()

void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM * aNetInfo )

inlineinherited

Set a NET_INFO object for the item.

Definition at line 83 of file board_connected_item.h.

 {
 m_netinfo = aNetInfo;
 }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by BOOST_AUTO_TEST_CASE(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), FABMASTER::loadEtch(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadVias(), FABMASTER::loadZone(), main(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

◆ SetNetCode() [1/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int aNetCode )

inlineinherited

Definition at line 106 of file board_connected_item.h.

 {
  SetNetCode( aNetCode, false );
 }

References BOARD_CONNECTED_ITEM::SetNetCode().

◆ SetNetCode() [2/2]

bool BOARD_CONNECTED_ITEM::SetNetCode	(	int	aNetCode,
		bool	aNoAssert
	)

inherited

Set net using a net code.

Note: Pads not on copper layers will have their net code always set to 0 (not connected).

Parameters

aNetCode	is a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssert	if true, do not assert that the net exists. Otherwise, item is assigned to the unconnected net.

Returns: true on success, false if the net did not exist

Definition at line 44 of file board_connected_item.cpp.

{
 if( !IsOnCopperLayer() )
 aNetCode = 0;
 
 // if aNetCode < 0 (typically NETINFO_LIST::FORCE_ORPHANED) or no parent board,
 // set the m_netinfo to the dummy NETINFO_LIST::ORPHANED
 
 BOARD* board = GetBoard();
 
 if( ( aNetCode >= 0 ) && board )
 m_netinfo = board->FindNet( aNetCode );
 else
 m_netinfo = NETINFO_LIST::OrphanedItem();
 
 if( !aNoAssert )
 wxASSERT( m_netinfo );
 
 return ( m_netinfo != nullptr );
}

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

Referenced by BOARD::AddArea(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), TEARDROP_MANAGER::createTeardrop(), PCB_EDIT_FRAME::Edit_Zone_Params(), ZONE_SETTINGS::ExportSetting(), FOOTPRINT::FOOTPRINT(), FP_ZONE::FP_ZONE(), ROUTER_TOOL::handleLayerSwitch(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), FOOTPRINT::operator=(), ALTIUM_PCB::ParsePolygons6Data(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PNS_KICAD_IFACE::UpdateItem(), and ROUTER_TOOL::updateSizesAfterLayerSwitch().

◆ SetOutline()

void ZONE::SetOutline ( SHAPE_POLY_SET * aOutline )

inline

Definition at line 315 of file zone.h.

315{ m_Poly = aOutline; }

References m_Poly.

Referenced by FABMASTER::loadZone().

◆ SetPadConnection()

void ZONE::SetPadConnection ( ZONE_CONNECTION aPadConnection )

inline

Definition at line 249 of file zone.h.

249{ m_PadConnection = aPadConnection; }

References m_PadConnection.

Referenced by ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), TEARDROP_MANAGER::createTeardrop(), ZONE_SETTINGS::ExportSetting(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadZone(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), KI_TEST::LoadHierarchy(), LIB_SYMBOL::operator=(), FOOTPRINT::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), BOARD_ITEM::SwapItemData(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 71 of file board_item.h.

71{ m_group = aGroup; }

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::DragArcTrack(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), BOARD_COMMIT::makeImage(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GROUP::RemoveItem(), BOARD_COMMIT::Revert(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), BOARD_ITEM::SwapItemData(), and TEST_BOARD_ITEM_FIXTURE::~TEST_BOARD_ITEM_FIXTURE().

◆ SetPosition()

void ZONE::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 102 of file zone.h.

102{}

Referenced by ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), and ALTIUM_PCB::ParsePolygons6Data().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

115{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetSelectedCorner()

void ZONE::SetSelectedCorner ( int aCorner )

inline

Definition at line 292 of file zone.h.

 {
 SHAPE_POLY_SET::VERTEX_INDEX selectedCorner;
 
 // If the global index of the corner is correct, assign it to m_CornerSelection
 if( m_Poly->GetRelativeIndices( aCorner, &selectedCorner ) )
 {
 if( m_CornerSelection == nullptr )
 m_CornerSelection = new SHAPE_POLY_SET::VERTEX_INDEX;
 
 *m_CornerSelection = selectedCorner;
 }
 else
 throw( std::out_of_range( "aCorner-th vertex does not exist" ) );
 }

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

◆ SetState()

void EDA_ITEM::SetState	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 128 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), and TRACKS_CLEANER::mergeCollinearSegments().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 137 of file eda_item.h.

137{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 88 of file board_item.cpp.

{
 wxCHECK( false, /* void */ );
}

◆ SetTeardropAreaType()

void ZONE::SetTeardropAreaType ( TEARDROP_TYPE aType )

inline

Set the type of teardrop if the zone is a teardrop area for non teardrop area, the type must be TEARDROP_TYPE::TD_NONE.

Definition at line 687 of file zone.h.

687{ m_teardropType = aType; }

References m_teardropType.

Referenced by TEARDROP_MANAGER::createTeardrop(), and ZONE_SETTINGS::ExportSetting().

◆ SetThermalReliefGap()

void ZONE::SetThermalReliefGap ( int aThermalReliefGap )

inline

Definition at line 176 of file zone.h.

 {
 if( m_thermalReliefGap != aThermalReliefGap )
 SetNeedRefill( true );
 
 m_thermalReliefGap = aThermalReliefGap;
 }

References m_thermalReliefGap, and SetNeedRefill().

Referenced by ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetThermalReliefSpokeWidth()

void ZONE::SetThermalReliefSpokeWidth ( int aThermalReliefSpokeWidth )

inline

Definition at line 187 of file zone.h.

 {
 if( m_thermalReliefSpokeWidth != aThermalReliefSpokeWidth )
 SetNeedRefill( true );
 
 m_thermalReliefSpokeWidth = aThermalReliefSpokeWidth;
 }

References m_thermalReliefSpokeWidth, and SetNeedRefill().

Referenced by ZONE_SETTINGS::ExportSetting(), EAGLE_PLUGIN::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), ALTIUM_PCB::ParsePolygons6Data(), and ZONE_DESC::ZONE_DESC().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 98 of file board_item.h.

 {
 VECTOR2I p( aX, GetY() );
 SetPosition( p );
 }

References BOARD_ITEM::GetY(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 104 of file board_item.h.

 {
 VECTOR2I p( GetX(), aY );
 SetPosition( p );
 }

References BOARD_ITEM::GetX(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetZoneName()

void ZONE::SetZoneName ( const wxString & aName )

inline

Definition at line 125 of file zone.h.

125{ m_zoneName = aName; }

References m_zoneName.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private 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()

◆ CalculateOutlineArea()

◆ CIterateWithHoles()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ DeleteStructure()

◆ Duplicate()

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAssignedPriority()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBorderHatchPitch()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetCornerPosition()

◆ GetCornerRadius()

◆ GetCornerSmoothingType()

◆ GetDefaultHatchPitch()

◆ GetDoNotAllowCopperPour()

◆ GetDoNotAllowFootprints()

◆ GetDoNotAllowPads()

◆ GetDoNotAllowTracks()

◆ GetDoNotAllowVias()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveNetClass()

◆ GetEffectiveShape()

◆ GetFill()

◆ GetFilledArea()

◆ GetFilledPolysList()

◆ GetFillFlag()

◆ GetFillMode()

◆ GetFirstLayer()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFriendlyName()

◆ GetHashValue()

◆ GetHatchBorderAlgorithm()

◆ GetHatchGap()

◆ GetHatchHoleMinArea()

◆ GetHatchLines()

◆ GetHatchOrientation()

◆ GetHatchSmoothingLevel()

◆ GetHatchSmoothingValue()

◆ GetHatchStyle()

◆ GetHatchThickness()

◆ GetInteractingZones()

◆ GetIslandRemovalMode()

◆ GetIsRuleArea()

◆ GetItemDescription()