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

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

bool Equals(MaterialMappingKit const &in_kit) const

Check if the source MaterialMappingKit is equivalent to this object.

Parameters: in_kit – The source MaterialMappingKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

MaterialMappingKit(): Initializes an empty kit.

MaterialMappingKit(MaterialMappingKit &&in_that)

The move constructor creates a MaterialMappingKit by transferring the underlying impl of the rvalue reference to this MaterialMappingKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a MaterialMappingKit to take the impl from.

MaterialMappingKit(MaterialMappingKit const &in_kit)

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

Parameters: in_kit – The source object to copy.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

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

bool operator!=(MaterialMappingKit const &in_kit) const

Check if the source MaterialMappingKit is not equivalent to this object.

Parameters: in_kit – The source MaterialMappingKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

MaterialMappingKit &operator=(MaterialMappingKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this MaterialMappingKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a MaterialMappingKit to take the impl from.
Returns: A reference to this MaterialMappingKit.

MaterialMappingKit &operator=(MaterialMappingKit const &in_kit)

Copies the source MaterialMappingKit into this object.

Parameters: in_kit – The source MaterialMappingKit to copy.
Returns: A reference to this object.

bool operator==(MaterialMappingKit const &in_kit) const

Check if the source MaterialMappingKit is equivalent to this object.

Parameters: in_kit – The source MaterialMappingKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

void Set(MaterialMappingKit const &in_kit)

Copies all settings from the source MaterialMappingKit into this object.

Parameters: in_kit – The source MaterialMappingKit to copy.

MaterialMappingKit &SetAmbientLightColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – An RGBA color that will be applied to those geometry types.
Returns: A reference to this object.

MaterialMappingKit &SetAmbientLightDownColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetAmbientLightUpColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_alpha – An alpha to apply to the specified channel of this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetBackFaceColor(RGBAColor const &in_rgba_color, Material::Color::Channel in_channel = Material::Color::Channel::DiffuseColor)

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

Parameters

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.
in_channel – The color channel to apply the color to.

Returns

A reference to this object.

MaterialMappingKit &SetBackFaceGloss(float in_value)

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

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

MaterialMappingKit &SetBackFaceMaterial(MaterialKit const &in_material)

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

Parameters: in_material – A material kit to be applied to all channels on this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetBackFaceModulatedTexture(char const *in_texture_name, RGBAColor const &in_modulating_color, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

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

Returns

A reference to this object.

MaterialMappingKit &SetBackFaceTexture(char const *in_texture_name, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

in_texture_name – The name of a texture, defined in a portfolio that is accessible.
in_channel – The texture channel to apply the texture to.
in_layer – The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.

Returns

A reference to this object.

MaterialMappingKit &SetCutEdgeColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_alpha – An alpha to apply to the specified channel of this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetCutFaceColor(RGBAColor const &in_rgba_color, Material::Color::Channel in_channel = Material::Color::Channel::DiffuseColor)

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

Parameters

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.
in_channel – The color channel to apply the color to.

Returns

A reference to this object.

MaterialMappingKit &SetCutFaceGloss(float in_value)

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

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

MaterialMappingKit &SetCutFaceMaterial(MaterialKit const &in_material)

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

Parameters: in_material – A material kit to be applied to all channels on this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetCutFaceModulatedTexture(char const *in_texture_name, RGBAColor const &in_modulating_color, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

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

Returns

A reference to this object.

MaterialMappingKit &SetCutFaceTexture(char const *in_texture_name, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

in_texture_name – The name of a texture, defined in a portfolio that is accessible.
in_channel – The texture channel to apply the texture to.
in_layer – The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.

Returns

A reference to this object.

MaterialMappingKit &SetCutGeometryColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – An RGBA color that will be applied to those geometry types.
Returns: A reference to this object.

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.

Parameters: in_color_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_alpha – An alpha to apply to the specified channel of this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetEdgeColor(RGBAColor const &in_rgba_color, Material::Color::Channel in_channel = Material::Color::Channel::DiffuseColor)

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

Parameters

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.
in_channel – The color channel to apply the color to.

Returns

A reference to this object.

MaterialMappingKit &SetEdgeGloss(float in_value)

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

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

MaterialMappingKit &SetEdgeMaterial(MaterialKit const &in_material)

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

Parameters: in_material – A material kit to be applied to all channels on this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetEdgeModulatedTexture(char const *in_texture_name, RGBAColor const &in_modulating_color, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

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

Returns

A reference to this object.

MaterialMappingKit &SetEdgeTexture(char const *in_texture_name, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

in_texture_name – The name of a texture, defined in a portfolio that is accessible.
in_channel – The texture channel to apply the texture to.
in_layer – The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.

Returns

A reference to this object.

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.

Parameters: in_alpha – An alpha to apply to the specified channel of this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetFaceColor(RGBAColor const &in_rgba_color, Material::Color::Channel in_channel = Material::Color::Channel::DiffuseColor)

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

Parameters

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.
in_channel – The color channel to apply the color to.

Returns

A reference to this object.

MaterialMappingKit &SetFaceGloss(float in_value)

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

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

MaterialMappingKit &SetFaceLegacyShader(char const *in_legacy_shader_name)

Internal use only - customers should not use. Applies a legacy shader by name, replacing any previous mapping to the DiffuseTexture channel on this geometry type.

Parameters: in_legacy_shader_name – The name of a legacy shader, defined in a portfolio that is accessible.
Returns: A reference to this object.

MaterialMappingKit &SetFaceMaterial(MaterialKit const &in_material)

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

Parameters: in_material – A material kit to be applied to all channels on this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetFaceModulatedTexture(char const *in_texture_name, RGBAColor const &in_modulating_color, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

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

Returns

A reference to this object.

MaterialMappingKit &SetFaceTexture(char const *in_texture_name, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

in_texture_name – The name of a texture, defined in a portfolio that is accessible.
in_channel – The texture channel to apply the texture to.
in_layer – The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.

Returns

A reference to this object.

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.

Parameters: in_alpha – An alpha to apply to the specified channel of this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetFrontFaceColor(RGBAColor const &in_rgba_color, Material::Color::Channel in_channel = Material::Color::Channel::DiffuseColor)

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.

Parameters

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.
in_channel – The color channel to apply the color to.

Returns

A reference to this object.

MaterialMappingKit &SetFrontFaceGloss(float in_value)

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

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

MaterialMappingKit &SetFrontFaceMaterial(MaterialKit const &in_material)

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

Parameters: in_material – A material kit to be applied to all channels on this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetFrontFaceModulatedTexture(char const *in_texture_name, RGBAColor const &in_modulating_color, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

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

Returns

A reference to this object.

MaterialMappingKit &SetFrontFaceTexture(char const *in_texture_name, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

in_texture_name – The name of a texture, defined in a portfolio that is accessible.
in_channel – The texture channel to apply the texture to.
in_layer – The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.

Returns

A reference to this object.

MaterialMappingKit &SetGeometryColor(RGBAColor const &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.

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

MaterialMappingKit &SetLightColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_alpha – The alpha value to apply to this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetLineColor(RGBAColor const &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.

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetMarkerColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetTextColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – A color to apply to this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_alpha – An alpha to apply to the specified channel of this geometry type.
Returns: A reference to this object.

MaterialMappingKit &SetVertexColor(RGBAColor const &in_rgba_color, Material::Color::Channel in_channel = Material::Color::Channel::DiffuseColor)

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

Parameters

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.
in_channel – The color channel to apply the color to.

Returns

A reference to this object.

MaterialMappingKit &SetVertexGloss(float in_value)

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

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

MaterialMappingKit &SetVertexLegacyShader(char const *in_legacy_shader_name)

Internal use only - customers should not use. Applies a legacy shader by name, replacing any previous mapping to the DiffuseTexture channel on this geometry type.

Parameters: in_legacy_shader_name – The name of a legacy shader, defined in a portfolio that is accessible.
Returns: A reference to this object.

MaterialMappingKit &SetVertexMaterial(MaterialKit const &in_material)

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

Parameters: in_material – A material kit to be applied to all channels on this geometry type.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

MaterialMappingKit &SetVertexModulatedTexture(char const *in_texture_name, RGBAColor const &in_modulating_color, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

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

Returns

A reference to this object.

MaterialMappingKit &SetVertexTexture(char const *in_texture_name, Material::Texture::Channel in_channel = Material::Texture::Channel::DiffuseTexture, size_t in_layer = 0)

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.

Parameters

in_texture_name – The name of a texture, defined in a portfolio that is accessible.
in_channel – The texture channel to apply the texture to.
in_layer – The specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.

Returns

A reference to this object.

MaterialMappingKit &SetWindowColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – An RGBA color that will be applied to this geometry types.
Returns: A reference to this object.

MaterialMappingKit &SetWindowContrastColor(RGBAColor const &in_rgba_color)

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

Parameters: in_rgba_color – An RGBA color that will be applied to this geometry types.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

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.

Parameters: in_material_index – An index into the active material palette.
Returns: A reference to this object.

void Show(MaterialMappingKit &out_kit) const

Copies all settings from this MaterialMappingKit into the given MaterialMappingKit.

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

bool ShowAmbientLightDownColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowAmbientLightUpColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowBackFaceChannel(Material::Channel in_channel, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
out_type – Indicates the type of material.
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.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
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.

Returns

true if the setting is valid, false otherwise.

bool ShowBackFaceChannel(Material::Channel in_channel, size_t in_layer, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
in_layer – The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_type – Indicates the type of material.
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.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
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.

Returns

true if the setting is valid, false otherwise.

bool ShowBackFaceMaterial(Material::Type &out_type, MaterialKit &out_kit, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_kit – If out_type is FullMaterial, this value contains the material.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowCutEdgeColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowCutFaceChannel(Material::Channel in_channel, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowCutFaceChannel(Material::Channel in_channel, size_t in_layer, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

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

Returns

true if the setting is valid, false otherwise.

bool ShowCutFaceMaterial(Material::Type &out_type, MaterialKit &out_kit, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_kit – If out_type is FullMaterial, this value contains the material.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowEdgeChannel(Material::Channel in_channel, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowEdgeChannel(Material::Channel in_channel, size_t in_layer, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

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

Returns

true if the setting is valid, false otherwise.

bool ShowEdgeMaterial(Material::Type &out_type, MaterialKit &out_kit, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_kit – If out_type is FullMaterial, this value contains the material.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowFaceChannel(Material::Channel in_channel, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
out_type – Indicates the type of material.
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.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
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.

Returns

true if the setting is valid, false otherwise.

bool ShowFaceChannel(Material::Channel in_channel, size_t in_layer, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
in_layer – The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_type – Indicates the type of material.
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.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
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.

Returns

true if the setting is valid, false otherwise.

bool ShowFaceMaterial(Material::Type &out_type, MaterialKit &out_kit, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_kit – If out_type is FullMaterial, this value contains the material.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowFrontFaceChannel(Material::Channel in_channel, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
out_type – Indicates the type of material.
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.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
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.

Returns

true if the setting is valid, false otherwise.

bool ShowFrontFaceChannel(Material::Channel in_channel, size_t in_layer, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
in_layer – The specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_type – Indicates the type of material.
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.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
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.

Returns

true if the setting is valid, false otherwise.

bool ShowFrontFaceMaterial(Material::Type &out_type, MaterialKit &out_kit, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_kit – If out_type is FullMaterial, this value contains the material.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowLightColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowLineAlpha(float &out_alpha) const

Shows the alpha setting for lines.

Parameters: out_alpha – The alpha value for lines.
Returns: true if the setting is valid, false otherwise.

bool ShowLineColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowMarkerColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowTextColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowVertexChannel(Material::Channel in_channel, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

in_channel – The channel to query.
out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_name – If out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowVertexChannel(Material::Channel in_channel, size_t in_layer, Material::Type &out_type, RGBAColor &out_rgba_color, UTF8 &out_texture_name, float &out_value) const

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.

Parameters

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

Returns

true if the setting is valid, false otherwise.

bool ShowVertexMaterial(Material::Type &out_type, MaterialKit &out_kit, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_kit – If out_type is FullMaterial, this value contains the material.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowWindowColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

bool ShowWindowContrastColor(Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const

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

Parameters

out_type – Indicates the type of material.
out_rgba_color – If out_type is RGBAColor, this value contains the color.
out_value – If out_type is MaterialIndex, this value contains the index.

Returns

true if the setting is valid, false otherwise.

MaterialMappingKit &UnsetAmbientLightColor()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetAmbientLightDownColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetAmbientLightUpColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetBackFaceChannel(Material::Channel in_channel)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetBackFaceChannel(Material::Channel in_channel, size_t in_layer)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetBackFaceMaterial()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetCutEdgeColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetCutFaceChannel(Material::Channel in_channel)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetCutFaceChannel(Material::Channel in_channel, size_t in_layer)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetCutFaceMaterial()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetCutGeometryColor()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetEdgeChannel(Material::Channel in_channel)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetEdgeChannel(Material::Channel in_channel, size_t in_layer)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetEdgeMaterial()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

MaterialMappingKit &UnsetFaceChannel(Material::Channel in_channel)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetFaceChannel(Material::Channel in_channel, size_t in_layer)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetFaceMaterial()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetFrontFaceChannel(Material::Channel in_channel)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetFrontFaceChannel(Material::Channel in_channel, size_t in_layer)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetFrontFaceMaterial()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetLightColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetLineAlpha()

Removes the alpha setting for lines.

Returns: A reference to this object.

MaterialMappingKit &UnsetLineColor()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetMarkerColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetTextColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetVertexChannel(Material::Channel in_channel)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetVertexChannel(Material::Channel in_channel, size_t in_layer)

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

Returns: A reference to this object.

MaterialMappingKit &UnsetVertexMaterial()

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

Returns: A reference to this object.

MaterialMappingKit &UnsetWindowColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

MaterialMappingKit &UnsetWindowContrastColor()

Removes the material mapping for this geometry type.

Returns: A reference to this object.

~MaterialMappingKit(): Destroy this kit.

Public Static Functions

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

Returns: A MaterialMappingKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::MaterialMappingKit