#include <GiMaterialTraitsData.h>

Public Member Functions
	OdGiMaterialTraitsData ()

void	operator= (const OdGiMaterialTraitsData &other)

bool	operator== (const OdGiMaterialTraitsData &other) const

bool	operator!= (const OdGiMaterialTraitsData &other) const

void	ambient (OdGiMaterialColor &ambientColor) const

void	diffuse (OdGiMaterialColor &diffuseColor, OdGiMaterialMap &diffuseMap) const

void	specular (OdGiMaterialColor &specularColor, OdGiMaterialMap &specularMap, double &glossFactor) const

void	reflection (OdGiMaterialMap &reflectionMap) const

void	opacity (double &opacity, OdGiMaterialMap &opacityMap) const

void	bump (OdGiMaterialMap &bumpMap) const

void	refraction (double &refractionIndex, OdGiMaterialMap &refractionMap) const

double	translucence () const

double	selfIllumination () const

double	reflectivity () const

OdGiMaterialTraits::IlluminationModel	illuminationModel () const

OdGiMaterialTraits::ChannelFlags	channelFlags () const

OdGiMaterialTraits::Mode	mode () const

void	setAmbient (const OdGiMaterialColor &ambientColor)

void	setDiffuse (const OdGiMaterialColor &diffuseColor, const OdGiMaterialMap &diffuseMap)

void	setSpecular (const OdGiMaterialColor &specularColor, const OdGiMaterialMap &specularMap, double glossFactor)

void	setReflection (const OdGiMaterialMap &reflectionMap)

void	setOpacity (double opacity, const OdGiMaterialMap &opacityMap)

void	setBump (const OdGiMaterialMap &bumpMap)

void	setRefraction (double refractionIndex, const OdGiMaterialMap &refractionMap)

void	setTranslucence (double value)

void	setSelfIllumination (double value)

void	setReflectivity (double value)

void	setIlluminationModel (OdGiMaterialTraits::IlluminationModel model)

void	setChannelFlags (OdGiMaterialTraits::ChannelFlags flags)

void	setMode (OdGiMaterialTraits::Mode value)

void	setColorBleedScale (double scale)

double	colorBleedScale () const

void	setIndirectBumpScale (double scale)

double	indirectBumpScale () const

void	setReflectanceScale (double scale)

double	reflectanceScale () const

void	setTransmittanceScale (double scale)

double	transmittanceScale () const

void	setTwoSided (bool flag)

bool	twoSided () const

void	setLuminanceMode (OdGiMaterialTraits::LuminanceMode mode)

OdGiMaterialTraits::LuminanceMode	luminanceMode () const

void	setLuminance (double value)

double	luminance () const

void	setNormalMap (const OdGiMaterialMap &normalMap, OdGiMaterialTraits::NormalMapMethod method, double strength)

void	normalMap (OdGiMaterialMap &normalMap, OdGiMaterialTraits::NormalMapMethod &method, double &strength) const

void	setGlobalIllumination (OdGiMaterialTraits::GlobalIlluminationMode mode)

OdGiMaterialTraits::GlobalIlluminationMode	globalIllumination () const

void	setFinalGather (OdGiMaterialTraits::FinalGatherMode mode)

OdGiMaterialTraits::FinalGatherMode	finalGather () const

void	setEmission (const OdGiMaterialColor &emissionColor, const OdGiMaterialMap &emissionMap)

void	emission (OdGiMaterialColor &emissionColor, OdGiMaterialMap &emissionMap) const

void	setTint (const OdGiMaterialColor &tintColor)

void	tint (OdGiMaterialColor &tintColor) const

void	setShadingAmbient (const OdGiMaterialColor &ambientColor)

void	shadingAmbient (OdGiMaterialColor &ambientColor) const

void	setShadingDiffuse (const OdGiMaterialColor &diffuseColor)

void	shadingDiffuse (OdGiMaterialColor &diffuseColor) const

void	setShadingSpecular (const OdGiMaterialColor &specularColor)

void	shadingSpecular (OdGiMaterialColor &specularColor) const

void	setShadingOpacity (double opacityPercentage)

void	shadingOpacity (double &opacityPercentage) const

void	setDiffuseColorMode (OdGiMaterialTraits::DiffuseColorMode diffuseColorMode)

OdGiMaterialTraits::DiffuseColorMode	diffuseColorMode () const

void	setShadowsOpacityEffect (double shadowsOpacity, double nonShadowLightsMergeEffect)

double	shadowsOpacityEffect (double &nonShadowLightsMergeEffect) const

void	setSpecularHighlightingOverride (double overrideVal)

double	specularHighlightingOverride () const

void	setRoughness (const OdGiMaterialMap &roughnessMap, double strength)

void	roughness (OdGiMaterialMap &roughnessMap, double &strength) const

void	setCutouts (const OdGiMaterialMap &cutoutsMap)

void	cutouts (OdGiMaterialMap &cutoutsMap) const

void	setReflectionMethod (OdGiMaterialTraits::ReflectionMethod method)

OdGiMaterialTraits::ReflectionMethod	reflectionMethod () const

Protected Attributes
OdGiMaterialColor	m_ambientColor

OdGiMaterialColor	m_diffuseColor

OdGiMaterialMap	m_diffuseMap

OdGiMaterialColor	m_specularColor

OdGiMaterialMap	m_specularMap

double	m_glossFactor

OdGiMaterialMap	m_reflectionMap

double	m_opacity

OdGiMaterialMap	m_opacityMap

OdGiMaterialMap	m_bumpMap

double	m_refractionIndex

OdGiMaterialMap	m_refractionMap

double	m_translucenceVal

double	m_selfIllumVal

double	m_reflectivityVal

OdGiMaterialTraits::IlluminationModel	m_illumModel

OdGiMaterialTraits::ChannelFlags	m_channelFlags

OdGiMaterialTraits::Mode	m_mode

double	m_bleedScale

double	m_indirectBumpScale

double	m_reflectScale

double	m_transmitScale

bool	m_twoSided

OdGiMaterialTraits::LuminanceMode	m_lumiMode

double	m_lumiVal

OdGiMaterialMap	m_normalMap

OdGiMaterialTraits::NormalMapMethod	m_normalMethod

double	m_normalStrength

OdGiMaterialTraits::GlobalIlluminationMode	m_globIllum

OdGiMaterialTraits::FinalGatherMode	m_fgMode

OdGiMaterialColor	m_emissionColor

OdGiMaterialMap	m_emissionMap

OdGiMaterialColor	m_tintColor

OdGiMaterialColor	m_shadingAmbientColor

OdGiMaterialColor	m_shadingDiffuseColor

OdGiMaterialColor	m_shadingSpeclrColor

double	m_shadingOpacity

OdGiMaterialTraits::DiffuseColorMode	m_diffuseColorMode

OdGiMaterialTraits::ReflectionMethod	m_reflectionMethod

double	m_shadowsOpacity

double	m_specularOverride

double	m_nslmEffect

double	m_roughness

OdGiMaterialMap	m_roughnessMap

OdGiMaterialMap	m_cutoutsMap

Detailed Description

See also: <link tv_working_with_attributes_materials, Work with Materials>

Definition at line 40 of file GiMaterialTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiMaterialTraitsData()

OdGiMaterialTraitsData::OdGiMaterialTraitsData ( )

inline

Default constructor for the OdGiMaterialTraitsData class. Sets object with default properties.

Definition at line 95 of file GiMaterialTraitsData.h.

Member Function Documentation

◆ ambient()

void OdGiMaterialTraitsData::ambient ( OdGiMaterialColor & ambientColor ) const

inline

Sets the ambient color.

Parameters

ambientColor [in] Ambient color.

Definition at line 333 of file GiMaterialTraitsData.h.

◆ bump()

void OdGiMaterialTraitsData::bump ( OdGiMaterialMap & bumpMap ) const

inline

Sets the bump map.

Parameters

bumpMap [in] Bump map.

Definition at line 386 of file GiMaterialTraitsData.h.

◆ channelFlags()

OdGiMaterialTraits::ChannelFlags OdGiMaterialTraitsData::channelFlags ( ) const

inline

Retrieves the material channels that are enabled.

Returns: channel flags of a material represented by a value from the ChannelFlags enumeration.

Definition at line 447 of file GiMaterialTraitsData.h.

◆ colorBleedScale()

double OdGiMaterialTraitsData::colorBleedScale ( ) const

inline

Retrieves the color bleed scale of this object.

Returns: color bleed scale as a value of the double type.

Definition at line 632 of file GiMaterialTraitsData.h.

◆ cutouts()

void OdGiMaterialTraitsData::cutouts ( OdGiMaterialMap & cutoutsMap ) const

inline

Returns the cutouts component of this object.

Parameters

cutoutsMap [out] Receives the cutouts map.

Definition at line 1075 of file GiMaterialTraitsData.h.

◆ diffuse()

void OdGiMaterialTraitsData::diffuse	(	OdGiMaterialColor &	diffuseColor,
		OdGiMaterialMap &	diffuseMap ) const

inline

Sets the diffuse color.

Parameters

diffuseColor	[in] Diffuse color.
diffuseMap	[in] Diffuse map.

Definition at line 343 of file GiMaterialTraitsData.h.

◆ diffuseColorMode()

OdGiMaterialTraits::DiffuseColorMode OdGiMaterialTraitsData::diffuseColorMode ( ) const

inline

Retrieves current diffuse, ambient, specular color and opacity behavior.

Returns: diffuse color mode as a value from the DiffuseColorMode enumeration.

Definition at line 973 of file GiMaterialTraitsData.h.

◆ emission()

void OdGiMaterialTraitsData::emission	(	OdGiMaterialColor &	emissionColor,
		OdGiMaterialMap &	emissionMap ) const

inline

Retrieves the emission component of this object.

Parameters

emissionColor	[out] Receives the emission color.
emissionMap	[out] Receives the emission map.

Definition at line 852 of file GiMaterialTraitsData.h.

◆ finalGather()

OdGiMaterialTraits::FinalGatherMode OdGiMaterialTraitsData::finalGather ( ) const

inline

Retrieves the final gather mode of this object.

Returns: final gathering mode as a value from the FinalGatherMode enumeration.

Definition at line 827 of file GiMaterialTraitsData.h.

◆ globalIllumination()

