OdGiMentalRayRenderSettingsTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiMentalRayRenderSettingsTraitsData:

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

Detailed Description

Corresponding C++ library: Gi <group OdGi_Classes>

Definition at line 1428 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiMentalRayRenderSettingsTraitsData()

OdGiMentalRayRenderSettingsTraitsData::OdGiMentalRayRenderSettingsTraitsData ( )

inline

Default constructor for the OdGiRenderSettingsTraitsData class. Sets the following parameters:

Data member Value Description m_iSamplingMin -1 Minimum number of samples for pixel shading. m_iSamplingMax 0 Maximum number of samples for pixel shading. m_SamplingFilter krBox Filter for merging multiple samples into a pixel color. m_dSamplingWidth 1.0 Sample width in pixels. m_dSamplingHeight 1.0 Sample height in pixels. m_fContrastR 0.1f Threshold value for red color channel of samples. m_fContrastG 0.1f Threshold value for green color channel of samples. m_fContrastB 0.1f Threshold value for blue color channel of samples. m_fContrastA 0.1f Threshold value for alpha channel of samples. m_ShadowMode krSimple Mode for processing shadows. m_bShadowMapEnabled true Flag that shows if shadow maps are enabled m_bRayTraceEnabled true Flag that shows if ray tracing is enabled m_iRTReflection 2 Level of recursion for computing reflection rays. m_iRTRefraction 2 Level of recursion for computing refraction rays. m_iRTSum 4 Maximum recursion level of reflection and refraction rays for ray tracing, combined. m_bGlobalIllum false Flag that shows if global illumination is enabled. m_iGISampleCount 500 Maximum number of photons surrounding a render sample point to use for calculation of global illumination. m_bSampleRadEnabled false Flag that shows if user-defined photon radius should be used. m_dSampleRad 1.0 Sample area of photons used for global illumination. m_iPhotonsPerLight 10000 Average number of photons to emit for each light source. m_iPhotonsReflection 5 Reflection tracing depth for photons. m_iPhotonsRefraction 5 Refraction tracing depth for photons. m_iPhotonsSum 5 Maximum recursion level of reflection and refraction rays for photons, combined. m_bFGEnabled false Flag that shows if final gathering is enabled. m_iFGRayCount 1000 Amount of final gather rays to use for each final gather point. m_bFGRadMin false Flag that shows if the user-defined minimum radius is used. m_bFGRadMax false Flag that shows if the user-defined maximum radius is used. m_bFGPixels false Flag that shows if the user-defined radii are measured in pixel units. m_dFGSRadMin 1.0 Minimum final gather sample radius. m_dFGSRadMax 1.0 Maximum final gather sample radius. m_dLightLumScale 1.0 Luminance of a light with intensity 1.0 (in candelas). m_DiagMode krOff Mode for processing diagnostic images. m_DiagGridMode krObject Coordinate system for the diagnostic grid. m_fDiagGridSize 10.0f Distance between grid lines (size). m_DiagPhtMode krDensity Type of photon information to use in the photon diagnostic mode. m_DiagBSPMode krDepth Type of BSP information to visualize with the BSP diagnostic mode. m_bExportMIEnabled false Flag that shows if MI file is exported after image is rendered. m_sMIFile (empty) Name of the exported MI file. m_iTileSize 32 Tile size to use during rendering. m_TileOrder krHilbert Tile order to use during rendering. m_iMemLimit 1048 Memory limit to allocate for rendering (in megabytes). m_fEnergyMult 1.0f Energy multiplier to control the magnitude of indirect illumination. m_pProgressMonitor NULL Interface pointer for the render driver to callback. m_ExposureType krAutomatic Exposure type. m_FGMode krFinalGatherAuto Final gathering mode. m_dShadowMult 1.0 Shadows sampling multiplier. m_MIMode krExportMIOff Export mode for the MI file.

Definition at line 1532 of file GiEnvironmentTraitsData.h.

Member Function Documentation

diagnosticBSPMode()

OdGiMrDiagnosticBSPMode OdGiMentalRayRenderSettingsTraitsData::diagnosticBSPMode ( ) const

inline

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.

Definition at line 2110 of file GiEnvironmentTraitsData.h.

diagnosticGridMode()

void OdGiMentalRayRenderSettingsTraitsData::diagnosticGridMode ( OdGiMrDiagnosticGridMode &  mode, float &  fSize  ) const

