An adjunct helper to the DRAWING_TOOL interactive tool, which handles incoming geometry changes from a POLYGON_GEOM_MANAGER and translates that into a ZONE based on given parameters. More...

#include <zone_create_helper.h>

Inheritance diagram for ZONE_CREATE_HELPER:

Classes
struct	PARAMS
	Parameters used to fully describe a zone creation process. More...

Public Member Functions
	ZONE_CREATE_HELPER (DRAWING_TOOL &aTool, PARAMS &aParams)

virtual	~ZONE_CREATE_HELPER ()

ZONE *	GetZone () const

void	OnGeometryChange (const POLYGON_GEOM_MANAGER &aMgr) override
	Called when the polygon is complete.

bool	OnFirstPoint (POLYGON_GEOM_MANAGER &aMgr) override
	Called before the first point is added - clients can do initialization here, and can veto the start of the process (e.g.

void	OnComplete (const POLYGON_GEOM_MANAGER &aMgr) override

std::unique_ptr< ZONE >	createNewZone (bool aKeepout)
	Prompt the user for new zone settings, and create a new zone with those settings.

std::unique_ptr< ZONE >	createZoneFromExisting (const ZONE &aSrcZone)
	Create a new zone with the settings from an existing zone.

void	performZoneCutout (ZONE &aZone, const ZONE &aCutout)
	Cut one zone out of another one (i.e.

void	commitZone (std::unique_ptr< ZONE > aZone)
	Commit the current zone-in-progress to the BOARD.

Private Member Functions
void	setUniquePriority (ZONE_SETTINGS &aZoneInfo)
	Choose a new priority for @aZoneInfo.

Private Attributes
DRAWING_TOOL &	m_tool
	Parameters of the zone to be drawn.

PARAMS &	m_params
	The preview item to display.

KIGFX::PREVIEW::POLYGON_ITEM	m_previewItem
	view that show the preview item

KIGFX::VIEW &	m_parentView
	The zone-in-progress.

std::unique_ptr< ZONE >	m_zone

Detailed Description

An adjunct helper to the DRAWING_TOOL interactive tool, which handles incoming geometry changes from a POLYGON_GEOM_MANAGER and translates that into a ZONE based on given parameters.

Definition at line 42 of file zone_create_helper.h.

Constructor & Destructor Documentation

◆ ZONE_CREATE_HELPER()

ZONE_CREATE_HELPER::ZONE_CREATE_HELPER	(	DRAWING_TOOL &	aTool,
		PARAMS &	aParams
	)

Parameters

aTool	the DRAWING_TOOL to provide the zone tool to.
aParams	the parameters to use to guide the zone creation.

Definition at line 38 of file zone_create_helper.cpp.

References KIGFX::VIEW::Add(), m_parentView, and m_previewItem.

◆ ~ZONE_CREATE_HELPER()

ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER ( )

virtual

Definition at line 47 of file zone_create_helper.cpp.

References m_parentView, m_previewItem, KIGFX::VIEW::Remove(), and KIGFX::VIEW::SetVisible().

Member Function Documentation

◆ commitZone()

void ZONE_CREATE_HELPER::commitZone ( std::unique_ptr< ZONE > aZone )

Commit the current zone-in-progress to the BOARD.

This might be adding a new zone, or modifying an existing zone with a cutout, depending on parameters.

Parameters

aZone is the drawn zone outline to commit.

Definition at line 213 of file zone_create_helper.cpp.

References _, COMMIT::Add(), B_CrtYd, Edge_Cuts, F_CrtYd, BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetLineThickness(), TOOL_BASE::GetManager(), TOOL_BASE::getModel(), PCB_BASE_FRAME::GetModel(), DRAWING_TOOL::m_frame, ZONE_CREATE_HELPER::PARAMS::m_layer, ZONE_CREATE_HELPER::PARAMS::m_mode, m_params, ZONE_CREATE_HELPER::PARAMS::m_sourceZone, m_tool, performZoneCutout(), BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), ACTIONS::selectItem, EDA_SHAPE::SetFilled(), PCB_SHAPE::SetLayer(), EDA_SHAPE::SetPolyShape(), EDA_SHAPE::SetShape(), and PCB_SHAPE::SetStroke().

Referenced by OnComplete().

◆ createNewZone()

std::unique_ptr< ZONE > ZONE_CREATE_HELPER::createNewZone ( bool aKeepout )

Prompt the user for new zone settings, and create a new zone with those settings.

Parameters

aKeepout should the zone be a keepout

Returns: the new zone, can be null if the user aborted

Definition at line 87 of file zone_create_helper.cpp.

References LSET::AllCuMask(), PCB_TOOL_BASE::board(), SELECTION::Empty(), ZONE_SETTINGS::ExportSetting(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getEditFrame(), SELECTION::GetItems(), TOOL_BASE::GetManager(), PCB_BASE_FRAME::GetModel(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetViewControls(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), DRAWING_TOOL::m_frame, PCB_TOOL_BASE::m_isFootprintEditor, ZONE_CREATE_HELPER::PARAMS::m_keepout, ZONE_CREATE_HELPER::PARAMS::m_layer, ZONE_SETTINGS::m_LayerProperties, ZONE_SETTINGS::m_Layers, ZONE_CREATE_HELPER::PARAMS::m_mode, ZONE_SETTINGS::m_Netcode, m_params, m_tool, PCB_FOOTPRINT_T, BASE_SET::reset(), BASE_SET::set(), EDA_DRAW_PANEL_GAL::SetFocus(), ZONE_SETTINGS::SetIsRuleArea(), setUniquePriority(), EDA_ITEM::Type(), and KIGFX::VIEW_CONTROLS::WarpMouseCursor().

Referenced by OnFirstPoint().

◆ createZoneFromExisting()

std::unique_ptr< ZONE > ZONE_CREATE_HELPER::createZoneFromExisting ( const ZONE & aSrcZone )

Create a new zone with the settings from an existing zone.

Parameters

aSrcZone the zone to copy settings from

Returns: the new zone

Definition at line 149 of file zone_create_helper.cpp.

References ZONE_SETTINGS::ExportSetting(), TOOL_BASE::getModel(), and m_tool.

Referenced by OnFirstPoint().

◆ GetZone()

ZONE * ZONE_CREATE_HELPER::GetZone ( ) const

inline

Definition at line 74 of file zone_create_helper.h.

References m_zone.

Referenced by DRAWING_TOOL::DrawZone().

◆ OnComplete()

void ZONE_CREATE_HELPER::OnComplete ( const POLYGON_GEOM_MANAGER & aMgr )

overridevirtual

◆ OnFirstPoint()

bool ZONE_CREATE_HELPER::OnFirstPoint ( POLYGON_GEOM_MANAGER & aMgr )

overridevirtual

Called before the first point is added - clients can do initialization here, and can veto the start of the process (e.g.

if user cancels a dialog)

Returns: false to veto start of new polygon Sent when the polygon geometry changes

Implements POLYGON_GEOM_MANAGER::CLIENT.

Definition at line 261 of file zone_create_helper.cpp.

References color, createNewZone(), createZoneFromExisting(), POLYGON_GEOM_MANAGER::DEG45, POLYGON_GEOM_MANAGER::DIRECT, KIGFX::RENDER_SETTINGS::GetColor(), TOOL_BASE::GetManager(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PCB_TOOL_BASE::Is45Limited(), ZONE_CREATE_HELPER::PARAMS::m_keepout, m_params, m_parentView, m_previewItem, ZONE_CREATE_HELPER::PARAMS::m_sourceZone, m_tool, m_zone, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::SetFillColor(), POLYGON_GEOM_MANAGER::SetLeaderMode(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::SetStrokeColor(), and KIGFX::VIEW::SetVisible().

◆ OnGeometryChange()

void ZONE_CREATE_HELPER::OnGeometryChange ( const POLYGON_GEOM_MANAGER & aMgr )

overridevirtual

Called when the polygon is complete.

Implements POLYGON_GEOM_MANAGER::CLIENT.

Definition at line 293 of file zone_create_helper.cpp.

References KIGFX::GEOMETRY, POLYGON_GEOM_MANAGER::GetLeaderLinePoints(), POLYGON_GEOM_MANAGER::GetLockedInPoints(), POLYGON_GEOM_MANAGER::GetLoopLinePoints(), POLYGON_GEOM_MANAGER::IsPolygonInProgress(), m_parentView, m_previewItem, m_zone, KIGFX::PREVIEW::POLYGON_ITEM::SetPoints(), KIGFX::VIEW::SetVisible(), and KIGFX::VIEW::Update().

Referenced by DRAWING_TOOL::DrawZone().

◆ performZoneCutout()

void ZONE_CREATE_HELPER::performZoneCutout	(	ZONE &	aZone,
		const ZONE &	aCutout
	)

Cut one zone out of another one (i.e.

subtraction) and update the zone..

Parameters

aZone	the zone to removed area from
aCutout	the area to remove

Definition at line 164 of file zone_create_helper.cpp.

References _, COMMIT::Add(), SHAPE_POLY_SET::AddHole(), SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::BooleanSubtract(), SHAPE_POLY_SET::CHole(), TOOL_BASE::GetManager(), ZONE::HatchBorder(), SHAPE_POLY_SET::HoleCount(), m_params, ZONE_CREATE_HELPER::PARAMS::m_sourceZone, m_tool, ZONE::Outline(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), BOARD_COMMIT::Push(), COMMIT::Remove(), TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, ACTIONS::selectItem, ZONE::SetLocalFlags(), ZONE::SetOutline(), and ZONE::UnFill().

Referenced by commitZone().

◆ setUniquePriority()

void ZONE_CREATE_HELPER::setUniquePriority ( ZONE_SETTINGS & aZoneInfo )

private

Choose a new priority for @aZoneInfo.

This will be the lowest unused zone priority number

Parameters

aZoneInfo ZONE_SETTINGS to apply the new priority number to

Definition at line 55 of file zone_create_helper.cpp.

References LSET::AllCuMask(), PCB_BASE_FRAME::GetBoard(), TOOL_BASE::getEditFrame(), m_tool, and ZONE_SETTINGS::m_ZonePriority.

Referenced by createNewZone().

Member Data Documentation

◆ m_params

PARAMS& ZONE_CREATE_HELPER::m_params

private

The preview item to display.

Definition at line 130 of file zone_create_helper.h.

Referenced by commitZone(), createNewZone(), OnFirstPoint(), and performZoneCutout().

◆ m_parentView

KIGFX::VIEW& ZONE_CREATE_HELPER::m_parentView

private

The zone-in-progress.

Definition at line 136 of file zone_create_helper.h.

Referenced by OnComplete(), OnFirstPoint(), OnGeometryChange(), ZONE_CREATE_HELPER(), and ~ZONE_CREATE_HELPER().

◆ m_previewItem

KIGFX::PREVIEW::POLYGON_ITEM ZONE_CREATE_HELPER::m_previewItem

private

view that show the preview item

Definition at line 133 of file zone_create_helper.h.

Referenced by OnComplete(), OnFirstPoint(), OnGeometryChange(), ZONE_CREATE_HELPER(), and ~ZONE_CREATE_HELPER().

◆ m_tool

DRAWING_TOOL& ZONE_CREATE_HELPER::m_tool

private

Parameters of the zone to be drawn.

Definition at line 127 of file zone_create_helper.h.

Referenced by commitZone(), createNewZone(), createZoneFromExisting(), OnFirstPoint(), performZoneCutout(), and setUniquePriority().

◆ m_zone

std::unique_ptr<ZONE> ZONE_CREATE_HELPER::m_zone

private

Definition at line 139 of file zone_create_helper.h.

Referenced by GetZone(), OnComplete(), OnFirstPoint(), and OnGeometryChange().

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZONE_CREATE_HELPER()

◆ ~ZONE_CREATE_HELPER()

Member Function Documentation

◆ commitZone()

◆ createNewZone()

◆ createZoneFromExisting()

◆ GetZone()

◆ OnComplete()

◆ OnFirstPoint()

◆ OnGeometryChange()

◆ performZoneCutout()

◆ setUniquePriority()

Member Data Documentation

◆ m_params

◆ m_parentView

◆ m_previewItem

◆ m_tool

◆ m_zone