model_viewer::material::MTLMaterial Class Reference

Class representing a material parsed from an MTL file. More...

#include <Material.hpp>

Inheritance diagram for model_viewer::material::MTLMaterial:

Collaboration diagram for model_viewer::material::MTLMaterial:

Signals
void	KdChanged ()
	Signal emitted when the diffuse color changes.
void	illuminationChanged ()
	Signal emitted when the illumination model changes.
void	dChanged ()
	Signal emitted when the opacity changes.
void	NsChanged ()
	Signal emitted when the specular roughness changes.
void	sharpnessChanged ()
	Signal emitted when the sharpness changes.
void	NiChanged ()
	Signal emitted when the index of refraction changes.
void	metalnessChanged ()
	Signal emitted when the metalness changes.
void	roughnessChanged ()
	Signal emitted when the roughness changes.
void	bumpStrengthChanged ()
	Signal emitted when the bump strength changes.
void	diffuseMapChanged ()
	Signal emitted when the diffuse map changes.
void	specularReflectionMapChanged ()
	Signal emitted when the specular reflection map changes.
void	specularMapChanged ()
	Signal emitted when the specular map changes.
void	emissiveMapChanged ()
	Signal emitted when the emissive map changes.
void	dissolveMapChanged ()
	Signal emitted when the dissolve map changes.
void	bumpMapChanged ()
	Signal emitted when the bump map changes.

Public Member Functions
	MTLMaterial (QObject *parent=nullptr)
	Constructor.
	~MTLMaterial () override=default
	Destructor.
void	parseMTL (const std::string &filepath)
	Parse an MTL file and set the material properties.
void	resetMaterial ()
	Reset the material to default values.
const QUrl &	getAmbientMap () const
	Get the Ambient Map URL.
const QUrl &	getDiffuseMap () const
	Get the Diffuse Map URL.
const QUrl &	getSpecularReflectionMap () const
	Get the Specular Reflection Map URL.
const QUrl &	getSpecularMap () const
	Get the Specular Map URL.
const QUrl &	getEmissiveMap () const
	Get the Emissive Map URL.
const QUrl &	getDissolveMap () const
	Get the Dissolve Map URL.
const QUrl &	getBumpMap () const
	Get the Bump/Normal Map URL.
const QUrl &	getDecalMap () const
	Get the Decal Map URL.
const QUrl &	getDispersionMap () const
	Get the Dispersion Map URL.

Properties
QColor	diffuseColor
qreal	illumination
qreal	metalness
qreal	roughness
qreal	bumpStrength
qreal	opacity
qreal	indexOfRefraction
QUrl	diffuseMap
QUrl	specularReflectionMap
QUrl	specularMap
QUrl	emissiveMap
QUrl	dissolveMap
QUrl	bumpMap

Private Member Functions
void	parseMaterial (std::ifstream &file)
	Parse the MTL file line by line.
void	setMaterialValues ()
	Apply parsed values to the material properties.
void	parseScalar (const std::string &line, const std::string &key)
	Parse a scalar value from an MTL line.
void	parseColor (const std::string &line, const std::string &key)
	Parse a color value from an MTL line.
void	parseMap (const std::string &line, const std::string &key)
	Parse a texture map from an MTL line.

Private Attributes
std::filesystem::path	_parentPath
	Parent path of the MTL file.
QColor	_Ka
	Ambient Color.
QColor	_Kd
	Diffuse Color.
QColor	_Ks
	Specular Color.
QColor	_Ke
	Emissive Color.
QColor	_Tf
	Transmission Filter.
qreal	_illumination
	Illumination Model.
qreal	_d
	Opacity.
qreal	_Ns
	Specular Roughness.
qreal	_sharpness
	Sharpness.
qreal	_Ni
	Index of Refraction.
qreal	_metalness = 0.0
	Metalness.
qreal	_roughness = 0.0
	Roughness.
