24#include <wx/filedlg.h>
25#include <wx/hyperlink.h>
33using namespace std::placeholders;
113 .Name(
"pcbnew.InteractiveRouter.PlaceVia" )
115 .DefaultHotkey(
'V' )
116 .LegacyHotkeyName(
"Add Through Via" )
117 .FriendlyName(
_(
"Place Through Via" ) )
118 .Tooltip(
_(
"Adds a through-hole via at the end of currently routed track." ) )
124 .Name(
"pcbnew.InteractiveRouter.PlaceBlindVia" )
127 .LegacyHotkeyName(
"Add Blind/Buried Via" )
128 .FriendlyName(
_(
"Place Blind/Buried Via" ) )
129 .Tooltip(
_(
"Adds a blind or buried via at the end of currently routed track.") )
135 .Name(
"pcbnew.InteractiveRouter.PlaceMicroVia" )
137 .DefaultHotkey(
MD_CTRL +
'V' )
138 .LegacyHotkeyName(
"Add MicroVia" )
139 .FriendlyName(
_(
"Place Microvia" ) )
140 .Tooltip(
_(
"Adds a microvia at the end of currently routed track." ) )
146 .Name(
"pcbnew.InteractiveRouter.SelLayerAndPlaceVia" )
148 .DefaultHotkey(
'<' )
149 .LegacyHotkeyName(
"Select Layer and Add Through Via" )
150 .FriendlyName(
_(
"Select Layer and Place Through Via..." ) )
151 .Tooltip(
_(
"Select a layer, then add a through-hole via at the end of currently routed track." ) )
157 .Name(
"pcbnew.InteractiveRouter.SelLayerAndPlaceBlindVia" )
159 .DefaultHotkey(
MD_ALT +
'<' )
160 .LegacyHotkeyName(
"Select Layer and Add Blind/Buried Via" )
161 .FriendlyName(
_(
"Select Layer and Place Blind/Buried Via..." ) )
162 .Tooltip(
_(
"Select a layer, then add a blind or buried via at the end of currently routed track." ) )
168 .Name(
"pcbnew.InteractiveRouter.SelLayerAndPlaceMicroVia" )
170 .FriendlyName(
_(
"Select Layer and Place Micro Via..." ) )
171 .Tooltip(
_(
"Select a layer, then add a micro via at the end of currently routed track." ) )
177 .Name(
"pcbnew.InteractiveRouter.CustomTrackViaSize" )
179 .DefaultHotkey(
'Q' )
180 .LegacyHotkeyName(
"Custom Track/Via Size" )
181 .FriendlyName(
_(
"Custom Track/Via Size..." ) )
182 .Tooltip(
_(
"Shows a dialog for changing the track width and via size." ) )
186 .Name(
"pcbnew.InteractiveRouter.SwitchPosture" )
188 .DefaultHotkey(
'/' )
189 .LegacyHotkeyName(
"Switch Track Posture" )
190 .FriendlyName(
_(
"Switch Track Posture" ) )
191 .Tooltip(
_(
"Switches posture of the currently routed track." ) )
195 .Name(
"pcbnew.InteractiveRouter.SwitchRounding" )
197 .DefaultHotkey(
MD_CTRL +
'/' )
198 .FriendlyName(
_(
"Track Corner Mode" ) )
199 .Tooltip(
_(
"Switches between sharp/rounded and 45°/90° corners when routing tracks." ) )
203#define _(s) wxGetTranslation((s))
210 m_inRouterTool( false )
222 SetIcon( BITMAPS::width_track_via );
223 SetTitle(
_(
"Select Track/Via Width" ) );
242 _(
"Route using the width of the starting track." ), wxITEM_CHECK );
247 _(
"Use track and via sizes from the net class" ), wxITEM_CHECK );
252 _(
"Specify custom track and via sizes" ), wxITEM_CHECK );
263 msg =
_(
"Track netclass width" );
268 Append( menuIdx, msg, wxEmptyString, wxITEM_CHECK );
279 msg =
_(
"Via netclass values" );
282 if(
via.m_Drill > 0 )
284 msg.Printf(
_(
"Via %s, hole %s" ),
290 msg.Printf(
_(
"Via %s" ),
296 Append( menuIdx, msg, wxEmptyString, wxITEM_CHECK );
304 int id = aEvent.GetId();
355 SetIcon( BITMAPS::width_track_via );
356 SetTitle(
_(
"Select Differential Pair Dimensions" ) );
372 _(
"Use differential pair dimensions from the net class" ), wxITEM_CHECK );
377 _(
"Specify custom differential pair dimensions" ), wxITEM_CHECK );
390 if( diffPair.
m_Gap <= 0 )
394 msg.Printf(
_(
"Width %s" ),
399 msg.Printf(
_(
"Width %s, via gap %s" ),
408 msg.Printf(
_(
"Width %s, gap %s" ),
414 msg.Printf(
_(
"Width %s, gap %s, via gap %s" ),
422 Append( menuIdx, msg, wxEmptyString, wxITEM_CHECK );
430 int id = aEvent.GetId();
476 menu.
SetTitle(
_(
"Interactive Router" ) );
494 auto notRoutingCond =
505 if( currentNets.empty() || currentNets[0] == nullptr )
514 return ratsnest && !ratsnest->
GetEdges().empty();
518 menu.AddSeparator( 1 );
521 menu.AddSeparator( haveHighlight, 2 );
578 static size_t lastLoggerSize = 0;
582 if( !logger || logger->GetEvents().size() == 0
583 || logger->GetEvents().size() == lastLoggerSize )
588 wxFileDialog dlg(
frame(),
_(
"Save router log" ), mruPath,
"pns.log",
590 wxFD_OVERWRITE_PROMPT | wxFD_SAVE );
592 if( dlg.ShowModal() != wxID_OK )
594 lastLoggerSize = logger->GetEvents().size();
598 wxFileName fname_log( dlg.GetPath() );
599 mruPath = fname_log.GetPath();
601 wxFileName fname_dump( fname_log );
602 fname_dump.SetExt(
"dump" );
604 wxFileName fname_settings( fname_log );
605 fname_settings.SetExt(
"settings" );
608 FILE* settings_f = wxFopen( fname_settings.GetAbsolutePath(),
"wb" );
610 fprintf( settings_f,
"%s\n", settingsStr.c_str() );
611 fclose( settings_f );
625 std::vector<PNS::ITEM*> added, removed, heads;
628 std::set<KIID> removedKIIDs;
630 for(
auto item : removed )
632 wxASSERT_MSG( item->Parent() !=
nullptr,
"removed an item with no parent uuid?" );
635 removedKIIDs.insert( item->Parent()->m_Uuid );
638 FILE* log_f = wxFopen( fname_log.GetAbsolutePath(),
"wb" );
640 added, removedKIIDs, heads,
641 logger->GetEvents() );
646 fname_log.GetAbsolutePath() ) );
650 fprintf( log_f,
"%s\n", logString.c_str().AsChar() );
708 if( currentLayer != activeLayer )
729 std::shared_ptr<DRC_ENGINE>& drcEngine = bds.
m_DRCEngine;
744 if( !constraint.
IsNull() )
772 dummyTrackB.
SetLayer( targetLayer );
780 if( !constraint.
IsNull() )
793 if( !constraint.
IsNull() )
819 wxASSERT_MSG(
false, wxT(
"Unhandled via type" ) );
863 LSEQ layers = enabledLayers.
Seq();
873 size_t target_idx = 0;
875 for(
size_t i = 0; i < layers.size(); i++ )
884 target_idx = ( idx + 1 ) % layers.size();
887 for(
size_t i = 0; i < layers.size() - 1; i++ )
891 targetLayer = layers[target_idx];
896 if( target_idx >= layers.size() )
914 size_t target_idx = 0;
916 for(
size_t i = 0; i < layers.size(); i++ )
925 target_idx = ( idx > 0 ) ? ( idx - 1 ) : ( layers.size() - 1 );
927 for(
size_t i = 0; i < layers.size() - 1; i++ )
931 targetLayer = layers[target_idx];
938 target_idx = layers.size() - 1;
960 if( !enabledLayers.
test( targetLayer ) )
968 if( targetLayer == currentLayer )
988 VIATYPE viaType = VIATYPE::THROUGH;
989 bool selectLayer =
false;
994 const int actViaFlags = aEvent.
Parameter<
int>();
995 selectLayer = actViaFlags & VIA_ACTION_FLAGS::SELECT_LAYER;
1008 if( viaType != VIATYPE::THROUGH )
1009 not_allowed_ly.
set( currentLayer );
1011 if( viaType == VIATYPE::MICROVIA )
1014 int previous_layer = currentLayer ==
B_Cu ? layerCount - 2
1017 int next_layer = currentLayer >= layerCount-2 ?
B_Cu
1022 if( previous_layer >=
F_Cu && previous_layer != currentLayer )
1023 not_allowed_ly.
reset( previous_layer );
1025 if( next_layer != currentLayer )
1026 not_allowed_ly.
reset( next_layer );
1030 not_allowed_ly, endPoint );
1039 if( viaType != VIATYPE::THROUGH )
1041 if( currentLayer == targetLayer )
1051 if( viaType == VIATYPE::BLIND_BURIED
1052 && ( ( targetLayer ==
B_Cu && currentLayer ==
F_Cu )
1053 || ( targetLayer ==
F_Cu && currentLayer ==
B_Cu ) ) )
1055 viaType = VIATYPE::THROUGH;
1064 case VIATYPE::THROUGH:
1066 currentLayer = pairTop;
1067 targetLayer = pairBottom;
1070 case VIATYPE::MICROVIA:
1073 if( pairTop > pairBottom ) std::swap( pairTop, pairBottom );
1075 if( currentLayer == pairTop && pairBottom == pairTop+1 )
1077 targetLayer = pairBottom;
1079 else if( currentLayer == pairBottom && pairBottom == pairTop+1 )
1081 targetLayer = pairTop;
1083 else if( currentLayer ==
F_Cu || currentLayer ==
In1_Cu )
1086 currentLayer =
F_Cu;
1088 if( layerCount > 2 )
1093 else if( currentLayer ==
B_Cu || currentLayer == layerCount - 2 )
1096 currentLayer =
B_Cu,
1109 case VIATYPE::BLIND_BURIED:
1110 if( currentLayer == pairTop || currentLayer == pairBottom )
1114 currentLayer = pairTop;
1115 targetLayer = pairBottom;
1121 targetLayer = pairTop;
1125 if( currentLayer == targetLayer )
1128 infobar->
ShowMessageFor(
_(
"Blind/buried via need 2 different layers." ),
1137 wxFAIL_MSG( wxT(
"unexpected via type" ) );
1160 if( !constraint.
IsNull() )
1166 if( !constraint.
IsNull() )
1213 if( !
getView()->IsLayerVisible( routingLayer ) )
1226 frame()->GetScreen()->m_Route_Layer_BOTTOM );
1256 m_router->ClearViewDecorations();
1305 auto syncRouterAndFrameLayer =
1313 if( !
getView()->IsLayerVisible( routingLayer ) )
1330 if( evt->IsCancelInteractive() )
1338 if( evt->IsMotion() )
1350 evt->SetMousePosition( last.value() );
1358 bool* autoRouted = evt->Parameter<
bool*>();
1365 if( autoRouted !=
nullptr )
1374 if( autoRouted !=
nullptr )
1376 *autoRouted =
false;
1390 syncRouterAndFrameLayer();
1411 bool forceCommit =
false;
1416 if( needLayerSwitch )
1420 syncRouterAndFrameLayer();
1453 bool forceFinish =
true;
1454 bool forceCommit =
false;
1459 else if( evt->IsCancelInteractive() || evt->IsActivate()
1465 if( evt->IsActivate() && !evt->IsMoveTool() )
1470 else if( evt->IsUndoRedo() )
1488 evt->SetPassEvent();
1505 if( settingsDlg.ShowModal() == wxID_OK )
1524 settingsDlg.ShowModal();
1621 std::vector<BOARD_CONNECTED_ITEM*> itemList;
1628 itemList.push_back(
pad );
1639 bool groupStart =
true;
1646 RN_NET* net = connectivity->GetRatsnestForNet( item->GetNetCode() );
1651 std::vector<std::shared_ptr<const CN_ANCHOR>> anchors;
1655 std::shared_ptr<const CN_ANCHOR> target = edge.GetTargetNode();
1656 std::shared_ptr<const CN_ANCHOR> source = edge.GetSourceNode();
1658 if( !source || source->Dirty() || !target || target->Dirty() )
1661 if( source->Parent() == item )
1662 anchors.push_back( source );
1663 else if( target->Parent() == item )
1664 anchors.push_back( target );
1668 for( std::shared_ptr<const CN_ANCHOR>
anchor : anchors )
1683 bool autoRouted =
false;
1760 if( !evt->IsDrag() )
1763 if( evt->IsCancelInteractive() )
1768 else if( evt->IsActivate() )
1770 if( evt->IsMoveTool() || evt->IsEditorTool() )
1789 else if( evt->IsMotion() )
1807 evt->SetPassEvent(
false );
1815 if( evt->HasPosition() )
1828 else if( evt->IsKeyPressed() )
1833 evt->SetPassEvent();
1841 evt->SetPassEvent();
1870 KIDIALOG dlg(
frame(),
_(
"The selected item is locked." ),
_(
"Confirmation" ),
1871 wxOK | wxCANCEL | wxICON_WARNING );
1872 dlg.SetOKLabel(
_(
"Drag Anyway" ) );
1914 if( evt->IsMotion() )
1923 if( dragger->GetForceMarkObstaclesMode( &dragStatus ) )
1930 hint.Printf(
_(
"(%s to commit anyway.)" ),
1934 statusItem->
SetMessage(
_(
"Track violates DRC." ) );
1942 else if( evt->IsClick(
BUT_LEFT ) )
1944 bool forceFinish =
false;
1945 bool forceCommit = evt->Modifier(
MD_CTRL );
1954 else if( evt->IsCancelInteractive() || evt->IsActivate() )
1959 if( evt->IsActivate() && !evt->IsMoveTool() )
1964 else if( evt->IsUndoRedo() )
1992 evt->SetPassEvent();
1997 evt->SetPassEvent();
2039 if( vias + traces == 0 )
2053 for(
int i = 0; !reference && i < aCollector.
GetCount(); i++ )
2054 reference =
dynamic_cast<PCB_TRACK*
>( aCollector[i] );
2068 refPoint = reference->
GetEnd();
2072 for(
int i = 0; i < aCollector.
GetCount(); i++ )
2076 if( neighbor && neighbor != reference )
2081 if( neighbor->
GetStart() != refPoint && neighbor->
GetEnd() != refPoint )
2088 aCollector.
Append( reference );
2137 std::set<FOOTPRINT*> footprints;
2140 footprints.insert(
static_cast<FOOTPRINT*
>( item ) );
2162 bool wasLocked =
false;
2186 std::vector<BOARD_ITEM*> dynamicItems;
2187 std::unique_ptr<CONNECTIVITY_DATA> dynamicData =
nullptr;
2190 if( !footprints.empty() )
2192 if( showCourtyardConflicts )
2202 itemsToDrag.
Add( solid );
2206 if( connectivityData->GetRatsnestForPad(
pad ).size() > 0 )
2207 dynamicItems.push_back(
pad );
2216 itemsToDrag.
Add( solid );
2219 if( showCourtyardConflicts )
2223 dynamicData = std::make_unique<CONNECTIVITY_DATA>(
board()->GetConnectivity(),
2224 dynamicItems,
true );
2225 connectivityData->BlockRatsnestItems( dynamicItems );
2232 itemsToDrag.
Add( startItem );
2250 else if( !footprints.empty() )
2276 int dragMode = aEvent.
Parameter<
int> ();
2285 if( !footprints.empty() )
2286 connectivityData->ClearLocalRatsnest();
2321 bool hasMouseMoved =
false;
2327 if( evt->IsCancelInteractive() )
2334 else if( evt->IsMotion() || evt->IsDrag(
BUT_LEFT ) )
2336 hasMouseMoved =
true;
2342 if( !footprints.empty() )
2351 previewItem =
static_cast<BOARD_ITEM*
>( drawing->Clone() );
2352 previewItem->
Move( offset );
2361 &&
pad->GetDrillSize().x == 0 )
2364 previewItem->
Move( offset );
2377 previewItem->
Move( offset );
2382 previewItem->
Move( offset );
2386 if( showCourtyardConflicts )
2390 if( showCourtyardConflicts )
2392 courtyardClearanceDRC.
Run();
2400 dynamicData->Move( offset - lastOffset );
2401 lastOffset = offset;
2402 connectivityData->ComputeLocalRatsnest( dynamicItems, dynamicData.get(), offset );
2409 if( dragger->GetForceMarkObstaclesMode( &dragStatus ) )
2414 hint.Printf(
_(
"(%s to commit anyway.)" ),
2418 statusItem->
SetMessage(
_(
"Track violates DRC." ) );
2426 else if( hasMouseMoved && ( evt->IsMouseUp(
BUT_LEFT ) || evt->IsClick(
BUT_LEFT ) ) )
2428 bool forceFinish =
false;
2429 bool forceCommit = evt->Modifier(
MD_CTRL );
2435 else if( evt->IsUndoRedo() )
2463 evt->SetPassEvent();
2468 evt->SetPassEvent();
2474 if( !footprints.empty() )
2488 connectivityData->ClearLocalRatsnest();
2555 KIDIALOG dlg(
frame(),
_(
"The selected item is locked." ),
_(
"Confirmation" ),
2556 wxOK | wxCANCEL | wxICON_WARNING );
2557 dlg.SetOKLabel(
_(
"Break Track" ) );
2581 if( sizeDlg.ShowModal() == wxID_OK )
2617 std::vector<MSG_PANEL_ITEM> items;
2625 wxString description;
2631 wxASSERT( nets.size() >= 2 );
2638 description = wxString::Format(
_(
"Routing Diff Pair: %s" ),
2645 if( netclassA == netclassB )
2646 netclass = netclassA->
GetName();
2648 netclass = netclassA->
GetName() + wxT(
", " ) + netclassB->
GetName();
2650 secondary = wxString::Format(
_(
"Resolved Netclass: %s" ),
2653 else if( !nets.empty() && nets[0] )
2657 description = wxString::Format(
_(
"Routing Track: %s" ),
2660 secondary = wxString::Format(
_(
"Resolved Netclass: %s" ),
2665 description =
_(
"Routing Track" );
2666 secondary =
_(
"(no net)" );
2669 items.emplace_back( description, secondary );
2671 wxString cornerMode;
2675 cornerMode =
_(
"Free-angle" );
2689 items.emplace_back(
_(
"Corner Style" ), cornerMode );
2699 items.emplace_back(
_(
"Mode" ), mode );
2701#define FORMAT_VALUE( x ) frame()->MessageTextFromValue( x )
2705 items.emplace_back( wxString::Format(
_(
"Track Width: %s" ),
2707 wxString::Format(
_(
"(from %s)" ),
2710 items.emplace_back( wxString::Format(
_(
"Min Clearance: %s" ),
2712 wxString::Format(
_(
"(from %s)" ),
2715 items.emplace_back( wxString::Format(
_(
"Diff Pair Gap: %s" ),
2717 wxString::Format(
_(
"(from %s)" ),
2721 wxASSERT( traces.
Count() == 2 );
2726 items.emplace_back( wxString::Format(
_(
"DP Max Uncoupled-length: %s" ),
2728 wxString::Format(
_(
"(from %s)" ),
2734 items.emplace_back( wxString::Format(
_(
"Track Width: %s" ),
2736 wxString::Format(
_(
"(from %s)" ),
2739 items.emplace_back( wxString::Format(
_(
"Min Clearance: %s" ),
2741 wxString::Format(
_(
"(from %s)" ),
@ switch_corner_rounding_shape
BOX2I BOX2ISafe(const BOX2D &aInput)
static TOOL_ACTION cancelInteractive
static TOOL_ACTION pasteSpecial
static TOOL_ACTION doDelete
static TOOL_ACTION finishInteractive
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void SetLayerVisible(int aLayer, bool isVisible)
BASE_SET & set(size_t pos=std::numeric_limits< size_t >::max(), bool value=true)
bool test(size_t pos) const
BASE_SET & reset(size_t pos=std::numeric_limits< size_t >::max())
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
void SetNet(NETINFO_ITEM *aNetInfo)
Set a NET_INFO object for the item.
Container for design settings for a BOARD object.
void UseCustomTrackViaSize(bool aEnabled)
Enables/disables custom track/via size settings.
void SetCustomDiffPairWidth(int aWidth)
Sets custom track width for differential pairs (i.e.
void SetDiffPairIndex(unsigned aIndex)
int GetCurrentViaSize() const
std::shared_ptr< DRC_ENGINE > m_DRCEngine
bool m_UseConnectedTrackWidth
std::vector< DIFF_PAIR_DIMENSION > m_DiffPairDimensionsList
bool m_TempOverrideTrackWidth
void SetCustomDiffPairGap(int aGap)
Sets custom gap for differential pairs (i.e.
void SetTrackWidthIndex(unsigned aIndex)
Set the current track width list index to aIndex.
void SetViaSizeIndex(unsigned aIndex)
Set the current via size list index to aIndex.
unsigned GetTrackWidthIndex() const
bool UseNetClassVia() const
Return true if netclass values should be used to obtain appropriate via size.
unsigned GetViaSizeIndex() const
bool UseNetClassTrack() const
Return true if netclass values should be used to obtain appropriate track width.
bool UseNetClassDiffPair() const
Return true if netclass values should be used to obtain appropriate diff pair dimensions.
int GetCopperLayerCount() const
void UseCustomDiffPairDimensions(bool aEnabled)
Enables/disables custom differential pair dimensions.
std::vector< int > m_TrackWidthList
unsigned GetDiffPairIndex() const
int GetCurrentViaDrill() const
std::vector< VIA_DIMENSION > m_ViasDimensionsList
void SetCustomDiffPairViaGap(int aGap)
Sets custom via gap for differential pairs (i.e.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual void SetLocked(bool aLocked)
virtual void Move(const VECTOR2I &aMoveVector)
Move this object.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
virtual bool IsLocked() const
Information pertinent to a Pcbnew printed circuit board.
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
PROJECT * GetProject() const
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
CN_EDGE represents a point-to-point connection, whether realized or unrealized (ie: tracks etc.
void Empty()
Clear the list.
int GetCount() const
Return the number of objects in the list.
int CountType(KICAD_T aType)
Count the number of items matching aType.
void Append(EDA_ITEM *item)
Add an item to the end of the list.
Implementing DIALOG_TRACK_VIA_SIZE_BASE.
@ ROUNDED_90
H/V with filleted corners.
@ MITERED_90
H/V only (90-degree corners)
@ ROUNDED_45
H/V/45 with filleted corners.
@ MITERED_45
H/V/45 with mitered corners (default)
virtual bool Run() override
Run this provider against the given PCB with configured options (if any).
std::vector< FOOTPRINT * > m_FpInMove
void ClearConflicts(KIGFX::VIEW *aView)
void UpdateConflicts(KIGFX::VIEW *aView, bool aHighlightMoved)
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
WX_INFOBAR * GetInfoBar()
void AddStandardSubMenus(TOOL_MENU &aMenu)
Construct a "basic" menu for a tool, containing only items that apply to all tools (e....
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
A base class for most all the KiCad significant classes used in schematics and boards.
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
Used when the right click button is pressed, or when the select tool is in effect.
static const std::vector< KICAD_T > DraggableItems
A scan list for items that can be dragged.
void SetUseGrid(bool aSnapToGrid)
void SetAuxAxes(bool aEnable, const VECTOR2I &aOrigin=VECTOR2I(0, 0))
const std::string FormatAsString()
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
void DoNotShowCheckbox(wxString file, int line)
Checks the 'do not show again' setting for the dialog.
Abstract interface for drawing on a 2D-surface.
BOX2D GetVisibleWorldExtents() const
bool GetGridSnapping() const
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const std::set< int > & GetHighlightNetCodes() const
Return the netcode of currently highlighted net.
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
virtual void ShowCursor(bool aEnabled)
Enable or disables display of cursor.
virtual void WarpMouseCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
If enabled (.
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Move cursor to the requested position expressed in world coordinates.
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
void ShowPreview(bool aShow=true)
virtual int GetTopLayer() const
GAL * GetGAL() const
Return the #GAL this view is using to draw graphical primitives.
void Hide(VIEW_ITEM *aItem, bool aHide=true, bool aHideOverlay=false)
Temporarily hide the item in the view (e.g.
void AddToPreview(VIEW_ITEM *aItem, bool aTakeOwnership=true)
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Represent a contiguous set of PCB layers.
bool Overlaps(const LAYER_RANGE &aOther) const
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
LSET is a set of PCB_LAYER_IDs.
static LSET AllLayersMask()
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
static LSET AllNonCuMask()
Return a mask holding all layer minus CU layers.
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
A collection of nets and the parameters used to route or test these nets.
const wxString GetName() const
Handle the data for a net.
const wxString & GetNetname() const
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
bool m_ShowCourtyardCollisions
static TOOL_ACTION_GROUP layerDirectSwitchActions()
static TOOL_ACTION layerToggle
static TOOL_ACTION drag45Degree
static TOOL_ACTION layerInner12
static TOOL_ACTION routerUndoLastSegment
static TOOL_ACTION layerInner8
static TOOL_ACTION layerInner3
static TOOL_ACTION layerPrev
static TOOL_ACTION routerSettingsDialog
Activation of the Push and Shove settings dialogs.
static TOOL_ACTION layerInner2
static TOOL_ACTION routerAttemptFinish
static TOOL_ACTION routeDiffPair
Activation of the Push and Shove router (differential pair mode)
static TOOL_ACTION selectionCursor
Select a single item under the cursor position.
static TOOL_ACTION trackViaSizeChanged
static TOOL_ACTION layerChanged
static TOOL_ACTION layerInner25
static TOOL_ACTION breakTrack
Break a single track into two segments at the cursor.
static TOOL_ACTION routerRouteSelectedFromEnd
static TOOL_ACTION routerHighlightMode
Actions to enable switching modes via hotkey assignments.
static TOOL_ACTION routerWalkaroundMode
static TOOL_ACTION routerShoveMode
static TOOL_ACTION layerInner24
static TOOL_ACTION properties
Activation of the edit tool.
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION layerInner29
static TOOL_ACTION routerAutorouteSelected
static TOOL_ACTION layerInner11
static TOOL_ACTION routerDiffPairDialog
static TOOL_ACTION routerContinueFromEnd
static TOOL_ACTION layerInner16
static TOOL_ACTION layerInner26
static TOOL_ACTION layerInner18
static TOOL_ACTION layerInner14
static TOOL_ACTION selectLayerPair
static TOOL_ACTION layerInner6
static TOOL_ACTION dragFreeAngle
static TOOL_ACTION clearHighlight
static TOOL_ACTION layerInner22
static TOOL_ACTION layerInner5
static TOOL_ACTION layerInner20
static TOOL_ACTION layerInner7
static TOOL_ACTION layerInner27
static TOOL_ACTION layerInner1
static TOOL_ACTION layerInner10
static TOOL_ACTION layerInner15
static TOOL_ACTION layerInner17
static TOOL_ACTION layerBottom
static TOOL_ACTION layerInner19
static TOOL_ACTION layerInner9
static TOOL_ACTION routerInlineDrag
Activation of the Push and Shove router (inline dragging mode)
static TOOL_ACTION layerInner30
static TOOL_ACTION layerTop
static TOOL_ACTION cycleRouterMode
static TOOL_ACTION layerInner4
static TOOL_ACTION routeSingleTrack
Activation of the Push and Shove router.
static TOOL_ACTION layerInner13
static TOOL_ACTION layerInner21
static TOOL_ACTION layerNext
static TOOL_ACTION routerRouteSelected
static TOOL_ACTION layerInner23
static TOOL_ACTION layerInner28
Common, abstract interface for edit frames.
APPEARANCE_CONTROLS * GetAppearancePanel()
void UndoRedoBlock(bool aBlock=true)
Enable/disable undo and redo operations.
PCB_LAYER_ID SelectOneLayer(PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
Show the dialog box for a layer selection.
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual PCB_LAYER_ID GetActiveLayer() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
The main frame for Pcbnew.
void SetActiveLayer(PCB_LAYER_ID aLayer) override
Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
void SaveBoard(const wxString &aFileName, BOARD *aBoard, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be u...
PCB_LAYER_ID m_Route_Layer_TOP
PCB_LAYER_ID m_Route_Layer_BOTTOM
void SetEnd(const VECTOR2I &aEnd)
void SetStart(const VECTOR2I &aStart)
const VECTOR2I & GetStart() const
const VECTOR2I & GetEnd() const
EDA_ITEM_FLAGS IsPointOnEnds(const VECTOR2I &point, int min_dist=0) const
Return STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = m...
void SetLayerPair(PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
For a via m_layer contains the top layer, the other layer is in m_bottomLayer/.
void SetViaType(VIATYPE aViaType)
int Count(int aKindMask=-1) const
void Add(const LINE &aLine)
Base class for PNS router board items.
virtual NET_HANDLE Net() const
PnsKind Kind() const
Return the type (kind) of the item.
const LAYER_RANGE & Layers() const
bool OfKind(int aKindMask) const
static wxString FormatLogFileAsString(int aMode, const std::vector< ITEM * > &aAddedItems, const std::set< KIID > &aRemovedItems, const std::vector< ITEM * > &aHeads, const std::vector< EVENT_ENTRY > &aEvents)
std::vector< ITEM * > FindItemsByZone(const ZONE *aParent)
ITEM * FindItemByParent(const BOARD_ITEM *aParent)
virtual const VECTOR2I & CurrentEnd() const =0
Function CurrentEnd()
virtual const ITEM_SET Traces()=0
Function Traces()
virtual bool HasPlacedAnything() const
virtual const VECTOR2I & CurrentStart() const =0
Function CurrentStart()
void SetMode(ROUTER_MODE aMode)
bool SwitchLayer(int layer)
void ClearViewDecorations()
PLACEMENT_ALGO * Placer()
void BreakSegmentOrArc(ITEM *aItem, const VECTOR2I &aP)
bool ContinueFromEnd(ITEM **aNewStartItem)
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
const wxString & FailureReason() const
bool IsPlacingVia() const
RULE_RESOLVER * GetRuleResolver() const
ROUTING_SETTINGS & Settings()
bool RoutingInProgress() const
RouterState GetState() const
std::optional< VECTOR2I > UndoLastSegment()
bool StartDragging(const VECTOR2I &aP, ITEM *aItem, int aDragMode=DM_ANY)
bool StartRouting(const VECTOR2I &aP, ITEM *aItem, int aLayer)
void SetVisibleViewArea(const BOX2I &aExtents)
int GetCurrentLayer() const
void GetUpdatedItems(std::vector< PNS::ITEM * > &aRemoved, std::vector< PNS::ITEM * > &aAdded, std::vector< PNS::ITEM * > &aHeads)
bool FixRoute(const VECTOR2I &aP, ITEM *aItem, bool aForceFinish, bool aForceCommit)
void ToggleViaPlacement()
const std::vector< NET_HANDLE > GetCurrentNets() const
bool Move(const VECTOR2I &aP, ITEM *aItem)
Contain all persistent settings of the router, such as the mode, optimization effort,...
bool GetFreeAngleMode() const
void SetMode(PNS_MODE aMode)
Return the optimizer effort. Bigger means cleaner traces, but slower routing.
PNS_MODE Mode() const
Set the routing mode.
DIRECTION_45::CORNER_MODE GetCornerMode() const
virtual NET_HANDLE DpCoupledNet(NET_HANDLE aNet)=0
void SetViaType(VIATYPE aViaType)
void SetTrackWidth(int aWidth)
int DiffPairWidth() const
void SetDiffPairWidth(int aWidth)
void SetDiffPairWidthSource(const wxString &aSource)
void SetDiffPairGapSource(const wxString &aSource)
void SetDiffPairGap(int aGap)
void SetViaDrill(int aDrill)
wxString GetClearanceSource() const
wxString GetDiffPairGapSource() const
wxString GetDiffPairWidthSource() const
void AddLayerPair(int aL1, int aL2)
std::optional< int > PairedLayer(int aLayerId)
bool TrackWidthIsExplicit() const
void SetViaDiameter(int aDiameter)
wxString GetWidthSource() const
void SetWidthSource(const wxString &aSource)
int DiffPairViaGap() const
bool ImportSizes(PNS::SIZES_SETTINGS &aSizes, PNS::ITEM *aStartItem, PNS::NET_HANDLE aNet) override
PNS::RULE_RESOLVER * GetRuleResolver() override
void SetStartLayer(int aLayer)
void SetCommitFlags(int aCommitFlags)
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
Container for project specific data.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
virtual PROJECT_FILE & GetProjectFile() const
Describe ratsnest for a single net.
const std::vector< CN_EDGE > & GetEdges() const
void SetMessage(const wxString &aStatus)
void SetHint(const wxString &aHint)
void SetPosition(const VECTOR2I &aPos) override
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
int Size() const
Returns the number of selected parts.
std::vector< EDA_ITEM * > GetItemsSortedBySelectionOrder() const
bool Empty() const
Checks if there is anything selected.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
A modified version of the wxInfoBar class that allows us to:
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION, MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the infobar with the provided message and icon for a specific period of time.
Handle a list of polygons defining a copper zone.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
This file is part of the common library.
@ VIA_DIAMETER_CONSTRAINT
@ DIFF_PAIR_GAP_CONSTRAINT
#define ROUTER_TRANSIENT
transient items that should NOT be cached
#define ENDPOINT
ends. (Used to support dragging.)
std::uint32_t EDA_ITEM_FLAGS
#define STARTPOINT
When a line is selected, these flags indicate which.
static FILENAME_RESOLVER * resolver
VECTOR2< ret_type > GetClampedCoords(const VECTOR2< in_type > &aCoords, pad_type aPadding=1u)
Clamps a vector to values that can be negated, respecting numeric limits of coordinates data type wit...
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound)
Return the key name from the key code.
This file is part of the common library.
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
PCB_LAYER_ID
A quick note on layer IDs:
PCB_LAYER_ID ToLAYER_ID(int aLayer)
The Cairo implementation of the graphics abstraction layer.
@ RM_MarkObstacles
Ignore collisions, mark obstacles.
@ RM_Walkaround
Only walk around.
@ PNS_MODE_ROUTE_DIFF_PAIR
@ ID_POPUP_PCB_SELECT_WIDTH1
@ ID_POPUP_PCB_SELECT_DIFFPAIR16
@ ID_POPUP_PCB_SELECT_USE_NETCLASS_VALUES
@ ID_POPUP_PCB_SELECT_WIDTH16
@ ID_POPUP_PCB_SELECT_AUTO_WIDTH
@ ID_POPUP_PCB_SELECT_CUSTOM_WIDTH
@ ID_POPUP_PCB_SELECT_DIFFPAIR1
@ ID_POPUP_PCB_SELECT_USE_NETCLASS_DIFFPAIR
@ ID_POPUP_PCB_SELECT_VIASIZE1
@ ID_POPUP_PCB_SELECT_CUSTOM_DIFFPAIR
@ ID_POPUP_PCB_SELECT_VIASIZE16
Class that computes missing connections on a PCB.
std::vector< FAB_LAYER_COLOR > dummy
wxString UnescapeString(const wxString &aSource)
Container to handle a stock of specific differential pairs each with unique track width,...
An abstract function object, returning a design rule (clearance, diff pair gap, etc) required between...
Container to handle a stock of specific vias each with unique diameter and drill sizes in the BOARD c...
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
wxPoint ToWxPoint(const VECTOR2I &aSize)
wxString AddFileExtListToFilter(const std::vector< std::string > &aExts)
Build the wildcard extension file dialog wildcard filter to add to the base message dialog.