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

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.MaterialKit in_kit) |
Check if the source MaterialKit is equivalent to this object. More... | |
override int | GetHashCode () |
MaterialKit () | |
The default constructor creates an empty MaterialKit object. More... | |
MaterialKit (HPS.MaterialKit in_kit) | |
The copy constructor creates a new MaterialKit object that contains the same settings as the source. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.MaterialKit in_kit) |
Copies all settings from the source MaterialKit into this object. More... | |
HPS.MaterialKit | SetBump (string in_texture_name) |
Applies a named texture to the bump channel, replacing any other texture on that channel. More... | |
HPS.MaterialKit | SetDiffuse (HPS.RGBColor in_color) |
Applies an RGB color to the whole diffuse channel, replacing any diffuse textures or shaders. More... | |
HPS.MaterialKit | SetDiffuse (HPS.RGBAColor in_color) |
Applies an RGBA color to the whole diffuse channel, replacing any diffuse textures or shaders. More... | |
HPS.MaterialKit | SetDiffuseAlpha (float in_alpha) |
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. More... | |
HPS.MaterialKit | SetDiffuseColor (HPS.RGBColor in_color) |
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. More... | |
HPS.MaterialKit | SetDiffuseColor (HPS.RGBAColor in_color) |
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. More... | |
HPS.MaterialKit | SetDiffuseTexture (string in_texture_name, ulong in_layer) |
Applies a named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer. More... | |
HPS.MaterialKit | SetDiffuseTexture (string in_texture_name) |
Applies a named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer. More... | |
HPS.MaterialKit | SetDiffuseTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, ulong in_layer) |
Applies a modulated named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer. More... | |
HPS.MaterialKit | SetDiffuseTexture (string in_texture_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer. More... | |
HPS.MaterialKit | SetDiffuseTexture (string[] in_texture_names) |
Applies named textures to each of the specified layers of the diffuse texture channel, replacing any other textures on those layers. More... | |
HPS.MaterialKit | SetDiffuseTexture (string[] in_texture_names, HPS.RGBAColor[] in_modulating_colors) |
Applies named textures, possibly modulated, to each of the specified layers of the diffuse texture channel, replacing any other textures on those layers. More... | |
HPS.MaterialKit | SetEmission (HPS.RGBAColor in_rgba_color) |
Applies an RGBA color to the emission channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetEmission (string in_texture_name) |
Applies a named texture to the emission channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetEmission (string in_texture_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named texture to the emission channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetEnvironmentCubeMap (string in_cubemap_name) |
Applies a named cube map to the environment channel, replacing any other texture or cube map on that channel. More... | |
HPS.MaterialKit | SetEnvironmentCubeMap (string in_cubemap_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named cube map to the environment channel, replacing any other texture or cube map on that channel. More... | |
HPS.MaterialKit | SetEnvironmentTexture (string in_texture_name) |
Applies a named texture to the environment channel, replacing any other texture or cube map on that channel. More... | |
HPS.MaterialKit | SetEnvironmentTexture (string in_texture_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named texture to the environment channel, replacing any other texture or cube map on that channel. More... | |
HPS.MaterialKit | SetEnvironmentTexture () |
Cancels any other texture or cube map on the environment channel. More... | |
HPS.MaterialKit | SetGloss (float in_gloss) |
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. More... | |
HPS.MaterialKit | SetMirror (HPS.RGBAColor in_rgba_color) |
Applies an RGBA color to the mirror channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetMirror (string in_texture_name) |
Applies a named texture to the mirror channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetMirror (string in_texture_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named texture to the mirror channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetShader (string in_shader_name) |
Internal use only - customers should not use. Applies a shader which replaces the diffuse texture at layer 0. It may also replace all diffuse textures depending on the multitexture setting of the shader. More... | |
HPS.MaterialKit | SetSpecular (HPS.RGBAColor in_rgba_color) |
Applies an RGBA color to the specular channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetSpecular (string in_texture_name) |
Applies a named texture to the specular channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetSpecular (string in_texture_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named texture to the specular channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetTransmission (string in_texture_name) |
Applies a named texture to the transmission channel, replacing any other color or texture on that channel. More... | |
HPS.MaterialKit | SetTransmission (string in_texture_name, HPS.RGBAColor in_modulating_color) |
Applies a modulated named texture to the transmission channel, replacing any other color or texture on that channel. More... | |
void | Show (out HPS.MaterialKit out_kit) |
Copies all settings from this MaterialKit into the given MaterialKit. More... | |
bool | ShowBump (out string out_texture_name) |
Retrieves the texture applied to the bump channel. More... | |
bool | ShowDiffuse () |
If the diffuse color will override textures and shaders. More... | |
bool | ShowDiffuseAlpha (out float out_alpha) |
Retrieves alpha set on the diffuse alpha channel. More... | |
bool | ShowDiffuseColor (out HPS.RGBColor out_rgb_color) |
Retrieves RGB color set on the diffuse RGB channel. More... | |
bool | ShowDiffuseColor (out HPS.RGBAColor out_rgba_color) |
Retrieves RGBA color set on the diffuse color channel. More... | |
bool | ShowDiffuseTexture (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the possibly modulated texture applied to layer 0 of the diffuse texture channel. More... | |
bool | ShowDiffuseTexture (ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the possibly modulated texture applied to the specified layer of the diffuse texture channel. More... | |
bool | ShowDiffuseTexture (out HPS.Material.Type[] out_types, out HPS.RGBAColor[] out_colors, out string[] out_texture_names) |
Retrieves the possibly modulated textures applied to all layers of the diffuse texture channel. More... | |
bool | ShowEmission (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the color, texture, or modulated texture applied to the emission channel. More... | |
bool | ShowEnvironment (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the color, texture, or modulated texture applied to the environment channel. More... | |
bool | ShowGloss (out float out_gloss) |
Retrieves the gloss of this material. Gloss is a single floating point value that describes the "focus" of specular reflections off a surface. More... | |
bool | ShowMirror (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the color, texture, or modulated texture applied to the mirror channel. More... | |
bool | ShowShader (out string out_shader_name) |
Internal use only - customers should not use. Retrieves the shader applied to this material More... | |
bool | ShowSpecular (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the color, texture, or modulated texture applied to the specular channel. More... | |
bool | ShowTransmission (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out string out_texture_name) |
Retrieves the color, texture, or modulated texture applied to the transmission channel. More... | |
HPS.MaterialKit | UnsetBump () |
Removes all settings applied to the bump channel. More... | |
HPS.MaterialKit | UnsetDiffuseAlpha () |
Removes all settings applied to the diffuse alpha channel. More... | |
HPS.MaterialKit | UnsetDiffuseColor () |
Removes all settings applied to the diffuse color channel including alpha. More... | |
HPS.MaterialKit | UnsetDiffuseColorRGB () |
Removes all settings applied to the diffuse rgb channel. More... | |
HPS.MaterialKit | UnsetDiffuseTexture () |
Removes all settings applied to all layers of the diffuse texture channel. More... | |
HPS.MaterialKit | UnsetDiffuseTexture (ulong in_layer) |
Removes all settings applied to the specified layer of the diffuse texture channel. More... | |
HPS.MaterialKit | UnsetEmission () |
Removes all settings applied to the emission channel. More... | |
HPS.MaterialKit | UnsetEnvironment () |
Removes all settings applied to the environment channel. More... | |
HPS.MaterialKit | UnsetEverything () |
Removes all setting from this material. More... | |
HPS.MaterialKit | UnsetGloss () |
Removes the gloss setting applied to this material. More... | |
HPS.MaterialKit | UnsetMirror () |
Removes all settings applied to the mirror channel. More... | |
HPS.MaterialKit | UnsetShader () |
Internal use only - customers should not use. Removes any shader applied to this material. More... | |
HPS.MaterialKit | UnsetSpecular () |
Removes all settings applied to the specular channel. More... | |
HPS.MaterialKit | UnsetTransmission () |
Removes all settings applied to the transmission channel. 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 an identifier that can be used to identify which instance of a class an object is. 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 bool | operator!= (HPS.MaterialKit a, HPS.MaterialKit b) |
static bool | operator== (HPS.MaterialKit a, HPS.MaterialKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
The default constructor creates an empty MaterialKit object.
|
inline |
The copy constructor creates a new MaterialKit object that contains the same settings as the source.
- Parameters
-
in_kit The source MaterialKit 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 MaterialKit is equivalent to this object.
- Parameters
-
in_kit The source MaterialKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying 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 MaterialKit into this object.
- Parameters
-
in_kit The source MaterialKit to copy.
|
inline |
Applies a named texture to the bump channel, replacing any other texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies an RGB color to the whole diffuse channel, replacing any diffuse textures or shaders.
- Parameters
-
in_color The color to be applied.
- Returns
- A reference to this object.
|
inline |
Applies an RGBA color to the whole diffuse channel, replacing any diffuse textures or shaders.
- Parameters
-
in_color The color to be applied.
- Returns
- A reference to this object.
|
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_alpha The alpha to be applied.
- Returns
- A reference to this object.
|
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_color The color to be applied.
- Returns
- A reference to this object.
|
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_color The color to be applied.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer.
- Parameters
-
in_texture_name The 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_layer The layer to apply the texture to. Higher numbered layers are applied on top of lower numbered ones.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the specified layer of the diffuse texture channel, replacing any other textures on that layer.
- Parameters
-
in_texture_name The 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.
|
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_name The 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_color A color that will be applied as a filter to the texture. in_layer The layer to apply the texture to. Higher numbered layers are applied on top of lower numbered ones.
- Returns
- A reference to this object.
|
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_name The 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_color A color that will be applied as a filter to the texture.
- Returns
- A reference to this object.
|
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_names The 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.
|
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_names The 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_colors An 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.
|
inline |
Applies an RGBA color to the emission channel, replacing any other color or texture on that channel.
- Parameters
-
in_rgba_color The color to be applied.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the emission channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies a modulated named texture to the emission channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible. in_modulating_color A color that will be applied as a filter to the texture.
- Returns
- A reference to this object.
|
inline |
Applies a named cube map to the environment channel, replacing any other texture or cube map on that channel.
- Parameters
-
in_cubemap_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies a modulated named cube map to the environment channel, replacing any other texture or cube map on that channel.
- Parameters
-
in_cubemap_name The name of a texture, defined in a portfolio that is accessible. in_modulating_color A color that will be applied as a filter to the cube map.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the environment channel, replacing any other texture or cube map on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies a modulated named texture to the environment channel, replacing any other texture or cube map on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible. in_modulating_color A color that will be applied as a filter to the texture.
- Returns
- A reference to this object.
|
inline |
Cancels any other texture or cube map on the environment channel.
- Returns
- A reference to this object.
|
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_gloss Gloss is always positive, and most surfaces have a gloss in the range of 1.0 to 30.0.
- Returns
- A reference to this object.
|
inline |
Applies an RGBA color to the mirror channel, replacing any other color or texture on that channel.
- Parameters
-
in_rgba_color The color to be applied.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the mirror channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies a modulated named texture to the mirror channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible. in_modulating_color A color that will be applied as a filter to the texture.
- Returns
- A reference to this object.
|
inline |
Internal use only - customers should not use. Applies a shader which replaces the diffuse texture at layer 0. It may also replace all diffuse textures depending on the multitexture setting of the shader.
- Parameters
-
in_shader_name The name of a shader, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies an RGBA color to the specular channel, replacing any other color or texture on that channel.
- Parameters
-
in_rgba_color The color to be applied.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the specular channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies a modulated named texture to the specular channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible. in_modulating_color A color that will be applied as a filter to the texture.
- Returns
- A reference to this object.
|
inline |
Applies a named texture to the transmission channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Applies a modulated named texture to the transmission channel, replacing any other color or texture on that channel.
- Parameters
-
in_texture_name The name of a texture, defined in a portfolio that is accessible. in_modulating_color A color that will be applied as a filter to the texture.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this MaterialKit into the given MaterialKit.
- Parameters
-
out_kit The MaterialKit to populate with the contents of this object.
|
inline |
Retrieves the texture applied to the bump channel.
- Parameters
-
out_texture_name The name of a texture applied to this channel.
- Returns
- true if a texture has been set on the bump channel, false otherwise.
|
inline |
If the diffuse color will override textures and shaders.
- Returns
- true if the diffuse color will override textures and shaders, false otherwise.
|
inline |
Retrieves alpha set on the diffuse alpha channel.
- Parameters
-
out_alpha The color set on the diffuse alpha channel.
- Returns
- true if the internal selection limit is valid, false otherwise.
|
inline |
Retrieves RGB color set on the diffuse RGB channel.
- Parameters
-
out_rgb_color The RGB color set on the diffuse RGB channel.
- Returns
- true if the diffuse RGB color is valid, false otherwise.
|
inline |
Retrieves RGBA color set on the diffuse color channel.
- Parameters
-
out_rgba_color The RGBA color set on the diffuse color channel.
- Returns
- true if the diffuse RGB color is valid, false otherwise.
|
inline |
Retrieves the possibly modulated texture applied to layer 0 of the diffuse texture channel.
- Parameters
-
out_type Indicates 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_color A modulating color applied as a filter to the named texture, only valid if out_type is ModulatedTexture. out_texture_name The 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.
|
inline |
Retrieves the possibly modulated texture applied to the specified layer of the diffuse texture channel.
- Parameters
-
in_layer The layer number to query for a texture. out_type Indicates 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_color A modulating color applied as a filter to the named texture, only valid if out_type is ModulatedTexture. out_texture_name The 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.
|
inline |
Retrieves the possibly modulated textures applied to all layers of the diffuse texture channel.
- Parameters
-
out_types An 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_colors An 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_names An 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.
|
inline |
Retrieves the color, texture, or modulated texture applied to the emission channel.
- Parameters
-
out_type Indicates 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_color A 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_name The 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.
|
inline |
Retrieves the color, texture, or modulated texture applied to the environment channel.
- Parameters
-
out_type Indicates 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_color A 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_name The 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.
|
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_gloss The 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.
|
inline |
Retrieves the color, texture, or modulated texture applied to the mirror channel.
- Parameters
-
out_type Indicates 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_color A 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_name The 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.
|
inline |
Internal use only - customers should not use. Retrieves the shader applied to this material
- Parameters
-
out_shader_name The name of a shader applied to this material.
- Returns
- true if a shader has been set on this material, false otherwise.
|
inline |
Retrieves the color, texture, or modulated texture applied to the specular channel.
- Parameters
-
out_type Indicates 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_color A 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_name The 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.
|
inline |
Retrieves the color, texture, or modulated texture applied to the transmission channel.
- Parameters
-
out_type Indicates 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_color A 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_name The 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.
|
inline |
Removes all settings applied to the bump channel.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the diffuse alpha channel.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the diffuse color channel including alpha.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the diffuse rgb channel.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to all layers of the diffuse texture channel.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the specified layer of the diffuse texture channel.
- Parameters
-
in_layer The layer to remove the setting from.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the emission channel.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the environment channel.
- Returns
- A reference to this object.
|
inline |
Removes all setting from this material.
- Returns
- A reference to this object.
|
inline |
Removes the gloss setting applied to this material.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the mirror channel.
- Returns
- A reference to this object.
|
inline |
Internal use only - customers should not use. Removes any shader applied to this material.
- Returns
- A reference to this object.
|
inline |
Removes all settings applied to the specular channel.
- Returns
- A reference to this object.
|
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