qreal	_bumpStrength = 0.0
	Bump/Normal Strength.
QUrl	_ambientMap
	Path to the Ambient Map.
QUrl	_diffuseMap
	Path to the Diffuse Map.
QUrl	_specularReflectionMap
	Path to the Specular Reflection Map.
QUrl	_specularMap
	Path to the Specular Map.
QUrl	_emissiveMap
	Path to the Emissive Map.
QUrl	_dissolveMap
	Path to the Dissolve Map.
QUrl	_bumpMap
	Path to the Bump/Normal Map.
QUrl	_decalMap
	Path to the Decal Map.
QUrl	_dispersionMap
	Path to the Dispersion Map.
std::unordered_map< std::string, qreal >	_scalars
	Maps to store parsed values before applying them.
std::unordered_map< std::string, QColor >	_colors
	Maps to store parsed colors before applying them.
std::unordered_map< std::string, QUrl >	_maps
	Maps to store parsed texture maps before applying them.
std::unordered_map< std::string, std::function< void(const std::string &, const std::string &)> >	_parseFunctions
	Map of parsing functions for different MTL line prefixes.

Detailed Description

Class representing a material parsed from an MTL file.

Todo

Seek ways to improve this class' architecture

Constructor & Destructor Documentation

MTLMaterial()

model_viewer::material::MTLMaterial::MTLMaterial ( QObject * parent = nullptr )

explicit

Constructor.

Parameters

parent

Parent QObject, nullptr by default

                                        : QObject(parent) {
    _parseFunctions = {
        {"Ka", [this](const std::string &l,
                      const std::string &k) { parseColor(l, k); }},
        {"Kd", [this](const std::string &l,
                      const std::string &k) { parseColor(l, k); }},
        {"Ks", [this](const std::string &l,
                      const std::string &k) { parseColor(l, k); }},
        {"Ke", [this](const std::string &l,
                      const std::string &k) { parseColor(l, k); }},
        {"Tf", [this](const std::string &l,
                      const std::string &k) { parseColor(l, k); }},
        {"illum", [this](const std::string &l,
                         const std::string &k) { parseScalar(l, k); }},
        {"d", [this](const std::string &l,
                     const std::string &k) { parseScalar(l, k); }},
        {"sharpness", [this](const std::string &l,
                             const std::string &k) { parseScalar(l, k); }},
        {"Ni", [this](const std::string &l,
                      const std::string &k) { parseScalar(l, k); }},
        {"map_Ka", [this](const std::string &l,
                          const std::string &k) { parseMap(l, k); }},
        {"map_Kd", [this](const std::string &l,
                          const std::string &k) { parseMap(l, k); }},
        {"map_Ks", [this](const std::string &l,
                          const std::string &k) { parseMap(l, k); }},
        {"map_Ns", [this](const std::string &l,
                          const std::string &k) { parseMap(l, k); }},
        {"map_Ke", [this](const std::string &l,
                          const std::string &k) { parseMap(l, k); }},
        {"bump", [this](const std::string &l,
                        const std::string &k) { parseMap(l, k); }},
        {"decal", [this](const std::string &l,
                         const std::string &k) { parseMap(l, k); }},
        {"disp", [this](const std::string &l,
                        const std::string &k) { parseMap(l, k); }},
    };
}

References _parseFunctions, parseColor(), parseMap(), and parseScalar().

Here is the call graph for this function:

~MTLMaterial()

model_viewer::material::MTLMaterial::~MTLMaterial ( )

overridedefault

Destructor.

Member Function Documentation

bumpMapChanged

void model_viewer::material::MTLMaterial::bumpMapChanged ( )

signal

Signal emitted when the bump map changes.

bumpStrengthChanged

void model_viewer::material::MTLMaterial::bumpStrengthChanged ( )

signal

Signal emitted when the bump strength changes.

dChanged

void model_viewer::material::MTLMaterial::dChanged ( )

signal

Signal emitted when the opacity changes.

diffuseMapChanged

void model_viewer::material::MTLMaterial::diffuseMapChanged ( )

signal

Signal emitted when the diffuse map changes.

dissolveMapChanged

void model_viewer::material::MTLMaterial::dissolveMapChanged ( )

signal

Signal emitted when the dissolve map changes.

emissiveMapChanged

void model_viewer::material::MTLMaterial::emissiveMapChanged ( )

signal

Signal emitted when the emissive map changes.

getAmbientMap()

const QUrl & model_viewer::material::MTLMaterial::getAmbientMap ( ) const

inline

Get the Ambient Map URL.

Returns

Ambient Map URL

{ return _ambientMap; };

References _ambientMap.

getBumpMap()

const QUrl & model_viewer::material::MTLMaterial::getBumpMap ( ) const

inline

Get the Bump/Normal Map URL.

Returns

Bump/Normal Map URL

{ return _bumpMap; };

References _bumpMap.

getDecalMap()

const QUrl & model_viewer::material::MTLMaterial::getDecalMap ( ) const

inline

Get the Decal Map URL.

Returns

Decal Map URL

{ return _decalMap; };

References _decalMap.

getDiffuseMap()

const QUrl & model_viewer::material::MTLMaterial::getDiffuseMap ( ) const

inline

Get the Diffuse Map URL.

Returns

Diffuse Map URL

{ return _diffuseMap; };

References _diffuseMap.

getDispersionMap()

const QUrl & model_viewer::material::MTLMaterial::getDispersionMap ( ) const

inline

Get the Dispersion Map URL.

Returns

Dispersion Map URL

{ return _dispersionMap; };

References _dispersionMap.

getDissolveMap()

const QUrl & model_viewer::material::MTLMaterial::getDissolveMap ( ) const

inline

Get the Dissolve Map URL.

Returns

Dissolve Map URL

{ return _dissolveMap; };

References _dissolveMap.

getEmissiveMap()

const QUrl & model_viewer::material::MTLMaterial::getEmissiveMap ( ) const

inline

Get the Emissive Map URL.

Returns

Emissive Map URL

{ return _emissiveMap; };

References _emissiveMap.

getSpecularMap()

const QUrl & model_viewer::material::MTLMaterial::getSpecularMap ( ) const

inline

Get the Specular Map URL.

Returns

Specular Map URL

{ return _specularMap; };

References _specularMap.

getSpecularReflectionMap()

const QUrl & model_viewer::material::MTLMaterial::getSpecularReflectionMap ( ) const

inline

Get the Specular Reflection Map URL.

Returns

Specular Reflection Map URL

                                                 {
        return _specularReflectionMap;
    };

References _specularReflectionMap.

illuminationChanged

void model_viewer::material::MTLMaterial::illuminationChanged ( )

signal

Signal emitted when the illumination model changes.

KdChanged

void model_viewer::material::MTLMaterial::KdChanged ( )

signal

Signal emitted when the diffuse color changes.

metalnessChanged

void model_viewer::material::MTLMaterial::metalnessChanged ( )

signal

Signal emitted when the metalness changes.

NiChanged

void model_viewer::material::MTLMaterial::NiChanged ( )

signal

Signal emitted when the index of refraction changes.

NsChanged

void model_viewer::material::MTLMaterial::NsChanged ( )

signal

Signal emitted when the specular roughness changes.

parseColor()

void model_viewer::material::MTLMaterial::parseColor ( const std::string & line, const std::string & key )

private

Parse a color value from an MTL line.

Parameters

line	Line to parse
key	Key of the color value

                                                                        {
    float r, g, b;
    const std::string lineTrimmed =
        string_helpers::trim_copy(line.substr(key.size() + 1));
    if (std::sscanf(lineTrimmed.c_str(), "%f %f %f", &r, &g, &b) < 3)
        std::cerr << "Invalid color at line " << line << std::endl;
    else
        _colors[key] = {static_cast<int>(r * 255), static_cast<int>(g * 255),
                        static_cast<int>(b * 255)};
}

