OdGiRenderSettingsTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiRenderSettingsTraitsData:

Public Member Functions
	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 1243 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiRenderSettingsTraitsData()

OdGiRenderSettingsTraitsData::OdGiRenderSettingsTraitsData ( )

inline

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

member Value Description m_bMatEnable true Flag that shows if materials are enabled m_bTextureSampling true Flag that shows if texture sampling is enabled m_bBackFaces true Flag that shows if back faces are displayed m_bShadows true Flag that shows if shadows are enabled m_bDiagnosticBack false Flag that shows if diagnostic background is enabled m_dScaleFactor 1.0 Scale factor

Definition at line 1264 of file GiEnvironmentTraitsData.h.

~OdGiRenderSettingsTraitsData()

virtual OdGiRenderSettingsTraitsData::~OdGiRenderSettingsTraitsData ( )

inlinevirtual

Destructor for the OdGiRenderSettingsTraitsData class.

Definition at line 1277 of file GiEnvironmentTraitsData.h.

Member Function Documentation

backFacesEnabled()

bool OdGiRenderSettingsTraitsData::backFacesEnabled ( ) const

inline

Checks whether back faces rendering is enabled.

Returns

true if back faces rendering is enabled, false otherwise.

Definition at line 1328 of file GiEnvironmentTraitsData.h.

diagnosticBackgroundEnabled()

bool OdGiRenderSettingsTraitsData::diagnosticBackgroundEnabled ( ) const

inline

Checks whether checkerboard (diagnostic) background is enabled.

Returns

true if diagnostic background rendering is enabled, false otherwise.

Definition at line 1358 of file GiEnvironmentTraitsData.h.

materialEnabled()

bool OdGiRenderSettingsTraitsData::materialEnabled ( ) const

inline

Checks whether per-object materials are used.

Returns

true if per-object materials are used.

Definition at line 1295 of file GiEnvironmentTraitsData.h.

modelScaleFactor()

double OdGiRenderSettingsTraitsData::modelScaleFactor ( ) const

inline

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.

Definition at line 1376 of file GiEnvironmentTraitsData.h.

operator!=()

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

inline

Checks whether the passed render settings traits are not equal to these traits. Traits are considered not equal if one of the following conditions fails: Material flags are equal; Texture sampling flags are equal; Back faces rendering flags are equal; Shadows rendering flags are equal; Diagnostic background flags are equal; Scale factors are equal.

Parameters

data2

[in] Traits to compare.

Returns

true if traits are equal, false otherwise.

Definition at line 1418 of file GiEnvironmentTraitsData.h.

operator==()

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

inline

Checks whether the passed render settings traits are equal to these traits. Traits are considered equal if: Material flags are equal; Texture sampling flags are equal; Back faces rendering flags are equal; Shadows rendering flags are equal; Diagnostic background flags are equal; Scale factors are equal.

Parameters

data2

[in] Traits to compare.

Returns

true if traits are equal, false otherwise.

Definition at line 1393 of file GiEnvironmentTraitsData.h.

setBackFacesEnabled()

void OdGiRenderSettingsTraitsData::setBackFacesEnabled ( bool  enabled )

inline

Specifies whether back faces should be rendered.

Parameters

enabled

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

Definition at line 1320 of file GiEnvironmentTraitsData.h.

setDiagnosticBackgroundEnabled()

void OdGiRenderSettingsTraitsData::setDiagnosticBackgroundEnabled ( bool  enabled )

inline

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

Parameters

enabled

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

Definition at line 1350 of file GiEnvironmentTraitsData.h.

setMaterialEnabled()

void OdGiRenderSettingsTraitsData::setMaterialEnabled ( bool  enabled )

inline

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.

Definition at line 1287 of file GiEnvironmentTraitsData.h.

setModelScaleFactor()

void OdGiRenderSettingsTraitsData::setModelScaleFactor ( double  scaleFactor )

inline

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.

Definition at line 1368 of file GiEnvironmentTraitsData.h.

setShadowsEnabled()

void OdGiRenderSettingsTraitsData::setShadowsEnabled ( bool  enabled )

inline

Specifies whether shadows should be rendered.

Parameters

enabled

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

Definition at line 1335 of file GiEnvironmentTraitsData.h.

setTextureSampling()

void OdGiRenderSettingsTraitsData::setTextureSampling ( bool  enabled )

inline

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

Parameters

enabled

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

Definition at line 1302 of file GiEnvironmentTraitsData.h.

shadowsEnabled()

bool OdGiRenderSettingsTraitsData::shadowsEnabled ( ) const

inline

Checks whether shadows rendering is enabled.

Returns

true if shadows rendering is enabled, false otherwise.

Definition at line 1343 of file GiEnvironmentTraitsData.h.

textureSampling()

bool OdGiRenderSettingsTraitsData::textureSampling ( ) const

inline

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.

Definition at line 1313 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h