KiCad PCB EDA Suite
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
pns_kicad_iface.h
Go to the documentation of this file.
1/*
2 * KiRouter - a push-and-(sometimes-)shove PCB router
3 *
4 * Copyright (C) 2013-2016 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 * Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7 *
8 * This program is free software: you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef __PNS_KICAD_IFACE_H
23#define __PNS_KICAD_IFACE_H
24
25#include <unordered_set>
26
27#include "pns_router.h"
28
31
32class BOARD;
33class BOARD_COMMIT;
34class PCB_TEXT;
36class PCB_TOOL_BASE;
37class FOOTPRINT;
38class PAD;
39class EDA_TEXT;
41
42namespace PNS
43{
44 class SIZES_SETTINGS;
45}
46
47namespace KIGFX
48{
49 class VIEW;
50}
51
53{
54public:
56 ~PNS_KICAD_IFACE_BASE() override;
57
58 void EraseView() override {};
59 void SetBoard( BOARD* aBoard );
60 void SyncWorld( PNS::NODE* aWorld ) override;
61 bool IsAnyLayerVisible( const PNS_LAYER_RANGE& aLayer ) const override { return true; };
62 bool IsFlashedOnLayer( const PNS::ITEM* aItem, int aLayer ) const override;
63 bool IsFlashedOnLayer( const PNS::ITEM* aItem, const PNS_LAYER_RANGE& aLayer ) const override;
64 bool IsItemVisible( const PNS::ITEM* aItem ) const override { return true; };
65 bool IsPNSCopperLayer( int aPNSLayer ) const override;
66 bool IsKicadCopperLayer( PCB_LAYER_ID aPcbnewLayer ) const;
67 void HideItem( PNS::ITEM* aItem ) override {}
68 void DisplayItem( const PNS::ITEM* aItem, int aClearance, bool aEdit = false,
69 int aFlags = 0 ) override {}
70 void DisplayPathLine( const SHAPE_LINE_CHAIN& aLine, int aImportance ) override {}
71 void DisplayRatline( const SHAPE_LINE_CHAIN& aRatline, PNS::NET_HANDLE aNet ) override {}
72 void AddItem( PNS::ITEM* aItem ) override;
73 void UpdateItem( PNS::ITEM* aItem ) override;
74 void RemoveItem( PNS::ITEM* aItem ) override;
75 void Commit() override {}
76 bool ImportSizes( PNS::SIZES_SETTINGS& aSizes, PNS::ITEM* aStartItem, PNS::NET_HANDLE aNet,
77 VECTOR2D aStartPosition ) override;
78 int StackupHeight( int aFirstLayer, int aSecondLayer ) const override;
79
80 int GetNetCode( PNS::NET_HANDLE aNet ) const override { return -1; }
81 wxString GetNetName( PNS::NET_HANDLE aNet ) const override { return wxEmptyString; }
82 void UpdateNet( PNS::NET_HANDLE aNet ) override {}
84
86
87 long long int CalculateRoutedPathLength( const PNS::ITEM_SET& aLine, const PNS::SOLID* aStartPad,
88 const PNS::SOLID* aEndPad, const NETCLASS* aNetClass ) override;
89 int64_t CalculateRoutedPathDelay( const PNS::ITEM_SET& aLine, const PNS::SOLID* aStartPad,
90 const PNS::SOLID* aEndPad, const NETCLASS* aNetClass ) override;
91 int64_t CalculateLengthForDelay( int64_t aDesiredDelay, int aWidth, bool aIsDiffPairCoupled,
92 int aDiffPairCouplingGap, int aPNSLayer, const NETCLASS* aNetClass ) override;
93 int64_t CalculateDelayForShapeLineChain( const SHAPE_LINE_CHAIN& aShape, int aWidth, bool aIsDiffPairCoupled,
94 int aDiffPairCouplingGap, int aPNSLayer,
95 const NETCLASS* aNetClass ) override;
96
97 PCB_LAYER_ID GetBoardLayerFromPNSLayer( int aLayer ) const override;
98 int GetPNSLayerFromBoardLayer( PCB_LAYER_ID aLayer ) const override;
99
101 void SetStartLayerFromPNS( int aLayer ) { m_startLayer = aLayer; }
102
104
105 virtual PNS::NODE* GetWorld() const override { return m_world; };
106
107 BOARD* GetBoard() const { return m_board; }
108
109 virtual EDA_UNITS GetUnits() const { return EDA_UNITS::MM; };
110
113
114protected:
117
118 std::vector<std::unique_ptr<PNS::SOLID>> syncPad( PAD* aPad );
119 std::unique_ptr<PNS::SEGMENT> syncTrack( PCB_TRACK* aTrack );
120 std::unique_ptr<PNS::ARC> syncArc( PCB_ARC* aArc );
121 std::unique_ptr<PNS::VIA> syncVia( PCB_VIA* aVia );
122 bool syncTextItem( PNS::NODE* aWorld, BOARD_ITEM* aItem, PCB_LAYER_ID aLayer );
123 bool syncGraphicalItem( PNS::NODE* aWorld, PCB_SHAPE* aItem );
124 bool syncZone( PNS::NODE* aWorld, ZONE* aZone, SHAPE_POLY_SET* aBoardOutline );
125 bool inheritTrackWidth( PNS::ITEM* aItem, int* aInheritedWidth );
126 std::vector<LENGTH_DELAY_CALCULATION_ITEM> getLengthDelayCalculationItems( const PNS::ITEM_SET& aLine,
127 const NETCLASS* aNetClass ) const;
128
129protected:
132 int m_startLayer; // The starting layer, in PNS layer coordinates
133};
134
136{
137public:
139 ~PNS_KICAD_IFACE() override;
140
141 virtual void SetHostTool( PCB_TOOL_BASE* aTool );
142
143 void SetView( KIGFX::VIEW* aView );
144 void EraseView() override;
145 bool IsAnyLayerVisible( const PNS_LAYER_RANGE& aLayer ) const override;
146 bool IsItemVisible( const PNS::ITEM* aItem ) const override;
147 void HideItem( PNS::ITEM* aItem ) override;
148 void DisplayItem( const PNS::ITEM* aItem, int aClearance, bool aEdit = false,
149 int aFlags = 0 ) override;
150 void DisplayPathLine( const SHAPE_LINE_CHAIN& aLine, int aImportance ) override;
151 void DisplayRatline( const SHAPE_LINE_CHAIN& aRatline, PNS::NET_HANDLE aNet ) override;
152 void Commit() override;
153 void AddItem( PNS::ITEM* aItem ) override;
154 void UpdateItem( PNS::ITEM* aItem ) override;
155 void RemoveItem( PNS::ITEM* aItem ) override;
156
157 int GetNetCode( PNS::NET_HANDLE aNet ) const override;
158 wxString GetNetName( PNS::NET_HANDLE aNet ) const override;
159 void UpdateNet( PNS::NET_HANDLE aNet ) override;
160
161 EDA_UNITS GetUnits() const override;
162
163 void SetCommitFlags( int aCommitFlags ) { m_commitFlags = aCommitFlags; }
164
165protected:
167 void modifyBoardItem( PNS::ITEM* aItem );
168
169 struct OFFSET
170 {
172 };
173
174 std::map<PAD*, OFFSET> m_fpOffsets;
177 std::unordered_set<BOARD_ITEM*> m_hiddenItems;
178
180 std::unique_ptr<BOARD_COMMIT> m_commit;
182};
183
184
185#endif
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:78
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:297
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:80
Extend VIEW_ITEM by possibility of grouping items into a single object.
Definition: view_group.h:48
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:67
Lightweight class which holds a pad, via, or a routed trace outline.
A collection of nets and the parameters used to route or test these nets.
Definition: netclass.h:45
Definition: pad.h:54
Base class for PNS router board items.
Definition: pns_item.h:98
Keep the router "world" - i.e.
Definition: pns_node.h:232
void DisplayItem(const PNS::ITEM *aItem, int aClearance, bool aEdit=false, int aFlags=0) override
bool syncGraphicalItem(PNS::NODE *aWorld, PCB_SHAPE *aItem)
void DisplayRatline(const SHAPE_LINE_CHAIN &aRatline, PNS::NET_HANDLE aNet) override
bool inheritTrackWidth(PNS::ITEM *aItem, int *aInheritedWidth)
void AddItem(PNS::ITEM *aItem) override
wxString GetNetName(PNS::NET_HANDLE aNet) const override
virtual EDA_UNITS GetUnits() const
PNS::DEBUG_DECORATOR * m_debugDecorator
void SetDebugDecorator(PNS::DEBUG_DECORATOR *aDec)
bool syncZone(PNS::NODE *aWorld, ZONE *aZone, SHAPE_POLY_SET *aBoardOutline)
void SetBoard(BOARD *aBoard)
long long int CalculateRoutedPathLength(const PNS::ITEM_SET &aLine, const PNS::SOLID *aStartPad, const PNS::SOLID *aEndPad, const NETCLASS *aNetClass) override
virtual PNS::NODE * GetWorld() const override
int64_t CalculateRoutedPathDelay(const PNS::ITEM_SET &aLine, const PNS::SOLID *aStartPad, const PNS::SOLID *aEndPad, const NETCLASS *aNetClass) override
std::unique_ptr< PNS::ARC > syncArc(PCB_ARC *aArc)
void RemoveItem(PNS::ITEM *aItem) override
bool IsPNSCopperLayer(int aPNSLayer) const override
int64_t CalculateLengthForDelay(int64_t aDesiredDelay, int aWidth, bool aIsDiffPairCoupled, int aDiffPairCouplingGap, int aPNSLayer, const NETCLASS *aNetClass) override
void DisplayPathLine(const SHAPE_LINE_CHAIN &aLine, int aImportance) override
PNS::RULE_RESOLVER * GetRuleResolver() override
bool syncTextItem(PNS::NODE *aWorld, BOARD_ITEM *aItem, PCB_LAYER_ID aLayer)
std::vector< LENGTH_DELAY_CALCULATION_ITEM > getLengthDelayCalculationItems(const PNS::ITEM_SET &aLine, const NETCLASS *aNetClass) const
bool IsAnyLayerVisible(const PNS_LAYER_RANGE &aLayer) const override
bool IsKicadCopperLayer(PCB_LAYER_ID aPcbnewLayer) const
std::vector< std::unique_ptr< PNS::SOLID > > syncPad(PAD *aPad)
int GetNetCode(PNS::NET_HANDLE aNet) const override
void HideItem(PNS::ITEM *aItem) override
void SetStartLayerFromPCBNew(PCB_LAYER_ID aLayer)
void Commit() override
bool IsItemVisible(const PNS::ITEM *aItem) const override
bool IsFlashedOnLayer(const PNS::ITEM *aItem, int aLayer) const override
PCB_LAYER_ID GetBoardLayerFromPNSLayer(int aLayer) const override
BOARD * GetBoard() const
void UpdateNet(PNS::NET_HANDLE aNet) override
void SyncWorld(PNS::NODE *aWorld) override
int StackupHeight(int aFirstLayer, int aSecondLayer) const override
int64_t CalculateDelayForShapeLineChain(const SHAPE_LINE_CHAIN &aShape, int aWidth, bool aIsDiffPairCoupled, int aDiffPairCouplingGap, int aPNSLayer, const NETCLASS *aNetClass) override
PNS::DEBUG_DECORATOR * GetDebugDecorator() override
std::unique_ptr< PNS::SEGMENT > syncTrack(PCB_TRACK *aTrack)
PNS_PCBNEW_RULE_RESOLVER * m_ruleResolver
PNS::NET_HANDLE GetOrphanedNetHandle() override
std::unique_ptr< PNS::VIA > syncVia(PCB_VIA *aVia)
int GetPNSLayerFromBoardLayer(PCB_LAYER_ID aLayer) const override
void SetStartLayerFromPNS(int aLayer)
PNS_LAYER_RANGE SetLayersFromPCBNew(PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer)
void EraseView() override
void UpdateItem(PNS::ITEM *aItem) override
bool ImportSizes(PNS::SIZES_SETTINGS &aSizes, PNS::ITEM *aStartItem, PNS::NET_HANDLE aNet, VECTOR2D aStartPosition) override
void SetView(KIGFX::VIEW *aView)
void RemoveItem(PNS::ITEM *aItem) override
void AddItem(PNS::ITEM *aItem) override
void UpdateItem(PNS::ITEM *aItem) override
std::map< PAD *, OFFSET > m_fpOffsets
int GetNetCode(PNS::NET_HANDLE aNet) const override
virtual void SetHostTool(PCB_TOOL_BASE *aTool)
void DisplayItem(const PNS::ITEM *aItem, int aClearance, bool aEdit=false, int aFlags=0) override
std::unique_ptr< BOARD_COMMIT > m_commit
void EraseView() override
void HideItem(PNS::ITEM *aItem) override
void UpdateNet(PNS::NET_HANDLE aNet) override
BOARD_CONNECTED_ITEM * createBoardItem(PNS::ITEM *aItem)
KIGFX::VIEW * m_view
void DisplayPathLine(const SHAPE_LINE_CHAIN &aLine, int aImportance) override
bool IsItemVisible(const PNS::ITEM *aItem) const override
std::unordered_set< BOARD_ITEM * > m_hiddenItems
EDA_UNITS GetUnits() const override
bool IsAnyLayerVisible(const PNS_LAYER_RANGE &aLayer) const override
PCB_TOOL_BASE * m_tool
void modifyBoardItem(PNS::ITEM *aItem)
void Commit() override
KIGFX::VIEW_GROUP * m_previewItems
void DisplayRatline(const SHAPE_LINE_CHAIN &aRatline, PNS::NET_HANDLE aNet) override
void SetCommitFlags(int aCommitFlags)
wxString GetNetName(PNS::NET_HANDLE aNet) const override
~PNS_KICAD_IFACE() override
Represent a contiguous set of PCB layers.
Definition: pns_layerset.h:32
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Represent a set of closed polygons.
Handle a list of polygons defining a copper zone.
Definition: zone.h:74
EDA_UNITS
Definition: eda_units.h:48
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
The Cairo implementation of the graphics abstraction layer.
Definition: eda_group.h:32
Push and Shove diff pair dimensions (gap) settings dialog.
void * NET_HANDLE
Definition: pns_item.h:55