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

#include <ee_grid_helper.h>

Inheritance diagram for EE_GRID_HELPER:
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 ()
 
 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
 Get the coarsest grid that applies to an item.
 
VECTOR2I BestDragOrigin (const VECTOR2I &aMousePos, GRID_HELPER_GRIDS aGrid, const SCH_SELECTION &aItems)
 
VECTOR2I BestSnapAnchor (const VECTOR2I &aOrigin, GRID_HELPER_GRIDS aGrid, SCH_ITEM *aSkip)
 
VECTOR2I BestSnapAnchor (const VECTOR2I &aOrigin, GRID_HELPER_GRIDS aGrid, const SCH_SELECTION &aSkip={})
 
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 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 ()
 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 Member Functions

std::set< SCH_ITEM * > queryVisible (const BOX2I &aArea, const SCH_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
 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 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 143 of file grid_helper.h.

Constructor & Destructor Documentation

◆ EE_GRID_HELPER() [1/2]

EE_GRID_HELPER::EE_GRID_HELPER ( )

Definition at line 42 of file ee_grid_helper.cpp.

References GRID_HELPER::GRID_HELPER().

◆ EE_GRID_HELPER() [2/2]

EE_GRID_HELPER::EE_GRID_HELPER ( TOOL_MANAGER * aToolMgr)

Definition at line 48 of file ee_grid_helper.cpp.

References KIGFX::VIEW::Add(), KIGFX::ORIGIN_VIEWITEM::CIRCLE_CROSS, KIGFX::ORIGIN_VIEWITEM::CROSS, GRID_HELPER::GRID_HELPER(), LAYER_SCHEMATIC_ANCHOR, GRID_HELPER::m_toolMgr, GRID_HELPER::m_viewAxis, GRID_HELPER::m_viewSnapPoint, and KIGFX::VIEW::SetVisible().

◆ ~EE_GRID_HELPER()

EE_GRID_HELPER::~EE_GRID_HELPER ( )
override

Definition at line 71 of file ee_grid_helper.cpp.

References 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 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 )
inlineprotectedinherited

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
virtualinherited

Reimplemented in PCB_GRID_HELPER.

Definition at line 353 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
virtualinherited

Reimplemented in PCB_GRID_HELPER.

Definition at line 359 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
inlinevirtualinherited

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
inherited

Definition at line 332 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
inherited

Definition at line 338 of file grid_helper.cpp.

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

◆ BestDragOrigin()

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

Definition at line 83 of file ee_grid_helper.cpp.

References GRID_HELPER::clearAnchors(), computeAnchors(), GRID_HELPER::CORNER, GRID_HELPER::ANCHOR::Distance(), GetItemGrid(), 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 SCH_SELECTION & aSkip = {} )

Definition at line 153 of file ee_grid_helper.cpp.

References std::abs(), GRID_HELPER::Align(), GRID_HELPER::canUseGrid(), GRID_HELPER::clearAnchors(), computeAnchors(), GRID_HELPER::ANCHOR::Distance(), GRID_HELPER::enableAndGetAnchorDebug(), VECTOR2< T >::EuclideanNorm(), KIGFX::GEOMETRY, GetGridSize(), SNAP_MANAGER::GetSnapLineManager(), GRID_HELPER::getSnapManager(), 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, SNAP_LINE_MANAGER::SetSnapLineEnd(), SNAP_LINE_MANAGER::SetSnapLineOrigin(), GRID_HELPER::showConstructionGeometry(), SNAP_RANGE, GRID_HELPER::SNAPPABLE, GRID_HELPER::SnapToConstructionLines(), 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 143 of file ee_grid_helper.cpp.

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

Referenced by SCH_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 380 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 ( )
inlineprotectedinherited

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

Definition at line 139 of file grid_helper.h.

References m_maskTypes.

Referenced by BOOST_AUTO_TEST_CASE().

◆ ClearSkipPoint()

void GRID_HELPER::ClearSkipPoint ( )
inlineinherited

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

Definition at line 150 of file grid_helper.cpp.

References m_snapManager.

◆ 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
aItemThe schematic item for which to compute the anchors
aRefPosThe point for which to compute the anchors (if used by the symbol)
aFromIs this for an anchor that is designating a source point (aFrom=true) or not
aIncludeTextif true will compute anchors for text items

Definition at line 439 of file ee_grid_helper.cpp.

References GRID_HELPER::addAnchor(), GRID_HELPER::Align(), computeAnchors(), 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_GROUP_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(), BestSnapAnchor(), and computeAnchors().

◆ computeNearest()

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

Definition at line 345 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 ( )
protectedinherited

Enable the anchor debug if permitted and return it.

Returns nullptr if not permitted by the advancd config

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

References KIGFX::GEOMETRY, GRID_HELPER::m_constructionGeomPreview, GRID_HELPER::m_snapManager, and GRID_HELPER::m_toolMgr.

