#include <pcb_grid_helper.h>

Inheritance diagram for PCB_GRID_HELPER:

Public Types
enum	ANCHOR_FLAGS { CORNER = 1 , OUTLINE = 2 , SNAPPABLE = 4 , ORIGIN = 8 , VERTICAL = 16 , HORIZONTAL = 32 , CONSTRUCTED = 64 , ALL = CORNER \| OUTLINE \| SNAPPABLE \| ORIGIN \| VERTICAL \| HORIZONTAL \| CONSTRUCTED }

Public Member Functions
	PCB_GRID_HELPER (TOOL_MANAGER aToolMgr, MAGNETIC_SETTINGS aMagneticSettings)

	~PCB_GRID_HELPER () override

BOARD_ITEM *	GetSnapped () const
	Function GetSnapped If the PCB_GRID_HELPER has highlighted a snap point (target shown), this function will return a pointer to the item to which it snapped.

VECTOR2I	AlignToSegment (const VECTOR2I &aPoint, const SEG &aSeg)

VECTOR2I	BestDragOrigin (const VECTOR2I &aMousePos, std::vector< BOARD_ITEM * > &aItem, GRID_HELPER_GRIDS aGrid=GRID_HELPER_GRIDS::GRID_CURRENT, const PCB_SELECTION_FILTER_OPTIONS *aSelectionFilter=nullptr)

VECTOR2I	AlignToArc (const VECTOR2I &aPoint, const SHAPE_ARC &aSeg)

VECTOR2I	SnapToPad (const VECTOR2I &aMousePos, std::deque< PAD * > &aPads)

virtual void	OnBoardItemRemoved (BOARD &aBoard, BOARD_ITEM *aBoardItem) override

VECTOR2I	BestSnapAnchor (const VECTOR2I &aOrigin, BOARD_ITEM *aReferenceItem, GRID_HELPER_GRIDS aGrid=GRID_HELPER_GRIDS::GRID_CURRENT)
	Chooses the "best" snap anchor around the given point, optionally taking layers from the reference item.

VECTOR2I	BestSnapAnchor (const VECTOR2I &aOrigin, const LSET &aLayers, GRID_HELPER_GRIDS aGrid=GRID_HELPER_GRIDS::GRID_CURRENT, const std::vector< BOARD_ITEM * > &aSkip={})

GRID_HELPER_GRIDS	GetItemGrid (const EDA_ITEM *aItem) const override
	Get the coarsest grid that applies to an item.

VECTOR2D	GetGridSize (GRID_HELPER_GRIDS aGrid) const override
	Return the size of the specified grid.

void	AddConstructionItems (std::vector< BOARD_ITEM * > aItems, bool aExtensionOnly, bool aIsPersistent)
	Add construction geometry for a set of board items.

virtual VECTOR2I	Align (const VECTOR2I &aPoint, GRID_HELPER_GRIDS aGrid) const

virtual VECTOR2I	Align (const VECTOR2I &aPoint) const

virtual VECTOR2I	Align (const VECTOR2I &aPoint, const VECTOR2D &aGrid, const VECTOR2D &aOffset) const

virtual VECTOR2I	AlignGrid (const VECTOR2I &aPoint, GRID_HELPER_GRIDS aGrid) const

VECTOR2I	AlignGrid (const VECTOR2I &aPoint) const

VECTOR2I	AlignGrid (const VECTOR2I &aPoint, const VECTOR2D &aGrid, const VECTOR2D &aOffset) const

VECTOR2I	GetGrid () const

VECTOR2D	GetVisibleGrid () const

VECTOR2I	GetOrigin () const

void	SetAuxAxes (bool aEnable, const VECTOR2I &aOrigin=VECTOR2I(0, 0))

virtual GRID_HELPER_GRIDS	GetSelectionGrid (const SELECTION &aSelection) const
	Gets the coarsest grid that applies to a selecion of items.

void	SetSkipPoint (const VECTOR2I &aPoint)

void	ClearSkipPoint ()
	Clear the skip point by setting it to an unreachable position, thereby preventing matching.

void	SetSnap (bool aSnap)

bool	GetSnap () const

void	SetUseGrid (bool aSnapToGrid)

bool	GetUseGrid () const

void	SetSnapLine (bool aSnap)

void	SetMask (int aMask)

