CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiMaterialTraits_Stub Class Reference

#include <GiMaterialTraitsData.h>

Inheritance diagram for OdGiMaterialTraits_Stub:
OdGiMaterialTraits OdGiDrawableTraits OdRxObject

Public Member Functions

 ODRX_USING_HEAP_OPERATORS (OdGiMaterialTraits)
 
 OdGiMaterialTraits_Stub ()
 
void addRef ()
 
void release ()
 
void ambient (OdGiMaterialColor &) const
 
void diffuse (OdGiMaterialColor &, OdGiMaterialMap &) const
 
void specular (OdGiMaterialColor &, OdGiMaterialMap &, double &) const
 
void reflection (OdGiMaterialMap &) const
 
void opacity (double &, OdGiMaterialMap &) const
 
void bump (OdGiMaterialMap &) const
 
void refraction (double &, OdGiMaterialMap &) const
 
double translucence () const
 
double selfIllumination () const
 
double reflectivity () const
 
IlluminationModel illuminationModel () const
 
ChannelFlags channelFlags () const
 
Mode mode () const
 
void setAmbient (const OdGiMaterialColor &)
 
void setDiffuse (const OdGiMaterialColor &, const OdGiMaterialMap &)
 
void setSpecular (const OdGiMaterialColor &, const OdGiMaterialMap &, double)
 
void setReflection (const OdGiMaterialMap &)
 
void setOpacity (double, const OdGiMaterialMap &)
 
void setBump (const OdGiMaterialMap &)
 
void setRefraction (double, const OdGiMaterialMap &)
 
void setTranslucence (double)
 
void setSelfIllumination (double)
 
void setReflectivity (double)
 
void setIlluminationModel (IlluminationModel)
 
void setChannelFlags (ChannelFlags)
 
void setMode (Mode)
 
void setColorBleedScale (double)
 
double colorBleedScale () const
 
void setIndirectBumpScale (double)
 
double indirectBumpScale () const
 
void setReflectanceScale (double)
 
double reflectanceScale () const
 
void setTransmittanceScale (double)
 
double transmittanceScale () const
 
void setTwoSided (bool)
 
bool twoSided () const
 
void setLuminanceMode (LuminanceMode)
 
LuminanceMode luminanceMode () const
 
void setLuminance (double)
 
double luminance () const
 
void setNormalMap (const OdGiMaterialMap &, NormalMapMethod, double)
 
void normalMap (OdGiMaterialMap &, NormalMapMethod &, double &) const
 
void setGlobalIllumination (GlobalIlluminationMode)
 
GlobalIlluminationMode globalIllumination () const
 
void setFinalGather (FinalGatherMode)
 
FinalGatherMode finalGather () const
 
void setEmission (const OdGiMaterialColor &, const OdGiMaterialMap &)
 
void emission (OdGiMaterialColor &, OdGiMaterialMap &) const
 
void setTint (const OdGiMaterialColor &)
 
void tint (OdGiMaterialColor &) const
 
void setShadingAmbient (const OdGiMaterialColor &)
 
void shadingAmbient (OdGiMaterialColor &) const
 
void setShadingDiffuse (const OdGiMaterialColor &)
 
void shadingDiffuse (OdGiMaterialColor &) const
 
void setShadingSpecular (const OdGiMaterialColor &)
 
void shadingSpecular (OdGiMaterialColor &) const
 
void setShadingOpacity (double)
 
void shadingOpacity (double &) const
 
void setDiffuseColorMode (DiffuseColorMode)
 
DiffuseColorMode diffuseColorMode () const
 
void setShadowsOpacityEffect (double, double)
 
double shadowsOpacityEffect (double &) const
 
void setSpecularHighlightingOverride (double)
 
double specularHighlightingOverride () const
 
- Public Member Functions inherited from OdGiMaterialTraits
 ODRX_DECLARE_MEMBERS (OdGiMaterialTraits)
 
virtual void ambient (OdGiMaterialColor &ambientColor) const =0
 
virtual void diffuse (OdGiMaterialColor &diffuseColor, OdGiMaterialMap &diffuseMap) const =0
 
