OdGiMaterialTraitsTaker Class Reference

#include <GiMaterialTraitsData.h>

Inheritance diagram for OdGiMaterialTraitsTaker:

Public Member Functions
	ODRX_USING_HEAP_OPERATORS (OdGiMaterialTraits)
virtual void	ambient (OdGiMaterialColor &ambientColor) const
virtual void	diffuse (OdGiMaterialColor &diffuseColor, OdGiMaterialMap &diffuseMap) const
virtual void	specular (OdGiMaterialColor &specularColor, OdGiMaterialMap &specularMap, double &glossFactor) const
virtual void	reflection (OdGiMaterialMap &reflectionMap) const
virtual void	opacity (double &opacityPercentage, OdGiMaterialMap &opacityMap) const
virtual void	bump (OdGiMaterialMap &bumpMap) const
virtual void	refraction (double &refractionIndex, OdGiMaterialMap &refractionMap) const
virtual double	translucence () const
virtual double	selfIllumination () const
virtual double	reflectivity () const
virtual IlluminationModel	illuminationModel () const
virtual ChannelFlags	channelFlags () const
virtual Mode	mode () const
virtual void	setAmbient (const OdGiMaterialColor &ambientColor)
virtual void	setDiffuse (const OdGiMaterialColor &diffuseColor, const OdGiMaterialMap &diffuseMap)
virtual void	setSpecular (const OdGiMaterialColor &specularColor, const OdGiMaterialMap &specularMap, double glossFactor)
virtual void	setReflection (const OdGiMaterialMap &reflectionMap)
virtual void	setOpacity (double opacityPercentage, const OdGiMaterialMap &opacityMap)
virtual void	setBump (const OdGiMaterialMap &bumpMap)
virtual void	setRefraction (double refractionIndex, const OdGiMaterialMap &refractionMap)
virtual void	setTranslucence (double value)
virtual void	setSelfIllumination (double value)
virtual void	setReflectivity (double value)
virtual void	setIlluminationModel (IlluminationModel model)
virtual void	setChannelFlags (ChannelFlags flags)
virtual void	setMode (Mode value)
virtual void	setColorBleedScale (double scale)
virtual double	colorBleedScale () const
virtual void	setIndirectBumpScale (double scale)
virtual double	indirectBumpScale () const
virtual void	setReflectanceScale (double scale)
virtual double	reflectanceScale () const
virtual void	setTransmittanceScale (double scale)
virtual double	transmittanceScale () const
virtual void	setTwoSided (bool flag)
virtual bool	twoSided () const
virtual void	setLuminanceMode (LuminanceMode mode)
virtual LuminanceMode	luminanceMode () const
virtual void	setLuminance (double value)
virtual double	luminance () const
virtual void	setNormalMap (const OdGiMaterialMap &normalMap, NormalMapMethod method, double strength)
virtual void	normalMap (OdGiMaterialMap &normalMap, NormalMapMethod &method, double &strength) const
virtual void	setGlobalIllumination (GlobalIlluminationMode mode)
virtual GlobalIlluminationMode	globalIllumination () const
virtual void	setFinalGather (FinalGatherMode mode)
virtual FinalGatherMode	finalGather () const
virtual void	setEmission (const OdGiMaterialColor &emissionColor, const OdGiMaterialMap &emissionMap)
virtual void	emission (OdGiMaterialColor &emissionColor, OdGiMaterialMap &emissionMap) const
virtual void	setTint (const OdGiMaterialColor &tintColor)
virtual void	tint (OdGiMaterialColor &tintColor) const
virtual void	setShadingAmbient (const OdGiMaterialColor &ambientColor)
virtual void	shadingAmbient (OdGiMaterialColor &ambientColor) const
virtual void	setShadingDiffuse (const OdGiMaterialColor &diffuseColor)
virtual void	shadingDiffuse (OdGiMaterialColor &diffuseColor) const
virtual void	setShadingSpecular (const OdGiMaterialColor &specularColor)
virtual void	shadingSpecular (OdGiMaterialColor &specularColor) const
virtual void	setShadingOpacity (double opacityPercentage)
virtual void	shadingOpacity (double &opacityPercentage) const
virtual void	setDiffuseColorMode (DiffuseColorMode diffuseColorMode)
virtual DiffuseColorMode	diffuseColorMode () const
virtual void	setShadowsOpacityEffect (double effectPercentage, double nonShadowLightsMergeEffect)
virtual 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 (ReflectionMethod method)
ReflectionMethod	reflectionMethod () const
void	getData (OdGiMaterialTraitsData &data) const
const OdGiMaterialTraitsData &	getData () const
void	setData (const OdGiMaterialTraitsData &data)
Public Member Functions inherited from OdStaticRxObject< OdGiMaterialTraits >
void	addRef ()
void	release () ODRX_NOEXCEPT
Public Member Functions inherited from OdGiMaterialTraits
	ODRX_DECLARE_MEMBERS (OdGiMaterialTraits)
Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Attributes
OdGiMaterialTraitsData	m_data