void	SetMaskFlag (int aFlag)

void	ClearMaskFlag (int aFlag)

std::optional< VECTOR2I >	GetSnappedPoint () const

virtual void	OnBoardItemAdded (BOARD &aBoard, BOARD_ITEM *aBoardItem)

virtual void	OnBoardItemsAdded (BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)

virtual void	OnBoardItemsRemoved (BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)

virtual void	OnBoardNetSettingsChanged (BOARD &aBoard)

virtual void	OnBoardItemChanged (BOARD &aBoard, BOARD_ITEM *aBoardItem)

virtual void	OnBoardItemsChanged (BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)

virtual void	OnBoardHighlightNetChanged (BOARD &aBoard)

virtual void	OnBoardRatsnestChanged (BOARD &aBoard)

virtual void	OnBoardCompositeUpdate (BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aDeletedItems)

Protected Member Functions
void	addAnchor (const VECTOR2I &aPos, int aFlags, EDA_ITEM *aItem, int aPointTypes=POINT_TYPE::PT_NONE)

void	addAnchor (const VECTOR2I &aPos, int aFlags, std::vector< EDA_ITEM * > aItems, int aPointTypes)

void	clearAnchors ()

bool	canUseGrid () const
	Check whether it is possible to use the grid – this depends both on local grid helper settings and global (tool manager) KiCad settings.

VECTOR2I	computeNearest (const VECTOR2I &aPoint, const VECTOR2I &aGrid, const VECTOR2I &aOffset) const

void	showConstructionGeometry (bool aShow)

SNAP_MANAGER &	getSnapManager ()

void	updateSnapPoint (const TYPED_POINT2I &aPoint)

KIGFX::ANCHOR_DEBUG *	enableAndGetAnchorDebug ()
	Enable the anchor debug if permitted and return it.

Protected Attributes
std::vector< ANCHOR >	m_anchors

TOOL_MANAGER *	m_toolMgr

std::optional< VECTOR2I >	m_auxAxis

int	m_maskTypes

bool	m_enableSnap

bool	m_enableGrid

bool	m_enableSnapLine

std::optional< ANCHOR >	m_snapItem

VECTOR2I	m_skipPoint

KIGFX::SNAP_INDICATOR	m_viewSnapPoint

KIGFX::ORIGIN_VIEWITEM	m_viewAxis

Private Member Functions
std::vector< BOARD_ITEM * >	queryVisible (const BOX2I &aArea, const std::vector< BOARD_ITEM * > &aSkip) const

ANCHOR *	nearestAnchor (const VECTOR2I &aPos, int aFlags)
	Find the nearest anchor point to the given position with matching flags.

void	computeAnchors (const std::vector< BOARD_ITEM * > &aItems, const VECTOR2I &aRefPos, bool aFrom, const PCB_SELECTION_FILTER_OPTIONS aSelectionFilter, const LSET aLayers, bool aForDrag)
	computeAnchors inserts the local anchor points in to the grid helper for the specified container of board items, including points implied by intersections or other relationships between the items.

void	computeAnchors (BOARD_ITEM aItem, const VECTOR2I &aRefPos, bool aFrom, const PCB_SELECTION_FILTER_OPTIONS aSelectionFilter)
	computeAnchors inserts the local anchor points in to the grid helper for the specified board item, given the reference point and the direction of use for the point.

Private Attributes
MAGNETIC_SETTINGS *	m_magneticSettings

std::vector< NEARABLE_GEOM >	m_pointOnLineCandidates

KIGFX::CONSTRUCTION_GEOM	m_constructionGeomPreview
	Show construction geometry (if any) on the canvas.

SNAP_MANAGER	m_snapManager
	Manage the construction geometry, snap lines, reference points, etc.

std::unique_ptr< KIGFX::ANCHOR_DEBUG >	m_anchorDebug
	#VIEW_ITEM for visualising anchor points, if enabled.

Detailed Description

Definition at line 44 of file pcb_grid_helper.h.

Member Enumeration Documentation

◆ ANCHOR_FLAGS

enum GRID_HELPER::ANCHOR_FLAGS

inherited

Enumerator
CORNER
OUTLINE
SNAPPABLE
ORIGIN
VERTICAL
HORIZONTAL
CONSTRUCTED
ALL

Definition at line 125 of file grid_helper.h.

