The HPS::MaterialMappingKit class is a user space object, used for grouping attribute settings related to materials. More...

#include <hps.h>

Inheritance diagram for HPS::MaterialMappingKit:

[legend]

Collaboration diagram for HPS::MaterialMappingKit:

[legend]

Public Member Functions
	MaterialMappingKit ()
	Initializes an empty kit. More...

	MaterialMappingKit (MaterialMappingKit const &in_kit)
	The copy constructor creates a new MaterialMappingKit object that contains the same settings as the source object. More...

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

MaterialMappingKit &	operator= (MaterialMappingKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this MaterialMappingKit thereby avoiding a copy. More...

	~MaterialMappingKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (MaterialMappingKit const &in_kit)
	Copies all settings from the source MaterialMappingKit into this object. More...

void	Show (MaterialMappingKit &out_kit) const
	Copies all settings from this MaterialMappingKit into the given MaterialMappingKit. More...

MaterialMappingKit &	operator= (MaterialMappingKit const &in_kit)
	Copies the source MaterialMappingKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (MaterialMappingKit const &in_kit) const
	Check if the source MaterialMappingKit is equivalent to this object. More...

bool	operator== (MaterialMappingKit const &in_kit) const
	Check if the source MaterialMappingKit is equivalent to this object. More...

bool	operator!= (MaterialMappingKit const &in_kit) const
	Check if the source MaterialMappingKit is not equivalent to this object. More...

MaterialMappingKit &	SetAmbientLightUpColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetAmbientLightDownColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	SetBackFaceGloss (float in_value)
	Sets the gloss – general "shininess" – of this geometry type. More...

MaterialMappingKit &	SetBackFaceMaterial (MaterialKit const &in_material)
	Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	SetFrontFaceGloss (float in_value)
	Sets the gloss – general "shininess" – of this geometry type. More...

MaterialMappingKit &	SetFrontFaceMaterial (MaterialKit const &in_material)
	Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetCutEdgeColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	SetCutFaceGloss (float in_value)
	Sets the gloss – general "shininess" – of this geometry type. More...

MaterialMappingKit &	SetCutFaceMaterial (MaterialKit const &in_material)
	Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	SetEdgeGloss (float in_value)
	Sets the gloss – general "shininess" – of this geometry type. More...

MaterialMappingKit &	SetEdgeMaterial (MaterialKit const &in_material)
	Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	SetFaceGloss (float in_value)
	Sets the gloss – general "shininess" – of this geometry type. More...

MaterialMappingKit &	SetFaceMaterial (MaterialKit const &in_material)
	Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetFaceShader (char const *in_shader_name)
	Internal use only - customers should not use. More...

MaterialMappingKit &	SetLightColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetLineColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetMarkerColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetTextColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	SetVertexGloss (float in_value)
	Sets the gloss – general "shininess" – of this geometry type. More...

MaterialMappingKit &	SetVertexMaterial (MaterialKit const &in_material)
	Sets a material for all channels on this geometry type, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetVertexShader (char const *in_shader_name)
	Internal use only - customers should not use. More...

MaterialMappingKit &	SetWindowColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

MaterialMappingKit &	SetWindowContrastColor (RGBAColor const &in_rgba_color)
	Sets a color using an RGBAColor, replacing any previous mapping to this geometry type. More...

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

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

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

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

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

MaterialMappingKit &	UnsetAmbientLightUpColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetAmbientLightDownColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetBackFaceMaterial ()
	Removes the material mapping for all channels of this geometry type. More...

MaterialMappingKit &	UnsetBackFaceChannel (Material::Channel in_channel)
	Removes the material mapping for one channel of this geometry type. More...

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

MaterialMappingKit &	UnsetFrontFaceMaterial ()
	Removes the material mapping for all channels of this geometry type. More...

MaterialMappingKit &	UnsetFrontFaceChannel (Material::Channel in_channel)
	Removes the material mapping for one channel of this geometry type. More...

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

MaterialMappingKit &	UnsetCutEdgeColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetCutFaceMaterial ()
	Removes the material mapping for all channels of this geometry type. More...

MaterialMappingKit &	UnsetCutFaceChannel (Material::Channel in_channel)
	Removes the material mapping for one channel of this geometry type. More...

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

MaterialMappingKit &	UnsetEdgeMaterial ()
	Removes the material mapping for all channels of this geometry type. More...

MaterialMappingKit &	UnsetEdgeChannel (Material::Channel in_channel)
	Removes the material mapping for one channel of this geometry type. More...

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

MaterialMappingKit &	UnsetFaceMaterial ()
	Removes the material mapping for all channels of this geometry type. More...

MaterialMappingKit &	UnsetFaceChannel (Material::Channel in_channel)
	Removes the material mapping for one channel of this geometry type. More...

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

MaterialMappingKit &	UnsetLightColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetLineColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetMarkerColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetTextColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetVertexMaterial ()
	Removes the material mapping for all channels of this geometry type. More...

MaterialMappingKit &	UnsetVertexChannel (Material::Channel in_channel)
	Removes the material mapping for one channel of this geometry type. More...

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

MaterialMappingKit &	UnsetWindowColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetWindowContrastColor ()
	Removes the material mapping for this geometry type. More...

MaterialMappingKit &	UnsetCutGeometryColor ()
	Removes the material mapping for both cut edges and cut faces. More...

MaterialMappingKit &	UnsetAmbientLightColor ()
	Removes the material mapping for both ambient light up and ambient light down. More...

MaterialMappingKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowAmbientLightUpColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

bool	ShowAmbientLightDownColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

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

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

bool	ShowBackFaceMaterial (Material::Type &out_type, MaterialKit &out_kit, float &out_value) const
	Shows the material mapping for all channels of this geometry type. More...

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

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

bool	ShowFrontFaceMaterial (Material::Type &out_type, MaterialKit &out_kit, float &out_value) const
	Shows the material mapping for all channels of this geometry type. More...

bool	ShowCutEdgeColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

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

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

bool	ShowCutFaceMaterial (Material::Type &out_type, MaterialKit &out_kit, float &out_value) const
	Shows the material mapping for all channels of this geometry type. More...

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

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

bool	ShowEdgeMaterial (Material::Type &out_type, MaterialKit &out_kit, float &out_value) const
	Shows the material mapping for all channels of this geometry type. More...

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

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

bool	ShowFaceMaterial (Material::Type &out_type, MaterialKit &out_kit, float &out_value) const
	Shows the material mapping for all channels of this geometry type. More...

bool	ShowLightColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

bool	ShowLineColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

bool	ShowMarkerColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

bool	ShowTextColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

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

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

bool	ShowVertexMaterial (Material::Type &out_type, MaterialKit &out_kit, float &out_value) const
	Shows the material mapping for all channels of this geometry type. More...

bool	ShowWindowColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

bool	ShowWindowContrastColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_value) const
	Shows the material mapping for this geometry type. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static MaterialMappingKit	GetDefault ()
	Creates a HPS::MaterialMappingKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

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.

