board_adapter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
 * Copyright (C) 1992-2020 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 BOARD_ADAPTER_H
#define BOARD_ADAPTER_H

#include <array>
#include <vector>
#include "../3d_rendering/3d_render_raytracing/accelerators/ccontainer2d.h"
#include "../3d_rendering/3d_render_raytracing/accelerators/ccontainer.h"
#include "../3d_rendering/3d_render_raytracing/shapes3D/cbbox.h"
#include "../3d_rendering/ccamera.h"
#include "../3d_enums.h"
#include "../3d_cache/3d_cache.h"
#include "../common_ogl/cogl_att_list.h"

#include <layers_id_colors_and_visibility.h>
#include <pad.h>
#include <track.h>
#include <wx/gdicmn.h>
#include <pcb_base_frame.h>
#include <pcb_text.h>
#include <pcb_shape.h>
#include <dimension.h>
#include <zone.h>
#include <footprint.h>
#include <reporter.h>

class COLOR_SETTINGS;

typedef std::map< PCB_LAYER_ID, CBVHCONTAINER2D *> MAP_CONTAINER_2D;

typedef std::map< PCB_LAYER_ID, SHAPE_POLY_SET *> MAP_POLY;

#define RANGE_SCALE_3D 8.0f


class BOARD_ADAPTER
{
 public:

    BOARD_ADAPTER();

    ~BOARD_ADAPTER();

    void Set3DCacheManager( S3D_CACHE *aCachePointer ) noexcept
    {
        m_3d_model_manager = aCachePointer;
    }

    S3D_CACHE *Get3DCacheManager( ) const noexcept
    {
        return m_3d_model_manager;
    }

    bool GetFlag( DISPLAY3D_FLG aFlag ) const ;

    void SetFlag( DISPLAY3D_FLG aFlag, bool aState );

    bool Is3DLayerEnabled( PCB_LAYER_ID aLayer ) const;

    bool ShouldFPBeDisplayed( FOOTPRINT_ATTR_T aFPAttributes ) const;

    void SetBoard( BOARD *aBoard ) noexcept
    {
        m_board = aBoard;
    }

    const BOARD *GetBoard() const noexcept
    {
        return m_board;
    }

    void SetColorSettings( COLOR_SETTINGS* aSettings ) noexcept
    {
        m_colors = aSettings;
    }

