|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.PBRMaterialKit class is a user space object, used for grouping attribute settings related to PBR materials.
◆ PBRMaterialKit() [1/2]
HPS.PBRMaterialKit.PBRMaterialKit |
( |
| ) |
|
|
inline |
Initializes an empty kit.
◆ PBRMaterialKit() [2/2]
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. |
◆ Empty()
override bool HPS.PBRMaterialKit.Empty |
( |
| ) |
|
|
inlinevirtual |
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()
Check if the source PBRMaterialKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A PBRMaterialKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.PBRMaterialKit.ObjectType |
( |
| ) |
|
|
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.
◆ Set()
Copies all settings from the source PBRMaterialKit into this object.
- Parameters
-
◆ SetAlphaFactor() [1/2]
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.
◆ SetAlphaFactor() [2/2]
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. |
- Returns
- A reference to this object.
◆ SetBaseColorFactor()
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.
◆ SetBaseColorMap()
Sets the base color map.
- Parameters
-
in_texture_name | The base color factor to use. |
- Returns
- A reference to this object.
◆ SetEmissiveMap()
Sets the emissive map.
- Parameters
-
in_texture_name | The base color factor to use. |
- Returns
- A reference to this object.
◆ SetMetalnessFactor()
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.
◆ SetMetalnessMap() [1/2]
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.
◆ SetMetalnessMap() [2/2]
Sets the metalness map.
- Parameters
-
in_texture_name | The base color factor to use. |
- Returns
- A reference to this object.
◆ SetNormalFactor()
Sets the normal factor which scales the normal map.
- Parameters
-
in_factor | The factor to use. |
- Returns
- A reference to this object.
◆ SetNormalMap()
Sets the normal map.
- Parameters
-
in_texture_name | The base color factor to use. |
- Returns
- A reference to this object.
◆ SetOcclusionFactor()
Sets the occlusion factor which scales the occlusion map.
- Parameters
-
in_factor | The factor to use. |
- Returns
- A reference to this object.
◆ SetOcclusionMap() [1/2]
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.
◆ SetOcclusionMap() [2/2]
Sets the occlusion map.
- Parameters
-
in_texture_name | The base color factor to use. |
- Returns
- A reference to this object.
◆ SetRoughnessFactor()
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.
◆ SetRoughnessMap() [1/2]
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.
◆ SetRoughnessMap() [2/2]
Sets the roughness map.
- Parameters
-
in_texture_name | The base color factor to use. |
- Returns
- A reference to this object.
◆ Show()
◆ ShowAlphaFactor()
bool HPS.PBRMaterialKit.ShowAlphaFactor |
( |
out float |
out_factor, |
|
|
out bool |
out_mask |
|
) |
| |
|
inline |
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.
◆ ShowBaseColorFactor()
bool HPS.PBRMaterialKit.ShowBaseColorFactor |
( |
out HPS.RGBAColor |
out_color | ) |
|
|
inline |
Shows the base color factor.
- Parameters
-
out_color | The base color factor if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowBaseColorMap()
bool HPS.PBRMaterialKit.ShowBaseColorMap |
( |
out string |
out_texture_name | ) |
|
|
inline |
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.
◆ ShowEmissiveMap()
bool HPS.PBRMaterialKit.ShowEmissiveMap |
( |
out string |
out_texture_name | ) |
|
|
inline |
Shows the emissive map name.
- Parameters
-
out_texture_name | The emissive map name if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowMetalnessFactor()
bool HPS.PBRMaterialKit.ShowMetalnessFactor |
( |
out float |
out_factor | ) |
|
|
inline |
Shows the metalness factor.
- Parameters
-
out_factor | The metalness if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowMetalnessMap()
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.
◆ ShowNormalFactor()
bool HPS.PBRMaterialKit.ShowNormalFactor |
( |
out float |
out_factor | ) |
|
|
inline |
Shows the normal factor.
- Parameters
-
out_factor | The normal factor if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowNormalMap()
bool HPS.PBRMaterialKit.ShowNormalMap |
( |
out string |
out_texture_name | ) |
|
|
inline |
Shows the normal map name.
- Parameters
-
out_texture_name | The normal map name if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowOcclusionFactor()
bool HPS.PBRMaterialKit.ShowOcclusionFactor |
( |
out float |
out_factor | ) |
|
|
inline |
Shows the occlusion factor.
- Parameters
-
out_factor | The occlusion if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowOcclusionMap()
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.
◆ ShowRoughnessFactor()
bool HPS.PBRMaterialKit.ShowRoughnessFactor |
( |
out float |
out_factor | ) |
|
|
inline |
Shows the roughness factor.
- Parameters
-
out_factor | The roughness if set. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowRoughnessMap()
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.
◆ UnsetAlphaFactor()
Removes the alpha factor from this kit type.
- Returns
- A reference to this object.
◆ UnsetBaseColorFactor()
Removes the base color factor from this kit type.
- Returns
- A reference to this object.
◆ UnsetBaseColorMap()
Removes the base color map from this kit type.
- Returns
- A reference to this object.
◆ UnsetEmissiveMap()
Removes the emissive map from this kit type.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetMetalnessFactor()
Removes the metalness factor from this kit type.
- Returns
- A reference to this object.
◆ UnsetMetalnessMap()
Removes the metalness map from this kit type.
- Returns
- A reference to this object.
◆ UnsetNormalFactor()
Removes the normal factor from this kit type.
- Returns
- A reference to this object.
◆ UnsetNormalMap()
Removes the normal map from this kit type.
- Returns
- A reference to this object.
◆ UnsetOcclusionFactor()
Removes the occlusion factor from this kit type.
- Returns
- A reference to this object.
◆ UnsetOcclusionMap()
Removes the occlusion map from this kit type.
- Returns
- A reference to this object.
◆ UnsetRoughnessFactor()
Removes the roughness factor from this kit type.
- Returns
- A reference to this object.
◆ 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:
- internals/hps_core/source/cs/HPS.PBRMaterialKit.cs