KiCad PCB EDA Suite
ratsnest_view_item.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) 2013 CERN
5 * Copyright (C) 2018-2021 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
33#include <kiface_base.h>
34#include <pcbnew_settings.h>
35#include <pcb_painter.h>
37#include <layer_ids.h>
38#include <pcb_base_frame.h>
39#include <view/view.h>
40
41#include <memory>
42#include <utility>
43
44
45RATSNEST_VIEW_ITEM::RATSNEST_VIEW_ITEM( std::shared_ptr<CONNECTIVITY_DATA> aData ) :
46 EDA_ITEM( NOT_USED ), m_data( std::move(aData) )
47{
48}
49
50
52{
53 // Make it always visible
54 BOX2I bbox;
55 bbox.SetMaximum();
56
57 return bbox;
58}
59
60
61void RATSNEST_VIEW_ITEM::ViewDraw( int aLayer, KIGFX::VIEW* aView ) const
62{
63 std::unique_lock<KISPINLOCK> lock( m_data->GetLock(), std::try_to_lock );
64
65 if( !lock )
66 return;
67
68 constexpr int CROSS_SIZE = 200000;
69
70 auto gal = aView->GetGAL();
71 gal->SetIsStroke( true );
72 gal->SetIsFill( false );
73 gal->SetLineWidth( 1.0 );
74 auto cfg = static_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
75
76 if( !cfg )
77 return;
78
79 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( aView->GetPainter()->GetSettings() );
80
81 COLOR4D defaultColor = rs->GetColor( nullptr, LAYER_RATSNEST );
82 COLOR4D color = defaultColor;
83 const bool colorByNet = rs->GetNetColorMode() != NET_COLOR_MODE::OFF;
84
85 std::set<int> highlightedNets = rs->GetHighlightNetCodes();
86 const std::set<int>& hiddenNets = rs->GetHiddenNets();
87
88 std::map<int, KIGFX::COLOR4D>& netColors = rs->GetNetColorMap();
89 std::map<wxString, KIGFX::COLOR4D>& ncColors = rs->GetNetclassColorMap();
90 const std::map<int, wxString>& ncMap = m_data->GetNetclassMap();
91
92 const bool onlyVisibleLayers = cfg->m_Display.m_RatsnestMode == RATSNEST_MODE::VISIBLE;
93 LSET visibleLayers;
94
95 // If we are in "other layers off" mode, the active layer is the only visible layer
96 if( rs->m_ContrastModeDisplay == HIGH_CONTRAST_MODE::HIDDEN )
97 {
98 visibleLayers.set( rs->GetPrimaryHighContrastLayer() );
99 }
100 else
101 {
102 for( PCB_LAYER_ID layer : LSET::AllCuMask().Seq() )
103 {
104 if( aView->IsLayerVisible( layer ) )
105 visibleLayers.set( layer );
106 }
107 }
108
109 const bool curved_ratsnest = cfg->m_Display.m_DisplayRatsnestLinesCurved;
110
111 // Draw the "dynamic" ratsnest (i.e. for objects that may be currently being moved)
112 for( const RN_DYNAMIC_LINE& l : m_data->GetLocalRatsnest() )
113 {
114 if( hiddenNets.count( l.netCode ) )
115 continue;
116
117 if( colorByNet && netColors.count( l.netCode ) )
118 color = netColors.at( l.netCode );
119 else if( colorByNet && ncMap.count( l.netCode ) && ncColors.count( ncMap.at( l.netCode ) ) )
120 color = ncColors.at( ncMap.at( l.netCode ) );
121 else
122 color = defaultColor;
123
124 if( color == COLOR4D::UNSPECIFIED )
125 color = defaultColor;
126
127 gal->SetStrokeColor( color.Brightened( 0.5 ).WithAlpha( std::min( 1.0, color.a + 0.4 ) ) );
128
129 if( l.a == l.b )
130 {
131 gal->DrawLine( VECTOR2I( l.a.x - CROSS_SIZE, l.a.y - CROSS_SIZE ),
132 VECTOR2I( l.b.x + CROSS_SIZE, l.b.y + CROSS_SIZE ) );
133 gal->DrawLine( VECTOR2I( l.a.x - CROSS_SIZE, l.a.y + CROSS_SIZE ),
134 VECTOR2I( l.b.x + CROSS_SIZE, l.b.y - CROSS_SIZE ) );
135 }
136 else
137 {
138 if( curved_ratsnest )
139 {
140 int dx = l.b.x - l.a.x;
141 int dy = l.b.y - l.a.y;
142 const VECTOR2I center = VECTOR2I( l.a.x + 0.5 * dx - 0.1 * dy,
143 l.a.y + 0.5 * dy + 0.1 * dx );
144 gal->DrawCurve( l.a, center, center, l.b );
145 }
146 else
147 {
148 gal->DrawLine( l.a, l.b );
149 }
150 }
151 }
152
153 for( int i = 1 /* skip "No Net" at [0] */; i < m_data->GetNetCount(); ++i )
154 {
155 if( hiddenNets.count( i ) )
156 continue;
157
158 RN_NET* net = m_data->GetRatsnestForNet( i );
159
160 if( !net )
161 continue;
162
163 if( colorByNet && netColors.count( i ) )
164 color = netColors.at( i );
165 else if( colorByNet && ncMap.count( i ) && ncColors.count( ncMap.at( i ) ) )
166 color = ncColors.at( ncMap.at( i ) );
167 else
168 color = defaultColor;
169
170 if( color == COLOR4D::UNSPECIFIED )
171 color = defaultColor;
172
173 // Draw the "static" ratsnest
174 if( highlightedNets.count( i ) )
175 gal->SetStrokeColor( color.Brightened( 0.8 ) );
176 else
177 gal->SetStrokeColor( color ); // using the default ratsnest color for not highlighted
178
179 for( const CN_EDGE& edge : net->GetEdges() )
180 {
181 if( !edge.IsVisible() )
182 continue;
183
184 const std::shared_ptr<CN_ANCHOR>& sourceNode = edge.GetSourceNode();
185 const std::shared_ptr<CN_ANCHOR>& targetNode = edge.GetTargetNode();
186 const VECTOR2I source( sourceNode->Pos() );
187 const VECTOR2I target( targetNode->Pos() );
188
189 if( !sourceNode->Valid() || !targetNode->Valid() )
190 continue;
191
192 bool enable = !sourceNode->GetNoLine() && !targetNode->GetNoLine();
193 bool show;
194
195 // If the global ratsnest is currently enabled, the local ratsnest should be easy to
196 // turn off, so either element can disable it.
197 // If the global ratsnest is disabled, the local ratsnest should be easy to turn on
198 // so either element can enable it.
199 if( cfg->m_Display.m_ShowGlobalRatsnest )
200 {
201 show = sourceNode->Parent()->GetLocalRatsnestVisible() &&
202 targetNode->Parent()->GetLocalRatsnestVisible();
203 }
204 else
205 {
206 show = sourceNode->Parent()->GetLocalRatsnestVisible() ||
207 targetNode->Parent()->GetLocalRatsnestVisible();
208 }
209
210 if( onlyVisibleLayers && show )
211 {
212 LSET sourceLayers = sourceNode->Parent()->GetLayerSet();
213 LSET targetLayers = targetNode->Parent()->GetLayerSet();
214
215 if( !( sourceLayers & visibleLayers ).any() ||
216 !( targetLayers & visibleLayers ).any() )
217 {
218 show = false;
219 }
220 }
221
222 if ( enable && show )
223 {
224 if ( source == target )
225 {
226 gal->DrawLine( VECTOR2I( source.x - CROSS_SIZE, source.y - CROSS_SIZE ),
227 VECTOR2I( source.x + CROSS_SIZE, source.y + CROSS_SIZE ) );
228 gal->DrawLine( VECTOR2I( source.x - CROSS_SIZE, source.y + CROSS_SIZE ),
229 VECTOR2I( source.x + CROSS_SIZE, source.y - CROSS_SIZE ) );
230 }
231 else
232 {
233 if( curved_ratsnest )
234 {
235 int dx = target.x - source.x;
236 int dy = target.y - source.y;
237 const VECTOR2I center = VECTOR2I( source.x + 0.5 * dx - 0.1 * dy,
238 source.y + 0.5 * dy + 0.1 * dx );
239 gal->DrawCurve( source, center, center, target );
240 }
241 else
242 {
243 gal->DrawLine( source, target );
244 }
245 }
246 }
247 }
248 }
249}
250
251
252void RATSNEST_VIEW_ITEM::ViewGetLayers( int aLayers[], int& aCount ) const
253{
254 aCount = 1;
255 aLayers[0] = LAYER_RATSNEST;
256}
257
int color
Definition: DXF_plotter.cpp:57
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
@ curved_ratsnest
@ HIDDEN
Inactive layers are hidden.
@ OFF
Net (and netclass) colors are not shown.
@ VISIBLE
Ratsnest lines are drawn to items on visible layers only.
void SetMaximum()
Definition: box2.h:63
CN_EDGE represents a point-to-point connection, whether realized or unrealized (ie: tracks etc.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:93
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
double b
Blue component.
Definition: color4d.h:386
virtual void SetIsStroke(bool aIsStrokeEnabled)
Enable/disable stroked outlines.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
Definition: pcb_painter.h:72
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
GAL * GetGAL() const
Return the #GAL this view is using to draw graphical primitives.
Definition: view.h:195
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:410
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:213
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:530
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:411
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:773
const BOX2I ViewBBox() const override
RATSNEST_VIEW_ITEM(std::shared_ptr< CONNECTIVITY_DATA > aData)
Class that draws missing connections on a PCB.
std::shared_ptr< CONNECTIVITY_DATA > m_data
Object containing ratsnest data.
void ViewGetLayers(int aLayers[], int &aCount) const override
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override
Describe ratsnest for a single net.
Definition: ratsnest_data.h:63
const std::vector< CN_EDGE > & GetEdges() const
Definition: ratsnest_data.h:90
@ LAYER_RATSNEST
Definition: layer_ids.h:204
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:59
Definition: bitmap.cpp:64
Class that computes missing connections on a PCB.
@ NOT_USED
the 3d code uses this value
Definition: typeinfo.h:79
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618