Constructor & Destructor Documentation

◆ MaterialMappingKit() [1/3]

HPS::MaterialMappingKit::MaterialMappingKit ( )

Initializes an empty kit.

◆ MaterialMappingKit() [2/3]

HPS::MaterialMappingKit::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.

◆ MaterialMappingKit() [3/3]

HPS::MaterialMappingKit::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()

HPS::MaterialMappingKit::~MaterialMappingKit ( )

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::MaterialMappingKit::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static MaterialMappingKit HPS::MaterialMappingKit::GetDefault ( )

static

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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::MaterialMappingKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator==()

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

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::MaterialMappingKit::Set ( MaterialMappingKit const & in_kit )

Copies all settings from the source MaterialMappingKit into this object.

Parameters

in_kit The source MaterialMappingKit to copy.

◆ SetAmbientLightColor()

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

◆ SetAmbientLightDownColor()

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

◆ SetAmbientLightDownMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetAmbientLightDownMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetAmbientLightMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetAmbientLightMaterialByIndex ( float in_material_index )

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

Because these geometry types only support a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetAmbientLightUpColor()

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

◆ SetAmbientLightUpMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetAmbientLightUpMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetBackFaceAlpha()

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

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

If diffuse channel isn't set, white is defaulted as the diffuse color with in_alpha the alpha value.

Parameters

in_alpha An alpha to apply to the specified channel of this geometry type.

