HPS.MaterialMappingControl Class Reference
Inheritance diagram for HPS.MaterialMappingControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
 MaterialMappingControl (HPS.SegmentKey in_seg)
 
 MaterialMappingControl (HPS.MaterialMappingControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.MaterialMappingControl SetAmbientLightColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetAmbientLightDownColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetAmbientLightDownMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetAmbientLightMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetAmbientLightUpColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetAmbientLightUpMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetBackFaceAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetBackFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)
 
HPS.MaterialMappingControl SetBackFaceColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetBackFaceGloss (float in_value)
 
HPS.MaterialMappingControl SetBackFaceMaterial (HPS.MaterialKit in_material)
 
HPS.MaterialMappingControl SetBackFaceMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetBackFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetBackFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetBackFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialMappingControl SetBackFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetBackFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetBackFaceTexture (string in_texture_name)
 
HPS.MaterialMappingControl SetCutEdgeColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetCutEdgeMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetCutFaceAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetCutFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)
 
HPS.MaterialMappingControl SetCutFaceColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetCutFaceGloss (float in_value)
 
HPS.MaterialMappingControl SetCutFaceMaterial (HPS.MaterialKit in_material)
 
HPS.MaterialMappingControl SetCutFaceMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetCutFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetCutFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetCutFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialMappingControl SetCutFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetCutFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetCutFaceTexture (string in_texture_name)
 
HPS.MaterialMappingControl SetCutGeometryColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetCutGeometryMaterialByIndex (float in_color_index)
 
HPS.MaterialMappingControl SetEdgeAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetEdgeColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)
 
HPS.MaterialMappingControl SetEdgeColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetEdgeGloss (float in_value)
 
HPS.MaterialMappingControl SetEdgeMaterial (HPS.MaterialKit in_material)
 
HPS.MaterialMappingControl SetEdgeMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetEdgeModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetEdgeModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetEdgeModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialMappingControl SetEdgeTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetEdgeTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetEdgeTexture (string in_texture_name)
 
HPS.MaterialMappingControl SetFaceAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)
 
HPS.MaterialMappingControl SetFaceColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetFaceGloss (float in_value)
 
HPS.MaterialMappingControl SetFaceMaterial (HPS.MaterialKit in_material)
 
HPS.MaterialMappingControl SetFaceMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialMappingControl SetFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetFaceTexture (string in_texture_name)
 
HPS.MaterialMappingControl SetFrontFaceAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetFrontFaceColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)
 
HPS.MaterialMappingControl SetFrontFaceColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetFrontFaceGloss (float in_value)
 
HPS.MaterialMappingControl SetFrontFaceMaterial (HPS.MaterialKit in_material)
 
HPS.MaterialMappingControl SetFrontFaceMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetFrontFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetFrontFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetFrontFaceModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialMappingControl SetFrontFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetFrontFaceTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetFrontFaceTexture (string in_texture_name)
 
HPS.MaterialMappingControl SetGeometryColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetLightColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetLightMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetLineAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetLineColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetLineMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetMarkerColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetMarkerMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetTextColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetTextMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetVertexAlpha (float in_alpha)
 
HPS.MaterialMappingControl SetVertexColor (HPS.RGBAColor in_rgba_color, HPS.Material.Color.Channel in_channel)
 
HPS.MaterialMappingControl SetVertexColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetVertexGloss (float in_value)
 
HPS.MaterialMappingControl SetVertexMaterial (HPS.MaterialKit in_material)
 
HPS.MaterialMappingControl SetVertexMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetVertexModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetVertexModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetVertexModulatedTexture (string in_texture_name, HPS.RGBAColor in_modulating_color)
 
HPS.MaterialMappingControl SetVertexTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl SetVertexTexture (string in_texture_name, HPS.Material.Texture.Channel in_channel)
 
HPS.MaterialMappingControl SetVertexTexture (string in_texture_name)
 
HPS.MaterialMappingControl SetWindowColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetWindowContrastColor (HPS.RGBAColor in_rgba_color)
 
HPS.MaterialMappingControl SetWindowContrastMaterialByIndex (float in_material_index)
 
HPS.MaterialMappingControl SetWindowMaterialByIndex (float in_material_index)
 
bool ShowAmbientLightDownColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowAmbientLightUpColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowBackFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowBackFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowBackFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)
 
