teardrop.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TEARDROP_H
#define TEARDROP_H
 
#include <unordered_map>
 
#include <tool/tool_manager.h>
#include <board.h>
#include <drc/drc_rtree.h>
#include "teardrop_parameters.h"
 
class BOARD;
class PCB_TRACK;
class ZONE;
 
 
// A class to store tracks grouped by layer and netcode
class TRACK_BUFFER
{
public:
    TRACK_BUFFER() {}

    void AddTrack( PCB_TRACK* aTrack, int aLayer, int aNetcode );

    std::map<int, std::vector<PCB_TRACK*>>& GetBuffer() { return m_map_tracks; }
 
    static void GetNetcodeAndLayerFromIndex( int aIdx, int* aLayer, int* aNetcode )
    {
        *aLayer = aIdx & 0xFF;
        *aNetcode = aIdx >> 8;
    }
 
private:
    // Build an index from the layer id and the netcode, to store a track in buffer
    int idxFromLayNet( int aLayer, int aNetcode ) const
    {
        return ( aNetcode << 8 ) + ( aLayer & 0xFF );
    }
 
    // Track buffer, tracks are grouped by layer+netcode
    std::map<int, std::vector<PCB_TRACK*>> m_map_tracks;
};
 

class TEARDROP_MANAGER
{
    friend class TEARDROP_PARAMETERS;
 
public:
    enum TEARDROP_VARIANT
    {
        TD_TYPE_PADVIA,     // Specify a teardrop on a pad via
        TD_TYPE_TRACKEND    // specify a teardrop on a rond end of a wide track
    };
 
    TEARDROP_MANAGER( BOARD* aBoard, TOOL_MANAGER* aToolManager );

    void RemoveTeardrops( BOARD_COMMIT& aCommit, std::vector<BOARD_ITEM*>* dirtyPadsAndVias,
                          std::set<PCB_TRACK*>* dirtyTracks,
                          const std::vector<BOARD_ITEM*>* dirtyCopper = nullptr );
    void UpdateTeardrops( BOARD_COMMIT& aCommit, const std::vector<BOARD_ITEM*>* dirtyPadsAndVias,
                          const std::set<PCB_TRACK*>* dirtyTracks, bool aForceFullUpdate = false );

    void AddTeardropsOnTracks( BOARD_COMMIT& aCommit, const std::set<PCB_TRACK*>* aTracks,
                               bool aForceFullUpdate = false, bool aSetPriorities = true );
 
    void DeleteTrackToTrackTeardrops( BOARD_COMMIT& aCommit );
 
    static int GetWidth( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer );
    static bool IsRound( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer );
    static bool IsUniformlyRound( BOARD_ITEM* aItem );
 
    void BuildTrackCaches();
 
private:
    bool areItemsInSameZone( BOARD_ITEM* aPadOrVia, PCB_TRACK* aTrack) const;

    const std::vector<std::set<const BOARD_ITEM*>>& zoneConnections( ZONE* aZone,
                                                                    PCB_LAYER_ID aLayer ) const;

    static int copperNetcode( const BOARD_ITEM* aItem );

    int pairClearance( PCB_TRACK* aSourceTrack, BOARD_ITEM* aItem,
                       PCB_LAYER_ID aLayer ) const;

    void ensureCopperIndex() const;

    bool collidesWithOtherNets( const std::vector<VECTOR2I>& aPoints, PCB_TRACK* aSourceTrack,
                                const std::vector<const BOARD_ITEM*>& aExempt ) const;

    bool computeFittedTeardropPolygon( const TEARDROP_PARAMETERS& aParams,
                                       std::vector<VECTOR2I>& aPoints, PCB_TRACK* aTrack,
                                       PCB_TRACK* aSourceTrack, BOARD_ITEM* aOther,
                                       const VECTOR2I& aOtherPos ) const;

    int computeChordThroughShape( PCB_TRACK* aTrack, BOARD_ITEM* aOther, PCB_LAYER_ID aLayer,
                                  const VECTOR2I& aInsidePoint ) const;

    void computeCurvedForRoundShape( const TEARDROP_PARAMETERS& aParams,
                                     std::vector<VECTOR2I>& aPoly, PCB_LAYER_ID aLayer,
                                     int aTrackHalfWidth,
                                     const VECTOR2D& aTrackDir, BOARD_ITEM* aOther,
                                     const VECTOR2I& aOtherPos, std::vector<VECTOR2I>& aPts ) const;
 