virtual void specular (OdGiMaterialColor &specularColor, OdGiMaterialMap &specularMap, double &glossFactor) const =0
 
virtual void reflection (OdGiMaterialMap &reflectionMap) const =0
 
virtual void opacity (double &opacityPercentage, OdGiMaterialMap &opacityMap) const =0
 
virtual void bump (OdGiMaterialMap &bumpMap) const =0
 
virtual void refraction (double &refractionIndex, OdGiMaterialMap &refractionMap) const =0
 
virtual double translucence () const =0
 
virtual double selfIllumination () const =0
 
virtual double reflectivity () const =0
 
virtual IlluminationModel illuminationModel () const =0
 
virtual ChannelFlags channelFlags () const =0
 
virtual Mode mode () const =0
 
virtual void setAmbient (const OdGiMaterialColor &ambientColor)=0
 
virtual void setDiffuse (const OdGiMaterialColor &diffuseColor, const OdGiMaterialMap &diffuseMap)=0
 
virtual void setSpecular (const OdGiMaterialColor &specularColor, const OdGiMaterialMap &specularMap, double glossFactor)=0
 
virtual void setReflection (const OdGiMaterialMap &reflectionMap)=0
 
virtual void setOpacity (double opacityPercentage, const OdGiMaterialMap &opacityMap)=0
 
virtual void setBump (const OdGiMaterialMap &bumpMap)=0
 
virtual void setRefraction (double refractionIndex, const OdGiMaterialMap &refractionMap)=0
 
virtual void setTranslucence (double value)=0
 
virtual void setSelfIllumination (double value)=0
 
virtual void setReflectivity (double value)=0
 
virtual void setIlluminationModel (IlluminationModel model)=0
 
virtual void setChannelFlags (ChannelFlags flags)=0
 
virtual void setMode (Mode value)=0
 
virtual void setColorBleedScale (double scale)=0
 
virtual double colorBleedScale () const =0
 
virtual void setIndirectBumpScale (double scale)=0
 
virtual double indirectBumpScale () const =0
 
virtual void setReflectanceScale (double scale)=0
 
virtual double reflectanceScale () const =0
 
virtual void setTransmittanceScale (double scale)=0
 
virtual double transmittanceScale () const =0
 
virtual void setTwoSided (bool flag)=0
 
virtual bool twoSided () const =0
 
virtual void setLuminanceMode (LuminanceMode mode)=0
 
virtual LuminanceMode luminanceMode () const =0
 
virtual void setLuminance (double value)=0
 
virtual double luminance () const =0
 
virtual void setNormalMap (const OdGiMaterialMap &normalMap, NormalMapMethod method, double strength)=0
 
virtual void normalMap (OdGiMaterialMap &normalMap, NormalMapMethod &method, double &strength) const =0
 
virtual void setGlobalIllumination (GlobalIlluminationMode mode)=0
 
virtual GlobalIlluminationMode globalIllumination () const =0
 
virtual void setFinalGather (FinalGatherMode mode)=0
 
virtual FinalGatherMode finalGather () const =0
 
virtual void setEmission (const OdGiMaterialColor &emissionColor, const OdGiMaterialMap &emissionMap)=0
 
virtual void emission (OdGiMaterialColor &emissionColor, OdGiMaterialMap &emissionMap) const =0
 
virtual void setTint (const OdGiMaterialColor &tintColor)=0
 
virtual void tint (OdGiMaterialColor &tintColor) const =0
 
virtual void setShadingAmbient (const OdGiMaterialColor &ambientColor)=0
 
virtual void shadingAmbient (OdGiMaterialColor &ambientColor) const =0
 
virtual void setShadingDiffuse (const OdGiMaterialColor &diffuseColor)=0
 
virtual void shadingDiffuse (OdGiMaterialColor &diffuseColor) const =0
 
virtual void setShadingSpecular (const OdGiMaterialColor &specularColor)=0
 
virtual void shadingSpecular (OdGiMaterialColor &specularColor) const =0
 
virtual void setShadingOpacity (double opacityPercentage)=0
 
virtual void shadingOpacity (double &opacityPercentage) const =0
 
