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 <footprint.h>
31 #include <fp_shape.h>
32 #include <board_commit.h>
33 #include <board_design_settings.h>
34 #include <pcb_painter.h>
35 #include <pcbnew_settings.h>
36 #include <tools/pcb_actions.h>
38 #include <zone_filler.h>
39 
41  m_tool( aTool ),
42  m_params( aParams ),
43  m_parentView( *aTool.getView() )
44 {
46 }
47 
48 
50 {
51  // remove the preview from the view
54 }
55 
56 
57 std::unique_ptr<ZONE> ZONE_CREATE_HELPER::createNewZone( bool aKeepout )
58 {
60  BOARD* board = frame->GetBoard();
63  std::set<int> highlightedNets = board->GetHighLightNetCodes();
64 
65  // Get the current default settings for zones
66  ZONE_SETTINGS zoneInfo = frame->GetZoneSettings();
67  zoneInfo.m_Layers.reset().set( m_params.m_layer ); // TODO(JE) multilayer defaults?
68  zoneInfo.m_NetcodeSelection = highlightedNets.empty() ? -1 : *highlightedNets.begin();
69  zoneInfo.SetIsRuleArea( m_params.m_keepout );
71 
72  // If we don't have a net from highlighting, maybe we can get one from the selection
74 
75  if( selectionTool && !selectionTool->GetSelection().Empty()
76  && zoneInfo.m_NetcodeSelection == -1 )
77  {
78  EDA_ITEM* item = *selectionTool->GetSelection().GetItems().begin();
79 
80  if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
81  zoneInfo.m_NetcodeSelection = bci->GetNetCode();
82  }
83 
85  {
86  // Get the current default settings for zones
87 
88  // Show options dialog
89  int dialogResult;
90 
91  if( m_params.m_keepout )
92  dialogResult = InvokeRuleAreaEditor( frame, &zoneInfo );
93  else
94  {
95  // TODO(JE) combine these dialogs?
96  if( ( zoneInfo.m_Layers & LSET::AllCuMask() ).any() )
97  dialogResult = InvokeCopperZonesEditor( frame, &zoneInfo );
98  else
99  dialogResult = InvokeNonCopperZonesEditor( frame, &zoneInfo );
100  }
101 
102  if( dialogResult == wxID_CANCEL )
103  return nullptr;
104 
105  controls->WarpCursor( controls->GetCursorPosition(), true );
106  }
107 
108  // The new zone is a ZONE if created in the board editor and a FP_ZONE if created in the
109  // footprint editor
110  wxASSERT( !m_tool.m_isFootprintEditor || ( parent->Type() == PCB_FOOTPRINT_T ) );
111 
112  std::unique_ptr<ZONE> newZone = m_tool.m_isFootprintEditor ?
113  std::make_unique<FP_ZONE>( parent ) :
114  std::make_unique<ZONE>( parent );
115 
116  // Apply the selected settings
117  zoneInfo.ExportSetting( *newZone );
118 
119  return newZone;
120 }
121 
122 
123 std::unique_ptr<ZONE> ZONE_CREATE_HELPER::createZoneFromExisting( const ZONE& aSrcZone )
124 {
125  BOARD* board = m_tool.getModel<BOARD>();
126 
127  std::unique_ptr<ZONE> newZone = std::make_unique<ZONE>( board );
128 
129  ZONE_SETTINGS zoneSettings;
130  zoneSettings << aSrcZone;
131 
132  zoneSettings.ExportSetting( *newZone );
133 
134  return newZone;
135 }
136 
137 
138 void ZONE_CREATE_HELPER::performZoneCutout( ZONE& aZone, const ZONE& aCutout )
139 {
140  BOARD_COMMIT commit( &m_tool );
141  std::vector<ZONE*> newZones;
142 
143  // Clear the selection before removing the old zone
144  auto toolMgr = m_tool.GetManager();
145  toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
146 
147  SHAPE_POLY_SET originalOutline( *aZone.Outline() );
148  originalOutline.BooleanSubtract( *aCutout.Outline(), SHAPE_POLY_SET::PM_FAST );
149 
150  // After substracting the hole, originalOutline can have more than one
151  // main outline.
152  // But a zone can have only one main outline, so create as many zones as
153  // originalOutline contains main outlines:
154  for( int outline = 0; outline < originalOutline.OutlineCount(); outline++ )
155  {
156  auto newZoneOutline = new SHAPE_POLY_SET;
157  newZoneOutline->AddOutline( originalOutline.Outline( outline ) );
158 
159  // Add holes (if any) to thez new zone outline:
160  for (int hole = 0; hole < originalOutline.HoleCount( outline ) ; hole++ )
161  newZoneOutline->AddHole( originalOutline.CHole( outline, hole ) );
162 
163  auto newZone = new ZONE( aZone );
164  newZone->SetOutline( newZoneOutline );
165  newZone->SetLocalFlags( 1 );
166  newZone->HatchBorder();
167  newZone->UnFill();
168  newZones.push_back( newZone );
169  commit.Add( newZone );
170  }
171 
172  commit.Remove( &aZone );
173 
174  // TODO Refill zones when KiCad supports auto re-fill
175 
176  commit.Push( _( "Add a zone cutout" ) );
177 
178  // Select the new zone and set it as the source for the next cutout
179  if( newZones.empty() )
180  {
181  m_params.m_sourceZone = nullptr;
182  }
183  else
184  {
185  m_params.m_sourceZone = newZones[0];
186  toolMgr->RunAction( PCB_ACTIONS::selectItem, true, newZones[0] );
187  }
188 
189 }
190 
191 
192 void ZONE_CREATE_HELPER::commitZone( std::unique_ptr<ZONE> aZone )
193 {
194  switch ( m_params.m_mode )
195  {
196  case ZONE_MODE::CUTOUT:
197  // For cutouts, subtract from the source
199  break;
200 
201  case ZONE_MODE::ADD:
202  case ZONE_MODE::SIMILAR:
203  {
204  BOARD_COMMIT commit( &m_tool );
205  BOARD* board = m_tool.getModel<BOARD>();
206 
207  aZone->HatchBorder();
208 
209  // TODO Refill zones when KiCad supports auto re-fill
210 
211  commit.Add( aZone.get() );
212 
213  std::lock_guard<KISPINLOCK> lock( board->GetConnectivity()->GetLock() );
214 
215  commit.Push( _( "Add a zone" ) );
216  m_tool.GetManager()->RunAction( PCB_ACTIONS::selectItem, true, aZone.release() );
217  break;
218  }
219 
221  {
222  BOARD_COMMIT commit( &m_tool );
223  BOARD* board = m_tool.getModel<BOARD>();
224  PCB_LAYER_ID layer = m_params.m_layer;
225  PCB_SHAPE* poly;
226 
228  poly = new FP_SHAPE( static_cast<FOOTPRINT*>( m_tool.m_frame->GetModel() ) );
229  else
230  poly = new PCB_SHAPE();
231 
232  poly->SetShape( SHAPE_T::POLY );
233 
234  if( layer == Edge_Cuts || layer == F_CrtYd || layer == B_CrtYd )
235  poly->SetFilled( false );
236  else
237  poly->SetFilled( true );
238 
240  poly->SetLayer( layer );
241  poly->SetPolyShape( *aZone->Outline() );
242 
243  commit.Add( poly );
245 
246  commit.Push( _( "Add a graphical polygon" ) );
247 
248  break;
249  }
250  }
251 }
252 
253 
255 {
256  // if we don't have a zone, create one
257  // the user's choice here can affect things like the colour of the preview
258  if( !m_zone )
259  {
260  if( m_params.m_sourceZone )
262  else
264 
265  if( m_zone )
266  {
268 
269  // set up properties from zone
270  const auto& settings = *m_parentView.GetPainter()->GetSettings();
271  COLOR4D color = settings.GetColor( nullptr, m_zone->GetLayer() );
272 
274  m_previewItem.SetFillColor( color.WithAlpha( 0.2 ) );
275 
277 
280  }
281  }
282 
283  return m_zone != nullptr;
284 }
285 
286 
288 {
289  // send the points to the preview item
292 }
293 
294 
296 {
297  auto& finalPoints = aMgr.GetLockedInPoints();
298 
299  if( finalPoints.PointCount() < 3 )
300  {
301  // just scrap the zone in progress
302  m_zone = nullptr;
303  }
304  else
305  {
306  // if m_params.m_mode == DRAWING_TOOL::ZONE_MODE::CUTOUT, m_zone
307  // will be merged to the existing zone as a new hole.
308  m_zone->Outline()->NewOutline();
309  auto* outline = m_zone->Outline();
310 
311  for( int i = 0; i < finalPoints.PointCount(); ++i )
312  outline->Append( finalPoints.CPoint( i ) );
313 
314  // In DEG45 mode, we may have intermediate points in the leader that should be
315  // included as they are shown in the preview. These typically maintain the
316  // 45 constraint
318  {
319  const auto& pts = aMgr.GetLeaderLinePoints();
320  for( int i = 1; i < pts.PointCount(); i++ )
321  outline->Append( pts.CPoint( i ) );
322  }
323 
324  outline->Outline( 0 ).SetClosed( true );
325  outline->RemoveNullSegments();
326  outline->Simplify( SHAPE_POLY_SET::PM_FAST );
327 
328  // hand the zone over to the committer
329  commitZone( std::move( m_zone ) );
330  m_zone = nullptr;
331  }
332 
334 }
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:59
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:196
ZONE * m_sourceZone
Zone leader mode.
void SetStrokeColor(const COLOR4D &aNewColor)
Set the fill color to set before drawing preview.
void SetFilled(bool aFlag)
Definition: eda_shape.h:83
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:161
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 SetPolyShape(const SHAPE_POLY_SET &aShape)
Definition: eda_shape.h:215
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:320
ZONE_CREATE_HELPER(DRAWING_TOOL &aTool, PARAMS &aParams)
int color
Definition: DXF_plotter.cpp:57
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:348
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:143
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,...
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:590
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:208
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
TOOL_MANAGER * GetManager() const
Return the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:143
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 (.
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:344
const std::deque< EDA_ITEM * > GetItems() const
Definition: selection.h:109
An interface for classes handling user events controlling the view behavior such as zooming,...
#define _(s)
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 SetWidth(int aWidth)
Definition: eda_shape.h:88
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:56
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:98
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
PCB_BASE_EDIT_FRAME * m_frame
Definition: drawing_tool.h:267
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:285
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
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:65
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
Definition: pcb_actions.h:62
void SetShape(SHAPE_T aShape)
Definition: eda_shape.h:91
The selection tool: currently supports:
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
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:184
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:1458
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:318
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?
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:1512
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113
Position or shape has changed.
Definition: view_item.h:49
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103