3d_model.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Oleg Endo <[email protected]>
 * Copyright (C) 2015-2016 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 _MODEL_3D_H_
#define _MODEL_3D_H_
 
#include <kicad_gl/kiglad.h> // Must be included first
 
#include <memory>
#include <mutex>
#include <vector>
#include <plugins/3dapi/c3dmodel.h>
#include "../raytracing/shapes3D/bbox_3d.h"
#include <3d_enums.h>
 
#include <wx/chartype.h>
 
class MODEL_3D
{
public:
    MODEL_3D( const S3DMODEL& a3DModel, MATERIAL_MODE aMaterialMode );
 
    ~MODEL_3D();

    void DrawOpaque( bool aUseSelectedMaterial, SFVEC3F aSelectionColor = SFVEC3F( 0.0f ) ) const
    {
        Draw( false, 1.0f, aUseSelectedMaterial, aSelectionColor, nullptr, nullptr );
    }

    void DrawTransparent( float aOpacity, bool aUseSelectedMaterial,
                          SFVEC3F aSelectionColor = SFVEC3F( 0.0f ) ) const
    {
        Draw( true, aOpacity, aUseSelectedMaterial, aSelectionColor, nullptr, nullptr );
    }

    void Draw( bool aTransparent, float aOpacity, bool aUseSelectedMaterial,
               const SFVEC3F& aSelectionColor,
               const glm::mat4 *aModelWorldMatrix,
               const SFVEC3F *aCameraWorldPos ) const;

    bool HasOpaqueMeshes() const { return m_have_opaque_meshes; }

    bool HasTransparentMeshes() const { return m_have_transparent_meshes; }

    void DrawBbox() const;

    void DrawBboxes() const;

    const BBOX_3D& GetBBox() const { return m_model_bbox; }

    static void BeginDrawMulti( bool aUseColorInformation );

    static void EndDrawMulti();
 
private:
    static const wxChar* m_logTrace;
 
    // the material mode that was used to generate the rendering data.
    // FIXME: this can be selected at run-time and does not require re-creation
    //        of the whole model objects.
    MATERIAL_MODE m_materialMode;
 
    BBOX_3D   m_model_bbox;               
    std::vector<BBOX_3D> m_meshes_bbox;   
 
    // unified vertex format for mesh rendering.
    struct VERTEX
    {
        glm::vec3   m_pos;
        glm::u8vec4 m_nrm;        // only 3 components used
        glm::u8vec4 m_color;      // regular color
        glm::u8vec4 m_cad_color;  // "CAD" mode rendering color
        glm::vec2   m_tex_uv;
    };
 
    // vertex buffer and index buffers that include all the individual meshes
    // lumped together.
    GLuint m_vertex_buffer = 0;
    GLuint m_index_buffer = 0;
    GLenum m_index_buffer_type = GL_INVALID_ENUM;
 
    // internal material definition
    // all meshes are grouped by material for rendering purposes.
    struct MATERIAL : SMATERIAL
    {
        unsigned int m_render_idx_buffer_offset = 0;
        unsigned int m_render_idx_count = 0;
 
        BBOX_3D m_bbox; 
 
        MATERIAL( const SMATERIAL& aOther ) : SMATERIAL( aOther ) { }
        bool IsTransparent() const { return m_Transparency > FLT_EPSILON; }
    };
 
    std::vector<MATERIAL> m_materials;
 
    // a model can consist of transparent and opaque parts.  remember which
    // ones are present during initial buffer and data setup.  use it later
    // during rendering.
    bool m_have_opaque_meshes = false;
    bool m_have_transparent_meshes = false;
 
    // vertex buffer and index buffer for the bounding boxes.
    // the first box is always the outer box, followed by inner boxes (one for each mesh).
    static constexpr unsigned int bbox_vtx_count = 8;
    static constexpr unsigned int bbox_idx_count = 24;
 
    GLuint m_bbox_vertex_buffer = 0;
    GLuint m_bbox_index_buffer = 0;
    GLenum m_bbox_index_buffer_type = GL_INVALID_ENUM;
 
    static void MakeBbox( const BBOX_3D& aBox, unsigned int aIdxOffset, VERTEX* aVtxOut,
                          GLuint* aIdxOut, const glm::vec4& aColor );
};
 

class MODEL_3D_DEFERRED
{
public:
    MODEL_3D_DEFERRED( const S3DMODEL& a3DModel, MATERIAL_MODE aMaterialMode ) :
            m_s3dModel( std::make_shared<S3DMODEL>( a3DModel ) ),
            m_materialNode( aMaterialMode )
    {
    }
 
    ~MODEL_3D_DEFERRED() {}
 
    void Reset()
    {
        std::lock_guard<std::recursive_mutex> lock( m_mutex );
 
        m_openglModel3D.reset();
        m_s3dModel.reset();
    }
 
    std::shared_ptr<MODEL_3D> MakeOrGet()
    {
        std::lock_guard<std::recursive_mutex> lock( m_mutex );
 
        if( !m_openglModel3D && !m_s3dModel )
            throw std::runtime_error( "Both OpenGL model and S3D model are null" );
 
        if( !m_openglModel3D )
            m_openglModel3D = std::make_shared<MODEL_3D>( *m_s3dModel, m_materialNode );
 
        m_s3dModel.reset();
 
        return m_openglModel3D;
    }
 
private:
    std::shared_ptr<MODEL_3D> m_openglModel3D;
    std::recursive_mutex      m_mutex;
 
    std::shared_ptr<S3DMODEL> m_s3dModel;
    MATERIAL_MODE             m_materialNode;
};
 
#endif // _MODEL_3D_H_