#include <zone_filler.h>

Public Member Functions
	ZONE_FILLER (BOARD aBoard, COMMIT aCommit)

	~ZONE_FILLER ()

void	SetProgressReporter (PROGRESS_REPORTER *aReporter)

PROGRESS_REPORTER *	GetProgressReporter () const

bool	Fill (const std::vector< ZONE * > &aZones, bool aCheck=false, wxWindow *aParent=nullptr)
	Fills the given list of zones.

bool	IsDebug () const

Private Member Functions
void	addKnockout (PAD *aPad, PCB_LAYER_ID aLayer, int aGap, SHAPE_POLY_SET &aHoles)
	Add a knockout for a pad.

void	addKnockout (BOARD_ITEM *aItem, PCB_LAYER_ID aLayer, int aGap, bool aIgnoreLineWidth, SHAPE_POLY_SET &aHoles)
	Add a knockout for a graphic item.

void	addHoleKnockout (PAD *aPad, int aGap, SHAPE_POLY_SET &aHoles)
	Add a knockout for a pad's hole.

void	knockoutThermalReliefs (const ZONE aZone, PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aFill, std::vector< PAD > &aThermalConnectionPads, std::vector< PAD * > &aNoConnectionPads)
	Removes thermal reliefs from the shape for any pads connected to the zone.

void	buildCopperItemClearances (const ZONE aZone, PCB_LAYER_ID aLayer, const std::vector< PAD > aNoConnectionPads, SHAPE_POLY_SET &aHoles)
	Removes clearance from the shape for copper items which share the zone's layer but are not connected to it.

void	subtractHigherPriorityZones (const ZONE *aZone, PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aRawFill)
	Removes the outlines of higher-proirity zones with the same net.