    void InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningReporter );

    double BiuTo3Dunits() const noexcept
    {
        return m_biuTo3Dunits;
    }

    const CBBOX &GetBBox3DU() const noexcept
    {
        return m_boardBoundingBox;
    }

    float GetEpoxyThickness3DU() const noexcept
    {
        return m_epoxyThickness3DU;
    }

    float GetNonCopperLayerThickness3DU() const noexcept
    {
        return m_nonCopperLayerThickness3DU;
    }

    float GetCopperThickness3DU() const noexcept
    {
        return m_copperThickness3DU;
    }

    int GetHolePlatingThicknessBIU() const noexcept;

    wxSize GetBoardSizeBIU() const noexcept
    {
        return m_boardSize;
    }

    wxPoint GetBoardPosBIU() const noexcept
    {
        return m_boardPos;
    }

    const SFVEC3F &GetBoardCenter3DU() const noexcept
    {
        return m_boardCenter;
    }

    float GetModulesZcoord3DIU( bool aIsFlipped ) const ;

    GRID3D_TYPE GridGet() const noexcept
    {
        return m_3D_grid_type;
    }

    void GridSet( GRID3D_TYPE aGridType ) noexcept
    {
        m_3D_grid_type = aGridType;
    }

    ANTIALIASING_MODE AntiAliasingGet() const { return m_antialiasing_mode; }

    void AntiAliasingSet( ANTIALIASING_MODE aAAmode ) { m_antialiasing_mode = aAAmode; }

    void RenderEngineSet( RENDER_ENGINE aRenderEngine ) noexcept
    {
        m_render_engine = aRenderEngine;
    }

    RENDER_ENGINE RenderEngineGet() const noexcept
    {
        return m_render_engine;
    }

    void MaterialModeSet( MATERIAL_MODE aMaterialMode ) noexcept
    {
        m_material_mode = aMaterialMode;
    }

    MATERIAL_MODE MaterialModeGet() const noexcept
    {
        return m_material_mode;
    }

    const SHAPE_POLY_SET &GetBoardPoly() const noexcept
    {
        return m_board_poly;
    }

    SFVEC4F GetLayerColor( PCB_LAYER_ID aLayerId ) const;

    SFVEC4F GetItemColor( int aItemId ) const;

    SFVEC4F GetColor( COLOR4D aColor ) const;

    float GetLayerTopZpos3DU( PCB_LAYER_ID aLayerId ) const noexcept
    {
        return m_layerZcoordTop[aLayerId];
    }

    float GetLayerBottomZpos3DU( PCB_LAYER_ID aLayerId ) const noexcept
    {
        return m_layerZcoordBottom[aLayerId];
    }

    const MAP_CONTAINER_2D &GetMapLayers() const noexcept
    {
        return m_layers_container2D;
    }

    const CBVHCONTAINER2D* GetPlatedPads_Front() const noexcept
    {
        return m_platedpads_container2D_F_Cu;
    }

    const CBVHCONTAINER2D* GetPlatedPads_Back() const noexcept
    {
        return m_platedpads_container2D_B_Cu;
    }

    const MAP_CONTAINER_2D &GetMapLayersHoles() const noexcept
    {
        return m_layers_holes2D;
    }

    const CBVHCONTAINER2D &GetThroughHole_Outer() const noexcept
    {
        return m_through_holes_outer;
    }

    const CBVHCONTAINER2D& GetThroughHole_Outer_Ring() const noexcept
    {
        return m_through_holes_outer_ring;
    }

    const SHAPE_POLY_SET &GetThroughHole_Outer_poly() const noexcept
    {
        return m_through_outer_holes_poly;
    }

    const SHAPE_POLY_SET &GetThroughHole_Outer_Ring_poly() const noexcept
    {
        return m_through_outer_ring_holes_poly;
    }

    const SHAPE_POLY_SET &GetThroughHole_Outer_poly_NPTH() const noexcept
    {
        return m_through_outer_holes_poly_NPTH;
    }

    const CBVHCONTAINER2D &GetThroughHole_Vias_Outer() const noexcept
    {
        return m_through_holes_vias_outer;
    }

    const SHAPE_POLY_SET &GetThroughHole_Vias_Outer_poly() const noexcept
    {
        return m_through_outer_holes_vias_poly;
    }

    const CBVHCONTAINER2D &GetThroughHole_Inner() const noexcept
    {
        return m_through_holes_inner;
    }

    unsigned int GetStats_Nr_Vias() const noexcept
    {
        return m_stats_nr_vias;
    }

    unsigned int GetStats_Nr_Holes() const noexcept
    {
        return m_stats_nr_holes;
    }

    float GetStats_Med_Via_Hole_Diameter3DU() const noexcept
    {
        return m_stats_via_med_hole_diameter;
    }

    float GetStats_Med_Hole_Diameter3DU() const noexcept
    {
        return m_stats_hole_med_diameter;
    }

    float GetStats_Med_Track_Width() const noexcept
    {
        return m_stats_track_med_width;
    }

    unsigned int GetNrSegmentsCircle( float aDiameter3DU ) const;

    unsigned int GetNrSegmentsCircle( int aDiameterBIU ) const;

    const MAP_POLY &GetPolyMap() const noexcept
    {
        return m_layers_poly;
    }

    const SHAPE_POLY_SET *GetPolyPlatedPads_Front()
    {
        return m_F_Cu_PlatedPads_poly;
    }

    const SHAPE_POLY_SET *GetPolyPlatedPads_Back()
    {
        return m_B_Cu_PlatedPads_poly;
    }

    const MAP_POLY &GetPolyMapHoles_Inner() const noexcept
    {
        return m_layers_inner_holes_poly;
    }

    const MAP_POLY &GetPolyMapHoles_Outer() const noexcept
    {
        return m_layers_outer_holes_poly;
    }

 private:
    bool createBoardPolygon( wxString* aErrorMsg );
    void createLayers( REPORTER* aStatusReporter );
    void destroyLayers();

    // Helper functions to create the board
     void createNewTrack( const TRACK* aTrack, CGENERICCONTAINER2D *aDstContainer,
                          int aClearanceValue );

    void createNewPadWithClearance( const PAD *aPad, CGENERICCONTAINER2D *aDstContainer,
                                    PCB_LAYER_ID aLayer, wxSize aClearanceValue ) const;

    COBJECT2D *createNewPadDrill( const PAD* aPad, int aInflateValue );

    void AddPadsWithClearanceToContainer( const FOOTPRINT *aFootprint,
                                          CGENERICCONTAINER2D *aDstContainer,
                                          PCB_LAYER_ID aLayerId, int aInflateValue,
                                          bool aSkipNPTHPadsWihNoCopper, bool aSkipPlatedPads,
                                          bool aSkipNonPlatedPads );

    void AddFPShapesWithClearanceToContainer( const FOOTPRINT *aFootprint,
                                              CGENERICCONTAINER2D *aDstContainer,
                                              PCB_LAYER_ID aLayerId, int aInflateValue );

    void AddShapeWithClearanceToContainer( const PCB_TEXT *aText,
                                           CGENERICCONTAINER2D *aDstContainer,
                                           PCB_LAYER_ID aLayerId, int aClearanceValue );

    void AddShapeWithClearanceToContainer( const PCB_SHAPE *aShape,
                                           CGENERICCONTAINER2D *aDstContainer,
                                           PCB_LAYER_ID aLayerId, int aClearanceValue );

    void AddShapeWithClearanceToContainer( const DIMENSION_BASE *aDimension,
                                           CGENERICCONTAINER2D *aDstContainer,
                                           PCB_LAYER_ID aLayerId, int aClearanceValue );

    void AddSolidAreasShapesToContainer( const ZONE *aZoneContainer,
                                         CGENERICCONTAINER2D *aDstContainer,
                                         PCB_LAYER_ID aLayerId );

    void TransformArcToSegments( const wxPoint &aCentre, const wxPoint &aStart, double aArcAngle,
                                 int aCircleToSegmentsCount, int aWidth,
                                 CGENERICCONTAINER2D *aDstContainer, const BOARD_ITEM &aBoardItem );

    void buildPadShapeThickOutlineAsSegments( const PAD *aPad, CGENERICCONTAINER2D *aDstContainer,
                                              int aWidth );

    // Helper functions to create poly contours
    void buildPadShapeThickOutlineAsPolygon( const PAD *aPad, SHAPE_POLY_SET &aCornerBuffer,
                                             int aWidth) const;

    void transformFPShapesToPolygon( const FOOTPRINT *aFootprint, PCB_LAYER_ID aLayer,
                                     SHAPE_POLY_SET& aCornerBuffer ) const;

