7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-21 22:15:02 +00:00
kicad/eeschema/tools/ee_grid_helper.h
2024-04-08 10:24:50 +01:00

85 lines
3.2 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2014 CERN
* Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef EE_GRID_HELPER_H
#define EE_GRID_HELPER_H
#include <math/vector2d.h>
#include <origin_viewitem.h>
#include <tool/grid_helper.h>
#include <ee_selection.h>
class SCH_ITEM;
class EE_GRID_HELPER : public GRID_HELPER
{
public:
EE_GRID_HELPER( TOOL_MANAGER* aToolMgr );
~EE_GRID_HELPER() override;
/**
* 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.
*
* @return NULL if not snapped. Pointer to snapped item otherwise
*/
SCH_ITEM* GetSnapped() const;
VECTOR2D GetGridSize( GRID_HELPER_GRIDS aGrid ) const override;
using GRID_HELPER::GetGrid;
GRID_HELPER_GRIDS GetSelectionGrid( const SELECTION& aItem ) const override;
GRID_HELPER_GRIDS GetItemGrid( const EDA_ITEM* aItem ) const override;
VECTOR2I BestDragOrigin( const VECTOR2I& aMousePos, GRID_HELPER_GRIDS aGrid,
const EE_SELECTION& aItems );
VECTOR2I BestSnapAnchor( const VECTOR2I& aOrigin, GRID_HELPER_GRIDS aGrid, SCH_ITEM* aSkip );
VECTOR2I BestSnapAnchor( const VECTOR2I& aOrigin, GRID_HELPER_GRIDS aGrid,
const EE_SELECTION& aSkip = {} );
private:
std::set<SCH_ITEM*> queryVisible( const BOX2I& aArea, const EE_SELECTION& aSkipList ) const;
ANCHOR* nearestAnchor( const VECTOR2I& aPos, int aFlags, GRID_HELPER_GRIDS aGrid );
/**
* 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.
*
* @param aItem The schematic item for which to compute the anchors
* @param aRefPos The point for which to compute the anchors (if used by the symbol)
* @param aFrom Is this for an anchor that is designating a source point (aFrom=true) or not
* @param aIncludeText if true will compute anchors for text items
*/
void computeAnchors( SCH_ITEM* aItem, const VECTOR2I& aRefPos, bool aFrom = false,
bool aIncludeText = false );
};
#endif