bool	fillCopperZone (const ZONE *aZone, PCB_LAYER_ID aLayer, PCB_LAYER_ID aDebugLayer, const SHAPE_POLY_SET &aSmoothedOutline, const SHAPE_POLY_SET &aMaxExtents, SHAPE_POLY_SET &aFillPolys)
	Function fillCopperZone Add non copper areas polygons (pads and tracks with clearance) to a filled copper area used in BuildFilledSolidAreasPolygons when calculating filled areas in a zone Non copper areas are pads and track and their clearance area The filled copper area must be computed before BuildFilledSolidAreasPolygons() call this function just after creating the filled copper area polygon (without clearance areas.

bool	fillNonCopperZone (const ZONE *aZone, PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aSmoothedOutline, SHAPE_POLY_SET &aFillPolys)

void	buildThermalSpokes (const ZONE box, PCB_LAYER_ID aLayer, const std::vector< PAD > &aSpokedPadsList, std::deque< SHAPE_LINE_CHAIN > &aSpokes)
	Function buildThermalSpokes Constructs a list of all thermal spokes for the given zone.

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

bool	addHatchFillTypeOnZone (const ZONE *aZone, PCB_LAYER_ID aLayer, PCB_LAYER_ID aDebugLayer, SHAPE_POLY_SET &aFillPolys)
	for zones having the ZONE_FILL_MODE::ZONE_FILL_MODE::HATCH_PATTERN, create a grid pattern in filled areas of aZone, giving to the filled polygons a fill style like a grid

Private Attributes
BOARD *	m_board

SHAPE_POLY_SET	m_boardOutline

bool	m_brdOutlinesValid

COMMIT *	m_commit

PROGRESS_REPORTER *	m_progressReporter

int	m_maxError

int	m_worstClearance

bool	m_debugZoneFiller

Detailed Description

Definition at line 39 of file zone_filler.h.

Constructor & Destructor Documentation

◆ ZONE_FILLER()

ZONE_FILLER::ZONE_FILLER	(	BOARD *	aBoard,
		COMMIT *	aCommit
	)

Definition at line 54 of file zone_filler.cpp.

References ADVANCED_CFG::GetCfg(), ADVANCED_CFG::m_DebugZoneFiller, and m_debugZoneFiller.

◆ ~ZONE_FILLER()

ZONE_FILLER::~ZONE_FILLER ( )

Definition at line 67 of file zone_filler.cpp.

Member Function Documentation

◆ addHatchFillTypeOnZone()

bool ZONE_FILLER::addHatchFillTypeOnZone	(	const ZONE *	aZone,
		PCB_LAYER_ID	aLayer,
		PCB_LAYER_ID	aDebugLayer,
		SHAPE_POLY_SET &	aFillPolys
	)

private

for zones having the ZONE_FILL_MODE::ZONE_FILL_MODE::HATCH_PATTERN, create a grid pattern in filled areas of aZone, giving to the filled polygons a fill style like a grid

Parameters

aZone	is the zone to modify
aFillPolys	A reference to a SHAPE_POLY_SET buffer containing the initial filled areas, and after adding the grid pattern, the modified filled areas with holes

Definition at line 2031 of file zone_filler.cpp.

Referenced by fillCopperZone(), and fillNonCopperZone().

◆ addHoleKnockout()

void ZONE_FILLER::addHoleKnockout	(	PAD *	aPad,
		int	aGap,
		SHAPE_POLY_SET &	aHoles
	)

private

Add a knockout for a pad's hole.

Definition at line 799 of file zone_filler.cpp.

References ERROR_OUTSIDE, m_maxError, and PAD::TransformHoleToPolygon().

Referenced by buildCopperItemClearances(), and fillCopperZone().

◆ addKnockout() [1/2]

void ZONE_FILLER::addKnockout	(	BOARD_ITEM *	aItem,
		PCB_LAYER_ID	aLayer,
		int	aGap,
		bool	aIgnoreLineWidth,
		SHAPE_POLY_SET &	aHoles
	)

private

Add a knockout for a graphic item.

The knockout is 'aGap' larger than the item (which might be either the electrical clearance or the board edge clearance).

Definition at line 809 of file zone_filler.cpp.

References ERROR_OUTSIDE, m_maxError, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, BOARD_ITEM::SetIsKnockout(), text, PCB_DIMENSION_BASE::TransformShapeToPolygon(), BOARD_ITEM::TransformShapeToPolygon(), PCB_TEXT::TransformShapeToPolygon(), and EDA_ITEM::Type().

◆ addKnockout() [2/2]

void ZONE_FILLER::addKnockout	(	PAD *	aPad,
		PCB_LAYER_ID	aLayer,
		int	aGap,
		SHAPE_POLY_SET &	aHoles
	)

private

Add a knockout for a pad.

The knockout is 'aGap' larger than the pad (which might be either the thermal clearance or the electrical clearance).

Definition at line 768 of file zone_filler.cpp.

References SHAPE_POLY_SET::Append(), BuildConvexHull(), CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL, ERROR_OUTSIDE, PAD::GetCustomShapeInZoneOpt(), PAD::GetShape(), m_maxError, SHAPE_POLY_SET::NewOutline(), and PAD::TransformShapeToPolygon().

Referenced by buildCopperItemClearances(), fillNonCopperZone(), and knockoutThermalReliefs().

◆ buildCopperItemClearances()

void ZONE_FILLER::buildCopperItemClearances	(	const ZONE *	aZone,
		PCB_LAYER_ID	aLayer,
		const std::vector< PAD * >	aNoConnectionPads,
		SHAPE_POLY_SET &	aHoles
	)

private

Removes clearance from the shape for copper items which share the zone's layer but are not connected to it.

Definition at line 981 of file zone_filler.cpp.

References addHoleKnockout(), addKnockout(), SHAPE_POLY_SET::Append(), CLEARANCE_CONSTRAINT, BOARD::Drawings(), EDGE_CLEARANCE_CONSTRAINT, Edge_Cuts, ERROR_OUTSIDE, BOARD::Footprints(), ZONE::GetBoundingBox(), ADVANCED_CFG::GetCfg(), BOARD::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetNetCode(), DRC_CONSTRAINT::GetValue(), HOLE_CLEARANCE_CONSTRAINT, BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), ZONE::IsTeardropArea(), m_board, BOARD_DESIGN_SETTINGS::m_DRCEngine, ADVANCED_CFG::m_ExtraClearance, m_maxError, m_progressReporter, m_worstClearance, Margin, MINOPTMAX< T >::Min(), EDA_IU_SCALE::mmToIU(), pad, PCB_SHAPE_T, PCB_VIA_T, pcbIUScale, PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::Simplify(), BOARD::Tracks(), TransformCircleToPolygon(), via, ZLO_FORCE_NO_ZONE_CONNECTION, and BOARD::Zones().

Referenced by fillCopperZone().

◆ buildThermalSpokes()

void ZONE_FILLER::buildThermalSpokes	(	const ZONE *	box,
		PCB_LAYER_ID	aLayer,
		const std::vector< PAD * > &	aSpokedPadsList,
		std::deque< SHAPE_LINE_CHAIN > &	aSpokes
	)

