28#include "dialog_table_properties.h"
34#include <dialogs/dialog_text_properties.h>
55#include <wx/filedlg.h>
93 SetIcon( BITMAPS::width_track_via );
114 _(
"Specify custom track and via sizes" ), wxITEM_CHECK );
123 if(
via.m_Drill > 0 )
125 msg.Printf(
_(
"Via %s, hole %s" ),
131 msg.Printf(
_(
"Via %s" ),
136 Append( menuIdx, msg, wxEmptyString, wxITEM_CHECK );
145 int id = aEvent.GetId();
154 if( sizeDlg.ShowModal() == wxID_OK )
175 m_controls( nullptr ),
179 m_inDrawingTool( false ),
182 m_pickerItem( nullptr ),
183 m_tuningPattern( nullptr )
203 auto activeToolFunctor =
220 auto canCloseOutline =
240 auto tuningToolActive =
268 std::shared_ptr<VIA_SIZE_MENU> viaSizeMenu = std::make_shared<VIA_SIZE_MENU>();
269 viaSizeMenu->SetTool(
this );
271 ctxMenu.
AddMenu( viaSizeMenu.get(), viaToolActive, 500 );
279 getEditFrame<PCB_BASE_FRAME>()->AddStandardSubMenus(
m_menu );
291 m_frame = getEditFrame<PCB_BASE_EDIT_FRAME>();
354 std::optional<VECTOR2D> startingPoint;
355 std::stack<PCB_SHAPE*> committedLines;
366 while(
drawShape( aEvent, &line, startingPoint, &committedLines ) )
371 commit.
Push(
_(
"Draw Line" ) );
373 committedLines.push( line );
377 startingPoint = std::nullopt;
404 std::optional<VECTOR2D> startingPoint;
407 rect->
SetShape( SHAPE_T::RECTANGLE );
417 while(
drawShape( aEvent, &rect, startingPoint,
nullptr ) )
421 bool cancelled =
false;
435 commit.
Push( isTextBox ?
_(
"Draw Text Box" ) :
_(
"Draw Rectangle" ) );
442 rect->
SetShape( SHAPE_T::RECTANGLE );
445 startingPoint = std::nullopt;
466 std::optional<VECTOR2D> startingPoint;
468 circle->
SetShape( SHAPE_T::CIRCLE );
478 while(
drawShape( aEvent, &circle, startingPoint,
nullptr ) )
482 commit.
Add( circle );
483 commit.
Push(
_(
"Draw Circle" ) );
489 circle->
SetShape( SHAPE_T::CIRCLE );
493 startingPoint = std::nullopt;
514 std::optional<VECTOR2D> startingPoint;
525 while(
drawArc( aEvent, &arc, startingPoint ) )
530 commit.
Push(
_(
"Draw Arc" ) );
539 startingPoint = std::nullopt;
554 bool immediateMode =
image !=
nullptr;
556 bool ignorePrimePosition =
false;
568 image->SetPosition( cursorPos );
614 ignorePrimePosition =
true;
623 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
648 else if( evt->IsActivate() )
650 if(
image && evt->IsMoveTool() )
653 evt->SetPassEvent(
false );
660 evt->SetPassEvent(
false );
664 if( evt->IsMoveTool() )
681 wxFileDialog dlg(
m_frame,
_(
"Choose Image" ), wxEmptyString, wxEmptyString,
682 _(
"Image Files" ) + wxS(
" " ) + wxImage::GetImageExtWildcard(),
685 if( dlg.ShowModal() != wxID_OK )
691 if( evt->IsPrime() && !ignorePrimePosition )
693 cursorPos =
grid.Align( evt->Position() );
704 wxString fullFilename = dlg.GetPath();
706 if( wxFileExists( fullFilename ) )
709 if( !
image || !
image->ReadImageFile( fullFilename ) )
711 wxMessageBox(
_(
"Could not load image from '%s'." ), fullFilename );
732 commit.Push(
_(
"Place Image" ) );
757 || evt->IsMotion() ) )
759 image->SetPosition( cursorPos );
803 bool ignorePrimePosition =
false;
849 ignorePrimePosition =
true;
858 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
877 else if( evt->IsActivate() )
882 if( evt->IsMoveTool() )
902 bool placing =
text !=
nullptr;
927 text->SetLayer( layer );
928 text->SetAttributes( textAttrs );
929 text->SetTextPos( cursorPos );
945 else if(
text->GetTextPos() != cursorPos )
974 commit.
Push(
_(
"Place Text" ) );
986 if( evt->IsPrime() && !ignorePrimePosition )
988 cursorPos = evt->Position();
1003 else if(
text && ( evt->IsMotion()
1006 text->SetPosition( cursorPos );
1023 evt->SetPassEvent();
1095 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1102 if( evt->IsCancelInteractive() || ( table && evt->IsAction( &
ACTIONS::undo ) ) )
1114 else if( evt->IsActivate() )
1119 if( evt->IsMoveTool() )
1138 else if( evt->IsClick(
BUT_LEFT ) )
1179 commit.
Push(
_(
"Draw Table" ) );
1197 VECTOR2I requestedSize( cursorPos - origin );
1199 int colCount = std::max( 1, requestedSize.
x / ( fontSize.
x * 15 ) );
1200 int rowCount = std::max( 1, requestedSize.
y / ( fontSize.
y * 3 ) );
1202 VECTOR2I cellSize( std::max( fontSize.
x * 5, requestedSize.
x / colCount ),
1203 std::max( fontSize.
y * 3, requestedSize.
y / rowCount ) );
1205 cellSize.
x =
KiROUND( (
double) cellSize.
x / gridSize.
x ) * gridSize.
x;
1206 cellSize.
y =
KiROUND( (
double) cellSize.
y / gridSize.
y ) * gridSize.
y;
1211 for(
int col = 0; col < colCount; ++col )
1214 for(
int row = 0; row < rowCount; ++row )
1218 for(
int col = 0; col < colCount; ++col )
1244 evt->SetPassEvent();
1278 enum DIMENSION_STEPS
1293 int step = SET_ORIGIN;
1309 dimension =
nullptr;
1338 if( step > SET_ORIGIN )
1344 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1352 grid.SetUseGrid(
false );
1362 if( evt->IsCancelInteractive() || ( dimension && evt->IsAction( &
ACTIONS::undo ) ) )
1366 if( step != SET_ORIGIN )
1376 else if( evt->IsActivate() )
1378 if( step != SET_ORIGIN )
1381 if( evt->IsPointEditor() )
1385 else if( evt->IsMoveTool() )
1431 auto setMeasurementAttributes =
1445 setMeasurementAttributes( dimension );
1450 setMeasurementAttributes( dimension );
1459 setMeasurementAttributes( dimension );
1468 wxFAIL_MSG( wxT(
"Unhandled action in DRAWING_TOOL::DrawDimension" ) );
1471 t = dimension->
Type();
1481 dimension->
SetEnd( cursorPos );
1490 preview.
Add( dimension );
1521 preview.
Remove( dimension );
1523 commit.
Add( dimension );
1524 commit.
Push(
_(
"Draw Dimension" ) );
1535 if( ++step >= FINISHED )
1537 dimension =
nullptr;
1542 else if( evt->IsDblClick(
BUT_LEFT ) )
1547 else if( evt->IsMotion() )
1552 dimension->
SetEnd( cursorPos );
1576 textOffset = -textOffset;
1585 textOffset = -textOffset;
1599 double angle = aligned->
GetAngle() + ( M_PI / 2 );
1602 double height = (
delta.x * cos( angle ) ) + (
delta.y * sin( angle ) );
1640 ortho->SetHeight( vert ? heightVector.
x : heightVector.
y );
1672 if( step == SET_END || step == SET_HEIGHT )
1691 evt->SetPassEvent();
1695 if( step != SET_ORIGIN )
1723 int dlgResult = dlg.ShowModal();
1727 if( dlgResult != wxID_OK )
1733 wxMessageBox(
_(
"No graphic items found in file.") );
1739 std::vector<BOARD_ITEM*> newItems;
1740 std::vector<BOARD_ITEM*> selectedItems;
1751 newItems.push_back(
group );
1752 selectedItems.push_back(
group );
1758 std::vector<PCB_SHAPE*> shapeList;
1759 std::vector<std::unique_ptr<PCB_SHAPE>> newShapes;
1761 for(
const std::unique_ptr<EDA_ITEM>& ptr : list )
1764 shapeList.push_back( shape );
1769 for( std::unique_ptr<PCB_SHAPE>& ptr : newShapes )
1772 list.push_back( std::move( ptr ) );
1776 for( std::unique_ptr<EDA_ITEM>& ptr : list )
1779 wxCHECK2( item,
continue );
1781 newItems.push_back( item );
1785 group->AddItem( item );
1790 selectedItems.push_back( item );
1795 preview.
Add( item );
1801 EDA_ITEMS selItems( selectedItems.begin(), selectedItems.end() );
1810 commit.
Stage( groupUndoList );
1812 commit.
Push(
_(
"Import Graphics" ) );
1851 item->Move(
delta );
1861 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1867 if( evt->IsCancelInteractive() || evt->IsActivate() )
1882 else if( evt->IsMotion() )
1887 item->Move(
delta );
1902 commit.
Stage( groupUndoList );
1904 commit.
Push(
_(
"Import Graphics" ) );
1914 evt->SetPassEvent();
1971 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1986 commit.
Push(
_(
"Move Footprint Anchor" ) );
1997 else if( evt->IsCancelInteractive() || evt->IsActivate() )
2004 evt->SetPassEvent();
2017#define TOGGLE( a ) a = !a
2049 std::optional<VECTOR2D> aStartingPoint,
2050 std::stack<PCB_SHAPE*>* aCommittedGraphics )
2052 SHAPE_T shape = ( *aGraphic )->GetShape();
2055 wxASSERT( shape == SHAPE_T::SEGMENT || shape == SHAPE_T::CIRCLE || shape == SHAPE_T::RECTANGLE );
2095 bool started =
false;
2096 bool cancelled =
false;
2114 if( !isLocalOriginSet )
2125 if( aStartingPoint )
2137 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2143 if( evt->IsCancelInteractive() || ( started && evt->IsAction( &
ACTIONS::undo ) ) )
2150 evt->SetPassEvent(
false );
2157 else if( evt->IsActivate() )
2159 if( evt->IsPointEditor() )
2163 else if( evt->IsMoveTool() )
2216 evt->SetPassEvent();
2235 if( aStartingPoint )
2237 cursorPos = *aStartingPoint;
2238 aStartingPoint = std::nullopt;
2253 grid.SetSkipPoint( cursorPos );
2256 twoPointMgr.
SetEnd( cursorPos );
2258 if( !isLocalOriginSet )
2280 if( shape == SHAPE_T::SEGMENT && snapItem && graphic->
GetLength() > 0 )
2285 commit.
Add( graphic );
2286 commit.
Push(
_(
"Draw Line" ) );
2299 twoPointMgr.
Reset();
2305 else if( evt->IsMotion() )
2307 VECTOR2I clampedCursorPos = cursorPos;
2309 if( shape == SHAPE_T::CIRCLE || shape == SHAPE_T::ARC )
2327 twoPointMgr.
SetEnd( clampedCursorPos );
2338 if( aCommittedGraphics && !aCommittedGraphics->empty() )
2340 twoPointMgr.
SetOrigin( aCommittedGraphics->top()->GetStart() );
2341 twoPointMgr.
SetEnd( aCommittedGraphics->top()->GetEnd() );
2342 aCommittedGraphics->pop();
2394 isLocalOriginSet =
true;
2395 evt->SetPassEvent();
2402 twoPointAsst.
SetUnits( userUnits );
2405 evt->SetPassEvent();
2409 evt->SetPassEvent();
2413 if( !isLocalOriginSet )
2459 std::optional<VECTOR2D> aStartingPoint )
2461 wxCHECK( aGraphic,
false );
2465 wxCHECK( graphic,
false );
2501 *aGraphic =
nullptr;
2509 bool started =
false;
2510 bool cancelled =
false;
2514 if( aStartingPoint )
2528 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2534 if( evt->IsCancelInteractive() || ( started && evt->IsAction( &
ACTIONS::undo ) ) )
2541 evt->SetPassEvent(
false );
2548 else if( evt->IsActivate() )
2550 if( evt->IsPointEditor() )
2554 else if( evt->IsMoveTool() )
2569 else if( evt->IsClick(
BUT_LEFT ) )
2589 preview.
Add( graphic );
2594 arcManager.
AddPoint( cursorPos,
true );
2600 else if( evt->IsMotion() )
2606 arcManager.
AddPoint( cursorPos,
false );
2633 evt->SetPassEvent();
2657 evt->SetPassEvent();
2700 evt->SetPassEvent();
2709 evt->SetPassEvent();
2729 preview.
Remove( graphic );
2747 bool clearSelection =
false;
2751 if( aMode == ZONE_MODE::ADD || aMode == ZONE_MODE::GRAPHIC_POLYGON )
2759 clearSelection =
true;
2770 if( clearSelection )
2798 ZONE* sourceZone =
nullptr;
2809 params.
m_mode = zoneMode;
2813 if( zoneMode == ZONE_MODE::SIMILAR && !sourceZone->
IsOnLayer( params.
m_layer ) )
2820 bool started =
false;
2834 polyGeomMgr.
Reset();
2836 grid.ClearSkipPoint();
2858 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2869 if( evt->IsCancelInteractive() )
2880 evt->SetPassEvent(
false );
2884 else if( evt->IsActivate() )
2889 if( evt->IsPointEditor() )
2893 else if( evt->IsMoveTool() )
2906 if( zoneMode != ZONE_MODE::SIMILAR )
2928 const bool endPolygon = evt->IsDblClick(
BUT_LEFT )
2935 polyGeomMgr.
Reset();
2942 else if( polyGeomMgr.
AddPoint( cursorPos ) )
2965 cursorPos = last.value();
2975 else if( started && ( evt->IsMotion()
3001 evt->SetPassEvent();
3023 std::shared_ptr<DRC_ENGINE> m_drcEngine;
3025 int m_worstClearance;
3026 bool m_allowDRCViolations;
3033 m_worstClearance( 0 )
3051 m_worstClearance = std::max( m_worstClearance, constraint.
GetValue().
Min() );
3055 for(
PAD*
pad : footprint->Pads() )
3057 std::optional<int> padOverride =
pad->GetClearanceOverrides(
nullptr );
3059 if( padOverride.has_value() )
3060 m_worstClearance = std::max( m_worstClearance, padOverride.value() );
3069 virtual ~VIA_PLACER()
3079 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> items;
3081 std::vector<PCB_TRACK*> possible_tracks;
3083 wxCHECK( view,
nullptr );
3085 view->
Query( bbox, items );
3101 possible_tracks.push_back( track );
3109 possible_tracks.push_back( arc );
3114 int min_d = std::numeric_limits<int>::max();
3116 for(
PCB_TRACK* track : possible_tracks )
3118 SEG test( track->GetStart(), track->GetEnd() );
3119 int dist = (
test.NearestPoint( position ) - position ).EuclideanNorm();
3124 return_track = track;
3128 return return_track;
3136 ZONE* zone =
dynamic_cast<ZONE*
>( aOther );
3148 int connectedItemNet = connectedItem->
GetNetCode();
3150 if( connectedItemNet == 0 || connectedItemNet == aVia->
GetNetCode() )
3163 if( clearance >= 0 )
3168 if( viaShape->Collide( otherShape.get(), clearance - m_drcEpsilon ) )
3179 if( clearance >= 0 )
3184 clearance - m_drcEpsilon ) )
3194 bool checkDRCViolation(
PCB_VIA* aVia )
3196 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> items;
3197 std::set<BOARD_ITEM*> checkedItems;
3200 bbox.
Inflate( m_worstClearance );
3203 for( std::pair<KIGFX::VIEW_ITEM*, int> it : items )
3223 else if( checkedItems.count( item ) )
3228 if( hasDRCViolation( aVia, item ) )
3231 checkedItems.insert( item );
3248 for(
FOOTPRINT* fp : m_board->Footprints() )
3250 for(
PAD*
pad : fp->Pads() )
3252 if(
pad->HitTest( position ) && (
pad->GetLayerSet() & lset ).any() )
3254 if(
pad->GetNetCode() > 0 )
3263 std::optional<int> selectPossibleNetsByPopupMenu( std::set<int>& aNetcodeList )
3267 std::map<int, int> menuIDNetCodeMap;
3270 for(
int netcode : aNetcodeList )
3276 menuText = wxString::Format(
"%s\t",
3279 menuText = wxString::Format(
"&%d %s\t",
3289 menu.
Add( menuText, menuID, BITMAPS::INVALID_BITMAP );
3290 menuIDNetCodeMap[ menuID ] = netcode;
3300 int selectedNetCode = -1;
3301 bool cancelled =
false;
3307 evt->SetPassEvent();
3311 std::optional<int>
id = evt->GetCommandId();
3314 if(
id && ( *
id > 0 ) && ( *
id < menuID ) )
3316 selectedNetCode = menuIDNetCodeMap.at( *
id );
3331 return std::optional<int>();
3333 return selectedNetCode;
3336 std::optional<int> findStitchedZoneNet(
PCB_VIA* aVia )
3340 std::set<int> netcodeList;
3348 for(
ZONE* z : m_board->Zones() )
3352 if( z->HitTestFilledArea( m_frame->
GetActiveLayer(), position ) )
3353 netcodeList.insert( z->GetNetCode() );
3360 if( netcodeList.size() == 1 )
3361 return *netcodeList.begin();
3366 for(
ZONE* z : m_board->Zones() )
3370 if( z->IsOnLayer( layer ) )
3372 if( z->HitTestFilledArea( layer, position ) )
3373 netcodeList.insert( z->GetNetCode() );
3379 if( netcodeList.size() == 1 )
3380 return *netcodeList.begin();
3382 if( netcodeList.size() > 1 )
3385 return selectPossibleNetsByPopupMenu( netcodeList );
3401 if( settings->
tracks == MAGNETIC_OPTIONS::CAPTURE_ALWAYS && m_gridHelper.
GetSnap() )
3405 SEG trackSeg( track->GetStart(), track->GetEnd() );
3411 else if( settings->
pads == MAGNETIC_OPTIONS::CAPTURE_ALWAYS && m_gridHelper.
GetSnap() )
3429 via->SetIsFree(
false );
3433 via->SetNetCode(
pad->GetNetCode() );
3434 via->SetIsFree(
false );
3438 std::optional<int> netcode = findStitchedZoneNet(
via );
3440 if( !netcode.has_value() )
3443 via->SetNetCode( netcode.value() );
3444 via->SetIsFree(
via->GetNetCode() > 0 );
3447 if( checkDRCViolation(
via ) )
3452 if( !m_allowDRCViolations )
3466 if( track && m_gridHelper.
GetSnap() )
3470 SEG trackSeg( trackStart, trackEnd );
3472 if( viaPos == trackStart || viaPos == trackEnd )
3486 newTrack->
SetEnd( trackEnd );
3487 aCommit.
Add( newTrack );
3493 std::unique_ptr<BOARD_ITEM> CreateItem()
override
3498 via->SetNetCode( 0 );
3519 switch(
via->GetViaType() )
3521 case VIATYPE::BLIND_BURIED:
3522 via->SetLayerPair( first_layer, last_layer );
3525 case VIATYPE::MICROVIA:
3528 ToLAYER_ID( ( m_board->GetCopperLayerCount() - 2 ) );
3530 if( first_layer ==
B_Cu )
3531 last_layer = last_inner_layer;
3532 else if( first_layer ==
F_Cu )
3534 else if( first_layer == last_inner_layer )
3536 else if( first_layer ==
In1_Cu )
3540 via->SetLayerPair( first_layer, last_layer );
3554 return std::unique_ptr<BOARD_ITEM>(
via );
3558 VIA_PLACER placer(
frame() );
constexpr EDA_IU_SCALE pcbIUScale
static TOOL_ACTION cancelInteractive
static TOOL_ACTION updateUnits
static TOOL_ACTION activatePointEditor
static TOOL_ACTION doDelete
static TOOL_ACTION cursorClick
static TOOL_ACTION refreshPreview
static TOOL_ACTION resetLocalCoords
void SetLayerVisible(int aLayer, bool isVisible)
VECTOR2D m_LocalOrigin
Relative Screen cursor coordinate (on grid) in user units.
bool test(size_t pos) const
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) override
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Container for design settings for a BOARD object.
DIM_PRECISION m_DimensionPrecision
Number of digits after the decimal.
void UseCustomTrackViaSize(bool aEnabled)
Enables/disables custom track/via size settings.
VIATYPE m_CurrentViaType
(VIA_BLIND_BURIED, VIA_THROUGH, VIA_MICROVIA)
DIM_UNITS_FORMAT m_DimensionUnitsFormat
bool GetTextUpright(PCB_LAYER_ID aLayer) const
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
bool GetTextItalic(PCB_LAYER_ID aLayer) const
int GetCurrentViaSize() const
std::shared_ptr< DRC_ENGINE > m_DRCEngine
bool m_UseConnectedTrackWidth
bool m_DimensionSuppressZeroes
void SetViaSizeIndex(unsigned aIndex)
Set the current via size list index to aIndex.
int GetDRCEpsilon() const
unsigned GetViaSizeIndex() const
bool m_DimensionKeepTextAligned
VECTOR2I GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
int GetLineThickness(PCB_LAYER_ID aLayer) const
Return the default graphic segment thickness from the layer class for the given layer.
int GetCurrentViaDrill() const
DIM_TEXT_POSITION m_DimensionTextPosition
DIM_UNITS_MODE m_DimensionUnitsMode
std::vector< VIA_DIMENSION > m_ViasDimensionsList
int m_DimensionExtensionOffset
int m_DimensionArrowLength
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
virtual std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const
virtual bool HasHole() const
const FOOTPRINTS & Footprints() const
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
size_type GetHeight() const
coord_type GetTop() const
size_type GetWidth() const
bool Contains(const Vec &aPoint) const
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
coord_type GetRight() const
coord_type GetLeft() const
coord_type GetBottom() const
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
std::list< std::unique_ptr< EDA_ITEM > > & GetImportedItems()
bool ShouldFixDiscontinuities()
bool IsPlacementInteractive()
Implementing DIALOG_TRACK_VIA_SIZE_BASE.
SEVERITY GetSeverity() const
const MINOPTMAX< int > & GetValue() const
void ShowInfoBarMsg(const wxString &aMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of...
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
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...
bool IsType(FRAME_T aType) const
WX_INFOBAR * GetInfoBar()
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
void DisplayConstraintsMsg(const wxString &msg)
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.
virtual void SetPosition(const VECTOR2I &aPos)
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
void SetCenter(const VECTOR2I &aCenter)
void SetFilled(bool aFlag)
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
void SetStart(const VECTOR2I &aStart)
void SetShape(SHAPE_T aShape)
void SetEnd(const VECTOR2I &aEnd)
void SetArcAngleAndEnd(const EDA_ANGLE &aAngle, bool aCheckNegativeAngle=false)
Set the end point from the angle center and start.
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
virtual bool IsVisible() const
void SetTextPos(const VECTOR2I &aPoint)
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
void SetItalic(bool aItalic)
A color representation with 4 components: red, green, blue, alpha.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Represents an assistant draw when interactively drawing an arc on a canvas.
void SetUnits(EDA_UNITS aUnits)
Manage the construction of a circular arc though sequential setting of critical points: center,...
VECTOR2I GetOrigin() const
< Get the center point of the arc (valid when state > SET_ORIGIN)
void SetAngleSnap(bool aSnap)
ARC_STEPS GetStep() const
Get the current step the manager is on (useful when drawing something depends on the current state)
void ToggleClockwise()
Set angle snapping (for the next point)
VECTOR2I GetStartRadiusEnd() const
Get the coordinates of the arc end point.
VECTOR2I GetEndRadiusEnd() const
Get the radius of the arc (valid if step >= SET_START)
EDA_ANGLE GetSubtended() const
@ SET_ANGLE
Waiting to lock in the arc end point.
@ SET_START
Waiting to lock in the arc start point.
bool HasGeometryChanged() const
void AddPoint(const VECTOR2I &aPt, bool aLockIn)
Add a point to the construction manager.
void RemoveLastPoint()
Undo the last point, and move the manager back to the previous step.
Represents an assistant draw when interactively drawing a line or circle on a canvas.
void SetUnits(EDA_UNITS aUnits)
Represent a very simple geometry manager for items that have a start and end point.
void SetOrigin(const VECTOR2I &aOrigin)
< Set the origin of the ruler (the fixed end)
void SetAngleSnap(bool aSnap)
VECTOR2I GetOrigin() const
void Reset()
Reset the manager to the initial state.
void SetEnd(const VECTOR2I &aEnd)
Set the current end of the rectangle (the end that moves with the cursor.
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.
virtual void CaptureCursor(bool aEnabled)
Force the cursor to stay within the drawing panel area.
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 VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Return the current mouse pointer position.
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.
virtual void PinCursorInsideNonAutoscrollArea(bool aWarpMouseCursor)=0
void ShowPreview(bool aShow=true)
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
int Query(const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
Find all visible items that touch or are within the rectangle aRect.
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...
void RecacheAllItems()
Rebuild GAL display lists.
std::pair< VIEW_ITEM *, int > LAYER_ITEM_PAIR
void AddToPreview(VIEW_ITEM *aItem, bool aTakeOwnership=true)
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
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.
A collection of nets and the parameters used to route or test these nets.
int GetuViaDiameter() const
const wxString & GetNetname() const
Container for NETINFO_ITEM elements, which are the nets.
static const int ORPHANED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
NETINFO_ITEM * GetNetItem(int aNetCode) const
static TOOL_ACTION deleteLastPoint
static TOOL_ACTION toggleHV45Mode
static TOOL_ACTION drawRuleArea
static TOOL_ACTION placeText
static TOOL_ACTION drawOrthogonalDimension
static TOOL_ACTION drawRectangle
static TOOL_ACTION setAnchor
static TOOL_ACTION placeReferenceImage
static TOOL_ACTION drawCircle
static TOOL_ACTION selectionCursor
Select a single item under the cursor position.
static TOOL_ACTION tuneDiffPair
static TOOL_ACTION trackViaSizeChanged
static TOOL_ACTION layerChanged
static TOOL_ACTION drawTable
static TOOL_ACTION drawTextBox
static TOOL_ACTION drawZoneCutout
static TOOL_ACTION drawPolygon
static TOOL_ACTION drawRadialDimension
static TOOL_ACTION tuneSingleTrack
static TOOL_ACTION properties
Activation of the edit tool.
static TOOL_ACTION drawLeader
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION placeCharacteristics
static TOOL_ACTION tuneSkew
static TOOL_ACTION incWidth
Increase width of currently drawn line.
static TOOL_ACTION clearHighlight
static TOOL_ACTION spacingDecrease
static TOOL_ACTION placeImportedGraphics
static TOOL_ACTION drawVia
static TOOL_ACTION drawArc
static TOOL_ACTION drawSimilarZone
static TOOL_ACTION decWidth
Decrease width of currently drawn line.
static TOOL_ACTION drawCenterDimension
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
static TOOL_ACTION arcPosture
Switch posture when drawing arc.
static TOOL_ACTION closeOutline
static TOOL_ACTION amplIncrease
static TOOL_ACTION amplDecrease
static TOOL_ACTION lengthTunerSettings
static TOOL_ACTION spacingIncrease
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
static TOOL_ACTION drawLine
static TOOL_ACTION placeStackup
static TOOL_ACTION drawAlignedDimension
static TOOL_ACTION drawZone
virtual bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Common, abstract interface for edit frames.
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
virtual void OnEditItemRequest(BOARD_ITEM *aItem)
Install the corresponding dialog editor for the given item.
void ClearListAndDeleteItems(PICKED_ITEMS_LIST *aList)
int ShowTextBoxPropertiesDialog(PCB_TEXTBOX *aTextBox)
APPEARANCE_CONTROLS * GetAppearancePanel()
void PutDataInPreviousState(PICKED_ITEMS_LIST *aList)
Used in undo or redo command.
void SetObjectVisible(GAL_LAYER_ID aLayer, bool aVisible=true)
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
virtual PCB_LAYER_ID GetActiveLayer() const
virtual MAGNETIC_SETTINGS * GetMagneticItemsSettings()
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 BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
virtual BOARD_ITEM_CONTAINER * GetModel() const =0
void Update()
Update the dimension's cached text and geometry.
int GetLineThickness() const
void SetExtensionOffset(int aOffset)
void SetLineThickness(int aWidth)
void SetArrowLength(int aLength)
virtual const VECTOR2I & GetStart() const
The dimension's origin is the first feature point for the dimension.
virtual void SetEnd(const VECTOR2I &aPoint)
virtual void SetStart(const VECTOR2I &aPoint)
int GetArrowLength() const
virtual const VECTOR2I & GetEnd() const
For better understanding of the points that make a dimension:
double GetAngle() const
Return the angle of the crossbar.
void SetHeight(int aHeight)
Set the distance from the feature points to the crossbar line.
Mark the center of a circle or arc with a cross shape.
A leader is a dimension-like object pointing to a specific point.
An orthogonal dimension is like an aligned dimension, but the extension lines are locked to the X or ...
A radial dimension indicates either the radius or diameter of an arc or circle.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
The main frame for Pcbnew.
VECTOR2I AlignToSegment(const VECTOR2I &aPoint, const SEG &aSeg)
A set of BOARD_ITEMs (i.e., without duplicates).
Object to handle a bitmap image that can be inserted in a PCB.
PCB_LAYER_ID m_Route_Layer_TOP
PCB_LAYER_ID m_Route_Layer_BOTTOM
EDA_ITEM * GetTopLeftItem(bool aFootprintsOnly=false) const override
void SetPosition(const VECTOR2I &aPos) override
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
void SetStroke(const STROKE_PARAMS &aStroke) override
void Normalize() override
Perform any normalization required after a user rotate and/or flip.
VECTOR2I GetPosition() const override
void SetColWidth(int aCol, int aWidth)
void Normalize() override
Perform any normalization required after a user rotate and/or flip.
void AddCell(PCB_TABLECELL *aCell)
void SetColCount(int aCount)
VECTOR2I GetPosition() const override
void SetRowHeight(int aRow, int aHeight)
void SetPosition(const VECTOR2I &aPos) override
void SetEnd(const VECTOR2I &aEnd)
void SetStart(const VECTOR2I &aStart)
virtual EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
const VECTOR2I & GetStart() const
const VECTOR2I & GetEnd() const
VECTOR2I GetPosition() const override
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
virtual COMMON_SETTINGS * GetCommonSettings() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
A holder to handle information on schematic or board items.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
unsigned GetCount() const
ROUTING_SETTINGS & Settings()
bool AllowDRCViolations() const
Class that handles the drawing of a polygon, including management of last corner deletion and drawing...
bool AddPoint(const VECTOR2I &aPt)
Lock in a polygon point.
@ DIRECT
Unconstrained point-to-point.
void SetCursorPosition(const VECTOR2I &aPos)
Set the current cursor position.
bool NewPointClosesOutline(const VECTOR2I &aPt) const
std::optional< VECTOR2I > DeleteLastCorner()
Remove the last-added point from the polygon.
void SetFinished()
Mark the polygon finished and update the client.
void SetLeaderMode(LEADER_MODE aMode)
Set the leader mode to use when calculating the leader/returner lines.
void Reset()
Clear the manager state and start again.
RAII class that sets an value at construction and resets it to the original value at destruction.
bool Contains(const SEG &aSeg) const
virtual void Add(EDA_ITEM *aItem)
virtual void Remove(EDA_ITEM *aItem)
virtual void Clear() override
Remove all the stored items from the group.
int Size() const
Returns the number of selected parts.
void SetReferencePoint(const VECTOR2I &aP)
bool Empty() const
Checks if there is anything selected.
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
void SetLineStyle(LINE_STYLE aLineStyle)
void SetWidth(int aWidth)
void SetColor(const KIGFX::COLOR4D &aColor)
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
EDA_UNITS GetUserUnits() const
A modified version of the wxInfoBar class that allows us to:
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
MESSAGE_TYPE GetMessageType() const
An adjunct helper to the DRAWING_TOOL interactive tool, which handles incoming geometry changes from ...
void OnGeometryChange(const POLYGON_GEOM_MANAGER &aMgr) override
Called when the polygon is complete.
Handle a list of polygons defining a copper zone.
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
bool GetDoNotAllowVias() const
SHAPE_POLY_SET * Outline()
virtual bool IsOnLayer(PCB_LAYER_ID) const override
Test to see if this object is on the given layer.
PCB_LAYER_ID GetFirstLayer() const
This file is part of the common library.
@ HOLE_CLEARANCE_CONSTRAINT
static constexpr EDA_ANGLE ANGLE_0
static constexpr EDA_ANGLE ANGLE_90
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
#define IS_NEW
New item, just created.
#define IS_MOVING
Item being moved.
void ConnectBoardShapes(std::vector< PCB_SHAPE * > &aShapeList, std::vector< std::unique_ptr< PCB_SHAPE > > &aNewShapes, int aChainingEpsilon)
Connects shapes to each other, making continious contours (adjacent shapes will have a common vertex)...
a few functions useful in geometry calculations.
VECTOR2< T > GetVectorSnapped45(const VECTOR2< T > &aVec, bool only45=false)
Snap a vector onto the nearest 0, 45 or 90 degree line.
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...
void InferBold(TEXT_ATTRIBUTES *aAttrs)
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored)
@ LAYER_SHAPES
Copper graphic shape opacity/visibility (color ignored)
PCB_LAYER_ID
A quick note on layer IDs:
PCB_LAYER_ID ToLAYER_ID(int aLayer)
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Class to handle a set of BOARD_ITEMs.
@ ID_POPUP_PCB_SELECT_CUSTOM_WIDTH
@ ID_POPUP_PCB_SELECT_VIASIZE1
@ ID_POPUP_PCB_SELECT_VIASIZE16
int GetUserUnits()
Return the currently selected user unit value for the interface.
PGM_BASE & Pgm()
The global Program "get" accessor.
Class that computes missing connections on a PCB.
@ NONE
No connection to this item.
bool NoPrintableChars(const wxString &aString)
Return true if the string is empty or contains only whitespace.
LINE_STYLE
Dashed line types.
constexpr int mmToIU(double mm) const
A filename or source description, a problem input line, a line number, a byte offset,...
Container to handle a stock of specific vias each with unique diameter and drill sizes in the BOARD c...
Parameters used to fully describe a zone creation process.
ZONE_MODE m_mode
Zone settings source (for similar and cutout zones)
bool m_keepout
< Should create a keepout zone?
ZONE * m_sourceZone
Zone leader mode.
PCB_LAYER_ID m_layer
The zone mode to operate in.
bool TestSegmentHit(const VECTOR2I &aRefPoint, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aDist)
Test if aRefPoint is with aDistance on the line defined by aStart and aEnd.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
VECTOR2< int32_t > VECTOR2I
VECTOR2< double > VECTOR2D