Constructor & Destructor Documentation

◆ PCB_GRID_HELPER()

PCB_GRID_HELPER::PCB_GRID_HELPER	(	TOOL_MANAGER *	aToolMgr,
		MAGNETIC_SETTINGS *	aMagneticSettings
	)

Definition at line 144 of file pcb_grid_helper.cpp.

References KIGFX::VIEW::Add(), KIGFX::ORIGIN_VIEWITEM::CIRCLE_CROSS, KIGFX::ORIGIN_VIEWITEM::CROSS, KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetView(), LAYER_AUX_ITEMS, GRID_HELPER::m_toolMgr, GRID_HELPER::m_viewAxis, GRID_HELPER::m_viewSnapPoint, KIGFX::ORIGIN_VIEWITEM::SetColor(), KIGFX::ORIGIN_VIEWITEM::SetDrawAtZero(), KIGFX::ORIGIN_VIEWITEM::SetSize(), KIGFX::ORIGIN_VIEWITEM::SetStyle(), KIGFX::VIEW::SetVisible(), and KIGFX::COLOR4D::WithAlpha().

◆ ~PCB_GRID_HELPER()

PCB_GRID_HELPER::~PCB_GRID_HELPER ( )

override

Definition at line 167 of file pcb_grid_helper.cpp.

References TOOL_MANAGER::GetView(), GRID_HELPER::m_toolMgr, GRID_HELPER::m_viewAxis, GRID_HELPER::m_viewSnapPoint, and KIGFX::VIEW::Remove().

Member Function Documentation

◆ addAnchor() [1/2]

void GRID_HELPER::addAnchor	(	const VECTOR2I &	aPos,
		int	aFlags,
		EDA_ITEM *	aItem,
		int	aPointTypes = `POINT_TYPE::PT_NONE`
	)

inlineprotectedinherited

Definition at line 178 of file grid_helper.h.

References GRID_HELPER::addAnchor().

Referenced by GRID_HELPER::addAnchor(), computeAnchors(), and EE_GRID_HELPER::computeAnchors().

◆ addAnchor() [2/2]

void GRID_HELPER::addAnchor	(	const VECTOR2I &	aPos,
		int	aFlags,
		std::vector< EDA_ITEM * >	aItems,
		int	aPointTypes
	)

inlineprotectedinherited

Definition at line 184 of file grid_helper.h.

References GRID_HELPER::m_anchors, and GRID_HELPER::m_maskTypes.

◆ AddConstructionItems()

void PCB_GRID_HELPER::AddConstructionItems	(	std::vector< BOARD_ITEM * >	aItems,
		bool	aExtensionOnly,
		bool	aIsPersistent
	)

Add construction geometry for a set of board items.

Parameters

aItems	The items for which to add construction geometry
aExtensionOnly	If true, the construction geometry only includes extensions of the items, if false it also overlays the items themselves.
aIsPersistent	If true, the construction geometry is considered "persistent" and will always be shown and won't be replaced by later temporary geometry.

Definition at line 176 of file pcb_grid_helper.cpp.

References CONSTRUCTION_MANAGER::FROM_ITEMS, EDA_SHAPE::GetArcMid(), PCB_SHAPE::GetCenter(), ADVANCED_CFG::GetCfg(), SNAP_MANAGER::GetConstructionManager(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), GRID_HELPER::getSnapManager(), EDA_SHAPE::GetStart(), PCB_SHAPE_T, CONSTRUCTION_MANAGER::ProposeConstructionItems(), SNAP_MANAGER::SetReferenceOnlyPoints(), and EDA_ITEM::Type().

Referenced by BestSnapAnchor().

◆ Align() [1/3]

VECTOR2I GRID_HELPER::Align ( const VECTOR2I & aPoint ) const

virtual

Reimplemented from GRID_HELPER.

Definition at line 75 of file grid_helper.cpp.

◆ Align() [2/3]

VECTOR2I GRID_HELPER::Align	(	const VECTOR2I &	aPoint,
		const VECTOR2D &	aGrid,
		const VECTOR2D &	aOffset
	)		const

virtual

Reimplemented from GRID_HELPER.

Definition at line 76 of file grid_helper.cpp.

References TOOL_MANAGER::GetView(), GRID_HELPER::m_constructionGeomPreview, GRID_HELPER::m_toolMgr, and KIGFX::VIEW::Remove().

