CFx SDK Documentation
2020SP3
|
#include <GiMaterial.h>
Public Types | |
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 } |
Public Member Functions | |
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 |
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 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 | |
Static Public Member Functions inherited from OdRxObject | |
static OdRxObjectPtr | cast (const OdRxObject *pointer) |
static OdRxClass * | desc () |
This class defines the interface to material traits for the vectorization process. Corresponding C++ library: TD_Gi <group OdGi_Classes>
Definition at line 45 of file GiMaterial.h.
anonymous enum |
Enumerator | |
---|---|
kByBlock | |
kByLayer |
Definition at line 92 of file GiMaterial.h.
Specifies material channels.
Enumerator | |
---|---|
kNone | |
kUseDiffuse | |
kUseSpecular | |
kUseReflection | |
kUseOpacity | |
kUseBump | |
kUseRefraction | |
kUseNormalMap | |
kUseEmission | |
kUseTint | |
kUseAll | |
kUseAllInternal |
Definition at line 63 of file GiMaterial.h.
Specifies the diffuse color mode.
Enumerator | |
---|---|
kDiffuseRealisticColor | |
kDiffuseShadingColor | |
kDiffuseStyleDependent |
Definition at line 144 of file GiMaterial.h.
Specifies the final gathering mode.
Enumerator | |
---|---|
kFinalGatherNone | |
kFinalGatherCast | |
kFinalGatherReceive | |
kFinalGatherCastAndReceive |
Definition at line 132 of file GiMaterial.h.
Specifies the global illumination.
Enumerator | |
---|---|
kGlobalIlluminationNone | |
kGlobalIlluminationCast | |
kGlobalIlluminationReceive | |
kGlobalIlluminationCastAndReceive |
Definition at line 121 of file GiMaterial.h.
This enumeration specifies an illumination model used in the rendering process when working with materials.
Enumerator | |
---|---|
kBlinnShader | |
kMetalShader |
Definition at line 54 of file GiMaterial.h.
Specifies the luminance modes.
Enumerator | |
---|---|
kSelfIllumination | |
kLuminance | |
kEmissionColor |
Definition at line 103 of file GiMaterial.h.
Specifies the material model.
Enumerator | |
---|---|
kRealistic | |
kAdvanced |
Definition at line 85 of file GiMaterial.h.
|
pure virtual |
Returns the ambient color component of this MaterialTraits object.
ambientColor | [out] Receives the ambient color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the bump component of this MaterialTraits object.
bumpMap | [out] Receives the bump map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the material channels in use by this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the color bleed scale of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the diffuse component of this MaterialTraits object.
diffuseColor | [out] Receives the diffuse color. |
diffuseMap | [out] Receives the diffuse map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns current diffuse, ambient, specular color and opacity behavior.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the emission component of this MaterialTraits object.
emissionColor | [out] Receives the emission color. |
emissionMap | [out] Receives the emission map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the final gather mode of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the global illumination mode of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the illumination model of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the indirect bump scale of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the luminance of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the luminance mode of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the mode of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the normalMap component of this MaterialTraits object.
normalMap | [out] Receives the normal map. |
method | [out] Receives the normal map method. |
strength | [out] Receives the normal map strength factor. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
OdGiMaterialTraits::ODRX_DECLARE_MEMBERS | ( | OdGiMaterialTraits | ) |
|
pure virtual |
Returns the opacity component of this MaterialTraits object.
opacityPercentage | [out] Receives the opacity percentage. |
opacityMap | [out] Receives the opacity map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the reflectance scale of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the reflection component of this MaterialTraits object.
reflectionMap | [out] Receives the reflection map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the reflectivity of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the refraction component of this MaterialTraits object.
refractionIndex | [out] Receives the refraction index. |
refractionMap | [out] Receives the refraction map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the self illumination of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the ambient color component of this MaterialTraits object.
ambientColor | [in] Ambient color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the bump component of this MaterialTraits object.
bumpMap | [in] Bump map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the material channels to be used by this MaterialTraits object.
value | [in] Channels to be used. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the color bleed scale of this MaterialTraits object.
scale | [in] Color bleed scale. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the diffuse component of this MaterialTraits object.
diffuseColor | [in] Diffuse color. |
diffuseMap | [in] Diffuse map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets diffuse, ambient, specual color and opacity behavior.
diffuseColorMode | [in] New setting for diffuse color and opacity mode. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the emission component of this MaterialTraits object.
emissionColor | [in] Emission color. |
emissionMap | [in] Emission map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the final gather mode of this MaterialTraits object.
mode | [in] Final gather mode. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the global illumination mode of this MaterialTraits object.
mode | [in] Global illumination mode. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the illumination model of this MaterialTraits object.
model | [in] Illumination model. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the indirect bump scale of this MaterialTraits object.
scale | [in] Indirect bump scale. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the luminance of this MaterialTraits object.
value | [in] Luminance value. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the luminance mode of this MaterialTraits object.
mode | [in] Luminance mode. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
Sets the mode of this MaterialTraits object.
value | [in] Mode value. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the normalMap component of this MaterialTraits object.
normalMap | [in] Normal map. |
method | [in] Normal map method. |
strength | [in] Strength factor. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the opacity component of this MaterialTraits object.
opacityPercentage | [in] Opacity percentage. |
opacityMap | [in] Opacity map. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the reflectance scale of this MaterialTraits object.
scale | [in] Reflectance scale. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the reflection component of this MaterialTraits object.
reflectionMap | [in] Reflection map. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the reflectivity of this MaterialTraits object.
value | [in] Reflectivity value. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the refraction component of this MaterialTraits object.
refractionIndex | [in] Refraction index. |
refractionMap | [in] Refraction map. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the self illumination of this MaterialTraits object.
value | [in] Self illumination level. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the shading ambient color component of this MaterialTraits object.
ambientColor | [in] Shading ambient color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the shading diffuse color component of this MaterialTraits object.
diffuseColor | [in] Shading diffuse color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the shading opacity component of this MaterialTraits object.
opacityPercentage | [in] Shading opacity percentage. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the shading specular color component of this MaterialTraits object.
specularColor | [in] Shading specular color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the specular component of this MaterialTraits object.
specularColor | [in] Specular color. |
specularMap | [in] Specular map. |
glossFactor | [in] Gloss factor. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the tint component of this MaterialTraits object.
tintColor | [in] Tint color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Sets the translucence of this MaterialTraits object.
value | [in] Translucence value. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the transmittance scale of this MaterialTraits object.
scale | [in] Transmittance scale. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Sets the two-sided mode of this MaterialTraits object.
flag | [in] Two-sided mode flag. |
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the shading ambient color component of this MaterialTraits object.
ambientColor | [out] Receives the shading ambient color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the shading diffuse color component of this MaterialTraits object.
diffuseColor | [out] Receives the shading diffuse color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the shading opacity component of this MaterialTraits object.
opacityPercentage | [out] Receives the shading opacity percentage. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the shading specular color component of this MaterialTraits object.
specularColor | [out] Receives the shading specular color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the specular component of this MaterialTraits object.
specularColor | [out] Receives the specular color. |
specularMap | [out] Receives the specular map. |
glossFactor | [out] Receives the gloss factor. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the tint component of this MaterialTraits object.
tintColor | [out] Receives the tint color. |
Implemented in OdGiMaterialTraitsTaker, and OdGiMaterialTraits_Stub.
|
pure virtual |
Returns the translucence of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the transmittance scale of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.
|
pure virtual |
Returns the two-sided mode of this MaterialTraits object.
Implemented in OdGiMaterialTraits_Stub, and OdGiMaterialTraitsTaker.