#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 , ALL = CORNER \| OUTLINE \| SNAPPABLE \| ORIGIN \| VERTICAL \| HORIZONTAL }

Public Member Functions
	PCB_GRID_HELPER (TOOL_MANAGER aToolMgr, MAGNETIC_SETTINGS aMagneticSettings)

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

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

VECTOR2I	BestDragOrigin (const VECTOR2I &aMousePos, std::vector< BOARD_ITEM * > &aItem, const SELECTION_FILTER_OPTIONS *aSelectionFilter=nullptr)

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

VECTOR2I	AlignToNearestPad (const VECTOR2I &aMousePos, PADS &aPads)

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

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

VECTOR2I	GetGrid () const

VECTOR2I	GetVisibleGrid () const

VECTOR2I	GetOrigin () const

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

virtual VECTOR2I	Align (const VECTOR2I &aPoint) const

VECTOR2I	AlignGrid (const VECTOR2I &aPoint) const

void	SetSkipPoint (const VECTOR2I &aPoint)

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

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)

Protected Member Functions
void	addAnchor (const VECTOR2I &aPos, int aFlags, EDA_ITEM *aItem)

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

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

ANCHOR *	m_snapItem

VECTOR2I	m_skipPoint

KIGFX::ORIGIN_VIEWITEM	m_viewSnapPoint

KIGFX::ORIGIN_VIEWITEM	m_viewSnapLine

KIGFX::ORIGIN_VIEWITEM	m_viewAxis

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

ANCHOR *	nearestAnchor (const VECTOR2I &aPos, int aFlags, LSET aMatchLayers)

void	computeAnchors (BOARD_ITEM aItem, const VECTOR2I &aRefPos, bool aFrom=false, const SELECTION_FILTER_OPTIONS aSelectionFilter=nullptr)
	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. More...

Private Attributes
MAGNETIC_SETTINGS *	m_magneticSettings

Detailed Description

Definition at line 35 of file pcb_grid_helper.h.

Member Enumeration Documentation

◆ ANCHOR_FLAGS

enum GRID_HELPER::ANCHOR_FLAGS

inherited

Enumerator
CORNER
OUTLINE
SNAPPABLE
ORIGIN
VERTICAL
HORIZONTAL
ALL

Definition at line 77 of file grid_helper.h.

Constructor & Destructor Documentation

◆ PCB_GRID_HELPER()

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

Member Function Documentation

◆ addAnchor()

void GRID_HELPER::addAnchor	(	const VECTOR2I &	aPos,
		int	aFlags,
		EDA_ITEM *	aItem
	)

inlineprotectedinherited

Definition at line 107 of file grid_helper.h.

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

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

◆ Align()

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

virtualinherited

Definition at line 103 of file grid_helper.cpp.

References std::abs(), GRID_HELPER::AlignGrid(), GRID_HELPER::canUseGrid(), GRID_HELPER::m_auxAxis, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ AlignGrid()

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

inherited

Definition at line 91 of file grid_helper.cpp.

References GRID_HELPER::GetGrid(), GRID_HELPER::GetOrigin(), grid, KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GRID_HELPER::Align(), EC_VERTICAL::Apply(), EC_HORIZONTAL::Apply(), EC_45DEGREE::Apply(), EC_LINE::Apply(), and EE_POINT_EDITOR::pinEditedCorner().

◆ AlignToArc()

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

Definition at line 134 of file pcb_grid_helper.cpp.

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

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

◆ AlignToNearestPad()

VECTOR2I PCB_GRID_HELPER::AlignToNearestPad	(	const VECTOR2I &	aMousePos,
		PADS &	aPads
	)

Definition at line 179 of file pcb_grid_helper.cpp.

References GRID_HELPER::clearAnchors(), computeAnchors(), EDA_ITEM::HitTest(), GRID_HELPER::m_anchors, GRID_HELPER::ORIGIN, and GRID_HELPER::ANCHOR::pos.

◆ AlignToSegment()

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

Definition at line 79 of file pcb_grid_helper.cpp.