OdGiMaterialTraits::GlobalIlluminationMode OdGiMaterialTraitsData::globalIllumination ( ) const

inline

Retrieves the global illumination mode of this object.

Returns: global illumination mode as a value from the GlobalIlluminationMode enumeration.

Definition at line 806 of file GiMaterialTraitsData.h.

◆ illuminationModel()

OdGiMaterialTraits::IlluminationModel OdGiMaterialTraitsData::illuminationModel ( ) const

inline

Retrieves the illumination model.

Returns: illumination model represented by the value from the IlluminationModel enumeration.

Definition at line 437 of file GiMaterialTraitsData.h.

◆ indirectBumpScale()

double OdGiMaterialTraitsData::indirectBumpScale ( ) const

inline

Retrieves the indirect bump scale of this object.

Returns: indirect bump scale as a value of the double type.

Definition at line 653 of file GiMaterialTraitsData.h.

◆ luminance()

double OdGiMaterialTraitsData::luminance ( ) const

inline

Retrieves the luminance of this object.

Returns: luminance amount as a value of the double type.

Definition at line 757 of file GiMaterialTraitsData.h.

◆ luminanceMode()

OdGiMaterialTraits::LuminanceMode OdGiMaterialTraitsData::luminanceMode ( ) const

inline

Retrieves the luminance mode of this object.

Returns: a value from the LuminanceMode enumeration that represents one of the luminance modes.

Definition at line 736 of file GiMaterialTraitsData.h.

◆ mode()

OdGiMaterialTraits::Mode OdGiMaterialTraitsData::mode ( ) const

inline

Retrieves the material model.

Returns: material model represented by a value from the Mode enumeration.

Definition at line 457 of file GiMaterialTraitsData.h.

◆ normalMap()

void OdGiMaterialTraitsData::normalMap	(	OdGiMaterialMap &	normalMap,
		OdGiMaterialTraits::NormalMapMethod &	method,
		double &	strength ) const

inline

Retrieves the normalMap component of this object.

Parameters

normalMap	[out] Receives the normal map.
method	[out] Receives the normal map method.
strength	[out] Receives the normal map strength factor.

Definition at line 783 of file GiMaterialTraitsData.h.

◆ opacity()

void OdGiMaterialTraitsData::opacity	(	double &	opacity,
		OdGiMaterialMap &	opacityMap ) const

inline

Sets the opacity properties.

Parameters

opacity	[in] Opacity factor.
opacityMap	[in] Opacity map.

Definition at line 376 of file GiMaterialTraitsData.h.

◆ operator!=()

bool OdGiMaterialTraitsData::operator!= ( const OdGiMaterialTraitsData & other ) const

inline

Inequality operator for the OdGiMaterialTraitsData class. Compares properties of the specified material traits to properties of this material traits object.

Parameters

other [in] Other object to be compared.

Returns: true if at least one property of the passed object differs from the corresponding property of this object, false if all properties are equal.

Definition at line 276 of file GiMaterialTraitsData.h.

◆ operator=()

void OdGiMaterialTraitsData::operator= ( const OdGiMaterialTraitsData & other )

inline

Assignment operator for the OdGiMaterialColor class. Assigns properties of the specified material traits to this material traits object.

Parameters

other [in] Object that stores properties to be assigned.

Definition at line 153 of file GiMaterialTraitsData.h.

◆ operator==()

bool OdGiMaterialTraitsData::operator== ( const OdGiMaterialTraitsData & other ) const

inline

Equality operator for the OdGiMaterialTraitsData class. Compares properties of the specified material traits to properties of this material traits object.

Parameters

other [in] Other object to be compared.

Returns: true if all properties of the passed object are equal to properties pf this object, false otherwise.

Definition at line 214 of file GiMaterialTraitsData.h.

◆ reflectanceScale()

double OdGiMaterialTraitsData::reflectanceScale ( ) const

inline

Retrieves the reflectance scale of this object.

Returns: reference scale as a value of the double type.

Definition at line 674 of file GiMaterialTraitsData.h.

◆ reflection()

void OdGiMaterialTraitsData::reflection ( OdGiMaterialMap & reflectionMap ) const

inline

Sets the reflection map.

Parameters

reflectionMap [in] Reflection map.

Definition at line 366 of file GiMaterialTraitsData.h.

◆ reflectionMethod()

OdGiMaterialTraits::ReflectionMethod OdGiMaterialTraitsData::reflectionMethod ( ) const

inline

Returns the reflection method of this object.

Returns: reflection method as a value from the ReflectionMethod enumeration.

Definition at line 1096 of file GiMaterialTraitsData.h.

◆ reflectivity()

double OdGiMaterialTraitsData::reflectivity ( ) const

inline

Retrieves the reflectivity value.

Returns: reflectivity as a value of the double type.

Definition at line 427 of file GiMaterialTraitsData.h.

◆ refraction()

void OdGiMaterialTraitsData::refraction	(	double &	refractionIndex,
		OdGiMaterialMap &	refractionMap ) const

inline

Sets the refraction properties.

Parameters

refractionIndex	[in] Index of refraction for a physical material. See online tables with values for specific physical materials.
refractionMap	[in] Reflection map.

Definition at line 396 of file GiMaterialTraitsData.h.