◆ Align() [3/3]

virtual VECTOR2I GRID_HELPER::Align	(	const VECTOR2I &	aPoint,
		GRID_HELPER_GRIDS	aGrid
	)		const

inlinevirtual

Reimplemented from GRID_HELPER.

Definition at line 65 of file grid_helper.h.

Referenced by AlignToArc(), AlignToSegment(), BestSnapAnchor(), PNS::TOOL_BASE::snapToItem(), and PNS::TOOL_BASE::updateEndItem().

◆ AlignGrid() [1/3]

VECTOR2I GRID_HELPER::AlignGrid ( const VECTOR2I & aPoint ) const

Definition at line 79 of file grid_helper.cpp.

◆ AlignGrid() [2/3]

VECTOR2I GRID_HELPER::AlignGrid	(	const VECTOR2I &	aPoint,
		const VECTOR2D &	aGrid,
		const VECTOR2D &	aOffset
	)		const

Definition at line 80 of file grid_helper.cpp.

◆ AlignGrid() [3/3]

virtual VECTOR2I GRID_HELPER::AlignGrid	(	const VECTOR2I &	aPoint,
		GRID_HELPER_GRIDS	aGrid
	)		const

inlinevirtual

Reimplemented from GRID_HELPER.

Definition at line 70 of file grid_helper.h.

◆ AlignToArc()

VECTOR2I PCB_GRID_HELPER::AlignToArc	(	const VECTOR2I &	aPoint,
		const SHAPE_ARC &	aSeg
	)

Definition at line 349 of file pcb_grid_helper.cpp.

References Align(), VECTOR2< int32_t >::ECOORD_MAX, SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_ARC::IntersectLine(), and GRID_HELPER::m_enableSnap.

Referenced by PNS::TOOL_BASE::snapToItem().

◆ AlignToSegment()

VECTOR2I PCB_GRID_HELPER::AlignToSegment	(	const VECTOR2I &	aPoint,
		const SEG &	aSeg
	)

Definition at line 294 of file pcb_grid_helper.cpp.

References SEG::A, Align(), SEG::B, VECTOR2< int32_t >::ECOORD_MAX, SEG::IntersectLines(), GRID_HELPER::m_enableSnap, and SEG::SquaredDistance().

Referenced by DRAWING_TOOL::DrawVia(), and PNS::TOOL_BASE::snapToItem().

◆ BestDragOrigin()

VECTOR2I PCB_GRID_HELPER::BestDragOrigin	(	const VECTOR2I &	aMousePos,
		std::vector< BOARD_ITEM * > &	aItem,
		GRID_HELPER_GRIDS	aGrid = `GRID_HELPER_GRIDS::GRID_CURRENT`,
		const PCB_SELECTION_FILTER_OPTIONS *	aSelectionFilter = `nullptr`
	)

Definition at line 425 of file pcb_grid_helper.cpp.

References GRID_HELPER::clearAnchors(), computeAnchors(), GRID_HELPER::CORNER, GRID_HELPER::ANCHOR::Distance(), TOOL_MANAGER::GetView(), GRID_HELPER::m_toolMgr, nearestAnchor(), GRID_HELPER::ORIGIN, GRID_HELPER::OUTLINE, GRID_HELPER::ANCHOR::pos, and KIGFX::VIEW::ToWorld().

◆ BestSnapAnchor() [1/2]

VECTOR2I PCB_GRID_HELPER::BestSnapAnchor	(	const VECTOR2I &	aOrigin,
		BOARD_ITEM *	aReferenceItem,
		GRID_HELPER_GRIDS	aGrid = `GRID_HELPER_GRIDS::GRID_CURRENT`
	)

Chooses the "best" snap anchor around the given point, optionally taking layers from the reference item.

The reference item will not be snapped to (it is being dragged or created) and we choose the layers that can be snapped based on the reference item layer

Parameters

aOrigin	Point we want to snap from
aReferenceItem	Reference item for layer/type special casing

Returns: snapped screen point

Definition at line 471 of file pcb_grid_helper.cpp.

References LSET::AllLayersMask(), BestSnapAnchor(), and BOARD_ITEM::GetLayerSet().

Referenced by BestSnapAnchor().

◆ BestSnapAnchor() [2/2]

