/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2023 Alex Shvartzkop * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include enum LENGTH_TUNING_MODE { SINGLE, DIFF_PAIR, DIFF_PAIR_SKEW }; class TUNING_STATUS_VIEW_ITEM : public EDA_ITEM { public: TUNING_STATUS_VIEW_ITEM( PCB_BASE_EDIT_FRAME* aFrame ) : EDA_ITEM( NOT_USED ), // Never added to anything - just a preview m_frame( aFrame ), m_min( 0.0 ), m_max( 0.0 ), m_current( 0.0 ) { } wxString GetClass() const override { return wxT( "TUNING_STATUS" ); } #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override {} #endif VECTOR2I GetPosition() const override { return m_pos; } void SetPosition( const VECTOR2I& aPos ) override { m_pos = aPos; }; void SetMinMax( double aMin, double aMax ) { m_min = aMin; m_minText = m_frame->MessageTextFromValue( m_min, false ); m_max = aMax; m_maxText = m_frame->MessageTextFromValue( m_max, false ); } void ClearMinMax() { m_min = 0.0; m_minText = wxT( "---" ); m_max = std::numeric_limits::max(); m_maxText = wxT( "---" ); } void SetCurrent( double aCurrent, const wxString& aLabel ) { m_current = aCurrent; m_currentText = m_frame->MessageTextFromValue( aCurrent ); m_currentLabel = aLabel; } const BOX2I ViewBBox() const override { BOX2I tmp; // this is an edit-time artefact; no reason to try and be smart with the bounding box // (besides, we can't tell the text extents without a view to know what the scale is) tmp.SetMaximum(); return tmp; } void ViewGetLayers( int aLayers[], int& aCount ) const override { aLayers[0] = LAYER_UI_START; aLayers[1] = LAYER_UI_START + 1; aCount = 2; } void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override { KIGFX::GAL* gal = aView->GetGAL(); bool viewFlipped = gal->IsFlippedX(); bool drawingDropShadows = ( aLayer == LAYER_UI_START ); gal->Save(); gal->Scale( { 1., 1. } ); KIGFX::PREVIEW::TEXT_DIMS headerDims = KIGFX::PREVIEW::GetConstantGlyphHeight( gal, -2 ); KIGFX::PREVIEW::TEXT_DIMS textDims = KIGFX::PREVIEW::GetConstantGlyphHeight( gal, -1 ); KIFONT::FONT* font = KIFONT::FONT::GetFont(); const KIFONT::METRICS& fontMetrics = KIFONT::METRICS::Default(); TEXT_ATTRIBUTES textAttrs; int glyphWidth = textDims.GlyphSize.x; VECTOR2I margin( KiROUND( glyphWidth * 0.4 ), KiROUND( glyphWidth ) ); VECTOR2I size( glyphWidth * 25 + margin.x * 2, headerDims.GlyphSize.y + textDims.GlyphSize.y ); VECTOR2I offset( margin.x * 2, -( size.y + margin.y * 2 ) ); if( drawingDropShadows ) { gal->SetIsFill( true ); gal->SetIsStroke( true ); gal->SetLineWidth( gal->GetScreenWorldMatrix().GetScale().x * 2 ); gal->SetStrokeColor( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) ); KIGFX::COLOR4D bgColor( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE ) ); gal->SetFillColor( bgColor.WithAlpha( 0.9 ) ); gal->DrawRectangle( GetPosition() + offset - margin, GetPosition() + offset + size + margin ); gal->Restore(); return; } COLOR4D bg = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE ); COLOR4D normal = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ); COLOR4D red; // Choose a red with reasonable contrasting with the background double bg_h, bg_s, bg_l; bg.ToHSL( bg_h, bg_s, bg_l ); red.FromHSL( 0, 1.0, bg_l < 0.5 ? 0.7 : 0.3 ); if( viewFlipped ) textAttrs.m_Halign = GR_TEXT_H_ALIGN_RIGHT; else textAttrs.m_Halign = GR_TEXT_H_ALIGN_LEFT; gal->SetIsFill( false ); gal->SetIsStroke( true ); gal->SetStrokeColor( normal ); textAttrs.m_Halign = GR_TEXT_H_ALIGN_LEFT; // Prevent text flipping when view is flipped if( gal->IsFlippedX() ) { textAttrs.m_Mirrored = true; textAttrs.m_Halign = GR_TEXT_H_ALIGN_RIGHT; } textAttrs.m_Size = headerDims.GlyphSize; textAttrs.m_StrokeWidth = headerDims.StrokeWidth; VECTOR2I textPos = GetPosition() + offset; font->Draw( gal, m_currentLabel, textPos, textAttrs, KIFONT::METRICS::Default() ); textPos.x += glyphWidth * 11 + margin.x; font->Draw( gal, _( "min" ), textPos, textAttrs, fontMetrics ); textPos.x += glyphWidth * 7 + margin.x; font->Draw( gal, _( "max" ), textPos, textAttrs, fontMetrics ); textAttrs.m_Size = textDims.GlyphSize; textAttrs.m_StrokeWidth = textDims.StrokeWidth; textPos = GetPosition() + offset; textPos.y += KiROUND( headerDims.LinePitch * 1.3 ); font->Draw( gal, m_currentText, textPos, textAttrs, KIFONT::METRICS::Default() ); textPos.x += glyphWidth * 11 + margin.x; gal->SetStrokeColor( m_current < m_min ? red : normal ); font->Draw( gal, m_minText, textPos, textAttrs, fontMetrics ); textPos.x += glyphWidth * 7 + margin.x; gal->SetStrokeColor( m_current > m_max ? red : normal ); font->Draw( gal, m_maxText, textPos, textAttrs, fontMetrics ); gal->Restore(); } protected: EDA_DRAW_FRAME* m_frame; VECTOR2I m_pos; double m_min; double m_max; double m_current; wxString m_currentLabel; wxString m_currentText; wxString m_minText; wxString m_maxText; }; class PCB_TUNING_PATTERN : public PCB_GENERATOR { public: static const wxString GENERATOR_TYPE; static const wxString DISPLAY_NAME; PCB_TUNING_PATTERN( BOARD_ITEM* aParent = nullptr, PCB_LAYER_ID aLayer = F_Cu, LENGTH_TUNING_MODE aMode = LENGTH_TUNING_MODE::SINGLE ); wxString GetGeneratorType() const override { return wxS( "tuning_pattern" ); } wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return wxString( _( "Tuning Pattern" ) ); } wxString GetFriendlyName() const override { return wxString( _( "Tuning Pattern" ) ); } wxString GetPluralName() const override { return wxString( _( "Tuning Patterns" ) ); } static PCB_TUNING_PATTERN* CreateNew( GENERATOR_TOOL* aTool, PCB_BASE_EDIT_FRAME* aFrame, BOARD_CONNECTED_ITEM* aStartItem, LENGTH_TUNING_MODE aMode ); void EditStart( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) override; bool Update( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) override; void EditPush( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit, const wxString& aCommitMsg = wxEmptyString, int aCommitFlags = 0 ) override; void EditRevert( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) override; void Remove( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) override; bool MakeEditPoints( std::shared_ptr points ) const override; bool UpdateFromEditPoints( std::shared_ptr aEditPoints, BOARD_COMMIT* aCommit ) override; bool UpdateEditPoints( std::shared_ptr aEditPoints ) override; void Move( const VECTOR2I& aMoveVector ) override { m_origin += aMoveVector; m_end += aMoveVector; if( !this->HasFlag( IN_EDIT ) ) { PCB_GROUP::Move( aMoveVector ); if( m_baseLine ) m_baseLine->Move( aMoveVector ); if( m_baseLineCoupled ) m_baseLineCoupled->Move( aMoveVector ); } } void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override { if( !this->HasFlag( IN_EDIT ) ) { RotatePoint( m_origin, aRotCentre, aAngle ); RotatePoint( m_end, aRotCentre, aAngle ); PCB_GROUP::Rotate( aRotCentre, aAngle ); if( m_baseLine ) m_baseLine->Rotate( aAngle, aRotCentre ); if( m_baseLineCoupled ) m_baseLineCoupled->Rotate( aAngle, aRotCentre ); } } const BOX2I GetBoundingBox() const override { return getOutline().BBox(); } void ViewGetLayers( int aLayers[], int& aCount ) const override { aCount = 0; aLayers[aCount++] = LAYER_ANCHOR; aLayers[aCount++] = GetLayer(); } bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override { return getOutline().Collide( aPosition, aAccuracy ); } bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const override { BOX2I sel = aRect; if ( aAccuracy ) sel.Inflate( aAccuracy ); if( aContained ) return sel.Contains( GetBoundingBox() ); return sel.Intersects( GetBoundingBox() ); } const BOX2I ViewBBox() const override { return GetBoundingBox(); } EDA_ITEM* Clone() const override { return new PCB_TUNING_PATTERN( *this ); } void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override final; const VECTOR2I& GetEnd() const { return m_end; } void SetEnd( const VECTOR2I& aValue ) { m_end = aValue; } int GetEndX() const { return m_end.x; } void SetEndX( int aValue ) { m_end.x = aValue; } int GetEndY() const { return m_end.y; } void SetEndY( int aValue ) { m_end.y = aValue; } LENGTH_TUNING_MODE GetTuningMode() const { return m_tuningMode; } PNS::ROUTER_MODE GetPNSMode() { switch( m_tuningMode ) { case LENGTH_TUNING_MODE::SINGLE: return PNS::PNS_MODE_TUNE_SINGLE; case LENGTH_TUNING_MODE::DIFF_PAIR: return PNS::PNS_MODE_TUNE_DIFF_PAIR; case LENGTH_TUNING_MODE::DIFF_PAIR_SKEW: return PNS::PNS_MODE_TUNE_DIFF_PAIR_SKEW; default: return PNS::PNS_MODE_TUNE_SINGLE; } } PNS::MEANDER_SETTINGS& GetSettings() { return m_settings; } int GetMinAmplitude() const { return m_settings.m_minAmplitude; } void SetMinAmplitude( int aValue ) { aValue = std::max( aValue, 0 ); m_settings.m_minAmplitude = aValue; if( m_settings.m_maxAmplitude < m_settings.m_minAmplitude ) m_settings.m_maxAmplitude = m_settings.m_minAmplitude; } int GetMaxAmplitude() const { return m_settings.m_maxAmplitude; } void SetMaxAmplitude( int aValue ) { aValue = std::max( aValue, 0 ); m_settings.m_maxAmplitude = aValue; if( m_settings.m_maxAmplitude < m_settings.m_minAmplitude ) m_settings.m_minAmplitude = m_settings.m_maxAmplitude; } PNS::MEANDER_SIDE GetInitialSide() const { return m_settings.m_initialSide; } void SetInitialSide( PNS::MEANDER_SIDE aValue ) { m_settings.m_initialSide = aValue; } int GetSpacing() const { return m_settings.m_spacing; } void SetSpacing( int aValue ) { m_settings.m_spacing = aValue; } std::optional GetTargetLength() const { if( m_settings.m_targetLength.Opt() == PNS::MEANDER_SETTINGS::LENGTH_UNCONSTRAINED ) return std::optional(); else return m_settings.m_targetLength.Opt(); } void SetTargetLength( std::optional aValue ) { if( aValue.has_value() ) m_settings.SetTargetLength( aValue.value() ); else m_settings.SetTargetLength( PNS::MEANDER_SETTINGS::LENGTH_UNCONSTRAINED ); } int GetTargetSkew() const { return m_settings.m_targetSkew.Opt(); } void SetTargetSkew( int aValue ) { m_settings.SetTargetSkew( aValue ); } bool GetOverrideCustomRules() const { return m_settings.m_overrideCustomRules; } void SetOverrideCustomRules( bool aOverride ) { m_settings.m_overrideCustomRules = aOverride; } int GetCornerRadiusPercentage() const { return m_settings.m_cornerRadiusPercentage; } void SetCornerRadiusPercentage( int aValue ) { m_settings.m_cornerRadiusPercentage = aValue; } bool IsSingleSided() const { return m_settings.m_singleSided; } void SetSingleSided( bool aValue ) { m_settings.m_singleSided = aValue; } bool IsRounded() const { return m_settings.m_cornerStyle == PNS::MEANDER_STYLE_ROUND; } void SetRounded( bool aFlag ) { m_settings.m_cornerStyle = aFlag ? PNS::MEANDER_STYLE_ROUND : PNS::MEANDER_STYLE_CHAMFER; } std::vector> GetRowData() override { std::vector> data = PCB_GENERATOR::GetRowData(); data.emplace_back( _HKI( "Net" ), m_lastNetName ); data.emplace_back( _HKI( "Tuning" ), m_tuningInfo ); return data; } const STRING_ANY_MAP GetProperties() const override; void SetProperties( const STRING_ANY_MAP& aProps ) override; void ShowPropertiesDialog( PCB_BASE_EDIT_FRAME* aEditFrame ) override; std::vector GetPreviewItems( GENERATOR_TOOL* aTool, PCB_BASE_EDIT_FRAME* aFrame, bool aStatusItemsOnly = false ) override; void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; protected: void swapData( BOARD_ITEM* aImage ) override { wxASSERT( aImage->Type() == PCB_GENERATOR_T ); std::swap( *this, *static_cast( aImage ) ); } bool recoverBaseline( PNS::ROUTER* aRouter ); bool baselineValid(); bool initBaseLine( PNS::ROUTER* aRouter, int aLayer, BOARD* aBoard, VECTOR2I& aStart, VECTOR2I& aEnd, NETINFO_ITEM* aNet, std::optional& aBaseLine ); bool initBaseLines( PNS::ROUTER* aRouter, int aLayer, BOARD* aBoard ); bool removeToBaseline( PNS::ROUTER* aRouter, int aLayer, SHAPE_LINE_CHAIN& aBaseLine ); bool resetToBaseline( GENERATOR_TOOL* aTool, int aLayer, SHAPE_LINE_CHAIN& aBaseLine, bool aPrimary ); SHAPE_LINE_CHAIN getOutline() const; protected: VECTOR2I m_end; PNS::MEANDER_SETTINGS m_settings; std::optional m_baseLine; std::optional m_baseLineCoupled; int m_trackWidth; int m_diffPairGap; LENGTH_TUNING_MODE m_tuningMode; wxString m_lastNetName; wxString m_tuningInfo; PNS::MEANDER_PLACER_BASE::TUNING_STATUS m_tuningStatus; }; static LENGTH_TUNING_MODE tuningFromString( const std::string& aStr ) { if( aStr == "single" ) return LENGTH_TUNING_MODE::SINGLE; else if( aStr == "diff_pair" ) return LENGTH_TUNING_MODE::DIFF_PAIR; else if( aStr == "diff_pair_skew" ) return LENGTH_TUNING_MODE::DIFF_PAIR_SKEW; else { wxFAIL_MSG( wxS( "Unknown length tuning token" ) ); return LENGTH_TUNING_MODE::SINGLE; } } static std::string tuningToString( const LENGTH_TUNING_MODE aTuning ) { switch( aTuning ) { case LENGTH_TUNING_MODE::SINGLE: return "single"; case LENGTH_TUNING_MODE::DIFF_PAIR: return "diff_pair"; case LENGTH_TUNING_MODE::DIFF_PAIR_SKEW: return "diff_pair_skew"; default: wxFAIL; return ""; } } static LENGTH_TUNING_MODE fromPNSMode( PNS::ROUTER_MODE aRouterMode ) { switch( aRouterMode ) { case PNS::PNS_MODE_TUNE_SINGLE: return LENGTH_TUNING_MODE::SINGLE; case PNS::PNS_MODE_TUNE_DIFF_PAIR: return LENGTH_TUNING_MODE::DIFF_PAIR; case PNS::PNS_MODE_TUNE_DIFF_PAIR_SKEW: return LENGTH_TUNING_MODE::DIFF_PAIR_SKEW; default: return LENGTH_TUNING_MODE::SINGLE; } } static PNS::MEANDER_SIDE sideFromString( const std::string& aStr ) { if( aStr == "default" ) return PNS::MEANDER_SIDE_DEFAULT; else if( aStr == "left" ) return PNS::MEANDER_SIDE_LEFT; else if( aStr == "right" ) return PNS::MEANDER_SIDE_RIGHT; else { wxFAIL_MSG( wxS( "Unknown length-tuning side token" ) ); return PNS::MEANDER_SIDE_DEFAULT; } } static std::string statusToString( const PNS::MEANDER_PLACER_BASE::TUNING_STATUS aStatus ) { switch( aStatus ) { case PNS::MEANDER_PLACER_BASE::TOO_LONG: return "too_long"; case PNS::MEANDER_PLACER_BASE::TOO_SHORT: return "too_short"; case PNS::MEANDER_PLACER_BASE::TUNED: return "tuned"; default: wxFAIL; return ""; } } static PNS::MEANDER_PLACER_BASE::TUNING_STATUS statusFromString( const std::string& aStr ) { if( aStr == "too_long" ) return PNS::MEANDER_PLACER_BASE::TOO_LONG; else if( aStr == "too_short" ) return PNS::MEANDER_PLACER_BASE::TOO_SHORT; else if( aStr == "tuned" ) return PNS::MEANDER_PLACER_BASE::TUNED; else { wxFAIL_MSG( wxS( "Unknown tuning status token" ) ); return PNS::MEANDER_PLACER_BASE::TUNED; } } static std::string sideToString( const PNS::MEANDER_SIDE aValue ) { switch( aValue ) { case PNS::MEANDER_SIDE_DEFAULT: return "default"; case PNS::MEANDER_SIDE_LEFT: return "left"; case PNS::MEANDER_SIDE_RIGHT: return "right"; default: wxFAIL; return ""; } } PCB_TUNING_PATTERN::PCB_TUNING_PATTERN( BOARD_ITEM* aParent, PCB_LAYER_ID aLayer, LENGTH_TUNING_MODE aMode ) : PCB_GENERATOR( aParent, aLayer ), m_trackWidth( 0 ), m_diffPairGap( 0 ), m_tuningMode( aMode ), m_tuningStatus( PNS::MEANDER_PLACER_BASE::TUNING_STATUS::TUNED ) { m_generatorType = GENERATOR_TYPE; m_name = DISPLAY_NAME; m_end = VECTOR2I( pcbIUScale.mmToIU( 10 ), 0 ); m_settings.m_initialSide = PNS::MEANDER_SIDE_LEFT; } static VECTOR2I snapToNearestTrack( const VECTOR2I& aP, BOARD* aBoard, NETINFO_ITEM* aNet, PCB_TRACK** aNearestTrack ) { SEG::ecoord minDist_sq = VECTOR2I::ECOORD_MAX; VECTOR2I closestPt = aP; for( PCB_TRACK *track : aBoard->Tracks() ) { if( aNet && track->GetNet() != aNet ) continue; VECTOR2I nearest; if( track->Type() == PCB_ARC_T ) { PCB_ARC* pcbArc = static_cast( track ); SHAPE_ARC arc( pcbArc->GetStart(), pcbArc->GetMid(), pcbArc->GetEnd(), pcbArc->GetWidth() ); nearest = arc.NearestPoint( aP ); } else { SEG seg( track->GetStart(), track->GetEnd() ); nearest = seg.NearestPoint( aP ); } SEG::ecoord dist_sq = ( nearest - aP ).SquaredEuclideanNorm(); if( dist_sq < minDist_sq ) { minDist_sq = dist_sq; closestPt = nearest; if( aNearestTrack ) *aNearestTrack = track; } } return closestPt; } bool PCB_TUNING_PATTERN::baselineValid() { if( m_tuningMode == DIFF_PAIR || m_tuningMode == DIFF_PAIR_SKEW ) { return( m_baseLine && m_baseLine->PointCount() > 1 && m_baseLineCoupled && m_baseLineCoupled->PointCount() > 1 ); } else { return( m_baseLine && m_baseLine->PointCount() > 1 ); } } PCB_TUNING_PATTERN* PCB_TUNING_PATTERN::CreateNew( GENERATOR_TOOL* aTool, PCB_BASE_EDIT_FRAME* aFrame, BOARD_CONNECTED_ITEM* aStartItem, LENGTH_TUNING_MODE aMode ) { BOARD* board = aStartItem->GetBoard(); BOARD_DESIGN_SETTINGS& bds = board->GetDesignSettings(); DRC_CONSTRAINT constraint; PCB_LAYER_ID layer = aStartItem->GetLayer(); PCB_TUNING_PATTERN* pattern = new PCB_TUNING_PATTERN( board, layer, aMode ); switch( aMode ) { case SINGLE: pattern->m_settings = bds.m_SingleTrackMeanderSettings; break; case DIFF_PAIR: pattern->m_settings = bds.m_DiffPairMeanderSettings; break; case DIFF_PAIR_SKEW: pattern->m_settings = bds.m_SkewMeanderSettings; break; } constraint = bds.m_DRCEngine->EvalRules( LENGTH_CONSTRAINT, aStartItem, nullptr, layer ); if( !constraint.IsNull() ) { if( aMode == DIFF_PAIR_SKEW ) pattern->m_settings.SetTargetSkew( constraint.GetValue() ); else pattern->m_settings.SetTargetLength( constraint.GetValue() ); } pattern->SetFlags( IS_NEW ); return pattern; } void PCB_TUNING_PATTERN::EditStart( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) { if( aCommit ) { if( IsNew() ) aCommit->Add( this ); else aCommit->Modify( this ); } SetFlags( IN_EDIT ); int layer = GetLayer(); PNS::ROUTER* router = aTool->Router(); aTool->ClearRouterChanges(); router->SyncWorld(); PNS::RULE_RESOLVER* resolver = router->GetRuleResolver(); PNS::CONSTRAINT constraint; if( !baselineValid() ) initBaseLines( router, layer, aBoard ); if( !m_settings.m_overrideCustomRules ) { PCB_TRACK* track = nullptr; PNS::SEGMENT pnsItem; m_origin = snapToNearestTrack( m_origin, aBoard, nullptr, &track ); wxCHECK( track, /* void */ ); NETINFO_ITEM* net = track->GetNet(); pnsItem.SetParent( track ); pnsItem.SetNet( net ); if( m_tuningMode == SINGLE ) { if( resolver->QueryConstraint( PNS::CONSTRAINT_TYPE::CT_LENGTH, &pnsItem, nullptr, layer, &constraint ) ) { m_settings.SetTargetLength( constraint.m_Value ); aTool->GetManager()->PostEvent( EVENTS::SelectedItemsModified ); } } else { PCB_TRACK* coupledTrack = nullptr; PNS::SEGMENT pnsCoupledItem; NETINFO_ITEM* coupledNet = aBoard->DpCoupledNet( net ); if( coupledNet ) snapToNearestTrack( m_origin, aBoard, coupledNet, &coupledTrack ); pnsCoupledItem.SetParent( coupledTrack ); pnsCoupledItem.SetNet( coupledNet ); if( m_tuningMode == DIFF_PAIR ) { if( resolver->QueryConstraint( PNS::CONSTRAINT_TYPE::CT_LENGTH, &pnsItem, &pnsCoupledItem, layer, &constraint ) ) { m_settings.SetTargetLength( constraint.m_Value ); aTool->GetManager()->PostEvent( EVENTS::SelectedItemsModified ); } } else { if( resolver->QueryConstraint( PNS::CONSTRAINT_TYPE::CT_DIFF_PAIR_SKEW, &pnsItem, &pnsCoupledItem, layer, &constraint ) ) { m_settings.m_targetSkew = constraint.m_Value; aTool->GetManager()->PostEvent( EVENTS::SelectedItemsModified ); } } } } } static PNS::LINKED_ITEM* pickSegment( PNS::ROUTER* aRouter, const VECTOR2I& aWhere, int aLayer, VECTOR2I& aPointOut, const SHAPE_LINE_CHAIN& aBaseline = SHAPE_LINE_CHAIN() ) { int maxSlopRadius = aRouter->Sizes().Clearance() + aRouter->Sizes().TrackWidth() / 2; static const int candidateCount = 2; PNS::LINKED_ITEM* prioritized[candidateCount]; SEG::ecoord dist[candidateCount]; SEG::ecoord distBaseline[candidateCount]; VECTOR2I point[candidateCount]; for( int i = 0; i < candidateCount; i++ ) { prioritized[i] = nullptr; dist[i] = VECTOR2I::ECOORD_MAX; distBaseline[i] = VECTOR2I::ECOORD_MAX; } for( int slopRadius : { 0, maxSlopRadius } ) { PNS::ITEM_SET candidates = aRouter->QueryHoverItems( aWhere, slopRadius ); for( PNS::ITEM* item : candidates.Items() ) { if( !item->OfKind( PNS::ITEM::SEGMENT_T | PNS::ITEM::ARC_T ) ) continue; if( !item->IsRoutable() ) continue; if( !item->Layers().Overlaps( aLayer ) ) continue; PNS::LINKED_ITEM* linked = static_cast( item ); if( item->Kind() & PNS::ITEM::ARC_T ) { PNS::ARC* pnsArc = static_cast( item ); VECTOR2I nearest = pnsArc->Arc().NearestPoint( aWhere ); SEG::ecoord d0 = ( nearest - aWhere ).SquaredEuclideanNorm(); if( d0 > dist[1] ) continue; if( aBaseline.PointCount() > 0 ) { SEG::ecoord dcBaseline; VECTOR2I target = pnsArc->Arc().GetArcMid(); if( aBaseline.SegmentCount() > 0 ) dcBaseline = aBaseline.SquaredDistance( target ); else dcBaseline = ( aBaseline.CPoint( 0 ) - target ).SquaredEuclideanNorm(); if( dcBaseline > distBaseline[1] ) continue; distBaseline[1] = dcBaseline; } prioritized[1] = linked; dist[1] = d0; point[1] = nearest; } else if( item->Kind() & PNS::ITEM::SEGMENT_T ) { PNS::SEGMENT* segm = static_cast( item ); VECTOR2I nearest = segm->CLine().NearestPoint( aWhere, false ); SEG::ecoord dd = ( aWhere - nearest ).SquaredEuclideanNorm(); if( dd > dist[1] ) continue; if( aBaseline.PointCount() > 0 ) { SEG::ecoord dcBaseline; VECTOR2I target = segm->Shape()->Centre(); if( aBaseline.SegmentCount() > 0 ) dcBaseline = aBaseline.SquaredDistance( target ); else dcBaseline = ( aBaseline.CPoint( 0 ) - target ).SquaredEuclideanNorm(); if( dcBaseline > distBaseline[1] ) continue; distBaseline[1] = dcBaseline; } prioritized[1] = segm; dist[1] = dd; point[1] = nearest; } } } PNS::LINKED_ITEM* rv = nullptr; for( int i = 0; i < candidateCount; i++ ) { PNS::LINKED_ITEM* item = prioritized[i]; if( item && ( aLayer < 0 || item->Layers().Overlaps( aLayer ) ) ) { rv = item; aPointOut = point[i]; break; } } return rv; } static std::optional getPNSLine( const VECTOR2I& aStart, const VECTOR2I& aEnd, PNS::ROUTER* router, int layer, VECTOR2I& aStartOut, VECTOR2I& aEndOut ) { PNS::NODE* world = router->GetWorld(); PNS::LINKED_ITEM* startItem = pickSegment( router, aStart, layer, aStartOut ); PNS::LINKED_ITEM* endItem = pickSegment( router, aEnd, layer, aEndOut ); //wxCHECK( startItem && endItem, std::nullopt ); for( PNS::LINKED_ITEM* testItem : { startItem, endItem } ) { if( !testItem ) continue; PNS::LINE line = world->AssembleLine( testItem, nullptr, false, false ); SHAPE_LINE_CHAIN oldChain = line.CLine(); if( oldChain.PointOnEdge( aStartOut, 1 ) && oldChain.PointOnEdge( aEndOut, 1 ) ) return line; } return std::nullopt; } bool PCB_TUNING_PATTERN::initBaseLine( PNS::ROUTER* aRouter, int aLayer, BOARD* aBoard, VECTOR2I& aStart, VECTOR2I& aEnd, NETINFO_ITEM* aNet, std::optional& aBaseLine ) { PNS::NODE* world = aRouter->GetWorld(); aStart = snapToNearestTrack( aStart, aBoard, aNet, nullptr ); aEnd = snapToNearestTrack( aEnd, aBoard, aNet, nullptr ); VECTOR2I startSnapPoint, endSnapPoint; PNS::LINKED_ITEM* startItem = pickSegment( aRouter, aStart, aLayer, startSnapPoint ); PNS::LINKED_ITEM* endItem = pickSegment( aRouter, aEnd, aLayer, endSnapPoint ); wxASSERT( startItem ); wxASSERT( endItem ); if( !startItem || !endItem ) return false; PNS::LINE line = world->AssembleLine( startItem ); const SHAPE_LINE_CHAIN& chain = line.CLine(); wxASSERT( line.ContainsLink( endItem ) ); wxASSERT( chain.PointOnEdge( startSnapPoint, 40000 ) ); wxASSERT( chain.PointOnEdge( endSnapPoint, 40000 ) ); SHAPE_LINE_CHAIN pre; SHAPE_LINE_CHAIN mid; SHAPE_LINE_CHAIN post; chain.Split( startSnapPoint, endSnapPoint, pre, mid, post ); aBaseLine = mid; return true; } bool PCB_TUNING_PATTERN::initBaseLines( PNS::ROUTER* aRouter, int aLayer, BOARD* aBoard ) { m_baseLineCoupled.reset(); PCB_TRACK* track = nullptr; m_origin = snapToNearestTrack( m_origin, aBoard, nullptr, &track ); wxCHECK( track, false ); NETINFO_ITEM* net = track->GetNet(); if( !initBaseLine( aRouter, aLayer, aBoard, m_origin, m_end, net, m_baseLine ) ) return false; // Generate both baselines even if we're skewing. We need the coupled baseline to run the // DRC rules against. if( m_tuningMode == DIFF_PAIR || m_tuningMode == DIFF_PAIR_SKEW ) { if( NETINFO_ITEM* coupledNet = aBoard->DpCoupledNet( net ) ) { VECTOR2I coupledStart = snapToNearestTrack( m_origin, aBoard, coupledNet, nullptr ); VECTOR2I coupledEnd = snapToNearestTrack( m_end, aBoard, coupledNet, nullptr ); return initBaseLine( aRouter, aLayer, aBoard, coupledStart, coupledEnd, coupledNet, m_baseLineCoupled ); } return false; } return true; } bool PCB_TUNING_PATTERN::removeToBaseline( PNS::ROUTER* aRouter, int aLayer, SHAPE_LINE_CHAIN& aBaseLine ) { VECTOR2I startSnapPoint, endSnapPoint; std::optional pnsLine = getPNSLine( aBaseLine.CPoint( 0 ), aBaseLine.CPoint( -1 ), aRouter, aLayer, startSnapPoint, endSnapPoint ); wxCHECK( pnsLine, false ); SHAPE_LINE_CHAIN pre; SHAPE_LINE_CHAIN mid; SHAPE_LINE_CHAIN post; pnsLine->CLine().Split( startSnapPoint, endSnapPoint, pre, mid, post ); for( PNS::LINKED_ITEM* li : pnsLine->Links() ) aRouter->GetInterface()->RemoveItem( li ); aRouter->GetWorld()->Remove( *pnsLine ); SHAPE_LINE_CHAIN straightChain; straightChain.Append( pre ); straightChain.Append( aBaseLine ); straightChain.Append( post ); straightChain.Simplify(); PNS::LINE straightLine( *pnsLine, straightChain ); aRouter->GetWorld()->Add( straightLine, false ); for( PNS::LINKED_ITEM* li : straightLine.Links() ) aRouter->GetInterface()->AddItem( li ); return true; } void PCB_TUNING_PATTERN::Remove( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) { SetFlags( IN_EDIT ); aTool->Router()->SyncWorld(); PNS::ROUTER* router = aTool->Router(); int layer = GetLayer(); // Ungroup first so that undo works if( !GetItems().empty() ) { PCB_GENERATOR* group = this; for( BOARD_ITEM* member : group->GetItems() ) aCommit->Stage( member, CHT_UNGROUP ); group->GetItems().clear(); } aCommit->Remove( this ); aTool->ClearRouterChanges(); if( baselineValid() ) { bool success = true; success &= removeToBaseline( router, layer, *m_baseLine ); if( m_tuningMode == DIFF_PAIR ) success &= removeToBaseline( router, layer, *m_baseLineCoupled ); if( !success ) recoverBaseline( router ); } const std::vector& allPnsChanges = aTool->GetRouterChanges(); for( const GENERATOR_PNS_CHANGES& pnsChanges : allPnsChanges ) { const std::set routerRemovedItems = pnsChanges.removedItems; const std::set routerAddedItems = pnsChanges.addedItems; /*std::cout << "Push commits << " << allPnsChanges.size() << " routerRemovedItems " << routerRemovedItems.size() << " routerAddedItems " << routerAddedItems.size() << " m_removedItems " << m_removedItems.size() << std::endl;*/ for( BOARD_ITEM* item : routerRemovedItems ) { item->ClearSelected(); aCommit->Remove( item ); } for( BOARD_ITEM* item : routerAddedItems ) aCommit->Add( item ); } aCommit->Push( "Remove Tuning Pattern" ); } bool PCB_TUNING_PATTERN::recoverBaseline( PNS::ROUTER* aRouter ) { PNS::SOLID queryItem; SHAPE_LINE_CHAIN* chain = static_cast( getOutline().Clone() ); queryItem.SetShape( chain ); // PNS::SOLID takes ownership queryItem.SetLayer( m_layer ); int lineWidth = 0; PNS::NODE::OBSTACLES obstacles; PNS::COLLISION_SEARCH_OPTIONS opts; opts.m_useClearanceEpsilon = false; PNS::NODE* world = aRouter->GetWorld(); PNS::NODE* branch = world->Branch(); branch->QueryColliding( &queryItem, obstacles, opts ); for( const PNS::OBSTACLE& obs : obstacles ) { PNS::ITEM* item = obs.m_item; if( !item->OfKind( PNS::ITEM::SEGMENT_T | PNS::ITEM::ARC_T ) ) continue; if( PNS::LINKED_ITEM* li = dynamic_cast( item ) ) { if( lineWidth == 0 || li->Width() < lineWidth ) lineWidth = li->Width(); } if( chain->PointInside( item->Anchor( 0 ), 10 ) && chain->PointInside( item->Anchor( 1 ), 10 ) ) { branch->Remove( item ); } } if( lineWidth == 0 ) lineWidth = pcbIUScale.mmToIU( 0.1 ); // Fallback if( baselineValid() ) { NETINFO_ITEM* recoverNet = GetBoard()->FindNet( m_lastNetName ); PNS::LINE recoverLine; recoverLine.SetLayer( m_layer ); recoverLine.SetWidth( lineWidth ); recoverLine.Line() = *m_baseLine; recoverLine.SetNet( recoverNet ); branch->Add( recoverLine, false ); if( m_tuningMode == DIFF_PAIR || m_tuningMode == DIFF_PAIR_SKEW ) { NETINFO_ITEM* recoverCoupledNet = GetBoard()->DpCoupledNet( recoverNet ); PNS::LINE recoverLineCoupled; recoverLineCoupled.SetLayer( m_layer ); recoverLineCoupled.SetWidth( lineWidth ); recoverLineCoupled.Line() = *m_baseLineCoupled; recoverLineCoupled.SetNet( recoverCoupledNet ); branch->Add( recoverLineCoupled, false ); } } aRouter->CommitRouting( branch ); //wxLogWarning( "PNS baseline recovered" ); return true; } bool PCB_TUNING_PATTERN::resetToBaseline( GENERATOR_TOOL* aTool, int aLayer, SHAPE_LINE_CHAIN& aBaseLine, bool aPrimary ) { PNS_KICAD_IFACE* iface = aTool->GetInterface(); PNS::ROUTER* router = aTool->Router(); PNS::NODE* world = router->GetWorld(); VECTOR2I startSnapPoint, endSnapPoint; std::optional pnsLine = getPNSLine( aBaseLine.CPoint( 0 ), aBaseLine.CPoint( -1 ), router, aLayer, startSnapPoint, endSnapPoint ); if( !pnsLine ) { // TODO //recoverBaseline( aRouter ); return true; } PNS::NODE* branch = world->Branch(); SHAPE_LINE_CHAIN straightChain; { SHAPE_LINE_CHAIN pre, mid, post; pnsLine->CLine().Split( startSnapPoint, endSnapPoint, pre, mid, post ); straightChain.Append( pre ); straightChain.Append( aBaseLine ); straightChain.Append( post ); straightChain.Simplify(); } branch->Remove( *pnsLine ); SHAPE_LINE_CHAIN newLineChain; if( aPrimary ) { m_origin = straightChain.NearestPoint( m_origin ); m_end = straightChain.NearestPoint( m_end ); // Don't allow points too close if( ( m_end - m_origin ).EuclideanNorm() < pcbIUScale.mmToIU( 0.1 ) ) { m_origin = startSnapPoint; m_end = endSnapPoint; } { SHAPE_LINE_CHAIN pre, mid, post; straightChain.Split( m_origin, m_end, pre, mid, post ); newLineChain.Append( pre ); newLineChain.Append( mid ); newLineChain.Append( post ); m_baseLine = mid; } } else { VECTOR2I start = straightChain.NearestPoint( m_origin ); VECTOR2I end = straightChain.NearestPoint( m_end ); { SHAPE_LINE_CHAIN pre, mid, post; straightChain.Split( start, end, pre, mid, post ); newLineChain.Append( pre ); newLineChain.Append( mid ); newLineChain.Append( post ); m_baseLineCoupled = mid; } } PNS::LINE newLine( *pnsLine, newLineChain ); branch->Add( newLine, false ); router->CommitRouting( branch ); int clearance = router->GetRuleResolver()->Clearance( &newLine, nullptr ); iface->DisplayItem( &newLine, clearance, true, PNS_COLLISION ); return true; } bool PCB_TUNING_PATTERN::Update( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) { if( !( GetFlags() & IN_EDIT ) ) return false; KIGFX::VIEW* view = aTool->GetManager()->GetView(); PNS::ROUTER* router = aTool->Router(); PNS_KICAD_IFACE* iface = aTool->GetInterface(); int layer = GetLayer(); auto hideRemovedItems = [&]( bool aHide ) { if( view ) { for( const GENERATOR_PNS_CHANGES& pnsCommit : aTool->GetRouterChanges() ) { for( BOARD_ITEM* item : pnsCommit.removedItems ) { if( view ) view->Hide( item, aHide, aHide ); } } } }; iface->SetStartLayer( layer ); if( router->RoutingInProgress() ) { router->StopRouting(); } if( !baselineValid() ) { initBaseLines( router, layer, aBoard ); } else { if( resetToBaseline( aTool, layer, *m_baseLine, true ) ) { m_origin = m_baseLine->CPoint( 0 ); m_end = m_baseLine->CPoint( -1 ); } else { //initBaseLines( router, layer, aBoard ); return false; } if( m_tuningMode == DIFF_PAIR ) { if( !resetToBaseline( aTool, layer, *m_baseLineCoupled, false ) ) { initBaseLines( router, layer, aBoard ); return false; } } } hideRemovedItems( true ); // Snap points VECTOR2I startSnapPoint, endSnapPoint; wxCHECK( m_baseLine, false ); PNS::LINKED_ITEM* startItem = pickSegment( router, m_origin, layer, startSnapPoint, *m_baseLine); PNS::LINKED_ITEM* endItem = pickSegment( router, m_end, layer, endSnapPoint, *m_baseLine ); wxASSERT( startItem ); wxASSERT( endItem ); if( !startItem || !endItem ) return false; router->SetMode( GetPNSMode() ); if( !router->StartRouting( startSnapPoint, startItem, layer ) ) { //recoverBaseline( router ); return false; } PNS::MEANDER_PLACER_BASE* placer = static_cast( router->Placer() ); m_settings.m_keepEndpoints = true; // Required for re-grouping placer->UpdateSettings( m_settings ); router->Move( m_end, nullptr ); if( PNS::DP_MEANDER_PLACER* dpPlacer = dynamic_cast( placer ) ) { m_trackWidth = dpPlacer->GetOriginPair().Width(); m_diffPairGap = dpPlacer->GetOriginPair().Gap(); } else { m_trackWidth = startItem->Width(); m_diffPairGap = router->Sizes().DiffPairGap(); } m_settings = placer->MeanderSettings(); m_lastNetName = iface->GetNetName( startItem->Net() ); m_tuningStatus = placer->TuningStatus(); wxString statusMessage; switch ( m_tuningStatus ) { case PNS::MEANDER_PLACER_BASE::TOO_LONG: statusMessage = _( "too long" ); break; case PNS::MEANDER_PLACER_BASE::TOO_SHORT: statusMessage = _( "too short" ); break; case PNS::MEANDER_PLACER_BASE::TUNED: statusMessage = _( "tuned" ); break; default: statusMessage = _( "unknown" ); break; } wxString result; EDA_UNITS userUnits = EDA_UNITS::MILLIMETRES; if( aTool->GetManager()->GetSettings() ) userUnits = static_cast( aTool->GetManager()->GetSettings()->m_System.units ); result = EDA_UNIT_UTILS::UI::MessageTextFromValue( pcbIUScale, userUnits, (double) placer->TuningResult() ); m_tuningInfo.Printf( wxS( "%s (%s)" ), result, statusMessage ); return true; } void PCB_TUNING_PATTERN::EditPush( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit, const wxString& aCommitMsg, int aCommitFlags ) { if( !( GetFlags() & IN_EDIT ) ) return; ClearFlags( IN_EDIT ); KIGFX::VIEW* view = aTool->GetManager()->GetView(); PNS::ROUTER* router = aTool->Router(); PNS_KICAD_IFACE* iface = aTool->GetInterface(); SHAPE_LINE_CHAIN bounds = getOutline(); int epsilon = aBoard->GetDesignSettings().GetDRCEpsilon(); iface->EraseView(); if( router->RoutingInProgress() ) { bool forceFinish = true; bool forceCommit = false; router->FixRoute( m_end, nullptr, forceFinish, forceCommit ); router->StopRouting(); } const std::vector& pnsCommits = aTool->GetRouterChanges(); for( const GENERATOR_PNS_CHANGES& pnsCommit : pnsCommits ) { const std::set routerRemovedItems = pnsCommit.removedItems; const std::set routerAddedItems = pnsCommit.addedItems; //std::cout << "Push commits << " << allPnsChanges.size() << " routerRemovedItems " // << routerRemovedItems.size() << " routerAddedItems " << routerAddedItems.size() // << " m_removedItems " << m_removedItems.size() << std::endl; for( BOARD_ITEM* item : routerRemovedItems ) { if( view ) view->Hide( item, false ); aCommit->Remove( item ); } for( BOARD_ITEM* item : routerAddedItems ) { if( PCB_TRACK* track = dynamic_cast( item ) ) { if( bounds.PointInside( track->GetStart(), epsilon ) && bounds.PointInside( track->GetEnd(), epsilon ) ) { AddItem( item ); aCommit->Stage( item, CHT_GROUP ); } } aCommit->Add( item ); } } if( aCommitMsg.IsEmpty() ) aCommit->Push( _( "Edit Tuning Pattern" ), aCommitFlags ); else aCommit->Push( aCommitMsg, aCommitFlags ); } void PCB_TUNING_PATTERN::EditRevert( GENERATOR_TOOL* aTool, BOARD* aBoard, BOARD_COMMIT* aCommit ) { if( !( GetFlags() & IN_EDIT ) ) return; ClearFlags( IN_EDIT ); PNS_KICAD_IFACE* iface = aTool->GetInterface(); iface->EraseView(); if( KIGFX::VIEW* view = aTool->GetManager()->GetView() ) { for( const GENERATOR_PNS_CHANGES& pnsCommit : aTool->GetRouterChanges() ) { for( BOARD_ITEM* item : pnsCommit.removedItems ) view->Hide( item, false ); } } aTool->Router()->StopRouting(); if( aCommit ) aCommit->Revert(); } bool PCB_TUNING_PATTERN::MakeEditPoints( std::shared_ptr points ) const { VECTOR2I centerlineOffset; VECTOR2I centerlineOffsetEnd; if( m_tuningMode == DIFF_PAIR && m_baseLineCoupled && m_baseLineCoupled->SegmentCount() > 0 ) { centerlineOffset = ( m_baseLineCoupled->CPoint( 0 ) - m_origin ) / 2; centerlineOffsetEnd = ( m_baseLineCoupled->CPoint( -1 ) - m_end ) / 2; } points->AddPoint( m_origin + centerlineOffset ); points->AddPoint( m_end + centerlineOffsetEnd ); SEG base = m_baseLine && m_baseLine->SegmentCount() > 0 ? m_baseLine->CSegment( 0 ) : SEG( m_origin, m_end ); base.A += centerlineOffset; base.B += centerlineOffset; int amplitude = m_settings.m_maxAmplitude + KiROUND( m_trackWidth / 2.0 ); if( m_tuningMode == DIFF_PAIR ) amplitude += m_trackWidth + m_diffPairGap; if( m_settings.m_initialSide == -1 ) amplitude *= -1; VECTOR2I widthHandleOffset = ( base.B - base.A ).Perpendicular().Resize( amplitude ); points->AddPoint( base.A + widthHandleOffset ); points->Point( 2 ).SetGridConstraint( IGNORE_GRID ); VECTOR2I spacingHandleOffset = widthHandleOffset + ( base.B - base.A ).Resize( KiROUND( m_settings.m_spacing * 1.5 ) ); points->AddPoint( base.A + spacingHandleOffset ); points->Point( 3 ).SetGridConstraint( IGNORE_GRID ); return true; } bool PCB_TUNING_PATTERN::UpdateFromEditPoints( std::shared_ptr aEditPoints, BOARD_COMMIT* aCommit ) { VECTOR2I centerlineOffset; VECTOR2I centerlineOffsetEnd; if( m_tuningMode == DIFF_PAIR && m_baseLineCoupled && m_baseLineCoupled->SegmentCount() > 0 ) { centerlineOffset = ( m_baseLineCoupled->CPoint( 0 ) - m_origin ) / 2; centerlineOffsetEnd = ( m_baseLineCoupled->CPoint( -1 ) - m_end ) / 2; } SEG base = m_baseLine && m_baseLine->SegmentCount() > 0 ? m_baseLine->CSegment( 0 ) : SEG( m_origin, m_end ); base.A += centerlineOffset; base.B += centerlineOffset; m_origin = aEditPoints->Point( 0 ).GetPosition() - centerlineOffset; m_end = aEditPoints->Point( 1 ).GetPosition() - centerlineOffsetEnd; if( aEditPoints->Point( 2 ).IsActive() ) { VECTOR2I wHandle = aEditPoints->Point( 2 ).GetPosition(); int value = base.LineDistance( wHandle ); value -= KiROUND( m_trackWidth / 2.0 ); if( m_tuningMode == DIFF_PAIR ) value -= m_trackWidth + m_diffPairGap; SetMaxAmplitude( KiROUND( value / pcbIUScale.mmToIU( 0.01 ) ) * pcbIUScale.mmToIU( 0.01 ) ); int side = base.Side( wHandle ); if( side < 0 ) m_settings.m_initialSide = PNS::MEANDER_SIDE_LEFT; else m_settings.m_initialSide = PNS::MEANDER_SIDE_RIGHT; } if( aEditPoints->Point( 3 ).IsActive() ) { VECTOR2I wHandle = aEditPoints->Point( 2 ).GetPosition(); VECTOR2I sHandle = aEditPoints->Point( 3 ).GetPosition(); int value = KiROUND( SEG( base.A, wHandle ).LineDistance( sHandle ) / 1.5 ); SetSpacing( KiROUND( value / pcbIUScale.mmToIU( 0.01 ) ) * pcbIUScale.mmToIU( 0.01 ) ); } return true; } bool PCB_TUNING_PATTERN::UpdateEditPoints( std::shared_ptr aEditPoints ) { VECTOR2I centerlineOffset; VECTOR2I centerlineOffsetEnd; if( m_tuningMode == DIFF_PAIR && m_baseLineCoupled && m_baseLineCoupled->SegmentCount() > 0 ) { centerlineOffset = ( m_baseLineCoupled->CPoint( 0 ) - m_origin ) / 2; centerlineOffsetEnd = ( m_baseLineCoupled->CPoint( -1 ) - m_end ) / 2; } SEG base = m_baseLine && m_baseLine->SegmentCount() > 0 ? m_baseLine->CSegment( 0 ) : SEG( m_origin, m_end ); base.A += centerlineOffset; base.B += centerlineOffset; int amplitude = m_settings.m_maxAmplitude + KiROUND( m_trackWidth / 2.0 ); if( m_tuningMode == DIFF_PAIR ) amplitude += m_trackWidth + m_diffPairGap; if( m_settings.m_initialSide == -1 ) amplitude *= -1; VECTOR2I widthHandleOffset = ( base.B - base.A ).Perpendicular().Resize( amplitude ); aEditPoints->Point( 0 ).SetPosition( m_origin + centerlineOffset ); aEditPoints->Point( 1 ).SetPosition( m_end + centerlineOffsetEnd ); aEditPoints->Point( 2 ).SetPosition( base.A + widthHandleOffset ); VECTOR2I spacingHandleOffset = widthHandleOffset + ( base.B - base.A ).Resize( KiROUND( m_settings.m_spacing * 1.5 ) ); aEditPoints->Point( 3 ).SetPosition( base.A + spacingHandleOffset ); return true; } SHAPE_LINE_CHAIN PCB_TUNING_PATTERN::getOutline() const { if( m_baseLine ) { int clampedMaxAmplitude = m_settings.m_maxAmplitude; int minAllowedAmplitude = 0; int baselineOffset = m_tuningMode == DIFF_PAIR ? ( m_diffPairGap + m_trackWidth ) / 2 : 0; if( m_settings.m_cornerStyle == PNS::MEANDER_STYLE::MEANDER_STYLE_ROUND ) { minAllowedAmplitude = baselineOffset + m_trackWidth; } else { int correction = m_trackWidth * tan( 1 - tan( DEG2RAD( 22.5 ) ) ); minAllowedAmplitude = baselineOffset + correction; } clampedMaxAmplitude = std::max( clampedMaxAmplitude, minAllowedAmplitude ); if( m_settings.m_singleSided ) { SHAPE_LINE_CHAIN clBase = *m_baseLine; SHAPE_LINE_CHAIN left, right; if( m_tuningMode != DIFF_PAIR ) { int amplitude = clampedMaxAmplitude + KiROUND( m_trackWidth / 2.0 ); SHAPE_LINE_CHAIN chain; if( clBase.OffsetLine( amplitude, CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, left, right, true ) ) { chain.Append( m_settings.m_initialSide >= 0 ? right : left ); chain.Append( clBase.Reverse() ); chain.SetClosed( true ); return chain; } } else if( m_tuningMode == DIFF_PAIR && m_baseLineCoupled ) { int amplitude = clampedMaxAmplitude + m_trackWidth + KiROUND( m_diffPairGap / 2.0 ); SHAPE_LINE_CHAIN clCoupled = *m_baseLineCoupled; SHAPE_LINE_CHAIN chain1, chain2; if( clBase.OffsetLine( amplitude, CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, left, right, true ) ) { if( m_settings.m_initialSide >= 0 ) chain1.Append( right ); else chain1.Append( left ); if( clBase.OffsetLine( KiROUND( m_trackWidth / 2.0 ), CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, left, right, true ) ) { if( m_settings.m_initialSide >= 0 ) chain1.Append( left.Reverse() ); else chain1.Append( right.Reverse() ); } chain1.SetClosed( true ); } if( clCoupled.OffsetLine( amplitude, CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, left, right, true ) ) { if( m_settings.m_initialSide >= 0 ) chain2.Append( right ); else chain2.Append( left ); if( clCoupled.OffsetLine( KiROUND( m_trackWidth / 2.0 ), CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, left, right, true ) ) { if( m_settings.m_initialSide >= 0 ) chain2.Append( left.Reverse() ); else chain2.Append( right.Reverse() ); } chain2.SetClosed( true ); } SHAPE_POLY_SET merged; merged.BooleanAdd( chain1, chain2, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE ); if( merged.OutlineCount() > 0 ) return merged.Outline( 0 ); } } // Not single-sided / fallback SHAPE_POLY_SET poly; SHAPE_LINE_CHAIN cl = *m_baseLine; int amplitude = 0; if( m_tuningMode == DIFF_PAIR ) amplitude = clampedMaxAmplitude + m_diffPairGap / 2 + KiROUND( m_trackWidth ); else amplitude = clampedMaxAmplitude + KiROUND( m_trackWidth / 2.0 ); poly.OffsetLineChain( *m_baseLine, amplitude, CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, false ); if( m_tuningMode == DIFF_PAIR && m_baseLineCoupled ) { SHAPE_POLY_SET polyCoupled; polyCoupled.OffsetLineChain( *m_baseLineCoupled, amplitude, CORNER_STRATEGY::ROUND_ALL_CORNERS, ARC_LOW_DEF, false ); SHAPE_POLY_SET merged; merged.BooleanAdd( poly, polyCoupled, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE ); if( merged.OutlineCount() > 0 ) return merged.Outline( 0 ); } if( poly.OutlineCount() > 0 ) return poly.Outline( 0 ); } return SHAPE_LINE_CHAIN(); } void PCB_TUNING_PATTERN::ViewDraw( int aLayer, KIGFX::VIEW* aView ) const { if( !IsSelected() && !IsNew() ) return; KIGFX::PREVIEW::DRAW_CONTEXT ctx( *aView ); int size = KiROUND( aView->ToWorld( EDIT_POINT::POINT_SIZE ) * 0.8 ); size = std::max( size, pcbIUScale.mmToIU( 0.05 ) ); if( !HasFlag( IN_EDIT ) ) { if( m_baseLine ) { for( int i = 0; i < m_baseLine->SegmentCount(); i++ ) { SEG seg = m_baseLine->CSegment( i ); ctx.DrawLineDashed( seg.A, seg.B, size, size / 6, true ); } } else { ctx.DrawLineDashed( m_origin, m_end, size, size / 6, false ); } if( m_tuningMode == DIFF_PAIR && m_baseLineCoupled ) { for( int i = 0; i < m_baseLineCoupled->SegmentCount(); i++ ) { SEG seg = m_baseLineCoupled->CSegment( i ); ctx.DrawLineDashed( seg.A, seg.B, size, size / 6, true ); } } } SHAPE_LINE_CHAIN chain = getOutline(); for( int i = 0; i < chain.SegmentCount(); i++ ) { SEG seg = chain.Segment( i ); ctx.DrawLineDashed( seg.A, seg.B, size, size / 2, false ); } } const STRING_ANY_MAP PCB_TUNING_PATTERN::GetProperties() const { STRING_ANY_MAP props = PCB_GENERATOR::GetProperties(); props.set( "tuning_mode", tuningToString( m_tuningMode ) ); props.set( "initial_side", sideToString( m_settings.m_initialSide ) ); props.set( "last_status", statusToString( m_tuningStatus ) ); props.set( "end", m_end ); props.set( "corner_radius_percent", m_settings.m_cornerRadiusPercentage ); props.set( "single_sided", m_settings.m_singleSided ); props.set( "rounded", m_settings.m_cornerStyle == PNS::MEANDER_STYLE_ROUND ); props.set_iu( "max_amplitude", m_settings.m_maxAmplitude ); props.set_iu( "min_amplitude", m_settings.m_minAmplitude ); props.set_iu( "min_spacing", m_settings.m_spacing ); props.set_iu( "target_length_min", m_settings.m_targetLength.Min() ); props.set_iu( "target_length", m_settings.m_targetLength.Opt() ); props.set_iu( "target_length_max", m_settings.m_targetLength.Max() ); props.set_iu( "target_skew_min", m_settings.m_targetSkew.Min() ); props.set_iu( "target_skew", m_settings.m_targetSkew.Opt() ); props.set_iu( "target_skew_max", m_settings.m_targetSkew.Max() ); props.set_iu( "last_track_width", m_trackWidth ); props.set_iu( "last_diff_pair_gap", m_diffPairGap ); props.set( "last_netname", m_lastNetName ); props.set( "last_tuning", m_tuningInfo ); props.set( "override_custom_rules", m_settings.m_overrideCustomRules ); if( m_baseLine ) props.set( "base_line", wxAny( *m_baseLine ) ); if( m_baseLineCoupled ) props.set( "base_line_coupled", wxAny( *m_baseLineCoupled ) ); return props; } void PCB_TUNING_PATTERN::SetProperties( const STRING_ANY_MAP& aProps ) { PCB_GENERATOR::SetProperties( aProps ); wxString tuningMode; aProps.get_to( "tuning_mode", tuningMode ); m_tuningMode = tuningFromString( tuningMode.utf8_string() ); wxString side; aProps.get_to( "initial_side", side ); m_settings.m_initialSide = sideFromString( side.utf8_string() ); wxString status; aProps.get_to( "last_status", status ); m_tuningStatus = statusFromString( status.utf8_string() ); aProps.get_to( "end", m_end ); aProps.get_to( "corner_radius_percent", m_settings.m_cornerRadiusPercentage ); aProps.get_to( "single_sided", m_settings.m_singleSided ); aProps.get_to( "side", m_settings.m_initialSide ); bool rounded; aProps.get_to( "rounded", rounded ); m_settings.m_cornerStyle = rounded ? PNS::MEANDER_STYLE_ROUND : PNS::MEANDER_STYLE_CHAMFER; long long int val; aProps.get_to_iu( "target_length", val ); m_settings.SetTargetLength( val ); if( aProps.get_to_iu( "target_length_min", val ) ) m_settings.m_targetLength.SetMin( val ); if( aProps.get_to_iu( "target_length_max", val ) ) m_settings.m_targetLength.SetMax( val ); int int_val; aProps.get_to_iu( "target_skew", int_val ); m_settings.SetTargetSkew( int_val ); if( aProps.get_to_iu( "target_skew_min", int_val ) ) m_settings.m_targetSkew.SetMin( int_val ); if( aProps.get_to_iu( "target_skew_max", int_val ) ) m_settings.m_targetSkew.SetMax( int_val ); aProps.get_to_iu( "max_amplitude", m_settings.m_maxAmplitude ); aProps.get_to_iu( "min_amplitude", m_settings.m_minAmplitude ); aProps.get_to_iu( "min_spacing", m_settings.m_spacing ); aProps.get_to_iu( "last_track_width", m_trackWidth ); aProps.get_to_iu( "last_diff_pair_gap", m_diffPairGap ); aProps.get_to( "override_custom_rules", m_settings.m_overrideCustomRules ); aProps.get_to( "last_netname", m_lastNetName ); aProps.get_to( "last_tuning", m_tuningInfo ); if( auto baseLine = aProps.get_opt( "base_line" ) ) m_baseLine = *baseLine; if( auto baseLineCoupled = aProps.get_opt( "base_line_coupled" ) ) m_baseLineCoupled = *baseLineCoupled; } void PCB_TUNING_PATTERN::ShowPropertiesDialog( PCB_BASE_EDIT_FRAME* aEditFrame ) { PNS::MEANDER_SETTINGS settings = m_settings; DRC_CONSTRAINT constraint; if( !m_items.empty() ) { BOARD_ITEM* startItem = *m_items.begin(); std::shared_ptr& drcEngine = GetBoard()->GetDesignSettings().m_DRCEngine; constraint = drcEngine->EvalRules( LENGTH_CONSTRAINT, startItem, nullptr, GetLayer() ); if( !constraint.IsNull() && !settings.m_overrideCustomRules ) settings.SetTargetLength( constraint.GetValue() ); } DIALOG_TUNING_PATTERN_PROPERTIES dlg( aEditFrame, settings, GetPNSMode(), constraint ); if( dlg.ShowModal() == wxID_OK ) { BOARD_COMMIT commit( aEditFrame ); commit.Modify( this ); m_settings = settings; GENERATOR_TOOL* generatorTool = aEditFrame->GetToolManager()->GetTool(); EditStart( generatorTool, GetBoard(), &commit ); Update( generatorTool, GetBoard(), &commit ); EditPush( generatorTool, GetBoard(), &commit ); } } std::vector PCB_TUNING_PATTERN::GetPreviewItems( GENERATOR_TOOL* aTool, PCB_BASE_EDIT_FRAME* aFrame, bool aStatusItemsOnly ) { std::vector previewItems; KIGFX::VIEW* view = aFrame->GetCanvas()->GetView(); if( auto* placer = dynamic_cast( aTool->Router()->Placer() ) ) { if( !aStatusItemsOnly ) { PNS::ITEM_SET items = placer->TunedPath(); for( PNS::ITEM* item : items ) previewItems.push_back( new ROUTER_PREVIEW_ITEM( item, view, PNS_HOVER_ITEM ) ); } TUNING_STATUS_VIEW_ITEM* statusItem = new TUNING_STATUS_VIEW_ITEM( aFrame ); if( m_tuningMode == DIFF_PAIR_SKEW ) { statusItem->SetMinMax( m_settings.m_targetSkew.Min(), m_settings.m_targetSkew.Max() ); } else { if( m_settings.m_targetLength.Opt() == PNS::MEANDER_SETTINGS::LENGTH_UNCONSTRAINED ) { statusItem->ClearMinMax(); } else { statusItem->SetMinMax( (double) m_settings.m_targetLength.Min(), (double) m_settings.m_targetLength.Max() ); } } if( m_tuningMode == DIFF_PAIR_SKEW ) statusItem->SetCurrent( (double) placer->TuningResult(), _( "current skew" ) ); else statusItem->SetCurrent( (double) placer->TuningResult(), _( "current length" ) ); statusItem->SetPosition( aFrame->GetToolManager()->GetMousePosition() ); previewItems.push_back( statusItem ); } return previewItems; } void PCB_TUNING_PATTERN::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) { wxString msg; NETINFO_ITEM* primaryNet = nullptr; NETINFO_ITEM* coupledNet = nullptr; PCB_TRACK* primaryItem = nullptr; PCB_TRACK* coupledItem = nullptr; NETCLASS* netclass = nullptr; int width = 0; bool mixedWidth = false; aList.emplace_back( _( "Type" ), GetFriendlyName() ); for( BOARD_ITEM* member : GetItems() ) { if( PCB_TRACK* track = dynamic_cast( member ) ) { if( !primaryNet ) { primaryItem = track; primaryNet = track->GetNet(); } else if( !coupledNet && track->GetNet() != primaryNet ) { coupledItem = track; coupledNet = track->GetNet(); } if( !netclass ) netclass = track->GetEffectiveNetClass(); if( !width ) width = track->GetWidth(); else if( width != track->GetWidth() ) mixedWidth = true; } } if( coupledNet ) { aList.emplace_back( _( "Nets" ), UnescapeString( primaryNet->GetNetname() ) + wxS( ", " ) + UnescapeString( coupledNet->GetNetname() ) ); } else if( primaryNet ) { aList.emplace_back( _( "Net" ), UnescapeString( primaryNet->GetNetname() ) ); } if( netclass ) aList.emplace_back( _( "Resolved Netclass" ), UnescapeString( netclass->GetName() ) ); aList.emplace_back( _( "Layer" ), layerMaskDescribe() ); if( width && !mixedWidth ) aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( width ) ); BOARD* board = GetBoard(); std::shared_ptr& drcEngine = board->GetDesignSettings().m_DRCEngine; DRC_CONSTRAINT constraint; // Display full track length (in Pcbnew) if( board && primaryItem && primaryItem->GetNetCode() > 0 ) { int count; double trackLen; double lenPadToDie; std::tie( count, trackLen, lenPadToDie ) = board->GetTrackLength( *primaryItem ); if( coupledItem && coupledItem->GetNetCode() > 0 ) { double coupledLen; std::tie( count, coupledLen, lenPadToDie ) = board->GetTrackLength( *coupledItem ); aList.emplace_back( _( "Routed Lengths" ), aFrame->MessageTextFromValue( trackLen ) + wxS( ", " ) + aFrame->MessageTextFromValue( coupledLen ) ); } else { aList.emplace_back( _( "Routed Length" ), aFrame->MessageTextFromValue( trackLen ) ); } if( lenPadToDie != 0 ) { msg = aFrame->MessageTextFromValue( lenPadToDie ); aList.emplace_back( _( "Pad To Die Length" ), msg ); msg = aFrame->MessageTextFromValue( trackLen + lenPadToDie ); aList.emplace_back( _( "Full Length" ), msg ); } } if( m_tuningMode == DIFF_PAIR_SKEW ) { constraint = drcEngine->EvalRules( SKEW_CONSTRAINT, primaryItem, coupledItem, m_layer ); if( constraint.IsNull() || m_settings.m_overrideCustomRules ) { msg = aFrame->MessageTextFromValue( m_settings.m_targetSkew.Opt() ); aList.emplace_back( wxString::Format( _( "Target Skew: %s" ), msg ), wxString::Format( _( "(from tuning pattern properties)" ) ) ); } else { msg = aFrame->MessageTextFromMinOptMax( constraint.GetValue() ); if( !msg.IsEmpty() ) { aList.emplace_back( wxString::Format( _( "Skew Constraints: %s" ), msg ), wxString::Format( _( "(from %s)" ), constraint.GetName() ) ); } } } else { constraint = drcEngine->EvalRules( LENGTH_CONSTRAINT, primaryItem, coupledItem, m_layer ); if( constraint.IsNull() || m_settings.m_overrideCustomRules ) { msg = aFrame->MessageTextFromValue( (double) m_settings.m_targetLength.Opt() ); aList.emplace_back( wxString::Format( _( "Target Length: %s" ), msg ), wxString::Format( _( "(from tuning pattern properties)" ) ) ); } else { msg = aFrame->MessageTextFromMinOptMax( constraint.GetValue() ); if( !msg.IsEmpty() ) { aList.emplace_back( wxString::Format( _( "Length Constraints: %s" ), msg ), wxString::Format( _( "(from %s)" ), constraint.GetName() ) ); } } } } const wxString PCB_TUNING_PATTERN::DISPLAY_NAME = _HKI( "Tuning Pattern" ); const wxString PCB_TUNING_PATTERN::GENERATOR_TYPE = wxS( "tuning_pattern" ); using SCOPED_DRAW_MODE = SCOPED_SET_RESET; #define HITTEST_THRESHOLD_PIXELS 5 int DRAWING_TOOL::PlaceTuningPattern( const TOOL_EVENT& aEvent ) { if( m_isFootprintEditor ) return 0; if( m_inDrawingTool ) return 0; REENTRANCY_GUARD guard( &m_inDrawingTool ); m_toolMgr->RunAction( PCB_ACTIONS::selectionClear ); m_frame->PushTool( aEvent ); Activate(); BOARD* board = m_frame->GetBoard(); std::shared_ptr& drcEngine = board->GetDesignSettings().m_DRCEngine; GENERATOR_TOOL* generatorTool = m_toolMgr->GetTool(); PNS::ROUTER* router = generatorTool->Router(); LENGTH_TUNING_MODE mode = fromPNSMode( aEvent.Parameter() ); KIGFX::VIEW_CONTROLS* controls = getViewControls(); PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool(); GENERAL_COLLECTORS_GUIDE guide = m_frame->GetCollectorsGuide(); SCOPED_DRAW_MODE scopedDrawMode( m_mode, MODE::TUNING ); m_pickerItem = nullptr; m_tuningPattern = nullptr; // Add a VIEW_GROUP that serves as a preview for the new item m_preview.Clear(); m_view->Add( &m_preview ); auto setCursor = [&]() { m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::BULLSEYE ); controls->ShowCursor( true ); }; auto updateHoverStatus = [&]() { std::unique_ptr dummyPattern; if( m_pickerItem ) { dummyPattern.reset( PCB_TUNING_PATTERN::CreateNew( generatorTool, m_frame, m_pickerItem, mode ) ); dummyPattern->SetPosition( m_pickerItem->GetFocusPosition() ); dummyPattern->SetEnd( m_pickerItem->GetFocusPosition() ); } if( dummyPattern ) { dummyPattern->EditStart( generatorTool, m_board, nullptr ); dummyPattern->Update( generatorTool, m_board, nullptr ); m_preview.FreeItems(); for( EDA_ITEM* item : dummyPattern->GetPreviewItems( generatorTool, m_frame ) ) m_preview.Add( item ); generatorTool->Router()->StopRouting(); m_view->Update( &m_preview ); } else { m_preview.FreeItems(); m_view->Update( &m_preview ); } }; auto updateTuningPattern = [&]() { if( m_tuningPattern && m_tuningPattern->GetPosition() != m_tuningPattern->GetEnd() ) { m_tuningPattern->EditStart( generatorTool, m_board, nullptr ); m_tuningPattern->Update( generatorTool, m_board, nullptr ); m_preview.FreeItems(); for( EDA_ITEM* item : m_tuningPattern->GetPreviewItems( generatorTool, m_frame, true ) ) { m_preview.Add( item ); } m_view->Update( &m_preview ); } }; // Set initial cursor setCursor(); while( TOOL_EVENT* evt = Wait() ) { setCursor(); VECTOR2D cursorPos = controls->GetMousePosition(); if( evt->IsCancelInteractive() || evt->IsActivate() || ( m_tuningPattern && evt->IsAction( &ACTIONS::undo ) ) ) { if( m_tuningPattern ) { // First click already made; clean up tuning pattern preview m_tuningPattern->EditRevert( generatorTool, m_board, nullptr ); delete m_tuningPattern; m_tuningPattern = nullptr; } break; } else if( evt->IsMotion() ) { if( !m_tuningPattern ) { // First click not yet made; we're in highlight-net-under-cursor mode GENERAL_COLLECTOR collector; collector.m_Threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) ); if( m_frame->GetDisplayOptions().m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL ) guide.SetIncludeSecondary( false ); else guide.SetIncludeSecondary( true ); collector.Collect( board, { PCB_TRACE_T, PCB_ARC_T }, cursorPos, guide ); if( collector.GetCount() > 1 ) selectionTool->GuessSelectionCandidates( collector, cursorPos ); m_pickerItem = nullptr; if( collector.GetCount() > 0 ) { double min_dist_sq = std::numeric_limits().max(); for( EDA_ITEM* candidate : collector ) { VECTOR2I candidatePos; if( candidate->Type() == PCB_TRACE_T ) { candidatePos = static_cast( candidate )->GetCenter(); } else if( candidate->Type() == PCB_ARC_T ) { candidatePos = static_cast( candidate )->GetMid(); } double dist_sq = ( cursorPos - candidatePos ).SquaredEuclideanNorm(); if( dist_sq < min_dist_sq ) { min_dist_sq = dist_sq; m_pickerItem = static_cast( candidate ); } } } updateHoverStatus(); } else { // First click already made; we're in preview-tuning-pattern mode m_tuningPattern->SetEnd( cursorPos ); updateTuningPattern(); } } else if( evt->IsClick( BUT_LEFT ) ) { if( m_pickerItem && !m_tuningPattern ) { // First click; create a tuning pattern if( dynamic_cast( m_pickerItem->GetParentGroup() ) ) { m_frame->ShowInfoBarWarning( _( "Unable to tune segments inside other tuning patterns." ) ); } else { m_preview.FreeItems(); m_frame->SetActiveLayer( m_pickerItem->GetLayer() ); m_tuningPattern = PCB_TUNING_PATTERN::CreateNew( generatorTool, m_frame, m_pickerItem, mode ); int dummyDist; int dummyClearance = std::numeric_limits::max() / 2; VECTOR2I closestPt; // With an artificially-large clearance this can't *not* collide, but the // if stmt keeps Coverity happy.... if( m_pickerItem->GetEffectiveShape()->Collide( cursorPos, dummyClearance, &dummyDist, &closestPt ) ) { m_tuningPattern->SetPosition( closestPt ); m_tuningPattern->SetEnd( closestPt ); } m_preview.Add( m_tuningPattern->Clone() ); } } else if( m_pickerItem && m_tuningPattern ) { // Second click; we're done BOARD_COMMIT commit( m_frame ); m_tuningPattern->EditStart( generatorTool, m_board, &commit ); m_tuningPattern->Update( generatorTool, m_board, &commit ); m_tuningPattern->EditPush( generatorTool, m_board, &commit, _( "Tune" ) ); for( BOARD_ITEM* item : m_tuningPattern->GetItems() ) item->SetSelected(); break; } } else if( evt->IsClick( BUT_RIGHT ) ) { PCB_SELECTION dummy; m_menu.ShowContextMenu( dummy ); } else if( evt->IsAction( &PCB_ACTIONS::spacingIncrease ) || evt->IsAction( &PCB_ACTIONS::spacingDecrease ) ) { if( m_tuningPattern ) { auto* placer = static_cast( router->Placer() ); placer->SpacingStep( evt->IsAction( &PCB_ACTIONS::spacingIncrease ) ? 1 : -1 ); m_tuningPattern->SetSpacing( placer->MeanderSettings().m_spacing ); updateTuningPattern(); } } else if( evt->IsAction( &PCB_ACTIONS::amplIncrease ) || evt->IsAction( &PCB_ACTIONS::amplDecrease ) ) { if( m_tuningPattern ) { auto* placer = static_cast( router->Placer() ); placer->AmplitudeStep( evt->IsAction( &PCB_ACTIONS::amplIncrease ) ? 1 : -1 ); m_tuningPattern->SetMaxAmplitude( placer->MeanderSettings().m_maxAmplitude ); updateTuningPattern(); } } else if( evt->IsAction( &PCB_ACTIONS::properties ) ) { if( m_tuningPattern ) { DRC_CONSTRAINT constraint; if( !m_tuningPattern->GetItems().empty() ) { BOARD_ITEM* startItem = *m_tuningPattern->GetItems().begin(); constraint = drcEngine->EvalRules( LENGTH_CONSTRAINT, startItem, nullptr, startItem->GetLayer() ); } DIALOG_TUNING_PATTERN_PROPERTIES dlg( m_frame, m_tuningPattern->GetSettings(), m_tuningPattern->GetPNSMode(), constraint ); if( dlg.ShowModal() == wxID_OK ) updateTuningPattern(); } } // TODO: It'd be nice to be able to say "don't allow any non-trivial editing actions", // but we don't at present have that, so we just knock out some of the egregious ones. else if( ZONE_FILLER_TOOL::IsZoneFillAction( evt ) ) { wxBell(); } else { evt->SetPassEvent(); } controls->CaptureCursor( m_tuningPattern != nullptr ); controls->SetAutoPan( m_tuningPattern != nullptr ); } controls->CaptureCursor( false ); controls->SetAutoPan( false ); controls->ForceCursorPosition( false ); controls->ShowCursor( false ); m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW ); m_preview.FreeItems(); m_view->Remove( &m_preview ); m_frame->GetCanvas()->Refresh(); if( m_tuningPattern ) selectionTool->AddItemToSel( m_tuningPattern ); m_frame->PopTool( aEvent ); return 0; } static struct PCB_TUNING_PATTERN_DESC { PCB_TUNING_PATTERN_DESC() { ENUM_MAP::Instance() .Map( LENGTH_TUNING_MODE::SINGLE, _HKI( "Single track" ) ) .Map( LENGTH_TUNING_MODE::DIFF_PAIR, _HKI( "Differential pair" ) ) .Map( LENGTH_TUNING_MODE::DIFF_PAIR_SKEW, _HKI( "Diff pair skew" ) ); ENUM_MAP::Instance() .Map( PNS::MEANDER_SIDE_LEFT, _HKI( "Left" ) ) .Map( PNS::MEANDER_SIDE_RIGHT, _HKI( "Right" ) ) .Map( PNS::MEANDER_SIDE_DEFAULT, _HKI( "Default" ) ); PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance(); REGISTER_TYPE( PCB_TUNING_PATTERN ); propMgr.AddTypeCast( new TYPE_CAST ); propMgr.AddTypeCast( new TYPE_CAST ); propMgr.InheritsAfter( TYPE_HASH( PCB_TUNING_PATTERN ), TYPE_HASH( PCB_GENERATOR ) ); propMgr.InheritsAfter( TYPE_HASH( PCB_TUNING_PATTERN ), TYPE_HASH( BOARD_ITEM ) ); const wxString groupTab = _HKI( "Pattern Properties" ); propMgr.AddProperty( new PROPERTY( _HKI( "End X" ), &PCB_TUNING_PATTERN::SetEndX, &PCB_TUNING_PATTERN::GetEndX, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_X_COORD ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "End Y" ), &PCB_TUNING_PATTERN::SetEndY, &PCB_TUNING_PATTERN::GetEndY, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_Y_COORD ), groupTab ); propMgr.AddProperty( new PROPERTY_ENUM( _HKI( "Tuning Mode" ), NO_SETTER( PCB_TUNING_PATTERN, LENGTH_TUNING_MODE ), &PCB_TUNING_PATTERN::GetTuningMode ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "Min Amplitude" ), &PCB_TUNING_PATTERN::SetMinAmplitude, &PCB_TUNING_PATTERN::GetMinAmplitude, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_X_COORD ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "Max Amplitude" ), &PCB_TUNING_PATTERN::SetMaxAmplitude, &PCB_TUNING_PATTERN::GetMaxAmplitude, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_X_COORD ), groupTab ); propMgr.AddProperty( new PROPERTY_ENUM( _HKI( "Initial Side" ), &PCB_TUNING_PATTERN::SetInitialSide, &PCB_TUNING_PATTERN::GetInitialSide ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "Min Spacing" ), &PCB_TUNING_PATTERN::SetSpacing, &PCB_TUNING_PATTERN::GetSpacing, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_X_COORD ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "Corner Radius %" ), &PCB_TUNING_PATTERN::SetCornerRadiusPercentage, &PCB_TUNING_PATTERN::GetCornerRadiusPercentage, PROPERTY_DISPLAY::PT_DEFAULT, ORIGIN_TRANSFORMS::NOT_A_COORD ), groupTab ); auto isSkew = []( INSPECTABLE* aItem ) -> bool { if( PCB_TUNING_PATTERN* pattern = dynamic_cast( aItem ) ) return pattern->GetTuningMode() == DIFF_PAIR_SKEW; return false; }; auto notIsSkew = [&]( INSPECTABLE* aItem ) -> bool { return !isSkew( aItem ); }; propMgr.AddProperty( new PROPERTY>( _HKI( "Target Length" ), &PCB_TUNING_PATTERN::SetTargetLength, &PCB_TUNING_PATTERN::GetTargetLength, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_X_COORD ), groupTab ) .SetAvailableFunc( notIsSkew ); propMgr.AddProperty( new PROPERTY( _HKI( "Target Skew" ), &PCB_TUNING_PATTERN::SetTargetSkew, &PCB_TUNING_PATTERN::GetTargetSkew, PROPERTY_DISPLAY::PT_SIZE, ORIGIN_TRANSFORMS::ABS_X_COORD ), groupTab ) .SetAvailableFunc( isSkew ); propMgr.AddProperty( new PROPERTY( _HKI( "Override Custom Rules" ), &PCB_TUNING_PATTERN::SetOverrideCustomRules, &PCB_TUNING_PATTERN::GetOverrideCustomRules ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "Single-sided" ), &PCB_TUNING_PATTERN::SetSingleSided, &PCB_TUNING_PATTERN::IsSingleSided ), groupTab ); propMgr.AddProperty( new PROPERTY( _HKI( "Rounded" ), &PCB_TUNING_PATTERN::SetRounded, &PCB_TUNING_PATTERN::IsRounded ), groupTab ); } } _PCB_TUNING_PATTERN_DESC; ENUM_TO_WXANY( LENGTH_TUNING_MODE ) ENUM_TO_WXANY( PNS::MEANDER_SIDE ) static GENERATORS_MGR::REGISTER registerMe; // Also register under the 7.99 name template struct REGISTER_LEGACY_TUNING_PATTERN { REGISTER_LEGACY_TUNING_PATTERN() { GENERATORS_MGR::Instance().Register( wxS( "meanders" ), T::DISPLAY_NAME, []() { return new T; } ); } }; static REGISTER_LEGACY_TUNING_PATTERN registerMeToo;