bool ShowCutEdgeColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowCutFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowCutFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowCutFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)
 
bool ShowEdgeChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowEdgeChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowEdgeMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)
 
bool ShowFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)
 
bool ShowFrontFaceChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowFrontFaceChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowFrontFaceMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)
 
bool ShowLightColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowLineAlpha (out float out_alpha)
 
bool ShowLineColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowMarkerColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowTextColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowVertexChannel (HPS.Material.Channel in_channel, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowVertexChannel (HPS.Material.Channel in_channel, ulong in_layer, out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out string out_texture_name, out float out_value)
 
bool ShowVertexMaterial (out HPS.Material.Type out_type, out HPS.MaterialKit out_kit, out float out_value)
 
bool ShowWindowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
bool ShowWindowContrastColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_value)
 
override HPS.Type Type ()
 
HPS.MaterialMappingControl UnsetAmbientLightColor ()
 
HPS.MaterialMappingControl UnsetAmbientLightDownColor ()
 
HPS.MaterialMappingControl UnsetAmbientLightUpColor ()
 
HPS.MaterialMappingControl UnsetBackFaceChannel (HPS.Material.Channel in_channel)
 
HPS.MaterialMappingControl UnsetBackFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl UnsetBackFaceMaterial ()
 
HPS.MaterialMappingControl UnsetCutEdgeColor ()
 
HPS.MaterialMappingControl UnsetCutFaceChannel (HPS.Material.Channel in_channel)
 
HPS.MaterialMappingControl UnsetCutFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl UnsetCutFaceMaterial ()
 
HPS.MaterialMappingControl UnsetCutGeometryColor ()
 
HPS.MaterialMappingControl UnsetEdgeChannel (HPS.Material.Channel in_channel)
 
