OdGiRenderEnvironmentTraits Class Reference

#include <GiEnvironment.h>

Inheritance diagram for OdGiRenderEnvironmentTraits:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiRenderEnvironmentTraits)
virtual void	setEnable (bool bEnable)=0
virtual bool	enable () const =0
virtual void	setIsBackground (bool bEnable)=0
virtual bool	isBackground () const =0
virtual void	setFogColor (const OdCmEntityColor &color)=0
virtual OdCmEntityColor	fogColor () const =0
virtual void	setNearDistance (double nearDist)=0
virtual double	nearDistance () const =0
virtual void	setFarDistance (double farDist)=0
virtual double	farDistance () const =0
virtual void	setNearPercentage (double nearPct)=0
virtual double	nearPercentage () const =0
virtual void	setFarPercentage (double farPct)=0
virtual double	farPercentage () const =0
virtual void	setEnvironmentMap (const OdGiMaterialTexture *m)=0
virtual OdGiMaterialTexture *	environmentMap () 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

Represents the render environment which is fog and environment map in the display system.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 38 of file GiEnvironment.h.

Member Function Documentation

enable()

virtual bool OdGiRenderEnvironmentTraits::enable ( ) const

pure virtual

Checks whether fog rendering is enabled.

Returns

true if fog rendering is enabled, false otherwise.

environmentMap()

virtual OdGiMaterialTexture * OdGiRenderEnvironmentTraits::environmentMap ( ) const

pure virtual

Retrieves the environment map.

Returns

pointer to the OdGiMaterialTexture instance that represents environment map.

farDistance()

virtual double OdGiRenderEnvironmentTraits::farDistance ( ) const

pure virtual

Retrieves far distance of fog rendering.

Returns

fog rendering far distance.

farPercentage()

virtual double OdGiRenderEnvironmentTraits::farPercentage ( ) const

pure virtual

Retrieves far percentage of the fog.

Returns

far percentage of the fog.

fogColor()

virtual OdCmEntityColor OdGiRenderEnvironmentTraits::fogColor ( ) const

pure virtual

Retrieves fog color.

Returns

fog color as OdCmEntityColor instance.

isBackground()

virtual bool OdGiRenderEnvironmentTraits::isBackground ( ) const

pure virtual

Checks whether fog is treated background.

Returns

true if fog is treated as background, false otherwise.

nearDistance()

virtual double OdGiRenderEnvironmentTraits::nearDistance ( ) const

pure virtual

Retrieves near distance of fog rendering.

Returns

fog rendering near distance.

nearPercentage()

virtual double OdGiRenderEnvironmentTraits::nearPercentage ( ) const

pure virtual

Retrieves near percentage of the fog.

Returns

near percentage of the fog.

ODRX_DECLARE_MEMBERS()

OdGiRenderEnvironmentTraits::ODRX_DECLARE_MEMBERS

(

OdGiRenderEnvironmentTraits

)

setEnable()

virtual void OdGiRenderEnvironmentTraits::setEnable ( bool  bEnable )

pure virtual

Enables or disables the fog rendering.

Parameters

bEnable

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

setEnvironmentMap()

virtual void OdGiRenderEnvironmentTraits::setEnvironmentMap ( const OdGiMaterialTexture *  m )

pure virtual

Sets the environment map.

Parameters

m	[in] Pointer to the environment map.

setFarDistance()

virtual void OdGiRenderEnvironmentTraits::setFarDistance ( double  farDist )

pure virtual

Specifies far distance for the fog rendering.

Parameters

farDist

[in] Far distance of the fog.

setFarPercentage()

virtual void OdGiRenderEnvironmentTraits::setFarPercentage ( double  farPct )

pure virtual

Specifies far percentage of the fog.

Parameters

farPct

[in] Far percentage of the fog.

setFogColor()

virtual void OdGiRenderEnvironmentTraits::setFogColor ( const OdCmEntityColor &  color )

pure virtual

Sets background color.

Parameters

color

[in] Fog color.

setIsBackground()

virtual void OdGiRenderEnvironmentTraits::setIsBackground ( bool  bEnable )

pure virtual

Specifies whether fog should be treated as a background.

Parameters

bEnable

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

setNearDistance()

virtual void OdGiRenderEnvironmentTraits::setNearDistance ( double  nearDist )

pure virtual

Specifies near distance for the fog rendering.

Parameters

nearDist

[in] Near distance of the fog.

setNearPercentage()

virtual void OdGiRenderEnvironmentTraits::setNearPercentage ( double  nearPct )

pure virtual

Specifies near percentage of the fog.

Parameters

nearPct

[in] Near percentage of the fog.

---

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

• GiEnvironment.h