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

#include <GiEnvironment.h>

Inheritance diagram for OdGiRenderSettingsTraits:
OdGiDrawableTraits OdRxObject OdGiMentalRayRenderSettingsTraits OdGiRapidRTRenderSettingsTraits

Public Member Functions

 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 the render settings for the display system.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 176 of file GiEnvironment.h.

Member Function Documentation

◆ backFacesEnabled()

virtual bool OdGiRenderSettingsTraits::backFacesEnabled ( ) const
pure virtual

Checks whether back faces rendering is enabled.

Returns
true if back faces rendering is enabled, false otherwise.

◆ diagnosticBackgroundEnabled()

virtual bool OdGiRenderSettingsTraits::diagnosticBackgroundEnabled ( ) const
pure virtual

Checks whether checkerboard (diagnostic) background is enabled.

Returns
true if diagnostic background rendering is enabled, false otherwise.

◆ materialEnabled()

virtual bool OdGiRenderSettingsTraits::materialEnabled ( ) const
pure virtual

Checks whether per-object materials are used.

Returns
true if per-object materials are used.

◆ modelScaleFactor()

virtual double OdGiRenderSettingsTraits::modelScaleFactor ( ) const
pure virtual

Retrieves model scale related to meters.

Returns
scale factor as a value of the double type. For example if model is drawn in kilometers, the returned value is 1000.0.

◆ ODRX_DECLARE_MEMBERS()

OdGiRenderSettingsTraits::ODRX_DECLARE_MEMBERS ( OdGiRenderSettingsTraits  )

◆ setBackFacesEnabled()

virtual void OdGiRenderSettingsTraits::setBackFacesEnabled ( bool  enabled)
pure virtual

Specifies whether back faces should be rendered.

Parameters
enabled[in] Flag that specifies whether back faces should be rendered.

◆ setDiagnosticBackgroundEnabled()

virtual void OdGiRenderSettingsTraits::setDiagnosticBackgroundEnabled ( bool  enabled)
pure virtual

Specifies whether checkerboard (diagnostic) background should be used for rendering.

Parameters
enabled[in] Flag that specifies whether checkerboard background should be used.

◆ setMaterialEnabled()

virtual void OdGiRenderSettingsTraits::setMaterialEnabled ( bool  enabled)
pure virtual

Specifies whether per-object materials should be used.

Parameters
enabled[in] Flag that specifies whether per-object materials should be used.
Remarks
If set to false, the global material is used for all objects.

◆ setModelScaleFactor()

virtual void OdGiRenderSettingsTraits::setModelScaleFactor ( double  scaleFactor)
pure virtual

Specifies model scale related to meters.

Parameters
scaleFactor[in] Scale factor for a model.
Remarks
For example, if the model is drawn in kilometers, the scale factor is 1000.0. This is later used for the global illumination.

◆ setShadowsEnabled()

virtual void OdGiRenderSettingsTraits::setShadowsEnabled ( bool  enabled)
pure virtual

Specifies whether shadows should be rendered.

Parameters
enabled[in] Flag that specifies whether shadows should be rendered.

◆ setTextureSampling()

virtual void OdGiRenderSettingsTraits::setTextureSampling ( bool  enabled)
pure virtual

Specifies whether texture sampling (filtering) should be used for image textures.

Parameters
enabled[in] Flag that specifies whether sampling should be used.

◆ shadowsEnabled()

virtual bool OdGiRenderSettingsTraits::shadowsEnabled ( ) const
pure virtual

Checks whether shadows rendering is enabled.

Returns
true if shadows rendering is enabled, false otherwise.

◆ textureSampling()

virtual bool OdGiRenderSettingsTraits::textureSampling ( ) const
pure virtual

Checks whether texture sampling (filtering) is used for image textures.

Returns
true if texture sampling is used, false otherwise.
Remarks
texture sampling is not applied to textured created in a procedural way.

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