target3001_pcb_builder.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 TARGET3001_PCB_BUILDER_H
#define TARGET3001_PCB_BUILDER_H
 
#include <map>
#include <memory>
#include <optional>
#include <set>
#include <vector>
 
#include <geometry/shape_poly_set.h>
#include <layer_ids.h>
#include <lset.h>
#include <math/box2.h>
#include <math/vector2d.h>
#include <wx/string.h>
 
#include <io/target3001/target3001_fonts.h>
#include <io/target3001/target3001_parser.h>
 
class BOARD;
class BOARD_ITEM;
class BOARD_ITEM_CONTAINER;
class FOOTPRINT;
class NETINFO_ITEM;
class PAD;
class PCB_SHAPE;
class PCB_TEXT;
class REPORTER;
 

class TARGET3001_PCB_BUILDER
{
public:
    TARGET3001_PCB_BUILDER( BOARD* aBoard, const TARGET3001::PROJECT& aProject, REPORTER* aReporter );
 
    void Build();

    const wxString& DesignRules() const { return m_designRules; }

    TARGET3001::LAYER_FUNCTION LayerFunction( int aLayer ) const;
 
private:
    void buildLayerMap();
    void buildNets();
    void buildComponents();
    void buildSignalCopper();
    void buildFreeItems();
    void buildPourAreas();
 
    void addFootprint( const TARGET3001::ELEMENT& aComponent );

    void addItem( const TARGET3001::ELEMENT& aElem, BOARD_ITEM_CONTAINER* aParent, FOOTPRINT* aFootprint,
                  bool aIsTrack );

    void addShape( const TARGET3001::ELEMENT& aElem, BOARD_ITEM_CONTAINER* aParent, FOOTPRINT* aFootprint,
                   bool aIsTrack, PCB_LAYER_ID aLayer );

    std::vector<std::unique_ptr<PCB_SHAPE>> fiducialShapes( const TARGET3001::ELEMENT& aElem,
                                                            BOARD_ITEM_CONTAINER* aParent ) const;
 
    void addPad( const TARGET3001::ELEMENT& aElem, FOOTPRINT* aFootprint );
    void addVia( const TARGET3001::ELEMENT& aElem );
    void addText( const TARGET3001::ELEMENT& aElem, BOARD_ITEM_CONTAINER* aParent, FOOTPRINT* aFootprint,
                  PCB_LAYER_ID aLayer );
    void configureText( PCB_TEXT* aText, const TARGET3001::ELEMENT& aElem, PCB_LAYER_ID aLayer );

    std::optional<PCB_LAYER_ID> mapLayer( int aLayer ) const;

    std::optional<PCB_LAYER_ID> pourCopperLayer( int aLayer ) const;
 
    bool isCopper( int aLayer ) const;

    void buildAreaClearanceRules();

    void connectAuraPads();
 
    NETINFO_ITEM* net( uint16_t aSignal ) const;
 
    VECTOR2I toKi( int32_t aX, int32_t aY ) const { return VECTOR2I( aX, -aY ); }

    bool elementOutline( const TARGET3001::ELEMENT& aElem, SHAPE_POLY_SET& aOut ) const;

    void mergeContour( const TARGET3001::ELEMENT& aElem );

    std::optional<LSET> padstackLayers( int aLayer ) const;

    void addPadstackCuts( const BOARD_ITEM& aItem, int aPadstack );
 
    struct AURA_PAD
    {
        PAD*                   pad;
        uint16_t               signal;
        std::set<PCB_LAYER_ID> noAura;   
    };
 
    struct POUR_AREA
    {
        uint16_t       signal;
        PCB_LAYER_ID   layer;
        VECTOR2I       anchor;
        SHAPE_POLY_SET outline;
    };
 
    BOARD*                     m_board;
    const TARGET3001::PROJECT& m_project;
    REPORTER*                  m_reporter;
 
    std::map<int, PCB_LAYER_ID>              m_layerMap;
    std::vector<int>                         m_copperStack;     
    std::map<uint16_t, NETINFO_ITEM*>        m_nets;            
    int                                      m_freePadCount = 0;
    std::map<std::pair<int, int>, SHAPE_POLY_SET> m_copperFills; 
    std::vector<POUR_AREA>                   m_pourAreas;
    std::optional<int>                       m_contourLayer;    
    BOX2I                                    m_contourBox;
    bool                                     m_contourCarvesNothing = false; 
    std::map<int, SHAPE_POLY_SET>            m_pourKeepouts;    

    std::map<uint16_t, std::map<int, int>>   m_signalClearances;
    std::vector<AURA_PAD>                    m_auraPads;
    std::set<std::pair<uint16_t, PCB_LAYER_ID>> m_pourLayers; 
    wxString                                 m_designRules;
    TARGET3001::FONTS                        m_fonts;
};
 
#endif // TARGET3001_PCB_BUILDER_H