private

Function buildThermalSpokes Constructs a list of all thermal spokes for the given zone.

Function buildThermalSpokes.

Definition at line 1764 of file zone_filler.cpp.

References SEG::A, SHAPE_LINE_CHAIN::Append(), SEG::B, ClipLine(), epsilon, ERROR_OUTSIDE, BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), PAD::GetBoundingBox(), ZONE::GetBoundingBox(), BOARD::GetDesignSettings(), BOX2< Vec >::GetHeight(), ZONE::GetLocalClearance(), DRC_CONSTRAINT::GetValue(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), SHAPE_LINE_CHAIN::Intersect(), BOX2< Vec >::Intersects(), EDA_IU_SCALE::IU_PER_MM, KiROUND(), m_board, BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD_DESIGN_SETTINGS::m_MaxError, m_maxError, MINOPTMAX< T >::Max(), MINOPTMAX< T >::Min(), BOX2< Vec >::Move(), BOX2< Vec >::Offset(), MINOPTMAX< T >::Opt(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), pad, pcbIUScale, VECTOR2< T >::Resize(), SEG::Reverse(), RotatePoint(), SHAPE_LINE_CHAIN::SetClosed(), PAD::SetOffset(), PAD::SetOrientation(), BOARD_ITEM::SetParentGroup(), PAD::SetPosition(), THERMAL_RELIEF_GAP_CONSTRAINT, THERMAL_SPOKE_WIDTH_CONSTRAINT, DRC_CONSTRAINT::Value(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by fillCopperZone().

◆ Fill()

bool ZONE_FILLER::Fill	(	const std::vector< ZONE * > &	aZones,
		bool	aCheck = `false`,
		wxWindow *	aParent = `nullptr`
	)

Fills the given list of zones.

NB: Invalidates connectivity - it is up to the caller to obtain a lock on the connectivity data before calling Fill to prevent access to stale data by other coroutines (for example, ratsnest redraw). This will generally be required if a UI-based progress reporter has been installed.

Caller is also responsible for re-building connectivity afterwards.

Definition at line 90 of file zone_filler.cpp.

References _, SHAPE_POLY_SET::AddOutline(), PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::AdvanceProgress(), LSET::AllCuMask(), SHAPE_POLY_SET::Area(), SHAPE_LINE_CHAIN::Area(), SHAPE_POLY_SET::BooleanIntersection(), ZONE::CacheTriangulation(), SHAPE_POLY_SET::Collide(), LSET::Contains(), KIDIALOG::DoNotShowCheckbox(), ERROR_OUTSIDE, fillSingleZone(), BOARD::Footprints(), ZONE::GetAssignedPriority(), BOARD_ITEM::GetBoard(), BOARD::GetBoardPolygonOutlines(), ZONE::GetBoundingBox(), BOARD::GetConnectivity(), BOARD::GetCopperLayerCount(), BOARD::GetEnabledLayers(), GetKiCadThreadPool(), ZONE::GetLock(), BOARD::GetMaxClearanceValue(), BOARD_CONNECTED_ITEM::GetNetCode(), ZONE::HigherPriority(), BOX2< Vec >::Inflate(), LSET::InternalCuMask(), BOX2< Vec >::Intersects(), PROGRESS_REPORTER::IsCancelled(), PROGRESS_REPORTER::KeepRefreshing(), m_board, m_boardOutline, m_brdOutlinesValid, m_commit, m_debugZoneFiller, m_progressReporter, m_worstClearance, COMMIT::Modify(), ZONE::Outline(), pad, PCB_VIA_T, SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::RemoveAllContours(), PROGRESS_REPORTER::Report(), LSET::Seq(), ZONE::SetFilledPolysList(), ZONE::SetFillFlag(), PROGRESS_REPORTER::SetMaxProgress(), KIDIALOG::SetOKCancelLabels(), KIDIALOG::ShowModal(), tp, BOARD::Tracks(), UNDEFINED_LAYER, via, ZLO_FORCE_FLASHED, ZLO_FORCE_NO_ZONE_CONNECTION, and BOARD::Zones().

Referenced by KI_TEST::FillZones(), and DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow().

◆ fillCopperZone()

bool ZONE_FILLER::fillCopperZone	(	const ZONE *	aZone,
		PCB_LAYER_ID	aLayer,
		PCB_LAYER_ID	aDebugLayer,
		const SHAPE_POLY_SET &	aSmoothedOutline,
		const SHAPE_POLY_SET &	aMaxExtents,
		SHAPE_POLY_SET &	aFillPolys
	)

private

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

1 - Creates the main zone outline using a correction to shrink the resulting area by m_ZoneMinThickness / 2.

Parameters

aPcb	the current board

The result is areas with a margin of m_ZoneMinThickness / 2 so that when drawing outline with segments having a thickness of m_ZoneMinThickness the outlines will match exactly the initial outlines 2 - Knocks out thermal reliefs around thermally-connected pads 3 - Builds a set of thermal spoke for the whole zone 4 - Knocks out unconnected copper items, deleting any affected spokes 5 - Removes unconnected copper islands, deleting any affected spokes 6 - Adds in the remaining spokes

Definition at line 1414 of file zone_filler.cpp.

References addHatchFillTypeOnZone(), addHoleKnockout(), SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), SHAPE_POLY_SET::BuildBBoxCaches(), buildCopperItemClearances(), buildThermalSpokes(), SHAPE_POLY_SET::CloneDropTriangulation(), SHAPE_POLY_SET::Contains(), SHAPE_POLY_SET::Deflate(), SHAPE_POLY_SET::DeletePolygon(), DUMP_POLYS_TO_COPPER_LAYER, epsilon, SHAPE_POLY_SET::Fracture(), BOARD::GetDesignSettings(), ZONE::GetFillMode(), ZONE::GetMinThickness(), BOX2< Vec >::GetSizeMax(), In15_Cu, In16_Cu, In17_Cu, In18_Cu, In1_Cu, In2_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, SHAPE_POLY_SET::Inflate(), PROGRESS_REPORTER::IsCancelled(), knockoutThermalReliefs(), m_board, m_debugZoneFiller, BOARD_DESIGN_SETTINGS::m_MaxError, m_maxError, m_progressReporter, BOX2< Vec >::Merge(), EDA_IU_SCALE::mmToIU(), SHAPE_POLY_SET::OutlineCount(), pad, pcbIUScale, SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::Polygon(), and subtractHigherPriorityZones().