◆ roughness()

void OdGiMaterialTraitsData::roughness	(	OdGiMaterialMap &	roughnessMap,
		double &	strength ) const

inline

Returns the roughness component of this object.

Parameters

roughnessMap	[out] Receives the roughness map.
strength	[out] Receives roughness effect strength.

Definition at line 1054 of file GiMaterialTraitsData.h.

◆ selfIllumination()

double OdGiMaterialTraitsData::selfIllumination ( ) const

inline

Retrieves the self-illumination amount.

Returns: self-illumination as a value of the double type.

Definition at line 417 of file GiMaterialTraitsData.h.

◆ setAmbient()

void OdGiMaterialTraitsData::setAmbient ( const OdGiMaterialColor & ambientColor )

inline

Sets the ambient color component.

Parameters

ambientColor [in] Ambient color.

Remarks: The ambient color component is most apparent when there is no direct illumination on the entity.

Definition at line 470 of file GiMaterialTraitsData.h.

◆ setBump()

void OdGiMaterialTraitsData::setBump ( const OdGiMaterialMap & bumpMap )

inline

Sets the bump component of this object.

Parameters

bumpMap [in] Bump map.

Definition at line 537 of file GiMaterialTraitsData.h.

◆ setChannelFlags()

void OdGiMaterialTraitsData::setChannelFlags ( OdGiMaterialTraits::ChannelFlags flags )

inline

Sets the material channels to be used by this MaterialTraits object.

Parameters

value [in] Channels to be used.

Definition at line 599 of file GiMaterialTraitsData.h.

◆ setColorBleedScale()

void OdGiMaterialTraitsData::setColorBleedScale ( double scale )

inline

Sets the color bleed scale of this object.

Parameters

scale [in] Color bleed scale.

Definition at line 621 of file GiMaterialTraitsData.h.

◆ setCutouts()

void OdGiMaterialTraitsData::setCutouts ( const OdGiMaterialMap & cutoutsMap )

inline

Sets the cutouts component of this object.

Parameters

cutoutsMap [in] Cutouts map.

Definition at line 1065 of file GiMaterialTraitsData.h.

◆ setDiffuse()

void OdGiMaterialTraitsData::setDiffuse	(	const OdGiMaterialColor &	diffuseColor,
		const OdGiMaterialMap &	diffuseMap )

inline

Sets the diffuse component of this object.

Parameters

diffuseColor	[in] Diffuse color.
diffuseMap	[in] Diffuse map.

Remarks: The diffuse component is most apparent when there is direct illumination on the entity.

Definition at line 484 of file GiMaterialTraitsData.h.

◆ setDiffuseColorMode()

void OdGiMaterialTraitsData::setDiffuseColorMode ( OdGiMaterialTraits::DiffuseColorMode diffuseColorMode )

inline

Sets diffuse, ambient, specual color and opacity behavior.

Parameters

diffuseColorMode [in] New setting for diffuse color and opacity mode.

Definition at line 963 of file GiMaterialTraitsData.h.

◆ setEmission()

void OdGiMaterialTraitsData::setEmission	(	const OdGiMaterialColor &	emissionColor,
		const OdGiMaterialMap &	emissionMap )

inline

Sets the emission component of this object.

Parameters

emissionColor	[in] Emission color.
emissionMap	[in] Emission map.

Definition at line 840 of file GiMaterialTraitsData.h.

◆ setFinalGather()

void OdGiMaterialTraitsData::setFinalGather ( OdGiMaterialTraits::FinalGatherMode mode )

inline

Sets the final gather mode of this object.

Parameters

mode	[in] Final gather mode.

Definition at line 816 of file GiMaterialTraitsData.h.

◆ setGlobalIllumination()

void OdGiMaterialTraitsData::setGlobalIllumination ( OdGiMaterialTraits::GlobalIlluminationMode mode )

inline

Sets the global illumination mode of this object.

Parameters

mode	[in] Global illumination mode.

Definition at line 795 of file GiMaterialTraitsData.h.

◆ setIlluminationModel()

void OdGiMaterialTraitsData::setIlluminationModel ( OdGiMaterialTraits::IlluminationModel model )

inline

Sets the illumination model of this object.

Parameters

model [in] Illumination model.

Definition at line 589 of file GiMaterialTraitsData.h.

◆ setIndirectBumpScale()

void OdGiMaterialTraitsData::setIndirectBumpScale ( double scale )

inline

Sets the indirect bump scale of this object.

Parameters

scale [in] Indirect bump scale.

Definition at line 642 of file GiMaterialTraitsData.h.

◆ setLuminance()

void OdGiMaterialTraitsData::setLuminance ( double value )

inline

Sets the luminance of this object.

Parameters

value [in] Luminance value.

Definition at line 746 of file GiMaterialTraitsData.h.

◆ setLuminanceMode()

void OdGiMaterialTraitsData::setLuminanceMode ( OdGiMaterialTraits::LuminanceMode mode )

inline

Sets the luminance mode of this object.

Parameters

mode	[in] Luminance mode.

Definition at line 725 of file GiMaterialTraitsData.h.

◆ setMode()

void OdGiMaterialTraitsData::setMode ( OdGiMaterialTraits::Mode value )