public:
    SFVEC4F m_BgColorBot;         
    SFVEC4F m_BgColorTop;         
    SFVEC4F m_BoardBodyColor;     
    SFVEC4F m_SolderMaskColorBot; 
    SFVEC4F m_SolderMaskColorTop; 
    SFVEC4F m_SolderPasteColor;   
    SFVEC4F m_SilkScreenColorBot; 
    SFVEC4F m_SilkScreenColorTop; 
    SFVEC4F m_CopperColor;        

    SFVEC3F m_opengl_selectionColor;

    // Raytracing light colors

    SFVEC3F m_raytrace_lightColorCamera;
    SFVEC3F m_raytrace_lightColorTop;
    SFVEC3F m_raytrace_lightColorBottom;

    std::vector<SFVEC3F> m_raytrace_lightColor;
    std::vector<SFVEC2F> m_raytrace_lightSphericalCoords;

    // Raytracing options
    int m_raytrace_nrsamples_shadows;
    int m_raytrace_nrsamples_reflections;
    int m_raytrace_nrsamples_refractions;

    float m_raytrace_spread_shadows;
    float m_raytrace_spread_reflections;
    float m_raytrace_spread_refractions;

    int m_raytrace_recursivelevel_reflections;
    int m_raytrace_recursivelevel_refractions;

private:

    BOARD*              m_board;
    S3D_CACHE*          m_3d_model_manager;
    COLOR_SETTINGS*     m_colors;

    // Render options

    std::vector< bool > m_drawFlags;
    GRID3D_TYPE         m_3D_grid_type;
    RENDER_ENGINE       m_render_engine;
    MATERIAL_MODE       m_material_mode;
    ANTIALIASING_MODE   m_antialiasing_mode;


    // Pcb board position

    wxPoint m_boardPos;

    wxSize  m_boardSize;

    SFVEC3F m_boardCenter;


    // Pcb board bounding boxes

    CBBOX             m_boardBoundingBox;

    MAP_POLY          m_layers_poly;

    SHAPE_POLY_SET*   m_F_Cu_PlatedPads_poly;
    SHAPE_POLY_SET*   m_B_Cu_PlatedPads_poly;

    MAP_POLY          m_layers_outer_holes_poly;

    MAP_POLY          m_layers_inner_holes_poly;

    SHAPE_POLY_SET    m_through_outer_holes_poly_NPTH;

    SHAPE_POLY_SET    m_through_outer_holes_poly;

    SHAPE_POLY_SET    m_through_outer_holes_vias_poly;

    SHAPE_POLY_SET    m_through_outer_ring_holes_poly;

    SHAPE_POLY_SET    m_board_poly;


    // 2D element containers

    MAP_CONTAINER_2D  m_layers_container2D;

    CBVHCONTAINER2D*  m_platedpads_container2D_F_Cu;
    CBVHCONTAINER2D*  m_platedpads_container2D_B_Cu;

    MAP_CONTAINER_2D  m_layers_holes2D;

    CBVHCONTAINER2D   m_through_holes_outer;

    CBVHCONTAINER2D   m_through_holes_outer_ring;

    CBVHCONTAINER2D   m_through_holes_inner;

    CBVHCONTAINER2D   m_through_holes_vias_outer;

    CBVHCONTAINER2D   m_through_holes_vias_inner;


    // Layers information

    unsigned int m_copperLayersCount;

    double m_biuTo3Dunits;

    std::array<float, PCB_LAYER_ID_COUNT>  m_layerZcoordTop;

    std::array<float, PCB_LAYER_ID_COUNT>  m_layerZcoordBottom;

    float  m_copperThickness3DU;

    float  m_epoxyThickness3DU;

    float  m_nonCopperLayerThickness3DU;

    float m_calc_seg_min_factor3DU;

    float m_calc_seg_max_factor3DU;


    // Statistics

    unsigned int m_stats_nr_tracks;

    float        m_stats_track_med_width;

    unsigned int m_stats_nr_vias;

    float        m_stats_via_med_hole_diameter;

    unsigned int m_stats_nr_holes;

    float        m_stats_hole_med_diameter;

    static const wxChar *m_logTrace;

};


class EDA_3D_BOARD_HOLDER
{
public:
    virtual BOARD_ADAPTER& GetAdapter() = 0;
    virtual CCAMERA&       GetCurrentCamera() = 0;

    virtual ~EDA_3D_BOARD_HOLDER() {};
};

#endif // BOARD_ADAPTER_H