PBRMaterialKit

class HPS.PBRMaterialKit : public HPS.Kit 

The HPS.PBRMaterialKit class is a user space object, used for grouping attribute settings related to PBR materials.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return: true if no values are set on this object, false otherwise.

bool Equals (HPS.PBRMaterialKit in_kit)

Check if the source PBRMaterialKit is equivalent to this object.

Param in_kit: The source PBRMaterialKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

PBRMaterialKit (): Initializes an empty kit.

PBRMaterialKit (HPS.PBRMaterialKit in_kit)

The copy constructor creates a new PBRMaterialKit object that contains the same settings as the source object.

Param in_kit: The source object to copy.

void Set (HPS.PBRMaterialKit in_kit)

Copies all settings from the source PBRMaterialKit into this object.

Param in_kit: The source PBRMaterialKit to copy.

HPS.PBRMaterialKit SetAlphaFactor (float in_factor)

Sets the alpha factor which scales the alpha map or acts as the alpha if no map exists.

Param in_factor: The factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetAlphaFactor (float in_factor, bool in_mask)

Sets the alpha factor which scales the alpha map or acts as the alpha if no map exists.

Param in_factor: The factor to use.
Param in_mask: Sets if the alpha acts as a mask.
Return: A reference to this object.

HPS.PBRMaterialKit SetBaseColorFactor (HPS.RGBAColor 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.

Param in_color: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetBaseColorMap (string in_texture_name)

Sets the base color map.

Param in_texture_name: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetEmissiveMap (string in_texture_name)

Sets the emissive map.

Param in_texture_name: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetMetalnessFactor (float in_factor)

Sets the metalness factor which scales the metalness map or acts as the metalness if no map exists.

Param in_factor: The factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetMetalnessMap (string in_texture_name)

Sets the metalness map.

Param in_texture_name: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetMetalnessMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel)

Sets the metalness map.

Param in_texture_name: The base color factor to use.
Param in_channel: The color channel from the map to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetNormalFactor (float in_factor)

Sets the normal factor which scales the normal map.

Param in_factor: The factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetNormalMap (string in_texture_name)

Sets the normal map.

Param in_texture_name: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetOcclusionFactor (float in_factor)

Sets the occlusion factor which scales the occlusion map.

Param in_factor: The factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetOcclusionMap (string in_texture_name)

Sets the occlusion map.

Param in_texture_name: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetOcclusionMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel)

Sets the occlusion map.

Param in_texture_name: The base color factor to use.
Param in_channel: The color channel from the map to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetRoughnessFactor (float in_factor)

Sets the roughness factor which scales the roughness map or acts as the roughness if no map exists.

Param in_factor: The factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetRoughnessMap (string in_texture_name)

Sets the roughness map.

Param in_texture_name: The base color factor to use.
Return: A reference to this object.

HPS.PBRMaterialKit SetRoughnessMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel)

Sets the roughness map.

Param in_texture_name: The base color factor to use.
Param in_channel: The color channel from the map to use.
Return: A reference to this object.

void Show (out HPS.PBRMaterialKit out_kit)

Copies all settings from this PBRMaterialKit into the given PBRMaterialKit.

Param out_kit: The PBRMaterialKit to populate with the contents of this object.

bool ShowAlphaFactor (out float out_factor, out bool out_mask)

Shows the alpha factor and alpha mask.

Param out_factor: The alpha factor if set.
Param out_mask: The alpha mask value.
Return: true if the setting is valid, false otherwise.

bool ShowBaseColorFactor (out HPS.RGBAColor out_color)

Shows the base color factor.

Param out_color: The base color factor if set.
Return: true if the setting is valid, false otherwise.

bool ShowBaseColorMap (out string out_texture_name)

Shows the base color map name.

Param out_texture_name: The base color map name if set.
Return: true if the setting is valid, false otherwise.

bool ShowEmissiveMap (out string out_texture_name)

Shows the emissive map name.

Param out_texture_name: The emissive map name if set.
Return: true if the setting is valid, false otherwise.

bool ShowMetalnessFactor (out float out_factor)

Shows the metalness factor.

Param out_factor: The metalness if set.
Return: true if the setting is valid, false otherwise.

bool ShowMetalnessMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel)

Shows the metalness map name.

Param out_texture_name: The metalness map name if set.
Param out_channel: The channel.
Return: true if the setting is valid, false otherwise.

bool ShowNormalFactor (out float out_factor)

Shows the normal factor.

Param out_factor: The normal factor if set.
Return: true if the setting is valid, false otherwise.

bool ShowNormalMap (out string out_texture_name)

Shows the normal map name.

Param out_texture_name: The normal map name if set.
Return: true if the setting is valid, false otherwise.

bool ShowOcclusionFactor (out float out_factor)

Shows the occlusion factor.

Param out_factor: The occlusion if set.
Return: true if the setting is valid, false otherwise.

bool ShowOcclusionMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel)

Shows the occlusion map name.

Param out_texture_name: The occlusion map name if set.
Param out_channel: The channel.
Return: true if the setting is valid, false otherwise.

bool ShowRoughnessFactor (out float out_factor)

Shows the roughness factor.

Param out_factor: The roughness if set.
Return: true if the setting is valid, false otherwise.

bool ShowRoughnessMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel)

Shows the roughness map name.

Param out_texture_name: The roughness map name if set.
Param out_channel: The channel.
Return: true if the setting is valid, false otherwise.

HPS.PBRMaterialKit UnsetAlphaFactor ()

Removes the alpha factor from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetBaseColorFactor ()

Removes the base color factor from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetBaseColorMap ()

Removes the base color map from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetEmissiveMap ()

Removes the emissive map from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetMetalnessFactor ()

Removes the metalness factor from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetMetalnessMap ()

Removes the metalness map from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetNormalFactor ()

Removes the normal factor from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetNormalMap ()

Removes the normal map from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetOcclusionFactor ()

Removes the occlusion factor from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetOcclusionMap ()

Removes the occlusion map from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetRoughnessFactor ()

Removes the roughness factor from this kit type.

Return: A reference to this object.

HPS.PBRMaterialKit UnsetRoughnessMap ()

Removes the roughness map from this kit type.

Return: A reference to this object.

Public Static Functions

HPS.PBRMaterialKit GetDefault ()

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.

Return: A PBRMaterialKit with the default settings.

bool operator!= (HPS.PBRMaterialKit a, HPS.PBRMaterialKit b)

bool operator== (HPS.PBRMaterialKit a, HPS.PBRMaterialKit b)