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

#include <GiEnvironment.h>

Inheritance diagram for OdGiRapidRTRenderSettingsTraits:
OdGiRenderSettingsTraits OdGiDrawableTraits OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiRapidRTRenderSettingsTraits)
 
virtual void setQuitCondition (OdGiQuitCondition condition)=0
 
virtual OdGiQuitCondition quitCondition () const =0
 
virtual void setDesiredRenderLevel (int level)=0
 
virtual int desiredRenderLevel () const =0
 
virtual void setDesiredRenderTime (int time)=0
 
virtual int desiredRenderTime () const =0
 
virtual void setLightingMode (OdGiLightingMode mode)=0
 
virtual OdGiLightingMode lightingMode () const =0
 
virtual void setFilterType (OdGiFilterType type)=0
 
virtual OdGiFilterType filterType () const =0
 
virtual void setFilterWidth (float width)=0
 
virtual float filterWidth () const =0
 
virtual void setFilterHeight (float height)=0
 
virtual float filterHeight () 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 OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () 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 OdRxClass * desc ()
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1069 of file GiEnvironment.h.

Member Function Documentation

◆ desiredRenderLevel()

virtual int OdGiRapidRTRenderSettingsTraits::desiredRenderLevel ( ) const
pure virtual

Retrieves the desired render level. Rendering quits once desired render quality is reached. This works only when the OdGiQuitCondition::krEQuitByRenderLevel value was passed to the setQuitCondition() method.

Returns
desired render level in range [1..50].

◆ desiredRenderTime()

virtual int OdGiRapidRTRenderSettingsTraits::desiredRenderTime ( ) const
pure virtual

Retrieves the desired render time. Rendering quits once rendering time limit is exceeded. This works only when the OdGiQuitCondition::krEQuitByRenderTime value was passed to the setQuitCondition() method.

Returns
desired render time in minutes.

◆ filterHeight()

virtual float OdGiRapidRTRenderSettingsTraits::filterHeight ( ) const
pure virtual

Retrieves the filter height in pixels.

Returns
filter height.

◆ filterType()

virtual OdGiFilterType OdGiRapidRTRenderSettingsTraits::filterType ( ) const
pure virtual

Retrieves the filter type applied to the image samples during sampling.

Returns
a filter type.

◆ filterWidth()

virtual float OdGiRapidRTRenderSettingsTraits::filterWidth ( ) const
pure virtual

Retrieves the filter width in pixels.

Returns
filter width.

◆ lightingMode()

virtual OdGiLightingMode OdGiRapidRTRenderSettingsTraits::lightingMode ( ) const
pure virtual

Retrieves a lighting mode.

Returns
a lighting mode as a value from the OdGiLightingMode enumeration.
Remarks
There are a simplistic, basic or advanced Lighting mode. When simplistic mode is used, the Global illumination and Glossy reflection/refraction is turned off. Basic lighting uses ambient occlusion and a simpler model for ambient light and image-based lighting (IBL). Advanced lighting uses full global illumination and a more advanced model for ambient light and IBL.

◆ ODRX_DECLARE_MEMBERS()

OdGiRapidRTRenderSettingsTraits::ODRX_DECLARE_MEMBERS ( OdGiRapidRTRenderSettingsTraits  )

◆ quitCondition()

virtual OdGiQuitCondition OdGiRapidRTRenderSettingsTraits::quitCondition ( ) const
pure virtual

Retrieves a condition that is used to quit the rendering process.

Returns
quit condition as a value from the OdGiQuitCondition enumeration.

◆ setDesiredRenderLevel()

virtual void OdGiRapidRTRenderSettingsTraits::setDesiredRenderLevel ( int  level)
pure virtual

Specifies the desired render level. Rendering quits once desired render quality is reached. This works only when the OdGiQuitCondition::krEQuitByRenderLevel value was passed to the setQuitCondition() method.

Parameters
level[in] Desired render level in range [1..50].

◆ setDesiredRenderTime()

virtual void OdGiRapidRTRenderSettingsTraits::setDesiredRenderTime ( int  time)
pure virtual

Specifies the desired render time. Rendering quits once rendering time limit is exceeded. This works only when the OdGiQuitCondition::krEQuitByRenderTime value was passed to the setQuitCondition() method.

Parameters
time[in] Desired render time in range [1..1440]. Render time is set in minutes.

◆ setFilterHeight()

virtual void OdGiRapidRTRenderSettingsTraits::setFilterHeight ( float  height)
pure virtual

Specifies the filter height.

Parameters
height[in] Filter height in pixels (image samples).
Remarks
There are different default sizes, recommended to different filter types:
Value box 1.0 triangle 2.0 Gaussian 3.0 Lanczos 4.0 Mitchell 4.0

◆ setFilterType()

virtual void OdGiRapidRTRenderSettingsTraits::setFilterType ( OdGiFilterType  type)
pure virtual

Specifies the filter type applied to the image samples during sampling.

Parameters
type[in] Filter type.

◆ setFilterWidth()

virtual void OdGiRapidRTRenderSettingsTraits::setFilterWidth ( float  width)
pure virtual

Specifies the filter width.

Parameters
width[in] Filter width in pixels (image samples).
Remarks
There are different default sizes, recommended to different filter types:
Value box 1.0 triangle 2.0 Gaussian 3.0 Lanczos 4.0 Mitchell 4.0

◆ setLightingMode()

virtual void OdGiRapidRTRenderSettingsTraits::setLightingMode ( OdGiLightingMode  mode)
pure virtual

Specifies a lighting mode.

Parameters
mode[in] Lighting mode.
Remarks
You can set whether a simplistic, basic or advanced Lighting mode. When simplistic mode is used, the Global illumination and Glossy reflection/refraction is turned off. Basic lighting uses ambient occlusion and a simpler model for ambient light and image-based lighting (IBL). Advanced lighting uses full global illumination and a more advanced model for ambient light and IBL.

◆ setQuitCondition()

virtual void OdGiRapidRTRenderSettingsTraits::setQuitCondition ( OdGiQuitCondition  condition)
pure virtual

Specifies quit condition for rendering process.

Parameters
condition[in] Quit condition.
The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:20