KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_tool_utils.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3
4 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
25
26#include <board.h>
27#include <pcb_shape.h>
28#include <pcb_track.h>
29
30std::optional<int> GetBoardItemWidth( const BOARD_ITEM& aItem )
31{
32 switch( aItem.Type() )
33 {
34 case PCB_SHAPE_T:
35 {
36 const PCB_SHAPE& shape = static_cast<const PCB_SHAPE&>( aItem );
37 return shape.GetWidth();
38 }
39
40 case PCB_TRACE_T:
41 {
42 const PCB_TRACK& track = static_cast<const PCB_TRACK&>( aItem );
43 return track.GetWidth();
44 }
45
46 default: break;
47 }
48
49 return std::nullopt;
50}
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
int GetWidth() const override
Definition: pcb_shape.cpp:382
virtual int GetWidth() const
Definition: pcb_track.h:116
std::optional< int > GetBoardItemWidth(const BOARD_ITEM &aItem)
Gets the width of a BOARD_ITEM, for items that have a meaningful width.
Utility functions that can be shared by PCB tools.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:88
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96