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

#include <GiEnvironment.h>

Inheritance diagram for OdGiMentalRayRenderSettingsTraits:
OdGiRenderSettingsTraits OdGiDrawableTraits OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiMentalRayRenderSettingsTraits)
 
virtual void setSampling (int min, int max)=0
 
virtual void sampling (int &min, int &max) const =0
 
virtual void setSamplingFilter (OdGiMrFilter filter, double width, double height)=0
 
virtual void SamplingFilter (OdGiMrFilter &filter, double &width, double &height) const =0
 
virtual void setSamplingContrastColor (float r, float g, float b, float a)=0
 
virtual void samplingContrastColor (float &r, float &g, float &b, float &a) const =0
 
virtual void setShadowMode (OdGiMrShadowMode mode)=0
 
virtual OdGiMrShadowMode shadowMode () const =0
 
virtual void setShadowMapEnabled (bool enabled)=0
 
virtual bool shadowMapEnabled () const =0
 
virtual void setRayTraceEnabled (bool enabled)=0
 
virtual bool rayTraceEnabled () const =0
 
virtual void setRayTraceDepth (int reflection, int refraction, int sum)=0
 
virtual void rayTraceDepth (int &reflection, int &refraction, int &sum) const =0
 
virtual void setGlobalIlluminationEnabled (bool enabled)=0
 
virtual bool globalIlluminationEnabled () const =0
 
virtual void setGISampleCount (int num)=0
 
virtual int giSampleCount () const =0
 
virtual void setGISampleRadiusEnabled (bool enabled)=0
 
virtual bool giSampleRadiusEnabled () const =0
 
virtual void setGISampleRadius (double radius)=0
 
virtual double giSampleRadius () const =0
 
virtual void setGIPhotonsPerLight (int num)=0
 
virtual int giPhotonsPerLight () const =0
 
virtual void setPhotonTraceDepth (int reflection, int refraction, int sum)=0
 
virtual void photonTraceDepth (int &reflection, int &refraction, int &sum) const =0
 
virtual void setFinalGatheringEnabled (bool enabled)=0
 
virtual bool finalGatheringEnabled () const =0
 
virtual void setFGRayCount (int num)=0
 
virtual int fgRayCount () const =0
 
virtual void setFGRadiusState (bool bMin, bool bMax, bool bPixels)=0
 
virtual void fgSampleRadiusState (bool &bMin, bool &bMax, bool &bPixels)=0
 
virtual void setFGSampleRadius (double min, double max)=0
 
virtual void fgSampleRadius (double &min, double &max) const =0
 
virtual void setLightLuminanceScale (double luminance)=0
 
virtual double lightLuminanceScale () const =0
 
virtual void setDiagnosticMode (OdGiMrDiagnosticMode mode)=0
 
virtual OdGiMrDiagnosticMode diagnosticMode () const =0
 
virtual void setDiagnosticGridMode (OdGiMrDiagnosticGridMode mode, float fSize)=0
 
virtual void diagnosticGridMode (OdGiMrDiagnosticGridMode &mode, float &fSize) const =0
 
virtual void setDiagnosticPhotonMode (OdGiMrDiagnosticPhotonMode mode)=0
 
virtual OdGiMrDiagnosticPhotonMode diagnosticPhotonMode () const =0
 
virtual void setDiagnosticBSPMode (OdGiMrDiagnosticBSPMode mode)=0
 
virtual OdGiMrDiagnosticBSPMode diagnosticBSPMode () const =0
 
virtual void setExportMIEnabled (bool enabled)=0
 
virtual bool exportMIEnabled () const =0
 
virtual void setExportMIFileName (const OdString &miName)=0
 
virtual OdString exportMIFileName () const =0
 
virtual void setTileSize (int size)=0
 
virtual int tileSize () const =0
 
virtual void setTileOrder (OdGiMrTileOrder order)=0
 
virtual OdGiMrTileOrder tileOrder () const =0
 
virtual void setMemoryLimit (int limit)=0
 
virtual int memoryLimit () const =0
 
virtual void setEnergyMultiplier (float fScale)=0
 
virtual float energyMultiplier () const =0
 
