KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ratsnest_data.h
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) 2013-2015 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
32#ifndef RATSNEST_DATA_H
33#define RATSNEST_DATA_H
34
35#include <algorithm>
36#include <core/typeinfo.h>
37#include <math/box2.h>
38
39#include <set>
40#include <vector>
41
43
44class BOARD_ITEM;
46class CN_CLUSTER;
47
49{
50 bool operator()( const std::shared_ptr<CN_ANCHOR>& aItem,
51 const std::shared_ptr<CN_ANCHOR>& bItem ) const
52 {
53 if( aItem->Pos().x == bItem->Pos().x )
54 return aItem->Pos().y < bItem->Pos().y;
55 else
56 return aItem->Pos().x < bItem->Pos().x;
57 }
58};
59
63class RN_NET
64{
65public:
66 RN_NET();
67
74 bool IsDirty() const { return m_dirty; }
75
79 void UpdateNet();
80
81 void RemoveInvalidRefs();
82
89 void OptimizeRNEdges();
90
91 void Clear();
92
93 void AddCluster( std::shared_ptr<CN_CLUSTER> aCluster );
94
95 unsigned int GetNodeCount() const { return m_nodes.size(); }
96
97 const std::vector<CN_EDGE>& GetEdges() const
98 {
99 // Use a const_cast to allow sorting in the const method
100 // This is safe because we're not changing the logical content of the vector,
101 // just the ordering of elements
102 std::stable_sort( const_cast<std::vector<CN_EDGE>&>( m_rnEdges ).begin(),
103 const_cast<std::vector<CN_EDGE>&>( m_rnEdges ).end(),
104 []( const CN_EDGE& a, const CN_EDGE& b )
105 {
106 return a.StableSortCompare( b );
107 } );
108 return m_rnEdges;
109 }
110 std::vector<CN_EDGE>& GetEdges()
111 {
112 std::stable_sort( m_rnEdges.begin(), m_rnEdges.end(),
113 []( const CN_EDGE& a, const CN_EDGE& b )
114 {
115 return a.StableSortCompare( b );
116 } );
117 return m_rnEdges;
118 }
119
120 bool NearestBicoloredPair( RN_NET* aOtherNet, VECTOR2I& aPos1, VECTOR2I& aPos2 ) const;
121
122protected:
124 void compute();
125
127 void kruskalMST( const std::vector<CN_EDGE> &aEdges );
128
129protected:
131 std::multiset<std::shared_ptr<CN_ANCHOR>, CN_PTR_CMP> m_nodes;
132
134 std::vector<CN_EDGE> m_boardEdges;
135
137 std::vector<CN_EDGE> m_rnEdges;
138
141
142 class TRIANGULATOR_STATE;
143
144 std::shared_ptr<TRIANGULATOR_STATE> m_triangulator;
145};
146
147#endif /* RATSNEST_DATA_H */
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:79
CN_EDGE represents a point-to-point connection, whether realized or unrealized (ie: tracks etc.
bool StableSortCompare(const CN_EDGE &aOther) const
Comparison operator for std::stable_sort.
Describe ratsnest for a single net.
Definition: ratsnest_data.h:64
unsigned int GetNodeCount() const
Definition: ratsnest_data.h:95
std::shared_ptr< TRIANGULATOR_STATE > m_triangulator
std::multiset< std::shared_ptr< CN_ANCHOR >, CN_PTR_CMP > m_nodes
< Vector of nodes
void RemoveInvalidRefs()
void kruskalMST(const std::vector< CN_EDGE > &aEdges)
void UpdateNet()
Recompute ratsnest for a net.
std::vector< CN_EDGE > & GetEdges()
const std::vector< CN_EDGE > & GetEdges() const
Definition: ratsnest_data.h:97
std::vector< CN_EDGE > m_rnEdges
Flag indicating necessity of recalculation of ratsnest for a net.
void OptimizeRNEdges()
Find optimal ends of RNEdges.
bool NearestBicoloredPair(RN_NET *aOtherNet, VECTOR2I &aPos1, VECTOR2I &aPos2) const
bool m_dirty
std::vector< CN_EDGE > m_boardEdges
Vector of edges that makes ratsnest for a given net.
void compute()
< Recompute ratsnest from scratch.
bool IsDirty() const
Return state of the 'dirty' flag, indicating that ratsnest for a given net is invalid and requires an...
Definition: ratsnest_data.h:74
void Clear()
void AddCluster(std::shared_ptr< CN_CLUSTER > aCluster)
bool operator()(const std::shared_ptr< CN_ANCHOR > &aItem, const std::shared_ptr< CN_ANCHOR > &bItem) const
Definition: ratsnest_data.h:50
VECTOR2I end