inline

Sets the mode of this object.

Parameters

value [in] Mode value.

Definition at line 609 of file GiMaterialTraitsData.h.

◆ setNormalMap()

void OdGiMaterialTraitsData::setNormalMap	(	const OdGiMaterialMap &	normalMap,
		OdGiMaterialTraits::NormalMapMethod	method,
		double	strength )

inline

Sets the normalMap component of this object.

Parameters

normalMap	[in] Normal map.
method	[in] Normal map method.
strength	[in] Strength factor.

Definition at line 769 of file GiMaterialTraitsData.h.

◆ setOpacity()

void OdGiMaterialTraitsData::setOpacity	(	double	opacity,
		const OdGiMaterialMap &	opacityMap )

inline

Sets the opacity component of this object.

Parameters

opacityPercentage	[in] Opacity percentage.
opacityMap	[in] Opacity map.

Definition at line 526 of file GiMaterialTraitsData.h.

◆ setReflectanceScale()

void OdGiMaterialTraitsData::setReflectanceScale ( double scale )

inline

Sets the reflectance scale of this object.

Parameters

scale [in] Reflectance scale.

Definition at line 663 of file GiMaterialTraitsData.h.

◆ setReflection()

void OdGiMaterialTraitsData::setReflection ( const OdGiMaterialMap & reflectionMap )

inline

Sets the reflection component of this object.

Parameters

reflectionMap [in] Reflection map.

Remarks: The reflection component creates a mirror finish on the entity.

Definition at line 515 of file GiMaterialTraitsData.h.

◆ setReflectionMethod()

void OdGiMaterialTraitsData::setReflectionMethod ( OdGiMaterialTraits::ReflectionMethod method )

inline

Sets the reflection method of this object.

Parameters

method [in] Reflection method.

Definition at line 1085 of file GiMaterialTraitsData.h.

◆ setReflectivity()

void OdGiMaterialTraitsData::setReflectivity ( double value )

inline

Sets the reflectivity of this object.

Parameters

value [in] Reflectivity value.

Definition at line 579 of file GiMaterialTraitsData.h.

◆ setRefraction()

void OdGiMaterialTraitsData::setRefraction	(	double	refractionIndex,
		const OdGiMaterialMap &	refractionMap )

inline

Sets the refraction component of this object.

Parameters

refractionIndex	[in] Refraction index.
refractionMap	[in] Refraction map.

Definition at line 548 of file GiMaterialTraitsData.h.

◆ setRoughness()

void OdGiMaterialTraitsData::setRoughness	(	const OdGiMaterialMap &	roughnessMap,
		double	strength )

inline

Sets the roughness component of this object.

Parameters

roughnessMap	[in] Roughness map.
strength	[in] Roughness effect strength.

Definition at line 1042 of file GiMaterialTraitsData.h.

◆ setSelfIllumination()

void OdGiMaterialTraitsData::setSelfIllumination ( double value )

inline

Sets the self illumination of this object.

Parameters

value [in] Self illumination level.

Definition at line 569 of file GiMaterialTraitsData.h.

◆ setShadingAmbient()

void OdGiMaterialTraitsData::setShadingAmbient ( const OdGiMaterialColor & ambientColor )

inline

Sets the shading ambient color component of this object.

Parameters

ambientColor [in] Shading ambient color.

Definition at line 883 of file GiMaterialTraitsData.h.

◆ setShadingDiffuse()

void OdGiMaterialTraitsData::setShadingDiffuse ( const OdGiMaterialColor & diffuseColor )

inline

Sets the shading diffuse color component of this object.

Parameters

diffuseColor [in] Shading diffuse color.

Definition at line 903 of file GiMaterialTraitsData.h.

◆ setShadingOpacity()

void OdGiMaterialTraitsData::setShadingOpacity ( double opacityPercentage )

inline

Sets the shading opacity component of this object.

Parameters

opacityPercentage [in] Shading opacity percentage.

Definition at line 943 of file GiMaterialTraitsData.h.

◆ setShadingSpecular()

void OdGiMaterialTraitsData::setShadingSpecular ( const OdGiMaterialColor & specularColor )

inline

Sets the shading specular color component of this object.

Parameters

specularColor [in] Shading specular color.

Definition at line 923 of file GiMaterialTraitsData.h.

◆ setShadowsOpacityEffect()

void OdGiMaterialTraitsData::setShadowsOpacityEffect	(	double	shadowsOpacity,
		double	nonShadowLightsMergeEffect )

inline

Sets coefficient of opacity influence onto received shadows.

Parameters

shadowsOpacity	[in] Coefficient in 0.0-1.0 range.
nonShadowLightsMergeEffect	[in] Value in 0.0-1.0 range that influences ignoring shadows casting by lights.

Remarks: The effect percentage value varies from 0 to 1. If nonShadowLightsMergeEffect is 0.0 lights can cast shadows on the material, if nonShadowLightsMergeEffect is 1.0 - lights do not cast shadows on the material.

Definition at line 989 of file GiMaterialTraitsData.h.

◆ setSpecular()

void OdGiMaterialTraitsData::setSpecular	(	const OdGiMaterialColor &	specularColor,
		const OdGiMaterialMap &	specularMap,
		double	glossFactor )