Referenced by fillSingleZone().

◆ fillNonCopperZone()

bool ZONE_FILLER::fillNonCopperZone	(	const ZONE *	aZone,
		PCB_LAYER_ID	aLayer,
		const SHAPE_POLY_SET &	aSmoothedOutline,
		SHAPE_POLY_SET &	aFillPolys
	)

private

◆ fillSingleZone()

bool ZONE_FILLER::fillSingleZone	(	ZONE *	aZone,
		PCB_LAYER_ID	aLayer,
		SHAPE_POLY_SET &	aFillPolys
	)

private

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

Returns: true if OK, false if the solid polygons cannot be built

Parameters

aZone	is the zone to fill
aFillPolys	A reference to a SHAPE_POLY_SET buffer to store polygons with no holes (holes are linked to main outline by overlapping segments, and these polygons are shrunk by aZone->GetMinThickness() / 2 to be drawn with a outline thickness = aZone->GetMinThickness() aFillPolys are polygons that will be drawn on screen and plotted

Definition at line 1727 of file zone_filler.cpp.

References ZONE::BuildSmoothedPoly(), F_Cu, fillCopperZone(), fillNonCopperZone(), LSET::InternalCuMask(), PROGRESS_REPORTER::IsCancelled(), ZONE::IsOnCopperLayer(), m_boardOutline, m_brdOutlinesValid, m_debugZoneFiller, m_progressReporter, ZONE::SetNeedRefill(), and UNDEFINED_LAYER.

Referenced by Fill().

◆ GetProgressReporter()

PROGRESS_REPORTER * ZONE_FILLER::GetProgressReporter ( ) const

inline

Definition at line 46 of file zone_filler.h.

References m_progressReporter.

◆ IsDebug()

bool ZONE_FILLER::IsDebug ( ) const

inline

Definition at line 60 of file zone_filler.h.

References m_debugZoneFiller.

◆ knockoutThermalReliefs()

void ZONE_FILLER::knockoutThermalReliefs	(	const ZONE *	aZone,
		PCB_LAYER_ID	aLayer,
		SHAPE_POLY_SET &	aFill,
		std::vector< PAD * > &	aThermalConnectionPads,
		std::vector< PAD * > &	aNoConnectionPads
	)