inline

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.

Definition at line 2067 of file GiEnvironmentTraitsData.h.

diagnosticMode()

OdGiMrDiagnosticMode OdGiMentalRayRenderSettingsTraitsData::diagnosticMode ( ) const

inline

Retrieves a mode used to process diagnostic images.

Returns

physical luminance of a light.

Definition at line 2044 of file GiEnvironmentTraitsData.h.

diagnosticPhotonMode()

OdGiMrDiagnosticPhotonMode OdGiMentalRayRenderSettingsTraitsData::diagnosticPhotonMode ( ) const

inline

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.

Definition at line 2089 of file GiEnvironmentTraitsData.h.

energyMultiplier()

float OdGiMentalRayRenderSettingsTraitsData::energyMultiplier ( ) const

inline

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

Returns

scale factor to control magnitude of indirect illumination.

Definition at line 2240 of file GiEnvironmentTraitsData.h.

exportMIEnabled()

bool OdGiMentalRayRenderSettingsTraitsData::exportMIEnabled ( ) const

inline

Checks whether MI file is enabled after image rendering.

Returns

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

Definition at line 2131 of file GiEnvironmentTraitsData.h.

exportMIFileName()

const OdString & OdGiMentalRayRenderSettingsTraitsData::exportMIFileName ( ) const

inline

Retrieves a file name for an exported MI file.

Returns

file name for an exported MI file as OdString value.

Definition at line 2152 of file GiEnvironmentTraitsData.h.

exportMIMode()

OdGiMrExportMIMode OdGiMentalRayRenderSettingsTraitsData::exportMIMode ( ) const

inline

Retrieves an export type for MI file.

Returns

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

Definition at line 2351 of file GiEnvironmentTraitsData.h.

exposureType()

OdGiMrExposureType OdGiMentalRayRenderSettingsTraitsData::exposureType ( ) const

inline

Retrieves the exposure type.

Returns

exposure type as a value from the OdGiMrExposureType enumeration.

Definition at line 2282 of file GiEnvironmentTraitsData.h.

fgRayCount()

int OdGiMentalRayRenderSettingsTraitsData::fgRayCount ( ) const

inline

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.

Definition at line 1950 of file GiEnvironmentTraitsData.h.

fgSampleRadius()

void OdGiMentalRayRenderSettingsTraitsData::fgSampleRadius ( double &  min, double &  max  ) const

inline

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.

Definition at line 2001 of file GiEnvironmentTraitsData.h.

fgSampleRadiusState()

void OdGiMentalRayRenderSettingsTraitsData::fgSampleRadiusState ( bool &  bMin, bool &  bMax, bool &  bPixels  )

inline

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.

Definition at line 1976 of file GiEnvironmentTraitsData.h.

finalGatheringEnabled()

bool OdGiMentalRayRenderSettingsTraitsData::finalGatheringEnabled ( ) const

inline

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.

Definition at line 1923 of file GiEnvironmentTraitsData.h.

finalGatheringMode()

OdGiMrFinalGatheringMode OdGiMentalRayRenderSettingsTraitsData::finalGatheringMode ( ) const

inline

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.

Definition at line 2309 of file GiEnvironmentTraitsData.h.

giPhotonsPerLight()

int OdGiMentalRayRenderSettingsTraitsData::giPhotonsPerLight ( ) const

inline

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.

Definition at line 1868 of file GiEnvironmentTraitsData.h.

giSampleCount()

int OdGiMentalRayRenderSettingsTraitsData::giSampleCount ( ) const

inline

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.

Definition at line 1802 of file GiEnvironmentTraitsData.h.

giSampleRadius()

double OdGiMentalRayRenderSettingsTraitsData::giSampleRadius ( ) const

inline

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.

Definition at line 1847 of file GiEnvironmentTraitsData.h.

giSampleRadiusEnabled()

bool OdGiMentalRayRenderSettingsTraitsData::giSampleRadiusEnabled ( ) const

inline

Checks whether user-defined photon radius is enabled.

Returns

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

Definition at line 1823 of file GiEnvironmentTraitsData.h.

globalIlluminationEnabled()

bool OdGiMentalRayRenderSettingsTraitsData::globalIlluminationEnabled ( ) const

inline

Checks whether global illumination effects are enabled.

Returns