References _colors, and model_viewer::string_helpers::trim_copy().

Referenced by MTLMaterial().

Here is the call graph for this function:

Here is the caller graph for this function:

parseMap()

void model_viewer::material::MTLMaterial::parseMap ( const std::string & line, const std::string & key )

private

Parse a texture map from an MTL line.

Parameters

line	Line to parse
key	Key of the texture map

                                                                      {
    const std::string map =
        string_helpers::trim_copy(line.substr(key.size() + 1));
    if (map.empty()) std::cerr << "Empty map at line " << line << std::endl;
    const std::string mapPath = (_parentPath / map).string();
    _maps[key] = QUrl::fromLocalFile(mapPath.c_str());
}

References _maps, _parentPath, and model_viewer::string_helpers::trim_copy().

Referenced by MTLMaterial().

Here is the call graph for this function:

Here is the caller graph for this function:

parseMaterial()

void model_viewer::material::MTLMaterial::parseMaterial ( std::ifstream & file )

private

Parse the MTL file line by line.

Parameters

file	Input file stream to parse

Todo

Optimize parsing of the material

                                                 {
    std::string line;
    while (std::getline(file, line)) {
        const auto pos = line.find(' ');
        const std::string lineStart =
            string_helpers::trim_copy(line.substr(0, pos));
        if (_parseFunctions.contains(lineStart))
            _parseFunctions.at(lineStart)(line, lineStart);
    }
}

References _parseFunctions, and model_viewer::string_helpers::trim_copy().

Referenced by parseMTL().

Here is the call graph for this function:

Here is the caller graph for this function:

parseMTL()

void model_viewer::material::MTLMaterial::parseMTL

(

const std::string &

filepath

)

Parse an MTL file and set the material properties.

Parameters

filepath

Path to the MTL file

                                                    {
    std::ifstream in(filepath);
    if (!in.is_open()) {
        std::cerr << "MTLMaterial: Could not open file " << filepath << ": "
                  << std::strerror(errno) << std::endl;
        return;
    }
    _parentPath = std::filesystem::path(filepath).parent_path();
    parseMaterial(in);
    setMaterialValues();
}

References _parentPath, parseMaterial(), and setMaterialValues().

Here is the call graph for this function:

parseScalar()

void model_viewer::material::MTLMaterial::parseScalar ( const std::string & line, const std::string & key )

private

Parse a scalar value from an MTL line.

Parameters

line	Line to parse
key	Key of the scalar value

                                                                         {
    float scalar;
    const std::string lineTrimmed =
        string_helpers::trim_copy(line.substr(key.size() + 1));
    if (std::sscanf(lineTrimmed.c_str(), "%f", &scalar) < 1)
        std::cerr << "Invalid scalar at line " << line << std::endl;
    else
        _scalars[key] = scalar;
}

References _scalars, and model_viewer::string_helpers::trim_copy().

Referenced by MTLMaterial().

Here is the call graph for this function:

Here is the caller graph for this function:

resetMaterial()

void model_viewer::material::MTLMaterial::resetMaterial

(

)

Reset the material to default values.

                                {
    _scalars.clear();
    _colors.clear();
    _maps.clear();
    _scalars["d"] = 1.0;
    _scalars["illum"] = 1.0;
    _colors["Kd"] = QColor(255, 255, 255);
    setMaterialValues();
}

References _colors, _maps, _scalars, and setMaterialValues().

Here is the call graph for this function:

roughnessChanged

void model_viewer::material::MTLMaterial::roughnessChanged ( )

signal

Signal emitted when the roughness changes.

setMaterialValues()

void model_viewer::material::MTLMaterial::setMaterialValues ( )

private