VECTOR2I PCB_GRID_HELPER::BestSnapAnchor	(	const VECTOR2I &	aOrigin,
		const LSET &	aLayers,
		GRID_HELPER_GRIDS	aGrid = `GRID_HELPER_GRIDS::GRID_CURRENT`,
		const std::vector< BOARD_ITEM * > &	aSkip = `{}`
	)

Definition at line 491 of file pcb_grid_helper.cpp.

References AddConstructionItems(), Align(), MAGNETIC_SETTINGS::allLayers, anchor, BOX2ISafe(), CONSTRUCTION_MANAGER::CancelProposal(), GRID_HELPER::clearAnchors(), SNAP_LINE_MANAGER::ClearSnapLine(), computeAnchors(), GRID_HELPER::CONSTRUCTED, GRID_HELPER::ANCHOR::Distance(), GRID_HELPER::enableAndGetAnchorDebug(), GRID_HELPER::ANCHOR::flags, KIGFX::GEOMETRY, ADVANCED_CFG::GetCfg(), SNAP_MANAGER::GetConstructionManager(), BOARD_ITEM::GetLayerSet(), GetNearestPoint(), SNAP_LINE_MANAGER::GetNearestSnapLinePoint(), SNAP_MANAGER::GetReferenceOnlyPoints(), SNAP_MANAGER::GetSnapLineManager(), GRID_HELPER::getSnapManager(), TOOL_MANAGER::GetView(), GRID_HELPER::GetVisibleGrid(), EDA_ITEM::HitTest(), CONSTRUCTION_MANAGER::InvolvesAllGivenRealItems(), GRID_HELPER::ANCHOR::items, KiROUND(), GRID_HELPER::m_anchors, ADVANCED_CFG::m_EnableExtensionSnaps, GRID_HELPER::m_enableGrid, GRID_HELPER::m_enableSnap, GRID_HELPER::m_enableSnapLine, ADVANCED_CFG::m_ExtensionSnapActivateOnHover, m_magneticSettings, m_pointOnLineCandidates, GRID_HELPER::m_skipPoint, GRID_HELPER::m_snapItem, GRID_HELPER::m_toolMgr, GRID_HELPER::m_viewSnapPoint, nearestAnchor(), GRID_HELPER::ANCHOR::pos, queryVisible(), SNAP_LINE_MANAGER::SetSnapLineEnd(), SNAP_LINE_MANAGER::SetSnapLineOrigin(), SNAP_LINE_MANAGER::SetSnappedAnchor(), KIGFX::SNAP_INDICATOR::SetSnapTypes(), KIGFX::VIEW::SetVisible(), GRID_HELPER::showConstructionGeometry(), GRID_HELPER::SNAPPABLE, KIGFX::VIEW::ToWorld(), KIGFX::VIEW::Update(), and GRID_HELPER::updateSnapPoint().

◆ canUseGrid()

bool GRID_HELPER::canUseGrid ( ) const

protectedinherited

Check whether it is possible to use the grid – this depends both on local grid helper settings and global (tool manager) KiCad settings.

Definition at line 228 of file grid_helper.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSnapping(), TOOL_MANAGER::GetView(), GRID_HELPER::m_enableGrid, and GRID_HELPER::m_toolMgr.

Referenced by GRID_HELPER::Align(), and EE_GRID_HELPER::BestSnapAnchor().

◆ clearAnchors()

void GRID_HELPER::clearAnchors ( )

inlineprotectedinherited

Definition at line 191 of file grid_helper.h.

References GRID_HELPER::m_anchors.

Referenced by EE_GRID_HELPER::BestDragOrigin(), BestDragOrigin(), BestSnapAnchor(), EE_GRID_HELPER::BestSnapAnchor(), and SnapToPad().

◆ ClearMaskFlag()

void GRID_HELPER::ClearMaskFlag ( int aFlag )

inlineinherited

Definition at line 121 of file grid_helper.h.

References GRID_HELPER::m_maskTypes.

◆ ClearSkipPoint()

void GRID_HELPER::ClearSkipPoint ( )

inlineinherited

Clear the skip point by setting it to an unreachable position, thereby preventing matching.

Definition at line 106 of file grid_helper.h.

References GRID_HELPER::m_skipPoint.

◆ computeAnchors() [1/2]