virtual void setProgressMonitor (void *pMonitor)=0
 
virtual const voidprogressMonitor () const =0
 
virtual void setExposureType (OdGiMrExposureType type)=0
 
virtual OdGiMrExposureType exposureType () const =0
 
virtual void setFinalGatheringMode (OdGiMrFinalGatheringMode mode)=0
 
virtual OdGiMrFinalGatheringMode finalGatheringMode () const =0
 
virtual void setShadowSamplingMultiplier (double multiplier)=0
 
virtual double shadowSamplingMultiplier () const =0
 
virtual void setExportMIMode (OdGiMrExportMIMode mode)=0
 
virtual OdGiMrExportMIMode exportMIMode () const =0
 
- Public Member Functions inherited from OdGiRenderSettingsTraits
 ODRX_DECLARE_MEMBERS (OdGiRenderSettingsTraits)
 
virtual void setMaterialEnabled (bool enabled)=0
 
virtual bool materialEnabled () const =0
 
virtual void setTextureSampling (bool enabled)=0
 
virtual bool textureSampling () const =0
 
virtual void setBackFacesEnabled (bool enabled)=0
 
virtual bool backFacesEnabled () const =0
 
virtual void setShadowsEnabled (bool enabled)=0
 
virtual bool shadowsEnabled () const =0
 
virtual void setDiagnosticBackgroundEnabled (bool enabled)=0
 
virtual bool diagnosticBackgroundEnabled () const =0
 
virtual void setModelScaleFactor (double scaleFactor)=0
 
virtual double modelScaleFactor () 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

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Represents settings that are specific to the mental ray render.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 408 of file GiEnvironment.h.

Member Function Documentation

◆ diagnosticBSPMode()

virtual OdGiMrDiagnosticBSPMode OdGiMentalRayRenderSettingsTraits::diagnosticBSPMode ( ) const
pure virtual

Retrieves the type of BSP information to render images within the BSP diagnostic mode.

Returns
the type of BSP information to to process images within the BSP diagnostic mode as OdGiMrDiagnosticBSPMode value.

◆ diagnosticGridMode()

virtual void OdGiMentalRayRenderSettingsTraits::diagnosticGridMode ( OdGiMrDiagnosticGridMode mode,
float &  fSize 
) const
pure virtual

Retrieves the coordinate system for the diagnostic grid and the distance between grid lines (size).

Parameters
mode[out] Receives the type of a diagnostic grid.
fSize[out] Receives the distance between grid lines. Must be greater than 0.

◆ diagnosticMode()

virtual OdGiMrDiagnosticMode OdGiMentalRayRenderSettingsTraits::diagnosticMode ( ) const
pure virtual

Retrieves a mode used to process diagnostic images.

Returns
physical luminance of a light.

◆ diagnosticPhotonMode()

virtual OdGiMrDiagnosticPhotonMode OdGiMentalRayRenderSettingsTraits::diagnosticPhotonMode ( ) const
pure virtual

Retrieves the type of photon information to render images within the photon diagnostic mode.

Returns
the type of photon information to to process images within the photon diagnostic mode as OdGiMrDiagnosticPhotonMode value.

◆ energyMultiplier()

virtual float OdGiMentalRayRenderSettingsTraits::energyMultiplier ( ) const
pure virtual

Receives the energy multiplier to control the magnitude of indirect illumination.

Returns
scale factor to control magnitude of indirect illumination.

◆ exportMIEnabled()

virtual bool OdGiMentalRayRenderSettingsTraits::exportMIEnabled ( ) const
pure virtual

Checks whether MI file is enabled after image rendering.

Returns
flag that specifies whether MI file is enabled after image rendering.

◆ exportMIFileName()

virtual OdString OdGiMentalRayRenderSettingsTraits::exportMIFileName ( ) const
pure virtual

Retrieves a file name for an exported MI file.

Returns
file name for an exported MI file as OdString value.

◆ exportMIMode()

virtual OdGiMrExportMIMode OdGiMentalRayRenderSettingsTraits::exportMIMode ( ) const
pure virtual

Retrieves an export type for MI file.

Returns
an export mode for MI file as a value from the OdGiMrExportMIMode enumeration.