HPS.MaterialMappingControl UnsetEdgeChannel (HPS.Material.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl UnsetEdgeMaterial ()
 
HPS.MaterialMappingControl UnsetEverything ()
 
HPS.MaterialMappingControl UnsetFaceChannel (HPS.Material.Channel in_channel)
 
HPS.MaterialMappingControl UnsetFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl UnsetFaceMaterial ()
 
HPS.MaterialMappingControl UnsetFrontFaceChannel (HPS.Material.Channel in_channel)
 
HPS.MaterialMappingControl UnsetFrontFaceChannel (HPS.Material.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl UnsetFrontFaceMaterial ()
 
HPS.MaterialMappingControl UnsetLightColor ()
 
HPS.MaterialMappingControl UnsetLineAlpha ()
 
HPS.MaterialMappingControl UnsetLineColor ()
 
HPS.MaterialMappingControl UnsetMarkerColor ()
 
HPS.MaterialMappingControl UnsetTextColor ()
 
HPS.MaterialMappingControl UnsetVertexChannel (HPS.Material.Channel in_channel)
 
HPS.MaterialMappingControl UnsetVertexChannel (HPS.Material.Channel in_channel, ulong in_layer)
 
HPS.MaterialMappingControl UnsetVertexMaterial ()
 
HPS.MaterialMappingControl UnsetWindowColor ()
 
HPS.MaterialMappingControl UnsetWindowContrastColor ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

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

Constructor & Destructor Documentation

◆ MaterialMappingControl() [1/2]

HPS.MaterialMappingControl.MaterialMappingControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ MaterialMappingControl() [2/2]

HPS.MaterialMappingControl.MaterialMappingControl ( HPS.MaterialMappingControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.MaterialMappingControl.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.Control.

◆ SetAmbientLightColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetAmbientLightColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorAn RGBA color that will be applied to those geometry types. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetAmbientLightDownColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetAmbientLightDownColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetAmbientLightDownMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetAmbientLightDownMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetAmbientLightMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetAmbientLightMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetAmbientLightUpColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetAmbientLightUpColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetAmbientLightUpMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetAmbientLightUpMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetBackFaceAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetBackFaceColor() [1/2]

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

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
in_channelThe color channel to apply the color to.
Returns
A reference to this object.

◆ SetBackFaceColor() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Returns
A reference to this object.

◆ SetBackFaceGloss()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceGloss ( float  in_value)
inline

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

Parameters
in_valueA 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()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceMaterial ( HPS.MaterialKit  in_material)
inline

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

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

◆ SetBackFaceMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetBackFaceModulatedTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetBackFaceModulatedTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetBackFaceModulatedTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceModulatedTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetBackFaceTexture() [1/3]

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

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

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetBackFaceTexture() [2/3]

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

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

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetBackFaceTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetBackFaceTexture ( string  in_texture_name)
inline

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

Parameters
in_texture_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetCutEdgeColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutEdgeColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetCutEdgeMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutEdgeMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetCutFaceAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetCutFaceColor() [1/2]

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

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
in_channelThe color channel to apply the color to.
Returns
A reference to this object.

◆ SetCutFaceColor() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Returns
A reference to this object.

◆ SetCutFaceGloss()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceGloss ( float  in_value)
inline

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

Parameters
in_valueA 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()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceMaterial ( HPS.MaterialKit  in_material)
inline

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

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

◆ SetCutFaceMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetCutFaceModulatedTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetCutFaceModulatedTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetCutFaceModulatedTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceModulatedTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetCutFaceTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetCutFaceTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetCutFaceTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutFaceTexture ( string  in_texture_name)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetCutGeometryColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutGeometryColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorAn RGBA color that will be applied to those geometry types. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetCutGeometryMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetCutGeometryMaterialByIndex ( float  in_color_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetEdgeAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetEdgeColor() [1/2]

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

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
in_channelThe color channel to apply the color to.
Returns
A reference to this object.

◆ SetEdgeColor() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Returns
A reference to this object.

◆ SetEdgeGloss()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeGloss ( float  in_value)
inline

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

Parameters
in_valueA 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()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeMaterial ( HPS.MaterialKit  in_material)
inline

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

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

◆ SetEdgeMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetEdgeModulatedTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetEdgeModulatedTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetEdgeModulatedTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeModulatedTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetEdgeTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetEdgeTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetEdgeTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetEdgeTexture ( string  in_texture_name)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetFaceAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetFaceColor() [1/2]

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

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type. This function sets the color for both the front and back faces.

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
in_channelThe color channel to apply the color to.
Returns
A reference to this object.

◆ SetFaceColor() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceColor ( HPS.RGBAColor  in_rgba_color)
inline

Sets a color on a particular channel using an RGBAColor, replacing any previous mapping to that channel on this geometry type. This function sets the color for both the front and back faces.

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Returns
A reference to this object.

◆ SetFaceGloss()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceGloss ( float  in_value)
inline

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

Parameters
in_valueA 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()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceMaterial ( HPS.MaterialKit  in_material)
inline

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

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

◆ SetFaceMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetFaceModulatedTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetFaceModulatedTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetFaceModulatedTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceModulatedTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetFaceTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetFaceTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetFaceTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFaceTexture ( string  in_texture_name)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetFrontFaceAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetFrontFaceColor() [1/2]

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

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
in_channelThe color channel to apply the color to.
Returns
A reference to this object.

◆ SetFrontFaceColor() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Returns
A reference to this object.

◆ SetFrontFaceGloss()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceGloss ( float  in_value)
inline

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

Parameters
in_valueA 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()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceMaterial ( HPS.MaterialKit  in_material)
inline

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

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

◆ SetFrontFaceMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetFrontFaceModulatedTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetFrontFaceModulatedTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetFrontFaceModulatedTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceModulatedTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetFrontFaceTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetFrontFaceTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetFrontFaceTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetFrontFaceTexture ( string  in_texture_name)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetGeometryColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetGeometryColor ( HPS.RGBAColor  in_rgba_color)
inline

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

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

◆ SetLightColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetLightColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetLightMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetLightMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetLineAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetLineAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetLineColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetLineColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetLineMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetLineMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetMarkerColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetMarkerColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetMarkerMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetMarkerMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetTextColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetTextColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to this geometry type. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetTextMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetTextMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetVertexAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexAlpha ( float  in_alpha)
inline

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

Parameters
in_alphaA color to apply to the diffuse channel of this geometry type.
Returns
A reference to this object.

◆ SetVertexColor() [1/2]

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

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
in_channelThe color channel to apply the color to.
Returns
A reference to this object.

◆ SetVertexColor() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorA color to apply to the specified channel of this geometry type. Currently only the DiffuseColor channel supports alpha, it is ignored otherwise.
Returns
A reference to this object.

◆ SetVertexGloss()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexGloss ( float  in_value)
inline

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

Parameters
in_valueA 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()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexMaterial ( HPS.MaterialKit  in_material)
inline

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

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

◆ SetVertexMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetVertexModulatedTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetVertexModulatedTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetVertexModulatedTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexModulatedTexture ( string  in_texture_name,
HPS.RGBAColor  in_modulating_color 
)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_modulating_colora color that is used to tint the texture. Only textures defined with modulation enabled support this. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetVertexTexture() [1/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
in_layerThe specific layer of in_channel to apply the texture to. Currently only relevant for DiffuseTexture, ignored otherwise.
Returns
A reference to this object.

◆ SetVertexTexture() [2/3]

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

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_nameThe name of a texture, defined in a portfolio that is accessible.
in_channelThe texture channel to apply the texture to.
Returns
A reference to this object.

◆ SetVertexTexture() [3/3]

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetVertexTexture ( string  in_texture_name)
inline

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_nameThe name of a texture, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetWindowColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetWindowColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorAn RGBA color that will be applied to this geometry types. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetWindowContrastColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetWindowContrastColor ( HPS.RGBAColor  in_rgba_color)
inline

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

Parameters
in_rgba_colorAn RGBA color that will be applied to this geometry types. Alpha channel is ignored.
Returns
A reference to this object.

◆ SetWindowContrastMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetWindowContrastMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ SetWindowMaterialByIndex()

HPS.MaterialMappingControl HPS.MaterialMappingControl.SetWindowMaterialByIndex ( float  in_material_index)
inline

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_indexAn index into the active material palette.
Returns
A reference to this object.

◆ ShowAmbientLightDownColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowAmbientLightUpColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowBackFaceChannel() [1/2]

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

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_channelThe channel to query.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Returns
true if the setting is valid, false otherwise.

◆ ShowBackFaceChannel() [2/2]

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

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_channelThe channel to query.
in_layerThe specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Returns
true if the setting is valid, false otherwise.

◆ ShowBackFaceMaterial()

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

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_typeIndicates the type of material.
out_kitIf out_type is FullMaterial, this value contains the material.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowCutEdgeColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowCutFaceChannel() [1/2]

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

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_channelThe channel to query.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowCutFaceChannel() [2/2]

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

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_channelThe channel to query.
in_layerThe specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowCutFaceMaterial()

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

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_typeIndicates the type of material.
out_kitIf out_type is FullMaterial, this value contains the material.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowEdgeChannel() [1/2]

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

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_channelThe channel to query.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowEdgeChannel() [2/2]

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

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_channelThe channel to query.
in_layerThe specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowEdgeMaterial()

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

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_typeIndicates the type of material.
out_kitIf out_type is FullMaterial, this value contains the material.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowFaceChannel() [1/2]

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

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_channelThe channel to query.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Returns
true if the setting is valid, false otherwise.

◆ ShowFaceChannel() [2/2]

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

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_channelThe channel to query.
in_layerThe specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Returns
true if the setting is valid, false otherwise.

◆ ShowFaceMaterial()

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

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_typeIndicates the type of material.
out_kitIf out_type is FullMaterial, this value contains the material.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowFrontFaceChannel() [1/2]

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

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_channelThe channel to query.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Returns
true if the setting is valid, false otherwise.

◆ ShowFrontFaceChannel() [2/2]

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

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_channelThe channel to query.
in_layerThe specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor or RGBColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index. If out_type is DiffuseChannelAlpha, this value contains the alpha value. If out_type is GlossValue, this value contains the gloss value.
Returns
true if the setting is valid, false otherwise.

◆ ShowFrontFaceMaterial()

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

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_typeIndicates the type of material.
out_kitIf out_type is FullMaterial, this value contains the material.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowLightColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowLineAlpha()

bool HPS.MaterialMappingControl.ShowLineAlpha ( out float  out_alpha)
inline

Shows the alpha setting for lines.

Parameters
out_alphaThe alpha value for lines.
Returns
true if the setting is valid, false otherwise.

◆ ShowLineColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowMarkerColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowTextColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowVertexChannel() [1/2]

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

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_channelThe channel to query.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowVertexChannel() [2/2]

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

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_channelThe channel to query.
in_layerThe specific layer of in_channel to query. Currently only relevant for DiffuseTexture, ignored otherwise.
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color. If out_type is ModulatedTexture, this value contains the modulating color.
out_texture_nameIf out_type is TextureName or ModulatedTexture, this value contains the name of the texture.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowVertexMaterial()

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

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_typeIndicates the type of material.
out_kitIf out_type is FullMaterial, this value contains the material.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowContrastColor()

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

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

Parameters
out_typeIndicates the type of material.
out_rgba_colorIf out_type is RGBAColor, this value contains the color.
out_valueIf out_type is MaterialIndex, this value contains the index.
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.MaterialMappingControl.Type ( )
inlinevirtual

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

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

Reimplemented from HPS.Control.

◆ UnsetAmbientLightColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetAmbientLightColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetAmbientLightDownColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetAmbientLightDownColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetAmbientLightUpColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetAmbientLightUpColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetBackFaceChannel() [1/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetBackFaceChannel ( HPS.Material.Channel  in_channel)
inline

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

Returns
A reference to this object.

◆ UnsetBackFaceChannel() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetBackFaceChannel ( HPS.Material.Channel  in_channel,
ulong  in_layer 
)
inline

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

Returns
A reference to this object.

◆ UnsetBackFaceMaterial()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetBackFaceMaterial ( )
inline

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

Returns
A reference to this object.

◆ UnsetCutEdgeColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetCutEdgeColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetCutFaceChannel() [1/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetCutFaceChannel ( HPS.Material.Channel  in_channel)
inline

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

Returns
A reference to this object.

◆ UnsetCutFaceChannel() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetCutFaceChannel ( HPS.Material.Channel  in_channel,
ulong  in_layer 
)
inline

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

Returns
A reference to this object.

◆ UnsetCutFaceMaterial()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetCutFaceMaterial ( )
inline

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

Returns
A reference to this object.

◆ UnsetCutGeometryColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetCutGeometryColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetEdgeChannel() [1/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetEdgeChannel ( HPS.Material.Channel  in_channel)
inline

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

Returns
A reference to this object.

◆ UnsetEdgeChannel() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetEdgeChannel ( HPS.Material.Channel  in_channel,
ulong  in_layer 
)
inline

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

Returns
A reference to this object.

◆ UnsetEdgeMaterial()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetEdgeMaterial ( )
inline

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

Returns
A reference to this object.

◆ UnsetEverything()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetEverything ( )
inline

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

Returns
A reference to this object.

◆ UnsetFaceChannel() [1/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetFaceChannel ( HPS.Material.Channel  in_channel)
inline

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

Returns
A reference to this object.

◆ UnsetFaceChannel() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetFaceChannel ( HPS.Material.Channel  in_channel,
ulong  in_layer 
)
inline

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

Returns
A reference to this object.

◆ UnsetFaceMaterial()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetFaceMaterial ( )
inline

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

Returns
A reference to this object.

◆ UnsetFrontFaceChannel() [1/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetFrontFaceChannel ( HPS.Material.Channel  in_channel)
inline

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

Returns
A reference to this object.

◆ UnsetFrontFaceChannel() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetFrontFaceChannel ( HPS.Material.Channel  in_channel,
ulong  in_layer 
)
inline

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

Returns
A reference to this object.

◆ UnsetFrontFaceMaterial()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetFrontFaceMaterial ( )
inline

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

Returns
A reference to this object.

◆ UnsetLightColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetLightColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetLineAlpha()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetLineAlpha ( )
inline

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

Returns
A reference to this object.

◆ UnsetLineColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetLineColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetMarkerColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetMarkerColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetTextColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetTextColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetVertexChannel() [1/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetVertexChannel ( HPS.Material.Channel  in_channel)
inline

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

Returns
A reference to this object.

◆ UnsetVertexChannel() [2/2]

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetVertexChannel ( HPS.Material.Channel  in_channel,
ulong  in_layer 
)
inline

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

Returns
A reference to this object.

◆ UnsetVertexMaterial()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetVertexMaterial ( )
inline

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

Returns
A reference to this object.

◆ UnsetWindowColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetWindowColor ( )
inline

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

Returns
A reference to this object.

◆ UnsetWindowContrastColor()

HPS.MaterialMappingControl HPS.MaterialMappingControl.UnsetWindowContrastColor ( )
inline

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

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.MaterialMappingControl.cs