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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.PBRMaterialKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 PBRMaterialKit ()
 
 PBRMaterialKit (HPS.PBRMaterialKit in_kit)
 
void Set (HPS.PBRMaterialKit in_kit)
 
HPS.PBRMaterialKit SetAlphaFactor (float in_factor, bool in_mask)
 
HPS.PBRMaterialKit SetAlphaFactor (float in_factor)
 
HPS.PBRMaterialKit SetBaseColorFactor (HPS.RGBAColor in_color)
 
HPS.PBRMaterialKit SetBaseColorMap (string in_texture_name)
 
HPS.PBRMaterialKit SetEmissiveMap (string in_texture_name)
 
HPS.PBRMaterialKit SetMetalnessFactor (float in_factor)
 
HPS.PBRMaterialKit SetMetalnessMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel)
 
HPS.PBRMaterialKit SetMetalnessMap (string in_texture_name)
 
HPS.PBRMaterialKit SetNormalFactor (float in_factor)
 
HPS.PBRMaterialKit SetNormalMap (string in_texture_name)
 
HPS.PBRMaterialKit SetOcclusionFactor (float in_factor)
 
HPS.PBRMaterialKit SetOcclusionMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel)
 
HPS.PBRMaterialKit SetOcclusionMap (string in_texture_name)
 
HPS.PBRMaterialKit SetRoughnessFactor (float in_factor)
 
HPS.PBRMaterialKit SetRoughnessMap (string in_texture_name, HPS.Material.Texture.ChannelMapping in_channel)
 
HPS.PBRMaterialKit SetRoughnessMap (string in_texture_name)
 
void Show (out HPS.PBRMaterialKit out_kit)
 
bool ShowAlphaFactor (out float out_factor, out bool out_mask)
 
bool ShowBaseColorFactor (out HPS.RGBAColor out_color)
 
bool ShowBaseColorMap (out string out_texture_name)
 
bool ShowEmissiveMap (out string out_texture_name)
 
bool ShowMetalnessFactor (out float out_factor)
 
bool ShowMetalnessMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel)
 
bool ShowNormalFactor (out float out_factor)
 
bool ShowNormalMap (out string out_texture_name)
 
bool ShowOcclusionFactor (out float out_factor)
 
bool ShowOcclusionMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel)
 
bool ShowRoughnessFactor (out float out_factor)
 
bool ShowRoughnessMap (out string out_texture_name, out HPS.Material.Texture.ChannelMapping out_channel)
 
HPS.PBRMaterialKit UnsetAlphaFactor ()
 
HPS.PBRMaterialKit UnsetBaseColorFactor ()
 
HPS.PBRMaterialKit UnsetBaseColorMap ()
 
HPS.PBRMaterialKit UnsetEmissiveMap ()
 
HPS.PBRMaterialKit UnsetEverything ()
 
HPS.PBRMaterialKit UnsetMetalnessFactor ()
 
HPS.PBRMaterialKit UnsetMetalnessMap ()
 
HPS.PBRMaterialKit UnsetNormalFactor ()
 
HPS.PBRMaterialKit UnsetNormalMap ()
 
HPS.PBRMaterialKit UnsetOcclusionFactor ()
 
HPS.PBRMaterialKit UnsetOcclusionMap ()
 
HPS.PBRMaterialKit UnsetRoughnessFactor ()
 
HPS.PBRMaterialKit UnsetRoughnessMap ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.PBRMaterialKit GetDefault ()
 
static bool operator!= (HPS.PBRMaterialKit a, HPS.PBRMaterialKit b)
 