virtual void setDiffuseColorMode (DiffuseColorMode diffuseColorMode)=0
 
virtual DiffuseColorMode diffuseColorMode () const =0
 
virtual void setShadowsOpacityEffect (double effectPercentage, double nonShadowLightsMergeEffect=1.0)=0
 
virtual double shadowsOpacityEffect (double &nonShadowLightsMergeEffect) const =0
 
virtual void setSpecularHighlightingOverride (double overrideVal)=0
 
virtual double specularHighlightingOverride () const =0
 
- 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 void addRef ()=0
 
virtual void release ()=0
 
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
 

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
<link tv_working_with_attributes_materials, Work with Materials>

<group OdGi_Classes>

Definition at line 1680 of file GiMaterialTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiMaterialTraits_Stub()

OdGiMaterialTraits_Stub::OdGiMaterialTraits_Stub ( )
inline

Definition at line 1685 of file GiMaterialTraitsData.h.

Member Function Documentation

◆ addRef()

void OdGiMaterialTraits_Stub::addRef ( )
inlinevirtual

Adds one reference to this object. Does nothing in current implementation.

Implements OdRxObject.

Definition at line 1690 of file GiMaterialTraitsData.h.

◆ ambient()

void OdGiMaterialTraits_Stub::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 1697 of file GiMaterialTraitsData.h.

◆ bump()

void OdGiMaterialTraits_Stub::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 1702 of file GiMaterialTraitsData.h.

◆ channelFlags()

ChannelFlags OdGiMaterialTraits_Stub::channelFlags ( ) const
inlinevirtual

Returns the material channels in use by this MaterialTraits object.

Returns
a set of flags that represent which channels are used.

Implements OdGiMaterialTraits.

Definition at line 1708 of file GiMaterialTraitsData.h.

◆ colorBleedScale()

double OdGiMaterialTraits_Stub::colorBleedScale ( ) const
inlinevirtual

Returns the color bleed scale of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 1726 of file GiMaterialTraitsData.h.

◆ diffuse()

void OdGiMaterialTraits_Stub::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 1698 of file GiMaterialTraitsData.h.

◆ diffuseColorMode()

DiffuseColorMode OdGiMaterialTraits_Stub::diffuseColorMode ( ) const
inlinevirtual

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

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

Implements OdGiMaterialTraits.

Definition at line 1774 of file GiMaterialTraitsData.h.

◆ emission()

void OdGiMaterialTraits_Stub::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 1756 of file GiMaterialTraitsData.h.

◆ finalGather()

FinalGatherMode OdGiMaterialTraits_Stub::finalGather ( ) const
inlinevirtual

Returns the final gather mode of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 1753 of file GiMaterialTraitsData.h.

◆ globalIllumination()

GlobalIlluminationMode OdGiMaterialTraits_Stub::globalIllumination ( ) const
inlinevirtual

Returns the global illumination mode of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 1750 of file GiMaterialTraitsData.h.

◆ illuminationModel()

IlluminationModel OdGiMaterialTraits_Stub::illuminationModel ( ) const
inlinevirtual

Returns the illumination model of this MaterialTraits object.

Returns
one of two shaders that define illumination model: kBlinnShader or kMetalShader.

Implements OdGiMaterialTraits.

Definition at line 1707 of file GiMaterialTraitsData.h.

◆ indirectBumpScale()

double OdGiMaterialTraits_Stub::indirectBumpScale ( ) const
inlinevirtual

Returns the indirect bump scale of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 1729 of file GiMaterialTraitsData.h.

◆ luminance()

double OdGiMaterialTraits_Stub::luminance ( ) const
inlinevirtual

Returns the luminance of this MaterialTraits object.

Returns
luminance amount as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1744 of file GiMaterialTraitsData.h.

◆ luminanceMode()

LuminanceMode OdGiMaterialTraits_Stub::luminanceMode ( ) const
inlinevirtual

Returns the luminance mode of this MaterialTraits object.

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

Implements OdGiMaterialTraits.

Definition at line 1741 of file GiMaterialTraitsData.h.