true if ray tracing is enabled, false otherwise.

Definition at line 1781 of file GiEnvironmentTraitsData.h.

lightLuminanceScale()

double OdGiMentalRayRenderSettingsTraitsData::lightLuminanceScale ( ) const

inline

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

Returns

physical luminance of a light.

Definition at line 2023 of file GiEnvironmentTraitsData.h.

memoryLimit()

int OdGiMentalRayRenderSettingsTraitsData::memoryLimit ( ) const

inline

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.

Definition at line 2219 of file GiEnvironmentTraitsData.h.

operator!=()

bool OdGiMentalRayRenderSettingsTraitsData::operator!= ( const OdGiMentalRayRenderSettingsTraitsData &  data2 ) const

inline

Checks whether the passed render traits are not equal to these traits.

Parameters

data2

[in] Traits to compare.

Returns

true if traits are not equal, false otherwise.

Definition at line 2363 of file GiEnvironmentTraitsData.h.

operator==()

bool OdGiMentalRayRenderSettingsTraitsData::operator== ( const OdGiMentalRayRenderSettingsTraitsData &  data2 ) const

inline

Checks whether the passed render traits are equal to these traits.

Parameters

data2

[in] Traits to compare.

Returns

true if traits are not equal, false otherwise.

Definition at line 2422 of file GiEnvironmentTraitsData.h.

photonTraceDepth()

void OdGiMentalRayRenderSettingsTraitsData::photonTraceDepth ( int &  reflection, int &  refraction, int &  sum  ) const

inline

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.

Definition at line 1894 of file GiEnvironmentTraitsData.h.

progressMonitor()

const void * OdGiMentalRayRenderSettingsTraitsData::progressMonitor ( ) const

inline

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.

Definition at line 2261 of file GiEnvironmentTraitsData.h.

rayTraceDepth()

void OdGiMentalRayRenderSettingsTraitsData::rayTraceDepth ( int &  reflection, int &  refraction, int &  sum  ) const

inline

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.

Definition at line 1758 of file GiEnvironmentTraitsData.h.

rayTraceEnabled()

bool OdGiMentalRayRenderSettingsTraitsData::rayTraceEnabled ( ) const

inline

Checks whether ray tracing is enabled.

Returns

true if ray tracing is enabled, false otherwise.

Definition at line 1732 of file GiEnvironmentTraitsData.h.

sampling()

void OdGiMentalRayRenderSettingsTraitsData::sampling ( int &  min, int &  max  ) const

inline

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.

Definition at line 1602 of file GiEnvironmentTraitsData.h.

samplingContrastColor()

void OdGiMentalRayRenderSettingsTraitsData::samplingContrastColor ( float &  r, float &  g, float &  b, float &  a  ) const

inline

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].

Definition at line 1666 of file GiEnvironmentTraitsData.h.

samplingFilter()

void OdGiMentalRayRenderSettingsTraitsData::samplingFilter ( OdGiMrFilter &  filter, double &  width, double &  height  ) const

inline

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].

Definition at line 1629 of file GiEnvironmentTraitsData.h.

setDiagnosticBSPMode()

void OdGiMentalRayRenderSettingsTraitsData::setDiagnosticBSPMode ( OdGiMrDiagnosticBSPMode  mode )

inline

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

Parameters

mode	[in] BSP diagnostic mode.

Definition at line 2099 of file GiEnvironmentTraitsData.h.

setDiagnosticGridMode()

void OdGiMentalRayRenderSettingsTraitsData::setDiagnosticGridMode ( OdGiMrDiagnosticGridMode  mode, float  fSize  )

inline

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.

Definition at line 2055 of file GiEnvironmentTraitsData.h.

setDiagnosticMode()

void OdGiMentalRayRenderSettingsTraitsData::setDiagnosticMode ( OdGiMrDiagnosticMode  mode )

inline

Specifies a mode used to process diagnostic images.

Parameters

mode	[in] Mode used to process diagnostic images.

Definition at line 2033 of file GiEnvironmentTraitsData.h.

setDiagnosticPhotonMode()

void OdGiMentalRayRenderSettingsTraitsData::setDiagnosticPhotonMode ( OdGiMrDiagnosticPhotonMode  mode )

inline

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

Parameters

mode	[in] Photon diagnostic mode.

Definition at line 2078 of file GiEnvironmentTraitsData.h.

