Ignition Common

API Reference

4.1.0

This class contains Physically-Based-Rendering (PBR) workflow properties. More...

#include <Pbr.hh>

Public Member Functions

 Pbr ()
 Default constructor. More...
 
std::string AlbedoMap () const
 Get the albedo map filename. This will be an empty string if an albedo map has not been set. More...
 
std::string AmbientOcclusionMap () const
 Get the ambient occlusion map filename. This will be an empty string if an ambient occlusion map has not been set. More...
 
std::string EmissiveMap () const
 Get the emissive map filename. This will be an empty string if an emissive map has not been set. More...
 
std::string EnvironmentMap () const
 Get the environment map filename. This will be an empty string if an environment map has not been set. More...
 
double Glossiness () const
 Get the glossiness value of the material for specular workflow. More...
 
std::string GlossinessMap () const
 Get the glossiness map filename for specular workflow. This will be an empty string if a glossiness map has not been set. More...
 
std::string LightMap () const
 Get the light map filename. This will be an empty string if an light map has not been set. More...
 
unsigned int LightMapTexCoordSet () const
 Get the light map texture coordinate set. More...
 
double Metalness () const
 Get the metalness value of the material for metal workflow. More...
 
std::string MetalnessMap () const
 Get the metalness map filename for metal workflow. This will be an empty string if a metalness map has not been set. More...
 
std::string NormalMap () const
 Get the normal map filename. This will be an empty string if a normal map has not been set. More...
 
NormalMapSpace NormalMapType () const
 Get the normal map type, either tangent or object space. More...
 
bool operator!= (const Pbr &_pbr) const
 Return true this Pbr object does not contain the same values as the passed in parameter. More...
 
bool operator== (const Pbr &_pbr) const
 Return true if both Pbr objects contain the same values. More...
 
double Roughness () const
 Get the roughness value of the material for metal workflow. More...
 
std::string RoughnessMap () const
 Get the roughness map filename for metal workflow. This will be an empty string if a roughness map has not been set. More...
 
void SetAlbedoMap (const std::string &_map)
 Set the albedo map filename. More...
 
void SetAmbientOcclusionMap (const std::string &_map)
 Set the ambient occlusion map filename. More...
 
void SetEmissiveMap (const std::string &_map)
 Set the emissive map filename. More...
 
void SetEnvironmentMap (const std::string &_map)
 Set the environment map filename. More...
 
void SetGlossiness (double _value)
 Set the glossiness value of the material for specular workflow. More...
 
void SetGlossinessMap (const std::string &_map)
 Set the glossiness map filename for specular workflow. More...
 
void SetLightMap (const std::string &_map, unsigned int _uvSet=0u)
 Set the light map filename. More...
 
void SetMetalness (double _value)
 Set the metalness value of the material for metal workflow. More...
 
void SetMetalnessMap (const std::string &_map)
 Set the metalness map filename for metal workflow. More...
 
void SetNormalMap (const std::string &_map, NormalMapSpace _space=NormalMapSpace::TANGENT)
 Set the normal map filename. More...
 
void SetRoughness (double _value)
 Set the roughness value of the material for metal workflow. More...
 
void SetRoughnessMap (const std::string &_map)
 Set the roughness map filename for metal workflow. More...
 
void SetSpecularMap (const std::string &_map)
 Set the specular map filename for specular workflow. More...
 
void SetType (PbrType _type)
 Set the PBR workflow to use. More...
 
std::string SpecularMap () const
 Get the specular map filename for specular workflow. This will be an empty string if a specular map has not been set. More...
 
PbrType Type () const
 Get the workflow type. More...
 

Detailed Description

This class contains Physically-Based-Rendering (PBR) workflow properties.

Constructor & Destructor Documentation

◆ Pbr()

Pbr ( )

Default constructor.

Member Function Documentation

◆ AlbedoMap()

std::string AlbedoMap ( ) const

Get the albedo map filename. This will be an empty string if an albedo map has not been set.

Returns
Filename of the albedo map, or empty string if an albedo map has not been specified.

◆ AmbientOcclusionMap()

std::string AmbientOcclusionMap ( ) const

Get the ambient occlusion map filename. This will be an empty string if an ambient occlusion map has not been set.

Returns
Filename of the ambient occlusion map, or empty string if an ambient occlusion map has not been specified.

◆ EmissiveMap()

std::string EmissiveMap ( ) const

Get the emissive map filename. This will be an empty string if an emissive map has not been set.

Returns
Filename of the emissive map, or empty string if an emissive map has not been specified.

◆ EnvironmentMap()

std::string EnvironmentMap ( ) const

Get the environment map filename. This will be an empty string if an environment map has not been set.

Returns
Filename of the environment map, or empty string if an environment map has not been specified.

◆ Glossiness()

double Glossiness ( ) const

Get the glossiness value of the material for specular workflow.

Returns
Glossiness value of the material

