zone_filler.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2017 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Tomasz Włostowski <[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 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 ZONE_FILLER_H
#define ZONE_FILLER_H
 
#include <map>
#include <mutex>
#include <vector>
#include <zone.h>
#include <geometry/rtree/packed_rtree.h>
#include <geometry/shape_poly_set.h>
#include <hash_128.h>
 
class PROGRESS_REPORTER;
class BOARD;
class COMMIT;
class FOOTPRINT;
class SHAPE_LINE_CHAIN;
 
 
class ZONE_FILLER
{
public:
    ZONE_FILLER( BOARD* aBoard, COMMIT* aCommit );
    ~ZONE_FILLER();
 
    void SetProgressReporter( PROGRESS_REPORTER* aReporter );
    PROGRESS_REPORTER* GetProgressReporter() const { return m_progressReporter; }

    bool Fill( const std::vector<ZONE*>& aZones, bool aCheck = false, wxWindow* aParent = nullptr );
 
    bool IsDebug() const { return m_debugZoneFiller; }
 
private:
 
    void addKnockout( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer, int aGap, SHAPE_POLY_SET& aHoles );
 
    void addKnockout( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer, int aGap, bool aIgnoreLineWidth,
                      SHAPE_POLY_SET& aHoles );
 
    void addHoleKnockout( PAD* aPad, int aGap, SHAPE_POLY_SET& aHoles );
 
    void knockoutThermalReliefs( const ZONE* aZone, PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aFill,
                                 std::vector<BOARD_ITEM*>& aThermalConnectionPads, std::vector<PAD*>& aNoConnectionPads,
                                 std::vector<BOARD_ITEM*>& aSolidConnectionItems );
 
    void buildCopperItemClearances( const ZONE* aZone, PCB_LAYER_ID aLayer,
                                    const std::vector<PAD*>& aNoConnectionPads,
                                    SHAPE_POLY_SET& aHoles,
                                    bool aIncludeZoneClearances = true );

    void buildDifferentNetZoneClearances( const ZONE* aZone, PCB_LAYER_ID aLayer,
                                          SHAPE_POLY_SET& aHoles );

    bool zoneKnockoutMayInteract( const ZONE* aZone, const ZONE* aKnockout ) const;

    BOX2I zoneKnockoutQueryBox( const ZONE* aZone ) const;

    bool mayHoldOutOfBoardCopper( const ZONE* aZone ) const;
 
    void subtractHigherPriorityZones( const ZONE* aZone, PCB_LAYER_ID aLayer,
                                      SHAPE_POLY_SET& aRawFill );

    bool fillCopperZone( const ZONE* aZone, PCB_LAYER_ID aLayer, PCB_LAYER_ID aDebugLayer,
                         const SHAPE_POLY_SET& aSmoothedOutline,
                         const SHAPE_POLY_SET& aMaxExtents, SHAPE_POLY_SET& aFillPolys );
 
    bool fillNonCopperZone( const ZONE* candidate, PCB_LAYER_ID aLayer,
                            const SHAPE_POLY_SET& aSmoothedOutline, SHAPE_POLY_SET& aFillPolys );
    void buildThermalSpokes( const ZONE* box, PCB_LAYER_ID aLayer,
                             const std::vector<BOARD_ITEM*>& aSpokedPadsList,
                             std::deque<SHAPE_LINE_CHAIN>& aSpokes );

    void buildHatchZoneThermalRings( const ZONE* aZone, PCB_LAYER_ID aLayer,
                                     const SHAPE_POLY_SET& aSmoothedOutline,
                                     const std::vector<BOARD_ITEM*>& aThermalConnectionPads,
                                     SHAPE_POLY_SET& aFillPolys,
                                     SHAPE_POLY_SET& aThermalRings );

    void connect_nearby_polys( SHAPE_POLY_SET& aPolys, double aDistance );

    bool fillSingleZone( ZONE* aZone, PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aFillPolys );

    bool addHatchFillTypeOnZone( const ZONE* aZone, PCB_LAYER_ID aLayer, PCB_LAYER_ID aDebugLayer,
                                 SHAPE_POLY_SET& aFillPolys,
                                 const SHAPE_POLY_SET& aThermalRings );

    bool addCopperThievingPattern( const ZONE* aZone, PCB_LAYER_ID aLayer,
                                   SHAPE_POLY_SET& aFillPolys );

    void postKnockoutMinWidthPrune( const ZONE* aZone, SHAPE_POLY_SET& aFillPolys,
                                    const SHAPE_POLY_SET& aSameNetApron );

    using FillSnapshot = std::map<std::pair<const ZONE*, PCB_LAYER_ID>, SHAPE_POLY_SET>;

    bool refillZoneFromCache( ZONE* aZone, PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aFillPolys,
                              const FillSnapshot* aSnapshot = nullptr );

    struct INDEXED_ITEM
    {
        BOARD_ITEM* m_item;
        FOOTPRINT*  m_owner;    // the footprint that owns a graphic item, else nullptr
        int         m_seq;
    };
 
    using ITEM_RTREE = KIRTREE::PACKED_RTREE<INDEXED_ITEM, int, 2>;

    static void queryIndex( const ITEM_RTREE& aIndex, const BOX2I& aBBox,
                            std::vector<INDEXED_ITEM>& aResult );

    void buildItemIndexes();
 
    BOARD*                m_board;
    SHAPE_POLY_SET        m_boardOutline;       // the board outlines, if exists
    bool                  m_brdOutlinesValid;   // true if m_boardOutline is well-formed
    COMMIT*               m_commit;
    PROGRESS_REPORTER*    m_progressReporter;
 
    // Rebuilt per fill, then read-only, so the fill workers can share them.
    ITEM_RTREE                         m_graphicIndex;    // fp reference/value/graphics + drawings
    ITEM_RTREE                         m_footprintIndex;  // footprints, for the courtyard knockout
    ITEM_RTREE                         m_padIndex;
    std::map<PCB_LAYER_ID, ITEM_RTREE> m_trackIndex;
    std::map<PCB_LAYER_ID, ITEM_RTREE> m_zoneIndex;
 
    int                   m_maxError;
    int                   m_worstClearance;
 
    // ExtraClearance plus max approximation error, part of the knockout reach
    int                   m_zoneKnockoutSlack;
 
    // Largest corner radius on the board. Widens the knockout query window.
    int                   m_maxZoneCornerRadius;
 
    bool                  m_debugZoneFiller;
 
    // Cache of pre-knockout fills for iterative refill optimization (issue 21746)
    // Key: (zone pointer, layer), Value: fill polygon before higher-priority zone knockout
    std::map<std::pair<const ZONE*, PCB_LAYER_ID>, SHAPE_POLY_SET> m_preKnockoutFillCache;
 
    // Un-hatched extent per (zone, layer); lets the refiller re-border carved hatch zones (#24758).
    std::map<std::pair<const ZONE*, PCB_LAYER_ID>, SHAPE_POLY_SET> m_preHatchSolidFillCache;
 
    // Band just outside each (zone, layer) that an abutting same-net zone pours into.  Buffers the
    // refiller's min-width cycle the way the smoothed outline buffers the initial one (#23790).
    std::map<std::pair<const ZONE*, PCB_LAYER_ID>, SHAPE_POLY_SET> m_sameNetApronCache;
 
    // Refill result keyed by (zone, layer); value is the knockout-geometry hash + cached fill.
    // Hit lets an unchanged-knockout zone skip the refill subtract + prune.  Cleared each Fill().
    std::map<std::pair<const ZONE*, PCB_LAYER_ID>, std::pair<HASH_128, SHAPE_POLY_SET>>
                                                                   m_refillResultCache;
    mutable std::mutex                                             m_cacheMutex;
};
 
#endif