KiCad PCB EDA Suite
zone_create_helper.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) 2017-2019 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #include <core/spinlock.h>
27 #include <tool/tool_manager.h>
28 #include <zone.h>
29 #include <pcb_shape.h>
30 #include <fp_shape.h>
31 #include <board_commit.h>
32 #include <pcb_painter.h>
33 #include <pcbnew_settings.h>
34 #include <tools/pcb_actions.h>
36 #include <zone_filler.h>
37 
39  m_tool( aTool ),
40  m_params( aParams ),
41  m_parentView( *aTool.getView() )
42 {
44 }
45 
46 
48 {
49  // remove the preview from the view
52 }
53 
54 
55 std::unique_ptr<ZONE> ZONE_CREATE_HELPER::createNewZone( bool aKeepout )
56 {
58  BOARD* board = frame->GetBoard();
61  std::set<int> highlightedNets = board->GetHighLightNetCodes();
62 
63  // Get the current default settings for zones
64  ZONE_SETTINGS zoneInfo = frame->GetZoneSettings();
65  zoneInfo.m_Layers.reset().set( m_params.m_layer ); // TODO(JE) multilayer defaults?
66  zoneInfo.m_NetcodeSelection = highlightedNets.empty() ? -1 : *highlightedNets.begin();
67  zoneInfo.SetIsRuleArea( m_params.m_keepout );
69 
70  // If we don't have a net from highlighing, maybe we can get one from the selection
72 
73  if( selectionTool && !selectionTool->GetSelection().Empty()
74  && zoneInfo.m_NetcodeSelection == -1 )
75  {
76  EDA_ITEM* item = *selectionTool->GetSelection().GetItems().begin();
77 
78  if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
79  zoneInfo.m_NetcodeSelection = bci->GetNetCode();
80  }
81 
83  {
84  // Get the current default settings for zones
85 
86  // Show options dialog
87  int dialogResult;
88 
89  if( m_params.m_keepout )
90  dialogResult = InvokeRuleAreaEditor( frame, &zoneInfo );
91  else
92  {
93  // TODO(JE) combine these dialogs?
94  if( ( zoneInfo.m_Layers & LSET::AllCuMask() ).any() )
95  dialogResult = InvokeCopperZonesEditor( frame, &zoneInfo );
96  else
97  dialogResult = InvokeNonCopperZonesEditor( frame, &zoneInfo );
98  }
99 
100  if( dialogResult == wxID_CANCEL )
101  return nullptr;
102 
103  controls->WarpCursor( controls->GetCursorPosition(), true );
104  }
105 
106  // The new zone is a ZONE if created in the board editor and a FP_ZONE if created in the
107  // footprint editor
108  wxASSERT( !m_tool.m_isFootprintEditor || ( parent->Type() == PCB_FOOTPRINT_T ) );
109 
110  std::unique_ptr<ZONE> newZone = m_tool.m_isFootprintEditor ?
111  std::make_unique<FP_ZONE>( parent ) :
112  std::make_unique<ZONE>( parent );
113 
114  // Apply the selected settings
115  zoneInfo.ExportSetting( *newZone );
116 
117  return newZone;
118 }
119 
120 
121 std::unique_ptr<ZONE> ZONE_CREATE_HELPER::createZoneFromExisting( const ZONE& aSrcZone )
122 {
123  BOARD* board = m_tool.getModel<BOARD>();
124 
125  std::unique_ptr<ZONE> newZone = std::make_unique<ZONE>( board );
126 
127  ZONE_SETTINGS zoneSettings;
128  zoneSettings << aSrcZone;
129 
130  zoneSettings.ExportSetting( *newZone );
131 
132  return newZone;
133 }
134 
135 
136 void ZONE_CREATE_HELPER::performZoneCutout( ZONE& aZone, const ZONE& aCutout )
137 {
138  BOARD_COMMIT commit( &m_tool );
139  std::vector<ZONE*> newZones;
140 
141  // Clear the selection before removing the old zone
142  auto toolMgr = m_tool.GetManager();
143  toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
144 
145  SHAPE_POLY_SET originalOutline( *aZone.Outline() );
146  originalOutline.BooleanSubtract( *aCutout.Outline(), SHAPE_POLY_SET::PM_FAST );
147 
148  // After substracting the hole, originalOutline can have more than one
149  // main outline.
150  // But a zone can have only one main outline, so create as many zones as
151  // originalOutline contains main outlines:
152  for( int outline = 0; outline < originalOutline.OutlineCount(); outline++ )
153  {
154  auto newZoneOutline = new SHAPE_POLY_SET;
155  newZoneOutline->AddOutline( originalOutline.Outline( outline ) );
156 
157  // Add holes (if any) to thez new zone outline:
158  for (int hole = 0; hole < originalOutline.HoleCount( outline ) ; hole++ )
159  newZoneOutline->AddHole( originalOutline.CHole( outline, hole ) );
160 
161  auto newZone = new ZONE( aZone );
162  newZone->SetOutline( newZoneOutline );
163  newZone->SetLocalFlags( 1 );
164  newZone->HatchBorder();
165  newZone->UnFill();
166  newZones.push_back( newZone );
167  commit.Add( newZone );
168  }
169 
170  commit.Remove( &aZone );
171 
172  // TODO Refill zones when KiCad supports auto re-fill
173 
174  commit.Push( _( "Add a zone cutout" ) );
175 
176  // Select the new zone and set it as the source for the next cutout
177  if( newZones.empty() )
178  {
179  m_params.m_sourceZone = nullptr;
180  }
181  else
182  {
183  m_params.m_sourceZone = newZones[0];
184  toolMgr->RunAction( PCB_ACTIONS::selectItem, true, newZones[0] );
185  }
186 
187 }
188 
189 
190 void ZONE_CREATE_HELPER::commitZone( std::unique_ptr<ZONE> aZone )
191 {
192  switch ( m_params.m_mode )
193  {
194  case ZONE_MODE::CUTOUT:
195  // For cutouts, subtract from the source
197  break;
198 
199  case ZONE_MODE::ADD:
200  case ZONE_MODE::SIMILAR:
201  {
202  BOARD_COMMIT commit( &m_tool );
203  BOARD* board = m_tool.getModel<BOARD>();
204 
205  aZone->HatchBorder();
206 
207  // TODO Refill zones when KiCad supports auto re-fill
208 
209  commit.Add( aZone.get() );
210 
211  std::lock_guard<KISPINLOCK> lock( board->GetConnectivity()->GetLock() );
212 
213  commit.Push( _( "Add a zone" ) );
214  m_tool.GetManager()->RunAction( PCB_ACTIONS::selectItem, true, aZone.release() );
215  break;
216  }
217 
219  {
220  BOARD_COMMIT commit( &m_tool );
221  BOARD* board = m_tool.getModel<BOARD>();
222  PCB_LAYER_ID layer = m_params.m_layer;
223  PCB_SHAPE* poly;
224 
226  poly = new FP_SHAPE( static_cast<FOOTPRINT*>( m_tool.m_frame->GetModel() ) );
227  else
228  poly = new PCB_SHAPE();
229 
231 
232  if( layer == Edge_Cuts || layer == F_CrtYd || layer == B_CrtYd )
233  poly->SetFilled( false );
234  else
235  poly->SetFilled( true );
236 
238  poly->SetLayer( layer );
239  poly->SetPolyShape( *aZone->Outline() );
240 
241  commit.Add( poly );
243 
244  commit.Push( _( "Add a graphical polygon" ) );
245 
246  break;
247  }
248  }
249 }
250 
251 
253 {
254  // if we don't have a zone, create one
255  // the user's choice here can affect things like the colour of the preview
256  if( !m_zone )
257  {
258  if( m_params.m_sourceZone )
260  else
262 
263  if( m_zone )
264  {
266 
267  // set up poperties from zone
268  const auto& settings = *m_parentView.GetPainter()->GetSettings();
269  COLOR4D color = settings.GetColor( nullptr, m_zone->GetLayer() );
270 
272  m_previewItem.SetFillColor( color.WithAlpha( 0.2 ) );
273 
275 
278  }
279  }
280 
281  return m_zone != nullptr;
282 }
283 
284 
286 {
287  // send the points to the preview item
290 }
291 
292 
294 {
295  auto& finalPoints = aMgr.GetLockedInPoints();
296 
297  if( finalPoints.PointCount() < 3 )
298  {
299  // just scrap the zone in progress
300  m_zone = nullptr;
301  }
302  else
303  {
304  // if m_params.m_mode == DRAWING_TOOL::ZONE_MODE::CUTOUT, m_zone
305  // will be merged to the existing zone as a new hole.
306  m_zone->Outline()->NewOutline();
307  auto* outline = m_zone->Outline();
308 
309  for( int i = 0; i < finalPoints.PointCount(); ++i )
310  outline->Append( finalPoints.CPoint( i ) );
311 
312  // In DEG45 mode, we may have intermediate points in the leader that should be
313  // included as they are shown in the preview. These typically maintain the
314  // 45 constraint
316  {
317  const auto& pts = aMgr.GetLeaderLinePoints();
318  for( int i = 1; i < pts.PointCount(); i++ )
319  outline->Append( pts.CPoint( i ) );
320  }
321 
322  outline->Outline( 0 ).SetClosed( true );
323  outline->RemoveNullSegments();
324  outline->Simplify( SHAPE_POLY_SET::PM_FAST );
325 
326  // hand the zone over to the committer
327  commitZone( std::move( m_zone ) );
328  m_zone = nullptr;
329  }
330 
332 }
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:63
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
void OnComplete(const POLYGON_GEOM_MANAGER &aMgr) override
Add a new zone with the same settings as an existing one.
T * getModel() const
Return the model object if it matches the requested type.
Definition: tool_base.h:197
ZONE * m_sourceZone
Zone leader mode.
void SetStrokeColor(const COLOR4D &aNewColor)
Set the fill color to set before drawing preview.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:194
COMMIT & Add(EDA_ITEM *aItem)
Notify observers that aItem has been added.
Definition: commit.h:78
const SHAPE_LINE_CHAIN & GetLeaderLinePoints() const
Get the points comprising the leader line (the line from the last locked-in point to the current curs...
void SetFilled(bool aFlag)
Definition: pcb_shape.h:94
int InvokeNonCopperZonesEditor(PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings)
Function InvokeNonCopperZonesEditor invokes up a modal dialog window for non-copper zone editing.
SHAPE_POLY_SET * Outline()
Definition: zone.h:317
ZONE_CREATE_HELPER(DRAWING_TOOL &aTool, PARAMS &aParams)
int color
Definition: DXF_plotter.cpp:60
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:352
DRAWING_TOOL & m_tool
Parameters of the zone to be drawn.
PCB_LAYER_ID m_layer
The zone mode to operate in.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:593
KIGFX::PREVIEW::POLYGON_ITEM m_previewItem
view that show the preview item
Parameters used to fully describe a zone creation process.
void SetLeaderMode(LEADER_MODE aMode)
Set the leader mode to use when calculating the leader/returner lines.
LEADER_MODE GetLeaderMode() const
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
void Append(int aX, int aY, bool aAllowDuplication=false)
Function Append()
TOOL_MANAGER * GetManager() const
Return the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:144
polygon (not yet used for tracks, but could be in microwave apps)
int GetLineThickness(PCB_LAYER_ID aLayer) const
Return the default graphic segment thickness from the layer class for the given layer.
int m_NetcodeSelection
Definition: zone_settings.h:93
PCB_SELECTION & GetSelection()
Return the set of currently selected items.
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
If enabled (.
PCB_LAYER_ID
A quick note on layer IDs:
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
Definition: drawing_tool.h:50
Represent a set of closed polygons.
const ZONE_SETTINGS & GetZoneSettings() const
KIGFX::VIEW & m_parentView
The zone-in-progress.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:416
const std::deque< EDA_ITEM * > GetItems() const
Definition: selection.h:133
An interface for classes handling user events controlling the view behavior such as zooming,...
Add a new zone/keepout with fresh settings.
bool OnFirstPoint(POLYGON_GEOM_MANAGER &aMgr) override
Called before the first point is added - clients can do initialization here, and can veto the start o...
void commitZone(std::unique_ptr< ZONE > aZone)
Commit the current zone-in-progress to the BOARD.
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
COMMIT & Remove(EDA_ITEM *aItem)
Notify observers that aItem has been removed.
Definition: commit.h:90
Unconstrained point-to-point.
void SetFillColor(const COLOR4D &aNewColor)
Set the line width to set before drawing preview.
void SetIsRuleArea(bool aEnable)
bool m_isFootprintEditor
void performZoneCutout(ZONE &aZone, const ZONE &aCutout)
Cut one zone out of another one (i.e.
int InvokeRuleAreaEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeRuleAreaEditor invokes up a modal dialog window for copper zone editing.
Make a cutout to an existing zone.
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:122
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
PCB_BASE_EDIT_FRAME * m_frame
Definition: drawing_tool.h:270
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:67
PARAMS & m_params
The preview item to display.
virtual BOARD_ITEM_CONTAINER * GetModel() const =0
Definition: color4d.h:48
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new hole to the given outline (default: last) and returns its index.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Definition: tool_manager.h:291
void OnGeometryChange(const POLYGON_GEOM_MANAGER &aMgr) override
Called when the polygon is complete.
std::unique_ptr< ZONE > createZoneFromExisting(const ZONE &aSrcZone)
Create a new zone with the settings from an existing zone.
std::unique_ptr< ZONE > m_zone
Common, abstract interface for edit frames.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
Definition: pcb_actions.h:66
void SetWidth(int aWidth)
Definition: pcb_shape.h:117
The selection tool: currently supports:
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
virtual void Push(const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=true) override
Revert the commit by restoring the modified items state.
void SetPoints(const SHAPE_LINE_CHAIN &aLockedInPts, const SHAPE_LINE_CHAIN &aLeaderPts)
Set the polygon points.
T * getEditFrame() const
Return the application window object, casted to requested user type.
Definition: tool_base.h:185
int InvokeCopperZonesEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeCopperZonesEditor invokes up a modal dialog window for copper zone editing.
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1449
void SetPolyShape(const SHAPE_POLY_SET &aShape)
Definition: pcb_shape.h:276
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:322
const SHAPE_LINE_CHAIN & GetLockedInPoints() const
Get the "locked-in" points that describe the polygon itself.
std::unique_ptr< ZONE > createNewZone(bool aKeepout)
Prompt the user for new zone settings, and create a new zone with those settings.
void BooleanSubtract(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset intersection For aFastMode meaning, see function booleanOp.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
BOARD * GetBoard() const
POLYGON_GEOM_MANAGER::LEADER_MODE m_leaderMode
bool m_keepout
< Should create a keepout zone?
void SetShape(PCB_SHAPE_TYPE aShape)
Definition: pcb_shape.h:129
Class that handles the drawing of a polygon, including management of last corner deletion and drawing...
ZONE_MODE m_mode
Zone settings source (for similar and cutout zones)
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1503
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163
Position or shape has changed.
Definition: view_item.h:54
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98