inline

Sets the specular component of this object.

Parameters

specularColor	[in] Specular color.
specularMap	[in] Specular map.
glossFactor	[in] Gloss factor.

Remarks: The specular component depends on the viewer's eye position and represents light source reflection highlights on the entity surface.

Definition at line 500 of file GiMaterialTraitsData.h.

◆ setSpecularHighlightingOverride()

void OdGiMaterialTraitsData::setSpecularHighlightingOverride ( double overrideVal )

inline

Sets specular highlighting behavior override.

Parameters

overrideVal [in] Specular highlighting override value.

Remarks: Positive override value represents absolute specular highlighting factor. Zero override value disables specular highlighting override. Negative override value provides maximal specular highlighting factor and means that highlighting factor must be taken from Visual Style.

Definition at line 1018 of file GiMaterialTraitsData.h.

◆ setTint()

void OdGiMaterialTraitsData::setTint ( const OdGiMaterialColor & tintColor )

inline

Sets the tint component of this object.

Parameters

tintColor [in] Tint color.

Definition at line 863 of file GiMaterialTraitsData.h.

◆ setTranslucence()

void OdGiMaterialTraitsData::setTranslucence ( double value )

inline

Sets the translucence of this object.

Parameters

value [in] Translucence value.

Definition at line 559 of file GiMaterialTraitsData.h.

◆ setTransmittanceScale()

void OdGiMaterialTraitsData::setTransmittanceScale ( double scale )

inline

Sets the transmittance scale of this object.

Parameters

scale [in] Transmittance scale.

Definition at line 684 of file GiMaterialTraitsData.h.

◆ setTwoSided()

void OdGiMaterialTraitsData::setTwoSided ( bool flag )

inline

Sets the two-sided (individual materials for front and back faces) mode of this object.

Parameters

flag	[in] Two-sided mode flag.

Definition at line 705 of file GiMaterialTraitsData.h.

◆ shadingAmbient()

void OdGiMaterialTraitsData::shadingAmbient ( OdGiMaterialColor & ambientColor ) const

inline

Retrieves the shading ambient color component of this object.

Parameters

ambientColor [out] Receives the shading ambient color.

Definition at line 893 of file GiMaterialTraitsData.h.

◆ shadingDiffuse()

void OdGiMaterialTraitsData::shadingDiffuse ( OdGiMaterialColor & diffuseColor ) const

inline

Retrieves the shading diffuse color component of this object.

Parameters

diffuseColor [out] Receives the shading diffuse color.

Definition at line 913 of file GiMaterialTraitsData.h.

◆ shadingOpacity()

void OdGiMaterialTraitsData::shadingOpacity ( double & opacityPercentage ) const

inline

Retrieves the shading opacity component of this object.

Parameters

opacityPercentage [out] Receives the shading opacity percentage.

Definition at line 953 of file GiMaterialTraitsData.h.

◆ shadingSpecular()

void OdGiMaterialTraitsData::shadingSpecular ( OdGiMaterialColor & specularColor ) const

inline

Retrieves the shading specular color component of this object.

Parameters

specularColor [out] Receives the shading specular color.

Definition at line 933 of file GiMaterialTraitsData.h.

◆ shadowsOpacityEffect()

double OdGiMaterialTraitsData::shadowsOpacityEffect ( double & nonShadowLightsMergeEffect ) const

inline

Returns coefficient of opacity influence on the received shadows.

Parameters

nonShadowLightsMergeEffect [out] Receives a value in 0.0-1.0 range that influences ignoring shadows casting by lights.

Returns: Returns the current shadows opacity effect value.

Remarks: Coefficient is 1.0 by default, which means that shadows opacity fully depends from material opacity.

Definition at line 1002 of file GiMaterialTraitsData.h.

◆ specular()

void OdGiMaterialTraitsData::specular	(	OdGiMaterialColor &	specularColor,
		OdGiMaterialMap &	specularMap,
		double &	glossFactor ) const

inline

Sets the specular (shine) color.

Parameters

specularColor	[in] Specular color.
specularMap	[in] Specular map.
glossFactor	[in] Glossiness factor.

Definition at line 355 of file GiMaterialTraitsData.h.

◆ specularHighlightingOverride()

double OdGiMaterialTraitsData::specularHighlightingOverride ( ) const

inline

Returns specular highlighting behavior override.

Remarks: Positive override value represents absolute specular highlighting factor. Zero override value disables specular highlighting override. Negative override value provides maximal specular highlighting factor and means that highlighting factor must be taken from Visual Style.

Definition at line 1031 of file GiMaterialTraitsData.h.

◆ tint()

void OdGiMaterialTraitsData::tint ( OdGiMaterialColor & tintColor ) const

inline

Retrieves the tint component of this object.

Parameters

tintColor [out] Receives the tint color.

Definition at line 873 of file GiMaterialTraitsData.h.

◆ translucence()

double OdGiMaterialTraitsData::translucence ( ) const

inline

Retrieves the translucence value.

Returns: translucence as a value of the double type.

Definition at line 407 of file GiMaterialTraitsData.h.

◆ transmittanceScale()

double OdGiMaterialTraitsData::transmittanceScale ( ) const

inline

Retrieves the transmittance scale of this object.

