7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-22 10:45:02 +00:00
kicad/pcbnew/tools/pcb_tool_utils.h

44 lines
1.5 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
* Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
*
* 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
*/
/**
* @file pcb_tool_utils.h
*
* Utility functions that can be shared by PCB tools.
* Public-API class operations that are not specific to any one tool.
*/
#pragma once
#include <optional>
class BOARD_ITEM;
/**
* Gets the width of a BOARD_ITEM, for items that have a meaningful width.
* (e.g. some graphics, tracks).
*
* @param aItem The item to get the width of.
* @return The width of the item, or std::nullopt if the item has no useful width.
*/
std::optional<int> GetBoardItemWidth( const BOARD_ITEM& aItem );