#include <DbRenderSettings.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from OdDbRenderSettings | |
| static OdSmartPtr< OdDbRenderSettings > | castByClassName (OdRxObject *obj) |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Member Functions inherited from OdDbObject | |
| OdDbObject () | |
| virtual OdResult | subGetClassID (void *pClsid) const |
| virtual OdDbObjectPtr | subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| virtual OdDbObjectPtr | subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subSetAttributes (OdGiDrawableTraits *traits) const =0 |
| virtual bool | subWorldDraw (OdGiWorldDraw *wd) const =0 |
| virtual void | subViewportDraw (OdGiViewportDraw *vd) const =0 |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class is a container class for the properties relevent to mental ray renderers.
- Remarks
- Database-resident OdDbMentalRayRenderSettings objects are stored in the NamedObjectsDictionary under ACAD_RENDER_SETTINGS.
In addition, the active RenderSettings are stored in the NamedObjectsDictionary under ACAD_RENDER_ACTIVE_SETTINGS.
<group OdDb_Classes>
Definition at line 251 of file DbRenderSettings.h.
Member Enumeration Documentation
◆ ShadowSamplingMultiplier
Shadow sampling multiplier for area lights.
| Enumerator | |
|---|---|
| kSamplingMultiplierZero | |
| kSamplingMultiplierOneEighth | |
| kSamplingMultiplierOneFourth | |
| kSamplingMultiplierOneHalf | |
| kSamplingMultiplierOne | |
| kSamplingMultiplierTwo | |
Definition at line 257 of file DbRenderSettings.h.
Constructor & Destructor Documentation
◆ OdDbMentalRayRenderSettings()
| OdDbMentalRayRenderSettings::OdDbMentalRayRenderSettings | ( | ) |
◆ ~OdDbMentalRayRenderSettings()
|
virtual |
Member Function Documentation
◆ diagnosticBSPMode()
| OdGiMrDiagnosticBSPMode OdDbMentalRayRenderSettings::diagnosticBSPMode | ( | ) | const |
Returns the Diagnostic BSP Mode for this MentalRayRenderSettings object.
- Parameters
-
diagnosticBSPMode [in] Diagnostic BSP Mode.
- Remarks
- The default value for DiagnosticBSPMode is krDepth.
◆ diagnosticGridMode()
| void OdDbMentalRayRenderSettings::diagnosticGridMode | ( | OdGiMrDiagnosticGridMode & | diagnosticGridMode, |
| float & | gridSpace | ||
| ) | const |
Returns the Diagnostic Grid for this MentalRayRenderSettings object.
- Parameters
-
diagnosticGridMode [out] Receives the coordinate system for the grid. gridSpace [out] Receives the distance between grid lines.
◆ diagnosticMode()
| OdGiMrDiagnosticMode OdDbMentalRayRenderSettings::diagnosticMode | ( | ) | const |
Returns the diagnostic image rendering mode for this MentalRayRenderSettings object.
- Parameters
-
diagnosticMode [in] Diagnostic mode.
◆ diagnosticPhotonMode()
| OdGiMrDiagnosticPhotonMode OdDbMentalRayRenderSettings::diagnosticPhotonMode | ( | ) | const |
Returns the Diagnostic Photon Mode for this MentalRayRenderSettings object.
◆ diagnosticSamplesMode()
| bool OdDbMentalRayRenderSettings::diagnosticSamplesMode | ( | ) | const |
Returns the Diagnostic Samples Mode for this MentalRayRenderSettings object.
- Remarks
- The default value for DiagnosticSamplesMode == false.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbRenderSettings.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbRenderSettings.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbRenderSettings.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbRenderSettings.
◆ energyMultiplier()
| float OdDbMentalRayRenderSettings::energyMultiplier | ( | ) | const |
Returns the magnitude of indirect illumination for this MentalRayRenderSettings object.
- Remarks
- EnergyMultiplier serves as a volume control for the photon emmision of every light.
◆ exportMIEnabled()
| bool OdDbMentalRayRenderSettings::exportMIEnabled | ( | ) | const |
Returns true if and only if an MI file is created after rendering for this MentalRayRenderSettings object.
◆ exportMIFileName()
| OdString OdDbMentalRayRenderSettings::exportMIFileName | ( | ) | const |
Returns the full filename of the exported MI file for this MentalRayRenderSettings object.
◆ exportMIMode()
| OdGiMrExportMIMode OdDbMentalRayRenderSettings::exportMIMode | ( | ) | const |
Returns the MI mode for this MentalRaySettings object.
◆ fgRayCount()
| int OdDbMentalRayRenderSettings::fgRayCount | ( | ) | const |
Returns the final gathering ray count for this MentalRayRenderSettings object.
- Remarks
- In order to compute indirect illumination of a scent, FGRayCount rays are shot into the scene for each final gathering point.
◆ fgSampleRadius()
| void OdDbMentalRayRenderSettings::fgSampleRadius | ( | double & | minRadius, |
| double & | maxRadius | ||
| ) | const |
Returns the Final Gathering Sample Radii for this MentalRayRenderSettings object.
- Parameters
-
minRadius [out] Receives the minimum radius. maxRadius [out] Receives the maximum radius.
◆ fgSampleRadiusState()
| void OdDbMentalRayRenderSettings::fgSampleRadiusState | ( | bool & | useMin, |
| bool & | useMax, | ||
| bool & | inPixels | ||
| ) | const |
Returns the the Final Gathering Sample Radius State for this MentalRayRenderSettings object.
- Parameters
-
useMin [out] Receives true if the user-supplied minimum radius is used, false for the default, useMax [out] Receives true if the user-supplied maximum radius is used, false for the default, inPixels [out] True if user-supplied radii are in pixels, false for drawing units.
◆ finalGatheringEnabled()
| bool OdDbMentalRayRenderSettings::finalGatheringEnabled | ( | ) | const |
Returns true if and only if final gathering is enabled for this MentalRayRenderSettings object.
◆ finalGatheringMode()
| OdGiMrFinalGatheringMode OdDbMentalRayRenderSettings::finalGatheringMode | ( | ) | const |
Returns the final gathering mode for this MentalRaySettings object.
◆ giPhotonsPerLight()
| int OdDbMentalRayRenderSettings::giPhotonsPerLight | ( | ) | const |
Returns the average the number of photons shot per light for this MentalRayRenderSettings object.
◆ giSampleCount()
| int OdDbMentalRayRenderSettings::giSampleCount | ( | ) | const |
Returns the number of photons used for computing global illumination near a sample point for this MentalRayRenderSettings object.
◆ giSampleRadius()
| double OdDbMentalRayRenderSettings::giSampleRadius | ( | ) | const |
Returns the radius for computing the photon count for global illumination for this MentalRayRenderSettings object.
◆ giSampleRadiusEnabled()
| bool OdDbMentalRayRenderSettings::giSampleRadiusEnabled | ( | ) | const |
Returns true if and only if the GISampleRadius is used for computing global illumination for this MentalRayRenderSettings object.
◆ globalIlluminationEnabled()
| bool OdDbMentalRayRenderSettings::globalIlluminationEnabled | ( | ) | const |
Returns true if and only if global illumination using photon mapping is enabled for this MentalRayRenderSettings object.
◆ lightLuminanceScale()
| double OdDbMentalRayRenderSettings::lightLuminanceScale | ( | ) | const |
Returns the light luminance scale factor for this MentalRaySettings object.
◆ memoryLimit()
| int OdDbMentalRayRenderSettings::memoryLimit | ( | ) | const |
Returns the maximum memory allocated for rendering for this MentalRaySettings object.
◆ ODDB_DECLARE_MEMBERS()
| OdDbMentalRayRenderSettings::ODDB_DECLARE_MEMBERS | ( | OdDbMentalRayRenderSettings | ) |
◆ operator==()
|
virtual |
◆ photonTraceDepth()
| void OdDbMentalRayRenderSettings::photonTraceDepth | ( | int & | reflection, |
| int & | refraction, | ||
| int & | sum | ||
| ) | const |
Returns the maximum photon trace depths for this MentalRayRenderSettings object.
- Parameters
-
reflection [out] Receives the maximum number of photon reflections. refraction [out] Receives the maximum number of photon refractions. sum [out] Receives the maximum number of photon reflections and refractions.
◆ rayTraceDepth()
| void OdDbMentalRayRenderSettings::rayTraceDepth | ( | int & | reflection, |
| int & | refraction, | ||
| int & | sum | ||
| ) | const |
Returns the maximum ray trace depths for this MentalRayRenderSettings object.
- Parameters
-
reflection [out] Receives the maximum number of ray reflections. refraction [out] Receives the maximum number of ray refractions. sum [out] Receives the maximum number of ray reflections and refractions.
◆ rayTracingEnabled()
| bool OdDbMentalRayRenderSettings::rayTracingEnabled | ( | ) | const |
Returns true if and only if ray tracing is enabled for this MentalRayRenderSettings object.
◆ sampling()
| void OdDbMentalRayRenderSettings::sampling | ( | int & | min, |
| int & | max | ||
| ) | const |
Returns the minimum and maximum sampling rates when rendering a pixel for this MentalRayRenderSettings object.
- Parameters
-
min [out] Receives the minimum sampling rate. [-3 .. 5] max [out] Receives the maximum sampling rate. [-3 .. 5]
- Remarks
- Negative values enable subsampling. -3 specifies one sample per 64 pixels 5 specfies one sample per 1028 pixels The default value of min == -1 The default value of max == 0
◆ samplingContrastColor()
| void OdDbMentalRayRenderSettings::samplingContrastColor | ( | float & | red, |
| float & | green, | ||
| float & | blue, | ||
| float & | alpha | ||
| ) | const |
Returns the SamplingContrastColor for this MentalRayRenderSettings object.
- Parameters
-
red [out] Receives the red color channel threshold. green [out] Receives the green channel threshold. blue [out] Receives the blue channel threshold. alpha [out] Receives the alpha channel threshold.
◆ SamplingFilter()
| void OdDbMentalRayRenderSettings::SamplingFilter | ( | OdGiMrFilter & | filter, |
| double & | width, | ||
| double & | height | ||
| ) | const |
Returns the sampling filter parameters for this MentalRayRenderSettings object.
- Parameters
-
filter [out] Receives the filter method. width [out] Receives the width of the filter area in pixels. height [out] Receives the height of the filter area in pixels.
◆ setDiagnosticBSPMode()
| void OdDbMentalRayRenderSettings::setDiagnosticBSPMode | ( | OdGiMrDiagnosticBSPMode | diagnosticBSPMode | ) |
Sets the Diagnostic BSP Mode for this MentalRayRenderSettings object.
- Parameters
-
diagnosticBSPMode [in] Diagnostic BSP Mode.
- Remarks
- The default value for DiagnosticBSPMode is krDepth.
◆ setDiagnosticGridMode()
| OdResult OdDbMentalRayRenderSettings::setDiagnosticGridMode | ( | OdGiMrDiagnosticGridMode | diagnosticGridMode, |
| float | gridSpace | ||
| ) |
Sets the Diagnostic Grid for this MentalRayRenderSettings object.
- Parameters
-
diagnosticGridMode [in] Coordinate system for the grid. gridSpace [in] Distance between grid lines.
- Remarks
- The default mode is krObject, the default grid space is 10.0.
◆ setDiagnosticMode()
| void OdDbMentalRayRenderSettings::setDiagnosticMode | ( | OdGiMrDiagnosticMode | diagnosticMode | ) |
Sets the diagnostic image rendering mode for this MentalRayRenderSettings object.
- Parameters
-
diagnosticMode [in] Diagnostic mode.
◆ setDiagnosticPhotonMode()
| void OdDbMentalRayRenderSettings::setDiagnosticPhotonMode | ( | OdGiMrDiagnosticPhotonMode | diagnosticPhotonMode | ) |
Sets the Diagnostic Photon Mode for this MentalRayRenderSettings object.
- Parameters
-
diagnosticPhotonMode [in] Diagnostic Photon Mode.
- Remarks
- The default value for DiagnosticPhotonMode == krDensity.
◆ setDiagnosticSamplesMode()
| void OdDbMentalRayRenderSettings::setDiagnosticSamplesMode | ( | bool | diagnosticSamplesMode | ) |
Controls the Diagnostic Samples Mode for this MentalRayRenderSettings object.
- Parameters
-
diagnosticSamplesMode [in] Diagnostic Samples Mode
- Remarks
- The default value for DiagnosticSamplesMode == false.
◆ setEnergyMultiplier()
| OdResult OdDbMentalRayRenderSettings::setEnergyMultiplier | ( | float | energyMultiplier | ) |
Sets the magnitude of indirect illumination for this MentalRayRenderSettings object.
- Parameters
-
energyMultiplier [in] Energy multiplier.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The default value for EnergyMultiplier is 1.0.
EnergyMultiplier serves as a volume control for the photon emmision of every light.
◆ setExportMIEnabled()
| void OdDbMentalRayRenderSettings::setExportMIEnabled | ( | bool | exportMIEnabled | ) |
Controls the creation of an MI file after rendering for this MentalRayRenderSettings object.
- Parameters
-
exportMIEnabled [in] Export MI Enabled.
- Remarks
- The default value for ExportMIEnabled == false.
- See also
- setExportMIFileName
◆ setExportMIFileName()
Sets the full filename of the exported MI file for this MentalRayRenderSettings object.
- Parameters
-
filename [in] Filename.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- If the ExportMIFileName is blank, no MI file is associated with this MentalRayRenderSettings object.
The default value for ExportMIFileName is blank.
◆ setExportMIMode()
| OdResult OdDbMentalRayRenderSettings::setExportMIMode | ( | OdGiMrExportMIMode | eExportMIMode | ) |
Sets the MI mode for this MentalRaySettings object.
- Parameters
-
eExportMIMode [in] MI mode.
- Remarks
- The default value for MI mode is krExportMIOff.
◆ setFGRadiusState()
| void OdDbMentalRayRenderSettings::setFGRadiusState | ( | bool | useMin, |
| bool | useMax, | ||
| bool | inPixels | ||
| ) |
Controls the Final Gathering Sample Radius State for this MentalRayRenderSettings object.
- Parameters
-
useMin [in] True to use user-supplied minimum radius, false for default radius. useMax [in] True to use user-supplied maximum radius, false for default radius. inPixels [in] True if user-supplied radii are in pixels, false for drawing units.
- Remarks
- The default values for all parameters == false.
◆ setFGRayCount()
| OdResult OdDbMentalRayRenderSettings::setFGRayCount | ( | int | fgRayCount | ) |
Sets the final gathering ray count for this MentalRayRenderSettings object.
- Parameters
-
fgRayCount [in] Final gathering ray count.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- In order to compute indirect illumination of a scent, FGRayCount rays are shot into the scene for each final gathering point.
The default value for FGRayCount = 1000.
◆ setFGSampleRadius()
| OdResult OdDbMentalRayRenderSettings::setFGSampleRadius | ( | double | minRadius, |
| double | maxRadius | ||
| ) |
Sets the Final Gathering Sample Radii for this MentalRayRenderSettings object.
- Parameters
-
minRadius [in] Minimum radius. maxRadius [in] Maximum radius.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- Default values are are 0.1 for drawing units, and 0.5 for pixels.
minRadius <= maxRadius
◆ setFinalGatheringEnabled()
| void OdDbMentalRayRenderSettings::setFinalGatheringEnabled | ( | bool | finalGatheringEnabled | ) |
Controls the application of final gathering for this MentalRayRenderSettings object.
- Parameters
-
finalGatheringEnabled [in] Controls final gathering.
- Remarks
- Final gathering permits indirect lighting effects such as color-bleeding.
◆ setFinalGatheringMode()
| OdResult OdDbMentalRayRenderSettings::setFinalGatheringMode | ( | OdGiMrFinalGatheringMode | mode | ) |
Sets the final gathering mode for this MentalRaySettings object.
- Parameters
-
mode [in] Final gathering mode.
- Remarks
- The default value for final gathering mode is krFinalGatherAuto.
◆ setGIPhotonsPerLight()
| OdResult OdDbMentalRayRenderSettings::setGIPhotonsPerLight | ( | int | numPhotons | ) |
Sets the average the number of photons shot per light for this MentalRayRenderSettings object.
- Parameters
-
numPhotons [in] Number of photons.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The default value for GIPhotonsPerLight == 10,000.
◆ setGISampleCount()
| OdResult OdDbMentalRayRenderSettings::setGISampleCount | ( | int | numPhotons | ) |
Sets the number of photons used for computing global illumination near a sample point for this MentalRayRenderSettings object.
- Parameters
-
numPhotons [in] Number of photons.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The default value for GISampleCount == 500
◆ setGISampleRadius()
| OdResult OdDbMentalRayRenderSettings::setGISampleRadius | ( | double | radius | ) |
Sets the radius for computing the photon count for global illumination for this MentalRayRenderSettings object.
- Parameters
-
radius [in] Sample radius.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The default value for GISampleRadius == 1.0.
◆ setGISampleRadiusEnabled()
| void OdDbMentalRayRenderSettings::setGISampleRadiusEnabled | ( | bool | giSampleRadiusEnabled | ) |
Controls the use of the GISampleRadius for computing global illumination for this MentalRayRenderSettings object.
- Parameters
-
giSampleRadiusEnabled [in] Controls GISampleRadiusEnabled.
- Remarks
- If GISampleRadiusEnabled == false, a default, the model space extents are used to computer a default radius.
The default value of GISampleRadiusEnabled == false.
◆ setGlobalIlluminationEnabled()
| void OdDbMentalRayRenderSettings::setGlobalIlluminationEnabled | ( | bool | globalIlluminationEnabled | ) |
Controls global illumination using photon mapping for this MentalRayRenderSettings object.
- Parameters
-
globalIlluminationEnabled [in] Controls GlobalIllumination.
- Remarks
- Global illumination permits indirect lighting effects such as color-bleeding.
The default value of GlobalIllumination is false.
◆ setLightLuminanceScale()
| OdResult OdDbMentalRayRenderSettings::setLightLuminanceScale | ( | double | fLuminance | ) |
Sets the light luminance scale factor for this MentalRaySettings object.
- Parameters
-
fLuminance [in] Luminance scale factor.
- Remarks
- The default value for light luminance scale factor is 1500.0.
◆ setMemoryLimit()
| OdResult OdDbMentalRayRenderSettings::setMemoryLimit | ( | int | memoryLimit | ) |
Sets the maximum memory allocated for rendering for this MentalRaySettings object.
- Parameters
-
memoryLimit [in] Memory limit (MB) [>= 128]
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The renderer will decrease performance so as to stay below the memory limit.
The default value for MemoryLimit is 1048.
◆ setPhotonTraceDepth()
| OdResult OdDbMentalRayRenderSettings::setPhotonTraceDepth | ( | int | reflection, |
| int | refraction, | ||
| int | sum | ||
| ) |
Sets the maximum photon trace depths for this MentalRayRenderSettings object.
- Parameters
-
reflection [in] Maximum number of photon reflections. refraction [in] Maximum number of photon refractions. sum [in] Maximum number of photon reflections and refractions.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The defaults are as follows:
Default reflection 5 refraction 5 sum 5
◆ setRayTraceDepth()
| OdResult OdDbMentalRayRenderSettings::setRayTraceDepth | ( | int | reflection, |
| int | refraction, | ||
| int | sum | ||
| ) |
Sets the maximum ray trace depths for this MentalRayRenderSettings object.
- Parameters
-
reflection [in] Maximum number of ray reflections. refraction [in] Maximum number of ray refractions. sum [in] Maximum number of ray reflections and refractions.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The defaults are as follows:
Default reflection 2 refraction 2 sum 4
◆ setRayTracingEnabled()
| void OdDbMentalRayRenderSettings::setRayTracingEnabled | ( | bool | rayTracingEnabled | ) |
Controls ray tracing for this MentalRayRenderSettings object.
- Parameters
-
rayTracingEnabled [in] Controls ray tracing.
- Remarks
- The default value of RayTracing == true;
◆ setSampling()
| OdResult OdDbMentalRayRenderSettings::setSampling | ( | int | min, |
| int | max | ||
| ) |
Controls the minimum and maximum sampling rates when rendering a pixel for this MentalRayRenderSettings object.
- Parameters
-
min [in] Minimum sampling rate. [-3 .. 5] max [in] Maximum sampling rate. [-3 .. 5]
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Negative values enable subsampling. -3 specifies one sample per 64 pixels 5 specfies one sample per 1028 pixels The default value of min == -1 The default value of max == 0 Min <= Max
◆ setSamplingContrastColor()
| OdResult OdDbMentalRayRenderSettings::setSamplingContrastColor | ( | float | red, |
| float | green, | ||
| float | blue, | ||
| float | alpha | ||
| ) |
Sets the SamplingContrastColor for this MentalRayRenderSettings object.
- Parameters
-
red [in] Red color channel threshold. [0.0 .. 1.0] green [in] Green channel threshold. [0.0 .. 1.0] blue [in] Blue channel threshold. [0.0 .. 1.0] alpha [in] Alpha channel threshold. [0.0 .. 1.0]
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- Additional color camples will be taken if the difference between a sample and its surrounding samples exceeds the SamplingContrastColor.
The default value for each color channel is 1.0.
◆ setSamplingFilter()
| OdResult OdDbMentalRayRenderSettings::setSamplingFilter | ( | OdGiMrFilter | filter, |
| double | width, | ||
| double | height | ||
| ) |
Sets the sampling filter parameters for this MentalRayRenderSettings object.
- Parameters
-
filter [in] Filter method. width [in] Width of the filter area in pixels. [0.0 .. 8.0] height [in] Height of the filter area in pixels. [0.0 .. 8.0]
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The defaults are as follows:
Default filter kBox width 1.0 height 1.0
◆ setShadowMapsEnabled()
| void OdDbMentalRayRenderSettings::setShadowMapsEnabled | ( | bool | shadowMapsEnabled | ) |
Controls the generation of shadow maps for this MentalRayRenderSettings object.
- Parameters
-
shadowMapsEnabled [in] Controls shadow maps.
- Remarks
- The default value of ShadowMapsEnabled == true;
◆ setShadowMode()
| void OdDbMentalRayRenderSettings::setShadowMode | ( | OdGiMrShadowMode | shadowMode | ) |
Sets the method of computing ray-traced shadows for this MentalRayRenderSettings object.
- Remarks
- The default value for ShadowMode == krSimple.
◆ setShadowSamplingMultiplier()
| OdResult OdDbMentalRayRenderSettings::setShadowSamplingMultiplier | ( | ShadowSamplingMultiplier | multiplier | ) |
Sets the shadow sampling multiplier for this MentalRaySettings object.
- Parameters
-
multiplier [in] Shadow sampling multiplier.
- Remarks
- The default value for shadow sampling multiplier is kSamplingMultiplierOne.
◆ setTileOrder()
| void OdDbMentalRayRenderSettings::setTileOrder | ( | OdGiMrTileOrder | tileOrder | ) |
Sets the tile order used in tile rendering for this MentalRaySettings object.
- Parameters
-
tileOrder [in] Tile order.
- Remarks
- The default value for TileOrder is krHilbert.
◆ setTileSize()
| OdResult OdDbMentalRayRenderSettings::setTileSize | ( | int | tileSize | ) |
Sets the image tile size used in rendering for this MentalRaySettings object.
- Parameters
-
tileSize [in] Tile size. [4..512]
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- Larger values decrease rendering time and update frequency during rendering.
The default value for TileSize is 32.
◆ shadowMapsEnabled()
| bool OdDbMentalRayRenderSettings::shadowMapsEnabled | ( | ) | const |
Returns true if and only if shadow maps are generated for this MentalRayRenderSettings object.
◆ shadowMode()
| OdGiMrShadowMode OdDbMentalRayRenderSettings::shadowMode | ( | ) | const |
Returns the method of computing ray-traced shadows for this MentalRayRenderSettings object.
◆ shadowSamplingMultiplier()
| ShadowSamplingMultiplier OdDbMentalRayRenderSettings::shadowSamplingMultiplier | ( | ) | const |
Returns the shadow sampling multiplier for this MentalRaySettings object.
◆ subSetAttributes()
|
virtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Reimplemented from OdDbRenderSettings.
◆ tileOrder()
| OdGiMrTileOrder OdDbMentalRayRenderSettings::tileOrder | ( | ) | const |
Returns the tile order used in tile rendering for this MentalRaySettings object.
◆ tileSize()
| int OdDbMentalRayRenderSettings::tileSize | ( | ) | const |
Returns the image tile size used in rendering for this MentalRaySettings object.
The documentation for this class was generated from the following file: