#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (PBRMaterialKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (PBRMaterialKit const &in_kit) const |
PBRMaterialKit & | operator= (PBRMaterialKit &&in_that) |
PBRMaterialKit & | operator= (PBRMaterialKit const &in_kit) |
bool | operator== (PBRMaterialKit const &in_kit) const |
PBRMaterialKit () | |
PBRMaterialKit (PBRMaterialKit const &in_kit) | |
PBRMaterialKit (PBRMaterialKit &&in_that) | |
void | Set (PBRMaterialKit const &in_kit) |
PBRMaterialKit & | SetAlphaFactor (float in_factor, bool in_mask=false) |
PBRMaterialKit & | SetBaseColorFactor (HPS::RGBAColor const &in_color) |
PBRMaterialKit & | SetBaseColorMap (char const *in_texture_name) |
PBRMaterialKit & | SetEmissiveMap (char const *in_texture_name) |
PBRMaterialKit & | SetMetalnessFactor (float in_factor) |
PBRMaterialKit & | SetMetalnessMap (char const *in_texture_name, HPS::Material::Texture::ChannelMapping in_channel=HPS::Material::Texture::ChannelMapping::Red) |
PBRMaterialKit & | SetNormalFactor (float in_factor) |
PBRMaterialKit & | SetNormalMap (char const *in_texture_name) |
PBRMaterialKit & | SetOcclusionFactor (float in_factor) |
PBRMaterialKit & | SetOcclusionMap (char const *in_texture_name, HPS::Material::Texture::ChannelMapping in_channel=HPS::Material::Texture::ChannelMapping::Blue) |
PBRMaterialKit & | SetRoughnessFactor (float in_factor) |
PBRMaterialKit & | SetRoughnessMap (char const *in_texture_name, HPS::Material::Texture::ChannelMapping in_channel=HPS::Material::Texture::ChannelMapping::Green) |
void | Show (PBRMaterialKit &out_kit) const |
~PBRMaterialKit () | |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
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.
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.
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.
The documentation for this class was generated from the following file:
- include/hps.h