Returns: A reference to this object.

◆ SetBackFaceColor()

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

◆ SetBackFaceGloss()

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

◆ SetBackFaceMaterial()

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

◆ SetBackFaceMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetBackFaceMaterialByIndex ( float in_material_index )

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

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetBackFaceModulatedTexture()

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

◆ SetBackFaceTexture()

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

◆ SetCutEdgeColor()

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

◆ SetCutEdgeMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetCutEdgeMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetCutFaceAlpha()

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

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

If diffuse channel isn't set, white is defaulted as the diffuse color with in_alpha the alpha value.

Parameters

in_alpha An alpha to apply to the specified channel of this geometry type.

Returns: A reference to this object.

◆ SetCutFaceColor()

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

◆ SetCutFaceGloss()

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

◆ SetCutFaceMaterial()

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

◆ SetCutFaceMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetCutFaceMaterialByIndex ( float in_material_index )

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

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetCutFaceModulatedTexture()

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

◆ SetCutFaceTexture()

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

◆ SetCutGeometryColor()

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

◆ SetCutGeometryMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetCutGeometryMaterialByIndex ( float in_color_index )

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

Parameters

in_color_index An index into the active material palette.

Returns: A reference to this object.

◆ SetEdgeAlpha()

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

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

If diffuse channel isn't set, white is defaulted as the diffuse color with in_alpha as the alpha value.

Parameters

in_alpha An alpha to apply to the specified channel of this geometry type.

Returns: A reference to this object.

◆ SetEdgeColor()

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

◆ SetEdgeGloss()

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

◆ SetEdgeMaterial()

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

◆ SetEdgeMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetEdgeMaterialByIndex ( float in_material_index )

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

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetEdgeModulatedTexture()

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

◆ SetEdgeTexture()

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

◆ SetFaceAlpha()

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

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

If diffuse channel isn't set, white is defaulted as the diffuse color with in_alpha as the alpha value.

Parameters

in_alpha An alpha to apply to the specified channel of this geometry type.

Returns: A reference to this object.

◆ SetFaceColor()

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

◆ SetFaceGloss()

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

◆ SetFaceMaterial()

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

◆ SetFaceMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetFaceMaterialByIndex ( float in_material_index )

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

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetFaceModulatedTexture()

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

◆ SetFaceShader()