◆ GlossinessMap()

std::string GlossinessMap ( ) const

Get the glossiness map filename for specular workflow. This will be an empty string if a glossiness map has not been set.

Returns
Filename of the glossiness map, or empty string if a glossiness map has not been specified.

◆ LightMap()

std::string LightMap ( ) const

Get the light map filename. This will be an empty string if an light map has not been set.

Returns
Filename of the light map, or empty string if a light map has not been specified.

◆ LightMapTexCoordSet()

unsigned int LightMapTexCoordSet ( ) const

Get the light map texture coordinate set.

Returns
Index of the light map texture coordinate set

◆ Metalness()

double Metalness ( ) const

Get the metalness value of the material for metal workflow.

Returns
metalness value of the material

◆ MetalnessMap()

std::string MetalnessMap ( ) const

Get the metalness map filename for metal workflow. This will be an empty string if a metalness map has not been set.

Returns
Filename of the metalness map, or empty string if a metalness map has not been specified.

◆ NormalMap()

std::string NormalMap ( ) const

Get the normal map filename. This will be an empty string if a normal map has not been set.

Returns
Filename of the normal map, or empty string if a normal map has not been specified.

◆ NormalMapType()

NormalMapSpace NormalMapType ( ) const

Get the normal map type, either tangent or object space.

Returns
Space that the normal map is defined in

◆ operator!=()

bool operator!= ( const Pbr _pbr) const

Return true this Pbr object does not contain the same values as the passed in parameter.

Parameters

◆ operator==()

bool operator== ( const Pbr _pbr) const

Return true if both Pbr objects contain the same values.

Parameters

◆ Roughness()

double Roughness ( ) const

Get the roughness value of the material for metal workflow.

Returns
roughness value of the material

◆ RoughnessMap()

std::string RoughnessMap ( ) const

Get the roughness map filename for metal workflow. This will be an empty string if a roughness map has not been set.

Returns
Filename of the roughness map, or empty string if a roughness map has not been specified.

◆ SetAlbedoMap()

void SetAlbedoMap ( const std::string _map)

Set the albedo map filename.

Parameters
[in]_mapFilename of the albedo map.

◆ SetAmbientOcclusionMap()

void SetAmbientOcclusionMap ( const std::string _map)

Set the ambient occlusion map filename.

Parameters
[in]_mapFilename of the ambient occlusion map.

◆ SetEmissiveMap()

void SetEmissiveMap ( const std::string _map)

Set the emissive map filename.

Parameters
[in]_mapFilename of the emissive map.

◆ SetEnvironmentMap()

void SetEnvironmentMap ( const std::string _map)

Set the environment map filename.

Parameters
[in]_mapFilename of the environment map.

◆ SetGlossiness()

void SetGlossiness ( double  _value)

Set the glossiness value of the material for specular workflow.

Parameters
[in]_valueGlossiness value.

◆ SetGlossinessMap()

void SetGlossinessMap ( const std::string _map)

Set the glossiness map filename for specular workflow.

Parameters
[in]_mapFilename of the glossiness map.

◆ SetLightMap()

void SetLightMap ( const std::string _map,
unsigned int  _uvSet = 0u 
)

Set the light map filename.

Parameters
[in]_mapFilename of the light map.
[in]_uvSetIndex of the texture coordinate set

◆ SetMetalness()

void SetMetalness ( double  _value)

Set the metalness value of the material for metal workflow.

Parameters
[in]_valueMetalness value.

◆ SetMetalnessMap()

void SetMetalnessMap ( const std::string _map)

Set the metalness map filename for metal workflow.

Parameters
[in]_mapFilename of the metalness map.

◆ SetNormalMap()

void SetNormalMap ( const std::string _map,
NormalMapSpace  _space = NormalMapSpace::TANGENT 
)

Set the normal map filename.

Parameters
[in]_mapFilename of the normal map.
[in]_spaceSpace that the normal map is defined in. Defaults to tangent space.

◆ SetRoughness()

void SetRoughness ( double  _value)

Set the roughness value of the material for metal workflow.

Parameters
[in]_valueRoughness value.

◆ SetRoughnessMap()

void SetRoughnessMap ( const std::string _map)

Set the roughness map filename for metal workflow.

Parameters
[in]_mapFilename of the roughness map.

◆ SetSpecularMap()

void SetSpecularMap ( const std::string _map)

Set the specular map filename for specular workflow.

Parameters
[in]_mapFilename of the specular map.

◆ SetType()

void SetType ( PbrType  _type)

Set the PBR workflow to use.

Parameters
[in]_typeWorkflow type to use

◆ SpecularMap()

std::string SpecularMap ( ) const

Get the specular map filename for specular workflow. This will be an empty string if a specular map has not been set.

Returns
Filename of the specular map, or empty string if a specular map has not been specified.

◆ Type()

PbrType Type ( ) const

Get the workflow type.

Returns
PBR workflow type.

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