KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | Friends | List of all members
GRID_HELPER Class Reference

#include <grid_helper.h>

Inheritance diagram for GRID_HELPER:
TEST_GRID_HELPER EE_GRID_HELPER PCB_GRID_HELPER TEST_GRID_HELPER

Classes

struct  ANCHOR
 
struct  SNAP_RANGES
 World-space snap thresholds derived from the screen-space snap radius. More...
 

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

 GRID_HELPER ()
 
 GRID_HELPER (TOOL_MANAGER *aToolMgr, int aConstructionLayer)
 
virtual ~GRID_HELPER ()
 
VECTOR2I GetGrid () const
 
VECTOR2D GetVisibleGrid () const
 
VECTOR2I GetOrigin () const
 
virtual void FullReset ()
 Reset all internal state.
 
void SetGridSize (const VECTOR2D &aGrid)
 
void SetVisibleGridSize (const VECTOR2D &aGrid)
 
void SetOrigin (const VECTOR2I &aOrigin)
 
void SetGridSnapping (bool aEnable)
 
void SetAuxAxes (bool aEnable, const VECTOR2I &aOrigin=VECTOR2I(0, 0))
 
virtual VECTOR2I Align (const VECTOR2I &aPoint, GRID_HELPER_GRIDS aGrid) const
 