Apply parsed values to the material properties.

                                    {
    _Ka = _colors["Ka"];
    _Kd = _colors["Kd"];
    _Ks = _colors["Ks"];
    _Tf = _colors["Tf"];
    _Ke = _colors["ke"];
 
    _illumination = _scalars["illum"];
    _d = _scalars["d"];
    _Ns = _scalars["Ns"];
    _sharpness = _scalars["sharpness"];
    _Ni = _scalars["Ni"];
 
    _ambientMap = _maps["map_Ka"];
    _diffuseMap = _maps["map_Kd"];
    _specularReflectionMap = _maps["map_Ks"];
    _specularMap = _maps["map_Ns"];
    _emissiveMap = _maps["map_Ke"];
    _dissolveMap = _maps["map_d"];
    _bumpMap = _maps["bump"];
    _decalMap = _maps["decal"];
    _dispersionMap = _maps["disp"];
 
    _roughness = std::clamp(1.0 - std::pow(_Ns / 100.0, 0.25), 0.04, 1.0);
    _metalness =
        std::clamp((_Ks.red() + _Ks.green() + _Ks.blue()) / 3.0, 0.0, 1.0);
}

References _ambientMap, _bumpMap, _colors, _d, _decalMap, _diffuseMap, _dispersionMap, _dissolveMap, _emissiveMap, _illumination, _Ka, _Kd, _Ke, _Ks, _maps, _metalness, _Ni, _Ns, _roughness, _scalars, _sharpness, _specularMap, _specularReflectionMap, and _Tf.

Referenced by parseMTL(), and resetMaterial().

Here is the caller graph for this function:

sharpnessChanged

void model_viewer::material::MTLMaterial::sharpnessChanged ( )

signal

Signal emitted when the sharpness changes.

specularMapChanged

void model_viewer::material::MTLMaterial::specularMapChanged ( )

signal

Signal emitted when the specular map changes.

specularReflectionMapChanged

void model_viewer::material::MTLMaterial::specularReflectionMapChanged ( )

signal

Signal emitted when the specular reflection map changes.

Member Data Documentation

_ambientMap

QUrl model_viewer::material::MTLMaterial::_ambientMap

private

Path to the Ambient Map.

Referenced by getAmbientMap(), and setMaterialValues().

_bumpMap

QUrl model_viewer::material::MTLMaterial::_bumpMap

private

Path to the Bump/Normal Map.

Referenced by getBumpMap(), and setMaterialValues().

_bumpStrength

qreal model_viewer::material::MTLMaterial::_bumpStrength = 0.0

private

Bump/Normal Strength.

_colors

std::unordered_map<std::string, QColor> model_viewer::material::MTLMaterial::_colors

private

Maps to store parsed colors before applying them.

Referenced by parseColor(), resetMaterial(), and setMaterialValues().

_d

qreal model_viewer::material::MTLMaterial::_d

private

Opacity.

Referenced by setMaterialValues().

_decalMap

QUrl model_viewer::material::MTLMaterial::_decalMap

private

Path to the Decal Map.

Referenced by getDecalMap(), and setMaterialValues().

_diffuseMap

QUrl model_viewer::material::MTLMaterial::_diffuseMap

private

Path to the Diffuse Map.

Referenced by getDiffuseMap(), and setMaterialValues().

_dispersionMap

QUrl model_viewer::material::MTLMaterial::_dispersionMap

private

Path to the Dispersion Map.

Referenced by getDispersionMap(), and setMaterialValues().

_dissolveMap

QUrl model_viewer::material::MTLMaterial::_dissolveMap

private

Path to the Dissolve Map.

Referenced by getDissolveMap(), and setMaterialValues().

_emissiveMap

QUrl model_viewer::material::MTLMaterial::_emissiveMap

private

Path to the Emissive Map.

Referenced by getEmissiveMap(), and setMaterialValues().

_illumination

qreal model_viewer::material::MTLMaterial::_illumination

private

Illumination Model.