◆ exposureType()

virtual OdGiMrExposureType OdGiMentalRayRenderSettingsTraits::exposureType ( ) const
pure virtual

Retrieves the exposure type.

Returns
exposure type as a value from the OdGiMrExposureType enumeration.

◆ fgRayCount()

virtual int OdGiMentalRayRenderSettingsTraits::fgRayCount ( ) const
pure virtual

Retrieves the amount of final gather rays used for each final gather point.

Returns
a number of final gather rays.
Remarks
Each final gather point receives the specified amount of rays to calculate indirect illumination.

◆ fgSampleRadius()

virtual void OdGiMentalRayRenderSettingsTraits::fgSampleRadius ( double &  min,
double &  max 
) const
pure virtual

Retrieves the minimum and maximum radii of the area used to sample final gather points to process indirect illumination.

Parameters
min[out] Receives minimum final gather sample radius. Measurement units for this parameter can be retrieved using the setFGRadiusState() method.
max[out] Receives maximum final gather sample radius. Measurement units for this parameter can be retrieved using the setFGRadiusState() method.

◆ fgSampleRadiusState()

virtual void OdGiMentalRayRenderSettingsTraits::fgSampleRadiusState ( bool &  bMin,
bool &  bMax,
bool &  bPixels 
)
pure virtual

Checks whether user-defined radii are used for final gathering and their measurement units.

Parameters
bMin[out] Flag that shows whether the user-defined minimum radius is used. If set to false, a default radius is used.
bMax[out] Flag that shows whether the user-defined maximum radius is used. If set to false, a default radius is used.
bPixels[out] Flag that shows whether the user-defined radii are measured in pixel units.

◆ finalGatheringEnabled()

virtual bool OdGiMentalRayRenderSettingsTraits::finalGatheringEnabled ( ) const
pure virtual

Checks whether final gathering is enabled.

Returns
true if final gathering is enabled, false otherwise.
Remarks
Final gathering enables indirect illumination effects such as color bleeding and can be combined with global illumination.

◆ finalGatheringMode()

virtual OdGiMrFinalGatheringMode OdGiMentalRayRenderSettingsTraits::finalGatheringMode ( ) const
pure virtual

Retrieves the final gathering mode.

Returns
final gathering mode as a value from OdGiMrFinalGatheringMode enumeration.
Remarks
Final gathering enables indirect illumination effects such as color bleeding and can be combined with global illumination.

◆ giPhotonsPerLight()

virtual int OdGiMentalRayRenderSettingsTraits::giPhotonsPerLight ( ) const
pure virtual

Retrieves the average number of photons that are emitted for each light source.

Returns
average number of photons that are emitted for each light source.

◆ giSampleCount()

virtual int OdGiMentalRayRenderSettingsTraits::giSampleCount ( ) const
pure virtual

Retrieves the maximum number of photons surrounding a render sample point to use for calculation of global illumination.

Returns
integer value that represents a number of photons around each render sample.

◆ giSampleRadius()

virtual double OdGiMentalRayRenderSettingsTraits::giSampleRadius ( ) const
pure virtual

Retrieves the radius of the sample area of photons used for global illumination.

Returns
radius of sample photons as a value of the double type.

◆ giSampleRadiusEnabled()

virtual bool OdGiMentalRayRenderSettingsTraits::giSampleRadiusEnabled ( ) const
pure virtual

Checks whether user-defined photon radius is enabled.

Returns
true if user-defined photon radius is enabled, false otherwise.

◆ globalIlluminationEnabled()

virtual bool OdGiMentalRayRenderSettingsTraits::globalIlluminationEnabled ( ) const
pure virtual

Checks whether global illumination effects are enabled.

Returns
true if ray tracing is enabled, false otherwise.

◆ lightLuminanceScale()

virtual double OdGiMentalRayRenderSettingsTraits::lightLuminanceScale ( ) const
pure virtual

Retrieves the physical luminance of a light with intensity 1.0 (in candelas).

Returns
physical luminance of a light.

◆ memoryLimit()

virtual int OdGiMentalRayRenderSettingsTraits::memoryLimit ( ) const
pure virtual

