29#include <magic_enum.hpp>
90 wxString
GetClass()
const override {
return wxT(
"TUNING_STATUS" ); }
93 void Show(
int nestLevel, std::ostream& os )
const override {}
111 m_max = std::numeric_limits<double>::max();
146 gal->
Scale( { 1., 1. } );
157 VECTOR2I offset( margin.
x * 2, -( size.
y + margin.
y * 2 ) );
159 if( drawingDropShadows )
164 gal->
SetStrokeColor( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
165 KIGFX::COLOR4D bgColor( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE ) );
174 COLOR4D bg = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE );
175 COLOR4D normal = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT );
179 double bg_h, bg_s, bg_l;
180 bg.
ToHSL( bg_h, bg_s, bg_l );
181 red.FromHSL( 0, 1.0, bg_l < 0.5 ? 0.7 : 0.3 );
206 textPos.
x += glyphWidth * 11 + margin.
x;
207 font->
Draw( gal,
_(
"min" ), textPos, textAttrs, fontMetrics );
209 textPos.
x += glyphWidth * 7 + margin.
x;
210 font->
Draw( gal,
_(
"max" ), textPos, textAttrs, fontMetrics );
219 textPos.
x += glyphWidth * 11 + margin.
x;
221 font->
Draw( gal,
m_minText, textPos, textAttrs, fontMetrics );
223 textPos.
x += glyphWidth * 7 + margin.
x;
225 font->
Draw( gal,
m_maxText, textPos, textAttrs, fontMetrics );
256 return wxString(
_(
"Tuning Pattern" ) );
261 return wxString(
_(
"Tuning Pattern" ) );
266 return wxString(
_(
"Tuning Patterns" ) );
278 const wxString& aCommitMsg = wxEmptyString,
int aCommitFlags = 0 )
override;
284 bool MakeEditPoints( std::shared_ptr<EDIT_POINTS> points )
const override;
294 m_end += aMoveVector;
335 m_baseLine->Mirror( aFlipLeftRight, !aFlipLeftRight, aCentre );
359 bool HitTest(
const BOX2I& aRect,
bool aContained,
int aAccuracy )
const override
405 aValue = std::max( aValue, 0 );
416 aValue = std::max( aValue, 0 );
433 return std::optional<int>();
440 if( aValue.has_value() )
462 std::vector<std::pair<wxString, wxVariant>>
GetRowData()
override
476 bool aStatusItemsOnly =
false )
override;
494 std::optional<SHAPE_LINE_CHAIN>& aBaseLine );
527 if( aStr ==
"single" )
529 else if( aStr ==
"diff_pair" )
531 else if( aStr ==
"diff_pair_skew" )
535 wxFAIL_MSG( wxS(
"Unknown length tuning token" ) );
548 default: wxFAIL;
return "";
555 switch( aRouterMode )
567 if( aStr ==
"default" )
569 else if( aStr ==
"left" )
571 else if( aStr ==
"right" )
575 wxFAIL_MSG( wxS(
"Unknown length-tuning side token" ) );
588 default: wxFAIL;
return "";
595 if( aStr ==
"too_long" )
597 else if( aStr ==
"too_short" )
599 else if( aStr ==
"tuned" )
603 wxFAIL_MSG( wxS(
"Unknown tuning status token" ) );
616 default: wxFAIL;
return "";
626 m_tuningMode( aMode ),
627 m_tuningStatus(
PNS::MEANDER_PLACER_BASE::TUNING_STATUS::TUNED )
644 if( aNet && track->GetNet() != aNet )
659 SEG seg( track->GetStart(), track->GetEnd() );
663 SEG::ecoord dist_sq = ( nearest - aP ).SquaredEuclideanNorm();
665 if( dist_sq < minDist_sq )
667 minDist_sq = dist_sq;
671 *aNearestTrack = track;
714 if( !constraint.
IsNull() )
732 aCommit->
Add(
this );
767 &pnsItem,
nullptr, layer, &constraint ) )
782 pnsCoupledItem.
SetParent( coupledTrack );
783 pnsCoupledItem.
SetNet( coupledNet );
788 &pnsItem, &pnsCoupledItem, layer, &constraint ) )
797 &pnsItem, &pnsCoupledItem, layer, &constraint ) )
814 static const int candidateCount = 2;
820 for(
int i = 0; i < candidateCount; i++ )
822 prioritized[i] =
nullptr;
827 for(
int slopRadius : { 0, maxSlopRadius } )
836 if( !item->IsRoutable() )
839 if( !item->Layers().Overlaps( aLayer ) )
849 SEG::ecoord d0 = ( nearest - aWhere ).SquaredEuclideanNorm();
854 if( aBaseline.PointCount() > 0 )
859 if( aBaseline.SegmentCount() > 0 )
860 dcBaseline = aBaseline.SquaredDistance( target );
862 dcBaseline = ( aBaseline.CPoint( 0 ) - target ).SquaredEuclideanNorm();
864 if( dcBaseline > distBaseline[1] )
867 distBaseline[1] = dcBaseline;
870 prioritized[1] = linked;
879 SEG::ecoord dd = ( aWhere - nearest ).SquaredEuclideanNorm();
884 if( aBaseline.PointCount() > 0 )
889 if( aBaseline.SegmentCount() > 0 )
890 dcBaseline = aBaseline.SquaredDistance( target );
892 dcBaseline = ( aBaseline.CPoint( 0 ) - target ).SquaredEuclideanNorm();
894 if( dcBaseline > distBaseline[1] )
897 distBaseline[1] = dcBaseline;
900 prioritized[1] = segm;
909 for(
int i = 0; i < candidateCount; i++ )
913 if( item && ( aLayer < 0 || item->Layers().Overlaps( aLayer ) ) )
916 aPointOut = point[i];
952 std::optional<SHAPE_LINE_CHAIN>& aBaseLine )
959 VECTOR2I startSnapPoint, endSnapPoint;
964 wxASSERT( startItem );
967 if( !startItem || !endItem )
975 wxASSERT( chain.
PointOnEdge( startSnapPoint, 40000 ) );
976 wxASSERT( chain.
PointOnEdge( endSnapPoint, 40000 ) );
982 chain.
Split( startSnapPoint, endSnapPoint, pre, mid, post );
997 wxCHECK( track,
false );
1013 return initBaseLine( aRouter, aLayer, aBoard, coupledStart, coupledEnd, coupledNet,
1026 VECTOR2I startSnapPoint, endSnapPoint;
1029 aRouter, aLayer, startSnapPoint, endSnapPoint );
1031 wxCHECK( pnsLine,
false );
1036 pnsLine->CLine().
Split( startSnapPoint, endSnapPoint, pre, mid, post );
1044 straightChain.
Append( pre );
1045 straightChain.
Append( aBaseLine );
1046 straightChain.
Append( post );
1049 PNS::LINE straightLine( *pnsLine, straightChain );
1077 group->GetItems().clear();
1086 bool success =
true;
1097 const std::vector<GENERATOR_PNS_CHANGES>& allPnsChanges = aTool->
GetRouterChanges();
1101 const std::set<BOARD_ITEM*> routerRemovedItems = pnsChanges.removedItems;
1102 const std::set<BOARD_ITEM*> routerAddedItems = pnsChanges.addedItems;
1110 item->ClearSelected();
1115 aCommit->
Add( item );
1118 aCommit->
Push(
"Remove Tuning Pattern" );
1150 if( lineWidth == 0 || li->Width() < lineWidth )
1151 lineWidth = li->Width();
1161 if( lineWidth == 0 )
1172 recoverLine.
SetNet( recoverNet );
1173 branch->
Add( recoverLine,
false );
1181 recoverLineCoupled.
SetWidth( lineWidth );
1183 recoverLineCoupled.
SetNet( recoverCoupledNet );
1184 branch->
Add( recoverLineCoupled,
false );
1202 VECTOR2I startSnapPoint, endSnapPoint;
1205 router, aLayer, startSnapPoint, endSnapPoint );
1219 pnsLine->CLine().
Split( startSnapPoint, endSnapPoint, pre, mid, post );
1221 straightChain.
Append( pre );
1222 straightChain.
Append( aBaseLine );
1223 straightChain.
Append( post );
1227 branch->
Remove( *pnsLine );
1240 m_end = endSnapPoint;
1247 newLineChain.
Append( pre );
1248 newLineChain.
Append( mid );
1249 newLineChain.
Append( post );
1261 straightChain.
Split( start, end, pre, mid, post );
1263 newLineChain.
Append( pre );
1264 newLineChain.
Append( mid );
1265 newLineChain.
Append( post );
1271 PNS::LINE newLine( *pnsLine, newLineChain );
1273 branch->
Add( newLine,
false );
1294 auto hideRemovedItems = [&](
bool aHide )
1300 for(
BOARD_ITEM* item : pnsCommit.removedItems )
1303 view->
Hide( item, aHide, aHide );
1343 hideRemovedItems(
true );
1345 VECTOR2I startSnapPoint, endSnapPoint;
1352 wxASSERT( startItem );
1353 wxASSERT( endItem );
1355 if( !startItem || !endItem )
1360 if( !router->
StartRouting( startSnapPoint, startItem, layer ) )
1388 wxString statusMessage;
1395 default: statusMessage =
_(
"unknown" );
break;
1399 EDA_UNITS userUnits = EDA_UNITS::MILLIMETRES;
1407 m_tuningInfo.Printf( wxS(
"%s (%s)" ), result, statusMessage );
1414 const wxString& aCommitMsg,
int aCommitFlags )
1431 bool forceFinish =
true;
1432 bool forceCommit =
false;
1434 router->
FixRoute(
m_end,
nullptr, forceFinish, forceCommit );
1438 const std::vector<GENERATOR_PNS_CHANGES>& pnsCommits = aTool->
GetRouterChanges();
1442 const std::set<BOARD_ITEM*> routerRemovedItems = pnsCommit.removedItems;
1443 const std::set<BOARD_ITEM*> routerAddedItems = pnsCommit.addedItems;
1452 view->
Hide( item,
false );
1459 aCommit->
Add( item );
1473 if( aCommitMsg.IsEmpty() )
1474 aCommit->
Push(
_(
"Edit Tuning Pattern" ), aCommitFlags );
1476 aCommit->
Push( aCommitMsg, aCommitFlags );
1495 for(
BOARD_ITEM* item : pnsCommit.removedItems )
1496 view->Hide( item,
false );
1518 points->AddPoint(
m_origin + centerlineOffset );
1519 points->AddPoint(
m_end + centerlineOffsetEnd );
1524 base.
A += centerlineOffset;
1525 base.
B += centerlineOffset;
1535 VECTOR2I widthHandleOffset = ( base.
B - base.
A ).Perpendicular().
Resize( amplitude );
1537 points->AddPoint( base.
A + widthHandleOffset );
1538 points->Point( 2 ).SetGridConstraint(
IGNORE_GRID );
1543 points->AddPoint( base.
A + spacingHandleOffset );
1544 points->Point( 3 ).SetGridConstraint(
IGNORE_GRID );
1565 base.
A += centerlineOffset;
1566 base.
B += centerlineOffset;
1568 m_origin = aEditPoints->Point( 0 ).GetPosition() - centerlineOffset;
1569 m_end = aEditPoints->Point( 1 ).GetPosition() - centerlineOffsetEnd;
1571 if( aEditPoints->Point( 2 ).IsActive() )
1573 VECTOR2I wHandle = aEditPoints->Point( 2 ).GetPosition();
1584 int side = base.
Side( wHandle );
1592 if( aEditPoints->Point( 3 ).IsActive() )
1594 VECTOR2I wHandle = aEditPoints->Point( 2 ).GetPosition();
1595 VECTOR2I sHandle = aEditPoints->Point( 3 ).GetPosition();
1620 base.
A += centerlineOffset;
1621 base.
B += centerlineOffset;
1631 VECTOR2I widthHandleOffset = ( base.
B - base.
A ).Perpendicular().
Resize( amplitude );
1633 aEditPoints->Point( 0 ).SetPosition(
m_origin + centerlineOffset );
1634 aEditPoints->Point( 1 ).SetPosition(
m_end + centerlineOffsetEnd );
1636 aEditPoints->Point( 2 ).SetPosition( base.
A + widthHandleOffset );
1641 aEditPoints->Point( 3 ).SetPosition( base.
A + spacingHandleOffset );
1652 int minAllowedAmplitude = 0;
1662 minAllowedAmplitude = baselineOffset +
correction;
1665 clampedMaxAmplitude = std::max( clampedMaxAmplitude, minAllowedAmplitude );
1716 if( clCoupled.
OffsetLine( amplitude, CORNER_STRATEGY::ROUND_ALL_CORNERS,
1763 CORNER_STRATEGY::ROUND_ALL_CORNERS,
ARC_LOW_DEF,
false );
1794 for(
int i = 0; i <
m_baseLine->SegmentCount(); i++ )
1868 wxString tuningMode;
1869 aProps.
get_to(
"tuning_mode", tuningMode );
1873 aProps.
get_to(
"initial_side", side );
1877 aProps.
get_to(
"last_status", status );
1885 bool rounded =
false;
1886 aProps.
get_to(
"rounded", rounded );
1891 aProps.
get_to_iu(
"target_length", val );
1894 if( aProps.
get_to_iu(
"target_length_min", val ) )
1897 if( aProps.
get_to_iu(
"target_length_max", val ) )
1902 aProps.
get_to_iu(
"target_skew", int_val );
1905 if( aProps.
get_to_iu(
"target_skew_min", int_val ) )
1908 if( aProps.
get_to_iu(
"target_skew_max", int_val ) )
1947 if( dlg.ShowModal() == wxID_OK )
1963 bool aStatusItemsOnly )
1965 std::vector<EDA_ITEM*> previewItems;
1970 if( !aStatusItemsOnly )
1998 statusItem->
SetCurrent( (
double) placer->TuningResult(),
_(
"current skew" ) );
2000 statusItem->
SetCurrent( (
double) placer->TuningResult(),
_(
"current length" ) );
2003 previewItems.push_back( statusItem );
2006 return previewItems;
2011 std::vector<MSG_PANEL_ITEM>& aList )
2020 bool mixedWidth =
false;
2030 primaryItem = track;
2031 primaryNet = track->GetNet();
2033 else if( !coupledNet && track->GetNet() != primaryNet )
2035 coupledItem = track;
2036 coupledNet = track->GetNet();
2040 netclass = track->GetEffectiveNetClass();
2043 width = track->GetWidth();
2044 else if( width != track->GetWidth() )
2055 else if( primaryNet )
2065 if( width && !mixedWidth )
2073 if( board && primaryItem && primaryItem->
GetNetCode() > 0 )
2079 std::tie( count, trackLen, lenPadToDie ) = board->
GetTrackLength( *primaryItem );
2081 if( coupledItem && coupledItem->
GetNetCode() > 0 )
2084 std::tie( count, coupledLen, lenPadToDie ) = board->
GetTrackLength( *coupledItem );
2095 if( lenPadToDie != 0 )
2098 aList.emplace_back(
_(
"Pad To Die Length" ), msg );
2101 aList.emplace_back(
_(
"Full Length" ), msg );
2113 aList.emplace_back( wxString::Format(
_(
"Target Skew: %s" ), msg ),
2114 wxString::Format(
_(
"(from tuning pattern properties)" ) ) );
2120 if( !msg.IsEmpty() )
2122 aList.emplace_back( wxString::Format(
_(
"Skew Constraints: %s" ), msg ),
2123 wxString::Format(
_(
"(from %s)" ), constraint.
GetName() ) );
2135 aList.emplace_back( wxString::Format(
_(
"Target Length: %s" ), msg ),
2136 wxString::Format(
_(
"(from tuning pattern properties)" ) ) );
2142 if( !msg.IsEmpty() )
2144 aList.emplace_back( wxString::Format(
_(
"Length Constraints: %s" ), msg ),
2145 wxString::Format(
_(
"(from %s)" ), constraint.
GetName() ) );
2159#define HITTEST_THRESHOLD_PIXELS 5
2202 auto updateHoverStatus =
2205 std::unique_ptr<PCB_TUNING_PATTERN> dummyPattern;
2217 dummyPattern->EditStart( generatorTool,
m_board,
nullptr );
2218 dummyPattern->Update( generatorTool,
m_board,
nullptr );
2222 for(
EDA_ITEM* item : dummyPattern->GetPreviewItems( generatorTool,
m_frame ) )
2236 auto updateTuningPattern =
2264 if( evt->IsCancelInteractive() || evt->IsActivate()
2278 else if( evt->IsMotion() )
2288 guide.SetIncludeSecondary(
false );
2290 guide.SetIncludeSecondary(
true );
2301 double min_dist_sq = std::numeric_limits<double>::max();
2303 for(
EDA_ITEM* candidate : collector )
2309 candidatePos =
static_cast<PCB_TRACK*
>( candidate )->GetCenter();
2311 else if( candidate->Type() ==
PCB_ARC_T )
2313 candidatePos =
static_cast<PCB_ARC*
>( candidate )->GetMid();
2316 double dist_sq = ( cursorPos - candidatePos ).SquaredEuclideanNorm();
2318 if( dist_sq < min_dist_sq )
2320 min_dist_sq = dist_sq;
2326 updateHoverStatus();
2333 updateTuningPattern();
2336 else if( evt->IsClick(
BUT_LEFT ) )
2345 "tuning patterns." ) );
2356 int dummyClearance = std::numeric_limits<int>::max() / 2;
2362 &dummyDist, &closestPt ) )
2381 item->SetSelected();
2400 updateTuningPattern();
2416 updateTuningPattern();
2441 if( dlg.ShowModal() == wxID_OK )
2442 updateTuningPattern();
2457 evt->SetPassEvent();
2488 .Map( LENGTH_TUNING_MODE::SINGLE,
_HKI(
"Single track" ) )
2489 .Map( LENGTH_TUNING_MODE::DIFF_PAIR,
_HKI(
"Differential pair" ) )
2490 .Map( LENGTH_TUNING_MODE::DIFF_PAIR_SKEW,
_HKI(
"Diff pair skew" ) );
2504 const wxString groupTab =
_HKI(
"Pattern Properties" );
2519 _HKI(
"Tuning Mode" ),
2525 _HKI(
"Min Amplitude" ),
2532 _HKI(
"Max Amplitude" ),
2539 _HKI(
"Initial Side" ),
2551 _HKI(
"Corner Radius %" ),
2569 return !isSkew( aItem );
2573 _HKI(
"Target Length" ),
2590 _HKI(
"Override Custom Rules" ),
2596 _HKI(
"Single-sided" ),
2614template <typename T>
constexpr EDA_IU_SCALE pcbIUScale
constexpr int ARC_LOW_DEF
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
virtual void Revert() override
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
NETINFO_ITEM * GetNet() const
Return #NET_INFO object for a given item.
Container for design settings for a BOARD object.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
int GetDRCEpsilon() const
PNS::MEANDER_SETTINGS m_DiffPairMeanderSettings
PNS::MEANDER_SETTINGS m_SingleTrackMeanderSettings
PNS::MEANDER_SETTINGS m_SkewMeanderSettings
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.
PCB_GROUP * GetParentGroup() const
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 const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
virtual wxString layerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
Information pertinent to a Pcbnew printed circuit board.
NETINFO_ITEM * DpCoupledNet(const NETINFO_ITEM *aNet)
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
const TRACKS & Tracks() const
std::tuple< int, double, double > GetTrackLength(const PCB_TRACK &aTrack) const
Return data on the length and number of track segments connected to a given track.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
bool Intersects(const BOX2< Vec > &aRect) 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.
int GetCount() const
Return the number of objects in the list.
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been removed.
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.
const MINOPTMAX< int > & GetValue() const
void ShowInfoBarWarning(const wxString &aWarningMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left ...
The base class for create windows for drawing purpose.
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 const VECTOR2I GetFocusPosition() const
Similar to GetPosition, but allows items to return their visual center rather than their anchor.
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)
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_FLAGS GetFlags() const
static const int POINT_SIZE
static ENUM_MAP< T > & Instance()
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
A general implementation of a COLLECTORS_GUIDE.
Used when the right click button is pressed, or when the select tool is in effect.
void Collect(BOARD_ITEM *aItem, const std::vector< KICAD_T > &aScanList, const VECTOR2I &aRefPos, const COLLECTORS_GUIDE &aGuide)
Scan a BOARD_ITEM using this class's Inspector method, which does the collection.
A factory which returns an instance of a PCB_GENERATOR.
void Register(const wxString &aTypeStr, const wxString &aName, std::function< PCB_GENERATOR *(void)> aCreateFunc)
Associate a type string to display name and create function.
static GENERATORS_MGR & Instance()
Class that other classes need to inherit from, in order to be inspectable.
FONT is an abstract base class for both outline and stroke fonts.
void Draw(KIGFX::GAL *aGal, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aCursor, const TEXT_ATTRIBUTES &aAttributes, const METRICS &aFontMetrics) const
Draw a string.
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false, const std::vector< wxString > *aEmbeddedFiles=nullptr)
static const METRICS & Default()
A color representation with 4 components: red, green, blue, alpha.
COLOR4D WithAlpha(double aAlpha) const
Return a color with the same color, but the given alpha.
void ToHSL(double &aOutHue, double &aOutSaturation, double &aOutLightness) const
Converts current color (stored in RGB) to HSL format.
Abstract interface for drawing on a 2D-surface.
virtual void SetIsFill(bool aIsFillEnabled)
Enable/disable fill.
virtual void DrawRectangle(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)
Draw a rectangle.
virtual void SetFillColor(const COLOR4D &aColor)
Set the fill color.
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
virtual void Restore()
Restore the context.
virtual void SetLineWidth(float aLineWidth)
Set the line width.
virtual void SetStrokeColor(const COLOR4D &aColor)
Set the stroke color.
virtual void SetIsStroke(bool aIsStrokeEnabled)
Enable/disable stroked outlines.
virtual void Scale(const VECTOR2D &aScale)
Scale the context.
virtual void Save()
Save the context.
A KIGFX::PREVIEW::DRAW_CONTEXT is a wrapper around a GAL and some other settings that makes it easy t...
void DrawLineDashed(const VECTOR2I &aStart, const VECTOR2I &aEn, int aDashStep, int aDashFill, bool aDeEmphasised)
Draw a dashed line on the current layer.
An interface for classes handling user events controlling the view behavior such as zooming,...
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 VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Return the current mouse pointer position.
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
void FreeItems()
Free all the items that were added to the group.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
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 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...
GAL * GetGAL() const
Return the #GAL this view is using to draw graphical primitives.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
void Hide(VIEW_ITEM *aItem, bool aHide=true, bool aHideOverlay=false)
Temporarily hide the item in the view (e.g.
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
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 TOOL_ACTION properties
Activation of the edit tool.
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION spacingDecrease
static TOOL_ACTION amplIncrease
static TOOL_ACTION amplDecrease
static TOOL_ACTION lengthTunerSettings
static TOOL_ACTION spacingIncrease
const VECTOR2I & GetMid() const
Common, abstract interface for edit frames.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide()
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
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.
virtual void SetProperties(const STRING_ANY_MAP &aProps)
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
bool AddItem(BOARD_ITEM *aItem) override
Add item to group.
void SetPosition(const VECTOR2I &aPos) override
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
VECTOR2I GetPosition() const override
virtual std::vector< std::pair< wxString, wxVariant > > GetRowData()
virtual const STRING_ANY_MAP GetProperties() const
std::unordered_set< BOARD_ITEM * > m_items
std::unordered_set< BOARD_ITEM * > & GetItems()
void Move(const VECTOR2I &aMoveVector) override
Move this object.
const VECTOR2I & GetStart() const
const VECTOR2I & GetEnd() const
virtual int GetWidth() const
void SetTargetSkew(int aValue)
const STRING_ANY_MAP GetProperties() const override
bool HitTest(const BOX2I &aRect, bool aContained, int aAccuracy) const override
Test if aRect intersects this item.
void SetEnd(const VECTOR2I &aValue)
void SetMinAmplitude(int aValue)
void SetSpacing(int aValue)
bool initBaseLines(PNS::ROUTER *aRouter, int aLayer, BOARD *aBoard)
wxString GetGeneratorType() const override
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
static const wxString DISPLAY_NAME
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
PNS::ROUTER_MODE GetPNSMode()
PCB_TUNING_PATTERN(BOARD_ITEM *aParent=nullptr, PCB_LAYER_ID aLayer=F_Cu, LENGTH_TUNING_MODE aMode=LENGTH_TUNING_MODE::SINGLE)
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
void swapData(BOARD_ITEM *aImage) override
bool recoverBaseline(PNS::ROUTER *aRouter)
void EditRevert(GENERATOR_TOOL *aTool, BOARD *aBoard, BOARD_COMMIT *aCommit) override
PNS::MEANDER_SIDE GetInitialSide() const
const VECTOR2I & GetEnd() const
bool UpdateEditPoints(std::shared_ptr< EDIT_POINTS > aEditPoints) override
void SetInitialSide(PNS::MEANDER_SIDE aValue)
wxString GetFriendlyName() const override
LENGTH_TUNING_MODE GetTuningMode() const
void Move(const VECTOR2I &aMoveVector) override
Move this object.
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
std::vector< EDA_ITEM * > GetPreviewItems(GENERATOR_TOOL *aTool, PCB_BASE_EDIT_FRAME *aFrame, bool aStatusItemsOnly=false) override
int GetMinAmplitude() const
void EditStart(GENERATOR_TOOL *aTool, BOARD *aBoard, BOARD_COMMIT *aCommit) override
bool resetToBaseline(GENERATOR_TOOL *aTool, int aLayer, SHAPE_LINE_CHAIN &aBaseLine, bool aPrimary)
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
void SetOverrideCustomRules(bool aOverride)
void SetRounded(bool aFlag)
LENGTH_TUNING_MODE m_tuningMode
std::vector< std::pair< wxString, wxVariant > > GetRowData() override
static const wxString GENERATOR_TYPE
void SetCornerRadiusPercentage(int aValue)
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
PNS::MEANDER_PLACER_BASE::TUNING_STATUS m_tuningStatus
bool UpdateFromEditPoints(std::shared_ptr< EDIT_POINTS > aEditPoints, BOARD_COMMIT *aCommit) override
std::optional< SHAPE_LINE_CHAIN > m_baseLineCoupled
void SetProperties(const STRING_ANY_MAP &aProps) override
bool removeToBaseline(PNS::ROUTER *aRouter, int aLayer, SHAPE_LINE_CHAIN &aBaseLine)
wxString GetPluralName() const override
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override final
Draw the parts of the object belonging to layer aLayer.
void Remove(GENERATOR_TOOL *aTool, BOARD *aBoard, BOARD_COMMIT *aCommit) override
std::optional< SHAPE_LINE_CHAIN > m_baseLine
int GetMaxAmplitude() const
PNS::MEANDER_SETTINGS m_settings
void ShowPropertiesDialog(PCB_BASE_EDIT_FRAME *aEditFrame) override
bool Update(GENERATOR_TOOL *aTool, BOARD *aBoard, BOARD_COMMIT *aCommit) override
bool GetOverrideCustomRules() const
void SetMaxAmplitude(int aValue)
void EditPush(GENERATOR_TOOL *aTool, BOARD *aBoard, BOARD_COMMIT *aCommit, const wxString &aCommitMsg=wxEmptyString, int aCommitFlags=0) override
PNS::MEANDER_SETTINGS & GetSettings()
void SetSingleSided(bool aValue)
bool initBaseLine(PNS::ROUTER *aRouter, int aLayer, BOARD *aBoard, VECTOR2I &aStart, VECTOR2I &aEnd, NETINFO_ITEM *aNet, std::optional< SHAPE_LINE_CHAIN > &aBaseLine)
std::optional< int > GetTargetLength() const
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
int GetCornerRadiusPercentage() const
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
SHAPE_LINE_CHAIN getOutline() const
void SetTargetLength(std::optional< int > aValue)
bool IsSingleSided() const
static PCB_TUNING_PATTERN * CreateNew(GENERATOR_TOOL *aTool, PCB_BASE_EDIT_FRAME *aFrame, BOARD_CONNECTED_ITEM *aStartItem, LENGTH_TUNING_MODE aMode)
bool MakeEditPoints(std::shared_ptr< EDIT_POINTS > points) const override
int GetTargetSkew() const
Differential Pair length-matching/meandering tool.
std::vector< ITEM * > & Items()
Base class for PNS router board items.
virtual NET_HANDLE Net() const
void SetNet(NET_HANDLE aNet)
void SetLayer(int aLayer)
void SetParent(BOARD_ITEM *aParent)
bool OfKind(int aKindMask) const
virtual VECTOR2I Anchor(int n) const
Represents a track on a PCB, connecting two non-trivial joints (that is, vias, pads,...
const SHAPE_LINE_CHAIN & CLine() const
SHAPE_LINE_CHAIN & Line()
void SetWidth(int aWidth)
Return line width.
virtual int Width() const
bool ContainsLink(const LINKED_ITEM *aItem) const
std::vector< LINKED_ITEM * > & Links()
Base class for Single trace & Differential pair meandering tools, as both of them share a lot of code...
virtual void UpdateSettings(const MEANDER_SETTINGS &aSettings)
TUNING_STATUS
< Result of the length tuning operation
virtual void SpacingStep(int aSign)
Increase/decrease the current meandering spacing by one step.
virtual TUNING_STATUS TuningStatus() const =0
Return the tuning status (too short, too long, etc.) of the trace(s) being tuned.
virtual const MEANDER_SETTINGS & MeanderSettings() const
Return the current meandering configuration.
virtual long long int TuningResult() const =0
Return the resultant length or skew of the tuned traces.
virtual void AmplitudeStep(int aSign)
Increase/decreases the current meandering amplitude by one step.
Dimensions for the meandering algorithm.
int m_minAmplitude
Maximum meandering amplitude.
void SetTargetLength(long long int aOpt)
static const long long int LENGTH_UNCONSTRAINED
int m_cornerRadiusPercentage
Place meanders on one side.
MEANDER_SIDE m_initialSide
Allowable tuning error.
bool m_singleSided
Initial side when placing meanders at segment.
MINOPTMAX< long long int > m_targetLength
Target skew value for diff pair de-skewing.
void SetTargetSkew(int aOpt)
MINOPTMAX< int > m_targetSkew
MEANDER_STYLE m_cornerStyle
Rounding percentage (0 - 100).
int m_maxAmplitude
Meandering period/spacing (see dialog picture for explanation).
bool m_overrideCustomRules
Type of corners for the meandered line.
int m_spacing
Amplitude/spacing adjustment step.
Keep the router "world" - i.e.
NODE * Branch()
Create a lightweight copy (called branch) of self that tracks the changes (added/removed items) wrs t...
bool Add(std::unique_ptr< SEGMENT > aSegment, bool aAllowRedundant=false)
Add an item to the current node.
std::set< OBSTACLE > OBSTACLES
int QueryColliding(const ITEM *aItem, OBSTACLES &aObstacles, const COLLISION_SEARCH_OPTIONS &aOpts=COLLISION_SEARCH_OPTIONS()) const
Find items colliding (closer than clearance) with the item aItem.
void Remove(ARC *aArc)
Remove an item from this branch.
const LINE AssembleLine(LINKED_ITEM *aSeg, int *aOriginSegmentIndex=nullptr, bool aStopAtLockedJoints=false, bool aFollowLockedSegments=false)
Follow the joint map to assemble a line connecting two non-trivial joints starting from segment aSeg.
virtual void RemoveItem(ITEM *aItem)=0
virtual void AddItem(ITEM *aItem)=0
void SetMode(ROUTER_MODE aMode)
PLACEMENT_ALGO * Placer()
ROUTER_IFACE * GetInterface() const
const ITEM_SET QueryHoverItems(const VECTOR2I &aP, int aSlopRadius=0)
RULE_RESOLVER * GetRuleResolver() const
bool RoutingInProgress() const
bool StartRouting(const VECTOR2I &aP, ITEM *aItem, int aLayer)
bool FixRoute(const VECTOR2I &aP, ITEM *aItem, bool aForceFinish, bool aForceCommit)
bool Move(const VECTOR2I &aP, ITEM *aItem)
virtual int Clearance(const ITEM *aA, const ITEM *aB, bool aUseClearanceEpsilon=true)=0
const SHAPE_LINE_CHAIN CLine() const
const SHAPE * Shape() const override
Return the geometrical shape of the item.
void SetShape(SHAPE *shape)
void SetStartLayer(int aLayer)
void DisplayItem(const PNS::ITEM *aItem, int aClearance, bool aEdit=false, int aFlags=0) override
void EraseView() override
wxString GetNetName(PNS::NET_HANDLE aNet) const override
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
Provide class metadata.Helper macro to map type hashes to names.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
void AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
RAII class that sets an value at construction and resets it to the original value at destruction.
int LineDistance(const VECTOR2I &aP, bool aDetermineSide=false) const
Return the closest Euclidean distance between point aP and the line defined by the ends of segment (t...
VECTOR2I::extended_type ecoord
const VECTOR2I NearestPoint(const VECTOR2I &aP) const
Compute a point on the segment (this) that is closest to point aP.
int Side(const VECTOR2I &aP) const
Determine on which side of directed line passing via segment ends point aP lies.
virtual void Add(EDA_ITEM *aItem)
virtual void Clear() override
Remove all the stored items from the group.
const VECTOR2I & GetArcMid() const
VECTOR2I NearestPoint(const VECTOR2I &aP) const
bool PointOnEdge(const VECTOR2I &aP, int aAccuracy=0) const
Check if point aP lies on an edge or vertex of the line chain.
bool PointInside(const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const override
Check if point aP lies inside a closed shape.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
const SHAPE_LINE_CHAIN Reverse() const
Reverse point order in the line chain.
int Split(const VECTOR2I &aP, bool aExact=false)
Insert the point aP belonging to one of the our segments, splitting the adjacent segment in two.
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
void Simplify(int aMaxError=0)
Simplify the line chain by removing colinear adjacent segments and duplicate vertices.
virtual bool Collide(const VECTOR2I &aP, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if point aP lies closer to us than aClearance.
SEG Segment(int aIndex) const
Return a copy of the aIndex-th segment in the line chain.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
const VECTOR2I NearestPoint(const VECTOR2I &aP, bool aAllowInternalShapePoints=true) const
Find a point on the line chain that is closest to point aP.
int SegmentCount() const
Return the number of segments in this line chain.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
SHAPE * Clone() const override
Return a dynamically allocated copy of the shape.
bool OffsetLine(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, SHAPE_LINE_CHAIN &aLeft, SHAPE_LINE_CHAIN &aRight, bool aSimplify=false) const
Creates line chains aLeft and aRight offset to this line chain.
Represent a set of closed polygons.
void BooleanAdd(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset union For aFastMode meaning, see function booleanOp.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
void OffsetLineChain(const SHAPE_LINE_CHAIN &aLine, int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify)
Perform offsetting of a line chain.
int OutlineCount() const
Return the number of outlines in the set.
virtual VECTOR2I Centre() const
Compute a center-of-mass of the shape.
A name/value tuple with unique names and wxAny values.
void set_iu(const std::string &aKey, const T &aVar)
bool get_to(const std::string &aKey, T &aVar) const
std::optional< T > get_opt(const std::string &aKey) const
void set(const std::string &aKey, const T &aVar)
bool get_to_iu(const std::string &aKey, T &aVar) const
GR_TEXT_H_ALIGN_T m_Halign
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
wxString GetClass() const override
Return the class name.
VECTOR2I GetPosition() const override
void SetMinMax(double aMin, double aMax)
void ViewDraw(int aLayer, KIGFX::VIEW *aView) const override
Draw the parts of the object belonging to layer aLayer.
void SetCurrent(double aCurrent, const wxString &aLabel)
TUNING_STATUS_VIEW_ITEM(PCB_BASE_EDIT_FRAME *aFrame)
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
void SetPosition(const VECTOR2I &aPos) override
wxString MessageTextFromMinOptMax(const MINOPTMAX< int > &aValue) const
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
static constexpr extended_type ECOORD_MAX
VECTOR2< T > Resize(T aNewLength) const
Return a vector of the same direction, but length specified in aNewLength.
static bool empty(const wxTextEntryBase *aCtrl)
#define IS_NEW
New item, just created.
#define IN_EDIT
Item currently edited.
static FILENAME_RESOLVER * resolver
@ LAYER_ANCHOR
anchor of items having an anchor point (texts, footprints)
PCB_LAYER_ID
A quick note on layer IDs:
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
KICOMMON_API wxString MessageTextFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
A helper to convert the double length aValue to a string in inches, millimeters, or unscaled units.
TEXT_DIMS GetConstantGlyphHeight(KIGFX::GAL *aGal, int aRelativeSize=0)
Set the GAL glyph height to a constant scaled value, so that it always looks the same on screen.
Push and Shove diff pair dimensions (gap) settings dialog.
@ PNS_MODE_TUNE_DIFF_PAIR
@ PNS_MODE_TUNE_DIFF_PAIR_SKEW
Class to handle a set of BOARD_ITEMs.
static PNS::MEANDER_SIDE sideFromString(const std::string &aStr)
static LENGTH_TUNING_MODE tuningFromString(const std::string &aStr)
static std::string tuningToString(const LENGTH_TUNING_MODE aTuning)
static struct PCB_TUNING_PATTERN_DESC _PCB_TUNING_PATTERN_DESC
static LENGTH_TUNING_MODE fromPNSMode(PNS::ROUTER_MODE aRouterMode)
static PNS::MEANDER_PLACER_BASE::TUNING_STATUS statusFromString(const std::string &aStr)
static std::string sideToString(const PNS::MEANDER_SIDE aValue)
static std::string statusToString(const PNS::MEANDER_PLACER_BASE::TUNING_STATUS aStatus)
static GENERATORS_MGR::REGISTER< PCB_TUNING_PATTERN > registerMe
static PNS::LINKED_ITEM * pickSegment(PNS::ROUTER *aRouter, const VECTOR2I &aWhere, int aLayer, VECTOR2I &aPointOut, const SHAPE_LINE_CHAIN &aBaseline=SHAPE_LINE_CHAIN())
static std::optional< PNS::LINE > getPNSLine(const VECTOR2I &aStart, const VECTOR2I &aEnd, PNS::ROUTER *router, int layer, VECTOR2I &aStartOut, VECTOR2I &aEndOut)
static VECTOR2I snapToNearestTrack(const VECTOR2I &aP, BOARD *aBoard, NETINFO_ITEM *aNet, PCB_TRACK **aNearestTrack)
static REGISTER_LEGACY_TUNING_PATTERN< PCB_TUNING_PATTERN > registerMeToo
#define NO_SETTER(owner, type)
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
constexpr double correction
std::vector< FAB_LAYER_COLOR > dummy
wxString UnescapeString(const wxString &aSource)
constexpr int mmToIU(double mm) const
PCB_TUNING_PATTERN_DESC()
bool m_useClearanceEpsilon
An abstract function object, returning a design rule (clearance, diff pair gap, etc) required between...
Hold an object colliding with another object, along with some useful data about the collision.
REGISTER_LEGACY_TUNING_PATTERN()
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
double DEG2RAD(double deg)
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
@ NOT_USED
the 3d code uses this value
@ 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)
constexpr ret_type KiROUND(fp_type v, bool aQuiet=false)
Round a floating point number to an integer using "round halfway cases away from zero".
VECTOR2< int32_t > VECTOR2I