rendering_engine::Model Class Reference

Represents a 3D model composed of multiple meshes and materials. More...

#include <model.hpp>

Public Member Functions
	Model (const std::string &filename, bool flipUVs=false)
	Constructs a model from a file. More...
	Model (std::vector< uint8_t > const &fileBytes, bool flipUVs=false)
	Constructs a model from an in-memory file buffer. More...
	Model (const Model &)=default
Model &	operator= (const Model &)=default
	Model (Model &&)=default
Model &	operator= (Model &&)=default
	~Model ()=default
bool	HasMeshes () const
	Checks whether this model contains any meshes. More...
bool	HasMaterials () const
	Checks whether this model contains any materials. More...
const std::vector< std::shared_ptr< Mesh > > &	Meshes () const
	Returns the list of meshes belonging to this model. More...
const std::vector< std::shared_ptr< ModelMaterial > > &	Materials () const
	Returns the list of materials belonging to this model. More...

Friends
class	Mesh

Detailed Description

Represents a 3D model composed of multiple meshes and materials.

The Model class serves as an intermediate container between the model-loading backend (e.g., Assimp) and GPU-side mesh upload (via MeshDataGpu). It holds all meshes and materials associated with a 3D model file, typically loaded from formats such as FBX, OBJ, or glTF.

Each imported model can contain multiple meshes and materials, all of which are accessible through this class for further processing or rendering.

Note

This class does not perform rendering. It only stores CPU-side mesh and material data for later GPU upload.

See also

Mesh, ModelMaterial, MeshDataGpu

Definition at line 29 of file model.hpp.

Constructor & Destructor Documentation

Model() [1/4]

rendering_engine::Model::Model ( const std::string &  filename, bool  flipUVs = false  )

explicit

Constructs a model from a file.

The model loader uses Assimp internally to parse the file and build Mesh and ModelMaterial instances. Optionally, UV coordinates can be flipped vertically during import.

Parameters

filename	Path to the model file (e.g., .obj, .fbx, .gltf).
flipUVs	Whether to flip UV coordinates vertically (useful for texture alignment).

Definition at line 10 of file model.cpp.

{
    Assimp::Importer importer;
 
    uint32_t flags = aiProcess_Triangulate | aiProcess_JoinIdenticalVertices | aiProcess_SortByPType;
    if( flipUVs )
    {
        flags |= aiProcess_FlipUVs;
    }
 
    const aiScene* scene = importer.ReadFile(filename, flags);
 
    if( scene == nullptr )
    {
        throw std::runtime_error(importer.GetErrorString());
    }
 
    if( scene->HasMaterials() )
    {
        for( uint32_t i = 0; i < scene->mNumMaterials; i++ )
        {
            mMaterials.push_back(std::shared_ptr<ModelMaterial>(new ModelMaterial(*this, *scene->mMaterials[i])));
        }
    }
 
    if( scene->HasMeshes() )
    {
        for( uint32_t i = 0; i < scene->mNumMeshes; i++ )
        {
            mMeshes.push_back(std::shared_ptr<Mesh>(new Mesh(*this, *(scene->mMeshes[i]))));
        }
    }
}

Model() [2/4]

rendering_engine::Model::Model ( std::vector< uint8_t > const &  fileBytes, bool  flipUVs = false  )

explicit

Constructs a model from an in-memory file buffer.

This constructor allows importing a 3D model directly from raw file bytes stored in memory rather than from disk.

The import process creates Mesh and ModelMaterial instances exactly the same way as the file-based constructor.

Parameters

fileBytes	Raw contents of a model file (the full encoded file).
flipUVs	Whether to flip UV coordinates vertically during import. This matches the behavior of the file-based constructor.

Exceptions

std::runtime_error

If Assimp fails to load the model.

Definition at line 43 of file model.cpp.

{
    Assimp::Importer importer;
 
    uint32_t flags = aiProcess_Triangulate | aiProcess_JoinIdenticalVertices | aiProcess_SortByPType;
    if (flipUVs)
    {
        flags |= aiProcess_FlipUVs;
    }
 
    const aiScene* scene = importer.ReadFileFromMemory(fileBytes.data(), fileBytes.size(), flags, "fbx");
 
    if (scene == nullptr)
    {
        throw std::runtime_error(importer.GetErrorString());
    }
    
    if (scene->HasMaterials())
    {
        for (uint32_t i = 0; i < scene->mNumMaterials; i++)
        {
            mMaterials.push_back(std::shared_ptr<ModelMaterial>(new ModelMaterial(*this, *scene->mMaterials[i])));
        }
    }
 
    if (scene->HasMeshes())
    {
        for (uint32_t i = 0; i < scene->mNumMeshes; i++)
        {
            mMeshes.push_back(std::shared_ptr<Mesh>(new Mesh(*this, *(scene->mMeshes[i]))));
        }
    }
}

Model() [3/4]

rendering_engine::Model::Model ( const Model &  )

default

Model() [4/4]

rendering_engine::Model::Model ( Model &&  )

default

~Model()

rendering_engine::Model::~Model ( )

default

Member Function Documentation

HasMaterials()

bool rendering_engine::Model::HasMaterials

(

)

const

Checks whether this model contains any materials.

Returns

True if at least one material was loaded; false otherwise.

Definition at line 80 of file model.cpp.

{
    return !mMaterials.empty();
}

HasMeshes()

bool rendering_engine::Model::HasMeshes

(

)

const

Checks whether this model contains any meshes.

Returns

True if at least one mesh was loaded; false otherwise.

Definition at line 76 of file model.cpp.

{
    return !mMeshes.empty();
}

Materials()

const std::vector< std::shared_ptr< ModelMaterial > > & rendering_engine::Model::Materials

(

)

const

Returns the list of materials belonging to this model.

Returns

Vector of shared pointers to ModelMaterial objects.

Definition at line 88 of file model.cpp.

{
    return mMaterials;
}

Meshes()

const std::vector< std::shared_ptr< Mesh > > & rendering_engine::Model::Meshes

(

)

const

Returns the list of meshes belonging to this model.

Returns

Vector of shared pointers to Mesh objects.

Definition at line 84 of file model.cpp.

{
    return mMeshes;
}

operator=() [1/2]

Model & rendering_engine::Model::operator= ( const Model &  )

default

operator=() [2/2]

Model & rendering_engine::Model::operator= ( Model &&  )

default

Friends And Related Function Documentation

Mesh

friend class Mesh

friend

Definition at line 31 of file model.hpp.

---

The documentation for this class was generated from the following files:

• model.hpp
• model.cpp