KiCad PCB EDA Suite
pns_router.h
Go to the documentation of this file.
1/*
2 * KiRouter - a push-and-(sometimes-)shove PCB router
3 *
4 * Copyright (C) 2013-2014 CERN
5 * Copyright (C) 2016 KiCad Developers, see AUTHORS.txt for contributors.
6 * Author: Tomasz Wlostowski <[email protected]>
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_ROUTER_H
23#define __PNS_ROUTER_H
24
25#include <list>
26#include <memory>
27#include <optional>
28#include <math/box2.h>
29
31#include "pns_sizes_settings.h"
32#include "pns_node.h"
33
34namespace KIGFX
35{
36
37class VIEW;
38class VIEW_GROUP;
39
40}
41
42namespace PNS {
43
44class DEBUG_DECORATOR;
45class NODE;
46class DIFF_PAIR_PLACER;
47class PLACEMENT_ALGO;
48class LINE_PLACER;
49class ITEM;
50class ARC;
51class LINE;
52class SOLID;
53class SEGMENT;
54class JOINT;
55class VIA;
56class RULE_RESOLVER;
57class SHOVE;
58class DRAGGER;
59class DRAG_ALGO;
60class LOGGER;
61
68};
69
71{
72 DM_CORNER = 0x1,
74 DM_VIA = 0x4,
76 DM_ARC = 0x10,
77 DM_ANY = 0x17,
78 DM_COMPONENT = 0x20
79};
87 {
88 public:
90 virtual ~ROUTER_IFACE() {};
91
92 virtual void SyncWorld( NODE* aNode ) = 0;
93 virtual void AddItem( ITEM* aItem ) = 0;
94 virtual void UpdateItem( ITEM* aItem ) = 0;
95 virtual void RemoveItem( ITEM* aItem ) = 0;
96 virtual bool IsAnyLayerVisible( const LAYER_RANGE& aLayer ) const = 0;
97 virtual bool IsItemVisible( const PNS::ITEM* aItem ) const = 0;
98 virtual bool IsFlashedOnLayer( const PNS::ITEM* aItem, int aLayer ) const = 0;
99 virtual void DisplayItem( const ITEM* aItem, int aClearance, bool aEdit = false, bool aIsHeadTrace = false ) = 0;
100 virtual void DisplayRatline( const SHAPE_LINE_CHAIN& aRatline, int aNetCode ) = 0;
101 virtual void HideItem( ITEM* aItem ) = 0;
102 virtual void Commit() = 0;
103 virtual bool ImportSizes( SIZES_SETTINGS& aSizes, ITEM* aStartItem, int aNet ) = 0;
104 virtual int StackupHeight( int aFirstLayer, int aSecondLayer ) const = 0;
105
106 virtual void EraseView() = 0;
107 virtual void UpdateNet( int aNetCode ) = 0;
108
109 virtual PNS::NODE* GetWorld() const = 0;
110
113};
114
116{
117public:
119 {
124 };
125
126public:
127 ROUTER();
128 ~ROUTER();
129
130 void SetInterface( ROUTER_IFACE* aIface );
131 void SetMode ( ROUTER_MODE aMode );
132 ROUTER_MODE Mode() const { return m_mode; }
133
134 RouterState GetState() const { return m_state; }
135
136 DRAG_ALGO* GetDragger() { return m_dragger.get(); }
137
138 static ROUTER* GetInstance();
139
140 void ClearWorld();
141 void SyncWorld();
142
143 bool RoutingInProgress() const;
144 bool StartRouting( const VECTOR2I& aP, ITEM* aItem, int aLayer );
145 bool Move( const VECTOR2I& aP, ITEM* aItem );
146 bool Finish();
147 bool ContinueFromEnd();
148 bool FixRoute( const VECTOR2I& aP, ITEM* aItem, bool aForceFinish = false );
149 void BreakSegment( ITEM *aItem, const VECTOR2I& aP );
150
151 void UndoLastSegment();
152 void CommitRouting();
153
154 void GetUpdatedItems( std::vector<PNS::ITEM*>& aRemoved, std::vector<PNS::ITEM*>& aAdded,
155 std::vector<PNS::ITEM*>& aHeads );
156
157 void StopRouting();
159
160 NODE* GetWorld() const { return m_world.get(); }
161
162 void FlipPosture();
163
164 bool SwitchLayer( int layer );
165
166 void ToggleViaPlacement();
167 void SetOrthoMode( bool aEnable );
168
169 void ToggleCornerMode();
170
171 int GetCurrentLayer() const;
172 const std::vector<int> GetCurrentNets() const;
173
174 LOGGER* Logger();
175
177
178 bool IsPlacingVia() const;
179
180 const ITEM_SET QueryHoverItems( const VECTOR2I& aP, bool aUseClearance = false );
181
182 bool StartDragging( const VECTOR2I& aP, ITEM* aItem, int aDragMode = DM_ANY );
183 bool StartDragging( const VECTOR2I& aP, ITEM_SET aItems, int aDragMode = DM_COMPONENT );
184
185 void SetIterLimit( int aX ) { m_iterLimit = aX; }
186 int GetIterLimit() const { return m_iterLimit; };
187
189
190 void CommitRouting( NODE* aNode );
191
196 void UpdateSizes( const SIZES_SETTINGS& aSizes );
197
203 {
204 m_settings = aSettings;
205 }
206
208
209 void SetFailureReason( const wxString& aReason ) { m_failureReason = aReason; }
210 const wxString& FailureReason() const { return m_failureReason; }
211
212 PLACEMENT_ALGO* Placer() { return m_placer.get(); }
213
214 ROUTER_IFACE* GetInterface() const { return m_iface; }
215
216 void SetVisibleViewArea( const BOX2I& aExtents ) { m_visibleViewArea = aExtents; }
217 const BOX2I& VisibleViewArea() const { return m_visibleViewArea; }
218
219private:
220 bool movePlacing( const VECTOR2I& aP, ITEM* aItem );
221 bool moveDragging( const VECTOR2I& aP, ITEM* aItem );
222
223 void updateView( NODE* aNode, ITEM_SET& aCurrent, bool aDragging = false );
224
225 // optHoverItem queryHoverItemEx(const VECTOR2I& aP);
226
227 void markViolations( NODE* aNode, ITEM_SET& aCurrent, NODE::ITEM_VECTOR& aRemoved );
228 bool isStartingPointRoutable( const VECTOR2I& aWhere, ITEM* aItem, int aLayer );
229
230 bool getNearestRatnestAnchor( VECTOR2I& aOtherEnd, LAYER_RANGE& aOtherEndLayers );
231
232
233private:
236
237 std::unique_ptr<NODE> m_world;
239
240 std::unique_ptr<PLACEMENT_ALGO> m_placer;
241 std::unique_ptr<DRAG_ALGO> m_dragger;
242 std::unique_ptr<SHOVE> m_shove;
243
245
248
253
256};
257
258}
259
260#endif
Represent a contiguous set of PCB layers.
Definition: pns_layerset.h:32
DRAG_ALGO.
Definition: pns_drag_algo.h:44
Base class for PNS router board items.
Definition: pns_item.h:56
Keep the router "world" - i.e.
Definition: pns_node.h:156
std::vector< ITEM * > ITEM_VECTOR
Definition: pns_node.h:167
virtual void RemoveItem(ITEM *aItem)=0
virtual void UpdateItem(ITEM *aItem)=0
virtual ~ROUTER_IFACE()
Definition: pns_router.h:90
virtual void UpdateNet(int aNetCode)=0
virtual bool IsItemVisible(const PNS::ITEM *aItem) const =0
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
virtual void HideItem(ITEM *aItem)=0
virtual bool ImportSizes(SIZES_SETTINGS &aSizes, ITEM *aStartItem, int aNet)=0
virtual void Commit()=0
virtual RULE_RESOLVER * GetRuleResolver()=0
virtual void DisplayRatline(const SHAPE_LINE_CHAIN &aRatline, int aNetCode)=0
virtual void AddItem(ITEM *aItem)=0
virtual void EraseView()=0
virtual void SyncWorld(NODE *aNode)=0
virtual void DisplayItem(const ITEM *aItem, int aClearance, bool aEdit=false, bool aIsHeadTrace=false)=0
virtual bool IsFlashedOnLayer(const PNS::ITEM *aItem, int aLayer) const =0
virtual int StackupHeight(int aFirstLayer, int aSecondLayer) const =0
virtual bool IsAnyLayerVisible(const LAYER_RANGE &aLayer) const =0
virtual PNS::NODE * GetWorld() const =0
void updateView(NODE *aNode, ITEM_SET &aCurrent, bool aDragging=false)
Definition: pns_router.cpp:701
void SetMode(ROUTER_MODE aMode)
bool moveDragging(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:596
bool SwitchLayer(int layer)
Definition: pns_router.cpp:947
void StopRouting()
Definition: pns_router.cpp:904
void SetIterLimit(int aX)
Definition: pns_router.h:185
void ClearViewDecorations()
Definition: pns_router.cpp:932
void ToggleCornerMode()
int m_iterLimit
Definition: pns_router.h:246
PLACEMENT_ALGO * Placer()
Definition: pns_router.h:212
NODE * m_lastNode
Definition: pns_router.h:238
void ClearWorld()
Definition: pns_router.cpp:102
ROUTER_IFACE * GetInterface() const
Definition: pns_router.h:214
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
Definition: pns_router.cpp:726
void SetFailureReason(const wxString &aReason)
Definition: pns_router.h:209
bool getNearestRatnestAnchor(VECTOR2I &aOtherEnd, LAYER_RANGE &aOtherEndLayers)
Definition: pns_router.cpp:481
LOGGER * Logger()
Definition: pns_router.cpp:993
ROUTER_MODE Mode() const
Definition: pns_router.h:132
void UndoLastSegment()
Definition: pns_router.cpp:885
void LoadSettings(ROUTING_SETTINGS *aSettings)
Changes routing settings to ones passed in the parameter.
Definition: pns_router.h:202
RouterState m_state
Definition: pns_router.h:235
const std::vector< int > GetCurrentNets() const
Definition: pns_router.cpp:971
void CommitRouting()
Definition: pns_router.cpp:895
bool m_forceMarkObstaclesMode
Definition: pns_router.h:247
std::unique_ptr< DRAG_ALGO > m_dragger
Definition: pns_router.h:241
void SetInterface(ROUTER_IFACE *aIface)
const BOX2I & VisibleViewArea() const
Definition: pns_router.h:217
bool Finish()
Definition: pns_router.cpp:523
void markViolations(NODE *aNode, ITEM_SET &aCurrent, NODE::ITEM_VECTOR &aRemoved)
Definition: pns_router.cpp:608
void SyncWorld()
Definition: pns_router.cpp:92
bool ContinueFromEnd()
Definition: pns_router.cpp:564
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:240
int GetIterLimit() const
Definition: pns_router.h:186
const wxString & FailureReason() const
Definition: pns_router.h:210
bool isStartingPointRoutable(const VECTOR2I &aWhere, ITEM *aItem, int aLayer)
Definition: pns_router.cpp:214
ROUTER_IFACE * m_iface
Definition: pns_router.h:244
bool IsPlacingVia() const
Definition: pns_router.cpp:999
void FlipPosture()
Definition: pns_router.cpp:938
RULE_RESOLVER * GetRuleResolver() const
Definition: pns_router.h:176
SIZES_SETTINGS m_sizes
Definition: pns_router.h:250
const ITEM_SET QueryHoverItems(const VECTOR2I &aP, bool aUseClearance=false)
Definition: pns_router.cpp:120
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:188
bool FixRoute(const VECTOR2I &aP, ITEM *aItem, bool aForceFinish=false)
Definition: pns_router.cpp:859
DRAG_ALGO * GetDragger()
Definition: pns_router.h:136
bool movePlacing(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:738
bool RoutingInProgress() const
Definition: pns_router.cpp:114
RouterState GetState() const
Definition: pns_router.h:134
BOX2I m_visibleViewArea
Definition: pns_router.h:234
static ROUTER * GetInstance()
Definition: pns_router.cpp:78
LOGGER * m_logger
Definition: pns_router.h:252
void BreakSegment(ITEM *aItem, const VECTOR2I &aP)
void SetOrthoMode(bool aEnable)
bool StartDragging(const VECTOR2I &aP, ITEM *aItem, int aDragMode=DM_ANY)
Definition: pns_router.cpp:149
bool StartRouting(const VECTOR2I &aP, ITEM *aItem, int aLayer)
Definition: pns_router.cpp:390
void SetVisibleViewArea(const BOX2I &aExtents)
Definition: pns_router.h:216
int GetCurrentLayer() const
Definition: pns_router.cpp:982
void GetUpdatedItems(std::vector< PNS::ITEM * > &aRemoved, std::vector< PNS::ITEM * > &aAdded, std::vector< PNS::ITEM * > &aHeads)
Definition: pns_router.cpp:776
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:207
std::unique_ptr< SHOVE > m_shove
Definition: pns_router.h:242
std::unique_ptr< NODE > m_world
Definition: pns_router.h:237
void ToggleViaPlacement()
Definition: pns_router.cpp:956
NODE * GetWorld() const
Definition: pns_router.h:160
ROUTING_SETTINGS * m_settings
Definition: pns_router.h:249
wxString m_failureReason
Definition: pns_router.h:255
ROUTER_MODE m_mode
Definition: pns_router.h:251
wxString m_toolStatusbarName
Definition: pns_router.h:254
bool Move(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:459
Contain all persistent settings of the router, such as the mode, optimization effort,...
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:266
Push and Shove diff pair dimensions (gap) settings dialog.
ROUTER_MODE
Definition: pns_router.h:62
@ PNS_MODE_ROUTE_SINGLE
Definition: pns_router.h:63
@ PNS_MODE_ROUTE_DIFF_PAIR
Definition: pns_router.h:64
@ PNS_MODE_TUNE_DIFF_PAIR
Definition: pns_router.h:66
@ PNS_MODE_TUNE_SINGLE
Definition: pns_router.h:65
@ PNS_MODE_TUNE_DIFF_PAIR_SKEW
Definition: pns_router.h:67
DRAG_MODE
Definition: pns_router.h:71
@ DM_CORNER
Definition: pns_router.h:72
@ DM_ANY
Definition: pns_router.h:77
@ DM_FREE_ANGLE
Definition: pns_router.h:75
@ DM_VIA
Definition: pns_router.h:74
@ DM_SEGMENT
Definition: pns_router.h:73
@ DM_ARC
Definition: pns_router.h:76
@ DM_COMPONENT
Definition: pns_router.h:78