#include <ee_grid_helper.h>

Inheritance diagram for EE_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
	EE_GRID_HELPER (TOOL_MANAGER *aToolMgr)

	~EE_GRID_HELPER () override

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

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

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

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

VECTOR2I	BestDragOrigin (const VECTOR2I &aMousePos, GRID_HELPER_GRIDS aGrid, const EE_SELECTION &aItems)

VECTOR2I	BestSnapAnchor (const VECTOR2I &aOrigin, GRID_HELPER_GRIDS aGrid, SCH_ITEM *aSkip)

VECTOR2I	BestSnapAnchor (const VECTOR2I &aOrigin, GRID_HELPER_GRIDS aGrid, const EE_SELECTION &aSkip={})

VECTOR2I	GetGrid () const

VECTOR2D	GetVisibleGrid () const

VECTOR2I	GetOrigin () const

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

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

void	SetSkipPoint (const VECTOR2I &aPoint)

void	ClearSkipPoint ()
	We 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

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::set< SCH_ITEM * >	queryVisible (const BOX2I &aArea, const EE_SELECTION &aSkipList) const

ANCHOR *	nearestAnchor (const VECTOR2I &aPos, int aFlags, GRID_HELPER_GRIDS aGrid)

void	computeAnchors (SCH_ITEM *aItem, const VECTOR2I &aRefPos, bool aFrom=false, bool aIncludeText=false)
	Insert the local anchor points in to the grid helper for the specified schematic item, given the reference point and the direction of use for the point.

Private Attributes
KIGFX::CONSTRUCTION_GEOM	m_constructionGeomPreview

SNAP_MANAGER	m_snapManager

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

Detailed Description

Definition at line 37 of file ee_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

◆ EE_GRID_HELPER()

EE_GRID_HELPER::EE_GRID_HELPER ( TOOL_MANAGER * aToolMgr )

Definition at line 41 of file ee_grid_helper.cpp.

References KIGFX::VIEW::Add(), KIGFX::ORIGIN_VIEWITEM::CIRCLE_CROSS, KIGFX::ORIGIN_VIEWITEM::CROSS, TOOL_MANAGER::GetView(), 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(), and KIGFX::VIEW::SetVisible().

◆ ~EE_GRID_HELPER()

EE_GRID_HELPER::~EE_GRID_HELPER ( )

override

Definition at line 61 of file ee_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 176 of file grid_helper.h.

References GRID_HELPER::addAnchor().

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

◆ addAnchor() [2/2]

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

inlineprotectedinherited

Definition at line 182 of file grid_helper.h.

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

◆ Align() [1/3]

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

virtualinherited

Reimplemented in PCB_GRID_HELPER.

Definition at line 199 of file grid_helper.cpp.

References GRID_HELPER::Align(), GRID_HELPER::GetGrid(), and GRID_HELPER::GetOrigin().

◆ Align() [2/3]

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

virtualinherited

Reimplemented in PCB_GRID_HELPER.

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

◆ Align() [3/3]

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

inlinevirtualinherited

Reimplemented in PCB_GRID_HELPER.

Definition at line 65 of file grid_helper.h.

References GRID_HELPER::Align(), GRID_HELPER::GetGridSize(), and GRID_HELPER::GetOrigin().

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

◆ AlignGrid() [1/3]

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

inherited

Definition at line 178 of file grid_helper.cpp.

References GRID_HELPER::computeNearest(), GRID_HELPER::GetGrid(), and GRID_HELPER::GetOrigin().

◆ AlignGrid() [2/3]

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

inherited

Definition at line 184 of file grid_helper.cpp.

References GRID_HELPER::computeNearest().

◆ AlignGrid() [3/3]

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

inlinevirtualinherited

Reimplemented in PCB_GRID_HELPER.

Definition at line 70 of file grid_helper.h.

References GRID_HELPER::AlignGrid(), GRID_HELPER::GetGridSize(), and GRID_HELPER::GetOrigin().

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

◆ BestDragOrigin()

VECTOR2I EE_GRID_HELPER::BestDragOrigin	(	const VECTOR2I &	aMousePos,
		GRID_HELPER_GRIDS	aGrid,
		const EE_SELECTION &	aItems
	)

Definition at line 70 of file ee_grid_helper.cpp.

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

◆ BestSnapAnchor() [1/2]

VECTOR2I EE_GRID_HELPER::BestSnapAnchor	(	const VECTOR2I &	aOrigin,
		GRID_HELPER_GRIDS	aGrid,
		const EE_SELECTION &	aSkip = `{}`
	)

Definition at line 140 of file ee_grid_helper.cpp.

