MaterialMappingKit

class HPS.MaterialMappingKit : public HPS.Kit 

The HPS.MaterialMappingKit class is a user space object, used for grouping attribute settings related to materials. A HPS.MaterialMappingKit is assigned to a portfolio, which in turn associates the materials to various geometry or subgeometry. Calling HPS.MaterialMappingKit.GetDefault() will return a material mapping kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return: true if no values are set on this object, false otherwise.

bool Equals (HPS.MaterialMappingKit in_kit)

Check if the source MaterialMappingKit is equivalent to this object.

Param in_kit: The source MaterialMappingKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

MaterialMappingKit (): Initializes an empty kit.

MaterialMappingKit (HPS.MaterialMappingKit in_kit)

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

Param in_kit: The source object to copy.

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.MaterialMappingKit in_kit)

Copies all settings from the source MaterialMappingKit into this object.

Param in_kit: The source MaterialMappingKit to copy.

HPS.MaterialMappingKit SetAmbientLightColor (HPS.RGBAColor in_rgba_color)

Sets a color on both ambient and ambient down using an RGBAColor, replacing any previous mapping to those geometry types.

Param in_rgba_color: An RGBA color that will be applied to those geometry types.
Return: A reference to this object.

HPS.MaterialMappingKit SetAmbientLightDownColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetAmbientLightDownMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetAmbientLightMaterialByIndex (float in_material_index)

Sets a color on both ambient and ambient down by using in_material_index to index into the active material palette, replacing any previous mapping to those geometry types. Because these geometry types only support a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetAmbientLightUpColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetAmbientLightUpMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceAlpha (float in_alpha)

Sets alpha on the diffuse channel on the back face, replacing any previous mapping to that channel on this geometry type. If diffuse channel isn’t set, white is defaulted as the diffuse color with in_alpha the alpha value.

Param in_alpha: An alpha to apply to the specified channel of this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceColor (HPS.RGBAColor in_rgba_color)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Param in_channel: The color channel to apply the color to.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceGloss (float in_value)

Sets the gloss <ndash > general “shininess” <ndash > of this geometry type.

Param in_value: A gloss value is always positive, and most surfaces have a gloss in the range from 1.0 to 30.0.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceMaterial (HPS.MaterialKit in_material)

Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type.

Param in_material: A material kit to be applied to all channels on this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceTexture (string in_texture_name)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetBackFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutEdgeColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutEdgeMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceAlpha (float in_alpha)

Sets alpha on the diffuse channel on the cut face, replacing any previous mapping to that channel on this geometry type. If diffuse channel isn’t set, white is defaulted as the diffuse color with in_alpha the alpha value.

Param in_alpha: An alpha to apply to the specified channel of this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceColor (HPS.RGBAColor in_rgba_color)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Param in_channel: The color channel to apply the color to.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceGloss (float in_value)

Sets the gloss <ndash > general “shininess” <ndash > of this geometry type.

Param in_value: A gloss value is always positive, and most surfaces have a gloss in the range from 1.0 to 30.0.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceMaterial (HPS.MaterialKit in_material)

Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type.

Param in_material: A material kit to be applied to all channels on this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceTexture (string in_texture_name)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutGeometryColor (HPS.RGBAColor in_rgba_color)

Sets a color on both cut edges and cut faces using an RGBAColor, replacing any previous mapping to those geometry types.

Param in_rgba_color: An RGBA color that will be applied to those geometry types.
Return: A reference to this object.

HPS.MaterialMappingKit SetCutGeometryMaterialByIndex (float in_color_index)

Sets a color on both cut edges and cut faces by using in_material_index to index into the active material palette, replacing any previous mapping to those geometry types.

Param in_color_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeAlpha (float in_alpha)

Sets alpha on the diffuse channel on the edge, replacing any previous mapping to that channel on this geometry type. If diffuse channel isn’t set, white is defaulted as the diffuse color with in_alpha as the alpha value.

Param in_alpha: An alpha to apply to the specified channel of this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeColor (HPS.RGBAColor in_rgba_color)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Param in_channel: The color channel to apply the color to.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeGloss (float in_value)

Sets the gloss <ndash > general “shininess” <ndash > of this geometry type.

Param in_value: A gloss value is always positive, and most surfaces have a gloss in the range from 1.0 to 30.0.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeMaterial (HPS.MaterialKit in_material)

Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type.

Param in_material: A material kit to be applied to all channels on this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeTexture (string in_texture_name)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetEdgeTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceAlpha (float in_alpha)

Sets alpha on the diffuse channel on the face, replacing any previous mapping to that channel on this geometry type. If diffuse channel isn’t set, white is defaulted as the diffuse color with in_alpha as the alpha value.

Param in_alpha: An alpha to apply to the specified channel of this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceColor (HPS.RGBAColor in_rgba_color)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Param in_channel: The color channel to apply the color to.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceGloss (float in_value)