◆ mode()

Mode OdGiMaterialTraits_Stub::mode ( ) const
inlinevirtual

Returns the mode of this MaterialTraits object.

Returns
one of two render modes: kRealistic or kAdvanced.

Implements OdGiMaterialTraits.

Definition at line 1709 of file GiMaterialTraitsData.h.

◆ normalMap()

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

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

◆ ODRX_USING_HEAP_OPERATORS()

OdGiMaterialTraits_Stub::ODRX_USING_HEAP_OPERATORS ( OdGiMaterialTraits  )

◆ opacity()

void OdGiMaterialTraits_Stub::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 1701 of file GiMaterialTraitsData.h.

◆ reflectanceScale()

double OdGiMaterialTraits_Stub::reflectanceScale ( ) const
inlinevirtual

Returns the reflectance scale of this MaterialTraits object.

Returns
reference scale as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1732 of file GiMaterialTraitsData.h.

◆ reflection()

void OdGiMaterialTraits_Stub::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 1700 of file GiMaterialTraitsData.h.

◆ reflectivity()

double OdGiMaterialTraits_Stub::reflectivity ( ) const
inlinevirtual

Returns the reflectivity of this MaterialTraits object.

Returns
reflectivity amount as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1706 of file GiMaterialTraitsData.h.

◆ refraction()

void OdGiMaterialTraits_Stub::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 1703 of file GiMaterialTraitsData.h.

◆ release()

void OdGiMaterialTraits_Stub::release ( )
inlinevirtual

Removes one reference to this object. Does nothing in current implementation.

Implements OdRxObject.

Definition at line 1695 of file GiMaterialTraitsData.h.

◆ selfIllumination()

double OdGiMaterialTraits_Stub::selfIllumination ( ) const
inlinevirtual

Returns the self illumination of this MaterialTraits object.

Returns
translucence amount as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1705 of file GiMaterialTraitsData.h.

◆ setAmbient()

void OdGiMaterialTraits_Stub::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 1711 of file GiMaterialTraitsData.h.

◆ setBump()

void OdGiMaterialTraits_Stub::setBump ( const OdGiMaterialMap bumpMap)
inlinevirtual

Sets the bump component of this MaterialTraits object.

Parameters
bumpMap[in] Bump map.

Implements OdGiMaterialTraits.

Definition at line 1716 of file GiMaterialTraitsData.h.

◆ setChannelFlags()

void OdGiMaterialTraits_Stub::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 1722 of file GiMaterialTraitsData.h.

◆ setColorBleedScale()

void OdGiMaterialTraits_Stub::setColorBleedScale ( double  scale)
inlinevirtual

Sets the color bleed scale of this MaterialTraits object.

Parameters
scale[in] Color bleed scale.

Implements OdGiMaterialTraits.

Definition at line 1725 of file GiMaterialTraitsData.h.

◆ setDiffuse()

void OdGiMaterialTraits_Stub::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 1712 of file GiMaterialTraitsData.h.

◆ setDiffuseColorMode()

void OdGiMaterialTraits_Stub::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 1773 of file GiMaterialTraitsData.h.

◆ setEmission()

void OdGiMaterialTraits_Stub::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 1755 of file GiMaterialTraitsData.h.

◆ setFinalGather()

void OdGiMaterialTraits_Stub::setFinalGather ( FinalGatherMode  mode)
inlinevirtual

Sets the final gather mode of this MaterialTraits object.

Parameters
mode[in] Final gather mode.

Implements OdGiMaterialTraits.

Definition at line 1752 of file GiMaterialTraitsData.h.

◆ setGlobalIllumination()

void OdGiMaterialTraits_Stub::setGlobalIllumination ( GlobalIlluminationMode  mode)
inlinevirtual

Sets the global illumination mode of this MaterialTraits object.

Parameters
mode[in] Global illumination mode.

Implements OdGiMaterialTraits.

Definition at line 1749 of file GiMaterialTraitsData.h.

◆ setIlluminationModel()

void OdGiMaterialTraits_Stub::setIlluminationModel ( IlluminationModel  model)
inlinevirtual

