
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.PBRMaterialKit in_kit) |
Check if the source PBRMaterialKit is equivalent to this object. More... | |
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). More... | |
PBRMaterialKit () | |
Initializes an empty kit. More... | |
PBRMaterialKit (HPS.PBRMaterialKit in_kit) | |
The copy constructor creates a new PBRMaterialKit object that contains the same settings as the source object. More... | |
void | Set (HPS.PBRMaterialKit in_kit) |
Copies all settings from the source PBRMaterialKit into this object. More... | |
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. More... | |
HPS.PBRMaterialKit | SetAlphaFactor (float in_factor) |
Sets the alpha factor which scales the alpha map or acts as the alpha if no map exists. More... | |
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. More... | |
HPS.PBRMaterialKit | SetBaseColorMap (string in_texture_name) |
Sets the base color map. More... | |
HPS.PBRMaterialKit | SetEmissiveMap (string in_texture_name) |
Sets the emissive map. More... | |
HPS.PBRMaterialKit | SetMetalnessFactor (float in_factor) |
Sets the metalness factor which scales the metalness map or acts as the metalness if no map exists. More... | |
HPS.PBRMaterialKit | SetMetalnessMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel) |
Sets the metalness map. More... | |
HPS.PBRMaterialKit | SetMetalnessMap (string in_texture_name) |
Sets the metalness map. More... | |
HPS.PBRMaterialKit | SetNormalFactor (float in_factor) |
Sets the normal factor which scales the normal map. More... | |
HPS.PBRMaterialKit | SetNormalMap (string in_texture_name) |
Sets the normal map. More... | |
HPS.PBRMaterialKit | SetOcclusionFactor (float in_factor) |
Sets the occlusion factor which scales the occlusion map. More... | |
HPS.PBRMaterialKit | SetOcclusionMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel) |
Sets the occlusion map. More... | |
HPS.PBRMaterialKit | SetOcclusionMap (string in_texture_name) |
Sets the occlusion map. More... | |
HPS.PBRMaterialKit | SetRoughnessFactor (float in_factor) |
Sets the roughness factor which scales the roughness map or acts as the roughness if no map exists. More... | |
HPS.PBRMaterialKit | SetRoughnessMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel) |
Sets the roughness map. More... | |
HPS.PBRMaterialKit | SetRoughnessMap (string in_texture_name) |
Sets the roughness map. More... | |
void | Show (out HPS.PBRMaterialKit out_kit) |
Copies all settings from this PBRMaterialKit into the given PBRMaterialKit. More... | |
bool | ShowAlphaFactor (out float out_factor, out bool out_mask) |
Shows the alpha factor and alpha mask. More... | |
bool | ShowBaseColorFactor (out HPS.RGBAColor out_color) |
Shows the base color factor. More... | |
bool | ShowBaseColorMap (out string out_texture_name) |
Shows the base color map name. More... | |
bool | ShowEmissiveMap (out string out_texture_name) |
Shows the emissive map name. More... | |
bool | ShowMetalnessFactor (out float out_factor) |
Shows the metalness factor. More... | |
bool | ShowMetalnessMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel) |
Shows the metalness map name. More... | |
bool | ShowNormalFactor (out float out_factor) |
Shows the normal factor. More... | |
bool | ShowNormalMap (out string out_texture_name) |
Shows the normal map name. More... | |
bool | ShowOcclusionFactor (out float out_factor) |
Shows the occlusion factor. More... | |
bool | ShowOcclusionMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel) |
Shows the occlusion map name. More... | |
bool | ShowRoughnessFactor (out float out_factor) |
Shows the roughness factor. More... | |
bool | ShowRoughnessMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel) |
Shows the roughness map name. More... | |
HPS.PBRMaterialKit | UnsetAlphaFactor () |
Removes the alpha factor from this kit type. More... | |
HPS.PBRMaterialKit | UnsetBaseColorFactor () |
Removes the base color factor from this kit type. More... | |
HPS.PBRMaterialKit | UnsetBaseColorMap () |
Removes the base color map from this kit type. More... | |
HPS.PBRMaterialKit | UnsetEmissiveMap () |
Removes the emissive map from this kit type. More... | |
HPS.PBRMaterialKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.PBRMaterialKit | UnsetMetalnessFactor () |
Removes the metalness factor from this kit type. More... | |
HPS.PBRMaterialKit | UnsetMetalnessMap () |
Removes the metalness map from this kit type. More... | |
HPS.PBRMaterialKit | UnsetNormalFactor () |
Removes the normal factor from this kit type. More... | |
HPS.PBRMaterialKit | UnsetNormalMap () |
Removes the normal map from this kit type. More... | |
HPS.PBRMaterialKit | UnsetOcclusionFactor () |
Removes the occlusion factor from this kit type. More... | |
HPS.PBRMaterialKit | UnsetOcclusionMap () |
Removes the occlusion map from this kit type. More... | |
HPS.PBRMaterialKit | UnsetRoughnessFactor () |
Removes the roughness factor from this kit type. More... | |
HPS.PBRMaterialKit | UnsetRoughnessMap () |
Removes the roughness map from this kit type. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.PBRMaterialKit a, HPS.PBRMaterialKit b) |
static bool | operator== (HPS.PBRMaterialKit a, HPS.PBRMaterialKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.PBRMaterialKit class is a user space object, used for grouping attribute settings related to PBR materials.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
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.
Member Function Documentation
|
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.
|
inline |
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.
|
inlinestatic |
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.
|
inline |
Copies all settings from the source PBRMaterialKit into this object.
- Parameters
-
in_kit The source PBRMaterialKit to copy.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Sets the base color map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
|
inline |
Sets the emissive map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Sets the metalness map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
|
inline |
Sets the normal factor which scales the normal map.
- Parameters
-
in_factor The factor to use.
- Returns
- A reference to this object.
|
inline |
Sets the normal map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
|
inline |
Sets the occlusion factor which scales the occlusion map.
- Parameters
-
in_factor The factor to use.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
Sets the occlusion map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Sets the roughness map.
- Parameters
-
in_texture_name The base color factor to use.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this PBRMaterialKit into the given PBRMaterialKit.
- Parameters
-
out_kit The PBRMaterialKit to populate with the contents of this object.
|
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.
|
inline |
Shows the base color factor.
- Parameters
-
out_color The base color factor if set.
- Returns
- true if the setting is valid, false otherwise.
|
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.
|
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.
|
inline |
Shows the metalness factor.
- Parameters
-
out_factor The metalness if set.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
Shows the normal factor.
- Parameters
-
out_factor The normal factor if set.
- Returns
- true if the setting is valid, false otherwise.
|
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.
|
inline |
Shows the occlusion factor.
- Parameters
-
out_factor The occlusion if set.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
Shows the roughness factor.
- Parameters
-
out_factor The roughness if set.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
Removes the alpha factor from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the base color factor from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the base color map from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the emissive map from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the metalness factor from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the metalness map from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the normal factor from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the normal map from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the occlusion factor from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the occlusion map from this kit type.
- Returns
- A reference to this object.
|
inline |
Removes the roughness factor from this kit type.
- Returns
- A reference to this object.
|
inline |
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