render_3d_raytrace_base.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-2020 Mario Luzeiro <[email protected]>
 * 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 RENDER_3D_RAYTRACE_BASE_H
#define RENDER_3D_RAYTRACE_BASE_H
 
#include "accelerators/container_3d.h"
#include "accelerators/accelerator_3d.h"
#include "../render_3d_base.h"
#include "light.h"
#include "../post_shader_ssao.h"
#include "material.h"
#include <plugins/3dapi/c3dmodel.h>
 
#include <map>
#include <memory>
#include <mutex>
#include <stop_token>
 
class PAD;
class PCB_VIA;

typedef std::vector< BLINN_PHONG_MATERIAL > MODEL_MATERIALS;

typedef std::map< const S3DMODEL* , MODEL_MATERIALS > MAP_MODEL_MATERIALS;
 
typedef enum
{
    RT_RENDER_STATE_TRACING = 0,
    RT_RENDER_STATE_POST_PROCESS_SHADE,
    RT_RENDER_STATE_POST_PROCESS_BLUR_AND_FINISH,
    RT_RENDER_STATE_FINISH,
    RT_RENDER_STATE_MAX
} RT_RENDER_STATE;
 
 
class RENDER_3D_RAYTRACE_BASE : public RENDER_3D_BASE
{
public:
    // TODO: Take into account board thickness so that the camera won't move inside of the board
    // when facing it perpendicularly.
    static constexpr float MIN_DISTANCE_IU = 4 * PCB_IU_PER_MM;
 
    explicit RENDER_3D_RAYTRACE_BASE( BOARD_ADAPTER& aAdapter, CAMERA& aCamera );
 
    ~RENDER_3D_RAYTRACE_BASE();
 
    int GetWaitForEditingTimeOut() override;
 
    void Reload( bool aOnlyLoadCopperAndShapes, std::stop_token aStop = {} );

    void InvalidateHitTesting();
 
    BOARD_ITEM *IntersectBoardItem( const RAY& aRay );
 
protected:
    virtual void initPbo() = 0;
    virtual void deletePbo() = 0;
    void createItemsFromContainer( const BVH_CONTAINER_2D* aContainer2d, PCB_LAYER_ID aLayer_id,
                                   const MATERIAL* aMaterialLayer, const SFVEC3F& aLayerColor,
                                   float aLayerZOffset );
 
    void restartRenderState();
    void renderTracing( uint8_t* ptrPBO );
    void postProcessShading( uint8_t* ptrPBO );
    void postProcessBlurFinish( uint8_t* ptrPBO );
    void renderBlockTracing( uint8_t* ptrPBO , signed int iBlock );
    void renderFinalColor( uint8_t* ptrPBO, const SFVEC4F& rgbColor,
                           bool applyColorSpaceConversion );
 
    void renderRayPackets( const SFVEC4F* bgColorY, const RAY* aRayPkt, HITINFO_PACKET* aHitPacket,
                           bool is_testShadow, SFVEC4F* aOutHitColor );
 
    void renderAntiAliasPackets( const SFVEC4F* aBgColorY, const HITINFO_PACKET* aHitPck_X0Y0,
                                 const HITINFO_PACKET* aHitPck_AA_X1Y1, const RAY* aRayPck,
                                 SFVEC4F* aOutHitColor );
 
    // Materials
    void setupMaterials();
 
    SFVEC4F shadeHit( const SFVEC4F& aBgColor, const RAY& aRay, HITINFO& aHitInfo,
                      bool aIsInsideObject, unsigned int aRecursiveLevel,
                      bool is_testShadow ) const;

    void createObject( CONTAINER_3D& aDstContainer, const OBJECT_2D* aObject2D, float aZMin,
                       float aZMax, const MATERIAL* aMaterial, const SFVEC3F& aObjColor );
 
