#include <hps.h>

Static Public Member Functions | |
static PBRMaterialKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PBRMaterialKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The HPS::PBRMaterialKit class is a user space object, used for grouping attribute settings related to PBR materials.
Constructor & Destructor Documentation
HPS::PBRMaterialKit::PBRMaterialKit | ( | ) |
Initializes an empty kit.
HPS::PBRMaterialKit::PBRMaterialKit | ( | PBRMaterialKit const & | in_kit | ) |
The copy constructor creates a new PBRMaterialKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
HPS::PBRMaterialKit::PBRMaterialKit | ( | PBRMaterialKit && | in_that | ) |
The move constructor creates a PBRMaterialKit by transferring the underlying impl of the rvalue reference to this MaterialMappingKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a PBRMaterialKit to take the impl from.
HPS::PBRMaterialKit::~PBRMaterialKit | ( | ) |
Destroy this kit.
Member Function Documentation
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS::Object.
bool HPS::PBRMaterialKit::Equals | ( | PBRMaterialKit const & | in_kit | ) | const |
Check if the source PBRMaterialKit is equivalent to this object.
- Parameters
-
in_kit The source PBRMaterialKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
Creates a HPS::PBRMaterialKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A PBRMaterialKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
bool HPS::PBRMaterialKit::operator!= | ( | PBRMaterialKit const & | in_kit | ) | const |
Check if the source PBRMaterialKit is not equivalent to this object.
- Parameters
-
in_kit The source PBRMaterialKit to compare to this object.
- Returns
- true if the objects are not equivalent, false otherwise.
PBRMaterialKit& HPS::PBRMaterialKit::operator= | ( | PBRMaterialKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this PBRMaterialKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a PBRMaterialKit to take the impl from.
- Returns
- A reference to this PBRMaterialKit.
PBRMaterialKit& HPS::PBRMaterialKit::operator= | ( | PBRMaterialKit const & | in_kit | ) |
Copies the source PBRMaterialKit into this object.
- Parameters
-
in_kit The source PBRMaterialKit to copy.
- Returns
- A reference to this object.
bool HPS::PBRMaterialKit::operator== | ( | PBRMaterialKit const & | in_kit | ) | const |
Check if the source PBRMaterialKit is equivalent to this object.
- Parameters
-
in_kit The source PBRMaterialKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::PBRMaterialKit::Set | ( | PBRMaterialKit const & | in_kit | ) |
Copies all settings from the source PBRMaterialKit into this object.
- Parameters
-
in_kit The source PBRMaterialKit to copy.
PBRMaterialKit& HPS::PBRMaterialKit::SetAlphaFactor | ( | float | in_factor, |
bool | in_mask = false |
||
) |
Sets the alpha factor which scales the alpha map or acts as the alpha if no map exists.
- Parameters
-
in_factor The factor to use. in_mask Sets if the alpha acts as a mask.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetBaseColorFactor | ( | HPS::RGBAColor const & | in_color | ) |
Sets the base color factor which either scales the base color map or acts as a base color directly if no map exists.
- Parameters
-
in_color The base color factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetBaseColorMap | ( | char const * | in_texture_name | ) |
Sets the base color map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetEmissiveMap | ( | char const * | in_texture_name | ) |
Sets the emissive map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetMetalnessFactor | ( | float | in_factor | ) |
Sets the metalness factor which scales the metalness map or acts as the metalness if no map exists.
- Parameters
-
in_factor The factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetMetalnessMap | ( | char const * | in_texture_name, |
HPS::Material::Texture::ChannelMapping | in_channel = HPS::Material::Texture::ChannelMapping::Red |
||
) |
Sets the metalness map.
- Parameters
-
in_texture_name The base color factor to use. in_channel The color channel from the map to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetNormalFactor | ( | float | in_factor | ) |
Sets the normal factor which scales the normal map.
- Parameters
-
in_factor The factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetNormalMap | ( | char const * | in_texture_name | ) |
Sets the normal map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetOcclusionFactor | ( | float | in_factor | ) |
Sets the occlusion factor which scales the occlusion map.
- Parameters
-
in_factor The factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetOcclusionMap | ( | char const * | in_texture_name, |
HPS::Material::Texture::ChannelMapping | in_channel = HPS::Material::Texture::ChannelMapping::Blue |
||
) |
Sets the occlusion map.
- Parameters
-
in_texture_name The base color factor to use. in_channel The color channel from the map to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetRoughnessFactor | ( | float | in_factor | ) |
Sets the roughness factor which scales the roughness map or acts as the roughness if no map exists.
- Parameters
-
in_factor The factor to use.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::SetRoughnessMap | ( | char const * | in_texture_name, |
HPS::Material::Texture::ChannelMapping | in_channel = HPS::Material::Texture::ChannelMapping::Green |
||
) |
Sets the roughness map.
- Parameters
-
in_texture_name The base color factor to use. in_channel The color channel from the map to use.
- Returns
- A reference to this object.
void HPS::PBRMaterialKit::Show | ( | PBRMaterialKit & | out_kit | ) | const |
Copies all settings from this PBRMaterialKit into the given PBRMaterialKit.
- Parameters
-
out_kit The PBRMaterialKit to populate with the contents of this object.
bool HPS::PBRMaterialKit::ShowAlphaFactor | ( | float & | out_factor, |
bool & | out_mask | ||
) | const |
Shows the alpha factor and alpha mask.
- Parameters
-
out_factor The alpha factor if set. out_mask The alpha mask value.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowBaseColorFactor | ( | HPS::RGBAColor & | out_color | ) | const |
Shows the base color factor.
- Parameters
-
out_color The base color factor if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowBaseColorMap | ( | UTF8 & | out_texture_name | ) | const |
Shows the base color map name.
- Parameters
-
out_texture_name The base color map name if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowEmissiveMap | ( | UTF8 & | out_texture_name | ) | const |
Shows the emissive map name.
- Parameters
-
out_texture_name The emissive map name if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowMetalnessFactor | ( | float & | out_factor | ) | const |
Shows the metalness factor.
- Parameters
-
out_factor The metalness if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowMetalnessMap | ( | UTF8 & | out_texture_name, |
HPS::Material::Texture::ChannelMapping & | out_channel | ||
) | const |
Shows the metalness map name.
- Parameters
-
out_texture_name The metalness map name if set. out_channel The channel.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowNormalFactor | ( | float & | out_factor | ) | const |
Shows the normal factor.
- Parameters
-
out_factor The normal factor if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowNormalMap | ( | UTF8 & | out_texture_name | ) | const |
Shows the normal map name.
- Parameters
-
out_texture_name The normal map name if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowOcclusionFactor | ( | float & | out_factor | ) | const |
Shows the occlusion factor.
- Parameters
-
out_factor The occlusion if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowOcclusionMap | ( | UTF8 & | out_texture_name, |
HPS::Material::Texture::ChannelMapping & | out_channel | ||
) | const |
Shows the occlusion map name.
- Parameters
-
out_texture_name The occlusion map name if set. out_channel The channel.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowRoughnessFactor | ( | float & | out_factor | ) | const |
Shows the roughness factor.
- Parameters
-
out_factor The roughness if set.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::PBRMaterialKit::ShowRoughnessMap | ( | UTF8 & | out_texture_name, |
HPS::Material::Texture::ChannelMapping & | out_channel | ||
) | const |
Shows the roughness map name.
- Parameters
-
out_texture_name The roughness map name if set. out_channel The channel.
- Returns
- true if the setting is valid, false otherwise.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetAlphaFactor | ( | ) |
Removes the alpha factor from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetBaseColorFactor | ( | ) |
Removes the base color factor from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetBaseColorMap | ( | ) |
Removes the base color map from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetEmissiveMap | ( | ) |
Removes the emissive map from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetMetalnessFactor | ( | ) |
Removes the metalness factor from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetMetalnessMap | ( | ) |
Removes the metalness map from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetNormalFactor | ( | ) |
Removes the normal factor from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetNormalMap | ( | ) |
Removes the normal map from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetOcclusionFactor | ( | ) |
Removes the occlusion factor from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetOcclusionMap | ( | ) |
Removes the occlusion map from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetRoughnessFactor | ( | ) |
Removes the roughness factor from this kit type.
- Returns
- A reference to this object.
PBRMaterialKit& HPS::PBRMaterialKit::UnsetRoughnessMap | ( | ) |
Removes the roughness map from this kit type.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h