pcb_track.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004 Jean-Pierre Charras, [email protected]
 * Copyright (C) 1992-2021 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
 */

#ifndef CLASS_TRACK_H
#define CLASS_TRACK_H


#include <board_connected_item.h>
#include <convert_to_biu.h>


class PCB_TRACK;
class PCB_VIA;
class PAD;
class MSG_PANEL_ITEM;
class SHAPE_POLY_SET;
class SHAPE_ARC;


// Flag used in locate routines (from which endpoint work)
enum ENDPOINT_T : int
{
 ENDPOINT_START = 0,
 ENDPOINT_END = 1
};

// Via types
// Note that this enum must be synchronized to GAL_LAYER_ID
enum class VIATYPE : int
{
 THROUGH = 3, /* Always a through hole via */
 BLIND_BURIED = 2, /* this via can be on internal layers */
 MICROVIA = 1, /* this via which connect from an external layer
 * to the near neighbor internal layer */
 NOT_DEFINED = 0 /* not yet used */
};

#define UNDEFINED_DRILL_DIAMETER -1 //< Undefined via drill diameter.

// Used for tracks and vias for algorithmic safety, not to enforce constraints
#define GEOMETRY_MIN_SIZE ( int )( 0.001 * IU_PER_MM )


class PCB_TRACK : public BOARD_CONNECTED_ITEM
{
public:
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && PCB_TRACE_T == aItem->Type();
 }

 PCB_TRACK( BOARD_ITEM* aParent, KICAD_T idtype = PCB_TRACE_T );

 // Do not create a copy constructor. The one generated by the compiler is adequate.

 void Move( const wxPoint& aMoveVector ) override
 {
 m_Start += aMoveVector;
 m_End += aMoveVector;
 }

 void Rotate( const wxPoint& aRotCentre, double aAngle ) override;

 void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;

 void SetPosition( const wxPoint& aPos ) override { m_Start = aPos; }
 wxPoint GetPosition() const override { return m_Start; }
 const wxPoint GetFocusPosition() const override { return ( m_Start + m_End ) / 2; }

 void SetWidth( int aWidth ) { m_Width = aWidth; }
 int GetWidth() const { return m_Width; }

 void SetEnd( const wxPoint& aEnd ) { m_End = aEnd; }
 const wxPoint& GetEnd() const { return m_End; }

 void SetStart( const wxPoint& aStart ) { m_Start = aStart; }
 const wxPoint& GetStart() const { return m_Start; }

 void SetEndX( int aX ) { m_End.x = aX; }
 void SetEndY( int aY ) { m_End.y = aY; }

 int GetEndX() const { return m_End.x; }
 int GetEndY() const { return m_End.y; }

 const wxPoint& GetEndPoint( ENDPOINT_T aEndPoint ) const
 {
 if( aEndPoint == ENDPOINT_START )
 return m_Start;
 else
 return m_End;
 }

 // Virtual function
 const EDA_RECT GetBoundingBox() const override;

 virtual double GetLength() const;

 void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
 PCB_LAYER_ID aLayer, int aClearanceValue,
 int aError, ERROR_LOC aErrorLoc,
 bool ignoreLineWidth = false ) const override;

 // @copydoc BOARD_ITEM::GetEffectiveShape
 virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING aFlash = FLASHING::DEFAULT ) const override;

 EDA_ITEM_FLAGS IsPointOnEnds( const wxPoint& point, int min_dist = 0 ) const;

 bool IsNull() const
 {
 return ( Type() == PCB_VIA_T ) || ( m_Start == m_End );
 }

 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

 SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;

 bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;

 bool ApproxCollinear( const PCB_TRACK& aTrack );

 wxString GetClass() const override
 {
 return wxT( "PCB_TRACK" );
 }

 int GetLocalClearance( wxString* aSource ) const override;

 wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;

 BITMAPS GetMenuImage() const override;

 virtual EDA_ITEM* Clone() const override;

 virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;

 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;

 const BOX2I ViewBBox() const override;

 virtual void SwapData( BOARD_ITEM* aImage ) override;

 bool IsOnCopperLayer() const override
 {
  return true;
 }

 struct cmp_tracks
 {
 bool operator()( const PCB_TRACK* aFirst, const PCB_TRACK* aSecond ) const;
 };

#if defined (DEBUG)
 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }

 static wxString ShowState( int stateBits );

#endif

protected:
 void GetMsgPanelInfoBase_Common( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) const;


 int m_Width; 
 wxPoint m_Start; 
 wxPoint m_End; 

};


class PCB_ARC : public PCB_TRACK
{
public:
 PCB_ARC( BOARD_ITEM* aParent ) :
 PCB_TRACK( aParent, PCB_ARC_T )
 {
 };

 PCB_ARC( BOARD_ITEM* aParent, const SHAPE_ARC* aArc );

 static inline bool ClassOf( const EDA_ITEM *aItem )
 {
 return aItem && PCB_ARC_T == aItem->Type();
 }

 virtual void Move( const wxPoint& aMoveVector ) override
 {
 m_Start += aMoveVector;
 m_Mid += aMoveVector;
 m_End += aMoveVector;
 }