Additional Inherited Members
Public Types inherited from OdGiMaterialTraits
enum	IlluminationModel { kBlinnShader = 0 , kMetalShader }
enum	ChannelFlags {   kNone = 0x00000 , kUseDiffuse = 0x00001 , kUseSpecular = 0x00002 , kUseReflection = 0x00004 ,   kUseOpacity = 0x00008 , kUseBump = 0x00010 , kUseRefraction = 0x00020 , kUseNormalMap = 0x00040 ,   kUseEmission = 0x00080 , kUseTint = 0x00100 , kUseRoughness = 0x00200 , kUseCutouts = 0x00400 ,   kUseAll , kUseAllInternal = (kUseAll | kUseEmission | kUseTint | kUseRoughness | kUseCutouts) }
enum	Mode { kRealistic = 0 , kAdvanced }
enum	{ kByBlock = (OdGiDrawable::kLastFlag << 1) , kByLayer = (OdGiDrawable::kLastFlag << 2) }
enum	LuminanceMode { kSelfIllumination = 0 , kLuminance , kEmissionColor }
enum	NormalMapMethod { kTangentSpace , kReliefPattern }
enum	GlobalIlluminationMode { kGlobalIlluminationNone , kGlobalIlluminationCast , kGlobalIlluminationReceive , kGlobalIlluminationCastAndReceive }
enum	FinalGatherMode { kFinalGatherNone , kFinalGatherCast , kFinalGatherReceive , kFinalGatherCastAndReceive }
enum	DiffuseColorMode { kDiffuseRealisticColor = 0 , kDiffuseShadingColor , kDiffuseStyleDependent }
enum	ReflectionMethod { kRayTracedReflections , kEnvironmentReflection }
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Detailed Description

See also

<link tv_working_with_attributes_materials, Work with Materials>

<group OdGi_Classes>

Definition at line 1109 of file GiMaterialTraitsData.h.

Member Function Documentation

ambient()

virtual void OdGiMaterialTraitsTaker::ambient ( OdGiMaterialColor & ambientColor ) const

inlinevirtual

Sets the ambient color.

Parameters

ambientColor

[in] Ambient color.

Implements OdGiMaterialTraits.

Definition at line 1120 of file GiMaterialTraitsData.h.

bump()

virtual void OdGiMaterialTraitsTaker::bump ( OdGiMaterialMap & bumpMap ) const

inlinevirtual

Sets the bump map.

Parameters

bumpMap

[in] Bump map.

Implements OdGiMaterialTraits.

Definition at line 1169 of file GiMaterialTraitsData.h.

channelFlags()

virtual ChannelFlags OdGiMaterialTraitsTaker::channelFlags ( ) const

inlinevirtual

Retrieves the material channels that are enabled.

Returns

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

Implements OdGiMaterialTraits.

Definition at line 1229 of file GiMaterialTraitsData.h.

colorBleedScale()

virtual double OdGiMaterialTraitsTaker::colorBleedScale ( ) const

inlinevirtual

Retrieves the color bleed scale of this object.

Returns

color bleed scale as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1407 of file GiMaterialTraitsData.h.

cutouts()

void OdGiMaterialTraitsTaker::cutouts ( OdGiMaterialMap & cutoutsMap ) const

inlinevirtual

Returns the cutouts component of this object.

Parameters

cutoutsMap

[out] Receives the cutouts map.

Implements OdGiMaterialTraits.

Definition at line 1834 of file GiMaterialTraitsData.h.

diffuse()

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

inlinevirtual

Sets the diffuse color.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1130 of file GiMaterialTraitsData.h.

diffuseColorMode()

virtual DiffuseColorMode OdGiMaterialTraitsTaker::diffuseColorMode ( ) const

inlinevirtual

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

Returns

diffuse color mode as a value from the DiffuseColorMode enumeration.

Implements OdGiMaterialTraits.

Definition at line 1741 of file GiMaterialTraitsData.h.

emission()

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

inlinevirtual

Retrieves the emission component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1620 of file GiMaterialTraitsData.h.

finalGather()

virtual FinalGatherMode OdGiMaterialTraitsTaker::finalGather ( ) const

inlinevirtual

Retrieves the final gather mode of this object.

Returns

final gathering mode as a value from the FinalGatherMode enumeration.

Implements OdGiMaterialTraits.

Definition at line 1598 of file GiMaterialTraitsData.h.

getData() [1/2]

const OdGiMaterialTraitsData & OdGiMaterialTraitsTaker::getData ( ) const

inline

Retrieves material traits data from this object.

Returns

reference to the OdGiMaterialTraitsData that represents material traits data for this object.

Definition at line 1871 of file GiMaterialTraitsData.h.

getData() [2/2]

void OdGiMaterialTraitsTaker::getData ( OdGiMaterialTraitsData & data ) const

inline

Retrieves material traits data from this object.

Parameters

data	[out] Placeholder for material traits.

Definition at line 1864 of file GiMaterialTraitsData.h.

globalIllumination()

virtual GlobalIlluminationMode OdGiMaterialTraitsTaker::globalIllumination ( ) const

inlinevirtual

Retrieves the global illumination mode of this object.

Returns

global illumination mode as a value from the GlobalIlluminationMode enumeration.

Implements OdGiMaterialTraits.

Definition at line 1577 of file GiMaterialTraitsData.h.

illuminationModel()

virtual IlluminationModel OdGiMaterialTraitsTaker::illuminationModel ( ) const

inlinevirtual

Retrieves the illumination model.

Returns

illumination model represented by the value from the IlluminationModel enumeration.

Implements OdGiMaterialTraits.

Definition at line 1219 of file GiMaterialTraitsData.h.

indirectBumpScale()

virtual double OdGiMaterialTraitsTaker::indirectBumpScale ( ) const

inlinevirtual

Retrieves the indirect bump scale of this object.

Returns

indirect bump scale as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1428 of file GiMaterialTraitsData.h.

luminance()

virtual double OdGiMaterialTraitsTaker::luminance ( ) const

inlinevirtual

Retrieves the luminance of this object.

Returns

luminance amount as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1532 of file GiMaterialTraitsData.h.

luminanceMode()

virtual LuminanceMode OdGiMaterialTraitsTaker::luminanceMode ( ) const

inlinevirtual

Retrieves the luminance mode of this object.

Returns

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

Implements OdGiMaterialTraits.

Definition at line 1511 of file GiMaterialTraitsData.h.

mode()

virtual Mode OdGiMaterialTraitsTaker::mode ( ) const

inlinevirtual

Retrieves the material model.

Returns

material model represented by a value from the Mode enumeration.

Implements OdGiMaterialTraits.

Definition at line 1239 of file GiMaterialTraitsData.h.

normalMap()

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

inlinevirtual

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.

Implements OdGiMaterialTraits.

Definition at line 1556 of file GiMaterialTraitsData.h.

ODRX_USING_HEAP_OPERATORS()

OdGiMaterialTraitsTaker::ODRX_USING_HEAP_OPERATORS

(

OdGiMaterialTraits

)

opacity()

virtual void OdGiMaterialTraitsTaker::opacity ( double & opacityPercentage, OdGiMaterialMap & opacityMap ) const

inlinevirtual

Sets the opacity properties.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1160 of file GiMaterialTraitsData.h.

reflectanceScale()

virtual double OdGiMaterialTraitsTaker::reflectanceScale ( ) const

inlinevirtual

Retrieves the reflectance scale of this object.

Returns

reference scale as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1449 of file GiMaterialTraitsData.h.

reflection()

virtual void OdGiMaterialTraitsTaker::reflection ( OdGiMaterialMap & reflectionMap ) const

inlinevirtual

Sets the reflection map.

Parameters

reflectionMap

[in] Reflection map.

Implements OdGiMaterialTraits.

Definition at line 1150 of file GiMaterialTraitsData.h.

reflectionMethod()

ReflectionMethod OdGiMaterialTraitsTaker::reflectionMethod ( ) const

inlinevirtual

Returns the reflection method of this object.

Returns

reflection method as a value from the ReflectionMethod enumeration.

Implements OdGiMaterialTraits.

Definition at line 1855 of file GiMaterialTraitsData.h.

reflectivity()

virtual double OdGiMaterialTraitsTaker::reflectivity ( ) const

inlinevirtual

Retrieves the reflectivity value.

Returns

reflectivity as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1209 of file GiMaterialTraitsData.h.

refraction()

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

inlinevirtual

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.

Implements OdGiMaterialTraits.

Definition at line 1179 of file GiMaterialTraitsData.h.

roughness()

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

inlinevirtual

Returns the roughness component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1814 of file GiMaterialTraitsData.h.

selfIllumination()

virtual double OdGiMaterialTraitsTaker::selfIllumination ( ) const

inlinevirtual

Retrieves the self-illumination amount.

Returns

self-illumination as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1199 of file GiMaterialTraitsData.h.

setAmbient()

virtual void OdGiMaterialTraitsTaker::setAmbient ( const OdGiMaterialColor & ambientColor )

inlinevirtual

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.

Implements OdGiMaterialTraits.

Definition at line 1252 of file GiMaterialTraitsData.h.

setBump()

virtual void OdGiMaterialTraitsTaker::setBump ( const OdGiMaterialMap & bumpMap )

inlinevirtual

Sets the bump component of this object.

Parameters

bumpMap

[in] Bump map.

Implements OdGiMaterialTraits.

Definition at line 1315 of file GiMaterialTraitsData.h.

setChannelFlags()

virtual void OdGiMaterialTraitsTaker::setChannelFlags ( ChannelFlags flags )

inlinevirtual

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

Parameters

value

[in] Channels to be used.

Implements OdGiMaterialTraits.

Definition at line 1376 of file GiMaterialTraitsData.h.

setColorBleedScale()

virtual void OdGiMaterialTraitsTaker::setColorBleedScale ( double scale )

inlinevirtual

Sets the color bleed scale of this object.

Parameters

scale

[in] Color bleed scale.

Implements OdGiMaterialTraits.

Definition at line 1396 of file GiMaterialTraitsData.h.

setCutouts()

void OdGiMaterialTraitsTaker::setCutouts ( const OdGiMaterialMap & cutoutsMap )

inlinevirtual

Sets the cutouts component of this object.

Parameters

cutoutsMap

[in] Cutouts map.

Implements OdGiMaterialTraits.

Definition at line 1824 of file GiMaterialTraitsData.h.

setData()

void OdGiMaterialTraitsTaker::setData ( const OdGiMaterialTraitsData & data )

inline

Sets material traits data for this object.

Parameters

data	[in] Material traits data to set.

Definition at line 1878 of file GiMaterialTraitsData.h.

setDiffuse()

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

inlinevirtual

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.

Implements OdGiMaterialTraits.

Definition at line 1266 of file GiMaterialTraitsData.h.

setDiffuseColorMode()

virtual void OdGiMaterialTraitsTaker::setDiffuseColorMode ( DiffuseColorMode diffuseColorMode )

inlinevirtual

Sets diffuse, ambient, specual color and opacity behavior.

Parameters

diffuseColorMode

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

Implements OdGiMaterialTraits.

Definition at line 1731 of file GiMaterialTraitsData.h.

setEmission()

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

inlinevirtual