virtual VECTOR2I AlignGrid (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
 
VECTOR2I AlignGrid (const VECTOR2I &aPoint) const
 
VECTOR2I AlignGrid (const VECTOR2I &aPoint, const VECTOR2D &aGrid, const VECTOR2D &aOffset) const
 
virtual GRID_HELPER_GRIDS GetSelectionGrid (const SELECTION &aSelection) const
 Gets the coarsest grid that applies to a selecion of items.
 
virtual GRID_HELPER_GRIDS GetItemGrid (const EDA_ITEM *aItem) const
 Get the coarsest grid that applies to an item.
 
virtual VECTOR2D GetGridSize (GRID_HELPER_GRIDS aGrid) const
 Return the size of the specified grid.
 
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 SetSnapLineDirections (const std::vector< VECTOR2I > &aDirections)
 
void SetSnapLineOrigin (const VECTOR2I &aOrigin)
 
void SetSnapLineEnd (const std::optional< VECTOR2I > &aEnd)
 
void ClearSnapLine ()
 
std::optional< VECTOR2I > SnapToConstructionLines (const VECTOR2I &aPoint, const VECTOR2I &aNearestGrid, const VECTOR2D &aGrid, double aSnapRange) const
 
void SetMask (int aMask)
 
void SetMaskFlag (int aFlag)
 
void ClearMaskFlag (int aFlag)
 
std::optional< VECTOR2I > GetSnappedPoint () const
 
void SetAngleRestriction (std::optional< VECTOR2I > aOrigin, double aStepDegrees)
 Restrict snapping to a set of angle branches emanating from an origin.
 
void SetPointEditProfile (bool aEnabled)
 
void SetStationarySelfGeometry (std::vector< VECTOR2I > aPoints, std::vector< SEG > aSegments)
 
void SetFeasibilityCallback (SNAP_RESOLVER::FEASIBILITY_CALLBACK aCallback)
 

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
 
SNAP_RANGES computeSnapRanges (bool aClampToVisibleGrid) const
 Compute the snap thresholds.
 
void emitAngleBranchCandidates (std::vector< SNAP_CANDIDATE > &aCandidates, const VECTOR2I &aOrigin, double aSnapScale) const
 Emit the angle-restriction snap candidates (the two branches bracketing the cursor angle) into the current frame.
 
void emitSelfAndGridCandidates (std::vector< SNAP_CANDIDATE > &aCandidates, const SNAP_SOURCE_CONTEXT &aContext, const VECTOR2I &aOrigin, const VECTOR2I &aNearestGrid, double aSnapScale, int aSnapRange, bool aUseGrid) const
 Emit the point editor's unchanged self-geometry and the independent grid axes.
 
SNAP_RESOLVER::TRACE_CALLBACK snapTraceCallback (const SNAP_SOURCE_CONTEXT &aContext) const
 
void retainAcceptedSnaps (const SNAP_RESULT &aResult)
 Record which snaps the resolver accepted so they can be re-biased on the next resolve, and separately track the accepted angle branch for the next frame.
 
void applySnapResultGuides (const SNAP_RESULT &aResult)
 
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.
 
void setLayoutReference (const VECTOR2I &aPoint, const std::optional< BOX2I > &aBounds, bool aAnchorPoint)
 Record the classified drag reference and trace it.
 

Static Protected Member Functions

static SNAP_REFERENCE_PREFERENCE classifyReference (const VECTOR2I &aPoint, const BOX2I &aBounds, bool aAnchorPoint)
 Classify the point a drag was started from against the moving object's bounds.
 

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
 
VECTOR2D m_manualGrid
 
VECTOR2D m_manualVisibleGrid
 
VECTOR2I m_manualOrigin
 
bool m_manualGridSnapping
 
std::optional< VECTOR2I > m_angleOrigin
 
double m_angleStepDegrees = 0.0
 
std::optional< SNAP_STABLE_ID > m_retainedAngleBranch
 
std::vector< SNAP_STABLE_ID > m_stickySnapIds
 
SNAP_RESOLVER::FEASIBILITY_CALLBACK m_feasibilityCallback
 
std::vector< VECTOR2I > m_stationarySelfPoints
 
std::vector< SEG > m_stationarySelfSegments
 
bool m_pointEditProfile = false
 
SNAP_REFERENCE_PREFERENCE m_layoutReferencePreference
 

Private Attributes

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.
 

Friends

void TEST_CLEAR_ANCHORS (GRID_HELPER &helper)
 

Detailed Description

Definition at line 66 of file grid_helper.h.

Member Enumeration Documentation

◆ ANCHOR_FLAGS

enum GRID_HELPER::ANCHOR_FLAGS
Enumerator
CORNER 
OUTLINE 
SNAPPABLE 
ORIGIN 
VERTICAL 
HORIZONTAL 
CONSTRUCTED 
ALL 

Definition at line 197 of file grid_helper.h.

Constructor & Destructor Documentation

◆ GRID_HELPER() [1/2]

GRID_HELPER::GRID_HELPER ( )

Definition at line 41 of file grid_helper.cpp.

References ALL, ClearSkipPoint(), m_constructionGeomPreview, m_enableGrid, m_enableSnap, m_enableSnapLine, m_manualGrid, m_manualGridSnapping, m_manualOrigin, m_manualVisibleGrid, m_maskTypes, m_snapItem, m_snapManager, and m_toolMgr.

Referenced by EE_GRID_HELPER::EE_GRID_HELPER(), EE_GRID_HELPER::EE_GRID_HELPER(), GRID_HELPER(), PCB_GRID_HELPER::PCB_GRID_HELPER(), PCB_GRID_HELPER::PCB_GRID_HELPER(), and TEST_CLEAR_ANCHORS.

◆ GRID_HELPER() [2/2]

GRID_HELPER::GRID_HELPER ( TOOL_MANAGER * aToolMgr,
int aConstructionLayer )

Definition at line 60 of file grid_helper.cpp.

References KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::VIEW::GetPainter(), GRID_HELPER(), m_constructionGeomPreview, and m_toolMgr.

◆ ~GRID_HELPER()

GRID_HELPER::~GRID_HELPER ( )
virtual

Definition at line 105 of file grid_helper.cpp.

References m_toolMgr.

Member Function Documentation

◆ addAnchor() [1/2]

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

Definition at line 249 of file grid_helper.h.

References addAnchor(), and PT_NONE.

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

◆ addAnchor() [2/2]

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

Definition at line 255 of file grid_helper.h.

References m_anchors, and m_maskTypes.

◆ Align() [1/3]

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

Reimplemented in PCB_GRID_HELPER.

Definition at line 537 of file grid_helper.cpp.

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

◆ Align() [2/3]

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

Reimplemented in PCB_GRID_HELPER.

Definition at line 543 of file grid_helper.cpp.

References std::abs(), AlignGrid(), canUseGrid(), 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
inlinevirtual

Reimplemented in PCB_GRID_HELPER.

Definition at line 101 of file grid_helper.h.

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

Referenced by Align(), Align(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::PCBGridHelperTestFixture, and EE_GRID_HELPER::ResolveSnap().

◆ AlignGrid() [1/3]

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

Definition at line 512 of file grid_helper.cpp.

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

◆ AlignGrid() [2/3]

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

Definition at line 518 of file grid_helper.cpp.

References computeNearest(), and KiROUND().

◆ AlignGrid() [3/3]

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

Reimplemented in PCB_GRID_HELPER.

Definition at line 106 of file grid_helper.h.

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

Referenced by Align(), AlignGrid(), AlignSchematicItemsToGrid(), EDIT_RELATION::Apply(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCB_GRID_HELPER::PCBGridHelperTestFixture.

◆ applySnapResultGuides()

void GRID_HELPER::applySnapResultGuides ( const SNAP_RESULT & aResult)
protected

Definition at line 166 of file grid_helper.cpp.

References DIMENSION_BRACKET, SNAP_GUIDE::end, SNAP_RESULT::guides, m_snapManager, SNAP_LINE_MANAGER::SetSnapLineEnd(), SNAP_LINE_MANAGER::SetSnapLineOrigin(), SNAP_GUIDE::start, SNAP_GUIDE::style, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ canUseGrid()

bool GRID_HELPER::canUseGrid ( ) const
protected

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 564 of file grid_helper.cpp.

References m_enableGrid, m_manualGridSnapping, and m_toolMgr.

Referenced by Align(), EE_GRID_HELPER::ResolveSnap(), and SnapToConstructionLines().

◆ classifyReference()

SNAP_REFERENCE_PREFERENCE GRID_HELPER::classifyReference ( const VECTOR2I & aPoint,
const BOX2I & aBounds,
bool aAnchorPoint )
staticprotected

Classify the point a drag was started from against the moving object's bounds.

Layout inference prefers a stationary feature matching the one the user grabbed, so a left-edge grab aligns to left edges and a centre grab aligns to centres. An anchor-point grab (a pad centre or a pin end) instead prefers the stationary anchor points of the same kind, which is what makes pad-to-pad and pin-to-pin alignment feel deliberate.

Parameters
aPointThe drag origin.
aBoundsThe bounds of everything being moved.
aAnchorPointTrue when the drag origin is a published anchor point.

Definition at line 197 of file grid_helper.cpp.

References std::abs(), ANCHOR_POINT, BOUNDS_FEATURE, BOX2< Vec >::Centre(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), index, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCBGridHelperTestFixture::ClassifyReference(), and setLayoutReference().

◆ clearAnchors()

void GRID_HELPER::clearAnchors ( )
inlineprotected

Definition at line 262 of file grid_helper.h.

References m_anchors.

Referenced by EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestDragOrigin(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::SnapToPad(), and TEST_CLEAR_ANCHORS.

◆ ClearMaskFlag()

void GRID_HELPER::ClearMaskFlag ( int aFlag)
inline

Definition at line 165 of file grid_helper.h.

References m_maskTypes.

◆ ClearSkipPoint()

void GRID_HELPER::ClearSkipPoint ( )
inline

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

Definition at line 142 of file grid_helper.h.

References m_skipPoint.

Referenced by BOOST_AUTO_TEST_CASE(), and GRID_HELPER().

◆ ClearSnapLine()

void GRID_HELPER::ClearSnapLine ( )

Definition at line 160 of file grid_helper.cpp.

References m_snapManager.

◆ computeNearest()

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

Definition at line 529 of file grid_helper.cpp.

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

Referenced by AlignGrid(), and AlignGrid().

◆ computeSnapRanges()

GRID_HELPER::SNAP_RANGES GRID_HELPER::computeSnapRanges ( bool aClampToVisibleGrid) const
protected

Compute the snap thresholds.

The radius is clamped to the visible grid so visible grid points always remain reachable.

See also
https://gitlab.com/kicad/code/kicad/-/issues/5638
https://gitlab.com/kicad/code/kicad/-/issues/7125
https://gitlab.com/kicad/code/kicad/-/issues/12303

Definition at line 580 of file grid_helper.cpp.

References ADVANCED_CFG::GetCfg(), GetVisibleGrid(), GRID_HELPER::SNAP_RANGES::in, KiROUND(), ADVANCED_CFG::m_SnapHysteresis, m_toolMgr, GRID_HELPER::SNAP_RANGES::out, GRID_HELPER::SNAP_RANGES::range, GRID_HELPER::SNAP_RANGES::rankingHysteresis, GRID_HELPER::SNAP_RANGES::scale, SNAP_SCREEN_RADIUS, and KIGFX::VIEW::ToWorld().

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ emitAngleBranchCandidates()

void GRID_HELPER::emitAngleBranchCandidates ( std::vector< SNAP_CANDIDATE > & aCandidates,
const VECTOR2I & aOrigin,
double aSnapScale ) const
protected

Emit the angle-restriction snap candidates (the two branches bracketing the cursor angle) into the current frame.

Shared by the derived helpers so the stringly-typed "angle" protocol lives in one place.

Definition at line 601 of file grid_helper.cpp.

References std::abs(), ANGLE, ANGLE_BRANCH, delta, SNAP_CANDIDATE::Line(), m_angleOrigin, m_angleStepDegrees, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ emitSelfAndGridCandidates()

void GRID_HELPER::emitSelfAndGridCandidates ( std::vector< SNAP_CANDIDATE > & aCandidates,
const SNAP_SOURCE_CONTEXT & aContext,
const VECTOR2I & aOrigin,
const VECTOR2I & aNearestGrid,
double aSnapScale,
int aSnapRange,
bool aUseGrid ) const
protected

Emit the point editor's unchanged self-geometry and the independent grid axes.

The two editors disagree on when the grid may be used, so the caller supplies that gate rather than the base guessing at it.

Definition at line 659 of file grid_helper.cpp.

References std::abs(), SNAP_CANDIDATE::AxisX(), SNAP_CANDIDATE::AxisY(), GRID, GRID_AXIS, GRID_X, GRID_Y, INTRINSIC_ANCHOR, m_stationarySelfPoints, MakeDerivedSnapId(), SNAP_SOURCE_CONTEXT::movingItem, OBJECT, SNAP_CANDIDATE::Point(), POINT_EDIT, SNAP_SOURCE_CONTEXT::profile, SELF_ENDPOINT, SELF_POINT, SNAP_SOURCE_CONTEXT::stationarySourceLeg, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ enableAndGetAnchorDebug()

KIGFX::ANCHOR_DEBUG * GRID_HELPER::enableAndGetAnchorDebug ( )
protected

Enable the anchor debug if permitted and return it.

Returns nullptr if not permitted by the advancd config

Definition at line 118 of file grid_helper.cpp.

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

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ FullReset()

virtual void GRID_HELPER::FullReset ( )
inlinevirtual

Reset all internal state.

Used to remove any dangling pointers to items that have been deleted.

Definition at line 83 of file grid_helper.h.

References m_anchors, m_constructionGeomPreview, m_layoutReferencePreference, m_retainedAngleBranch, m_snapManager, and m_stickySnapIds.

◆ GetGrid()

VECTOR2I GRID_HELPER::GetGrid ( ) const

Definition at line 446 of file grid_helper.cpp.

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

Referenced by Align(), AlignGrid(), BOOST_AUTO_TEST_CASE(), PCB_GRID_HELPER::computeAnchors(), and EE_GRID_HELPER::EEGridHelperTestFixture.

◆ GetGridSize()

VECTOR2D GRID_HELPER::GetGridSize ( GRID_HELPER_GRIDS aGrid) const
virtual

Return the size of the specified grid.

Reimplemented in EE_GRID_HELPER, PCB_GRID_HELPER, and TEST_GRID_HELPER.

Definition at line 488 of file grid_helper.cpp.

References m_manualGrid, and m_toolMgr.

Referenced by Align(), AlignGrid(), BOOST_AUTO_TEST_CASE(), and GetSelectionGrid().

◆ GetItemGrid()

virtual GRID_HELPER_GRIDS GRID_HELPER::GetItemGrid ( const EDA_ITEM * aItem) const
inlinevirtual

Get the coarsest grid that applies to an item.

Reimplemented in EE_GRID_HELPER, and PCB_GRID_HELPER.

Definition at line 127 of file grid_helper.h.

References GRID_CURRENT.

Referenced by GetSelectionGrid().

◆ GetOrigin()

VECTOR2I GRID_HELPER::GetOrigin ( ) const

Definition at line 459 of file grid_helper.cpp.

References m_manualOrigin, and m_toolMgr.

Referenced by Align(), Align(), AlignGrid(), AlignGrid(), BOOST_AUTO_TEST_CASE(), and PCB_GRID_HELPER::ResolveSnap().

◆ GetSelectionGrid()

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

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

Definition at line 471 of file grid_helper.cpp.

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

◆ GetSnap()

bool GRID_HELPER::GetSnap ( ) const
inline

Definition at line 148 of file grid_helper.h.

References m_enableSnap.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DRAWING_TOOL::DrawVia().

◆ getSnapManager()

SNAP_MANAGER & GRID_HELPER::getSnapManager ( )
inlineprotected

Definition at line 326 of file grid_helper.h.

References m_snapManager.

Referenced by EE_GRID_HELPER::AddConstructionItems(), PCB_GRID_HELPER::AddConstructionItems(), PCB_GRID_HELPER::ClearSnapFeedback(), PCB_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::nearestAnchor(), PCB_GRID_HELPER::PCB_GRID_HELPER(), EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ GetSnappedPoint()

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

Definition at line 571 of file grid_helper.cpp.

References m_snapItem.

Referenced by BOOST_AUTO_TEST_CASE(), and PCB_PICKER_TOOL::SelectPointInteractively().

◆ GetUseGrid()

bool GRID_HELPER::GetUseGrid ( ) const
inline

Definition at line 151 of file grid_helper.h.

References m_enableGrid.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ GetVisibleGrid()

VECTOR2D GRID_HELPER::GetVisibleGrid ( ) const

Definition at line 453 of file grid_helper.cpp.

References m_manualVisibleGrid, and m_toolMgr.

Referenced by BOOST_AUTO_TEST_CASE(), and computeSnapRanges().

◆ retainAcceptedSnaps()

void GRID_HELPER::retainAcceptedSnaps ( const SNAP_RESULT & aResult)
protected

Record which snaps the resolver accepted so they can be re-biased on the next resolve, and separately track the accepted angle branch for the next frame.

Definition at line 702 of file grid_helper.cpp.

References SNAP_RESULT::accepted, ANGLE_BRANCH, m_retainedAngleBranch, and m_stickySnapIds.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ SetAngleRestriction()

void GRID_HELPER::SetAngleRestriction ( std::optional< VECTOR2I > aOrigin,
double aStepDegrees )
inline

Restrict snapping to a set of angle branches emanating from an origin.

Passing an empty origin clears the restriction and any retained branch so the next resolve starts fresh.

Definition at line 175 of file grid_helper.h.

References m_angleOrigin, m_angleStepDegrees, and m_retainedAngleBranch.

◆ SetAuxAxes()

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

Definition at line 494 of file grid_helper.cpp.

References m_auxAxis, m_toolMgr, and m_viewAxis.

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetFeasibilityCallback()

void GRID_HELPER::SetFeasibilityCallback ( SNAP_RESOLVER::FEASIBILITY_CALLBACK aCallback)
inline

Definition at line 192 of file grid_helper.h.

References m_feasibilityCallback.

◆ SetGridSize()

void GRID_HELPER::SetGridSize ( const VECTOR2D & aGrid)
inline

Definition at line 94 of file grid_helper.h.

References m_manualGrid.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetGridSnapping()

void GRID_HELPER::SetGridSnapping ( bool aEnable)
inline

Definition at line 97 of file grid_helper.h.

References m_manualGridSnapping.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ setLayoutReference()

void GRID_HELPER::setLayoutReference ( const VECTOR2I & aPoint,
const std::optional< BOX2I > & aBounds,
bool aAnchorPoint )
protected

Record the classified drag reference and trace it.

Definition at line 225 of file grid_helper.cpp.

References ANCHOR_POINT, BOUNDS_FEATURE, classifyReference(), and m_layoutReferencePreference.

Referenced by EE_GRID_HELPER::BestDragOrigin(), and PCB_GRID_HELPER::BestDragOrigin().

◆ SetMask()

void GRID_HELPER::SetMask ( int aMask)
inline

Definition at line 163 of file grid_helper.h.

References m_maskTypes.

◆ SetMaskFlag()

void GRID_HELPER::SetMaskFlag ( int aFlag)
inline

Definition at line 164 of file grid_helper.h.

References m_maskTypes.

◆ SetOrigin()

void GRID_HELPER::SetOrigin ( const VECTOR2I & aOrigin)
inline

Definition at line 96 of file grid_helper.h.

References m_manualOrigin.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetPointEditProfile()

void GRID_HELPER::SetPointEditProfile ( bool aEnabled)
inline

Definition at line 184 of file grid_helper.h.

References m_pointEditProfile.

◆ SetSkipPoint()

void GRID_HELPER::SetSkipPoint ( const VECTOR2I & aPoint)
inline

Definition at line 134 of file grid_helper.h.

References m_skipPoint.

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetSnap()

void GRID_HELPER::SetSnap ( bool aSnap)
inline

Definition at line 147 of file grid_helper.h.

References m_enableSnap.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DRAWING_TOOL::DrawVia(), and PCB_PICKER_TOOL::SelectPointInteractively().

◆ SetSnapLine()

void GRID_HELPER::SetSnapLine ( bool aSnap)
inline

Definition at line 153 of file grid_helper.h.

References m_enableSnapLine.

◆ SetSnapLineDirections()

void GRID_HELPER::SetSnapLineDirections ( const std::vector< VECTOR2I > & aDirections)

Definition at line 144 of file grid_helper.cpp.

References m_snapManager.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetSnapLineEnd()

void GRID_HELPER::SetSnapLineEnd ( const std::optional< VECTOR2I > & aEnd)

Definition at line 155 of file grid_helper.cpp.

References m_snapManager.

◆ SetSnapLineOrigin()

void GRID_HELPER::SetSnapLineOrigin ( const VECTOR2I & aOrigin)

Definition at line 150 of file grid_helper.cpp.

References m_snapManager.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetStationarySelfGeometry()

void GRID_HELPER::SetStationarySelfGeometry ( std::vector< VECTOR2I > aPoints,
std::vector< SEG > aSegments )
inline

Definition at line 186 of file grid_helper.h.

References m_stationarySelfPoints, and m_stationarySelfSegments.

◆ SetUseGrid()

void GRID_HELPER::SetUseGrid ( bool aSnapToGrid)
inline

Definition at line 150 of file grid_helper.h.

References m_enableGrid.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetVisibleGridSize()

void GRID_HELPER::SetVisibleGridSize ( const VECTOR2D & aGrid)
inline

Definition at line 95 of file grid_helper.h.

References m_manualVisibleGrid.

Referenced by BOOST_AUTO_TEST_CASE().

◆ showConstructionGeometry()

void GRID_HELPER::showConstructionGeometry ( bool aShow)
protected

Definition at line 137 of file grid_helper.cpp.

References m_constructionGeomPreview, and m_toolMgr.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ SnapToConstructionLines()

std::optional< VECTOR2I > GRID_HELPER::SnapToConstructionLines ( const VECTOR2I & aPoint,
const VECTOR2I & aNearestGrid,
const VECTOR2D & aGrid,
double aSnapRange ) const

Definition at line 244 of file grid_helper.cpp.

References canUseGrid(), delta, VECTOR2< T >::EuclideanNorm(), SNAP_LINE_MANAGER::GetActiveDirection(), SNAP_LINE_MANAGER::GetDirections(), SNAP_LINE_MANAGER::GetSnapLineOrigin(), m_snapManager, traceSnap, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ snapTraceCallback()

SNAP_RESOLVER::TRACE_CALLBACK GRID_HELPER::snapTraceCallback ( const SNAP_SOURCE_CONTEXT & aContext) const
protected

Definition at line 624 of file grid_helper.cpp.

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), SNAP_SOURCE_CONTEXT::movingBounds, SNAP_SOURCE_CONTEXT::movingReferencePoint, BOX2< Vec >::Offset(), SNAP_SOURCE_CONTEXT::sourcePoint, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ updateSnapPoint()

void GRID_HELPER::updateSnapPoint ( const TYPED_POINT2I & aPoint)
protected

Definition at line 431 of file grid_helper.cpp.

References KIGFX::GEOMETRY, TYPED_POINT2I::m_point, m_toolMgr, TYPED_POINT2I::m_types, and m_viewSnapPoint.

Referenced by PCB_GRID_HELPER::ResolveSnap().

Friends And Related Symbol Documentation

◆ TEST_CLEAR_ANCHORS

void TEST_CLEAR_ANCHORS ( GRID_HELPER & helper)
friend

Definition at line 24 of file test_grid_helper.cpp.

References clearAnchors(), and GRID_HELPER().

Member Data Documentation

◆ m_anchorDebug

std::unique_ptr<KIGFX::ANCHOR_DEBUG> GRID_HELPER::m_anchorDebug
private

#VIEW_ITEM for visualising anchor points, if enabled.

Definition at line 397 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::Align(), and enableAndGetAnchorDebug().

◆ m_anchors

std::vector<ANCHOR> GRID_HELPER::m_anchors
protected

Definition at line 337 of file grid_helper.h.

Referenced by addAnchor(), clearAnchors(), FullReset(), EE_GRID_HELPER::nearestAnchor(), PCB_GRID_HELPER::nearestAnchor(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::SnapToPad().

◆ m_angleOrigin

std::optional<VECTOR2I> GRID_HELPER::m_angleOrigin
protected

Definition at line 361 of file grid_helper.h.

Referenced by emitAngleBranchCandidates(), and SetAngleRestriction().

◆ m_angleStepDegrees

double GRID_HELPER::m_angleStepDegrees = 0.0
protected

Definition at line 362 of file grid_helper.h.

Referenced by emitAngleBranchCandidates(), and SetAngleRestriction().

◆ m_auxAxis

std::optional<VECTOR2I> GRID_HELPER::m_auxAxis
protected

Definition at line 340 of file grid_helper.h.

Referenced by Align(), and SetAuxAxes().

◆ m_constructionGeomPreview

KIGFX::CONSTRUCTION_GEOM GRID_HELPER::m_constructionGeomPreview
private

Show construction geometry (if any) on the canvas.

Definition at line 391 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::Align(), FullReset(), EE_GRID_HELPER::GetGrid(), GRID_HELPER(), GRID_HELPER(), and showConstructionGeometry().

◆ m_enableGrid

bool GRID_HELPER::m_enableGrid
protected

Definition at line 345 of file grid_helper.h.

Referenced by canUseGrid(), GetUseGrid(), GRID_HELPER(), PCB_GRID_HELPER::ResolveSnap(), and SetUseGrid().

◆ m_enableSnap

bool GRID_HELPER::m_enableSnap
protected

Definition at line 344 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::AlignToArc(), PCB_GRID_HELPER::AlignToSegment(), GetSnap(), GRID_HELPER(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and SetSnap().

◆ m_enableSnapLine

bool GRID_HELPER::m_enableSnapLine
protected

Definition at line 346 of file grid_helper.h.

Referenced by GRID_HELPER(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and SetSnapLine().

◆ m_feasibilityCallback

SNAP_RESOLVER::FEASIBILITY_CALLBACK GRID_HELPER::m_feasibilityCallback
protected

Definition at line 365 of file grid_helper.h.

Referenced by EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and SetFeasibilityCallback().

◆ m_layoutReferencePreference

SNAP_REFERENCE_PREFERENCE GRID_HELPER::m_layoutReferencePreference
protected

Definition at line 369 of file grid_helper.h.

Referenced by FullReset(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and setLayoutReference().

◆ m_manualGrid

VECTOR2D GRID_HELPER::m_manualGrid
protected

Definition at line 355 of file grid_helper.h.

Referenced by GetGrid(), GetGridSize(), GRID_HELPER(), and SetGridSize().

◆ m_manualGridSnapping

bool GRID_HELPER::m_manualGridSnapping
protected

Definition at line 358 of file grid_helper.h.

Referenced by canUseGrid(), GRID_HELPER(), and SetGridSnapping().

◆ m_manualOrigin

VECTOR2I GRID_HELPER::m_manualOrigin
protected

Definition at line 357 of file grid_helper.h.

Referenced by GetOrigin(), GRID_HELPER(), and SetOrigin().

◆ m_manualVisibleGrid

VECTOR2D GRID_HELPER::m_manualVisibleGrid
protected

Definition at line 356 of file grid_helper.h.

Referenced by GetVisibleGrid(), GRID_HELPER(), and SetVisibleGridSize().

◆ m_maskTypes

int GRID_HELPER::m_maskTypes
protected

Definition at line 342 of file grid_helper.h.

Referenced by addAnchor(), ClearMaskFlag(), GRID_HELPER(), SetMask(), and SetMaskFlag().

◆ m_pointEditProfile

bool GRID_HELPER::m_pointEditProfile = false
protected

Definition at line 368 of file grid_helper.h.

Referenced by EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and SetPointEditProfile().

◆ m_retainedAngleBranch

std::optional<SNAP_STABLE_ID> GRID_HELPER::m_retainedAngleBranch
protected

Definition at line 363 of file grid_helper.h.

Referenced by FullReset(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), retainAcceptedSnaps(), and SetAngleRestriction().

◆ m_skipPoint

VECTOR2I GRID_HELPER::m_skipPoint
protected

Definition at line 349 of file grid_helper.h.

Referenced by ClearSkipPoint(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and SetSkipPoint().

◆ m_snapItem

std::optional<ANCHOR> GRID_HELPER::m_snapItem
protected

Definition at line 347 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::ClearSnapFeedback(), EE_GRID_HELPER::GetSnapped(), PCB_GRID_HELPER::GetSnapped(), GetSnappedPoint(), GRID_HELPER(), PCB_GRID_HELPER::OnBoardItemRemoved(), PCB_GRID_HELPER::OnBoardItemsRemoved(), EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ m_snapManager

SNAP_MANAGER GRID_HELPER::m_snapManager
private

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

Definition at line 394 of file grid_helper.h.

Referenced by applySnapResultGuides(), ClearSnapLine(), FullReset(), EE_GRID_HELPER::GetGrid(), getSnapManager(), GRID_HELPER(), SetSnapLineDirections(), SetSnapLineEnd(), SetSnapLineOrigin(), and SnapToConstructionLines().

◆ m_stationarySelfPoints

std::vector<VECTOR2I> GRID_HELPER::m_stationarySelfPoints
protected

Definition at line 366 of file grid_helper.h.

Referenced by emitSelfAndGridCandidates(), and SetStationarySelfGeometry().

◆ m_stationarySelfSegments

std::vector<SEG> GRID_HELPER::m_stationarySelfSegments
protected

Definition at line 367 of file grid_helper.h.

Referenced by EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and SetStationarySelfGeometry().

◆ m_stickySnapIds

std::vector<SNAP_STABLE_ID> GRID_HELPER::m_stickySnapIds
protected

Definition at line 364 of file grid_helper.h.

Referenced by FullReset(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), and retainAcceptedSnaps().

◆ m_toolMgr

TOOL_MANAGER* GRID_HELPER::m_toolMgr
protected

Definition at line 339 of file grid_helper.h.

Referenced by EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestDragOrigin(), canUseGrid(), PCB_GRID_HELPER::ClearSnapFeedback(), PCB_GRID_HELPER::computeAnchors(), computeSnapRanges(), PCB_GRID_HELPER::editingInsideFootprint(), EE_GRID_HELPER::EE_GRID_HELPER(), enableAndGetAnchorDebug(), EE_GRID_HELPER::GetGrid(), GetGrid(), EE_GRID_HELPER::GetGridSize(), GetGridSize(), PCB_GRID_HELPER::GetGridSize(), GetOrigin(), GetVisibleGrid(), GRID_HELPER(), GRID_HELPER(), PCB_GRID_HELPER::PCB_GRID_HELPER(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), SetAuxAxes(), showConstructionGeometry(), EE_GRID_HELPER::snapInferenceSettings(), PCB_GRID_HELPER::snapInferenceSettings(), updateSnapPoint(), EE_GRID_HELPER::~EE_GRID_HELPER(), ~GRID_HELPER(), and PCB_GRID_HELPER::~PCB_GRID_HELPER().

◆ m_viewAxis

KIGFX::ORIGIN_VIEWITEM GRID_HELPER::m_viewAxis
protected

Definition at line 352 of file grid_helper.h.

Referenced by EE_GRID_HELPER::EE_GRID_HELPER(), PCB_GRID_HELPER::PCB_GRID_HELPER(), SetAuxAxes(), EE_GRID_HELPER::~EE_GRID_HELPER(), and PCB_GRID_HELPER::~PCB_GRID_HELPER().

◆ m_viewSnapPoint

KIGFX::SNAP_INDICATOR GRID_HELPER::m_viewSnapPoint
protected

Definition at line 351 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::ClearSnapFeedback(), EE_GRID_HELPER::EE_GRID_HELPER(), PCB_GRID_HELPER::PCB_GRID_HELPER(), EE_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), updateSnapPoint(), EE_GRID_HELPER::~EE_GRID_HELPER(), and PCB_GRID_HELPER::~PCB_GRID_HELPER().

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