MaterialMappingKit& HPS::MaterialMappingKit::SetFaceShader ( char const * in_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_shader_name The name of a shader, defined in a portfolio that is accessible.

Returns: A reference to this object.

◆ SetFaceTexture()

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

◆ SetFrontFaceAlpha()

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

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

If diffuse channel isn't set, white is defaulted as the diffuse color with in_alpha the alpha value.

Parameters

in_alpha An alpha to apply to the specified channel of this geometry type.

Returns: A reference to this object.

◆ SetFrontFaceColor()

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

◆ SetFrontFaceGloss()

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

◆ SetFrontFaceMaterial()

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

◆ SetFrontFaceMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetFrontFaceMaterialByIndex ( float in_material_index )

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

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetFrontFaceModulatedTexture()

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

◆ SetFrontFaceTexture()

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

◆ SetLightColor()

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

◆ SetLightMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetLightMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetLineColor()

MaterialMappingKit& HPS::MaterialMappingKit::SetLineColor ( 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.

◆ SetLineMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetLineMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetMarkerColor()

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

◆ SetMarkerMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetMarkerMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetTextColor()

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

◆ SetTextMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetTextMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetVertexAlpha()

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

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

If diffuse channel isn't set, white is defaulted as the diffuse color with in_alpha as the alpha value.

Parameters

in_alpha An alpha to apply to the specified channel of this geometry type.

Returns: A reference to this object.

◆ SetVertexColor()

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

◆ SetVertexGloss()

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

◆ SetVertexMaterial()

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

◆ SetVertexMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetVertexMaterialByIndex ( float in_material_index )

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

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetVertexModulatedTexture()

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

◆ SetVertexShader()

MaterialMappingKit& HPS::MaterialMappingKit::SetVertexShader ( char const * in_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_shader_name The name of a shader, defined in a portfolio that is accessible.

Returns: A reference to this object.

◆ SetVertexTexture()

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

◆ SetWindowColor()

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

◆ SetWindowContrastColor()

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

◆ SetWindowContrastMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetWindowContrastMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ SetWindowMaterialByIndex()

MaterialMappingKit& HPS::MaterialMappingKit::SetWindowMaterialByIndex ( float in_material_index )

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

Because this geometry only supports a simple color, only the diffuse channel of the material will be used.

Parameters

in_material_index An index into the active material palette.

Returns: A reference to this object.

◆ Show()

void HPS::MaterialMappingKit::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.

◆ ShowAmbientLightDownColor()

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

◆ ShowLineColor()

bool HPS::MaterialMappingKit::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::MaterialMappingKit::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::MaterialMappingKit::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::MaterialMappingKit::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::MaterialMappingKit::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::MaterialMappingKit::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::MaterialMappingKit::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::MaterialMappingKit::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::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetAmbientLightColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetAmbientLightColor ( )

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

Returns: A reference to this object.

◆ UnsetAmbientLightDownColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetAmbientLightDownColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetAmbientLightUpColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetAmbientLightUpColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetBackFaceChannel() [1/2]

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

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

Returns: A reference to this object.

◆ UnsetBackFaceChannel() [2/2]

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

◆ UnsetBackFaceMaterial()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetBackFaceMaterial ( )

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

Returns: A reference to this object.

◆ UnsetCutEdgeColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetCutEdgeColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetCutFaceChannel() [1/2]

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

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

Returns: A reference to this object.

◆ UnsetCutFaceChannel() [2/2]

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

◆ UnsetCutFaceMaterial()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetCutFaceMaterial ( )

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

Returns: A reference to this object.

◆ UnsetCutGeometryColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetCutGeometryColor ( )

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

Returns: A reference to this object.

◆ UnsetEdgeChannel() [1/2]

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

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

Returns: A reference to this object.

◆ UnsetEdgeChannel() [2/2]

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

◆ UnsetEdgeMaterial()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetEdgeMaterial ( )

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

Returns: A reference to this object.

◆ UnsetEverything()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetFaceChannel() [1/2]

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

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

Returns: A reference to this object.

◆ UnsetFaceChannel() [2/2]

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

◆ UnsetFaceMaterial()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetFaceMaterial ( )

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

Returns: A reference to this object.

◆ UnsetFrontFaceChannel() [1/2]

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

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

Returns: A reference to this object.

◆ UnsetFrontFaceChannel() [2/2]

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

◆ UnsetFrontFaceMaterial()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetFrontFaceMaterial ( )

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

Returns: A reference to this object.

◆ UnsetLightColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetLightColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetLineColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetLineColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetMarkerColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetMarkerColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetTextColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetTextColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetVertexChannel() [1/2]

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

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

Returns: A reference to this object.

◆ UnsetVertexChannel() [2/2]

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

◆ UnsetVertexMaterial()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetVertexMaterial ( )

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

Returns: A reference to this object.

◆ UnsetWindowColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetWindowColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

◆ UnsetWindowContrastColor()

MaterialMappingKit& HPS::MaterialMappingKit::UnsetWindowContrastColor ( )

Removes the material mapping for this geometry type.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::MaterialMappingKit::staticType = HPS::Type::MaterialMappingKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MaterialMappingKit() [1/3]

◆ MaterialMappingKit() [2/3]

◆ MaterialMappingKit() [3/3]

◆ ~MaterialMappingKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ 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()

◆ SetFaceMaterial()

◆ SetFaceMaterialByIndex()

◆ SetFaceModulatedTexture()

◆ SetFaceShader()

◆ SetFaceTexture()

◆ SetFrontFaceAlpha()

◆ SetFrontFaceColor()

◆ SetFrontFaceGloss()

◆ SetFrontFaceMaterial()

◆ SetFrontFaceMaterialByIndex()

◆ SetFrontFaceModulatedTexture()

◆ SetFrontFaceTexture()

◆ SetLightColor()

◆ SetLightMaterialByIndex()

◆ SetLineColor()

◆ SetLineMaterialByIndex()

◆ SetMarkerColor()

◆ SetMarkerMaterialByIndex()

◆ SetTextColor()

◆ SetTextMaterialByIndex()

◆ SetVertexAlpha()

◆ SetVertexColor()