28#include "dialog_table_properties.h"
34#include <dialogs/dialog_text_properties.h>
55#include <wx/filedlg.h>
91 SetIcon( BITMAPS::width_track_via );
112 _(
"Specify custom track and via sizes" ), wxITEM_CHECK );
121 if(
via.m_Drill > 0 )
123 msg.Printf(
_(
"Via %s, hole %s" ),
129 msg.Printf(
_(
"Via %s" ),
134 Append( menuIdx, msg, wxEmptyString, wxITEM_CHECK );
143 int id = aEvent.GetId();
152 if( sizeDlg.ShowModal() == wxID_OK )
173 m_controls( nullptr ),
177 m_inDrawingTool( false ),
180 m_pickerItem( nullptr ),
181 m_tuningPattern( nullptr )
201 auto activeToolFunctor =
218 auto canCloseOutline =
238 auto tuningToolActive =
266 std::shared_ptr<VIA_SIZE_MENU> viaSizeMenu = std::make_shared<VIA_SIZE_MENU>();
267 viaSizeMenu->SetTool(
this );
269 ctxMenu.
AddMenu( viaSizeMenu.get(), viaToolActive, 500 );
277 getEditFrame<PCB_BASE_FRAME>()->AddStandardSubMenus(
m_menu );
289 m_frame = getEditFrame<PCB_BASE_EDIT_FRAME>();
349 std::optional<VECTOR2D> startingPoint;
350 std::stack<PCB_SHAPE*> committedLines;
361 while(
drawShape( aEvent, &line, startingPoint, &committedLines ) )
366 commit.
Push(
_(
"Draw Line" ) );
368 committedLines.push( line );
372 startingPoint = std::nullopt;
399 std::optional<VECTOR2D> startingPoint;
402 rect->
SetShape( SHAPE_T::RECTANGLE );
412 while(
drawShape( aEvent, &rect, startingPoint,
nullptr ) )
416 bool cancelled =
false;
430 commit.
Push( isTextBox ?
_(
"Draw Text Box" ) :
_(
"Draw Rectangle" ) );
437 rect->
SetShape( SHAPE_T::RECTANGLE );
440 startingPoint = std::nullopt;
461 std::optional<VECTOR2D> startingPoint;
463 circle->
SetShape( SHAPE_T::CIRCLE );
473 while(
drawShape( aEvent, &circle, startingPoint,
nullptr ) )
477 commit.
Add( circle );
478 commit.
Push(
_(
"Draw Circle" ) );
484 circle->
SetShape( SHAPE_T::CIRCLE );
488 startingPoint = std::nullopt;
509 std::optional<VECTOR2D> startingPoint;
520 while(
drawArc( aEvent, &arc, startingPoint ) )
525 commit.
Push(
_(
"Draw Arc" ) );
534 startingPoint = std::nullopt;
549 bool immediateMode =
image !=
nullptr;
551 bool ignorePrimePosition =
false;
563 image->SetPosition( cursorPos );
609 ignorePrimePosition =
true;
618 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
643 else if( evt->IsActivate() )
645 if(
image && evt->IsMoveTool() )
648 evt->SetPassEvent(
false );
655 evt->SetPassEvent(
false );
659 if( evt->IsMoveTool() )
676 wxFileDialog dlg(
m_frame,
_(
"Choose Image" ), wxEmptyString, wxEmptyString,
677 _(
"Image Files" ) + wxS(
" " ) + wxImage::GetImageExtWildcard(),
680 if( dlg.ShowModal() != wxID_OK )
686 if( evt->IsPrime() && !ignorePrimePosition )
688 cursorPos =
grid.Align( evt->Position() );
699 wxString fullFilename = dlg.GetPath();
701 if( wxFileExists( fullFilename ) )
704 if( !
image || !
image->ReadImageFile( fullFilename ) )
706 wxMessageBox(
_(
"Could not load image from '%s'." ), fullFilename );
727 commit.Push(
_(
"Place Image" ) );
752 || evt->IsMotion() ) )
754 image->SetPosition( cursorPos );
798 bool ignorePrimePosition =
false;
844 ignorePrimePosition =
true;
853 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
872 else if( evt->IsActivate() )
877 if( evt->IsMoveTool() )
897 bool placing =
text !=
nullptr;
922 text->SetLayer( layer );
923 text->SetAttributes( textAttrs );
924 text->SetTextPos( cursorPos );
940 else if(
text->GetTextPos() != cursorPos )
969 commit.
Push(
_(
"Place Text" ) );
981 if( evt->IsPrime() && !ignorePrimePosition )
983 cursorPos = evt->Position();
998 else if(
text && ( evt->IsMotion()
1001 text->SetPosition( cursorPos );
1018 evt->SetPassEvent();
1090 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1097 if( evt->IsCancelInteractive() || ( table && evt->IsAction( &
ACTIONS::undo ) ) )
1109 else if( evt->IsActivate() )
1114 if( evt->IsMoveTool() )
1133 else if( evt->IsClick(
BUT_LEFT ) )
1174 commit.
Push(
_(
"Draw Table" ) );
1192 VECTOR2I requestedSize( cursorPos - origin );
1194 int colCount = std::max( 1, requestedSize.
x / ( fontSize.
x * 15 ) );
1195 int rowCount = std::max( 1, requestedSize.
y / ( fontSize.
y * 3 ) );
1197 VECTOR2I cellSize( std::max( fontSize.
x * 5, requestedSize.
x / colCount ),
1198 std::max( fontSize.
y * 3, requestedSize.
y / rowCount ) );
1200 cellSize.
x =
KiROUND( (
double) cellSize.
x / gridSize.
x ) * gridSize.
x;
1201 cellSize.
y =
KiROUND( (
double) cellSize.
y / gridSize.
y ) * gridSize.
y;
1206 for(
int col = 0; col < colCount; ++col )
1209 for(
int row = 0; row < rowCount; ++row )
1213 for(
int col = 0; col < colCount; ++col )
1239 evt->SetPassEvent();
1273 enum DIMENSION_STEPS
1288 int step = SET_ORIGIN;
1304 dimension =
nullptr;
1333 if( step > SET_ORIGIN )
1339 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1347 grid.SetUseGrid(
false );
1357 if( evt->IsCancelInteractive() || ( dimension && evt->IsAction( &
ACTIONS::undo ) ) )
1361 if( step != SET_ORIGIN )
1371 else if( evt->IsActivate() )
1373 if( step != SET_ORIGIN )
1376 if( evt->IsPointEditor() )
1380 else if( evt->IsMoveTool() )
1426 auto setMeasurementAttributes =
1440 setMeasurementAttributes( dimension );
1445 setMeasurementAttributes( dimension );
1454 setMeasurementAttributes( dimension );
1463 wxFAIL_MSG( wxT(
"Unhandled action in DRAWING_TOOL::DrawDimension" ) );
1466 t = dimension->
Type();
1476 dimension->
SetEnd( cursorPos );
1485 preview.
Add( dimension );
1516 preview.
Remove( dimension );
1518 commit.
Add( dimension );
1519 commit.
Push(
_(
"Draw Dimension" ) );
1530 if( ++step >= FINISHED )
1532 dimension =
nullptr;
1537 else if( evt->IsDblClick(
BUT_LEFT ) )
1542 else if( evt->IsMotion() )
1547 dimension->
SetEnd( cursorPos );
1571 textOffset = -textOffset;
1580 textOffset = -textOffset;
1594 double angle = aligned->
GetAngle() + ( M_PI / 2 );
1597 double height = (
delta.x * cos( angle ) ) + (
delta.y * sin( angle ) );
1635 ortho->SetHeight( vert ? heightVector.
x : heightVector.
y );
1667 if( step == SET_END || step == SET_HEIGHT )
1686 evt->SetPassEvent();
1690 if( step != SET_ORIGIN )
1718 int dlgResult = dlg.ShowModal();
1722 if( dlgResult != wxID_OK )
1728 wxMessageBox(
_(
"No graphic items found in file.") );
1734 std::vector<BOARD_ITEM*> newItems;
1735 std::vector<BOARD_ITEM*> selectedItems;
1746 newItems.push_back(
group );
1747 selectedItems.push_back(
group );
1753 std::vector<PCB_SHAPE*> shapeList;
1754 std::vector<std::unique_ptr<PCB_SHAPE>> newShapes;
1756 for(
const std::unique_ptr<EDA_ITEM>& ptr : list )
1759 shapeList.push_back( shape );
1764 for( std::unique_ptr<PCB_SHAPE>& ptr : newShapes )
1767 list.push_back( std::move( ptr ) );
1771 for( std::unique_ptr<EDA_ITEM>& ptr : list )
1774 wxCHECK2( item,
continue );
1776 newItems.push_back( item );
1780 group->AddItem( item );
1785 selectedItems.push_back( item );
1790 preview.
Add( item );
1796 EDA_ITEMS selItems( selectedItems.begin(), selectedItems.end() );
1805 commit.
Stage( groupUndoList );
1807 commit.
Push(
_(
"Import Graphics" ) );
1843 item->Move(
delta );
1853 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1859 if( evt->IsCancelInteractive() || evt->IsActivate() )
1874 else if( evt->IsMotion() )
1879 item->Move(
delta );
1894 commit.
Stage( groupUndoList );
1896 commit.
Push(
_(
"Import Graphics" ) );
1906 evt->SetPassEvent();
1963 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1978 commit.
Push(
_(
"Move Footprint Anchor" ) );
1989 else if( evt->IsCancelInteractive() || evt->IsActivate() )
1996 evt->SetPassEvent();
2009#define TOGGLE( a ) a = !a
2041 std::optional<VECTOR2D> aStartingPoint,
2042 std::stack<PCB_SHAPE*>* aCommittedGraphics )
2044 SHAPE_T shape = ( *aGraphic )->GetShape();
2047 wxASSERT( shape == SHAPE_T::SEGMENT || shape == SHAPE_T::CIRCLE || shape == SHAPE_T::RECTANGLE );
2084 bool started =
false;
2085 bool cancelled =
false;
2103 if( !isLocalOriginSet )
2114 if( aStartingPoint )
2126 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2132 if( evt->IsCancelInteractive() || ( started && evt->IsAction( &
ACTIONS::undo ) ) )
2139 evt->SetPassEvent(
false );
2146 else if( evt->IsActivate() )
2148 if( evt->IsPointEditor() )
2152 else if( evt->IsMoveTool() )
2205 evt->SetPassEvent();
2224 if( aStartingPoint )
2226 cursorPos = *aStartingPoint;
2227 aStartingPoint = std::nullopt;
2242 grid.SetSkipPoint( cursorPos );
2245 twoPointMgr.
SetEnd( cursorPos );
2247 if( !isLocalOriginSet )
2269 if( shape == SHAPE_T::SEGMENT && snapItem && graphic->
GetLength() > 0 )
2274 commit.
Add( graphic );
2275 commit.
Push(
_(
"Draw Line" ) );
2288 twoPointMgr.
Reset();
2294 else if( evt->IsMotion() )
2296 VECTOR2I clampedCursorPos = cursorPos;
2298 if( shape == SHAPE_T::CIRCLE || shape == SHAPE_T::ARC )
2316 twoPointMgr.
SetEnd( clampedCursorPos );
2327 if( aCommittedGraphics && !aCommittedGraphics->empty() )
2329 twoPointMgr.
SetOrigin( aCommittedGraphics->top()->GetStart() );
2330 twoPointMgr.
SetEnd( aCommittedGraphics->top()->GetEnd() );
2331 aCommittedGraphics->pop();
2383 isLocalOriginSet =
true;
2384 evt->SetPassEvent();
2391 twoPointAsst.
SetUnits( userUnits );
2394 evt->SetPassEvent();
2398 evt->SetPassEvent();
2402 if( !isLocalOriginSet )
2448 std::optional<VECTOR2D> aStartingPoint )
2450 wxCHECK( aGraphic,
false );
2454 wxCHECK( graphic,
false );
2487 *aGraphic =
nullptr;
2495 bool started =
false;
2496 bool cancelled =
false;
2500 if( aStartingPoint )
2514 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2520 if( evt->IsCancelInteractive() || ( started && evt->IsAction( &
ACTIONS::undo ) ) )
2527 evt->SetPassEvent(
false );
2534 else if( evt->IsActivate() )
2536 if( evt->IsPointEditor() )
2540 else if( evt->IsMoveTool() )
2555 else if( evt->IsClick(
BUT_LEFT ) )
2575 preview.
Add( graphic );
2580 arcManager.
AddPoint( cursorPos,
true );
2586 else if( evt->IsMotion() )
2592 arcManager.
AddPoint( cursorPos,
false );
2619 evt->SetPassEvent();
2643 evt->SetPassEvent();
2686 evt->SetPassEvent();
2695 evt->SetPassEvent();
2715 preview.
Remove( graphic );
2733 bool clearSelection =
false;
2737 if( aMode == ZONE_MODE::ADD || aMode == ZONE_MODE::GRAPHIC_POLYGON )
2745 clearSelection =
true;
2756 if( clearSelection )
2784 ZONE* sourceZone =
nullptr;
2795 params.
m_mode = zoneMode;
2799 if( zoneMode == ZONE_MODE::SIMILAR && !sourceZone->
IsOnLayer( params.
m_layer ) )
2806 bool started =
false;
2820 polyGeomMgr.
Reset();
2822 grid.ClearSkipPoint();
2844 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2855 if( evt->IsCancelInteractive() )
2866 evt->SetPassEvent(
false );
2870 else if( evt->IsActivate() )
2875 if( evt->IsPointEditor() )
2879 else if( evt->IsMoveTool() )
2892 if( zoneMode != ZONE_MODE::SIMILAR )
2914 const bool endPolygon = evt->IsDblClick(
BUT_LEFT )
2921 polyGeomMgr.
Reset();
2928 else if( polyGeomMgr.
AddPoint( cursorPos ) )
2951 cursorPos = last.value();
2961 else if( started && ( evt->IsMotion()
2987 evt->SetPassEvent();
3009 std::shared_ptr<DRC_ENGINE> m_drcEngine;
3011 int m_worstClearance;
3012 bool m_allowDRCViolations;
3019 m_worstClearance( 0 )
3037 m_worstClearance = std::max( m_worstClearance, constraint.
GetValue().
Min() );
3041 for(
PAD*
pad : footprint->Pads() )
3043 std::optional<int> padOverride =
pad->GetClearanceOverrides(
nullptr );
3045 if( padOverride.has_value() )
3046 m_worstClearance = std::max( m_worstClearance, padOverride.value() );
3055 virtual ~VIA_PLACER()
3065 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> items;
3067 std::vector<PCB_TRACK*> possible_tracks;
3069 wxCHECK( view,
nullptr );
3071 view->
Query( bbox, items );
3087 possible_tracks.push_back( track );
3093 int min_d = std::numeric_limits<int>::max();
3095 for(
PCB_TRACK* track : possible_tracks )
3097 SEG test( track->GetStart(), track->GetEnd() );
3103 return_track = track;
3107 return return_track;
3115 ZONE* zone =
dynamic_cast<ZONE*
>( aOther );
3127 int connectedItemNet = connectedItem->
GetNetCode();
3129 if( connectedItemNet == 0 || connectedItemNet == aVia->
GetNetCode() )
3142 if( clearance >= 0 )
3147 if( viaShape->Collide( otherShape.get(), clearance - m_drcEpsilon ) )
3158 if( clearance >= 0 )
3163 clearance - m_drcEpsilon ) )
3173 bool checkDRCViolation(
PCB_VIA* aVia )
3175 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> items;
3176 std::set<BOARD_ITEM*> checkedItems;
3179 bbox.
Inflate( m_worstClearance );
3182 for( std::pair<KIGFX::VIEW_ITEM*, int> it : items )
3202 else if( checkedItems.count( item ) )
3207 if( hasDRCViolation( aVia, item ) )
3210 checkedItems.insert( item );
3227 for(
FOOTPRINT* fp : m_board->Footprints() )
3229 for(
PAD*
pad : fp->Pads() )
3231 if(
pad->HitTest( position ) && (
pad->GetLayerSet() & lset ).any() )
3233 if(
pad->GetNetCode() > 0 )
3242 int selectPossibleNetsByPopMenu( std::list<int>& aNetcodeList )
3246 std::map<int, int> menuIDNetCodeMap;
3249 for(
int netcode : aNetcodeList )
3255 menuText = wxString::Format(
"%s\t",
3258 menuText = wxString::Format(
"&%d %s\t",
3268 menu.
Add( menuText, menuID, BITMAPS::INVALID_BITMAP );
3269 menuIDNetCodeMap[ menuID ] = netcode;
3279 int selectNetCode = -1;
3284 evt->SetPassEvent();
3288 std::optional<int>
id = evt->GetCommandId();
3291 if(
id && ( *
id > 0 ) && ( *
id < menuID ) )
3293 selectNetCode = menuIDNetCodeMap.at( *
id );
3309 return selectNetCode;
3312 int findStitchedZoneNet(
PCB_VIA* aVia )
3325 for(
ZONE* z : m_board->Zones() )
3329 if( z->HitTestFilledArea( m_frame->
GetActiveLayer(), position ) )
3330 return z->GetNetCode();
3337 LSET tempLset =
LSET( m_board->GetVisibleLayers() & lset );
3338 std::list<int> netcodeList;
3342 if( 1 != tempLset.
Seq().size() )
3349 for(
ZONE* z : m_board->Zones() )
3353 if( z->IsOnLayer( layer ) )
3355 if( z->HitTestFilledArea( layer, position ) )
3356 netcodeList.push_back( z->GetNetCode() );
3363 netcodeList.unique();
3365 if( netcodeList.size() == 1 )
3367 return netcodeList.front();
3372 if( netcodeList.size() > 1 )
3374 return selectPossibleNetsByPopMenu( netcodeList );
3389 if( settings->
tracks == MAGNETIC_OPTIONS::CAPTURE_ALWAYS && m_gridHelper.
GetSnap() )
3401 else if( settings->
pads == MAGNETIC_OPTIONS::CAPTURE_ALWAYS && m_gridHelper.
GetSnap() )
3423 via->SetIsFree(
false );
3427 via->SetNetCode(
pad->GetNetCode() );
3428 via->SetIsFree(
false );
3432 int netcode = findStitchedZoneNet(
via );
3439 via->SetNetCode( netcode );
3440 via->SetIsFree(
via->GetNetCode() > 0 );
3443 if( checkDRCViolation(
via ) )
3448 if( !m_allowDRCViolations )
3462 if( track && m_gridHelper.
GetSnap() )
3466 SEG trackSeg( trackStart, trackEnd );
3468 if( viaPos == trackStart || viaPos == trackEnd )
3482 newTrack->
SetEnd( trackEnd );
3483 aCommit.
Add( newTrack );
3489 std::unique_ptr<BOARD_ITEM> CreateItem()
override
3494 via->SetNetCode( 0 );
3515 switch(
via->GetViaType() )
3517 case VIATYPE::BLIND_BURIED:
3518 via->SetLayerPair( first_layer, last_layer );
3521 case VIATYPE::MICROVIA:
3524 ToLAYER_ID( ( m_board->GetCopperLayerCount() - 2 ) );
3526 if( first_layer ==
B_Cu )
3527 last_layer = last_inner_layer;
3528 else if( first_layer ==
F_Cu )
3530 else if( first_layer == last_inner_layer )
3532 else if( first_layer ==
In1_Cu )
3536 via->SetLayerPair( first_layer, last_layer );
3550 return std::unique_ptr<BOARD_ITEM>(
via );
3554 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.
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 ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
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.
virtual 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.
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
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)
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.
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.
double EuclideanNorm(const VECTOR2I &vector)
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< double > VECTOR2D