#include <hps.h>

Inheritance diagram for HPS::MaterialMappingControl:

Public Member Functions
	MaterialMappingControl (SegmentKey &in_seg)

	MaterialMappingControl (MaterialMappingControl const &in_that)

	MaterialMappingControl (MaterialMappingControl &&in_that)

HPS::Type	ObjectType () const

MaterialMappingControl &	operator= (MaterialMappingControl &&in_that)

MaterialMappingControl &	operator= (MaterialMappingControl const &in_that)

MaterialMappingControl &	SetAmbientLightColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetAmbientLightDownColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetAmbientLightDownMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetAmbientLightMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetAmbientLightUpColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetAmbientLightUpMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetBackFaceAlpha (float in_alpha)

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

MaterialMappingControl &	SetBackFaceGloss (float in_value)

MaterialMappingControl &	SetBackFaceMaterial (MaterialKit const &in_material)

MaterialMappingControl &	SetBackFaceMaterialByIndex (float in_material_index)

MaterialMappingControl &	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)

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

MaterialMappingControl &	SetCutEdgeColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetCutEdgeMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetCutFaceAlpha (float in_alpha)

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

MaterialMappingControl &	SetCutFaceGloss (float in_value)

MaterialMappingControl &	SetCutFaceMaterial (MaterialKit const &in_material)

MaterialMappingControl &	SetCutFaceMaterialByIndex (float in_material_index)

MaterialMappingControl &	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)

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

MaterialMappingControl &	SetCutGeometryColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetCutGeometryMaterialByIndex (float in_color_index)

MaterialMappingControl &	SetEdgeAlpha (float in_alpha)

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

MaterialMappingControl &	SetEdgeGloss (float in_value)

MaterialMappingControl &	SetEdgeMaterial (MaterialKit const &in_material)

MaterialMappingControl &	SetEdgeMaterialByIndex (float in_material_index)

MaterialMappingControl &	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)

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

MaterialMappingControl &	SetFaceAlpha (float in_alpha)

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

MaterialMappingControl &	SetFaceGloss (float in_value)

MaterialMappingControl &	SetFaceLegacyShader (char const *in_legacy_shader_name)

MaterialMappingControl &	SetFaceMaterial (MaterialKit const &in_material)

MaterialMappingControl &	SetFaceMaterialByIndex (float in_material_index)

MaterialMappingControl &	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)

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

MaterialMappingControl &	SetFrontFaceAlpha (float in_alpha)

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

MaterialMappingControl &	SetFrontFaceGloss (float in_value)

MaterialMappingControl &	SetFrontFaceMaterial (MaterialKit const &in_material)

MaterialMappingControl &	SetFrontFaceMaterialByIndex (float in_material_index)

MaterialMappingControl &	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)

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

MaterialMappingControl &	SetGeometryColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetLightColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetLightMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetLineAlpha (float in_alpha)

MaterialMappingControl &	SetLineColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetLineMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetMarkerColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetMarkerMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetTextColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetTextMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetVertexAlpha (float in_alpha)

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

MaterialMappingControl &	SetVertexGloss (float in_value)

MaterialMappingControl &	SetVertexLegacyShader (char const *in_legacy_shader_name)

MaterialMappingControl &	SetVertexMaterial (MaterialKit const &in_material)

MaterialMappingControl &	SetVertexMaterialByIndex (float in_material_index)

MaterialMappingControl &	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)

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

MaterialMappingControl &	SetWindowColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetWindowContrastColor (RGBAColor const &in_rgba_color)

MaterialMappingControl &	SetWindowContrastMaterialByIndex (float in_material_index)

MaterialMappingControl &	SetWindowMaterialByIndex (float in_material_index)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	ShowLineAlpha (float &out_alpha) const

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

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

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

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

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

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

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

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

virtual HPS::Type	Type () const

MaterialMappingControl &	UnsetAmbientLightColor ()

MaterialMappingControl &	UnsetAmbientLightDownColor ()

MaterialMappingControl &	UnsetAmbientLightUpColor ()

MaterialMappingControl &	UnsetBackFaceChannel (Material::Channel in_channel)

MaterialMappingControl &	UnsetBackFaceChannel (Material::Channel in_channel, size_t in_layer)