Retrieves the maximum amount of memory that can be allocated for rendering.

Returns
maximum amount of memory that can be allocated for rendering as integer value.

◆ ODRX_DECLARE_MEMBERS()

OdGiMentalRayRenderSettingsTraits::ODRX_DECLARE_MEMBERS ( OdGiMentalRayRenderSettingsTraits  )

◆ photonTraceDepth()

virtual void OdGiMentalRayRenderSettingsTraits::photonTraceDepth ( int &  reflection,
int &  refraction,
int &  sum 
) const
pure virtual

Retrieves the maximum depth (recursion depth) for traced photons.

Parameters
reflection[out] Maximum recursion level of reflection photons, greater than or equal to 0.
refraction[out] Maximum recursion level of refraction photons, greater than or equal to 0.
sum[out] Maximum recursion level of reflection and refraction photons, combined.

◆ progressMonitor()

virtual const void * OdGiMentalRayRenderSettingsTraits::progressMonitor ( ) const
pure virtual

Retrieves a pointer to the progress monitor.

Returns
a pointer to a void type that can be casted later to a type of a corresponding process monitor.

◆ rayTraceDepth()

virtual void OdGiMentalRayRenderSettingsTraits::rayTraceDepth ( int &  reflection,
int &  refraction,
int &  sum 
) const
pure virtual

Retrieves the maximum depth (recursion depth) for traced rays.

Parameters
reflection[out] Maximum recursion level of reflection rays, greater than or equal to 0.
refraction[out] Maximum recursion level of refraction rays, greater than or equal to 0.
sum[out] Maximum recursion level of reflection and refraction rays, combined.

◆ rayTraceEnabled()

virtual bool OdGiMentalRayRenderSettingsTraits::rayTraceEnabled ( ) const
pure virtual

Checks whether ray tracing is enabled.

Returns
true if ray tracing is enabled, false otherwise.

◆ sampling()

virtual void OdGiMentalRayRenderSettingsTraits::sampling ( int &  min,
int &  max 
) const
pure virtual

Retrieves the minimum and maximum numbers of samples that are used for pixel shading process during rendering.

Parameters
min[out] Minimum sampling rate [-3..5]. Values less than zero enable subsampling. -3 corresponds to one sample for every 64 pixel (1/64) and 5 corresponds to 1024 samples per pixel. This parameter cannot be greater than the max parameter.
max[out] Maximal sampling rate [-3..5]. This parameter cannot be less than the min parameter.

◆ samplingContrastColor()

virtual void OdGiMentalRayRenderSettingsTraits::samplingContrastColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
pure virtual

Retrieves the threshold values for color channels below which further samples are not accepted.

Parameters
r[out] Red channel.
g[out] Green channel.
b[out] Blue channel.
a[out] Alpha (transparency) channel.
Remarks
Each color channel value can be in the range [0.0..1.0].

◆ SamplingFilter()

virtual void OdGiMentalRayRenderSettingsTraits::SamplingFilter ( OdGiMrFilter filter,
double &  width,
double &  height 
) const
pure virtual

Retrieves the filtering parameters for merging multiple samples into a pixel color.

Parameters
filter[out] Filtering parameters for merging multiple samples into a pixel color.
width[out] Width of a filter area for neighboring pixels in the range of [0..8].
height[out] Width of a filter area for neighboring pixels in the range of [0..8].

◆ setDiagnosticBSPMode()

virtual void OdGiMentalRayRenderSettingsTraits::setDiagnosticBSPMode ( OdGiMrDiagnosticBSPMode  mode)
pure virtual

Specifies the type of BSP information to render images within the BSP diagnostic mode.

Parameters
mode[in] BSP diagnostic mode.

◆ setDiagnosticGridMode()

virtual void OdGiMentalRayRenderSettingsTraits::setDiagnosticGridMode ( OdGiMrDiagnosticGridMode  mode,
float  fSize 
)
pure virtual

Specifies the coordinate system for the diagnostic grid and the distance between grid lines (size).

Parameters
mode[in] Type of a diagnostic grid.
fSize[in] Distance between grid lines. Must be greater than 0.

◆ setDiagnosticMode()

