pns_meander.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2013-2015 CERN
 * Copyright (C) 2016-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __PNS_MEANDER_H
#define __PNS_MEANDER_H
 
#include <math/vector2d.h>
#include <core/minoptmax.h>
 
#include <geometry/shape.h>
#include <geometry/shape_line_chain.h>
 
namespace PNS {
 
class MEANDER_PLACER_BASE;
class MEANDERED_LINE;
 
enum MEANDER_TYPE {
 MT_SINGLE, // _|^|_, single-sided
 MT_START, // _|^|
 MT_FINISH, // |^|_
 MT_TURN, // |^| or |_|
 MT_CHECK_START, // try fitting a start type, but don't produce a line
 MT_CHECK_FINISH, // try fitting a finish type, but don't produce a line
 MT_CORNER, // line corner
 MT_ARC, // arc corner
 MT_EMPTY // no meander (straight line)
};
 
enum MEANDER_STYLE {
 MEANDER_STYLE_ROUND = 1, // rounded (90 degree arc)
 MEANDER_STYLE_CHAMFER // chamfered (45 degree segment)
};
 
enum MEANDER_SIDE
{
 MEANDER_SIDE_LEFT = -1,
 MEANDER_SIDE_DEFAULT = 0,
 MEANDER_SIDE_RIGHT = 1
};
 
class MEANDER_SETTINGS
{
#define DEFAULT_TOLERANCE 100000
 
public:
 
 MEANDER_SETTINGS()
 {
 m_minAmplitude = 100000;
 m_maxAmplitude = 1000000;
 m_step = 50000;
 m_lenPadToDie = 0;
 m_spacing = 600000;
 SetTargetLength( 100000000 );
 SetTargetSkew( 0 );
 m_overrideCustomRules = false;
 m_cornerStyle = MEANDER_STYLE_ROUND;
 m_cornerRadiusPercentage = 100;
 m_singleSided = false;
 m_initialSide = MEANDER_SIDE_LEFT;
 m_lengthTolerance = 0;
 m_keepEndpoints = false;
 }
 
 void SetTargetLength( long long int aOpt )
 {
 m_targetLength.SetOpt( aOpt );
 m_targetLength.SetMin( aOpt - DEFAULT_TOLERANCE );
 m_targetLength.SetMax( aOpt + DEFAULT_TOLERANCE );
 }
 
 void SetTargetLength( const MINOPTMAX<int>& aConstraint )
 {
 SetTargetLength( aConstraint.Opt() );
 
 if( aConstraint.HasMin() )
 m_targetLength.SetMin( aConstraint.Min() );
 
 if( aConstraint.HasMax() )
 m_targetLength.SetMax( aConstraint.Max() );
 }
 
 void SetTargetSkew( int aOpt )
 {
 m_targetSkew.SetOpt( aOpt );
 m_targetSkew.SetMin( aOpt - DEFAULT_TOLERANCE );
 m_targetSkew.SetMax( aOpt + DEFAULT_TOLERANCE );
 }
 
 void SetTargetSkew( const MINOPTMAX<int>& aConstraint )
 {
 SetTargetSkew( aConstraint.Opt() );
 
 if( aConstraint.HasMin() )
 m_targetSkew.SetMin( aConstraint.Min() );
 
 if( aConstraint.HasMax() )
 m_targetSkew.SetMax( aConstraint.Max() );
 }
 
 int m_minAmplitude;
 
 int m_maxAmplitude;
 
 int m_spacing;
 
 int m_step;
 
 int m_lenPadToDie;
 
 MINOPTMAX<long long int> m_targetLength;
 
 MINOPTMAX<int> m_targetSkew;
 
 bool m_overrideCustomRules;
 
 MEANDER_STYLE m_cornerStyle;
 
 int m_cornerRadiusPercentage;
 
 bool m_singleSided;
 
 MEANDER_SIDE m_initialSide;
 
 int m_lengthTolerance;
 
 bool m_keepEndpoints;
};
 
class MEANDER_SHAPE
{
public:
 MEANDER_SHAPE( MEANDER_PLACER_BASE* aPlacer, int aWidth, bool aIsDual = false ) :
 m_placer( aPlacer ),
 m_dual( aIsDual ),
 m_width( aWidth ),
 m_baselineOffset( 0 )
 {
 // Do not leave uninitialized members, and keep static analyzer quiet:
 m_type = MT_SINGLE;
 m_amplitude = 0;
 m_targetBaseLen = 0;
 m_side = false;
 m_baseIndex = 0;
 m_currentTarget = nullptr;
 m_meanCornerRadius = 0;
 }
 
 void SetType( MEANDER_TYPE aType )
 {
 m_type = aType;
 }
 
 MEANDER_TYPE Type() const
 {
 return m_type;
 }
 
 void SetBaseIndex( int aIndex )
 {
 m_baseIndex = aIndex;
 }
 
 int BaseIndex() const
 {
 return m_baseIndex;
 }
 
 int Amplitude() const
 {
 return m_amplitude;
 }
 