MaterialMappingControl &	UnsetBackFaceMaterial ()

MaterialMappingControl &	UnsetCutEdgeColor ()

MaterialMappingControl &	UnsetCutFaceChannel (Material::Channel in_channel)

MaterialMappingControl &	UnsetCutFaceChannel (Material::Channel in_channel, size_t in_layer)

MaterialMappingControl &	UnsetCutFaceMaterial ()

MaterialMappingControl &	UnsetCutGeometryColor ()

MaterialMappingControl &	UnsetEdgeChannel (Material::Channel in_channel)

MaterialMappingControl &	UnsetEdgeChannel (Material::Channel in_channel, size_t in_layer)

MaterialMappingControl &	UnsetEdgeMaterial ()

MaterialMappingControl &	UnsetEverything ()

MaterialMappingControl &	UnsetFaceChannel (Material::Channel in_channel)

MaterialMappingControl &	UnsetFaceChannel (Material::Channel in_channel, size_t in_layer)

MaterialMappingControl &	UnsetFaceMaterial ()

MaterialMappingControl &	UnsetFrontFaceChannel (Material::Channel in_channel)

MaterialMappingControl &	UnsetFrontFaceChannel (Material::Channel in_channel, size_t in_layer)

MaterialMappingControl &	UnsetFrontFaceMaterial ()

MaterialMappingControl &	UnsetLightColor ()

MaterialMappingControl &	UnsetLineAlpha ()

MaterialMappingControl &	UnsetLineColor ()

MaterialMappingControl &	UnsetMarkerColor ()

MaterialMappingControl &	UnsetTextColor ()

MaterialMappingControl &	UnsetVertexChannel (Material::Channel in_channel)

MaterialMappingControl &	UnsetVertexChannel (Material::Channel in_channel, size_t in_layer)

MaterialMappingControl &	UnsetVertexMaterial ()

MaterialMappingControl &	UnsetWindowColor ()

MaterialMappingControl &	UnsetWindowContrastColor ()

	~MaterialMappingControl ()

Public Member Functions inherited from HPS::Object
virtual bool	Empty () const

intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::MaterialMappingControl

Static Public Attributes inherited from HPS::Control
static const HPS::Type	staticType = HPS::Type::Control

Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Protected Member Functions inherited from HPS::Control
	Control (Control &&in_that)

Control &	operator= (Control &&in_that)

Detailed Description

The HPS::MaterialMappingControl class is a smart pointer that is tied to a database object. This object allows you to manipulate materials at the segment level. Examples of materials include texture, color, and gloss, among other things. Materials can be applied to geometry faces, edges, vertices, and text. Light color can also be set using this control. Materials can be applied at the segment, entity, or subentity level. In all MaterialMappingControl functions that take an RGBAColor, the alpha channel is ignored.

This table lists default values for the various segment attributes accessible from HPS::MaterialMappingControl.

Constructor & Destructor Documentation

◆ MaterialMappingControl() [1/3]

HPS::MaterialMappingControl::MaterialMappingControl ( SegmentKey & in_seg )

explicit

Initializes a control tied to the segment in_seg.

◆ MaterialMappingControl() [2/3]

HPS::MaterialMappingControl::MaterialMappingControl ( MaterialMappingControl const & in_that )

Initializes a control tied to the same object as in_that.

◆ MaterialMappingControl() [3/3]

HPS::MaterialMappingControl::MaterialMappingControl ( MaterialMappingControl && in_that )

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

Parameters

in_that An rvalue reference to a MaterialMappingControl to take the impl from.

◆ ~MaterialMappingControl()

HPS::MaterialMappingControl::~MaterialMappingControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::MaterialMappingControl::ObjectType ( ) const

inlinevirtual

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

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

Reimplemented from HPS::Control.

◆ operator=() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::operator= ( MaterialMappingControl && in_that )

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

Parameters

in_that An rvalue reference to a MaterialMappingControl to take the impl from.

Returns: A reference to this MaterialMappingControl.

◆ operator=() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::operator= ( MaterialMappingControl const & in_that )

Share the underlying smart-pointer of the MaterialMappingControl source.

Parameters

in_that The MaterialMappingControl source of the assignment.

Returns: A reference to this MaterialMappingControl.

◆ SetAmbientLightColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetAmbientLightDownColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetAmbientLightDownMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetAmbientLightMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetAmbientLightUpColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetAmbientLightUpMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetBackFaceAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetBackFaceAlpha ( float in_alpha )

Sets an alpha on the diffuse channel using in_alpha on the back face, replacing any previous mapping to that channel on this geometry type. If diffuse channel doesn't exist, white is used as the default value on diffuse channel with alpha value of in_alpha

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetBackFaceColor()

MaterialMappingControl& HPS::MaterialMappingControl::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 on the back 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.

◆ SetBackFaceGloss()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetBackFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetBackFaceMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetBackFaceModulatedTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.
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.

◆ SetBackFaceTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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 on the back 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.

◆ SetCutEdgeColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetCutEdgeMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetCutFaceAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetCutFaceAlpha ( float in_alpha )

Sets an alpha on the diffuse channel using in_alpha, replacing any previous mapping to that channel on this geometry type. If diffuse channel doesn't exist, white is used as the default value on diffuse channel with alpha value of in_alpha

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetCutFaceColor()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetCutFaceGloss()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetCutFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetCutFaceMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetCutFaceModulatedTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.
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.

◆ SetCutFaceTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetCutGeometryColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetCutGeometryMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetEdgeAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetEdgeAlpha ( float in_alpha )

Sets an alpha on the diffuse channel using in_alpha, replacing any previous mapping to that channel on this geometry type. If diffuse channel doesn't exist, white is used as the default value on diffuse channel with alpha value of in_alpha

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetEdgeColor()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetEdgeGloss()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetEdgeMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetEdgeMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetEdgeModulatedTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.
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.

◆ SetEdgeTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFaceAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetFaceAlpha ( float in_alpha )

Sets an alpha on the diffuse channel using in_alpha, replacing any previous mapping to that channel on this geometry type. This function sets the alpha for both the front and back faces. If diffuse channel doesn't exist, white is used as the default value on diffuse channel with alpha value of in_alpha

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetFaceColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. This function sets the color for both the front and back faces.

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.

◆ SetFaceGloss()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFaceLegacyShader()

MaterialMappingControl& HPS::MaterialMappingControl::SetFaceLegacyShader ( char const * in_legacy_shader_name )

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

Parameters

in_legacy_shader_name The name of a shader, defined in a portfolio that is accessible.

Returns: A reference to this object.

◆ SetFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFaceMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFaceModulatedTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.
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.

◆ SetFaceTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFrontFaceAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetFrontFaceAlpha ( float in_alpha )

Sets an alpha on the diffuse channel using in_alpha, replacing any previous mapping to that channel on this geometry type. If diffuse channel doesn't exist, white is used as the default value on diffuse channel with alpha value of in_alpha

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetFrontFaceColor()

MaterialMappingControl& HPS::MaterialMappingControl::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, 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.

◆ SetFrontFaceGloss()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFrontFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFrontFaceMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetFrontFaceModulatedTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.
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.

◆ SetFrontFaceTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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, 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.

◆ SetGeometryColor()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetLightColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetLightMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetLineAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetLineAlpha ( float in_alpha )

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

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetLineColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetLineMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetMarkerColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetMarkerMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetTextColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetTextMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetVertexAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::SetVertexAlpha ( float in_alpha )

Sets an alpha on the diffuse channel using in_alpha, replacing any previous mapping to that channel on this geometry type. If diffuse channel doesn't exist, white is used as the default value on diffuse channel with alpha value of in_alpha

Parameters

in_alpha A color to apply to the diffuse channel of this geometry type.

Returns: A reference to this object.

◆ SetVertexColor()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetVertexGloss()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetVertexLegacyShader()

MaterialMappingControl& HPS::MaterialMappingControl::SetVertexLegacyShader ( char const * in_legacy_shader_name )

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

Parameters

in_legacy_shader_name The name of a shader, defined in a portfolio that is accessible.

Returns: A reference to this object.

◆ SetVertexMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetVertexMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetVertexModulatedTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.
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.

◆ SetVertexTexture()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetWindowColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetWindowContrastColor()

MaterialMappingControl& HPS::MaterialMappingControl::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. Alpha channel is ignored.

Returns: A reference to this object.

◆ SetWindowContrastMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ SetWindowMaterialByIndex()

MaterialMappingControl& HPS::MaterialMappingControl::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.

◆ ShowAmbientLightDownColor()

bool HPS::MaterialMappingControl::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.

◆ ShowAmbientLightUpColor()

bool HPS::MaterialMappingControl::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.

◆ ShowBackFaceChannel() [1/2]

bool HPS::MaterialMappingControl::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.

◆ ShowBackFaceChannel() [2/2]

bool HPS::MaterialMappingControl::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.

◆ ShowBackFaceMaterial()

bool HPS::MaterialMappingControl::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.

◆ ShowCutEdgeColor()

bool HPS::MaterialMappingControl::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.

◆ ShowCutFaceChannel() [1/2]

bool HPS::MaterialMappingControl::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.

◆ ShowCutFaceChannel() [2/2]

bool HPS::MaterialMappingControl::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.

◆ ShowCutFaceMaterial()

bool HPS::MaterialMappingControl::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.

◆ ShowEdgeChannel() [1/2]

bool HPS::MaterialMappingControl::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.

◆ ShowEdgeChannel() [2/2]

bool HPS::MaterialMappingControl::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.

◆ ShowEdgeMaterial()

bool HPS::MaterialMappingControl::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.

◆ ShowFaceChannel() [1/2]

bool HPS::MaterialMappingControl::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.

◆ ShowFaceChannel() [2/2]

bool HPS::MaterialMappingControl::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.

◆ ShowFaceMaterial()

bool HPS::MaterialMappingControl::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.

◆ ShowFrontFaceChannel() [1/2]

bool HPS::MaterialMappingControl::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.

◆ ShowFrontFaceChannel() [2/2]

bool HPS::MaterialMappingControl::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.

◆ ShowFrontFaceMaterial()

bool HPS::MaterialMappingControl::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.

◆ ShowLightColor()

bool HPS::MaterialMappingControl::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.

◆ ShowLineAlpha()

bool HPS::MaterialMappingControl::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.

◆ ShowLineColor()

bool HPS::MaterialMappingControl::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.

◆ ShowMarkerColor()

bool HPS::MaterialMappingControl::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.

◆ ShowTextColor()

bool HPS::MaterialMappingControl::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.

◆ ShowVertexChannel() [1/2]

bool HPS::MaterialMappingControl::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.

◆ ShowVertexChannel() [2/2]

bool HPS::MaterialMappingControl::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.

◆ ShowVertexMaterial()

bool HPS::MaterialMappingControl::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.

◆ ShowWindowColor()

bool HPS::MaterialMappingControl::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.

◆ ShowWindowContrastColor()

bool HPS::MaterialMappingControl::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.

◆ Type()

virtual HPS::Type HPS::MaterialMappingControl::Type ( ) const

inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning: This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.

Returns: The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetAmbientLightColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetAmbientLightColor ( )

Removes the material mapping for both ambient light up and ambient light down. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetAmbientLightDownColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetAmbientLightDownColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetAmbientLightUpColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetAmbientLightUpColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetBackFaceChannel() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::UnsetBackFaceChannel ( Material::Channel in_channel )

Removes the material mapping for one channel of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetBackFaceChannel() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::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. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetBackFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetBackFaceMaterial ( )

Removes the material mapping for all channels of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetCutEdgeColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetCutEdgeColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetCutFaceChannel() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::UnsetCutFaceChannel ( Material::Channel in_channel )

Removes the material mapping for one channel of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetCutFaceChannel() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::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. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetCutFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetCutFaceMaterial ( )

Removes the material mapping for all channels of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetCutGeometryColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetCutGeometryColor ( )

Removes the material mapping for both cut edges and cut faces. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetEdgeChannel() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::UnsetEdgeChannel ( Material::Channel in_channel )

Removes the material mapping for one channel of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetEdgeChannel() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::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. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetEdgeMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetEdgeMaterial ( )

Removes the material mapping for all channels of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetEverything()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetEverything ( )

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetFaceChannel() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::UnsetFaceChannel ( Material::Channel in_channel )

Removes the material mapping for one channel of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetFaceChannel() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::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. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetFaceMaterial ( )

Removes the material mapping for all channels of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetFrontFaceChannel() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::UnsetFrontFaceChannel ( Material::Channel in_channel )

Removes the material mapping for one channel of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetFrontFaceChannel() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::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. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetFrontFaceMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetFrontFaceMaterial ( )

Removes the material mapping for all channels of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetLightColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetLightColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetLineAlpha()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetLineAlpha ( )

Removes the line alpha setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetLineColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetLineColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault(). Note that this function also unsets alpha values specified for lines through SetLineAlpha on this control.

Returns: A reference to this object.

◆ UnsetMarkerColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetMarkerColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetTextColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetTextColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetVertexChannel() [1/2]

MaterialMappingControl& HPS::MaterialMappingControl::UnsetVertexChannel ( Material::Channel in_channel )

Removes the material mapping for one channel of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetVertexChannel() [2/2]

MaterialMappingControl& HPS::MaterialMappingControl::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. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetVertexMaterial()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetVertexMaterial ( )

Removes the material mapping for all channels of this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetWindowColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetWindowColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

◆ UnsetWindowContrastColor()

MaterialMappingControl& HPS::MaterialMappingControl::UnsetWindowContrastColor ( )

Removes the material mapping for this geometry type. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MaterialMappingKit::GetDefault().

Returns: A reference to this object.

The documentation for this class was generated from the following file:

include/hps.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MaterialMappingControl() [1/3]

◆ MaterialMappingControl() [2/3]

◆ MaterialMappingControl() [3/3]

◆ ~MaterialMappingControl()

Member Function Documentation

◆ ObjectType()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetAmbientLightColor()

◆ SetAmbientLightDownColor()

◆ SetAmbientLightDownMaterialByIndex()

◆ SetAmbientLightMaterialByIndex()

◆ SetAmbientLightUpColor()

◆ SetAmbientLightUpMaterialByIndex()

◆ SetBackFaceAlpha()

◆ SetBackFaceColor()

◆ SetBackFaceGloss()

◆ SetBackFaceMaterial()

◆ SetBackFaceMaterialByIndex()

◆ SetBackFaceModulatedTexture()

◆ SetBackFaceTexture()

◆ SetCutEdgeColor()

◆ SetCutEdgeMaterialByIndex()

◆ SetCutFaceAlpha()

◆ SetCutFaceColor()

◆ SetCutFaceGloss()

◆ SetCutFaceMaterial()

◆ SetCutFaceMaterialByIndex()

◆ SetCutFaceModulatedTexture()

◆ SetCutFaceTexture()

◆ SetCutGeometryColor()

◆ SetCutGeometryMaterialByIndex()

◆ SetEdgeAlpha()

◆ SetEdgeColor()

◆ SetEdgeGloss()

◆ SetEdgeMaterial()

◆ SetEdgeMaterialByIndex()

◆ SetEdgeModulatedTexture()

◆ SetEdgeTexture()

◆ SetFaceAlpha()

◆ SetFaceColor()

◆ SetFaceGloss()

◆ SetFaceLegacyShader()

◆ SetFaceMaterial()

◆ SetFaceMaterialByIndex()

◆ SetFaceModulatedTexture()

◆ SetFaceTexture()

◆ SetFrontFaceAlpha()

◆ SetFrontFaceColor()

◆ SetFrontFaceGloss()

◆ SetFrontFaceMaterial()

◆ SetFrontFaceMaterialByIndex()

◆ SetFrontFaceModulatedTexture()

◆ SetFrontFaceTexture()

◆ SetGeometryColor()

◆ SetLightColor()

◆ SetLightMaterialByIndex()

◆ SetLineAlpha()

◆ SetLineColor()

◆ SetLineMaterialByIndex()

◆ SetMarkerColor()

◆ SetMarkerMaterialByIndex()

◆ SetTextColor()

◆ SetTextMaterialByIndex()

◆ SetVertexAlpha()

◆ SetVertexColor()

◆ SetVertexGloss()

◆ SetVertexLegacyShader()

◆ SetVertexMaterial()

◆ SetVertexMaterialByIndex()

◆ SetVertexModulatedTexture()

◆ SetVertexTexture()

◆ SetWindowColor()

◆ SetWindowContrastColor()

◆ SetWindowContrastMaterialByIndex()