KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | 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:
EE_GRID_HELPER PCB_GRID_HELPER

Classes

struct  ANCHOR
 

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

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
 
VECTOR2D m_manualGrid
 
VECTOR2D m_manualVisibleGrid
 
VECTOR2I m_manualOrigin
 
bool m_manualGridSnapping
 

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

Constructor & Destructor Documentation

◆ GRID_HELPER() [1/2]

GRID_HELPER::GRID_HELPER ( )

Definition at line 42 of file grid_helper.cpp.

References ALL, 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 58 of file grid_helper.cpp.

References GRID_HELPER(), and m_toolMgr.

◆ ~GRID_HELPER()

GRID_HELPER::~GRID_HELPER ( )
virtual

Definition at line 97 of file grid_helper.cpp.

References m_anchorDebug, m_constructionGeomPreview, m_toolMgr, 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 )
inlineprotected

Definition at line 196 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 202 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 449 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 455 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 75 of file grid_helper.h.

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

Referenced by Align(), Align(), EE_GRID_HELPER::BestSnapAnchor(), 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(), and PCB_GRID_HELPER::PCBGridHelperTestFixture.

◆ AlignGrid() [1/3]

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

Definition at line 428 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 434 of file grid_helper.cpp.

References computeNearest().

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

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

Referenced by Align(), AlignGrid(), EC_45DEGREE::Apply(), EC_90DEGREE::Apply(), EC_HORIZONTAL::Apply(), EC_LINE::Apply(), EC_VERTICAL::Apply(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCB_GRID_HELPER::PCBGridHelperTestFixture.

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

References m_enableGrid, m_manualGridSnapping, and m_toolMgr.

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

◆ clearAnchors()

void GRID_HELPER::clearAnchors ( )
inlineprotected

Definition at line 209 of file grid_helper.h.

References m_anchors.

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

◆ ClearMaskFlag()

void GRID_HELPER::ClearMaskFlag ( int aFlag)
inline

Definition at line 139 of file grid_helper.h.

References m_maskTypes.

Referenced by BOOST_AUTO_TEST_CASE().

◆ ClearSkipPoint()

void GRID_HELPER::ClearSkipPoint ( )
inline

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

Definition at line 116 of file grid_helper.h.

References m_skipPoint.

Referenced by BOOST_AUTO_TEST_CASE().

◆ ClearSnapLine()

void GRID_HELPER::ClearSnapLine ( )

Definition at line 152 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 441 of file grid_helper.cpp.

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

Referenced by AlignGrid(), and AlignGrid().

◆ 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 110 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::BestSnapAnchor(), and PCB_GRID_HELPER::BestSnapAnchor().

◆ GetGrid()

VECTOR2I GRID_HELPER::GetGrid ( ) const

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

◆ GetGridSize()

VECTOR2D GRID_HELPER::GetGridSize ( GRID_HELPER_GRIDS aGrid) const
virtual

Return the size of the specified grid.

Reimplemented in EE_GRID_HELPER, and PCB_GRID_HELPER.

Definition at line 404 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 101 of file grid_helper.h.

References GRID_CURRENT.

Referenced by GetSelectionGrid().

◆ GetOrigin()

VECTOR2I GRID_HELPER::GetOrigin ( ) const

Definition at line 375 of file grid_helper.cpp.

References m_manualOrigin, and m_toolMgr.

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

◆ GetSelectionGrid()

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

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

Reimplemented in EE_GRID_HELPER.

Definition at line 387 of file grid_helper.cpp.

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

◆ GetSnap()

bool GRID_HELPER::GetSnap ( ) const
inline

Definition at line 122 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 226 of file grid_helper.h.

References m_snapManager.

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

◆ GetSnappedPoint()

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

Definition at line 483 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 125 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 369 of file grid_helper.cpp.

References m_manualVisibleGrid, and m_toolMgr.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), and BOOST_AUTO_TEST_CASE().

◆ SetAuxAxes()

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

Definition at line 410 of file grid_helper.cpp.

References m_auxAxis, m_toolMgr, and m_viewAxis.

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetGridSize()

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

Definition at line 68 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(), and BOOST_AUTO_TEST_CASE().

◆ SetGridSnapping()

void GRID_HELPER::SetGridSnapping ( bool aEnable)
inline

Definition at line 71 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(), and BOOST_AUTO_TEST_CASE().

◆ SetMask()

void GRID_HELPER::SetMask ( int aMask)
inline

Definition at line 137 of file grid_helper.h.

References m_maskTypes.

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetMaskFlag()

void GRID_HELPER::SetMaskFlag ( int aFlag)
inline

Definition at line 138 of file grid_helper.h.

References m_maskTypes.

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetOrigin()

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

Definition at line 70 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(), and BOOST_AUTO_TEST_CASE().

◆ SetSkipPoint()

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

Definition at line 108 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 121 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 127 of file grid_helper.h.

References m_enableSnapLine.

◆ SetSnapLineDirections()

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

Definition at line 136 of file grid_helper.cpp.

References m_snapManager.

◆ SetSnapLineEnd()

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

Definition at line 147 of file grid_helper.cpp.

References m_snapManager.

◆ SetSnapLineOrigin()

void GRID_HELPER::SetSnapLineOrigin ( const VECTOR2I & aOrigin)

Definition at line 142 of file grid_helper.cpp.

References m_snapManager.

◆ SetUseGrid()

void GRID_HELPER::SetUseGrid ( bool aSnapToGrid)
inline

Definition at line 124 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 69 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 129 of file grid_helper.cpp.

References m_constructionGeomPreview, and m_toolMgr.

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

◆ SnapToConstructionLines()

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

Definition at line 158 of file grid_helper.cpp.

References std::abs(), canUseGrid(), delta, VECTOR2< T >::Dot(), VECTOR2< T >::EuclideanNorm(), SNAP_LINE_MANAGER::GetActiveDirection(), SNAP_LINE_MANAGER::GetDirections(), GetOrigin(), SNAP_LINE_MANAGER::GetSnapLineOrigin(), KiROUND(), m_skipPoint, m_snapManager, traceSnap, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ updateSnapPoint()

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

Definition at line 347 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::BestSnapAnchor().

Friends And Related Symbol Documentation

◆ TEST_CLEAR_ANCHORS

void TEST_CLEAR_ANCHORS ( GRID_HELPER & helper)
friend

Definition at line 23 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 268 of file grid_helper.h.

Referenced by enableAndGetAnchorDebug(), and ~GRID_HELPER().

◆ m_anchors

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

Definition at line 237 of file grid_helper.h.

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

◆ m_auxAxis

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

Definition at line 240 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 262 of file grid_helper.h.

Referenced by EE_GRID_HELPER::GetGrid(), GRID_HELPER(), showConstructionGeometry(), and ~GRID_HELPER().

◆ m_enableGrid

bool GRID_HELPER::m_enableGrid
protected

Definition at line 245 of file grid_helper.h.

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

◆ m_enableSnap

bool GRID_HELPER::m_enableSnap
protected

Definition at line 244 of file grid_helper.h.

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

◆ m_enableSnapLine

bool GRID_HELPER::m_enableSnapLine
protected

Definition at line 246 of file grid_helper.h.

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

◆ m_manualGrid

VECTOR2D GRID_HELPER::m_manualGrid
protected

Definition at line 255 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::AlignGrid(), GetGrid(), GetGridSize(), GRID_HELPER(), and SetGridSize().

◆ m_manualGridSnapping

bool GRID_HELPER::m_manualGridSnapping
protected

Definition at line 258 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::AlignGrid(), canUseGrid(), GRID_HELPER(), and SetGridSnapping().

◆ m_manualOrigin

VECTOR2I GRID_HELPER::m_manualOrigin
protected

Definition at line 257 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::AlignGrid(), GetOrigin(), GRID_HELPER(), and SetOrigin().

◆ m_manualVisibleGrid

VECTOR2D GRID_HELPER::m_manualVisibleGrid
protected

Definition at line 256 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::AlignGrid(), GetVisibleGrid(), GRID_HELPER(), and SetVisibleGridSize().

◆ m_maskTypes

int GRID_HELPER::m_maskTypes
protected

Definition at line 242 of file grid_helper.h.

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

◆ m_skipPoint

VECTOR2I GRID_HELPER::m_skipPoint
protected

Definition at line 249 of file grid_helper.h.

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

◆ m_snapItem

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

Definition at line 247 of file grid_helper.h.

Referenced by EE_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), EE_GRID_HELPER::GetSnapped(), PCB_GRID_HELPER::GetSnapped(), GetSnappedPoint(), GRID_HELPER(), and PCB_GRID_HELPER::OnBoardItemRemoved().

◆ m_snapManager

SNAP_MANAGER GRID_HELPER::m_snapManager
private

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

Definition at line 265 of file grid_helper.h.

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

◆ m_toolMgr

TOOL_MANAGER* GRID_HELPER::m_toolMgr
protected

Definition at line 239 of file grid_helper.h.

Referenced by PCB_GRID_HELPER::Align(), EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestDragOrigin(), EE_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), canUseGrid(), PCB_GRID_HELPER::computeAnchors(), 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(), SetAuxAxes(), showConstructionGeometry(), 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 252 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 251 of file grid_helper.h.

Referenced by EE_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), EE_GRID_HELPER::EE_GRID_HELPER(), PCB_GRID_HELPER::PCB_GRID_HELPER(), 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: