CFx SDK Documentation  2020SP3
Public Member Functions | Protected Attributes | List of all members
OdGiMaterialTraitsTaker Class Reference

#include <GiMaterialTraitsData.h>

Inheritance diagram for OdGiMaterialTraitsTaker:
OdGiMaterialTraits OdGiDrawableTraits OdRxObject OdGiTraitsCache< OdGiMaterialTraitsData, OdGiMaterialTraitsTaker, OdGiMaterialTraits::kByBlock|OdGiMaterialTraits::kByLayer >

Public Member Functions

 ODRX_USING_HEAP_OPERATORS (OdGiMaterialTraits)
 
void addRef ()
 
void release ()
 
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
 
void getData (OdGiMaterialTraitsData &data) const
 
const OdGiMaterialTraitsDatagetData () const
 
void setData (const OdGiMaterialTraitsData &data)
 
- 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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, kUseAll, kUseAllInternal = (kUseAll | kUseEmission | kUseTint)
}
 
enum  Mode { kRealistic = 0, kAdvanced }
 
enum  { kByBlock = (OdGiDrawable::kLastFlag << 1), kByLayer = (OdGiDrawable::kLastFlag << 2) }
 
enum  LuminanceMode { kSelfIllumination = 0, kLuminance, kEmissionColor }
 
enum  NormalMapMethod { kTangentSpace }
 
enum  GlobalIlluminationMode { kGlobalIlluminationNone, kGlobalIlluminationCast, kGlobalIlluminationReceive, kGlobalIlluminationCastAndReceive }
 
enum  FinalGatherMode { kFinalGatherNone, kFinalGatherCast, kFinalGatherReceive, kFinalGatherCastAndReceive }
 
enum  DiffuseColorMode { kDiffuseRealisticColor = 0, kDiffuseShadingColor, kDiffuseStyleDependent }
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

See also
TD_Gi

<group OdGi_Classes>

Definition at line 544 of file GiMaterialTraitsData.h.

Member Function Documentation

◆ addRef()

void OdGiMaterialTraitsTaker::addRef ( )
inlinevirtual

Declares the method incrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Implements OdRxObject.

Definition at line 552 of file GiMaterialTraitsData.h.

◆ ambient()

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

Returns the ambient color component of this MaterialTraits object.

Parameters
ambientColor[out] Receives the ambient color.
Remarks
The ambient color component is most apparent when there is no direct illumination on the entity.

Implements OdGiMaterialTraits.

Definition at line 555 of file GiMaterialTraitsData.h.

◆ bump()

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

Returns the bump component of this MaterialTraits object.

Parameters
bumpMap[out] Receives the bump map.

Implements OdGiMaterialTraits.

Definition at line 575 of file GiMaterialTraitsData.h.

◆ channelFlags()

virtual ChannelFlags OdGiMaterialTraitsTaker::channelFlags ( ) const
inlinevirtual

Returns the material channels in use by this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 599 of file GiMaterialTraitsData.h.

◆ colorBleedScale()

virtual double OdGiMaterialTraitsTaker::colorBleedScale ( ) const
inlinevirtual

Returns the color bleed scale of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 665 of file GiMaterialTraitsData.h.

◆ diffuse()

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

Returns the diffuse component of this MaterialTraits object.

Parameters
diffuseColor[out] Receives the diffuse color.
diffuseMap[out] Receives the diffuse map.
Remarks
The diffuse component is most apparent when there is direct illumination on the entity.

Implements OdGiMaterialTraits.

Definition at line 559 of file GiMaterialTraitsData.h.

◆ diffuseColorMode()

virtual DiffuseColorMode OdGiMaterialTraitsTaker::diffuseColorMode ( ) const
inlinevirtual

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

Implements OdGiMaterialTraits.

Definition at line 809 of file GiMaterialTraitsData.h.

◆ emission()

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

Returns the emission component of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 755 of file GiMaterialTraitsData.h.

◆ finalGather()

virtual FinalGatherMode OdGiMaterialTraitsTaker::finalGather ( ) const
inlinevirtual

Returns the final gather mode of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 746 of file GiMaterialTraitsData.h.

◆ getData() [1/2]

const OdGiMaterialTraitsData& OdGiMaterialTraitsTaker::getData ( ) const
inline

Definition at line 815 of file GiMaterialTraitsData.h.

◆ getData() [2/2]

void OdGiMaterialTraitsTaker::getData ( OdGiMaterialTraitsData data) const
inline

Definition at line 814 of file GiMaterialTraitsData.h.

◆ globalIllumination()

virtual GlobalIlluminationMode OdGiMaterialTraitsTaker::globalIllumination ( ) const
inlinevirtual

Returns the global illumination mode of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 737 of file GiMaterialTraitsData.h.

◆ illuminationModel()

virtual IlluminationModel OdGiMaterialTraitsTaker::illuminationModel ( ) const
inlinevirtual

Returns the illumination model of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 595 of file GiMaterialTraitsData.h.

◆ indirectBumpScale()

virtual double OdGiMaterialTraitsTaker::indirectBumpScale ( ) const
inlinevirtual

Returns the indirect bump scale of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 674 of file GiMaterialTraitsData.h.

◆ luminance()

virtual double OdGiMaterialTraitsTaker::luminance ( ) const
inlinevirtual

Returns the luminance of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 719 of file GiMaterialTraitsData.h.

◆ luminanceMode()

virtual LuminanceMode OdGiMaterialTraitsTaker::luminanceMode ( ) const
inlinevirtual

Returns the luminance mode of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 710 of file GiMaterialTraitsData.h.

◆ mode()

virtual Mode OdGiMaterialTraitsTaker::mode ( ) const
inlinevirtual

Returns the mode of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 603 of file GiMaterialTraitsData.h.

◆ normalMap()

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

Returns the normalMap component of this MaterialTraits 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 728 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

Returns the opacity component of this MaterialTraits object.

Parameters
opacityPercentage[out] Receives the opacity percentage.
opacityMap[out] Receives the opacity map.

Implements OdGiMaterialTraits.

Definition at line 571 of file GiMaterialTraitsData.h.

◆ reflectanceScale()

virtual double OdGiMaterialTraitsTaker::reflectanceScale ( ) const
inlinevirtual

Returns the reflectance scale of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 683 of file GiMaterialTraitsData.h.

◆ reflection()

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

Returns the reflection component of this MaterialTraits object.

Parameters
reflectionMap[out] Receives the reflection map.
Remarks
The reflection component creates a mirror finish on the entity.

Implements OdGiMaterialTraits.

Definition at line 567 of file GiMaterialTraitsData.h.

◆ reflectivity()

virtual double OdGiMaterialTraitsTaker::reflectivity ( ) const
inlinevirtual

Returns the reflectivity of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 591 of file GiMaterialTraitsData.h.

◆ refraction()

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

Returns the refraction component of this MaterialTraits object.

Parameters
refractionIndex[out] Receives the refraction index.
refractionMap[out] Receives the refraction map.

Implements OdGiMaterialTraits.

Definition at line 579 of file GiMaterialTraitsData.h.

◆ release()

void OdGiMaterialTraitsTaker::release ( )
inlinevirtual

Declares the method decrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Implements OdRxObject.

Definition at line 553 of file GiMaterialTraitsData.h.

◆ selfIllumination()

virtual double OdGiMaterialTraitsTaker::selfIllumination ( ) const
inlinevirtual

Returns the self illumination of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 587 of file GiMaterialTraitsData.h.

◆ setAmbient()

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

Sets the ambient color component of this MaterialTraits object.

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 608 of file GiMaterialTraitsData.h.

◆ setBump()

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

Sets the bump component of this MaterialTraits object.

Parameters
bumpMap[in] Bump map.

Implements OdGiMaterialTraits.

Definition at line 628 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 652 of file GiMaterialTraitsData.h.

◆ setColorBleedScale()

virtual void OdGiMaterialTraitsTaker::setColorBleedScale ( double  scale)
inlinevirtual

Sets the color bleed scale of this MaterialTraits object.

Parameters
scale[in] Color bleed scale.

Implements OdGiMaterialTraits.

Definition at line 661 of file GiMaterialTraitsData.h.

◆ setData()

void OdGiMaterialTraitsTaker::setData ( const OdGiMaterialTraitsData data)
inline

Definition at line 817 of file GiMaterialTraitsData.h.

◆ setDiffuse()

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

Sets the diffuse component of this MaterialTraits 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 612 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 805 of file GiMaterialTraitsData.h.

◆ setEmission()

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

Sets the emission component of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 751 of file GiMaterialTraitsData.h.

◆ setFinalGather()

virtual void OdGiMaterialTraitsTaker::setFinalGather ( FinalGatherMode  mode)
inlinevirtual

Sets the final gather mode of this MaterialTraits object.

Parameters
mode[in] Final gather mode.

Implements OdGiMaterialTraits.

Definition at line 742 of file GiMaterialTraitsData.h.

◆ setGlobalIllumination()

virtual void OdGiMaterialTraitsTaker::setGlobalIllumination ( GlobalIlluminationMode  mode)
inlinevirtual

Sets the global illumination mode of this MaterialTraits object.

Parameters
mode[in] Global illumination mode.

Implements OdGiMaterialTraits.

Definition at line 733 of file GiMaterialTraitsData.h.

◆ setIlluminationModel()

virtual void OdGiMaterialTraitsTaker::setIlluminationModel ( IlluminationModel  model)
inlinevirtual

Sets the illumination model of this MaterialTraits object.

Parameters
model[in] Illumination model.

Implements OdGiMaterialTraits.

Definition at line 648 of file GiMaterialTraitsData.h.

◆ setIndirectBumpScale()

virtual void OdGiMaterialTraitsTaker::setIndirectBumpScale ( double  scale)
inlinevirtual

Sets the indirect bump scale of this MaterialTraits object.

Parameters
scale[in] Indirect bump scale.

Implements OdGiMaterialTraits.

Definition at line 670 of file GiMaterialTraitsData.h.

◆ setLuminance()

virtual void OdGiMaterialTraitsTaker::setLuminance ( double  value)
inlinevirtual

Sets the luminance of this MaterialTraits object.

Parameters
value[in] Luminance value.

Implements OdGiMaterialTraits.

Definition at line 715 of file GiMaterialTraitsData.h.

◆ setLuminanceMode()

virtual void OdGiMaterialTraitsTaker::setLuminanceMode ( LuminanceMode  mode)
inlinevirtual

Sets the luminance mode of this MaterialTraits object.

Parameters
mode[in] Luminance mode.

Implements OdGiMaterialTraits.

Definition at line 706 of file GiMaterialTraitsData.h.

◆ setMode()

virtual void OdGiMaterialTraitsTaker::setMode ( Mode  value)
inlinevirtual

Sets the mode of this MaterialTraits object.

Parameters
value[in] Mode value.

Implements OdGiMaterialTraits.

Definition at line 656 of file GiMaterialTraitsData.h.

◆ setNormalMap()

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

Sets the normalMap component of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 724 of file GiMaterialTraitsData.h.

◆ setOpacity()

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

Sets the opacity component of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 624 of file GiMaterialTraitsData.h.

◆ setReflectanceScale()

virtual void OdGiMaterialTraitsTaker::setReflectanceScale ( double  scale)
inlinevirtual

Sets the reflectance scale of this MaterialTraits object.

Parameters
scale[in] Reflectance scale.

Implements OdGiMaterialTraits.

Definition at line 679 of file GiMaterialTraitsData.h.

◆ setReflection()

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

Sets the reflection component of this MaterialTraits object.

Parameters
reflectionMap[in] Reflection map.
Remarks
The reflection component creates a mirror finish on the entity.

Implements OdGiMaterialTraits.

Definition at line 620 of file GiMaterialTraitsData.h.

◆ setReflectivity()

virtual void OdGiMaterialTraitsTaker::setReflectivity ( double  value)
inlinevirtual

Sets the reflectivity of this MaterialTraits object.

Parameters
value[in] Reflectivity value.

Implements OdGiMaterialTraits.

Definition at line 644 of file GiMaterialTraitsData.h.

◆ setRefraction()

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

Sets the refraction component of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 632 of file GiMaterialTraitsData.h.

◆ setSelfIllumination()

virtual void OdGiMaterialTraitsTaker::setSelfIllumination ( double  value)
inlinevirtual

Sets the self illumination of this MaterialTraits object.

Parameters
value[in] Self illumination level.

Implements OdGiMaterialTraits.

Definition at line 640 of file GiMaterialTraitsData.h.

◆ setShadingAmbient()

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

Sets the shading ambient color component of this MaterialTraits object.

Parameters
ambientColor[in] Shading ambient color.

Implements OdGiMaterialTraits.

Definition at line 769 of file GiMaterialTraitsData.h.

◆ setShadingDiffuse()

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

Sets the shading diffuse color component of this MaterialTraits object.

Parameters
diffuseColor[in] Shading diffuse color.

Implements OdGiMaterialTraits.

Definition at line 778 of file GiMaterialTraitsData.h.

◆ setShadingOpacity()

virtual void OdGiMaterialTraitsTaker::setShadingOpacity ( double  opacityPercentage)
inlinevirtual

Sets the shading opacity component of this MaterialTraits object.

Parameters
opacityPercentage[in] Shading opacity percentage.

Implements OdGiMaterialTraits.

Definition at line 796 of file GiMaterialTraitsData.h.

◆ setShadingSpecular()

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

Sets the shading specular color component of this MaterialTraits object.

Parameters
specularColor[in] Shading specular color.

Implements OdGiMaterialTraits.

Definition at line 787 of file GiMaterialTraitsData.h.

◆ setSpecular()

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

Sets the specular component of this MaterialTraits 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 616 of file GiMaterialTraitsData.h.

◆ setTint()

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

Sets the tint component of this MaterialTraits object.

Parameters
tintColor[in] Tint color.

Implements OdGiMaterialTraits.

Definition at line 760 of file GiMaterialTraitsData.h.

◆ setTranslucence()

virtual void OdGiMaterialTraitsTaker::setTranslucence ( double  value)
inlinevirtual

Sets the translucence of this MaterialTraits object.

Parameters
value[in] Translucence value.

Implements OdGiMaterialTraits.

Definition at line 636 of file GiMaterialTraitsData.h.

◆ setTransmittanceScale()

virtual void OdGiMaterialTraitsTaker::setTransmittanceScale ( double  scale)
inlinevirtual

Sets the transmittance scale of this MaterialTraits object.

Parameters
scale[in] Transmittance scale.

Implements OdGiMaterialTraits.

Definition at line 688 of file GiMaterialTraitsData.h.

◆ setTwoSided()

virtual void OdGiMaterialTraitsTaker::setTwoSided ( bool  flag)
inlinevirtual

Sets the two-sided mode of this MaterialTraits object.

Parameters
flag[in] Two-sided mode flag.

Implements OdGiMaterialTraits.

Definition at line 697 of file GiMaterialTraitsData.h.

◆ shadingAmbient()

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

Returns the shading ambient color component of this MaterialTraits object.

Parameters
ambientColor[out] Receives the shading ambient color.

Implements OdGiMaterialTraits.

Definition at line 773 of file GiMaterialTraitsData.h.

◆ shadingDiffuse()

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

Returns the shading diffuse color component of this MaterialTraits object.

Parameters
diffuseColor[out] Receives the shading diffuse color.

Implements OdGiMaterialTraits.

Definition at line 782 of file GiMaterialTraitsData.h.

◆ shadingOpacity()

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

Returns the shading opacity component of this MaterialTraits object.

Parameters
opacityPercentage[out] Receives the shading opacity percentage.

Implements OdGiMaterialTraits.

Definition at line 800 of file GiMaterialTraitsData.h.

◆ shadingSpecular()

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

Returns the shading specular color component of this MaterialTraits object.

Parameters
specularColor[out] Receives the shading specular color.

Implements OdGiMaterialTraits.

Definition at line 791 of file GiMaterialTraitsData.h.

◆ specular()

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

Returns the specular component of this MaterialTraits object.

Parameters
specularColor[out] Receives the specular color.
specularMap[out] Receives the specular map.
glossFactor[out] Receives the gloss factor.
Remarks
The specular component depends on the viewer's eye position and represents the light source reflection highlights on the entity surface.

Implements OdGiMaterialTraits.

Definition at line 563 of file GiMaterialTraitsData.h.

◆ tint()

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

Returns the tint component of this MaterialTraits object.

Parameters
tintColor[out] Receives the tint color.

Implements OdGiMaterialTraits.

Definition at line 764 of file GiMaterialTraitsData.h.

◆ translucence()

virtual double OdGiMaterialTraitsTaker::translucence ( ) const
inlinevirtual

Returns the translucence of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 583 of file GiMaterialTraitsData.h.

◆ transmittanceScale()

virtual double OdGiMaterialTraitsTaker::transmittanceScale ( ) const
inlinevirtual

Returns the transmittance scale of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 692 of file GiMaterialTraitsData.h.

◆ twoSided()

virtual bool OdGiMaterialTraitsTaker::twoSided ( ) const
inlinevirtual

Returns the two-sided mode of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 701 of file GiMaterialTraitsData.h.

Member Data Documentation

◆ m_data

OdGiMaterialTraitsData OdGiMaterialTraitsTaker::m_data
protected

Definition at line 547 of file GiMaterialTraitsData.h.


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