Sets the illumination model of this MaterialTraits object.

Parameters
model[in] Illumination model.

Implements OdGiMaterialTraits.

Definition at line 1721 of file GiMaterialTraitsData.h.

◆ setIndirectBumpScale()

void OdGiMaterialTraits_Stub::setIndirectBumpScale ( double  scale)
inlinevirtual

Sets the indirect bump scale of this MaterialTraits object.

Parameters
scale[in] Indirect bump scale.

Implements OdGiMaterialTraits.

Definition at line 1728 of file GiMaterialTraitsData.h.

◆ setLuminance()

void OdGiMaterialTraits_Stub::setLuminance ( double  value)
inlinevirtual

Sets the luminance of this MaterialTraits object.

Parameters
value[in] Luminance value.

Implements OdGiMaterialTraits.

Definition at line 1743 of file GiMaterialTraitsData.h.

◆ setLuminanceMode()

void OdGiMaterialTraits_Stub::setLuminanceMode ( LuminanceMode  mode)
inlinevirtual

Sets the luminance mode of this MaterialTraits object.

Parameters
mode[in] Luminance mode.

Implements OdGiMaterialTraits.

Definition at line 1740 of file GiMaterialTraitsData.h.

◆ setMode()

void OdGiMaterialTraits_Stub::setMode ( Mode  value)
inlinevirtual

Sets the mode of this MaterialTraits object.

Parameters
value[in] Mode value.

Implements OdGiMaterialTraits.

Definition at line 1723 of file GiMaterialTraitsData.h.

◆ setNormalMap()

void OdGiMaterialTraits_Stub::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 1746 of file GiMaterialTraitsData.h.

◆ setOpacity()

void OdGiMaterialTraits_Stub::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 1715 of file GiMaterialTraitsData.h.

◆ setReflectanceScale()

void OdGiMaterialTraits_Stub::setReflectanceScale ( double  scale)
inlinevirtual

Sets the reflectance scale of this MaterialTraits object.

Parameters
scale[in] Reflectance scale.

Implements OdGiMaterialTraits.

Definition at line 1731 of file GiMaterialTraitsData.h.

◆ setReflection()

void OdGiMaterialTraits_Stub::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 1714 of file GiMaterialTraitsData.h.

◆ setReflectivity()

void OdGiMaterialTraits_Stub::setReflectivity ( double  value)
inlinevirtual

Sets the reflectivity of this MaterialTraits object.

Parameters
value[in] Reflectivity value.

Implements OdGiMaterialTraits.

Definition at line 1720 of file GiMaterialTraitsData.h.

◆ setRefraction()

void OdGiMaterialTraits_Stub::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 1717 of file GiMaterialTraitsData.h.

◆ setSelfIllumination()

void OdGiMaterialTraits_Stub::setSelfIllumination ( double  value)
inlinevirtual

Sets the self illumination of this MaterialTraits object.

Parameters
value[in] Self illumination level.

Implements OdGiMaterialTraits.

Definition at line 1719 of file GiMaterialTraitsData.h.

◆ setShadingAmbient()

void OdGiMaterialTraits_Stub::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 1761 of file GiMaterialTraitsData.h.

◆ setShadingDiffuse()

void OdGiMaterialTraits_Stub::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 1764 of file GiMaterialTraitsData.h.

◆ setShadingOpacity()

void OdGiMaterialTraits_Stub::setShadingOpacity ( double  opacityPercentage)
inlinevirtual

Sets the shading opacity component of this MaterialTraits object.

Parameters
opacityPercentage[in] Shading opacity percentage.

Implements OdGiMaterialTraits.

Definition at line 1770 of file GiMaterialTraitsData.h.

◆ setShadingSpecular()

void OdGiMaterialTraits_Stub::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 1767 of file GiMaterialTraitsData.h.

◆ setShadowsOpacityEffect()

void OdGiMaterialTraits_Stub::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] Setup amount in 0.0-1.0 range of lights influence which is doesn't cast shadows.

Implements OdGiMaterialTraits.

Definition at line 1776 of file GiMaterialTraitsData.h.

◆ setSpecular()

