CFx SDK Documentation  2022 SP0
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 OdStringexportMIFileName () 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 voidprogressMonitor () 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 1096 of file GiEnvironmentTraitsData.h.

Member Enumeration Documentation

◆ KindOfRenderSettings

Enumerator
kMentalRaySettings 
kRapidRTSettings 

Definition at line 1106 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiCombinedRenderSettingsTraitsData()

OdGiCombinedRenderSettingsTraitsData::OdGiCombinedRenderSettingsTraitsData ( )
inline

Definition at line 1101 of file GiEnvironmentTraitsData.h.

Member Function Documentation

◆ hasMentalRayRenderSettings()

bool OdGiCombinedRenderSettingsTraitsData::hasMentalRayRenderSettings ( ) const
inline

Definition at line 1124 of file GiEnvironmentTraitsData.h.

◆ hasRapidRTRenderSettings()

bool OdGiCombinedRenderSettingsTraitsData::hasRapidRTRenderSettings ( ) const
inline

Definition at line 1128 of file GiEnvironmentTraitsData.h.

◆ kindOfRenderSettings()

OdUInt32 OdGiCombinedRenderSettingsTraitsData::kindOfRenderSettings ( ) const
inline

Definition at line 1115 of file GiEnvironmentTraitsData.h.

◆ modifyKindOfRenderSettings()

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

Definition at line 1119 of file GiEnvironmentTraitsData.h.

◆ operator!=()

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

Definition at line 1133 of file GiEnvironmentTraitsData.h.

◆ operator==()

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

Definition at line 1139 of file GiEnvironmentTraitsData.h.

◆ setKindOfRenderSettings()

void OdGiCombinedRenderSettingsTraitsData::setKindOfRenderSettings ( OdUInt32  nFlags)
inline

Definition at line 1111 of file GiEnvironmentTraitsData.h.


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