◆ 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 249 of file ee_grid_helper.cpp.

References grid, GRID_CONNECTABLE, GRID_GRAPHICS, GRID_TEXT, GRID_WIRES, GRID_HELPER::m_toolMgr, and schIUScale.

Referenced by BestSnapAnchor(), GetItemGrid(), and GetSelectionGrid().

◆ GetItemGrid()

GRID_HELPER_GRIDS EE_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 368 of file ee_grid_helper.cpp.

References GetGridSize(), GetItemGrid(), grid, GRID_CONNECTABLE, GRID_CURRENT, GRID_GRAPHICS, GRID_TEXT, GRID_WIRES, group, 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_GROUP_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 SCH_SELECTION_TOOL::autostartEvent(), BestDragOrigin(), BOOST_AUTO_TEST_CASE(), GetItemGrid(), and GetSelectionGrid().

◆ GetOrigin()

VECTOR2I GRID_HELPER::GetOrigin ( ) const
inherited

Definition at line 279 of file grid_helper.cpp.

References m_manualOrigin, and m_toolMgr.

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

◆ 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 351 of file ee_grid_helper.cpp.

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

◆ GetSnap()

bool GRID_HELPER::GetSnap ( ) const
inlineinherited

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

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

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

Returns
NULL if not snapped. Pointer to snapped item otherwise

Definition at line 296 of file ee_grid_helper.cpp.

References GRID_HELPER::m_snapItem.

◆ GetSnappedPoint()

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

Definition at line 387 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
inlineinherited

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
inherited

Definition at line 273 of file grid_helper.cpp.

References m_manualVisibleGrid, and m_toolMgr.

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

◆ nearestAnchor()

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

Definition at line 551 of file ee_grid_helper.cpp.

References GRID_CONNECTABLE, GRID_GRAPHICS, SCH_ITEM::IsConnectable(), and GRID_HELPER::m_anchors.

Referenced by BestDragOrigin(), and BestSnapAnchor().

◆ queryVisible()

std::set< SCH_ITEM * > EE_GRID_HELPER::queryVisible ( const BOX2I & aArea,
const SCH_SELECTION & aSkipList ) const
private

Definition at line 308 of file ee_grid_helper.cpp.

References FRAME_SCH_SYMBOL_EDITOR, KIGFX::VIEW::GetScale(), SCH_ITEM::IsPrivate(), EDA_BASE_FRAME::IsType(), KIGFX::VIEW::IsVisible(), LIB_SYMBOL_T, GRID_HELPER::m_toolMgr, KIGFX::VIEW::Query(), EDA_ITEM::Type(), and KIGFX::VIEW_ITEM::ViewGetLOD().

Referenced by BestSnapAnchor().

◆ SetAuxAxes()

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

Definition at line 314 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)
inlineinherited

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

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

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

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

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

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

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

Definition at line 127 of file grid_helper.h.

References m_enableSnapLine.

◆ SetSnapLineDirections()

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

Definition at line 134 of file grid_helper.cpp.

References m_snapManager.

◆ SetSnapLineEnd()

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

Definition at line 145 of file grid_helper.cpp.

References m_snapManager.

◆ SetSnapLineOrigin()

void GRID_HELPER::SetSnapLineOrigin ( const VECTOR2I & aOrigin)
inherited

Definition at line 140 of file grid_helper.cpp.

References m_snapManager.

◆ SetUseGrid()

void GRID_HELPER::SetUseGrid ( bool aSnapToGrid)
inlineinherited

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

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

Definition at line 127 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
inherited

Definition at line 156 of file grid_helper.cpp.

References std::abs(), canUseGrid(), delta, VECTOR2< T >::EuclideanNorm(), SNAP_LINE_MANAGER::GetActiveDirection(), SNAP_LINE_MANAGER::GetDirections(), SNAP_LINE_MANAGER::GetSnapLineOrigin(), KiROUND(), m_skipPoint, m_snapManager, 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)
protectedinherited

Definition at line 251 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().

Member Data Documentation

◆ m_anchorDebug

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

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

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
protectedinherited

Definition at line 240 of file grid_helper.h.

Referenced by Align(), and SetAuxAxes().

◆ m_constructionGeomPreview

KIGFX::CONSTRUCTION_GEOM GRID_HELPER::m_constructionGeomPreview
privateinherited

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
protectedinherited

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
protectedinherited

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
protectedinherited

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
protectedinherited

Definition at line 255 of file grid_helper.h.

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

◆ m_manualGridSnapping

bool GRID_HELPER::m_manualGridSnapping
protectedinherited

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
protectedinherited

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
protectedinherited

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
protectedinherited

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
protectedinherited

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
protectedinherited

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
privateinherited

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
protectedinherited

Definition at line 239 of file grid_helper.h.

Referenced by 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
protectedinherited

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
protectedinherited

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: