TDME2 1.9.121
Public Member Functions | Private Member Functions | Private Attributes | List of all members
PBRMaterialProperties Class Referencefinal

Represents specular material properties. More...

#include <tdme/engine/model/PBRMaterialProperties.h>

Collaboration diagram for PBRMaterialProperties:
Collaboration graph

Public Member Functions

 PBRMaterialProperties ()
 Public constructor. More...
 
 ~PBRMaterialProperties ()
 Destructor. More...
 
bool hasEmbeddedTextures () const
 
void setEmbedTextures (bool embedTextures)
 Set if to embed textures. More...
 
const Color4 & getBaseColorFactor () const
 
void setBaseColorFactor (const Color4 &baseColorFactor)
 Set base color factor. More...
 
const string & getBaseColorTexturePathName () const
 
const string & getBaseColorTextureFileName () const
 
void setBaseColorTexture (Texture *baseColorTexture)
 Set up a base color texture by the texture itself. More...
 
void setBaseColorTexture (const string &pathName, const string &fileName)
 Set up a base color texture. More...
 
bool hasBaseColorTexture () const
 
Texture * getBaseColorTexture () const
 
bool hasBaseColorTextureTransparency () const
 
void setBaseColorTextureTransparency (bool transparency)
 Set if base color texture uses transparency. More...
 
bool hasBaseColorTextureMaskedTransparency () const
 
void setBaseColorTextureMaskedTransparency (bool maskedTransparency)
 Set if base color texture uses masked transparency(means pixel are eighter opaque or not visible) More...
 
float getBaseColorTextureMaskedTransparencyThreshold () const
 
void setBaseColorTextureMaskedTransparencyThreshold (float maskedTransparencyThreshold)
 Set base color texture masked transparency threshold. More...
 
float getMetallicFactor () const
 
void setMetallicFactor (float metallicFactor)
 Set metallic factor. More...
 
float getRoughnessFactor () const
 
void setRoughnessFactor (float roughnessFactor)
 Set roughness factor. More...
 
const string & getMetallicRoughnessTexturePathName () const
 
const string & getMetallicRoughnessTextureFileName () const
 
void setMetallicRoughnessTexture (Texture *metallicRoughnessTexture)
 Set up a metallic roughness texture by the texture itself. More...
 
void setMetallicRoughnessTexture (const string &pathName, const string &fileName)
 Set up a metallic roughness texture. More...
 
bool hasMetallicRoughnessTexture () const
 
Texture * getMetallicRoughnessTexture () const
 
float getNormalScale () const
 
void setNormalScale (float normalScale)
 Set normal scale. More...
 
const string & getNormalTexturePathName () const
 
const string & getNormalTextureFileName () const
 
void setNormalTexture (Texture *normalTexture)
 Set up a normal texture by the texture itself. More...
 
void setNormalTexture (const string &pathName, const string &fileName)
 Set up a normal texture. More...
 
bool hasNormalTexture () const
 
Texture * getNormalTexture () const
 
float getExposure () const
 
void setExposure (float exposure)
 Set exposure. More...
 

Private Member Functions

void checkBaseColorTextureTransparency ()
 Checks and set ups base color texture transparency. More...
 

Private Attributes

bool embedTextures
 
Color4 baseColorFactor
 
string baseColorTexturePathName
 
string baseColorTextureFileName
 
Texture * baseColorTexture
 
bool baseColorTextureMaskedTransparency
 
float baseColorTextureMaskedTransparencyThreshold
 
bool baseColorTextureTransparency
 
float metallicFactor
 
float roughnessFactor
 
string metallicRoughnessTexturePathName
 
string metallicRoughnessTextureFileName
 
Texture * metallicRoughnessTexture
 
float normalScale
 
string normalTexturePathName
 
string normalTextureFileName
 
Texture * normalTexture
 
float exposure
 

Detailed Description

Represents specular material properties.

Author
andreas.drewke
Version
$Id$

Definition at line 20 of file PBRMaterialProperties.h.

Constructor & Destructor Documentation

◆ PBRMaterialProperties()

PBRMaterialProperties ( )

Public constructor.

Definition at line 17 of file PBRMaterialProperties.cpp.

◆ ~PBRMaterialProperties()

~PBRMaterialProperties ( )

Destructor.

Definition at line 33 of file PBRMaterialProperties.cpp.

Member Function Documentation

◆ checkBaseColorTextureTransparency()

void checkBaseColorTextureTransparency ( )
private

Checks and set ups base color texture transparency.

Definition at line 89 of file PBRMaterialProperties.cpp.

◆ getBaseColorFactor()

const Color4 & getBaseColorFactor ( ) const
inline
Returns
base color factor

Definition at line 77 of file PBRMaterialProperties.h.

◆ getBaseColorTexture()

Texture * getBaseColorTexture ( ) const
inline
Returns
the material's base color texture

Definition at line 126 of file PBRMaterialProperties.h.

◆ getBaseColorTextureFileName()

const string & getBaseColorTextureFileName ( ) const
inline
Returns
base color texture file name

Definition at line 99 of file PBRMaterialProperties.h.

◆ getBaseColorTextureMaskedTransparencyThreshold()

float getBaseColorTextureMaskedTransparencyThreshold ( ) const
inline
Returns
base color texture masked transparency threshold

Definition at line 163 of file PBRMaterialProperties.h.

◆ getBaseColorTexturePathName()

const string & getBaseColorTexturePathName ( ) const
inline
Returns
base color texture path name

Definition at line 92 of file PBRMaterialProperties.h.

◆ getExposure()

float getExposure ( ) const
inline
Returns
exposure

Definition at line 305 of file PBRMaterialProperties.h.

◆ getMetallicFactor()

float getMetallicFactor ( ) const
inline
Returns
metallic factor

Definition at line 178 of file PBRMaterialProperties.h.

◆ getMetallicRoughnessTexture()

Texture * getMetallicRoughnessTexture ( ) const
inline
Returns
the material's metallic roughness texture

Definition at line 242 of file PBRMaterialProperties.h.

◆ getMetallicRoughnessTextureFileName()

const string & getMetallicRoughnessTextureFileName ( ) const
inline
Returns
metallic roughness texture file name

Definition at line 215 of file PBRMaterialProperties.h.

◆ getMetallicRoughnessTexturePathName()

const string & getMetallicRoughnessTexturePathName ( ) const
inline
Returns
metallic roughness texture path name

Definition at line 208 of file PBRMaterialProperties.h.

◆ getNormalScale()

float getNormalScale ( ) const
inline
Returns
normal scale

Definition at line 249 of file PBRMaterialProperties.h.

◆ getNormalTexture()

Texture * getNormalTexture ( ) const
inline
Returns
the material's normal texture

Definition at line 298 of file PBRMaterialProperties.h.

◆ getNormalTextureFileName()

const string & getNormalTextureFileName ( ) const
inline
Returns
normal texture file name

Definition at line 271 of file PBRMaterialProperties.h.

◆ getNormalTexturePathName()

const string & getNormalTexturePathName ( ) const
inline
Returns
normal texture path name

Definition at line 264 of file PBRMaterialProperties.h.

◆ getRoughnessFactor()

float getRoughnessFactor ( ) const
inline
Returns
roughness factor

Definition at line 193 of file PBRMaterialProperties.h.

◆ hasBaseColorTexture()

bool hasBaseColorTexture ( ) const
inline
Returns
if material has a base color texture

Definition at line 119 of file PBRMaterialProperties.h.

◆ hasBaseColorTextureMaskedTransparency()

bool hasBaseColorTextureMaskedTransparency ( ) const
inline
Returns
base color texture has masked transparency, means pixel are eighter opaque or not visible

Definition at line 148 of file PBRMaterialProperties.h.

◆ hasBaseColorTextureTransparency()

bool hasBaseColorTextureTransparency ( ) const
inline
Returns
base color texture has transparent pixels

Definition at line 133 of file PBRMaterialProperties.h.

◆ hasEmbeddedTextures()

bool hasEmbeddedTextures ( ) const
inline
Returns
if textures will be embedded in model files

Definition at line 62 of file PBRMaterialProperties.h.

◆ hasMetallicRoughnessTexture()

bool hasMetallicRoughnessTexture ( ) const
inline
Returns
if material has a metallic roughness texture

Definition at line 235 of file PBRMaterialProperties.h.

◆ hasNormalTexture()

bool hasNormalTexture ( ) const
inline
Returns
if material has a normal texture

Definition at line 291 of file PBRMaterialProperties.h.

◆ setBaseColorFactor()

void setBaseColorFactor ( const Color4 &  baseColorFactor)
inline

Set base color factor.

Parameters
baseColorFactorbase color factor

Definition at line 85 of file PBRMaterialProperties.h.

◆ setBaseColorTexture() [1/2]

void setBaseColorTexture ( const string &  pathName,
const string &  fileName 
)

Set up a base color texture.

Parameters
pathNamepath name
fileNamefile name

Definition at line 48 of file PBRMaterialProperties.cpp.

◆ setBaseColorTexture() [2/2]

void setBaseColorTexture ( Texture *  baseColorTexture)

Set up a base color texture by the texture itself.

Parameters
baseColorTexturebase color texture

Definition at line 39 of file PBRMaterialProperties.cpp.

◆ setBaseColorTextureMaskedTransparency()

void setBaseColorTextureMaskedTransparency ( bool  maskedTransparency)
inline

Set if base color texture uses masked transparency(means pixel are eighter opaque or not visible)

Parameters
maskedTransparencymasked transparency

Definition at line 156 of file PBRMaterialProperties.h.

◆ setBaseColorTextureMaskedTransparencyThreshold()

void setBaseColorTextureMaskedTransparencyThreshold ( float  maskedTransparencyThreshold)
inline

Set base color texture masked transparency threshold.

Parameters
maskedTransparencyThresholddiffuse texture masked transparency threshold

Definition at line 171 of file PBRMaterialProperties.h.

◆ setBaseColorTextureTransparency()

void setBaseColorTextureTransparency ( bool  transparency)
inline

Set if base color texture uses transparency.

Parameters
transparencytransparency

Definition at line 141 of file PBRMaterialProperties.h.

◆ setEmbedTextures()

void setEmbedTextures ( bool  embedTextures)
inline

Set if to embed textures.

Parameters
embedTexturesembed textures

Definition at line 70 of file PBRMaterialProperties.h.

◆ setExposure()

void setExposure ( float  exposure)
inline

Set exposure.

Parameters
exposureexposure

Definition at line 313 of file PBRMaterialProperties.h.

◆ setMetallicFactor()

void setMetallicFactor ( float  metallicFactor)
inline

Set metallic factor.

Parameters
metallicFactormetallic factor

Definition at line 186 of file PBRMaterialProperties.h.

◆ setMetallicRoughnessTexture() [1/2]

void setMetallicRoughnessTexture ( const string &  pathName,
const string &  fileName 
)

Set up a metallic roughness texture.

Parameters
pathNamepath name
fileNamefile name

Definition at line 65 of file PBRMaterialProperties.cpp.

◆ setMetallicRoughnessTexture() [2/2]

void setMetallicRoughnessTexture ( Texture *  metallicRoughnessTexture)

Set up a metallic roughness texture by the texture itself.

Parameters
metallicRoughnessTexturemetallic roughness texture

Definition at line 57 of file PBRMaterialProperties.cpp.

◆ setNormalScale()

void setNormalScale ( float  normalScale)
inline

Set normal scale.

Parameters
normalScalenormal scale

Definition at line 257 of file PBRMaterialProperties.h.

◆ setNormalTexture() [1/2]

void setNormalTexture ( const string &  pathName,
const string &  fileName 
)

Set up a normal texture.

Parameters
pathNamepath name
fileNamefile name

Definition at line 81 of file PBRMaterialProperties.cpp.

◆ setNormalTexture() [2/2]

void setNormalTexture ( Texture *  normalTexture)

Set up a normal texture by the texture itself.

Parameters
normalTexturenormal texture

Definition at line 73 of file PBRMaterialProperties.cpp.

◆ setRoughnessFactor()

void setRoughnessFactor ( float  roughnessFactor)
inline

Set roughness factor.

Parameters
roughnessFactorroughness factor

Definition at line 201 of file PBRMaterialProperties.h.

Member Data Documentation

◆ baseColorFactor

Color4 baseColorFactor
private

Definition at line 25 of file PBRMaterialProperties.h.

◆ baseColorTexture

Texture* baseColorTexture
private

Definition at line 28 of file PBRMaterialProperties.h.

◆ baseColorTextureFileName

string baseColorTextureFileName
private

Definition at line 27 of file PBRMaterialProperties.h.

◆ baseColorTextureMaskedTransparency

bool baseColorTextureMaskedTransparency
private

Definition at line 29 of file PBRMaterialProperties.h.

◆ baseColorTextureMaskedTransparencyThreshold

float baseColorTextureMaskedTransparencyThreshold
private

Definition at line 30 of file PBRMaterialProperties.h.

◆ baseColorTexturePathName

string baseColorTexturePathName
private

Definition at line 26 of file PBRMaterialProperties.h.

◆ baseColorTextureTransparency

bool baseColorTextureTransparency
private

Definition at line 31 of file PBRMaterialProperties.h.

◆ embedTextures

bool embedTextures
private

Definition at line 24 of file PBRMaterialProperties.h.

◆ exposure

float exposure
private

Definition at line 41 of file PBRMaterialProperties.h.

◆ metallicFactor

float metallicFactor
private

Definition at line 32 of file PBRMaterialProperties.h.

◆ metallicRoughnessTexture

Texture* metallicRoughnessTexture
private

Definition at line 36 of file PBRMaterialProperties.h.

◆ metallicRoughnessTextureFileName

string metallicRoughnessTextureFileName
private

Definition at line 35 of file PBRMaterialProperties.h.

◆ metallicRoughnessTexturePathName

string metallicRoughnessTexturePathName
private

Definition at line 34 of file PBRMaterialProperties.h.

◆ normalScale

float normalScale
private

Definition at line 37 of file PBRMaterialProperties.h.

◆ normalTexture

Texture* normalTexture
private

Definition at line 40 of file PBRMaterialProperties.h.

◆ normalTextureFileName

string normalTextureFileName
private

Definition at line 39 of file PBRMaterialProperties.h.

◆ normalTexturePathName

string normalTexturePathName
private

Definition at line 38 of file PBRMaterialProperties.h.

◆ roughnessFactor

float roughnessFactor
private

Definition at line 33 of file PBRMaterialProperties.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.3