setEnergyMultiplier()

void OdGiMentalRayRenderSettingsTraitsData::setEnergyMultiplier ( float  fScale )

inline

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

Parameters

fScale

[in] Scale factor.

Definition at line 2229 of file GiEnvironmentTraitsData.h.

setExportMIEnabled()

void OdGiMentalRayRenderSettingsTraitsData::setExportMIEnabled ( bool  enabled )

inline

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.

Definition at line 2120 of file GiEnvironmentTraitsData.h.

setExportMIFileName()

void OdGiMentalRayRenderSettingsTraitsData::setExportMIFileName ( const OdString &  miName )

inline

Specifies a file name for an exported MI file.

Parameters

miName

[in] Name for an exported MI file.

Definition at line 2141 of file GiEnvironmentTraitsData.h.

setExportMIMode()

void OdGiMentalRayRenderSettingsTraitsData::setExportMIMode ( OdGiMrExportMIMode  mode )

inline

Specifies an export type for MI file.

Parameters

mode	[in] Defines export mode for MI files.

Definition at line 2340 of file GiEnvironmentTraitsData.h.

setExposureType()

void OdGiMentalRayRenderSettingsTraitsData::setExposureType ( OdGiMrExposureType  type )

inline

Specifies the exposure type.

Parameters

type	[in] Exposure type.

Definition at line 2271 of file GiEnvironmentTraitsData.h.

setFGRadiusState()

void OdGiMentalRayRenderSettingsTraitsData::setFGRadiusState ( bool  bMin, bool  bMax, bool  bPixels  )

inline

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.

Definition at line 1962 of file GiEnvironmentTraitsData.h.

setFGRayCount()

void OdGiMentalRayRenderSettingsTraitsData::setFGRayCount ( int  num )

inline

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.

Definition at line 1936 of file GiEnvironmentTraitsData.h.

setFGSampleRadius()

void OdGiMentalRayRenderSettingsTraitsData::setFGSampleRadius ( double  min, double  max  )

inline

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.

Definition at line 1989 of file GiEnvironmentTraitsData.h.

setFinalGatheringEnabled()

void OdGiMentalRayRenderSettingsTraitsData::setFinalGatheringEnabled ( bool  enabled )

inline

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.

Definition at line 1909 of file GiEnvironmentTraitsData.h.

setFinalGatheringMode()

void OdGiMentalRayRenderSettingsTraitsData::setFinalGatheringMode ( OdGiMrFinalGatheringMode  mode )

inline

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.

Definition at line 2295 of file GiEnvironmentTraitsData.h.

setGIPhotonsPerLight()

void OdGiMentalRayRenderSettingsTraitsData::setGIPhotonsPerLight ( int  num )

inline

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.

Definition at line 1857 of file GiEnvironmentTraitsData.h.

setGISampleCount()

void OdGiMentalRayRenderSettingsTraitsData::setGISampleCount ( int  num )

inline

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.

Definition at line 1791 of file GiEnvironmentTraitsData.h.

setGISampleRadius()

void OdGiMentalRayRenderSettingsTraitsData::setGISampleRadius ( double  radius )

inline

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.

Definition at line 1836 of file GiEnvironmentTraitsData.h.

setGISampleRadiusEnabled()

void OdGiMentalRayRenderSettingsTraitsData::setGISampleRadiusEnabled ( bool  enabled )

inline

Specifies whether user-defined photon radius should be used.

Parameters

enabled

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

Definition at line 1812 of file GiEnvironmentTraitsData.h.

setGlobalIlluminationEnabled()

void OdGiMentalRayRenderSettingsTraitsData::setGlobalIlluminationEnabled ( bool  enabled )

inline

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

Parameters

enabled

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

Definition at line 1770 of file GiEnvironmentTraitsData.h.

setLightLuminanceScale()

void OdGiMentalRayRenderSettingsTraitsData::setLightLuminanceScale ( double  luminance )

inline

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.

Definition at line 2012 of file GiEnvironmentTraitsData.h.

setMemoryLimit()

void OdGiMentalRayRenderSettingsTraitsData::setMemoryLimit ( int  limit )

inline

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

Parameters

limit

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

Definition at line 2208 of file GiEnvironmentTraitsData.h.

setPhotonTraceDepth()

void OdGiMentalRayRenderSettingsTraitsData::setPhotonTraceDepth ( int  reflection, int  refraction, int  sum  )