Sets the emission component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1609 of file GiMaterialTraitsData.h.

setFinalGather()

virtual void OdGiMaterialTraitsTaker::setFinalGather ( FinalGatherMode mode )

inlinevirtual

Sets the final gather mode of this object.

Parameters

mode	[in] Final gather mode.

Implements OdGiMaterialTraits.

Definition at line 1587 of file GiMaterialTraitsData.h.

setGlobalIllumination()

virtual void OdGiMaterialTraitsTaker::setGlobalIllumination ( GlobalIlluminationMode mode )

inlinevirtual

Sets the global illumination mode of this object.

Parameters

mode	[in] Global illumination mode.

Implements OdGiMaterialTraits.

Definition at line 1566 of file GiMaterialTraitsData.h.

setIlluminationModel()

virtual void OdGiMaterialTraitsTaker::setIlluminationModel ( IlluminationModel model )

inlinevirtual

Sets the illumination model of this object.

Parameters

model

[in] Illumination model.

Implements OdGiMaterialTraits.

Definition at line 1366 of file GiMaterialTraitsData.h.

setIndirectBumpScale()

virtual void OdGiMaterialTraitsTaker::setIndirectBumpScale ( double scale )

inlinevirtual

Sets the indirect bump scale of this object.

Parameters

scale

[in] Indirect bump scale.

Implements OdGiMaterialTraits.

Definition at line 1417 of file GiMaterialTraitsData.h.

setLuminance()

virtual void OdGiMaterialTraitsTaker::setLuminance ( double value )

inlinevirtual

Sets the luminance of this object.

Parameters

value

[in] Luminance value.

Implements OdGiMaterialTraits.

Definition at line 1521 of file GiMaterialTraitsData.h.

setLuminanceMode()

virtual void OdGiMaterialTraitsTaker::setLuminanceMode ( LuminanceMode mode )

inlinevirtual

Sets the luminance mode of this object.

Parameters

mode	[in] Luminance mode.

Implements OdGiMaterialTraits.

Definition at line 1500 of file GiMaterialTraitsData.h.

setMode()

virtual void OdGiMaterialTraitsTaker::setMode ( Mode value )

inlinevirtual

Sets the mode of this object.

Parameters

value

[in] Mode value.

Implements OdGiMaterialTraits.

Definition at line 1386 of file GiMaterialTraitsData.h.

setNormalMap()

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

inlinevirtual

Sets the normalMap component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1544 of file GiMaterialTraitsData.h.

setOpacity()

virtual void OdGiMaterialTraitsTaker::setOpacity ( double opacityPercentage, const OdGiMaterialMap & opacityMap )

inlinevirtual

Sets the opacity component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1305 of file GiMaterialTraitsData.h.

setReflectanceScale()

virtual void OdGiMaterialTraitsTaker::setReflectanceScale ( double scale )

inlinevirtual

Sets the reflectance scale of this object.

Parameters

scale

[in] Reflectance scale.

Implements OdGiMaterialTraits.

Definition at line 1438 of file GiMaterialTraitsData.h.

setReflection()

virtual void OdGiMaterialTraitsTaker::setReflection ( const OdGiMaterialMap & reflectionMap )

inlinevirtual

Sets the reflection component of this object.

Parameters

reflectionMap

[in] Reflection map.

Remarks

The reflection component creates a mirror finish on the entity.

Implements OdGiMaterialTraits.

Definition at line 1294 of file GiMaterialTraitsData.h.

setReflectionMethod()

void OdGiMaterialTraitsTaker::setReflectionMethod ( ReflectionMethod method )

inlinevirtual

Sets the reflection method of this object.

Parameters

method

[in] Reflection method.

Implements OdGiMaterialTraits.

Definition at line 1844 of file GiMaterialTraitsData.h.

setReflectivity()

virtual void OdGiMaterialTraitsTaker::setReflectivity ( double value )

inlinevirtual

Sets the reflectivity of this object.

Parameters

value

[in] Reflectivity value.

Implements OdGiMaterialTraits.

Definition at line 1356 of file GiMaterialTraitsData.h.

setRefraction()

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

inlinevirtual

Sets the refraction component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1326 of file GiMaterialTraitsData.h.

setRoughness()

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

inlinevirtual

Sets the roughness component of this object.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1803 of file GiMaterialTraitsData.h.

setSelfIllumination()

virtual void OdGiMaterialTraitsTaker::setSelfIllumination ( double value )

inlinevirtual

Sets the self illumination of this object.

Parameters

value

[in] Self illumination level.

Implements OdGiMaterialTraits.

Definition at line 1346 of file GiMaterialTraitsData.h.

setShadingAmbient()

virtual void OdGiMaterialTraitsTaker::setShadingAmbient ( const OdGiMaterialColor & ambientColor )

inlinevirtual

Sets the shading ambient color component of this object.

Parameters

ambientColor

[in] Shading ambient color.

Implements OdGiMaterialTraits.

Definition at line 1650 of file GiMaterialTraitsData.h.

setShadingDiffuse()

virtual void OdGiMaterialTraitsTaker::setShadingDiffuse ( const OdGiMaterialColor & diffuseColor )

inlinevirtual

Sets the shading diffuse color component of this object.

Parameters

diffuseColor

[in] Shading diffuse color.

Implements OdGiMaterialTraits.

Definition at line 1670 of file GiMaterialTraitsData.h.

setShadingOpacity()

virtual void OdGiMaterialTraitsTaker::setShadingOpacity ( double opacityPercentage )

inlinevirtual

Sets the shading opacity component of this object.

Parameters

opacityPercentage

[in] Shading opacity percentage.

Implements OdGiMaterialTraits.

Definition at line 1711 of file GiMaterialTraitsData.h.

setShadingSpecular()

virtual void OdGiMaterialTraitsTaker::setShadingSpecular ( const OdGiMaterialColor & specularColor )

inlinevirtual

Sets the shading specular color component of this object.

Parameters

specularColor

[in] Shading specular color.

Implements OdGiMaterialTraits.

Definition at line 1690 of file GiMaterialTraitsData.h.

setShadowsOpacityEffect()

virtual void OdGiMaterialTraitsTaker::setShadowsOpacityEffect ( double effectPercentage, double nonShadowLightsMergeEffect )

inlinevirtual

Sets coefficient of opacity influence onto received shadows.

Parameters

effectPercentage	[in] Coefficient in 0.0-1.0 range.
nonShadowLightsMergeEffect	[in] Coefficient in 0.0-1.0 range of light's influence which doesn't allow to cast shadows.

Implements OdGiMaterialTraits.

Definition at line 1752 of file GiMaterialTraitsData.h.

setSpecular()

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

inlinevirtual

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.

Implements OdGiMaterialTraits.

Definition at line 1281 of file GiMaterialTraitsData.h.

setSpecularHighlightingOverride()

void OdGiMaterialTraitsTaker::setSpecularHighlightingOverride ( double overrideVal )

inlinevirtual

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 a visual style.

Implements OdGiMaterialTraits.

Definition at line 1779 of file GiMaterialTraitsData.h.

setTint()

virtual void OdGiMaterialTraitsTaker::setTint ( const OdGiMaterialColor & tintColor )

inlinevirtual

Sets the tint component of this object.

Parameters

tintColor

[in] Tint color.

Implements OdGiMaterialTraits.

Definition at line 1630 of file GiMaterialTraitsData.h.

setTranslucence()

virtual void OdGiMaterialTraitsTaker::setTranslucence ( double value )

inlinevirtual

Sets the translucence of this object.

Parameters

value

[in] Translucence value.

Implements OdGiMaterialTraits.

Definition at line 1336 of file GiMaterialTraitsData.h.

setTransmittanceScale()

virtual void OdGiMaterialTraitsTaker::setTransmittanceScale ( double scale )

inlinevirtual

Sets the transmittance scale of this object.

Parameters

scale

[in] Transmittance scale.

Implements OdGiMaterialTraits.

Definition at line 1459 of file GiMaterialTraitsData.h.

setTwoSided()

virtual void OdGiMaterialTraitsTaker::setTwoSided ( bool flag )

inlinevirtual

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

Parameters

flag	[in] Two-sided mode flag.

Implements OdGiMaterialTraits.

Definition at line 1480 of file GiMaterialTraitsData.h.

shadingAmbient()

virtual void OdGiMaterialTraitsTaker::shadingAmbient ( OdGiMaterialColor & ambientColor ) const

inlinevirtual

Retrieves the shading ambient color component of this object.

Parameters

ambientColor

[out] Receives the shading ambient color.

Implements OdGiMaterialTraits.

Definition at line 1660 of file GiMaterialTraitsData.h.

shadingDiffuse()

virtual void OdGiMaterialTraitsTaker::shadingDiffuse ( OdGiMaterialColor & diffuseColor ) const

inlinevirtual

Retrieves the shading diffuse color component of this object.

Parameters

diffuseColor

[out] Receives the shading diffuse color.

Implements OdGiMaterialTraits.

Definition at line 1680 of file GiMaterialTraitsData.h.

shadingOpacity()

virtual void OdGiMaterialTraitsTaker::shadingOpacity ( double & opacityPercentage ) const

inlinevirtual

Retrieves the shading opacity component of this object.

Parameters

opacityPercentage

[out] Receives the shading opacity percentage.

Implements OdGiMaterialTraits.

Definition at line 1721 of file GiMaterialTraitsData.h.

shadingSpecular()

virtual void OdGiMaterialTraitsTaker::shadingSpecular ( OdGiMaterialColor & specularColor ) const

inlinevirtual

Retrieves the shading specular color component of this object.

Parameters

specularColor

[out] Receives the shading specular color.

Implements OdGiMaterialTraits.

Definition at line 1700 of file GiMaterialTraitsData.h.

shadowsOpacityEffect()

virtual double OdGiMaterialTraitsTaker::shadowsOpacityEffect ( double & nonShadowLightsMergeEffect ) const

inlinevirtual

Returns coefficient of opacity influence onto received shadows. Coefficient is set to 1.0 by default, which means that shadows opacity is fully dependent on material opacity.

Parameters

nonShadowLightsMergeEffect

[out] Coefficient in 0.0-1.0 range of light's influence which doesn't allow to cast shadows.

Returns

Coefficient of opacity influence onto received shadows.

Implements OdGiMaterialTraits.

Definition at line 1764 of file GiMaterialTraitsData.h.

specular()

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

inlinevirtual

Sets the specular (shine) color.

Parameters

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

Implements OdGiMaterialTraits.

Definition at line 1141 of file GiMaterialTraitsData.h.

specularHighlightingOverride()

double OdGiMaterialTraitsTaker::specularHighlightingOverride ( ) const

inlinevirtual

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.

Implements OdGiMaterialTraits.

Definition at line 1792 of file GiMaterialTraitsData.h.

tint()

virtual void OdGiMaterialTraitsTaker::tint ( OdGiMaterialColor & tintColor ) const

inlinevirtual

Retrieves the tint component of this object.

Parameters

tintColor

[out] Receives the tint color.

Implements OdGiMaterialTraits.

Definition at line 1640 of file GiMaterialTraitsData.h.

translucence()

virtual double OdGiMaterialTraitsTaker::translucence ( ) const

inlinevirtual

Retrieves the translucence value.

Returns

translucence as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1189 of file GiMaterialTraitsData.h.

transmittanceScale()

virtual double OdGiMaterialTraitsTaker::transmittanceScale ( ) const

inlinevirtual

Retrieves the transmittance scale of this object.

Returns

transmittance scale as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1470 of file GiMaterialTraitsData.h.

twoSided()

virtual bool OdGiMaterialTraitsTaker::twoSided ( ) const

inlinevirtual

Checks whether two-sided mode (individual materials for front and back faces) is enabled.

Returns

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

Implements OdGiMaterialTraits.

Definition at line 1490 of file GiMaterialTraitsData.h.

Member Data Documentation

m_data

OdGiMaterialTraitsData OdGiMaterialTraitsTaker::m_data

protected

Definition at line 1112 of file GiMaterialTraitsData.h.

---

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

• GiMaterialTraitsData.h