static bool operator== (HPS.PBRMaterialKit a, HPS.PBRMaterialKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ PBRMaterialKit() [1/2]

HPS.PBRMaterialKit.PBRMaterialKit ( )
inline

Initializes an empty kit.

◆ PBRMaterialKit() [2/2]

HPS.PBRMaterialKit.PBRMaterialKit ( HPS.PBRMaterialKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ 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()

bool HPS.PBRMaterialKit.Equals ( HPS.PBRMaterialKit  in_kit)
inline

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

◆ 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()

void HPS.PBRMaterialKit.Set ( HPS.PBRMaterialKit  in_kit)
inline

Copies all settings from the source PBRMaterialKit into this object.

Parameters
in_kitThe source PBRMaterialKit to copy.

◆ SetAlphaFactor() [1/2]

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetAlphaFactor ( float  in_factor,
bool  in_mask 
)
inline

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.

◆ SetAlphaFactor() [2/2]

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetAlphaFactor ( float  in_factor)
inline

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

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

◆ SetBaseColorFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetBaseColorFactor ( HPS.RGBAColor  in_color)
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_colorThe base color factor to use.
Returns
A reference to this object.

◆ SetBaseColorMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetBaseColorMap ( string  in_texture_name)
inline

Sets the base color map.

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

◆ SetEmissiveMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetEmissiveMap ( string  in_texture_name)
inline

Sets the emissive map.

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

◆ SetMetalnessFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetMetalnessFactor ( float  in_factor)
inline

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() [1/2]

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

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.

◆ SetMetalnessMap() [2/2]

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetMetalnessMap ( string  in_texture_name)
inline

Sets the metalness map.

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

◆ SetNormalFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetNormalFactor ( float  in_factor)
inline

Sets the normal factor which scales the normal map.

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

◆ SetNormalMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetNormalMap ( string  in_texture_name)
inline

Sets the normal map.

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

◆ SetOcclusionFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetOcclusionFactor ( float  in_factor)
inline

Sets the occlusion factor which scales the occlusion map.

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

◆ SetOcclusionMap() [1/2]

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

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.

◆ SetOcclusionMap() [2/2]

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetOcclusionMap ( string  in_texture_name)
inline

Sets the occlusion map.

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

◆ SetRoughnessFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetRoughnessFactor ( float  in_factor)
inline

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() [1/2]

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

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.

◆ SetRoughnessMap() [2/2]

HPS.PBRMaterialKit HPS.PBRMaterialKit.SetRoughnessMap ( string  in_texture_name)
inline

Sets the roughness map.

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

◆ Show()

void HPS.PBRMaterialKit.Show ( out HPS.PBRMaterialKit  out_kit)
inline

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 ( out float  out_factor,
out bool  out_mask 
)
inline

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 ( out HPS.RGBAColor  out_color)
inline

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 ( out string  out_texture_name)
inline

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 ( out string  out_texture_name)
inline

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 ( out float  out_factor)
inline

Shows the metalness factor.

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

◆ ShowMetalnessMap()

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

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 ( out float  out_factor)
inline

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 ( out string  out_texture_name)
inline

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 ( out float  out_factor)
inline

Shows the occlusion factor.

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

◆ ShowOcclusionMap()

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

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 ( out float  out_factor)
inline

Shows the roughness factor.

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

◆ ShowRoughnessMap()

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

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

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetAlphaFactor ( )
inline

Removes the alpha factor from this kit type.

Returns
A reference to this object.

◆ UnsetBaseColorFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetBaseColorFactor ( )
inline

Removes the base color factor from this kit type.

Returns
A reference to this object.

◆ UnsetBaseColorMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetBaseColorMap ( )
inline

Removes the base color map from this kit type.

Returns
A reference to this object.

◆ UnsetEmissiveMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetEmissiveMap ( )
inline

Removes the emissive map from this kit type.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMetalnessFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetMetalnessFactor ( )
inline

Removes the metalness factor from this kit type.

Returns
A reference to this object.

◆ UnsetMetalnessMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetMetalnessMap ( )
inline

Removes the metalness map from this kit type.

Returns
A reference to this object.

◆ UnsetNormalFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetNormalFactor ( )
inline

Removes the normal factor from this kit type.

Returns
A reference to this object.

◆ UnsetNormalMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetNormalMap ( )
inline

Removes the normal map from this kit type.

Returns
A reference to this object.

◆ UnsetOcclusionFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetOcclusionFactor ( )
inline

Removes the occlusion factor from this kit type.

Returns
A reference to this object.

◆ UnsetOcclusionMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetOcclusionMap ( )
inline

Removes the occlusion map from this kit type.

Returns
A reference to this object.

◆ UnsetRoughnessFactor()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetRoughnessFactor ( )
inline

Removes the roughness factor from this kit type.

Returns
A reference to this object.

◆ UnsetRoughnessMap()

HPS.PBRMaterialKit HPS.PBRMaterialKit.UnsetRoughnessMap ( )
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