sdf::SDF_VERSION_NAMESPACE::PbrWorkflow Class Reference

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

#include <Pbr.hh>

Public Member Functions
	PbrWorkflow ()
	Default constructor. More...
std::string	AlbedoMap () const
	Get the albedo map filename. More...
std::string	AmbientOcclusionMap () const
	Get the ambient occlusion map filename. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
std::string	EmissiveMap () const
	Get the emissive map filename. More...
std::string	EnvironmentMap () const
	Get the environment map filename. 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. More...
std::string	LightMap () const
	Get the light map filename. More...
unsigned int	LightMapTexCoordSet () const
	Get the light map texture coordinate set. More...
Errors	Load (ElementPtr _sdf)
	Load the pbr workflow based on an element pointer. 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. More...
std::string	NormalMap () const
	Get the normal map filename. More...
NormalMapSpace	NormalMapType () const
	Get the normal map type, either tangent or object space. More...
bool	operator!= (const PbrWorkflow &_workflow) const
	Return true this PbrWorkflow object does not contain the same values as the passed in parameter. More...
bool	operator== (const PbrWorkflow &_workflow) const
	Return true if both PbrWorkflow 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. 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 (const 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 (const 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 (const 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 (PbrWorkflowType _type)
	Set the PBR workflow to use. More...
std::string	SpecularMap () const
	Get the specular map filename for specular workflow. More...
PbrWorkflowType	Type () const
	Get the workflow type. More...

Detailed Description

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

Constructor & Destructor Documentation

PbrWorkflow()

sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::PbrWorkflow

(

)

Default constructor.

Member Function Documentation

AlbedoMap()

std::string sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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.

Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::Element

(

)

const

Get a pointer to the SDF element that was used during load.

Returns

SDF element pointer. The value will be nullptr if Load has not been called.

EmissiveMap()

std::string sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::Glossiness

(

)

const

Get the glossiness value of the material for specular workflow.

Returns

Glossiness value of the material

GlossinessMap()

std::string sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::LightMapTexCoordSet

(

)

const

Get the light map texture coordinate set.

Returns

Index of the texture coordinate set

Load()

Errors sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::Load

(

ElementPtr

_sdf

)

Load the pbr workflow based on an element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters

[in]

_sdf

The SDF Element pointer

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

Metalness()

double sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::Metalness

(

)

const

Get the metalness value of the material for metal workflow.

Returns

metalness value of the material

MetalnessMap()

std::string sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::NormalMapType

(

)

const

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

Returns

Space that the normal map is defined in

operator!=()

bool sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::operator!=

(

const PbrWorkflow &

_workflow

)

const

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

Parameters

[_in]

_workflow PbrWorkflow value to compare. \returen True if 'this' != _workflow.

operator==()

bool sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::operator==

(

const PbrWorkflow &

_workflow

)

const

Return true if both PbrWorkflow objects contain the same values.

Parameters

[_in]

_workflow PbrWorkflow value to compare. \returen True if 'this' == _workflow.

Roughness()

double sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::Roughness

(

)

const

Get the roughness value of the material for metal workflow.

Returns

roughness value of the material

RoughnessMap()

std::string sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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 sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetAlbedoMap

(

const std::string &

_map

)

Set the albedo map filename.

Parameters

[in]

_map

Filename of the albedo map.

SetAmbientOcclusionMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetAmbientOcclusionMap

(

const std::string &

_map

)

Set the ambient occlusion map filename.

Parameters

[in]

_map

Filename of the ambient occlusion map.

SetEmissiveMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetEmissiveMap

(

const std::string &

_map

)

Set the emissive map filename.

Parameters

[in]

_map

Filename of the emissive map.

SetEnvironmentMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetEnvironmentMap

(

const std::string &

_map

)

Set the environment map filename.

Parameters

[in]

_map

Filename of the environment map.

SetGlossiness()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetGlossiness

(

const double

_value

)

Set the glossiness value of the material for specular workflow.

Parameters

[in]

_value

Glossiness value.

SetGlossinessMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetGlossinessMap

(

const std::string &

_map

)

Set the glossiness map filename for specular workflow.

Parameters

[in]

_map

Filename of the glossiness map.

SetLightMap()

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

Set the light map filename.

Parameters

[in]	_map	Filename of the light map.
[in]	_uvSet	Index of the light map texture coordinate set

SetMetalness()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetMetalness

(

const double

_value

)

Set the metalness value of the material for metal workflow.

Parameters

[in]

_value

Metalness value.

SetMetalnessMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetMetalnessMap

(

const std::string &

_map

)

Set the metalness map filename for metal workflow.

Parameters

[in]

_map

Filename of the metalness map.

SetNormalMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetNormalMap	(	const std::string &	_map,
		NormalMapSpace	_space = NormalMapSpace::TANGENT
	)

Set the normal map filename.

Parameters

[in]	_map	Filename of the normal map.
[in]	_space	Space that the normal map is defined in. Defaults to tangent space.

SetRoughness()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetRoughness

(

const double

_value

)

Set the roughness value of the material for metal workflow.

Parameters

[in]

_value

Roughness value.

SetRoughnessMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetRoughnessMap

(

const std::string &

_map

)

Set the roughness map filename for metal workflow.

Parameters

[in]

_map

Filename of the roughness map.

SetSpecularMap()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetSpecularMap

(

const std::string &

_map

)

Set the specular map filename for specular workflow.

Parameters

[in]

_map

Filename of the specular map.

SetType()

void sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::SetType

(

PbrWorkflowType

_type

)

Set the PBR workflow to use.

Parameters

[in]

_type

Workflow type to use

SpecularMap()

std::string sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::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()

PbrWorkflowType sdf::SDF_VERSION_NAMESPACE::PbrWorkflow::Type

(

)

const

Get the workflow type.

Returns

PBR workflow type.

---

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

• Pbr.hh