Returns: transmittance scale as a value of the double type.

Definition at line 695 of file GiMaterialTraitsData.h.

◆ twoSided()

bool OdGiMaterialTraitsData::twoSided ( ) const

inline

Retrieves the two-sided (individual materials for front and back faces) mode of this object.

Returns: true if the two-sided mode is enabled, false otherwise.

Definition at line 715 of file GiMaterialTraitsData.h.

Member Data Documentation

◆ m_ambientColor

OdGiMaterialColor OdGiMaterialTraitsData::m_ambientColor

protected

Definition at line 43 of file GiMaterialTraitsData.h.

◆ m_bleedScale

double OdGiMaterialTraitsData::m_bleedScale

protected

Definition at line 62 of file GiMaterialTraitsData.h.

◆ m_bumpMap

OdGiMaterialMap OdGiMaterialTraitsData::m_bumpMap

protected

Definition at line 52 of file GiMaterialTraitsData.h.

◆ m_channelFlags

OdGiMaterialTraits::ChannelFlags OdGiMaterialTraitsData::m_channelFlags

protected

Definition at line 59 of file GiMaterialTraitsData.h.

◆ m_cutoutsMap

OdGiMaterialMap OdGiMaterialTraitsData::m_cutoutsMap

protected

Definition at line 90 of file GiMaterialTraitsData.h.

◆ m_diffuseColor

OdGiMaterialColor OdGiMaterialTraitsData::m_diffuseColor

protected

Definition at line 44 of file GiMaterialTraitsData.h.

◆ m_diffuseColorMode

OdGiMaterialTraits::DiffuseColorMode OdGiMaterialTraitsData::m_diffuseColorMode

protected

Definition at line 82 of file GiMaterialTraitsData.h.

◆ m_diffuseMap

OdGiMaterialMap OdGiMaterialTraitsData::m_diffuseMap

protected

Definition at line 45 of file GiMaterialTraitsData.h.

◆ m_emissionColor

OdGiMaterialColor OdGiMaterialTraitsData::m_emissionColor

protected

Definition at line 75 of file GiMaterialTraitsData.h.

◆ m_emissionMap

OdGiMaterialMap OdGiMaterialTraitsData::m_emissionMap

protected

Definition at line 76 of file GiMaterialTraitsData.h.

◆ m_fgMode

OdGiMaterialTraits::FinalGatherMode OdGiMaterialTraitsData::m_fgMode

protected

Definition at line 73 of file GiMaterialTraitsData.h.

◆ m_globIllum

OdGiMaterialTraits::GlobalIlluminationMode OdGiMaterialTraitsData::m_globIllum

protected

Definition at line 72 of file GiMaterialTraitsData.h.

◆ m_glossFactor

double OdGiMaterialTraitsData::m_glossFactor

protected

Definition at line 48 of file GiMaterialTraitsData.h.

◆ m_illumModel

OdGiMaterialTraits::IlluminationModel OdGiMaterialTraitsData::m_illumModel

protected

Definition at line 58 of file GiMaterialTraitsData.h.

◆ m_indirectBumpScale

double OdGiMaterialTraitsData::m_indirectBumpScale

protected

Definition at line 63 of file GiMaterialTraitsData.h.

◆ m_lumiMode

OdGiMaterialTraits::LuminanceMode OdGiMaterialTraitsData::m_lumiMode

protected

Definition at line 67 of file GiMaterialTraitsData.h.

◆ m_lumiVal

double OdGiMaterialTraitsData::m_lumiVal

protected

Definition at line 68 of file GiMaterialTraitsData.h.

◆ m_mode

OdGiMaterialTraits::Mode OdGiMaterialTraitsData::m_mode

protected

Definition at line 60 of file GiMaterialTraitsData.h.

◆ m_normalMap

OdGiMaterialMap OdGiMaterialTraitsData::m_normalMap

protected

Definition at line 69 of file GiMaterialTraitsData.h.

◆ m_normalMethod

OdGiMaterialTraits::NormalMapMethod OdGiMaterialTraitsData::m_normalMethod

protected

Definition at line 70 of file GiMaterialTraitsData.h.

◆ m_normalStrength

double OdGiMaterialTraitsData::m_normalStrength

protected

Definition at line 71 of file GiMaterialTraitsData.h.

◆ m_nslmEffect

double OdGiMaterialTraitsData::m_nslmEffect

protected

Definition at line 87 of file GiMaterialTraitsData.h.

◆ m_opacity

double OdGiMaterialTraitsData::m_opacity

protected

Definition at line 50 of file GiMaterialTraitsData.h.

◆ m_opacityMap

OdGiMaterialMap OdGiMaterialTraitsData::m_opacityMap

protected

Definition at line 51 of file GiMaterialTraitsData.h.

◆ m_reflectionMap

OdGiMaterialMap OdGiMaterialTraitsData::m_reflectionMap

protected

Definition at line 49 of file GiMaterialTraitsData.h.

◆ m_reflectionMethod

OdGiMaterialTraits::ReflectionMethod OdGiMaterialTraitsData::m_reflectionMethod

protected

Definition at line 83 of file GiMaterialTraitsData.h.

◆ m_reflectivityVal

