#include <hps.h>

Inheritance diagram for HPS::PBRMaterialKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (PBRMaterialKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (PBRMaterialKit const &in_kit) const
 
PBRMaterialKitoperator= (PBRMaterialKit &&in_that)
 
PBRMaterialKitoperator= (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)
 
PBRMaterialKitSetAlphaFactor (float in_factor, bool in_mask=false)
 
PBRMaterialKitSetBaseColorFactor (HPS::RGBAColor const &in_color)
 
PBRMaterialKitSetBaseColorMap (char const *in_texture_name)
 
PBRMaterialKitSetEmissiveMap (char const *in_texture_name)
 
PBRMaterialKitSetMetalnessFactor (float in_factor)
 
PBRMaterialKitSetMetalnessMap (char const *in_texture_name, HPS::Material::Texture::ChannelMapping in_channel=HPS::Material::Texture::ChannelMapping::Red)
 
PBRMaterialKitSetNormalFactor (float in_factor)
 
PBRMaterialKitSetNormalMap (char const *in_texture_name)
 
PBRMaterialKitSetOcclusionFactor (float in_factor)
 
PBRMaterialKitSetOcclusionMap (char const *in_texture_name, HPS::Material::Texture::ChannelMapping in_channel=HPS::Material::Texture::ChannelMapping::Blue)
 
PBRMaterialKitSetRoughnessFactor (float in_factor)
 
PBRMaterialKitSetRoughnessMap (char const *in_texture_name, HPS::Material::Texture::ChannelMapping in_channel=HPS::Material::Texture::ChannelMapping::Green)
 
void Show (PBRMaterialKit &out_kit) const
 
bool ShowAlphaFactor (float &out_factor, bool &out_mask) const
 
bool ShowBaseColorFactor (HPS::RGBAColor &out_color) const
 
bool ShowBaseColorMap (UTF8 &out_texture_name) const
 
bool ShowEmissiveMap (UTF8 &out_texture_name) const
 
bool ShowMetalnessFactor (float &out_factor) const
 
bool ShowMetalnessMap (UTF8 &out_texture_name, HPS::Material::Texture::ChannelMapping &out_channel) const
 
bool ShowNormalFactor (float &out_factor) const
 
bool ShowNormalMap (UTF8 &out_texture_name) const
 
bool ShowOcclusionFactor (float &out_factor) const
 
bool ShowOcclusionMap (UTF8 &out_texture_name, HPS::Material::Texture::ChannelMapping &out_channel) const
 
bool ShowRoughnessFactor (float &out_factor) const
 
bool ShowRoughnessMap (UTF8 &out_texture_name, HPS::Material::Texture::ChannelMapping &out_channel) const
 
PBRMaterialKitUnsetAlphaFactor ()
 
PBRMaterialKitUnsetBaseColorFactor ()
 
PBRMaterialKitUnsetBaseColorMap ()
 
PBRMaterialKitUnsetEmissiveMap ()
 
PBRMaterialKitUnsetEverything ()
 
PBRMaterialKitUnsetMetalnessFactor ()
 
PBRMaterialKitUnsetMetalnessMap ()
 
PBRMaterialKitUnsetNormalFactor ()
 
PBRMaterialKitUnsetNormalMap ()
 
PBRMaterialKitUnsetOcclusionFactor ()
 
PBRMaterialKitUnsetOcclusionMap ()
 
PBRMaterialKitUnsetRoughnessFactor ()
 
PBRMaterialKitUnsetRoughnessMap ()
 
 ~PBRMaterialKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static PBRMaterialKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PBRMaterialKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (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

◆ PBRMaterialKit() [1/3]

HPS::PBRMaterialKit::PBRMaterialKit ( )

Initializes an empty kit.

◆ PBRMaterialKit() [2/3]

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_kitThe source object to copy.

◆ PBRMaterialKit() [3/3]

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_thatAn rvalue reference to a PBRMaterialKit to take the impl from.

◆ ~PBRMaterialKit()

HPS::PBRMaterialKit::~PBRMaterialKit ( )

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::PBRMaterialKit::Empty ( ) const
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.

◆ Equals()

bool HPS::PBRMaterialKit::Equals ( PBRMaterialKit const &  in_kit) const

Check if the source PBRMaterialKit is equivalent to this object.

Parameters
in_kitThe source PBRMaterialKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static PBRMaterialKit HPS::PBRMaterialKit::GetDefault ( )
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.

◆ ObjectType()

HPS::Type HPS::PBRMaterialKit::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::PBRMaterialKit::operator!= ( PBRMaterialKit const &  in_kit) const

Check if the source PBRMaterialKit is not equivalent to this object.

Parameters
in_kitThe source PBRMaterialKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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_thatAn rvalue reference to a PBRMaterialKit to take the impl from.
Returns
A reference to this PBRMaterialKit.

◆ operator=() [2/2]

PBRMaterialKit& HPS::PBRMaterialKit::operator= ( PBRMaterialKit const &  in_kit)

Copies the source PBRMaterialKit into this object.

Parameters
in_kitThe source PBRMaterialKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::PBRMaterialKit::operator== ( PBRMaterialKit const &  in_kit) const

Check if the source PBRMaterialKit is equivalent to this object.

Parameters
in_kitThe source PBRMaterialKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::PBRMaterialKit::Set ( PBRMaterialKit const &  in_kit)

Copies all settings from the source PBRMaterialKit into this object.

Parameters
in_kitThe source PBRMaterialKit to copy.

◆ SetAlphaFactor()

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_factorThe factor to use.
in_maskSets if the alpha acts as a mask.
Returns
A reference to this object.

◆ SetBaseColorFactor()

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_colorThe base color factor to use.
Returns
A reference to this object.

◆ SetBaseColorMap()

PBRMaterialKit& HPS::PBRMaterialKit::SetBaseColorMap ( char const *  in_texture_name)

Sets the base color map.

Parameters
in_texture_nameThe base color factor to use.
Returns
A reference to this object.

◆ SetEmissiveMap()

PBRMaterialKit& HPS::PBRMaterialKit::SetEmissiveMap ( char const *  in_texture_name)

Sets the emissive map.

Parameters
in_texture_nameThe base color factor to use.
Returns
A reference to this object.

◆ SetMetalnessFactor()

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_factorThe factor to use.
Returns
A reference to this object.

◆ SetMetalnessMap()

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_nameThe base color factor to use.
in_channelThe color channel from the map to use.
Returns
A reference to this object.

◆ SetNormalFactor()

PBRMaterialKit& HPS::PBRMaterialKit::SetNormalFactor ( float  in_factor)

Sets the normal factor which scales the normal map.

Parameters
in_factorThe factor to use.
Returns
A reference to this object.

◆ SetNormalMap()

PBRMaterialKit& HPS::PBRMaterialKit::SetNormalMap ( char const *  in_texture_name)

Sets the normal map.

Parameters
in_texture_nameThe base color factor to use.
Returns
A reference to this object.

◆ SetOcclusionFactor()

PBRMaterialKit& HPS::PBRMaterialKit::SetOcclusionFactor ( float  in_factor)

Sets the occlusion factor which scales the occlusion map.

Parameters
in_factorThe factor to use.
Returns
A reference to this object.

◆ SetOcclusionMap()

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_nameThe base color factor to use.
in_channelThe color channel from the map to use.
Returns
A reference to this object.

◆ SetRoughnessFactor()

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_factorThe factor to use.
Returns
A reference to this object.

◆ SetRoughnessMap()

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_nameThe base color factor to use.
in_channelThe color channel from the map to use.
Returns
A reference to this object.

◆ Show()

void HPS::PBRMaterialKit::Show ( PBRMaterialKit out_kit) const

Copies all settings from this PBRMaterialKit into the given PBRMaterialKit.

Parameters
out_kitThe PBRMaterialKit to populate with the contents of this object.

◆ ShowAlphaFactor()

bool HPS::PBRMaterialKit::ShowAlphaFactor ( float &  out_factor,
bool &  out_mask 
) const

Shows the alpha factor and alpha mask.

Parameters
out_factorThe alpha factor if set.
out_maskThe alpha mask value.
Returns
true if the setting is valid, false otherwise.

◆ ShowBaseColorFactor()

bool HPS::PBRMaterialKit::ShowBaseColorFactor ( HPS::RGBAColor out_color) const

Shows the base color factor.

Parameters
out_colorThe base color factor if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowBaseColorMap()

bool HPS::PBRMaterialKit::ShowBaseColorMap ( UTF8 out_texture_name) const

Shows the base color map name.

Parameters
out_texture_nameThe base color map name if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowEmissiveMap()

bool HPS::PBRMaterialKit::ShowEmissiveMap ( UTF8 out_texture_name) const

Shows the emissive map name.

Parameters
out_texture_nameThe emissive map name if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowMetalnessFactor()

bool HPS::PBRMaterialKit::ShowMetalnessFactor ( float &  out_factor) const

Shows the metalness factor.

Parameters
out_factorThe metalness if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowMetalnessMap()

bool HPS::PBRMaterialKit::ShowMetalnessMap ( UTF8 out_texture_name,
HPS::Material::Texture::ChannelMapping out_channel 
) const

Shows the metalness map name.

Parameters
out_texture_nameThe metalness map name if set.
out_channelThe channel.
Returns
true if the setting is valid, false otherwise.

◆ ShowNormalFactor()

bool HPS::PBRMaterialKit::ShowNormalFactor ( float &  out_factor) const

Shows the normal factor.

Parameters
out_factorThe normal factor if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowNormalMap()

bool HPS::PBRMaterialKit::ShowNormalMap ( UTF8 out_texture_name) const

Shows the normal map name.

Parameters
out_texture_nameThe normal map name if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowOcclusionFactor()

bool HPS::PBRMaterialKit::ShowOcclusionFactor ( float &  out_factor) const

Shows the occlusion factor.

Parameters
out_factorThe occlusion if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowOcclusionMap()

bool HPS::PBRMaterialKit::ShowOcclusionMap ( UTF8 out_texture_name,
HPS::Material::Texture::ChannelMapping out_channel 
) const

Shows the occlusion map name.

Parameters
out_texture_nameThe occlusion map name if set.
out_channelThe channel.
Returns
true if the setting is valid, false otherwise.

◆ ShowRoughnessFactor()

bool HPS::PBRMaterialKit::ShowRoughnessFactor ( float &  out_factor) const

Shows the roughness factor.

Parameters
out_factorThe roughness if set.
Returns
true if the setting is valid, false otherwise.

◆ ShowRoughnessMap()

bool HPS::PBRMaterialKit::ShowRoughnessMap ( UTF8 out_texture_name,
HPS::Material::Texture::ChannelMapping out_channel 
) const

Shows the roughness map name.

Parameters
out_texture_nameThe roughness map name if set.
out_channelThe channel.
Returns
true if the setting is valid, false otherwise.

◆ UnsetAlphaFactor()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetAlphaFactor ( )

Removes the alpha factor from this kit type.

Returns
A reference to this object.

◆ UnsetBaseColorFactor()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetBaseColorFactor ( )

Removes the base color factor from this kit type.

Returns
A reference to this object.

◆ UnsetBaseColorMap()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetBaseColorMap ( )

Removes the base color map from this kit type.

Returns
A reference to this object.

◆ UnsetEmissiveMap()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetEmissiveMap ( )

Removes the emissive map from this kit type.

Returns
A reference to this object.

◆ UnsetEverything()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMetalnessFactor()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetMetalnessFactor ( )

Removes the metalness factor from this kit type.

Returns
A reference to this object.

◆ UnsetMetalnessMap()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetMetalnessMap ( )

Removes the metalness map from this kit type.

Returns
A reference to this object.

◆ UnsetNormalFactor()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetNormalFactor ( )

Removes the normal factor from this kit type.

Returns
A reference to this object.

◆ UnsetNormalMap()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetNormalMap ( )

Removes the normal map from this kit type.

Returns
A reference to this object.

◆ UnsetOcclusionFactor()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetOcclusionFactor ( )

Removes the occlusion factor from this kit type.

Returns
A reference to this object.

◆ UnsetOcclusionMap()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetOcclusionMap ( )

Removes the occlusion map from this kit type.

Returns
A reference to this object.

◆ UnsetRoughnessFactor()

PBRMaterialKit& HPS::PBRMaterialKit::UnsetRoughnessFactor ( )

Removes the roughness factor from this kit type.

Returns
A reference to this object.

◆ UnsetRoughnessMap()

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: