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

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiCombinedRenderSettingsTraitsData:
OdGiMentalRayRenderSettingsTraitsData OdGiRapidRTRenderSettingsTraitsData OdGiRenderSettingsTraitsData OdGiRenderSettingsTraitsData

Public Types

enum  KindOfRenderSettings { kMentalRaySettings = 1 , kRapidRTSettings = 2 }
 

Public Member Functions

 OdGiCombinedRenderSettingsTraitsData ()
 
void setKindOfRenderSettings (OdUInt32 nFlags)
 
OdUInt32 kindOfRenderSettings () const
 
void modifyKindOfRenderSettings (OdUInt32 nFlags, bool bOp=true)
 
bool hasMentalRayRenderSettings () const
 
bool hasRapidRTRenderSettings () const
 
bool operator!= (const OdGiCombinedRenderSettingsTraitsData &data2) const
 
bool operator== (const OdGiCombinedRenderSettingsTraitsData &data2) const
 
- Public Member Functions inherited from OdGiMentalRayRenderSettingsTraitsData
 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
 
- Public Member Functions inherited from OdGiRapidRTRenderSettingsTraitsData
 OdGiRapidRTRenderSettingsTraitsData ()
 
void setQuitCondition (OdGiQuitCondition condition)
 
OdGiQuitCondition quitCondition () const
 
void setDesiredRenderLevel (int level)
 
int desiredRenderLevel () const
 
void setDesiredRenderTime (int time)
 
int desiredRenderTime () const
 
void setLightingMode (OdGiLightingMode mode)
 
OdGiLightingMode lightingMode () const
 
void setFilterType (OdGiFilterType type)
 
OdGiFilterType filterType () const
 
void setFilterWidth (float width)
 
float filterWidth () const
 
void setFilterHeight (float height)
 
float filterHeight () const
 
bool operator!= (const OdGiRapidRTRenderSettingsTraitsData &data2) const
 
bool operator== (const OdGiRapidRTRenderSettingsTraitsData &data2) const
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 2701 of file GiEnvironmentTraitsData.h.

Member Enumeration Documentation

◆ KindOfRenderSettings

enum OdGiCombinedRenderSettingsTraitsData::KindOfRenderSettings

Represents render settings that are used for rendering.

Enumerator
kMentalRaySettings 

Mental ray renderer settings.

kRapidRTSettings 

RapidRT renderer settings.

Definition at line 2717 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiCombinedRenderSettingsTraitsData()

OdGiCombinedRenderSettingsTraitsData::OdGiCombinedRenderSettingsTraitsData ( )
inline

Default constructor for the OdGiCombinedRenderSettingsTraitsData class.

Definition at line 2709 of file GiEnvironmentTraitsData.h.

Member Function Documentation

◆ hasMentalRayRenderSettings()

bool OdGiCombinedRenderSettingsTraitsData::hasMentalRayRenderSettings ( ) const
inline

Checks whether mental ray render settings are used.

Returns
true if mental ray settings are used, false otherwise.

Definition at line 2763 of file GiEnvironmentTraitsData.h.

◆ hasRapidRTRenderSettings()

bool OdGiCombinedRenderSettingsTraitsData::hasRapidRTRenderSettings ( ) const
inline

Checks whether RapidRT render settings are used.

Returns
true if RapidRT render settings are used, false otherwise.

Definition at line 2774 of file GiEnvironmentTraitsData.h.

◆ kindOfRenderSettings()

OdUInt32 OdGiCombinedRenderSettingsTraitsData::kindOfRenderSettings ( ) const
inline

Retrieves a value that represents a type of render settings.

Returns
value that defines render settings. 1 - Mental Ray renderer, 2 - Rapid RT renderer.

Definition at line 2741 of file GiEnvironmentTraitsData.h.

◆ modifyKindOfRenderSettings()

void OdGiCombinedRenderSettingsTraitsData::modifyKindOfRenderSettings ( OdUInt32  nFlags,
bool  bOp = true 
)
inline

Modifies which render settings are currently used.

Parameters
nFlags[in] Value to define render settings. 1 - Mental Ray renderer, 2 - Rapid RT renderer.
bOp[in] Flag that specifies whether the passed render should be used.

Definition at line 2752 of file GiEnvironmentTraitsData.h.

◆ operator!=()

bool OdGiCombinedRenderSettingsTraitsData::operator!= ( const OdGiCombinedRenderSettingsTraitsData &  data2) const
inline

Checks whether the passed render traits are not equal to these render traits. Traits are not equal if one of the following conditions fails: Mental Ray render settings of the passed object are equal to Mental Ray render settings of the this object; RapidRT render settings of the passed object are equal to RapidRT render settings of this object; Types of render settings are equal;

Parameters
data2[in] Traits to compare.
Returns
true if traits are not equal, false otherwise.

Definition at line 2791 of file GiEnvironmentTraitsData.h.

◆ operator==()

bool OdGiCombinedRenderSettingsTraitsData::operator== ( const OdGiCombinedRenderSettingsTraitsData &  data2) const
inline

Checks whether the passed render traits are equal to these render traits. Traits are equal if: Mental Ray render settings of the passed object are equal to Mental Ray render settings of the this object; RapidRT render settings of the passed object are equal to RapidRT render settings of this object; Types of render settings are equal;

Parameters
data2[in] Traits to compare.
Returns
true if traits are equal, false otherwise.

Definition at line 2810 of file GiEnvironmentTraitsData.h.

◆ setKindOfRenderSettings()

void OdGiCombinedRenderSettingsTraitsData::setKindOfRenderSettings ( OdUInt32  nFlags)
inline

Specifies which render settings are used.

Parameters
nFlags[in] Value to define render settings. 1 - Mental Ray renderer, 2 - Rapid RT renderer.

Definition at line 2730 of file GiEnvironmentTraitsData.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:15