Sets the gloss <ndash > general “shininess” <ndash > of this geometry type.

Param in_value: A gloss value is always positive, and most surfaces have a gloss in the range from 1.0 to 30.0.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceMaterial (HPS.MaterialKit in_material)

Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type.

Param in_material: A material kit to be applied to all channels on this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceTexture (string in_texture_name)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceAlpha (float in_alpha)

Sets alpha on the diffuse channel on the front face, replacing any previous mapping to that channel on this geometry type. If diffuse channel isn’t set, white is defaulted as the diffuse color with in_alpha the alpha value.

Param in_alpha: An alpha to apply to the specified channel of this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceColor (HPS.RGBAColor in_rgba_color)

Sets a color on a particular channel using an RGBAColor on the front face, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)

Sets a color on a particular channel using an RGBAColor on the front face, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Param in_channel: The color channel to apply the color to.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceGloss (float in_value)

Sets the gloss <ndash > general “shininess” <ndash > of this geometry type.

Param in_value: A gloss value is always positive, and most surfaces have a gloss in the range from 1.0 to 30.0.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceMaterial (HPS.MaterialKit in_material)

Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type.

Param in_material: A material kit to be applied to all channels on this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceTexture (string in_texture_name)

Sets a texture in_texture_name on the channel in_channel on the front face, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)

Sets a texture in_texture_name on the channel in_channel on the front face, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetFrontFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture in_texture_name on the channel in_channel on the front face, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetGeometryColor (HPS.RGBAColor in_rgba_color)

Sets a color on all basic geometry types (faces, edges, lines, markers, vertices, text) using an RGBAColor, replacing any previous mapping to those geometry types.

Param in_rgba_color: An RGBA color that will be applied to all basic geometry types. Alpha channel is ignored.
Return: A reference to this object.

HPS.MaterialMappingKit SetLightColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetLightMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetLineAlpha (float in_alpha)

Sets alpha on the diffuse channel on the line, replacing any previous mapping to that channel on this geometry type.

Param in_alpha: The alpha value to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetLineColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. Note that this function implicitly sets an alpha value for lines if an RGBColor is passed in. The alpha value can be modified either by calling this function again, or by calling SetLineAlpha.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetLineMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetMarkerColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetMarkerMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetTextColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: A color to apply to this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetTextMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexAlpha (float in_alpha)

Sets alpha on the diffuse channel on the vertex, replacing any previous mapping to that channel on this geometry type. If diffuse channel isn’t set, white is defaulted as the diffuse color with in_alpha as the alpha value.

Param in_alpha: An alpha to apply to the specified channel of this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexColor (HPS.RGBAColor in_rgba_color)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type.

Param in_rgba_color: A color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Param in_channel: The color channel to apply the color to.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexGloss (float in_value)

Sets the gloss <ndash > general “shininess” <ndash > of this geometry type.

Param in_value: A gloss value is always positive, and most surfaces have a gloss in the range from 1.0 to 30.0.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexMaterial (HPS.MaterialKit in_material)

Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type.

Param in_material: A material kit to be applied to all channels on this geometry type.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexMaterialByIndex (float in_material_index)

Sets a material by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture on a particular channel, replacing any previous mapping to that channel on this geometry type. The texture will be modulated by the specified color. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_modulating_color: a color that is used to tint the texture. Only textures defined with modulation enabled support this.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexTexture (string in_texture_name)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Return: A reference to this object.

HPS.MaterialMappingKit SetVertexTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)

Sets a texture in_texture_name on the channel in_channel, replacing any previous mapping to that channel on this geometry type. The DiffuseTexture channel additionally supports mapping textures to multiple layers with higher layers appearing on top of lower layers.

Param in_texture_name: The name of a texture, defined in a portfolio that is accessible.
Param in_channel: The texture channel to apply the texture to.
Param in_layer: The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Return: A reference to this object.

HPS.MaterialMappingKit SetWindowColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: An RGBA color that will be applied to this geometry types.
Return: A reference to this object.

HPS.MaterialMappingKit SetWindowContrastColor (HPS.RGBAColor in_rgba_color)

Sets a color using an RGBAColor, replacing any previous mapping to this geometry type.

Param in_rgba_color: An RGBA color that will be applied to this geometry types.
Return: A reference to this object.

HPS.MaterialMappingKit SetWindowContrastMaterialByIndex (float in_material_index)

Sets a color by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

HPS.MaterialMappingKit SetWindowMaterialByIndex (float in_material_index)

Sets a color by using in_material_index to index into the active material palette, replacing any previous mapping to this geometry type. Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Param in_material_index: An index into the active material palette.
Return: A reference to this object.

void Show (out HPS.MaterialMappingKit out_kit)

Copies all settings from this MaterialMappingKit into the given MaterialMappingKit.

Param out_kit: The MaterialMappingKit to populate with the contents of this object.

bool ShowAmbientLightDownColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowAmbientLightUpColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowBackFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Return: true if the setting is valid, false otherwise.

bool ShowBackFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param in_layer: The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Return: true if the setting is valid, false otherwise.

bool ShowBackFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)

Shows the material mapping for all channels of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_kit: If out_type is FullMaterial, this value contains the material.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowCutEdgeColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowCutFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowCutFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param in_layer: The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowCutFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)

Shows the material mapping for all channels of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_kit: If out_type is FullMaterial, this value contains the material.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowEdgeChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowEdgeChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param in_layer: The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowEdgeMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)

Shows the material mapping for all channels of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_kit: If out_type is FullMaterial, this value contains the material.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Return: true if the setting is valid, false otherwise.

bool ShowFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param in_layer: The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Return: true if the setting is valid, false otherwise.

bool ShowFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)

Shows the material mapping for all channels of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_kit: If out_type is FullMaterial, this value contains the material.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowFrontFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Return: true if the setting is valid, false otherwise.

bool ShowFrontFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param in_layer: The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Return: true if the setting is valid, false otherwise.

bool ShowFrontFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)

Shows the material mapping for all channels of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_kit: If out_type is FullMaterial, this value contains the material.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowLightColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowLineAlpha (out float out_alpha)

Shows the alpha setting for lines.

Param out_alpha: The alpha value for lines.
Return: true if the setting is valid, false otherwise.

bool ShowLineColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowMarkerColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowTextColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowVertexChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowVertexChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)

Shows the material mapping for the channel in_channel and layer in_layer of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param in_channel: The channel to query.
Param in_layer: The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
Param out_texture_name: If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowVertexMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)

Shows the material mapping for all channels of this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_kit: If out_type is FullMaterial, this value contains the material.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowWindowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

bool ShowWindowContrastColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)

Shows the material mapping for this geometry type. The out_type parameter indicates which of the other arguments is valid.

Param out_type: Indicates the type of material.
Param out_rgba_color: If out_type is RGBAColor, this value contains the color.
Param out_value: If out_type is MaterialIndex, this value contains the index.
Return: true if the setting is valid, false otherwise.

HPS.MaterialMappingKit UnsetAmbientLightColor ()

Removes the material mapping for both ambient light up and ambient light down.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetAmbientLightDownColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetAmbientLightUpColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetBackFaceChannel (HPS.Material.Channel in_channel)

Removes the material mapping for one channel of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetBackFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)

Removes the material mapping for one layer of one channel (usually DiffuseTexture) of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetBackFaceMaterial ()

Removes the material mapping for all channels of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetCutEdgeColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetCutFaceChannel (HPS.Material.Channel in_channel)

Removes the material mapping for one channel of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetCutFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)

Removes the material mapping for one layer of one channel (usually DiffuseTexture) of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetCutFaceMaterial ()

Removes the material mapping for all channels of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetCutGeometryColor ()

Removes the material mapping for both cut edges and cut faces.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetEdgeChannel (HPS.Material.Channel in_channel)

Removes the material mapping for one channel of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetEdgeChannel (HPS.Material.Channel in_channel, ulong in_layer)

Removes the material mapping for one layer of one channel (usually DiffuseTexture) of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetEdgeMaterial ()

Removes the material mapping for all channels of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetFaceChannel (HPS.Material.Channel in_channel)

Removes the material mapping for one channel of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)

Removes the material mapping for one layer of one channel (usually DiffuseTexture) of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetFaceMaterial ()

Removes the material mapping for all channels of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetFrontFaceChannel (HPS.Material.Channel in_channel)

Removes the material mapping for one channel of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetFrontFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)

Removes the material mapping for one layer of one channel (usually DiffuseTexture) of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetFrontFaceMaterial ()

Removes the material mapping for all channels of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetLightColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetLineAlpha ()

Removes the alpha setting for lines.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetLineColor ()

Removes the material mapping for this geometry type. Note that this also unsets alpha settings for lines specified in this kit.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetMarkerColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetTextColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetVertexChannel (HPS.Material.Channel in_channel)

Removes the material mapping for one channel of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetVertexChannel (HPS.Material.Channel in_channel, ulong in_layer)

Removes the material mapping for one layer of one channel (usually DiffuseTexture) of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetVertexMaterial ()

Removes the material mapping for all channels of this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetWindowColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

HPS.MaterialMappingKit UnsetWindowContrastColor ()

Removes the material mapping for this geometry type.

Return: A reference to this object.

Public Static Functions

HPS.MaterialMappingKit GetDefault ()

Creates a HPS.MaterialMappingKit 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.

Return: A MaterialMappingKit with the default settings.

bool operator!= (HPS.MaterialMappingKit a, HPS.MaterialMappingKit b)

bool operator== (HPS.MaterialMappingKit a, HPS.MaterialMappingKit b)