References std::abs(), GRID_HELPER::Align(), GRID_HELPER::canUseGrid(), GRID_HELPER::clearAnchors(), SNAP_LINE_MANAGER::ClearSnapLine(), computeAnchors(), GRID_HELPER::ANCHOR::Distance(), GRID_HELPER::enableAndGetAnchorDebug(), VECTOR2< T >::EuclideanNorm(), KIGFX::GEOMETRY, SNAP_MANAGER::GetSnapLineManager(), SNAP_LINE_MANAGER::GetSnapLineOrigin(), GRID_HELPER::getSnapManager(), TOOL_MANAGER::GetView(), KIGFX::VIEW::IsVisible(), EDA_IU_SCALE::IU_PER_MILS, GRID_HELPER::m_anchors, GRID_HELPER::m_enableSnap, GRID_HELPER::m_enableSnapLine, GRID_HELPER::m_skipPoint, GRID_HELPER::m_snapItem, GRID_HELPER::m_toolMgr, GRID_HELPER::m_viewSnapPoint, nearestAnchor(), GRID_HELPER::ANCHOR::pos, queryVisible(), schIUScale, KIGFX::ORIGIN_VIEWITEM::SetPosition(), SNAP_LINE_MANAGER::SetSnapLineEnd(), SNAP_LINE_MANAGER::SetSnapLineOrigin(), KIGFX::VIEW::SetVisible(), GRID_HELPER::showConstructionGeometry(), SNAP_RANGE, GRID_HELPER::SNAPPABLE, KIGFX::VIEW::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ BestSnapAnchor() [2/2]

VECTOR2I EE_GRID_HELPER::BestSnapAnchor	(	const VECTOR2I &	aOrigin,
		GRID_HELPER_GRIDS	aGrid,
		SCH_ITEM *	aSkip
	)

Definition at line 130 of file ee_grid_helper.cpp.

References SELECTION::Add(), and BestSnapAnchor().

Referenced by EE_SELECTION_TOOL::autostartEvent(), and BestSnapAnchor().

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

◆ clearAnchors()

void GRID_HELPER::clearAnchors ( )

inlineprotectedinherited

Definition at line 189 of file grid_helper.h.

References GRID_HELPER::m_anchors.

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

◆ 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

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

void EE_GRID_HELPER::computeAnchors	(	SCH_ITEM *	aItem,
		const VECTOR2I &	aRefPos,
		bool	aFrom = `false`,
		bool	aIncludeText = `false`
	)

private

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

Parameters

aItem	The schematic item for which to compute the anchors
aRefPos	The point for which to compute the anchors (if used by the symbol)
aFrom	Is this for an anchor that is designating a source point (aFrom=true) or not
aIncludeText	if true will compute anchors for text items

Definition at line 415 of file ee_grid_helper.cpp.

References GRID_HELPER::addAnchor(), GRID_HELPER::Align(), GRID_HELPER::CORNER, SCH_ITEM::GetConnectionPoints(), SCH_LINE::GetEndPoint(), EDA_ITEM::GetPosition(), SCH_LINE::GetStartPoint(), GRID_HELPER::HORIZONTAL, KI_FALLTHROUGH, GRID_HELPER::ORIGIN, pin, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, GRID_HELPER::SNAPPABLE, TestSegmentHit(), EDA_ITEM::Type(), GRID_HELPER::VERTICAL, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BestDragOrigin(), and BestSnapAnchor().

◆ computeNearest()

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

protectedinherited

Definition at line 191 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 PCB_GRID_HELPER::BestSnapAnchor(), and BestSnapAnchor().

◆ GetGrid()

VECTOR2I GRID_HELPER::GetGrid ( ) const

Definition at line 59 of file grid_helper.cpp.

References KIGFX::GEOMETRY, KIGFX::VIEW::IsVisible(), GRID_HELPER::m_constructionGeomPreview, KIGFX::VIEW::SetVisible(), and KIGFX::VIEW::Update().

◆ GetGridSize()

VECTOR2D EE_GRID_HELPER::GetGridSize ( GRID_HELPER_GRIDS aGrid ) const

overridevirtual

Return the size of the specified grid.

Reimplemented from GRID_HELPER.

Definition at line 264 of file ee_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_WIRES, GRID_HELPER::m_toolMgr, APP_SETTINGS_BASE::m_Window, and schIUScale.

Referenced by GetSelectionGrid().

◆ GetItemGrid()

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

overridevirtual

Gets the coarsest grid that applies to an item.

Reimplemented from GRID_HELPER.

Definition at line 366 of file ee_grid_helper.cpp.

References GRID_CONNECTABLE, GRID_CURRENT, GRID_GRAPHICS, GRID_TEXT, GRID_WIRES, LIB_SYMBOL_T, SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCH_TEXTBOX_T, and EDA_ITEM::Type().

Referenced by EE_SELECTION_TOOL::autostartEvent(), BestDragOrigin(), and GetSelectionGrid().

◆ GetOrigin()

VECTOR2I GRID_HELPER::GetOrigin ( ) const

inherited

Definition at line 131 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 EE_GRID_HELPER::GetSelectionGrid ( const SELECTION & aSelection ) const

overridevirtual

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

Reimplemented from GRID_HELPER.

Definition at line 349 of file ee_grid_helper.cpp.

References SELECTION::Front(), GetGridSize(), 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 206 of file grid_helper.h.

References GRID_HELPER::m_snapManager.

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

◆ GetSnapped()

SCH_ITEM * EE_GRID_HELPER::GetSnapped ( ) const

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