References SEG::A, GRID_HELPER::Align(), SEG::B, VECTOR2< int >::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,
		const SELECTION_FILTER_OPTIONS *	aSelectionFilter = `nullptr`
	)

Definition at line 212 of file pcb_grid_helper.cpp.

References LSET::AllLayersMask(), GRID_HELPER::clearAnchors(), computeAnchors(), GRID_HELPER::CORNER, GRID_HELPER::ANCHOR::Distance(), KIGFX::VIEW::GetGAL(), TOOL_MANAGER::GetView(), KIGFX::GAL::GetWorldScale(), GRID_HELPER::m_toolMgr, nearestAnchor(), GRID_HELPER::ORIGIN, GRID_HELPER::OUTLINE, and GRID_HELPER::ANCHOR::pos.

◆ BestSnapAnchor() [1/2]

VECTOR2I PCB_GRID_HELPER::BestSnapAnchor	(	const VECTOR2I &	aOrigin,
		BOARD_ITEM *	aReferenceItem
	)

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 259 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,
		const std::vector< BOARD_ITEM * > &	aSkip = `{}`
	)

Allows de-snapping from the line if you are closer to another snap point

Definition at line 278 of file pcb_grid_helper.cpp.

References std::abs(), GRID_HELPER::Align(), GRID_HELPER::clearAnchors(), computeAnchors(), GRID_HELPER::ANCHOR::Distance(), KIGFX::GEOMETRY, KIGFX::VIEW::GetGAL(), KIGFX::ORIGIN_VIEWITEM::GetPosition(), TOOL_MANAGER::GetView(), GRID_HELPER::GetVisibleGrid(), KIGFX::GAL::GetWorldScale(), KIGFX::VIEW::IsVisible(), KiROUND(), GRID_HELPER::m_enableGrid, GRID_HELPER::m_enableSnap, GRID_HELPER::m_enableSnapLine, GRID_HELPER::m_skipPoint, GRID_HELPER::m_snapItem, GRID_HELPER::m_toolMgr, GRID_HELPER::m_viewSnapLine, GRID_HELPER::m_viewSnapPoint, nearestAnchor(), GRID_HELPER::ANCHOR::pos, queryVisible(), BOX2< Vec >::SetEnd(), KIGFX::ORIGIN_VIEWITEM::SetEndPosition(), BOX2< Vec >::SetOrigin(), KIGFX::ORIGIN_VIEWITEM::SetPosition(), KIGFX::VIEW::SetVisible(), GRID_HELPER::SNAPPABLE, KIGFX::VIEW::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ canUseGrid()

bool GRID_HELPER::canUseGrid ( ) const

inlineprotectedinherited

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 123 of file grid_helper.h.

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 113 of file grid_helper.h.

References GRID_HELPER::m_anchors, and GRID_HELPER::m_snapItem.

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

◆ ClearMaskFlag()

void GRID_HELPER::ClearMaskFlag ( int aFlag )

inlineinherited

Definition at line 75 of file grid_helper.h.

References GRID_HELPER::m_maskTypes.

◆ ClearSkipPoint()

void GRID_HELPER::ClearSkipPoint ( )

inlineinherited

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

Definition at line 60 of file grid_helper.h.

References GRID_HELPER::m_skipPoint.

◆ computeAnchors()

void PCB_GRID_HELPER::computeAnchors	(	BOARD_ITEM *	aItem,
		const VECTOR2I &	aRefPos,
		bool	aFrom = `false`,
		const SELECTION_FILTER_OPTIONS *	aSelectionFilter = `nullptr`
	)

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 416 of file pcb_grid_helper.cpp.

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

◆ GetGrid()

VECTOR2I GRID_HELPER::GetGrid ( ) const

inherited

Definition at line 51 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::AlignGrid(), and computeAnchors().

◆ GetOrigin()

VECTOR2I GRID_HELPER::GetOrigin ( ) const

inherited

Definition at line 67 of file grid_helper.cpp.

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

Referenced by GRID_HELPER::AlignGrid().

◆ GetSnap()

bool GRID_HELPER::GetSnap ( ) const

inlineinherited

Definition at line 66 of file grid_helper.h.

References GRID_HELPER::m_enableSnap.

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

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