 void MakeCorner( const VECTOR2I& aP1, const VECTOR2I& aP2 = VECTOR2I( 0, 0 ) );
 
 void MakeArc( const SHAPE_ARC& aArc1, const SHAPE_ARC& aArc2 = SHAPE_ARC() );
 
 void Resize( int aAmpl );
 
 void Recalculate();
 
 bool IsDual() const
 {
 return m_dual;
 }
 
 bool Side() const
 {
 return m_side;
 }
 
 VECTOR2I End() const
 {
 return m_clippedBaseSeg.B;
 }
 
 const SHAPE_LINE_CHAIN& CLine( int aShape ) const
 {
 return m_shapes[aShape];
 }
 
 void MakeEmpty();
 
 bool Fit( MEANDER_TYPE aType, const SEG& aSeg, const VECTOR2I& aP, bool aSide );
 
 const SEG& BaseSegment() const
 {
 return m_clippedBaseSeg;
 }
 
 int BaselineLength() const;
 
 long long int CurrentLength() const;
 
 long long int MinTunableLength() const;
 
 int MinAmplitude() const;
 
 const MEANDER_SETTINGS& Settings() const;
 
 int Width() const
 {
 return m_width;
 }
 
 void SetBaselineOffset( int aOffset )
 {
 m_baselineOffset = aOffset;
 }
 
 void SetTargetBaselineLength( int aLength ) { m_targetBaseLen = aLength; }
 
private:
 friend class MEANDERED_LINE;
 
 void start( SHAPE_LINE_CHAIN* aTarget, const VECTOR2D& aWhere, const VECTOR2D& aDir );
 
 void forward( int aLength );
 
 void turn( const EDA_ANGLE& aAngle );
 
 void miter( int aRadius, bool aSide );
 
 void uShape( int aSides, int aCorner, int aTop );
 
 SHAPE_LINE_CHAIN makeMiterShape( const VECTOR2D& aP, const VECTOR2D& aDir, bool aSide );
 
 SHAPE_LINE_CHAIN genMeanderShape( const VECTOR2D& aP, const VECTOR2D& aDir, bool aSide,
 MEANDER_TYPE aType, int aBaselineOffset = 0 );
 
 void updateBaseSegment();
 
 int cornerRadius() const;
 
 int spacing() const;
 
 MEANDER_TYPE m_type;
 
 MEANDER_PLACER_BASE* m_placer;
 
 bool m_dual;
 
 int m_width;
 
 int m_amplitude;
 
 int m_baselineOffset;
 
 int m_meanCornerRadius;
 
 int m_targetBaseLen;
 
 VECTOR2I m_p0;
 
 SEG m_baseSeg;
 
 SEG m_clippedBaseSeg;
 
 bool m_side;
 
 SHAPE_LINE_CHAIN m_shapes[2];
 
 int m_baseIndex;
 
 VECTOR2D m_currentDir;
 
 VECTOR2D m_currentPos;
 
 SHAPE_LINE_CHAIN* m_currentTarget;
};
 
 
class MEANDERED_LINE
{
public:
 MEANDERED_LINE()
 {
 // Do not leave uninitialized members, and keep static analyzer quiet:
 m_placer = nullptr;
 m_dual = false;
 m_width = 0;
 m_baselineOffset = 0;
 }
 
 MEANDERED_LINE( MEANDER_PLACER_BASE* aPlacer, bool aIsDual = false ) :
 m_placer( aPlacer ),
 m_dual( aIsDual )
 {
 // Do not leave uninitialized members, and keep static analyzer quiet:
 m_width = 0;
 m_baselineOffset = 0;
 }
 
 ~MEANDERED_LINE()
 {
 Clear();
 }
 
 void AddCorner( const VECTOR2I& aA, const VECTOR2I& aB = VECTOR2I( 0, 0 ) );
 
 void AddArc( const SHAPE_ARC& aArc1, const SHAPE_ARC& aArc2 = SHAPE_ARC() );
 
 void AddArcAndPt( const SHAPE_ARC& aArc1, const VECTOR2I& aPt2 );
 
 void AddPtAndArc( const VECTOR2I& aPt1, const SHAPE_ARC& aArc2 );
 
 void AddMeander( MEANDER_SHAPE* aShape );
 
 void Clear();
 
 void SetWidth( int aWidth )
 {
 m_width = aWidth;
 }
 
 void MeanderSegment( const SEG& aSeg, bool aSide, int aBaseIndex = 0 );
 
 void SetBaselineOffset( int aOffset )
 {
 m_baselineOffset = aOffset;
 }
 
 std::vector<MEANDER_SHAPE*>& Meanders()
 {
 return m_meanders;
 }
 
 bool CheckSelfIntersections( MEANDER_SHAPE* aShape, int aClearance );
 
 const MEANDER_SETTINGS& Settings() const;
 
private:
 VECTOR2I m_last;
 
 MEANDER_PLACER_BASE* m_placer;
 std::vector<MEANDER_SHAPE*> m_meanders;
 
 bool m_dual;
 int m_width;
 int m_baselineOffset;
};
 
}
 
#endif // __PNS_MEANDER_H