void OdGiMaterialTraits_Stub::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 1713 of file GiMaterialTraitsData.h.

◆ setSpecularHighlightingOverride()

void OdGiMaterialTraits_Stub::setSpecularHighlightingOverride ( double  overrideVal)
inlinevirtual

Setup specular highlighting behavior override.

Parameters
overrideVal[in] Specular highlighting override value.
Remarks
Positive override value means absolute specular highlighting factor. Zero override value disables specular highlighting override. Negative override value provides maximal speculat highlighting factor and means that highlighting factor must be got from Visual Style.

Implements OdGiMaterialTraits.

Definition at line 1779 of file GiMaterialTraitsData.h.

◆ setTint()

void OdGiMaterialTraits_Stub::setTint ( const OdGiMaterialColor tintColor)
inlinevirtual

Sets the tint component of this MaterialTraits object.

Parameters
tintColor[in] Tint color.

Implements OdGiMaterialTraits.

Definition at line 1758 of file GiMaterialTraitsData.h.

◆ setTranslucence()

void OdGiMaterialTraits_Stub::setTranslucence ( double  value)
inlinevirtual

Sets the translucence of this MaterialTraits object.

Parameters
value[in] Translucence value.

Implements OdGiMaterialTraits.

Definition at line 1718 of file GiMaterialTraitsData.h.

◆ setTransmittanceScale()

void OdGiMaterialTraits_Stub::setTransmittanceScale ( double  scale)
inlinevirtual

Sets the transmittance scale of this MaterialTraits object.

Parameters
scale[in] Transmittance scale.

Implements OdGiMaterialTraits.

Definition at line 1734 of file GiMaterialTraitsData.h.

◆ setTwoSided()

void OdGiMaterialTraits_Stub::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 1737 of file GiMaterialTraitsData.h.

◆ shadingAmbient()

void OdGiMaterialTraits_Stub::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 1762 of file GiMaterialTraitsData.h.

◆ shadingDiffuse()

void OdGiMaterialTraits_Stub::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 1765 of file GiMaterialTraitsData.h.

◆ shadingOpacity()

void OdGiMaterialTraits_Stub::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 1771 of file GiMaterialTraitsData.h.

◆ shadingSpecular()

void OdGiMaterialTraits_Stub::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 1768 of file GiMaterialTraitsData.h.

◆ shadowsOpacityEffect()

double OdGiMaterialTraits_Stub::shadowsOpacityEffect ( double &  nonShadowLightsMergeEffect) const
inlinevirtual

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

Parameters
nonShadowLightsMergeEffect[out] Amount in 0.0-1.0 range of lights influence which is doesn't cast shadows.

Implements OdGiMaterialTraits.

Definition at line 1777 of file GiMaterialTraitsData.h.

◆ specular()

void OdGiMaterialTraits_Stub::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 1699 of file GiMaterialTraitsData.h.

◆ specularHighlightingOverride()

double OdGiMaterialTraits_Stub::specularHighlightingOverride ( ) const
inlinevirtual

Returns specular highlighting behavior override.

Implements OdGiMaterialTraits.

Definition at line 1780 of file GiMaterialTraitsData.h.

◆ tint()

void OdGiMaterialTraits_Stub::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 1759 of file GiMaterialTraitsData.h.

◆ translucence()

double OdGiMaterialTraits_Stub::translucence ( ) const
inlinevirtual

Returns the translucence of this MaterialTraits object.

Returns
translucence amount as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1704 of file GiMaterialTraitsData.h.

◆ transmittanceScale()

double OdGiMaterialTraits_Stub::transmittanceScale ( ) const
inlinevirtual

Returns the transmittance scale of this MaterialTraits object.

Returns
transmittance scale as a value of the double type.

Implements OdGiMaterialTraits.

Definition at line 1735 of file GiMaterialTraitsData.h.

◆ twoSided()

bool OdGiMaterialTraits_Stub::twoSided ( ) const
inlinevirtual

Returns the two-sided mode of this MaterialTraits object.

Implements OdGiMaterialTraits.

Definition at line 1738 of file GiMaterialTraitsData.h.


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