    void addPadsAndVias();
    void insertHole( const PCB_VIA* aVia );
    void insertHole( const PAD* aPad );
    void addCounterborePlating( const BOARD_ITEM& aSource, const SFVEC2F& aCenter,
                                float aInnerRadius, float aDepth, float aSurfaceZ,
                                bool aIsFront );
    void addCountersinkPlating( const SFVEC2F& aCenter, float aTopInnerRadius,
                                float aBottomInnerRadius, float aSurfaceZ, float aDepth,
                                bool aIsFront );
    void backfillPostMachine();
    void load3DModels( CONTAINER_3D& aDstContainer, bool aSkipMaterialInformation, std::stop_token aStop = {} );
    void addPlaceholderToRaytracer( CONTAINER_3D& aDstContainer, const FOOTPRINT* aFootprint,
                                    const glm::mat4& aFpMatrix, bool aHasExtrudedBody = false, float aOpacity = 1.0f );
    bool addExtrudedBodyToRaytracer( CONTAINER_3D& aDstContainer, const FOOTPRINT* aFootprint );
    void addModels( CONTAINER_3D& aDstContainer, const S3DMODEL* a3DModel,
                    const glm::mat4& aModelMatrix, float aFPOpacity,
                    bool aSkipMaterialInformation, BOARD_ITEM* aBoardItem );
 
    MODEL_MATERIALS* getModelMaterial( const S3DMODEL* a3DModel );
 
    void initializeBlockPositions();
 
    void render( uint8_t* ptrPBO );
    void renderPreview( uint8_t* ptrPBO );
 
    static SFVEC4F premultiplyAlpha( const SFVEC4F& aInput );
 
    struct
    {
        BLINN_PHONG_MATERIAL m_Paste;
        BLINN_PHONG_MATERIAL m_SilkS;
        BLINN_PHONG_MATERIAL m_SolderMask;
        BLINN_PHONG_MATERIAL m_EpoxyBoard;
        BLINN_PHONG_MATERIAL m_Copper;
        BLINN_PHONG_MATERIAL m_NonPlatedCopper;
        BLINN_PHONG_MATERIAL m_Floor;
    } m_materials;
 
    std::vector<std::unique_ptr<BLINN_PHONG_MATERIAL>> m_extrusionMaterials;
 
    BOARD_NORMAL         m_boardMaterial;
    COPPER_NORMAL        m_copperMaterial;
    PLATED_COPPER_NORMAL m_platedCopperMaterial;
    SOLDER_MASK_NORMAL   m_solderMaskMaterial;
    PLASTIC_NORMAL       m_plasticMaterial;
    PLASTIC_SHINE_NORMAL m_shinyPlasticMaterial;
    BRUSHED_METAL_NORMAL m_brushedMetalMaterial;
    SILK_SCREEN_NORMAL   m_silkScreenMaterial;
 
    bool m_is_canvas_initialized;
    bool m_isPreview;

    RT_RENDER_STATE m_renderState;

    int64_t m_renderStartTime;

    size_t m_blockRenderProgressCount;
 
    POST_SHADER_SSAO m_postShaderSsao;
 
    std::list<LIGHT*> m_lights;
 
    DIRECTIONAL_LIGHT* m_cameraLight;
 
    /*GLuint m_pboId;
    GLuint m_pboDataSize;*/
 
    CONTAINER_3D m_objectContainer;

    CONTAINER_2D m_containerWithObjectsToDelete;
 
    CONTAINER_2D* m_outlineBoard2dObjects;
    BVH_CONTAINER_2D* m_antioutlineBoard2dObjects;
 
    std::unique_ptr<ACCELERATOR_3D> m_accelerator;

    std::mutex m_hitTestMutex;
 
    SFVEC4F m_backgroundColorTop;
    SFVEC4F m_backgroundColorBottom;

    wxSize m_oldWindowsSize;

    std::vector< SFVEC2UI > m_blockPositions;

    std::vector< int > m_blockPositionsWasProcessed;

    std::vector< SFVEC2UI > m_blockPositionsFast;
 
    SFVEC2UI m_realBufferSize;
    SFVEC2UI m_fastPreviewModeSize;
 
    HITINFO_PACKET* m_firstHitinfo;
 
    SFVEC3F* m_shaderBuffer;
 
    // Display Offset
    unsigned int m_xoffset;
    unsigned int m_yoffset;

    MAP_MODEL_MATERIALS m_modelMaterialMap;
 
    // Statistics
    unsigned int m_convertedDummyBlockCount;
    unsigned int m_converted2dRoundSegmentCount;
};
 
#define USE_SRGB_SPACE
 
#ifdef USE_SRGB_SPACE
extern SFVEC3F ConvertSRGBToLinear( const SFVEC3F& aSRGBcolor );
extern SFVEC4F ConvertSRGBAToLinear( const SFVEC4F& aSRGBAcolor );
#else
#define ConvertSRGBToLinear( v ) ( v )
#define ConvertSRGBAToLinear( v ) ( v )
#endif
 
#endif // RENDER_3D_RAYTRACE_BASE_H