Referenced by setMaterialValues().

_Ka

QColor model_viewer::material::MTLMaterial::_Ka

private

Ambient Color.

Referenced by setMaterialValues().

_Kd

QColor model_viewer::material::MTLMaterial::_Kd

private

Diffuse Color.

Referenced by setMaterialValues().

_Ke

QColor model_viewer::material::MTLMaterial::_Ke

private

Emissive Color.

Referenced by setMaterialValues().

_Ks

QColor model_viewer::material::MTLMaterial::_Ks

private

Specular Color.

Referenced by setMaterialValues().

_maps

std::unordered_map<std::string, QUrl> model_viewer::material::MTLMaterial::_maps

private

Maps to store parsed texture maps before applying them.

Referenced by parseMap(), resetMaterial(), and setMaterialValues().

_metalness

qreal model_viewer::material::MTLMaterial::_metalness = 0.0

private

Metalness.

Referenced by setMaterialValues().

_Ni

qreal model_viewer::material::MTLMaterial::_Ni

private

Index of Refraction.

Referenced by setMaterialValues().

_Ns

qreal model_viewer::material::MTLMaterial::_Ns

private

Specular Roughness.

Referenced by setMaterialValues().

_parentPath

std::filesystem::path model_viewer::material::MTLMaterial::_parentPath

private

Parent path of the MTL file.

Referenced by parseMap(), and parseMTL().

_parseFunctions

std::unordered_map<std::string, std::function<void(const std::string &, const std::string &)> > model_viewer::material::MTLMaterial::_parseFunctions

private

Map of parsing functions for different MTL line prefixes.

Referenced by MTLMaterial(), and parseMaterial().

_roughness

qreal model_viewer::material::MTLMaterial::_roughness = 0.0

private

Roughness.

Referenced by setMaterialValues().

_scalars

std::unordered_map<std::string, qreal> model_viewer::material::MTLMaterial::_scalars

private

Maps to store parsed values before applying them.

Referenced by parseScalar(), resetMaterial(), and setMaterialValues().

_sharpness

qreal model_viewer::material::MTLMaterial::_sharpness

private

Sharpness.

Referenced by setMaterialValues().

_specularMap

QUrl model_viewer::material::MTLMaterial::_specularMap

private

Path to the Specular Map.

Referenced by getSpecularMap(), and setMaterialValues().

_specularReflectionMap

QUrl model_viewer::material::MTLMaterial::_specularReflectionMap

private

Path to the Specular Reflection Map.

Referenced by getSpecularReflectionMap(), and setMaterialValues().

_Tf

QColor model_viewer::material::MTLMaterial::_Tf

private

Transmission Filter.

Referenced by setMaterialValues().

Property Documentation

bumpMap

QUrl model_viewer::material::MTLMaterial::bumpMap

read

bumpStrength

qreal model_viewer::material::MTLMaterial::bumpStrength

diffuseColor

QColor model_viewer::material::MTLMaterial::diffuseColor

diffuseMap

QUrl model_viewer::material::MTLMaterial::diffuseMap

read

dissolveMap

QUrl model_viewer::material::MTLMaterial::dissolveMap

read

emissiveMap

QUrl model_viewer::material::MTLMaterial::emissiveMap

read

illumination

qreal model_viewer::material::MTLMaterial::illumination

indexOfRefraction

qreal model_viewer::material::MTLMaterial::indexOfRefraction

metalness

qreal model_viewer::material::MTLMaterial::metalness

opacity

qreal model_viewer::material::MTLMaterial::opacity

roughness

qreal model_viewer::material::MTLMaterial::roughness

specularMap

QUrl model_viewer::material::MTLMaterial::specularMap

read

specularReflectionMap

QUrl model_viewer::material::MTLMaterial::specularReflectionMap

read

---

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

• /github/workspace/include/Material/Material.hpp
• /github/workspace/src/Material/Material.cpp