 virtual void Rotate( const wxPoint& aRotCentre, double aAngle ) override;

 virtual void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;

 void SetMid( const wxPoint& aMid ) { m_Mid = aMid; }
 const wxPoint& GetMid() const { return m_Mid; }

 void SetPosition( const wxPoint& aPos ) override
 {
 m_Start = aPos;
 }

 virtual wxPoint GetPosition() const override;

 virtual wxPoint GetCenter() const override { return GetPosition(); }

 double GetRadius() const;
 double GetAngle() const;
 double GetArcAngleStart() const;
 double GetArcAngleEnd() const;
 virtual bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;

 virtual bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;

 wxString GetClass() const override
 {
 return wxT( "PCB_ARC" );
 }

 // @copydoc BOARD_ITEM::GetEffectiveShape
 virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING aFlash = FLASHING::DEFAULT ) const override;

 //TODO(snh): Add GetSelectMenuText() and GetMsgPanelInfoBase()

 virtual double GetLength() const override
 {
 double radius = GetRadius();
 double includedAngle = std::abs( GetAngle() );

 return radius * M_PI * includedAngle / 1800.0;
 }

 EDA_ITEM* Clone() const override;

 virtual void SwapData( BOARD_ITEM* aImage ) override;

private:
 wxPoint m_Mid; 
};


class PCB_VIA : public PCB_TRACK
{
public:
 PCB_VIA( BOARD_ITEM* aParent );

 static inline bool ClassOf( const EDA_ITEM *aItem )
 {
 return aItem && PCB_VIA_T == aItem->Type();
 }

 // Do not create a copy constructor. The one generated by the compiler is adequate.

 bool IsType( const KICAD_T aScanTypes[] ) const override
 {
 if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( *p == PCB_LOCATE_STDVIA_T && m_viaType == VIATYPE::THROUGH )
 return true;
 else if( *p == PCB_LOCATE_UVIA_T && m_viaType == VIATYPE::MICROVIA )
 return true;
 else if( *p == PCB_LOCATE_BBVIA_T && m_viaType == VIATYPE::BLIND_BURIED )
 return true;
 }

 return false;
 }

 VIATYPE GetViaType() const { return m_viaType; }
 void SetViaType( VIATYPE aViaType ) { m_viaType = aViaType; }

 bool IsOnLayer( PCB_LAYER_ID aLayer ) const override;

 virtual LSET GetLayerSet() const override;
 virtual void SetLayerSet( LSET aLayers ) override;

 void SetLayerPair( PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer );

 void SetBottomLayer( PCB_LAYER_ID aLayer );
 void SetTopLayer( PCB_LAYER_ID aLayer );

 void LayerPair( PCB_LAYER_ID* top_layer, PCB_LAYER_ID* bottom_layer ) const;

 PCB_LAYER_ID TopLayer() const;
 PCB_LAYER_ID BottomLayer() const;

 void SanitizeLayers();

 wxPoint GetPosition() const override { return m_Start; }
 void SetPosition( const wxPoint& aPoint ) override { m_Start = aPoint; m_End = aPoint; }

 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

 bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;

 wxString GetClass() const override
 {
 return wxT( "PCB_VIA" );
 }

 wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;

 BITMAPS GetMenuImage() const override;

 EDA_ITEM* Clone() const override;

 void ViewGetLayers( int aLayers[], int& aCount ) const override;

 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;

 void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;

#if defined (DEBUG)
 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif

 int GetMinAnnulus( PCB_LAYER_ID aLayer, wxString* aSource ) const;

 void SetRemoveUnconnected( bool aSet ) { m_removeUnconnectedLayer = aSet; }
 bool GetRemoveUnconnected() const { return m_removeUnconnectedLayer; }

 void SetKeepTopBottom( bool aSet ) { m_keepTopBottomLayer = aSet; }
 bool GetKeepTopBottom() const { return m_keepTopBottomLayer; }

 bool FlashLayer( int aLayer ) const;

 bool FlashLayer( LSET aLayers ) const;

 void SetDrill( int aDrill ) { m_drill = aDrill; }

 int GetDrill() const { return m_drill; }

 int GetDrillValue() const;

 void SetDrillDefault() { m_drill = UNDEFINED_DRILL_DIAMETER; }

 bool GetIsFree() const { return m_isFree; }
 void SetIsFree( bool aFree = true ) { m_isFree = aFree; }

 bool IsDrillDefault() const { return m_drill <= 0; }

 void SwapData( BOARD_ITEM* aImage ) override;

 // @copydoc BOARD_ITEM::GetEffectiveShape
 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING aFlash = FLASHING::DEFAULT ) const override;

protected:
 wxString layerMaskDescribe() const override;

private:
 PCB_LAYER_ID m_bottomLayer;

 VIATYPE m_viaType; 

 int m_drill; 

 bool m_removeUnconnectedLayer; 
 bool m_keepTopBottomLayer; 
 bool m_isFree; 
};


#endif // CLASS_TRACK_H