inline

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.

Definition at line 1880 of file GiEnvironmentTraitsData.h.

setProgressMonitor()

void OdGiMentalRayRenderSettingsTraitsData::setProgressMonitor ( void *  pMonitor )

inline

Specifies the interface pointer for the render driver to callback.

Parameters

pMonitor

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

Definition at line 2250 of file GiEnvironmentTraitsData.h.

setRayTraceDepth()

void OdGiMentalRayRenderSettingsTraitsData::setRayTraceDepth ( int  reflection, int  refraction, int  sum  )

inline

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.

Definition at line 1744 of file GiEnvironmentTraitsData.h.

setRayTraceEnabled()

void OdGiMentalRayRenderSettingsTraitsData::setRayTraceEnabled ( bool  enabled )

inline

Specifies whether ray tracing should be enabled.

Parameters

enabled

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

Definition at line 1721 of file GiEnvironmentTraitsData.h.

setSampling()

void OdGiMentalRayRenderSettingsTraitsData::setSampling ( int  min, int  max  )

inline

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.

Definition at line 1590 of file GiEnvironmentTraitsData.h.

setSamplingContrastColor()

void OdGiMentalRayRenderSettingsTraitsData::setSamplingContrastColor ( float  r, float  g, float  b, float  a  )

inline

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].

Definition at line 1647 of file GiEnvironmentTraitsData.h.

setSamplingFilter()

void OdGiMentalRayRenderSettingsTraitsData::setSamplingFilter ( OdGiMrFilter  filter, double  width, double  height  )

inline

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].

Definition at line 1615 of file GiEnvironmentTraitsData.h.

setShadowMapEnabled()

void OdGiMentalRayRenderSettingsTraitsData::setShadowMapEnabled ( bool  enabled )

inline

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.

Definition at line 1700 of file GiEnvironmentTraitsData.h.

setShadowMode()

void OdGiMentalRayRenderSettingsTraitsData::setShadowMode ( OdGiMrShadowMode  mode )

inline

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

Parameters

mode	[in] Shadow mode.

Definition at line 1679 of file GiEnvironmentTraitsData.h.

setShadowSamplingMultiplier()

void OdGiMentalRayRenderSettingsTraitsData::setShadowSamplingMultiplier ( double  multiplier )

inline

Specifies shadow sampling multiplier value.

Parameters

multiplier

[in] Multiplier value for shadows.

Definition at line 2319 of file GiEnvironmentTraitsData.h.

setTileOrder()

void OdGiMentalRayRenderSettingsTraitsData::setTileOrder ( OdGiMrTileOrder  order )

inline

Specifies the order used to render image tiles.

Parameters

order

[in] Order used to render image tiles.

Definition at line 2187 of file GiEnvironmentTraitsData.h.

setTileSize()

void OdGiMentalRayRenderSettingsTraitsData::setTileSize ( int  size )

inline

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].

Definition at line 2166 of file GiEnvironmentTraitsData.h.

shadowMapEnabled()

bool OdGiMentalRayRenderSettingsTraitsData::shadowMapEnabled ( ) const

inline

Checks whether shadow maps is enabled.

Returns

true if shadow mapping is enabled, false otherwise.

Definition at line 1711 of file GiEnvironmentTraitsData.h.

shadowMode()

OdGiMrShadowMode OdGiMentalRayRenderSettingsTraitsData::shadowMode ( ) const

inline

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.

Definition at line 1690 of file GiEnvironmentTraitsData.h.

shadowSamplingMultiplier()

double OdGiMentalRayRenderSettingsTraitsData::shadowSamplingMultiplier ( ) const

inline

Retrieves shadow sampling multiplier value.

Returns

multiplier value for shadows.

Definition at line 2330 of file GiEnvironmentTraitsData.h.

tileOrder()

OdGiMrTileOrder OdGiMentalRayRenderSettingsTraitsData::tileOrder ( ) const

inline

Retrieves the order used to render image tiles.

Returns

order used to render image tiles as OdGiMrTileOrder value.

Definition at line 2198 of file GiEnvironmentTraitsData.h.

tileSize()

int OdGiMentalRayRenderSettingsTraitsData::tileSize ( ) const

inline

Retrieves the size of the image tiles used during rendering.

Returns

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

Definition at line 2177 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h