virtual void OdGiMentalRayRenderSettingsTraits::setDiagnosticMode ( OdGiMrDiagnosticMode  mode)
pure virtual

Specifies a mode used to process diagnostic images.

Parameters
mode[in] Mode used to process diagnostic images.

◆ setDiagnosticPhotonMode()

virtual void OdGiMentalRayRenderSettingsTraits::setDiagnosticPhotonMode ( OdGiMrDiagnosticPhotonMode  mode)
pure virtual

Specifies the type of photon information to render images within the photon diagnostic mode.

Parameters
mode[in] Photon diagnostic mode.

◆ setEnergyMultiplier()

virtual void OdGiMentalRayRenderSettingsTraits::setEnergyMultiplier ( float  fScale)
pure virtual

Specifies the energy multiplier to control the magnitude of indirect illumination.

Parameters
fScale[in] Scale factor.

◆ setExportMIEnabled()

virtual void OdGiMentalRayRenderSettingsTraits::setExportMIEnabled ( bool  enabled)
pure virtual

Specifies whether to export MI file after image is rendered.

Parameters
mode[in] Flag that specifies whether to export MI file after image is rendered.

◆ setExportMIFileName()

virtual void OdGiMentalRayRenderSettingsTraits::setExportMIFileName ( const OdString miName)
pure virtual

Specifies a file name for an exported MI file.

Parameters
miName[in] Name for an exported MI file.

◆ setExportMIMode()

virtual void OdGiMentalRayRenderSettingsTraits::setExportMIMode ( OdGiMrExportMIMode  mode)
pure virtual

Specifies an export type for MI file.

Parameters
mode[in] Defines export mode for MI files.

◆ setExposureType()

virtual void OdGiMentalRayRenderSettingsTraits::setExposureType ( OdGiMrExposureType  type)
pure virtual

Specifies the exposure type.

Parameters
type[in] Exposure type.

◆ setFGRadiusState()

virtual void OdGiMentalRayRenderSettingsTraits::setFGRadiusState ( bool  bMin,
bool  bMax,
bool  bPixels 
)
pure virtual

Specifies whether user-defined radii are used for final gathering and the measurement units for the radii.

Parameters
bMin[in] Flag that specifies whether the user-defined minimum radius is used. If set to false, a default radius is used.
bMax[in] Flag that specifies whether the user-defined maximum radius is used. If set to false, a default radius is used.
bPixels[in] Flag that specifies whether the user-defined radii are measured in pixel units.

◆ setFGRayCount()

virtual void OdGiMentalRayRenderSettingsTraits::setFGRayCount ( int  num)
pure virtual

Specifies the amount of final gather rays to use for each final gather point.

Parameters
enabled[in] Amount of final gather rays to use for each final gather point. Must be greater than 0.
Remarks
Each final gather point receives the specified amount of rays to calculate indirect illumination.

◆ setFGSampleRadius()

virtual void OdGiMentalRayRenderSettingsTraits::setFGSampleRadius ( double  min,
double  max 
)
pure virtual

Specifies the minimum and maximum radii of the area used to sample final gather points to process indirect illumination.

Parameters
min[in] Minimum final gather sample radius. To define measurement units for this parameter, use the setFGRadiusState() method. Must be greater than 0 but less than or equal to the max parameter.
max[in] Maximum final gather sample radius. To define measurement units for this parameter, use the setFGRadiusState() method. Must be greater than 0 and greater than or equal to the min parameter.

◆ setFinalGatheringEnabled()

virtual void OdGiMentalRayRenderSettingsTraits::setFinalGatheringEnabled ( bool  enabled)
pure virtual

Specifies whether final gathering should be enabled.

Parameters
enabled[in] Flag that specifies whether global illumination should be enabled.
Remarks
Final gathering enables indirect illumination effects such as color bleeding and can be combined with global illumination.

◆ setFinalGatheringMode()

virtual void OdGiMentalRayRenderSettingsTraits::setFinalGatheringMode ( OdGiMrFinalGatheringMode  mode)
pure virtual

Specifies the final gathering mode.

Parameters
mode[in] Final gathering mode.
Remarks
Final gathering enables indirect illumination effects such as color bleeding and can be combined with global illumination.

◆ setGIPhotonsPerLight()

virtual void OdGiMentalRayRenderSettingsTraits::setGIPhotonsPerLight ( int  num)
pure virtual

Specifies the average number of photons to emit for each light source.

Parameters
num[in] Average number of photons to emit for each light. Must be greater than 0.

◆ setGISampleCount()

virtual void OdGiMentalRayRenderSettingsTraits::setGISampleCount ( int  num)
pure virtual

Specifies the maximum number of photons surrounding a render sample point to use for calculation of global illumination.

Parameters
sum[in] Number of photons around each render sample. Must be greater than zero.

◆ setGISampleRadius()

virtual void OdGiMentalRayRenderSettingsTraits::setGISampleRadius ( double  radius)
pure virtual

Specifies the radius of the sample area of photons used for global illumination.

Parameters
radius[in] Radius in model units. Must be greater than or equal to zero.
Remarks
Photons are searched for the area indicated around each render sample, up to the number of photons defined by setGIPhotonCount() method.

◆ setGISampleRadiusEnabled()

virtual void OdGiMentalRayRenderSettingsTraits::setGISampleRadiusEnabled ( bool  enabled)
pure virtual

Specifies whether user-defined photon radius should be used.

Parameters
enabled[in] Flag that specifies whether to enable user-defined photon sampling radius.

◆ setGlobalIlluminationEnabled()

virtual void OdGiMentalRayRenderSettingsTraits::setGlobalIlluminationEnabled ( bool  enabled)
pure virtual

Specifies whether global illumination effects (for example, color bleeding) should be enabled.

Parameters
enabled[in] Flag that specifies whether global illumination should be enabled.

◆ setLightLuminanceScale()

virtual void OdGiMentalRayRenderSettingsTraits::setLightLuminanceScale ( double  luminance)
pure virtual

Specifies the physical luminance of a light with intensity 1.0 (in candelas).

Parameters
luminance[in] Physical luminance of a light with intensity 1.0 (in candelas), used as a physical scaling factor.

◆ setMemoryLimit()

virtual void OdGiMentalRayRenderSettingsTraits::setMemoryLimit ( int  limit)
pure virtual

Specifies the maximum amount of memory that can be allocated for rendering.

Parameters
limit[in] maximum amount of memory for rendering in MB.

◆ setPhotonTraceDepth()

virtual void OdGiMentalRayRenderSettingsTraits::setPhotonTraceDepth ( int  reflection,
int  refraction,
int  sum 
)
pure virtual

Specifies the maximum depth (recursion level) for traced photons.

Parameters
reflection[in] Maximum recursion level of reflection photons, greater than or equal to 0.
refraction[in] Maximum recursion level of refraction photons, greater than or equal to 0.
sum[in] Maximum recursion level of reflection and refraction photons, combined.

◆ setProgressMonitor()

virtual void OdGiMentalRayRenderSettingsTraits::setProgressMonitor ( void pMonitor)
pure virtual

Specifies the interface pointer for the render driver to callback.

Parameters
pMonitor[in] Void pointer that caller provides for the render driver to callback.

◆ setRayTraceDepth()

virtual void OdGiMentalRayRenderSettingsTraits::setRayTraceDepth ( int  reflection,
int  refraction,
int  sum 
)
pure virtual

Specifies the maximum depth (recursion depth) for traced rays.

Parameters
reflection[in] Maximum recursion level of reflection rays, greater than or equal to 0.
refraction[in] Maximum recursion level of refraction rays, greater than or equal to 0.
sum[in] Maximum recursion level of reflection and refraction rays, combined.

◆ setRayTraceEnabled()

virtual void OdGiMentalRayRenderSettingsTraits::setRayTraceEnabled ( bool  enabled)
pure virtual

Specifies whether ray tracing should be enabled.

Parameters
enabled[in] Flag that specifies whether ray tracing should be enabled.

◆ setSampling()

virtual void OdGiMentalRayRenderSettingsTraits::setSampling ( int  min,
int  max 
)
pure virtual

Specifies the minimum and maximum numbers of samples that are used for pixel shading process during rendering.

Parameters
min[in] Minimum sampling rate [-3..5]. Values less than zero enable subsampling. -3 corresponds to one sample for every 64 pixel (1/64) and 5 corresponds to 1024 samples per pixel. This parameter must be less or equal to the max parameter.
max[in] Maximal sampling rate [-3..5]. This parameter must be equal or greater than to the mix parameter.

◆ setSamplingContrastColor()

virtual void OdGiMentalRayRenderSettingsTraits::setSamplingContrastColor ( float  r,
float  g,
float  b,
float  a 
)
pure virtual

Specifies the threshold values for color channels below which further samples are not accepted.

Parameters
r[in] Red channel.
g[in] Green channel.
b[in] Blue channel.
a[in] Alpha (transparency) channel.
Remarks
Each color channel value can be in the range [0.0..1.0].

◆ setSamplingFilter()

virtual void OdGiMentalRayRenderSettingsTraits::setSamplingFilter ( OdGiMrFilter  filter,
double  width,
double  height 
)
pure virtual

Specifies the filtering parameters for merging multiple samples into a pixel color.

Parameters
filter[in] Filtering parameters for merging multiple samples into a pixel color.
width[in] Width of a filter area for neighboring pixels in the range of [0..8].
height[in] Width of a filter area for neighboring pixels in the range of [0..8].

◆ setShadowMapEnabled()

virtual void OdGiMentalRayRenderSettingsTraits::setShadowMapEnabled ( bool  enabled)
pure virtual

Specifies whether shadow maps should be enabled. Affects only lights using mapped shadows.

Parameters
enabled[in] Flag that specifies whether shadow maps should be enabled.

◆ setShadowMode()

virtual void OdGiMentalRayRenderSettingsTraits::setShadowMode ( OdGiMrShadowMode  mode)
pure virtual

Specifies the method used to compute ray-traced shadows. Affects only lights using ray-traced shadows.

Parameters
mode[in] Shadow mode.

◆ setShadowSamplingMultiplier()

virtual void OdGiMentalRayRenderSettingsTraits::setShadowSamplingMultiplier ( double  multiplier)
pure virtual

Specifies shadow sampling multiplier value.

Parameters
multiplier[in] Multiplier value for shadows.

◆ setTileOrder()

virtual void OdGiMentalRayRenderSettingsTraits::setTileOrder ( OdGiMrTileOrder  order)
pure virtual

Specifies the order used to render image tiles.

Parameters
order[in] Order used to render image tiles.

◆ setTileSize()

virtual void OdGiMentalRayRenderSettingsTraits::setTileSize ( int  size)
pure virtual

Specifies the size of the image tiles used during rendering.

Parameters
size[in] Size of image tiles used during rendering.
Remarks
Small values increase rendering time, however provide more frequent updates during rendering. The values must be in range [4..512].

◆ shadowMapEnabled()

virtual bool OdGiMentalRayRenderSettingsTraits::shadowMapEnabled ( ) const
pure virtual

Checks whether shadow maps is enabled.

Returns
true if shadow mapping is enabled, false otherwise.

◆ shadowMode()

virtual OdGiMrShadowMode OdGiMentalRayRenderSettingsTraits::shadowMode ( ) const
pure virtual

Retrieves the method used to compute ray-traced shadows.

Returns
a value from the OdGiMrShadowMode which represents a shadow mode used for processing ray-traced shadows.

◆ shadowSamplingMultiplier()

virtual double OdGiMentalRayRenderSettingsTraits::shadowSamplingMultiplier ( ) const
pure virtual

Retrieves shadow sampling multiplier value.

Returns
multiplier value for shadows.

◆ tileOrder()

virtual OdGiMrTileOrder OdGiMentalRayRenderSettingsTraits::tileOrder ( ) const
pure virtual

Retrieves the order used to render image tiles.

Returns
order used to render image tiles as OdGiMrTileOrder value.

◆ tileSize()

virtual int OdGiMentalRayRenderSettingsTraits::tileSize ( ) const
pure virtual

Retrieves the size of the image tiles used during rendering.

Returns
size of the image tiles used during rendering in range of [4..512].

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