pcb_grid_helper.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Tomasz Wlostowski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCB_GRID_HELPER_H
#define PCB_GRID_HELPER_H
 
#include <initializer_list>
#include <set>
#include <vector>
 
#include <settings/snap_settings.h>
#include <tool/grid_helper.h>
#include <snap/snap_resolver.h>
#include <geometry/intersection.h>
#include <geometry/nearest.h>
 
#include <board.h>
 
 
class LSET;
class PCB_ARC;
class SHAPE_ARC;
class TOOL_MANAGER;
struct MAGNETIC_SETTINGS;
struct PCB_SELECTION_FILTER_OPTIONS;
 
class PCB_GRID_HELPER : public GRID_HELPER, public BOARD_LISTENER
{
    friend class PCBGridHelperTestFixture;
public:
 
    PCB_GRID_HELPER();
    PCB_GRID_HELPER( TOOL_MANAGER* aToolMgr, MAGNETIC_SETTINGS* aMagneticSettings );
    ~PCB_GRID_HELPER() override;

    BOARD_ITEM* GetSnapped() const;
 
    using GRID_HELPER::Align;
    using GRID_HELPER::AlignGrid;
 
    VECTOR2I Align( const VECTOR2I& aPoint, GRID_HELPER_GRIDS aGrid ) const override;
 
    VECTOR2I AlignToSegment ( const VECTOR2I& aPoint, const SEG& aSeg );
 
    VECTOR2I BestDragOrigin( const VECTOR2I& aMousePos, std::vector<BOARD_ITEM*>& aItem,
                             GRID_HELPER_GRIDS aGrid = GRID_HELPER_GRIDS::GRID_CURRENT,
                             const PCB_SELECTION_FILTER_OPTIONS* aSelectionFilter = nullptr );
 
    VECTOR2I AlignToArc ( const VECTOR2I& aPoint, const SHAPE_ARC& aSeg );
 
    VECTOR2I SnapToPad( const VECTOR2I& aMousePos, std::deque<PAD*>& aPads );
 
    void OnBoardItemRemoved( BOARD& aBoard, BOARD_ITEM* aRemovedItem ) override;
 
    void OnBoardItemsRemoved( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItems ) override;

    SNAP_RESULT ResolveSnap( const VECTOR2I& aOrigin, BOARD_ITEM* aReferenceItem,
                             GRID_HELPER_GRIDS aGrid = GRID_HELPER_GRIDS::GRID_CURRENT );
    SNAP_RESULT ResolveSnap( const VECTOR2I& aOrigin, const LSET& aLayers,
                             GRID_HELPER_GRIDS aGrid = GRID_HELPER_GRIDS::GRID_CURRENT,
                             const std::vector<BOARD_ITEM*>& aSkip = {},
                             std::optional<VECTOR2I>         aMovingReferencePoint = std::nullopt );
    void ClearSnapFeedback();

    void SetConstructionGeometryEnabled( bool aEnable ) { m_constructionGeometryEnabled = aEnable; }

    void SetSuppressedSnapSubtypes( std::set<SNAP_CANDIDATE_SUBTYPE> aSubtypes )
    {
        m_suppressedSnapSubtypes = std::move( aSubtypes );
    }
 
    GRID_HELPER_GRIDS GetItemGrid( const EDA_ITEM* aItem ) const override;
 
    VECTOR2D GetGridSize( GRID_HELPER_GRIDS aGrid ) const override;

    void AddConstructionItems( std::vector<BOARD_ITEM*> aItems, bool aExtensionOnly,
                               bool aIsPersistent );

    struct ANCHOR_SPEC
    {
        VECTOR2I pos;
        int      flags;
        int      pointType;
    };

    static std::vector<ANCHOR_SPEC> GetArcAnchors( const PCB_ARC& aArc, bool aFrom );
 
private:
    static BOX2I layoutBounds( const BOARD_ITEM& aItem );

    bool editingInsideFootprint() const;

    SNAP_INFERENCE_SETTINGS snapInferenceSettings() const;
 
    std::vector<BOARD_ITEM*> queryVisible( std::initializer_list<BOX2I>    aAreas,
                                           const std::vector<BOARD_ITEM*>& aSkip ) const;

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

    void computeAnchors( const std::vector<BOARD_ITEM*>& aItems, const VECTOR2I& aRefPos,
                         bool aFrom, const PCB_SELECTION_FILTER_OPTIONS* aSelectionFilter,
                         const LSET* aLayers, bool aForDrag );

    void computeAnchors( BOARD_ITEM* aItem, const VECTOR2I& aRefPos, bool aFrom,
                         const PCB_SELECTION_FILTER_OPTIONS* aSelectionFilter );
 
private:
    MAGNETIC_SETTINGS*               m_magneticSettings;
 
    std::vector<NEARABLE_GEOM>       m_pointOnLineCandidates;
 
    bool                             m_constructionGeometryEnabled = true;
 
    std::set<SNAP_CANDIDATE_SUBTYPE> m_suppressedSnapSubtypes;
};
 
#endif