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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MaterialKit in_kit)
 
override int GetHashCode ()
 
 MaterialKit ()
 
 MaterialKit (HPS.MaterialKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.MaterialKit in_kit)
 
HPS.MaterialKit SetBump (string in_texture_name)
 
HPS.MaterialKit SetDiffuse (HPS.RGBColor in_color)
 
HPS.MaterialKit SetDiffuse (HPS.RGBAColor in_color)
 
HPS.MaterialKit SetDiffuseAlpha (float in_alpha)
 
HPS.MaterialKit SetDiffuseColor (HPS.RGBColor in_color)
 
HPS.MaterialKit SetDiffuseColor (HPS.RGBAColor in_color)
 
HPS.MaterialKit SetDiffuseTexture (string in_texture_name, ulong in_layer)
 
HPS.MaterialKit SetDiffuseTexture (string in_texture_name)
 
HPS.MaterialKit SetDiffuseTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, ulong in_layer)
 
HPS.MaterialKit SetDiffuseTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialKit SetDiffuseTexture (string[] in_texture_names)
 
HPS.MaterialKit SetDiffuseTexture (string[] in_texture_names, HPS.RGBAColor[] in_modulating_colors)
 
HPS.MaterialKit SetEmission (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialKit SetEmission (string in_texture_name)
 
HPS.MaterialKit SetEmission (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialKit SetEnvironmentCubeMap (string in_cubemap_name)
 
HPS.MaterialKit SetEnvironmentCubeMap (string in_cubemap_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialKit SetEnvironmentTexture (string in_texture_name)
 
HPS.MaterialKit SetEnvironmentTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialKit SetEnvironmentTexture ()
 
HPS.MaterialKit SetGloss (float in_gloss)
 
HPS.MaterialKit SetMirror (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialKit SetMirror (string in_texture_name)
 
HPS.MaterialKit SetMirror (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialKit SetSpecular (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialKit SetSpecular (string in_texture_name)
 
HPS.MaterialKit SetSpecular (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialKit SetTransmission (string in_texture_name)
 
HPS.MaterialKit SetTransmission (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
void Show (out HPS.MaterialKit out_kit)
 
bool ShowBump (out string out_texture_name)
 
bool ShowDiffuse ()
 
bool ShowDiffuseAlpha (out float out_alpha)
 
bool ShowDiffuseColor (out HPS.RGBColor out_rgb_color)
 
bool ShowDiffuseColor (out HPS.RGBAColor out_rgba_color)
 
bool ShowDiffuseTexture (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
bool ShowDiffuseTexture (ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
bool ShowDiffuseTexture (out HPS.Material.Type[] out_types, out HPS.RGBAColor[] out_colors, out string[] out_texture_names)
 
bool ShowEmission (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
bool ShowEnvironment (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
bool ShowGloss (out float out_gloss)
 
bool ShowMirror (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
bool ShowSpecular (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
bool ShowTransmission (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name)
 
HPS.MaterialKit UnsetBump ()
 
HPS.MaterialKit UnsetDiffuseAlpha ()
 
HPS.MaterialKit UnsetDiffuseColor ()
 
HPS.MaterialKit UnsetDiffuseColorRGB ()
 
HPS.MaterialKit UnsetDiffuseTexture ()
 
HPS.MaterialKit UnsetDiffuseTexture (ulong in_layer)
 
HPS.MaterialKit UnsetEmission ()
 
HPS.MaterialKit UnsetEnvironment ()
 
HPS.MaterialKit UnsetEverything ()
 
HPS.MaterialKit UnsetGloss ()
 
HPS.MaterialKit UnsetMirror ()
 
HPS.MaterialKit UnsetSpecular ()
 
HPS.MaterialKit UnsetTransmission ()
 
- 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 bool operator!= (HPS.MaterialKit a, HPS.MaterialKit b)
 
static bool operator== (HPS.MaterialKit a, HPS.MaterialKit 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 MaterialKit class is a user space object, useful for carrying a group of attribute settings. A MaterialKit can be associated with various geometry or subgeometery types using a material mapping kit or control.

Constructor & Destructor Documentation

◆ MaterialKit() [1/2]

HPS.MaterialKit.MaterialKit ( )
inline

The default constructor creates an empty MaterialKit object.

◆ MaterialKit() [2/2]

HPS.MaterialKit.MaterialKit ( HPS.MaterialKit  in_kit)
inline

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

Parameters
in_kitThe source MaterialKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.MaterialKit.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.MaterialKit.Equals ( HPS.MaterialKit  in_kit)
inline

Check if the source MaterialKit is equivalent to this object.

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

◆ ObjectType()

override HPS.Type HPS.MaterialKit.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.MaterialKit.Set ( HPS.MaterialKit  in_kit)
inline

Copies all settings from the source MaterialKit into this object.

Parameters
in_kitThe source MaterialKit to copy.

◆ SetBump()

HPS.MaterialKit HPS.MaterialKit.SetBump ( string  in_texture_name)
inline

Applies a named texture to the bump channel, replacing any other texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetDiffuse() [1/2]

HPS.MaterialKit HPS.MaterialKit.SetDiffuse ( HPS.RGBColor  in_color)
inline

Applies an RGB color to the whole diffuse channel, replacing any diffuse textures or shaders.

Parameters
in_colorThe color to be applied.
Returns
A reference to this object.

◆ SetDiffuse() [2/2]

HPS.MaterialKit HPS.MaterialKit.SetDiffuse ( HPS.RGBAColor  in_color)
inline

Applies an RGBA color to the whole diffuse channel, replacing any diffuse textures or shaders.

Parameters
in_colorThe color to be applied.
Returns
A reference to this object.

◆ SetDiffuseAlpha()

HPS.MaterialKit HPS.MaterialKit.SetDiffuseAlpha ( float  in_alpha)
inline

Applies an alpha channel the diffuse color channel. Only one diffuse color may be set at a time but it can coexist with diffuse textures if they have transparency. If diffuse color has not been set, white will be set as a default value in the diffuse color channel with a transparent value of in_alpha.

Parameters
in_alphaThe alpha to be applied.
Returns
A reference to this object.

◆ SetDiffuseColor() [1/2]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseColor ( HPS.RGBColor  in_color)
inline

Applies an RGB color to the diffuse color channel. Only one diffuse color may be set at a time but it can coexist with diffuse textures if they have transparency.

Parameters
in_colorThe color to be applied.
Returns
A reference to this object.

◆ SetDiffuseColor() [2/2]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseColor ( HPS.RGBAColor  in_color)
inline

Applies an RGBA color to the diffuse color channel. Only one diffuse color may be set at a time but it can coexist with diffuse textures if they have transparency.

Parameters
in_colorThe color to be applied.
Returns
A reference to this object.

◆ SetDiffuseTexture() [1/6]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseTexture ( string  in_texture_name,
ulong  in_layer 
)
inline

Applies a named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible. There are two special values that can be passed in here. A null pointer removes the texture name from that layer, allowing the texture on that layer to be inherited from above in the tree. Passing an empty string, "", removes the texture from that layer but indicates that no texture should be inherited from above, an explicit blank.
in_layerThe layer to apply the texture to. Higher numbered layers are applied on top of lower numbered ones.
Returns
A reference to this object.

◆ SetDiffuseTexture() [2/6]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseTexture ( string  in_texture_name)
inline

Applies a named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible. There are two special values that can be passed in here. A null pointer removes the texture name from that layer, allowing the texture on that layer to be inherited from above in the tree. Passing an empty string, "", removes the texture from that layer but indicates that no texture should be inherited from above, an explicit blank.
Returns
A reference to this object.

◆ SetDiffuseTexture() [3/6]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color,
ulong  in_layer 
)
inline

Applies a modulated named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible. There are two special values that can be passed in here. A null pointer removes the texture name from that layer, allowing the texture on that layer to be inherited from above in the tree. Passing an empty string, "", removes the texture from that layer but indicates that no texture should be inherited from above, an explicit blank.
in_modulating_colorA color that will be applied as a filter to the texture.
in_layerThe layer to apply the texture to. Higher numbered layers are applied on top of lower numbered ones.
Returns
A reference to this object.

◆ SetDiffuseTexture() [4/6]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible. There are two special values that can be passed in here. A null pointer removes the texture name from that layer, allowing the texture on that layer to be inherited from above in the tree. Passing an empty string, "", removes the texture from that layer but indicates that no texture should be inherited from above, an explicit blank.
in_modulating_colorA color that will be applied as a filter to the texture.
Returns
A reference to this object.

◆ SetDiffuseTexture() [5/6]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseTexture ( string []  in_texture_names)
inline

Applies named textures to each of the specified layers of the diffuse texture channel, replacing any other textures on those layers.

Parameters
in_texture_namesThe names of textures, one per layer. Uninitialized strings are ignored. An empty string, "", removes the texture from that layer but indicates that no texture should be inherited from above, an explicit blank.
Returns
A reference to this object.

◆ SetDiffuseTexture() [6/6]

HPS.MaterialKit HPS.MaterialKit.SetDiffuseTexture ( string []  in_texture_names,
HPS.RGBAColor []  in_modulating_colors 
)
inline

Applies named textures, possibly modulated, to each of the specified layers of the diffuse texture channel, replacing any other textures on those layers.

Parameters
in_texture_namesThe names of textures, one per layer. Uninitialized strings are ignored. An empty string, "", removes the texture from that layer but indicates that no texture should be inherited from above, an explicit blank.
in_modulating_colorsAn array of modulating colors to be applied to the corresponding layer. If a color in the this array is uninitialized, the texture on that layer will be unmodulated.
Returns
A reference to this object.

◆ SetEmission() [1/3]

HPS.MaterialKit HPS.MaterialKit.SetEmission ( HPS.RGBAColor  in_rgba_color)
inline

Applies an RGBA color to the emission channel, replacing any other color or texture on that channel.

Parameters
in_rgba_colorThe color to be applied.
Returns
A reference to this object.

◆ SetEmission() [2/3]

HPS.MaterialKit HPS.MaterialKit.SetEmission ( string  in_texture_name)
inline

Applies a named texture to the emission channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetEmission() [3/3]

HPS.MaterialKit HPS.MaterialKit.SetEmission ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named texture to the emission channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colorA color that will be applied as a filter to the texture.
Returns
A reference to this object.

◆ SetEnvironmentCubeMap() [1/2]

HPS.MaterialKit HPS.MaterialKit.SetEnvironmentCubeMap ( string  in_cubemap_name)
inline

Applies a named cube map to the environment channel, replacing any other texture or cube map on that channel.

Parameters
in_cubemap_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetEnvironmentCubeMap() [2/2]

HPS.MaterialKit HPS.MaterialKit.SetEnvironmentCubeMap ( string  in_cubemap_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named cube map to the environment channel, replacing any other texture or cube map on that channel.

Parameters
in_cubemap_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colorA color that will be applied as a filter to the cube map.
Returns
A reference to this object.

◆ SetEnvironmentTexture() [1/3]

HPS.MaterialKit HPS.MaterialKit.SetEnvironmentTexture ( string  in_texture_name)
inline

Applies a named texture to the environment channel, replacing any other texture or cube map on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetEnvironmentTexture() [2/3]

HPS.MaterialKit HPS.MaterialKit.SetEnvironmentTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named texture to the environment channel, replacing any other texture or cube map on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colorA color that will be applied as a filter to the texture.
Returns
A reference to this object.

◆ SetEnvironmentTexture() [3/3]

HPS.MaterialKit HPS.MaterialKit.SetEnvironmentTexture ( )
inline

Cancels any other texture or cube map on the environment channel.

Returns
A reference to this object.

◆ SetGloss()

HPS.MaterialKit HPS.MaterialKit.SetGloss ( float  in_gloss)
inline

Gloss is a setting that helps to determine the specular response of a material. It is a single floating point value that describes the "focus" of specular reflections off a surface. The gloss value changes the area of the "glare" off a surface. A high gloss value gives a small, focused glare; a low gloss value results in a less polished, more scattered reflection.

Parameters
in_glossGloss is always positive, and most surfaces have a gloss in the range of 1.0 to 30.0.
Returns
A reference to this object.

◆ SetMirror() [1/3]

HPS.MaterialKit HPS.MaterialKit.SetMirror ( HPS.RGBAColor  in_rgba_color)
inline

Applies an RGBA color to the mirror channel, replacing any other color or texture on that channel.

Parameters
in_rgba_colorThe color to be applied.
Returns
A reference to this object.

◆ SetMirror() [2/3]

HPS.MaterialKit HPS.MaterialKit.SetMirror ( string  in_texture_name)
inline

Applies a named texture to the mirror channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetMirror() [3/3]

HPS.MaterialKit HPS.MaterialKit.SetMirror ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named texture to the mirror channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colorA color that will be applied as a filter to the texture.
Returns
A reference to this object.

◆ SetSpecular() [1/3]

HPS.MaterialKit HPS.MaterialKit.SetSpecular ( HPS.RGBAColor  in_rgba_color)
inline

Applies an RGBA color to the specular channel, replacing any other color or texture on that channel.

Parameters
in_rgba_colorThe color to be applied.
Returns
A reference to this object.

◆ SetSpecular() [2/3]

HPS.MaterialKit HPS.MaterialKit.SetSpecular ( string  in_texture_name)
inline

Applies a named texture to the specular channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetSpecular() [3/3]

HPS.MaterialKit HPS.MaterialKit.SetSpecular ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named texture to the specular channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colorA color that will be applied as a filter to the texture.
Returns
A reference to this object.

◆ SetTransmission() [1/2]

HPS.MaterialKit HPS.MaterialKit.SetTransmission ( string  in_texture_name)
inline

Applies a named texture to the transmission channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetTransmission() [2/2]

HPS.MaterialKit HPS.MaterialKit.SetTransmission ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

Applies a modulated named texture to the transmission channel, replacing any other color or texture on that channel.

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colorA color that will be applied as a filter to the texture.
Returns
A reference to this object.

◆ Show()

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

Copies all settings from this MaterialKit into the given MaterialKit.

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

◆ ShowBump()

bool HPS.MaterialKit.ShowBump ( out string  out_texture_name)
inline

Retrieves the texture applied to the bump channel.

Parameters
out_texture_nameThe name of a texture applied to this channel.
Returns
true if a texture has been set on the bump channel, false otherwise.

◆ ShowDiffuse()

bool HPS.MaterialKit.ShowDiffuse ( )
inline

If the diffuse color will override textures and shaders.

Returns
true if the diffuse color will override textures and shaders, false otherwise.

◆ ShowDiffuseAlpha()

bool HPS.MaterialKit.ShowDiffuseAlpha ( out float  out_alpha)
inline

Retrieves alpha set on the diffuse alpha channel.

Parameters
out_alphaThe color set on the diffuse alpha channel.
Returns
true if the internal selection limit is valid, false otherwise.

◆ ShowDiffuseColor() [1/2]

bool HPS.MaterialKit.ShowDiffuseColor ( out HPS.RGBColor  out_rgb_color)
inline

Retrieves RGB color set on the diffuse RGB channel.

Parameters
out_rgb_colorThe RGB color set on the diffuse RGB channel.
Returns
true if the diffuse RGB color is valid, false otherwise.

◆ ShowDiffuseColor() [2/2]

bool HPS.MaterialKit.ShowDiffuseColor ( out HPS.RGBAColor  out_rgba_color)
inline

Retrieves RGBA color set on the diffuse color channel.

Parameters
out_rgba_colorThe RGBA color set on the diffuse color channel.
Returns
true if the diffuse RGB color is valid, false otherwise.

◆ ShowDiffuseTexture() [1/3]

bool HPS.MaterialKit.ShowDiffuseTexture ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the possibly modulated texture applied to layer 0 of the diffuse texture channel.

Parameters
out_typeIndicates which of the following arguments is valid. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA modulating color applied as a filter to the named texture, only valid if out_type is ModulatedTexture.
out_texture_nameThe name of a texture applied to this channel.
Returns
true if a texture has been set on layer 0 of the diffuse texture channel, false otherwise.

◆ ShowDiffuseTexture() [2/3]

bool HPS.MaterialKit.ShowDiffuseTexture ( ulong  in_layer,
out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the possibly modulated texture applied to the specified layer of the diffuse texture channel.

Parameters
in_layerThe layer number to query for a texture.
out_typeIndicates which of the following arguments is valid. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA modulating color applied as a filter to the named texture, only valid if out_type is ModulatedTexture.
out_texture_nameThe name of a texture applied to this channel.
Returns
true if a texture has been set on the specified layer of the diffuse texture channel, false otherwise.

◆ ShowDiffuseTexture() [3/3]

bool HPS.MaterialKit.ShowDiffuseTexture ( out HPS.Material.Type []  out_types,
out HPS.RGBAColor []  out_colors,
out string []  out_texture_names 
)
inline

Retrieves the possibly modulated textures applied to all layers of the diffuse texture channel.

Parameters
out_typesAn array of types indicating which of the following arguments is valid for each layer. If a type is TextureName, only the texture name is valid, the color should be ignored. If a type is ModulatedTexture, both the texture name and the modulating color are valid. If a type is Nothing, there is no texture applied to that layer
out_colorsAn array of modulating colors applied as filters to the named textures, each entry is only valid if the corresponding entry in out_types is ModulatedTexture.
out_texture_namesAn array of names of a textures applied to this channel, indexed by layer.
Returns
true if any texture has been set on the diffuse texture channel, false otherwise.

◆ ShowEmission()

bool HPS.MaterialKit.ShowEmission ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the color, texture, or modulated texture applied to the emission channel.

Parameters
out_typeIndicates which of the following arguments is valid. If the type is RGBAColor, only out_color is valid, the texture name should be ignored. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA color used either for the entire channel or to modulate a texture on this channel. See out_type to determine if this color is valid.
out_texture_nameThe name of a possibly modulated texture applied to this channel. See out_type to determine if this texture name is valid.
Returns
true if any color or texture has been set on the emission channel, false otherwise.

◆ ShowEnvironment()

bool HPS.MaterialKit.ShowEnvironment ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the color, texture, or modulated texture applied to the environment channel.

Parameters
out_typeIndicates which of the following arguments is valid. If the type is RGBAColor, only out_color is valid, the texture name should be ignored. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA color used either for the entire channel or to modulate a texture on this channel. See out_type to determine if this color is valid.
out_texture_nameThe name of a possibly modulated texture applied to this channel. See out_type to determine if this texture name is valid.
Returns
true if any color or texture has been set on the environment channel, false otherwise.

◆ ShowGloss()

bool HPS.MaterialKit.ShowGloss ( out float  out_gloss)
inline

Retrieves the gloss of this material. Gloss is a single floating point value that describes the "focus" of specular reflections off a surface.

Parameters
out_glossThe gloss value of this material. Gloss is always positive, and most surfaces have a gloss in the range of 1.0 to 30.0.
Returns
true if gloss has been specified for this material, false otherwise.
See also
SetGloss().

◆ ShowMirror()

bool HPS.MaterialKit.ShowMirror ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the color, texture, or modulated texture applied to the mirror channel.

Parameters
out_typeIndicates which of the following arguments is valid. If the type is RGBAColor, only out_color is valid, the texture name should be ignored. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA color used either for the entire channel or to modulate a texture on this channel. See out_type to determine if this color is valid.
out_texture_nameThe name of a possibly modulated texture applied to this channel. See out_type to determine if this texture name is valid.
Returns
true if any color or texture has been set on the mirror channel, false otherwise.

◆ ShowSpecular()

bool HPS.MaterialKit.ShowSpecular ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the color, texture, or modulated texture applied to the specular channel.

Parameters
out_typeIndicates which of the following arguments is valid. If the type is RGBAColor, only out_color is valid, the texture name should be ignored. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA color used either for the entire channel or to modulate a texture on this channel. See out_type to determine if this color is valid.
out_texture_nameThe name of a possibly modulated texture applied to this channel. See out_type to determine if this texture name is valid.
Returns
true if any color or texture has been set on the specular channel, false otherwise.

◆ ShowTransmission()

bool HPS.MaterialKit.ShowTransmission ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_color,
out string  out_texture_name 
)
inline

Retrieves the color, texture, or modulated texture applied to the transmission channel.

Parameters
out_typeIndicates which of the following arguments is valid. If the type is RGBAColor, only out_color is valid, the texture name should be ignored. If the type is TextureName, only the texture name is valid, the color should be ignored. If the type is ModulatedTexture, both the texture name and the modulating color are valid.
out_colorA color used either for the entire channel or to modulate a texture on this channel. See out_type to determine if this color is valid.
out_texture_nameThe name of a possibly modulated texture applied to this channel. See out_type to determine if this texture name is valid.
Returns
true if any color or texture has been set on the transmission channel, false otherwise.

◆ UnsetBump()

HPS.MaterialKit HPS.MaterialKit.UnsetBump ( )
inline

Removes all settings applied to the bump channel.

Returns
A reference to this object.

◆ UnsetDiffuseAlpha()

HPS.MaterialKit HPS.MaterialKit.UnsetDiffuseAlpha ( )
inline

Removes all settings applied to the diffuse alpha channel.

Returns
A reference to this object.

◆ UnsetDiffuseColor()

HPS.MaterialKit HPS.MaterialKit.UnsetDiffuseColor ( )
inline

Removes all settings applied to the diffuse color channel including alpha.

Returns
A reference to this object.

◆ UnsetDiffuseColorRGB()

HPS.MaterialKit HPS.MaterialKit.UnsetDiffuseColorRGB ( )
inline

Removes all settings applied to the diffuse rgb channel.

Returns
A reference to this object.

◆ UnsetDiffuseTexture() [1/2]

HPS.MaterialKit HPS.MaterialKit.UnsetDiffuseTexture ( )
inline

Removes all settings applied to all layers of the diffuse texture channel.

Returns
A reference to this object.

◆ UnsetDiffuseTexture() [2/2]

HPS.MaterialKit HPS.MaterialKit.UnsetDiffuseTexture ( ulong  in_layer)
inline

Removes all settings applied to the specified layer of the diffuse texture channel.

Parameters
in_layerThe layer to remove the setting from.
Returns
A reference to this object.

◆ UnsetEmission()

HPS.MaterialKit HPS.MaterialKit.UnsetEmission ( )
inline

Removes all settings applied to the emission channel.

Returns
A reference to this object.

◆ UnsetEnvironment()

HPS.MaterialKit HPS.MaterialKit.UnsetEnvironment ( )
inline

Removes all settings applied to the environment channel.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.MaterialKit HPS.MaterialKit.UnsetEverything ( )
inline

Removes all setting from this material.

Returns
A reference to this object.

◆ UnsetGloss()

HPS.MaterialKit HPS.MaterialKit.UnsetGloss ( )
inline

Removes the gloss setting applied to this material.

Returns
A reference to this object.

◆ UnsetMirror()

HPS.MaterialKit HPS.MaterialKit.UnsetMirror ( )
inline

Removes all settings applied to the mirror channel.

Returns
A reference to this object.

◆ UnsetSpecular()

HPS.MaterialKit HPS.MaterialKit.UnsetSpecular ( )
inline

Removes all settings applied to the specular channel.

Returns
A reference to this object.

◆ UnsetTransmission()

HPS.MaterialKit HPS.MaterialKit.UnsetTransmission ( )
inline

Removes all settings applied to the transmission channel.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.MaterialKit.cs