double OdGiMaterialTraitsData::m_reflectivityVal

protected

Definition at line 57 of file GiMaterialTraitsData.h.

◆ m_reflectScale

double OdGiMaterialTraitsData::m_reflectScale

protected

Definition at line 64 of file GiMaterialTraitsData.h.

◆ m_refractionIndex

double OdGiMaterialTraitsData::m_refractionIndex

protected

Definition at line 53 of file GiMaterialTraitsData.h.

◆ m_refractionMap

OdGiMaterialMap OdGiMaterialTraitsData::m_refractionMap

protected

Definition at line 54 of file GiMaterialTraitsData.h.

◆ m_roughness

double OdGiMaterialTraitsData::m_roughness

protected

Definition at line 88 of file GiMaterialTraitsData.h.

◆ m_roughnessMap

OdGiMaterialMap OdGiMaterialTraitsData::m_roughnessMap

protected

Definition at line 89 of file GiMaterialTraitsData.h.

◆ m_selfIllumVal

double OdGiMaterialTraitsData::m_selfIllumVal

protected

Definition at line 56 of file GiMaterialTraitsData.h.

◆ m_shadingAmbientColor

OdGiMaterialColor OdGiMaterialTraitsData::m_shadingAmbientColor

protected

Definition at line 78 of file GiMaterialTraitsData.h.

◆ m_shadingDiffuseColor

OdGiMaterialColor OdGiMaterialTraitsData::m_shadingDiffuseColor

protected

Definition at line 79 of file GiMaterialTraitsData.h.

◆ m_shadingOpacity

double OdGiMaterialTraitsData::m_shadingOpacity

protected

Definition at line 81 of file GiMaterialTraitsData.h.

◆ m_shadingSpeclrColor

OdGiMaterialColor OdGiMaterialTraitsData::m_shadingSpeclrColor

protected

Definition at line 80 of file GiMaterialTraitsData.h.

◆ m_shadowsOpacity

double OdGiMaterialTraitsData::m_shadowsOpacity

protected

Definition at line 85 of file GiMaterialTraitsData.h.

◆ m_specularColor

OdGiMaterialColor OdGiMaterialTraitsData::m_specularColor

protected

Definition at line 46 of file GiMaterialTraitsData.h.

◆ m_specularMap

OdGiMaterialMap OdGiMaterialTraitsData::m_specularMap

protected

Definition at line 47 of file GiMaterialTraitsData.h.

◆ m_specularOverride

double OdGiMaterialTraitsData::m_specularOverride

protected

Definition at line 86 of file GiMaterialTraitsData.h.

◆ m_tintColor

OdGiMaterialColor OdGiMaterialTraitsData::m_tintColor

protected

Definition at line 77 of file GiMaterialTraitsData.h.

◆ m_translucenceVal

double OdGiMaterialTraitsData::m_translucenceVal

protected

Definition at line 55 of file GiMaterialTraitsData.h.

◆ m_transmitScale

double OdGiMaterialTraitsData::m_transmitScale

protected

Definition at line 65 of file GiMaterialTraitsData.h.

◆ m_twoSided

bool OdGiMaterialTraitsData::m_twoSided

protected

Definition at line 66 of file GiMaterialTraitsData.h.

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

GiMaterialTraitsData.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OdGiMaterialTraitsData()

Member Function Documentation

◆ ambient()

◆ bump()

◆ channelFlags()

◆ colorBleedScale()

◆ cutouts()

◆ diffuse()

◆ diffuseColorMode()

◆ emission()

◆ finalGather()

◆ globalIllumination()

◆ illuminationModel()

◆ indirectBumpScale()

◆ luminance()

◆ luminanceMode()

◆ mode()

◆ normalMap()

◆ opacity()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ reflectanceScale()

◆ reflection()

◆ reflectionMethod()

◆ reflectivity()

◆ refraction()

◆ roughness()

◆ selfIllumination()

◆ setAmbient()

◆ setBump()

◆ setChannelFlags()

◆ setColorBleedScale()

◆ setCutouts()

◆ setDiffuse()

◆ setDiffuseColorMode()

◆ setEmission()

◆ setFinalGather()

◆ setGlobalIllumination()

◆ setIlluminationModel()

◆ setIndirectBumpScale()

◆ setLuminance()

◆ setLuminanceMode()

◆ setMode()

◆ setNormalMap()

◆ setOpacity()

◆ setReflectanceScale()

◆ setReflection()

◆ setReflectionMethod()

◆ setReflectivity()

◆ setRefraction()

◆ setRoughness()

◆ setSelfIllumination()

◆ setShadingAmbient()

◆ setShadingDiffuse()

◆ setShadingOpacity()

◆ setShadingSpecular()

◆ setShadowsOpacityEffect()

◆ setSpecular()

◆ setSpecularHighlightingOverride()

◆ setTint()

◆ setTranslucence()

◆ setTransmittanceScale()

◆ setTwoSided()

◆ shadingAmbient()

◆ shadingDiffuse()

◆ shadingOpacity()

◆ shadingSpecular()

◆ shadowsOpacityEffect()

◆ specular()

◆ specularHighlightingOverride()

◆ tint()

◆ translucence()

◆ transmittanceScale()

◆ twoSided()

Member Data Documentation