void PCB_GRID_HELPER::computeAnchors	(	BOARD_ITEM *	aItem,
		const VECTOR2I &	aRefPos,
		bool	aFrom,
		const PCB_SELECTION_FILTER_OPTIONS *	aSelectionFilter
	)

private

computeAnchors inserts the local anchor points in to the grid helper for the specified board item, given the reference point and the direction of use for the point.

Parameters

aItem	The board item for which to compute the anchors
aRefPos	The point for which to compute the anchors (if used by the component)
aFrom	Is this for an anchor that is designating a source point (aFrom=true) or not

If we are getting a drag point, we don't want to center the edge of pads

Definition at line 1065 of file pcb_grid_helper.cpp.

◆ computeAnchors() [2/2]

void PCB_GRID_HELPER::computeAnchors	(	const std::vector< BOARD_ITEM * > &	aItems,
		const VECTOR2I &	aRefPos,
		bool	aFrom,
		const PCB_SELECTION_FILTER_OPTIONS *	aSelectionFilter,
		const LSET *	aLayers,
		bool	aForDrag
	)

private

computeAnchors inserts the local anchor points in to the grid helper for the specified container of board items, including points implied by intersections or other relationships between the items.

Definition at line 908 of file pcb_grid_helper.cpp.

References GRID_HELPER::addAnchor(), MAGNETIC_SETTINGS::allLayers, computeAnchors(), GRID_HELPER::CONSTRUCTED, PCB_INTERSECTABLE::Geometry, BOARD_ITEM::GetLayerSet(), GRID_HELPER::getSnapManager(), PCB_SELECTION_FILTER_OPTIONS::graphics, PCB_INTERSECTABLE::Item, m_magneticSettings, m_pointOnLineCandidates, PCB_ARC_T, PCB_SHAPE_T, PCB_TRACE_T, GRID_HELPER::SNAPPABLE, PCB_SELECTION_FILTER_OPTIONS::tracks, and EDA_ITEM::Type().

Referenced by BestDragOrigin(), BestSnapAnchor(), computeAnchors(), and SnapToPad().

◆ computeNearest()

VECTOR2I GRID_HELPER::computeNearest	(	const VECTOR2I &	aPoint,
		const VECTOR2I &	aGrid,
		const VECTOR2I &	aOffset
	)		const

protectedinherited

Definition at line 193 of file grid_helper.cpp.

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

Referenced by GRID_HELPER::AlignGrid().

◆ enableAndGetAnchorDebug()

KIGFX::ANCHOR_DEBUG * GRID_HELPER::enableAndGetAnchorDebug ( )

protectedinherited

Enable the anchor debug if permitted and return it.

Returns nullptr if not permitted by the advancd config

Definition at line 85 of file grid_helper.cpp.

References KIGFX::VIEW::Add(), ADVANCED_CFG::GetCfg(), TOOL_MANAGER::GetView(), GRID_HELPER::m_anchorDebug, ADVANCED_CFG::m_EnableSnapAnchorsDebug, GRID_HELPER::m_toolMgr, and KIGFX::VIEW::SetVisible().

Referenced by BestSnapAnchor(), and EE_GRID_HELPER::BestSnapAnchor().

◆ GetGrid()

VECTOR2I GRID_HELPER::GetGrid ( ) const

inherited

Definition at line 119 of file grid_helper.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSize(), TOOL_MANAGER::GetView(), KiROUND(), GRID_HELPER::m_toolMgr, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GRID_HELPER::Align(), GRID_HELPER::AlignGrid(), computeAnchors(), and PNS::TOOL_BASE::pickSingleItem().

◆ GetGridSize()

VECTOR2D PCB_GRID_HELPER::GetGridSize ( GRID_HELPER_GRIDS aGrid ) const

overridevirtual

Return the size of the specified grid.

Reimplemented from GRID_HELPER.

Definition at line 780 of file pcb_grid_helper.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridSize(), TOOL_MANAGER::GetSettings(), TOOL_MANAGER::GetView(), grid, WINDOW_SETTINGS::grid, GRID_CONNECTABLE, GRID_GRAPHICS, GRID_TEXT, GRID_VIAS, GRID_WIRES, GRID_HELPER::m_toolMgr, APP_SETTINGS_BASE::m_Window, and pcbIUScale.

◆ GetItemGrid()

