Mesh.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of Berserk Engine project                                    */
/* https://github.com/EgorOrachyov/Berserk                                        */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2018 - 2021 Egor Orachyov                                        */
/*                                                                                */
/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
/* of this software and associated documentation files (the "Software"), to deal  */
/* in the Software without restriction, including without limitation the rights   */
/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
/* copies of the Software, and to permit persons to whom the Software is          */
/* furnished to do so, subject to the following conditions:                       */
/*                                                                                */
/* The above copyright notice and this permission notice shall be included in all */
/* copies or substantial portions of the Software.                                */
/*                                                                                */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
/* SOFTWARE.                                                                      */
/**********************************************************************************/
 
#ifndef BERSERK_MESH_HPP
#define BERSERK_MESH_HPP
 
#include <core/Config.hpp>
#include <core/Typedefs.hpp>
#include <core/math/TAabb.hpp>
#include <core/templates/RefCnt.hpp>
 
#include <render/material/Material.hpp>
#include <render/mesh/MeshFormats.hpp>
 
#include <rhi/RHIBuffer.hpp>
#include <rhi/RHIVertexDeclaration.hpp>
 
#include <unordered_map>
#include <vector>
 
BRK_NS_BEGIN
 
class SubMesh final : public RefCnt {
public:
    BRK_API SubMesh() = default;
    BRK_API ~SubMesh() override = default;
 
    BRK_API const StringName &GetName() const { return mName; }
 
    BRK_API const Ref<RHIIndexBuffer> &GetIndexBuffer() const { return mIndexBuffer; }
    BRK_API RHIPrimitivesType GetPrimitivesType() const { return mPrimitivesType; }
    BRK_API RHIIndexType GetIndexType() const { return mIndexType; }
    BRK_API const Aabbf &GetAabb() const { return mAabb; }
 
    BRK_API uint32 GetVerticesCount() const { return mVerticesCount; }
    BRK_API uint32 GetBaseVertex() const { return mBaseVertex; }
    BRK_API uint32 GetIndicesCount() const { return mIndicesCount; }
    BRK_API uint32 GetMaterialIndex() const { return mMaterialIndex; }
 
    BRK_API bool IsIndexed() const { return mIndexType != RHIIndexType::Unknown; }
 
private:
    friend class Mesh;
 
    StringName mName; 
    Ref<RHIIndexBuffer> mIndexBuffer;                                 
    RHIPrimitivesType mPrimitivesType = RHIPrimitivesType::Triangles; 
    RHIIndexType mIndexType = RHIIndexType::Unknown;                  
    Aabbf mAabb;                                                      
    uint32 mVerticesCount{};            
    uint32 mBaseVertex{};               
    uint32 mIndicesCount{};             
    uint32 mMaterialIndex = 0xffffffff; 
};
 
struct MeshArrays {
    const float *positions = nullptr;
    const float *normals = nullptr;
    const float *tangents = nullptr;
    const float *colors = nullptr;
    const float *uvs = nullptr;
    const float *uvs2 = nullptr;
    const float *weights = nullptr;
    const int32 *bones = nullptr;
};
 
class Mesh final : public RefCnt {
public:
    BRK_API Mesh(MeshFormat format, uint32 verticesCount, const Ref<Data> &vertexData, const Ref<Data> &attributeData, const Ref<Data> &skinningData);
 
    BRK_API Mesh(MeshFormat format, uint32 verticesCount, const MeshArrays &meshArrays);
 
    BRK_API ~Mesh() override = default;
 
    BRK_API void SetName(StringName name);
    BRK_API void SetAabb(const Aabbf &aabb);
 
    BRK_API void AddMaterial(Ref<Material> material);
 
    BRK_API void AddSubMesh(const StringName &name, RHIPrimitivesType primitivesType, const Aabbf &aabb, uint32 baseVertex, RHIIndexType indexType, uint32 indicesCount, const Ref<Data> &indexData);
 
    BRK_API void SetSubMeshMaterial(const StringName &name, uint32 index);
 
    BRK_API Ref<const SubMesh> FindSubMesh(const StringName &name) const;
 
    BRK_API const StringName &GetName() const { return mName; }
    BRK_API const MeshFormat &GetFormat() const { return mFormat; }
    BRK_API const Aabbf &GetAabb() const { return mAabb; }
 
    BRK_API const std::vector<Ref<Material>> &GetMaterials() const { return mMaterials; }
    BRK_API const std::vector<Ref<SubMesh>> &GetSubMeshes() const { return mSubMeshes; }
    BRK_API const std::unordered_map<StringName, uint32> &GetSubMeshLookUp() const { return mSubMeshLookUp; }
 
    BRK_API uint32 GetVerticesCount() const { return mVerticesCount; }
 
    BRK_API const Ref<RHIVertexBuffer> &GetVertexData() const { return mVertexData; }
    BRK_API const Ref<RHIVertexBuffer> &GetAttributeData() const { return mAttributeData; }
    BRK_API const Ref<RHIVertexBuffer> &GetSkinningData() const { return mSkinningData; }
 
    BRK_API const Ref<RHIVertexDeclaration> &GetDeclaration() const { return mDeclaration; }
 
    BRK_API bool HasVertexData() const { return mVertexData.IsNotNull(); }
    BRK_API bool HasAttributeData() const { return mAttributeData.IsNotNull(); }
    BRK_API bool HasSkinningData() const { return mSkinningData.IsNotNull(); }
 
private:
    void InitFromData(MeshFormat format, uint32 verticesCount, const Ref<Data> &vertexData, const Ref<Data> &attributeData, const Ref<Data> &skinningData);
 
private:
    StringName mName;   
    MeshFormat mFormat; 
    Aabbf mAabb;        
    std::vector<Ref<Material>> mMaterials;                 
    std::vector<Ref<SubMesh>> mSubMeshes;                  
    std::unordered_map<StringName, uint32> mSubMeshLookUp; 
    uint32 mVerticesCount = 0; 
    Ref<RHIVertexBuffer> mVertexData;    
    Ref<RHIVertexBuffer> mAttributeData; 
    Ref<RHIVertexBuffer> mSkinningData;  
    Ref<RHIVertexDeclaration> mDeclaration; 
};
 
BRK_NS_END
 
#endif//BERSERK_MESH_HPP