OdGiRenderEnvironmentTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Public Member Functions
	OdGiRenderEnvironmentTraitsData ()
void	setEnable (bool bEnable)
bool	enable () const
void	setIsBackground (bool bEnable)
bool	isBackground () const
void	setFogColor (const OdCmEntityColor &color)
const OdCmEntityColor &	fogColor () const
void	setNearDistance (double nearDist)
double	nearDistance () const
void	setFarDistance (double farDist)
double	farDistance () const
void	setNearPercentage (double nearPct)
double	nearPercentage () const
void	setFarPercentage (double farPct)
double	farPercentage () const
void	setEnvironmentMap (const OdGiMaterialTexture *map)
OdGiMaterialTexturePtr	environmentMap () const
bool	operator== (const OdGiRenderEnvironmentTraitsData &data2) const
bool	operator!= (const OdGiRenderEnvironmentTraitsData &data2) const

Detailed Description

Corresponding C++ library: Gi <group OdGi_Classes>

Definition at line 1255 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiRenderEnvironmentTraitsData()

OdGiRenderEnvironmentTraitsData::OdGiRenderEnvironmentTraitsData ( )

inline

Default constructor for the OdGiRenderEnvironmentTraitsData class. Sets fog display and background flags, fog color, fog render distances and percentage.

Definition at line 1271 of file GiEnvironmentTraitsData.h.

Member Function Documentation

enable()

bool OdGiRenderEnvironmentTraitsData::enable ( ) const

inline

Checks whether fog rendering is enabled.

Returns

true if fog rendering is enabled, false otherwise.

Definition at line 1295 of file GiEnvironmentTraitsData.h.

environmentMap()

OdGiMaterialTexturePtr OdGiRenderEnvironmentTraitsData::environmentMap ( ) const

inline

Retrieves the environment map.

Returns

smart pointer to the OdGiMaterialTexture instance that represents environment map.

Definition at line 1407 of file GiEnvironmentTraitsData.h.

farDistance()

double OdGiRenderEnvironmentTraitsData::farDistance ( ) const

inline

Retrieves far distance of fog rendering.

Returns

fog rendering far distance.

Definition at line 1355 of file GiEnvironmentTraitsData.h.

farPercentage()

double OdGiRenderEnvironmentTraitsData::farPercentage ( ) const

inline

Retrieves far percentage of the fog.

Returns

far percentage of the fog.

Definition at line 1385 of file GiEnvironmentTraitsData.h.

fogColor()

const OdCmEntityColor & OdGiRenderEnvironmentTraitsData::fogColor ( ) const

inline

Retrieves fog color.

Returns

fog color as a reference to OdCmEntityColor instance.

Definition at line 1325 of file GiEnvironmentTraitsData.h.

isBackground()

bool OdGiRenderEnvironmentTraitsData::isBackground ( ) const

inline

Checks whether fog is treated background.

Returns

true if fog is treated as background, false otherwise.

Definition at line 1310 of file GiEnvironmentTraitsData.h.

nearDistance()

double OdGiRenderEnvironmentTraitsData::nearDistance ( ) const

inline

Retrieves near distance of fog rendering.

Returns

fog rendering near distance.

Definition at line 1340 of file GiEnvironmentTraitsData.h.

nearPercentage()

double OdGiRenderEnvironmentTraitsData::nearPercentage ( ) const

inline

Retrieves near percentage of the fog.

Returns

near percentage of the fog.

Definition at line 1370 of file GiEnvironmentTraitsData.h.

operator!=()

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

inline

Checks whether the passed traits for render environment traits are not equal to these render traits. Traits are not equal if one of the following conditions fails: The enable flags are equal; The background flags are equal; Fog colors are equal; Near and far distances are equal; Near and far percentages are equal; Either both object have environment maps absent or have the same environment maps;

Parameters

data2

[in] Traits to compare.

Returns

true if traits are not equal, false otherwise.

Definition at line 1452 of file GiEnvironmentTraitsData.h.

operator==()

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

inline

Checks whether the passed traits for render environment traits are equal to these render traits. Traits are considered equal if: The enable flags are equal; The background flags are equal; Fog colors are equal; Near and far distances are equal; Near and far percentages are equal; Either both object have environment maps absent or have the same environment maps;

Parameters

data2

[in] Traits to compare.

Returns

true if traits are equal, false otherwise.

Definition at line 1424 of file GiEnvironmentTraitsData.h.

setEnable()

void OdGiRenderEnvironmentTraitsData::setEnable ( bool bEnable )

inline

Enables or disables the fog rendering.

Parameters

bEnable

[in] Flag that specifies whether to enable fog rendering.

Definition at line 1287 of file GiEnvironmentTraitsData.h.

setEnvironmentMap()

void OdGiRenderEnvironmentTraitsData::setEnvironmentMap ( const OdGiMaterialTexture * map )

inline

Sets the environment map.

Parameters

m	[in] Pointer to the environment map.

Definition at line 1392 of file GiEnvironmentTraitsData.h.

setFarDistance()

void OdGiRenderEnvironmentTraitsData::setFarDistance ( double farDist )

inline

Specifies far distance for the fog rendering.

Parameters

farDist

[in] Far distance of the fog.

Definition at line 1347 of file GiEnvironmentTraitsData.h.

setFarPercentage()

void OdGiRenderEnvironmentTraitsData::setFarPercentage ( double farPct )

inline

Specifies far percentage of the fog.

Parameters

farPct

[in] Far percentage of the fog.

Definition at line 1377 of file GiEnvironmentTraitsData.h.

setFogColor()

void OdGiRenderEnvironmentTraitsData::setFogColor ( const OdCmEntityColor & color )

inline

Sets background color.

Parameters

color

[in] Fog color.

Definition at line 1317 of file GiEnvironmentTraitsData.h.

setIsBackground()

void OdGiRenderEnvironmentTraitsData::setIsBackground ( bool bEnable )

inline

Specifies whether fog should be treated as a background.

Parameters

bEnable

[in] Flag that specifies whether to treat fog as background.

Definition at line 1302 of file GiEnvironmentTraitsData.h.

setNearDistance()

void OdGiRenderEnvironmentTraitsData::setNearDistance ( double nearDist )

inline

Specifies near distance for the fog rendering.

Parameters

nearDist

[in] Near distance of the fog.

Definition at line 1332 of file GiEnvironmentTraitsData.h.

setNearPercentage()

void OdGiRenderEnvironmentTraitsData::setNearPercentage ( double nearPct )

inline

Specifies near percentage of the fog.

Parameters

nearPct

[in] Near percentage of the fog.

Definition at line 1362 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h