GRID_HELPER_GRIDS PCB_GRID_HELPER::GetItemGrid ( const EDA_ITEM * aItem ) const

overridevirtual

Get the coarsest grid that applies to an item.

Reimplemented from GRID_HELPER.

Definition at line 746 of file pcb_grid_helper.cpp.

References GRID_CONNECTABLE, GRID_CURRENT, GRID_GRAPHICS, GRID_TEXT, GRID_VIAS, GRID_WIRES, PCB_ARC_T, PCB_DIMENSION_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

◆ GetOrigin()

VECTOR2I GRID_HELPER::GetOrigin ( ) const

inherited

Definition at line 133 of file grid_helper.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridOrigin(), TOOL_MANAGER::GetView(), and GRID_HELPER::m_toolMgr.

Referenced by GRID_HELPER::Align(), and GRID_HELPER::AlignGrid().

◆ GetSelectionGrid()

GRID_HELPER_GRIDS GRID_HELPER::GetSelectionGrid ( const SELECTION & aSelection ) const

virtualinherited

Gets the coarsest grid that applies to a selecion of items.

Reimplemented in EE_GRID_HELPER.

Definition at line 141 of file grid_helper.cpp.

References SELECTION::Front(), GRID_HELPER::GetGridSize(), GRID_HELPER::GetItemGrid(), and grid.

◆ GetSnap()

bool GRID_HELPER::GetSnap ( ) const

inlineinherited

Definition at line 112 of file grid_helper.h.

References GRID_HELPER::m_enableSnap.

Referenced by DRAWING_TOOL::DrawVia(), and PNS::TOOL_BASE::updateEndItem().

◆ getSnapManager()

SNAP_MANAGER & GRID_HELPER::getSnapManager ( )

inlineprotectedinherited

Definition at line 208 of file grid_helper.h.

References GRID_HELPER::m_snapManager.

Referenced by AddConstructionItems(), BestSnapAnchor(), EE_GRID_HELPER::BestSnapAnchor(), and computeAnchors().

◆ GetSnapped()

BOARD_ITEM * PCB_GRID_HELPER::GetSnapped ( ) const

Function GetSnapped If the PCB_GRID_HELPER has highlighted a snap point (target shown), this function will return a pointer to the item to which it snapped.

Returns: NULL if not snapped. Pointer to snapped item otherwise

Definition at line 732 of file pcb_grid_helper.cpp.

References GRID_HELPER::m_snapItem.

◆ GetSnappedPoint()

std::optional< VECTOR2I > GRID_HELPER::GetSnappedPoint ( ) const

inherited

Definition at line 234 of file grid_helper.cpp.

References GRID_HELPER::m_snapItem.

Referenced by PCB_PICKER_TOOL::SelectPointInteractively().

◆ GetUseGrid()

bool GRID_HELPER::GetUseGrid ( ) const

inlineinherited

Definition at line 115 of file grid_helper.h.

References GRID_HELPER::m_enableGrid.

Referenced by PNS::TOOL_BASE::updateStartItem().

◆ GetVisibleGrid()

VECTOR2D GRID_HELPER::GetVisibleGrid ( ) const

inherited

Definition at line 127 of file grid_helper.cpp.

References KIGFX::VIEW::GetGAL(), TOOL_MANAGER::GetView(), KIGFX::GAL::GetVisibleGridSize(), and GRID_HELPER::m_toolMgr.

Referenced by BestSnapAnchor().

◆ nearestAnchor()

PCB_GRID_HELPER::ANCHOR * PCB_GRID_HELPER::nearestAnchor	(	const VECTOR2I &	aPos,
		int	aFlags
	)

private

Find the nearest anchor point to the given position with matching flags.

Parameters

return The nearest anchor point, or nullptr if none found

Definition at line 1582 of file pcb_grid_helper.cpp.

References anchor, and GRID_HELPER::m_anchors.

Referenced by BestDragOrigin(), and BestSnapAnchor().

◆ OnBoardCompositeUpdate()

virtual void BOARD_LISTENER::OnBoardCompositeUpdate	(	BOARD &	aBoard,
		std::vector< BOARD_ITEM * > &	aAddedItems,
		std::vector< BOARD_ITEM * > &	aRemovedItems,
		std::vector< BOARD_ITEM * > &	aDeletedItems
	)