    void computeCurvedForRectShape( const TEARDROP_PARAMETERS& aParams,
                                    std::vector<VECTOR2I>& aPoly, int aTdWidth,
                                    int aTrackHalfWidth, std::vector<VECTOR2I>& aPts,
                                    const VECTOR2I& aIntersection, BOARD_ITEM* aOther,
                                    const VECTOR2I& aOtherPos, PCB_LAYER_ID aLayer ) const;

    bool computeTeardropPolygon( const TEARDROP_PARAMETERS& aParams,
                                 std::vector<VECTOR2I>& aCorners, PCB_TRACK* aTrack,
                                 PCB_TRACK* aSourceTrack, BOARD_ITEM* aOther,
                                 const VECTOR2I& aOtherPos ) const;
    bool computeAnchorPoints( const TEARDROP_PARAMETERS& aParams, PCB_LAYER_ID aLayer,
                              BOARD_ITEM* aItem, const VECTOR2I& aPos,
                              std::vector<VECTOR2I>& aPts ) const;

    PCB_TRACK* findTouchingTrack( EDA_ITEM_FLAGS& aMatchType, PCB_TRACK* aTrackRef,
                                  PCB_TRACK* aSourceTrack, const VECTOR2I& aEndPoint ) const;

    static KIID teardropUuid( const PCB_TRACK* aTrack, const BOARD_ITEM* aCandidate, int aSlot );

    static KIID maskUuidFor( const KIID& aCopperUuid );

    static void buildCrossingStub( PCB_TRACK& aStub, const PCB_TRACK* aTrack,
                                   const VECTOR2I& aEnd );

    ZONE* createTeardrop( TEARDROP_VARIANT aTeardropVariant, std::vector<VECTOR2I>& aPoints,
                          PCB_TRACK* aSourceTrack, const KIID& aUuid ) const;
 
    ZONE* createTeardropMask( TEARDROP_VARIANT aTeardropVariant, std::vector<VECTOR2I>& aPoints,
                              PCB_TRACK* aSourceTrack, const KIID& aUuid ) const;

    void createAndAddTeardropWithMask( BOARD_COMMIT& aCommit, TEARDROP_VARIANT aTeardropVariant,
                                       std::vector<VECTOR2I>& aPoints, PCB_TRACK* aSourceTrack,
                                       const KIID& aUuid );

    bool tryCreateTrackTeardrop( BOARD_COMMIT& aCommit, const TEARDROP_PARAMETERS& aParams,
                                 TEARDROP_VARIANT aTeardropVariant, PCB_TRACK* aTrack,
                                 PCB_TRACK* aSourceTrack, BOARD_ITEM* aCandidate,
                                 const VECTOR2I& aPos, const KIID& aUuid );

    void setTeardropPriorities();

    bool findAnchorPointsOnTrack( const TEARDROP_PARAMETERS& aParams, VECTOR2I& aStartPoint,
                                  VECTOR2I& aEndPoint, VECTOR2I& aIntersection,
                                  PCB_TRACK*& aTrack, PCB_TRACK* aSourceTrack, BOARD_ITEM* aOther,
                                  const VECTOR2I& aOtherPos, int* aEffectiveTeardropLen ) const;
 
private:
    int                       m_tolerance;      // max dist between track end point and pad/via
                                                //   center to see them connected to ut a teardrop
    BOARD*                    m_board;
    TOOL_MANAGER*             m_toolManager;
    TEARDROP_PARAMETERS_LIST* m_prmsList;       // the teardrop parameters list, from the board design settings
 
    DRC_RTREE                 m_tracksRTree;
    TRACK_BUFFER              m_trackLookupList;
    std::vector<ZONE*>        m_createdTdList;  // list of new created teardrops

    mutable DRC_RTREE         m_copperRTree;
    mutable bool              m_copperIndexed;
 
    mutable std::unordered_map<PTR_LAYER_CACHE_KEY, std::vector<std::set<const BOARD_ITEM*>>>
            m_zoneConnectionCache;
 
    mutable std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, int> m_pairClearanceCache;
};
 
#endif  // ifndef TEARDROP_H