KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023 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>
35#include <pcbnew_settings.h>
36#include <pcb_painter.h>
38#include <layer_ids.h>
39#include <pcb_base_frame.h>
40#include <view/view.h>
41
42#include <memory>
43#include <utility>
44
45
46RATSNEST_VIEW_ITEM::RATSNEST_VIEW_ITEM( std::shared_ptr<CONNECTIVITY_DATA> aData ) :
48 m_data( std::move( aData ) )
49{
50}
51
52
54{
55 // Make it always visible
56 BOX2I bbox;
57 bbox.SetMaximum();
58
59 return bbox;
60}
61
62
63void RATSNEST_VIEW_ITEM::ViewDraw( int aLayer, KIGFX::VIEW* aView ) const
64{
65 std::unique_lock<KISPINLOCK> lock( m_data->GetLock(), std::try_to_lock );
66
67 if( !lock )
68 return;
69
70 constexpr int CROSS_SIZE = 200000;
71
72 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
73
74 if( !cfg )
75 return;
76
77 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( aView->GetPainter()->GetSettings() );
78 KIGFX::GAL* gal = aView->GetGAL();
79 gal->SetIsStroke( true );
80 gal->SetIsFill( false );
82
83 std::set<int> highlightedNets = rs->GetHighlightNetCodes();
84 const std::set<int>& hiddenNets = rs->GetHiddenNets();
85
86 COLOR4D defaultColor = rs->GetColor( nullptr, LAYER_RATSNEST );
87 COLOR4D color = defaultColor;
88 const bool colorByNet = rs->GetNetColorMode() != NET_COLOR_MODE::OFF;
89 const bool dimStatic = m_data->GetLocalRatsnest().size() > 0 || highlightedNets.size() > 0;
90
91 std::map<int, KIGFX::COLOR4D>& netColors = rs->GetNetColorMap();
92 std::map<wxString, KIGFX::COLOR4D>& ncColors = rs->GetNetclassColorMap();
93 const std::map<int, wxString>& ncMap = m_data->GetNetclassMap();
94
95 const bool onlyVisibleLayers = cfg->m_Display.m_RatsnestMode == RATSNEST_MODE::VISIBLE;
96 LSET visibleLayers;
97
98 // If we are in "other layers off" mode, the active layer is the only visible layer
99 if( rs->m_ContrastModeDisplay == HIGH_CONTRAST_MODE::HIDDEN )
100 {
101 visibleLayers.set( rs->GetPrimaryHighContrastLayer() );
102 }
103 else
104 {
105 for( PCB_LAYER_ID layer : LSET::AllCuMask().Seq() )
106 {
107 if( aView->IsLayerVisible( layer ) )
108 visibleLayers.set( layer );
109 }
110 }
111
112 auto adjustColor =
113 [&]( COLOR4D& color_base, double brightnessDelta, double alpha )
114 {
115 if( rs->GetColor( nullptr, LAYER_PCB_BACKGROUND ).GetBrightness() < 0.5 )
116 return color_base.Brightened( brightnessDelta ).WithAlpha( std::min( alpha, 1.0 ) );
117 else
118 return color_base.Darkened( brightnessDelta ).WithAlpha( std::min( alpha, 1.0 ) );
119 };
120
122
123 // Draw the "dynamic" ratsnest (i.e. for objects that may be currently being moved)
124 for( const RN_DYNAMIC_LINE& l : m_data->GetLocalRatsnest() )
125 {
126 if( hiddenNets.count( l.netCode ) )
127 continue;
128
129 if( colorByNet && netColors.count( l.netCode ) )
130 color = netColors.at( l.netCode );
131 else if( colorByNet && ncMap.count( l.netCode ) && ncColors.count( ncMap.at( l.netCode ) ) )
132 color = ncColors.at( ncMap.at( l.netCode ) );
133 else
134 color = defaultColor;
135
136 if( color == COLOR4D::UNSPECIFIED )
137 color = defaultColor;
138
139 gal->SetStrokeColor( adjustColor( color, 0.5, color.a + 0.3 ) );
140
141 if( l.a == l.b )
142 {
143 gal->DrawLine( VECTOR2I( l.a.x - CROSS_SIZE, l.a.y - CROSS_SIZE ),
144 VECTOR2I( l.b.x + CROSS_SIZE, l.b.y + CROSS_SIZE ) );
145 gal->DrawLine( VECTOR2I( l.a.x - CROSS_SIZE, l.a.y + CROSS_SIZE ),
146 VECTOR2I( l.b.x + CROSS_SIZE, l.b.y - CROSS_SIZE ) );
147 }
148 else
149 {
150 if( curved_ratsnest )
151 {
152 int dx = l.b.x - l.a.x;
153 int dy = l.b.y - l.a.y;
154 const VECTOR2I center = VECTOR2I( l.a.x + 0.5 * dx - 0.1 * dy,
155 l.a.y + 0.5 * dy + 0.1 * dx );
156 gal->DrawCurve( l.a, center, center, l.b );
157 }
158 else
159 {
160 gal->DrawLine( l.a, l.b );
161 }
162 }
163 }
164
165 for( int i = 1 /* skip "No Net" at [0] */; i < m_data->GetNetCount(); ++i )
166 {
167 if( hiddenNets.count( i ) )
168 continue;
169
170 RN_NET* net = m_data->GetRatsnestForNet( i );
171
172 if( !net || m_data->GetConnectivityAlgo()->IsNetDirty( i ) )
173 continue;
174
175 if( colorByNet && netColors.count( i ) )
176 color = netColors.at( i );
177 else if( colorByNet && ncMap.count( i ) && ncColors.count( ncMap.at( i ) ) )
178 color = ncColors.at( ncMap.at( i ) );
179 else
180 color = defaultColor;
181
182 if( color == COLOR4D::UNSPECIFIED )
183 color = defaultColor;
184
185 if( dimStatic )
186 color = adjustColor( color, 0.0, color.a / 2 );
187
188 // Draw the "static" ratsnest
189 if( highlightedNets.count( i ) )
190 gal->SetStrokeColor( adjustColor( color, 0.8, color.a + 0.4 ) );
191 else
192 gal->SetStrokeColor( color ); // using the default ratsnest color for not highlighted
193
194 for( const CN_EDGE& edge : net->GetEdges() )
195 {
196 if( !edge.IsVisible() )
197 continue;
198
199 const std::shared_ptr<const CN_ANCHOR>& sourceNode = edge.GetSourceNode();
200 const std::shared_ptr<const CN_ANCHOR>& targetNode = edge.GetTargetNode();
201
202 if( !sourceNode || sourceNode->Dirty() || !targetNode || targetNode->Dirty() )
203 continue;
204
205 const VECTOR2I source( sourceNode->Pos() );
206 const VECTOR2I target( targetNode->Pos() );
207
208 bool enable = !sourceNode->GetNoLine() && !targetNode->GetNoLine();
209 bool show;
210
211 // If the global ratsnest is currently enabled, the local ratsnest should be easy to
212 // turn off, so either element can disable it.
213 // If the global ratsnest is disabled, the local ratsnest should be easy to turn on
214 // so either element can enable it.
216 {
217 show = sourceNode->Parent()->GetLocalRatsnestVisible() &&
218 targetNode->Parent()->GetLocalRatsnestVisible();
219 }
220 else
221 {
222 show = sourceNode->Parent()->GetLocalRatsnestVisible() ||
223 targetNode->Parent()->GetLocalRatsnestVisible();
224 }
225
226 if( onlyVisibleLayers && show )
227 {
228 LSET sourceLayers = sourceNode->Parent()->GetLayerSet();
229 LSET targetLayers = targetNode->Parent()->GetLayerSet();
230
231 if( !( sourceLayers & visibleLayers ).any() ||
232 !( targetLayers & visibleLayers ).any() )
233 {
234 show = false;
235 }
236 }
237
238 if ( enable && show )
239 {
240 if ( source == target )
241 {
242 gal->DrawLine( VECTOR2I( source.x - CROSS_SIZE, source.y - CROSS_SIZE ),
243 VECTOR2I( source.x + CROSS_SIZE, source.y + CROSS_SIZE ) );
244 gal->DrawLine( VECTOR2I( source.x - CROSS_SIZE, source.y + CROSS_SIZE ),
245 VECTOR2I( source.x + CROSS_SIZE, source.y - CROSS_SIZE ) );
246 }
247 else
248 {
249 if( curved_ratsnest )
250 {
251 int dx = target.x - source.x;
252 int dy = target.y - source.y;
253 const VECTOR2I center = VECTOR2I( source.x + 0.5 * dx - 0.1 * dy,
254 source.y + 0.5 * dy + 0.1 * dx );
255 gal->DrawCurve( source, center, center, target );
256 }
257 else
258 {
259 gal->DrawLine( source, target );
260 }
261 }
262 }
263 }
264 }
265}
266
267
268void RATSNEST_VIEW_ITEM::ViewGetLayers( int aLayers[], int& aCount ) const
269{
270 aCount = 1;
271 aLayers[0] = LAYER_RATSNEST;
272}
273
int color
Definition: DXF_plotter.cpp:58
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
@ curved_ratsnest
void SetMaximum()
Definition: box2.h:64
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:95
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
COLOR4D WithAlpha(double aAlpha) const
Return a color with the same color, but the given alpha.
Definition: color4d.h:311
COLOR4D Darkened(double aFactor) const
Return a color that is darker by a given factor, without modifying object.
Definition: color4d.h:282
COLOR4D Brightened(double aFactor) const
Return a color that is brighter by a given factor, without modifying object.
Definition: color4d.h:268
Abstract interface for drawing on a 2D-surface.
virtual void SetIsFill(bool aIsFillEnabled)
Enable/disable fill.
virtual void SetLineWidth(float aLineWidth)
Set the line width.
virtual void SetStrokeColor(const COLOR4D &aColor)
Set the stroke color.
virtual void SetIsStroke(bool aIsStrokeEnabled)
Enable/disable stroked outlines.
virtual void DrawLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a line.
virtual void DrawCurve(const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0)
Draw a cubic bezier spline.
double GetWorldScale() const
Get the world scale.
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:77
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
GAL * GetGAL() const
Return the #GAL this view is using to draw graphical primitives.
Definition: view.h:197
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:412
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:215
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:573
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:418
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:863
DISPLAY_OPTIONS m_Display
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:96
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:223
@ LAYER_RATSNEST
Definition: layer_ids.h:207
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
STL namespace.
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:588