#include <GiLightTraits.h>

Public Member Functions
	OdGiSkyParameters ()

bool	operator== (const OdGiSkyParameters &params) const

void	setIllumination (bool enable)

bool	illumination () const

void	setIntensityFactor (double intensity)

double	intensityFactor () const

void	setHaze (double haze)

double	haze () const

void	setHorizonHeight (double height)

double	horizonHeight () const

void	setHorizonBlur (double blur)

double	horizonBlur () const

void	setGroundColor (const OdCmEntityColor &color)

OdCmEntityColor	groundColor () const

void	setNightColor (const OdCmEntityColor &color)

OdCmEntityColor	nightColor () const

void	setAerialPerspective (bool apply)

bool	aerialPerspective () const

void	setVisibilityDistance (double distance)

double	visibilityDistance () const

void	setDiskScale (double scale)

double	diskScale () const

void	setGlowIntensity (double intensity)

double	glowIntensity () const

void	setDiskIntensity (double intensity)

double	diskIntensity () const

void	setSolarDiskSamples (OdUInt16 samples)

OdUInt16	solarDiskSamples () const

void	setSunDirection (const OdGeVector3d &sundir)

const OdGeVector3d &	sunDirection () const

void	setRedBlueShift (double redBlueShift)

double	redBlueShift () const

void	setSaturation (double saturation)

double	saturation () const

Detailed Description

This class contains all sky properties for OdDbSun objects.

See also: TD_Gi

Definition at line 901 of file GiLightTraits.h.

Constructor & Destructor Documentation

◆ OdGiSkyParameters()

OdGiSkyParameters::OdGiSkyParameters ( )

inline

Default constructor for the OdGiSkyParameters class. Initializes the following data members:

Data member Value Description m_status false Flag that shows if sky illumination is enabled. m_intensityFactor 1 Intensity factor for the sky illumination. m_haze 0.0 Turbulence of the atmosphere. m_horizonHeight 0.0 WCS height of the horizon plane. m_horizonBlur 0.1 Amount of blur between ground plane and sky. m_aerialPerspective false Flag that shows if aerial perspective is applied. m_visibilityDistance 10000.0 Distance at which 10% haze occlusion results. m_diskScale 4.0 Sun disk scale. m_glowIntensity 1.0 Intensity of the sun glow. m_diskIntensity 1.0 Intensity of the sun disk. m_solarDiskSamples 8 Number of samples for the solar disk. m_redBlueShift 0.0 Red-blue shift value for the sky. m_saturation 1.0 Sky saturation level. m_groundColor 0xc2808080 Color of the ground plane. m_nightColor 0xc2010205 Color of the night sky. m_sunDirection (0.35, 1.0, -0.25) Sun direction vector.

Definition at line 1228 of file GiLightTraits.h.

Member Function Documentation

◆ aerialPerspective()

bool OdGiSkyParameters::aerialPerspective ( ) const

inline

Checks whether aerial perspective should be applied.

Returns: true if aerial perspective is applied, false otherwise.

Definition at line 1329 of file GiLightTraits.h.

◆ diskIntensity()

double OdGiSkyParameters::diskIntensity ( ) const

inline

Retrieves intensity of the sun disk.

Returns: intensity of the sun disk as a value of the double value.

Definition at line 1361 of file GiLightTraits.h.

◆ diskScale()

double OdGiSkyParameters::diskScale ( ) const

inline

Retrieves scale of the sun disk.

Returns: disk scale of the sun as a value of the double value.

Definition at line 1345 of file GiLightTraits.h.

◆ glowIntensity()

double OdGiSkyParameters::glowIntensity ( ) const

inline

Retrieves intensity of the sun glow.

Returns: intensity of the sun glow as a value of the double value.

Definition at line 1353 of file GiLightTraits.h.

◆ groundColor()

OdCmEntityColor OdGiSkyParameters::groundColor ( ) const

inline

Retrieves the color of the ground plane.

Returns: color of the ground plane as OdCmEntityColor instance.

Definition at line 1313 of file GiLightTraits.h.

◆ haze()

double OdGiSkyParameters::haze ( ) const

inline

Retrieves the turbulence value of the atmosphere.

Returns: turbulence of the atmosphere as a value of the double type.

Definition at line 1289 of file GiLightTraits.h.

◆ horizonBlur()

double OdGiSkyParameters::horizonBlur ( ) const

inline

Retrieves the amount of blur between ground plane and sky.

Returns: amount of blur between ground plane and sky.

Definition at line 1305 of file GiLightTraits.h.

◆ horizonHeight()

double OdGiSkyParameters::horizonHeight ( ) const

inline

Retrieves the height of the horizon plane.

Returns: the height of the horizon plane in the world-space.

Definition at line 1297 of file GiLightTraits.h.

◆ illumination()

bool OdGiSkyParameters::illumination ( ) const

inline

Checks whether sky illumination is enabled.

Returns: true if sky illumination is enabled, false otherwise.

Definition at line 1273 of file GiLightTraits.h.

◆ intensityFactor()

double OdGiSkyParameters::intensityFactor ( ) const

inline

Retrieves intensity factor for the sky illumination.

Returns: intensity factor for the sky illumination as a value of the double type.

Definition at line 1281 of file GiLightTraits.h.

◆ nightColor()

OdCmEntityColor OdGiSkyParameters::nightColor ( ) const

inline

Retrieves the color of the night sky.

Returns: color of the ground plane as OdCmEntityColor instance.

Definition at line 1321 of file GiLightTraits.h.

◆ operator==()

bool OdGiSkyParameters::operator== ( const OdGiSkyParameters & params ) const

inline

Equality operator for the OdGiSkyParameters class.

Parameters

params [in] Parameters to be compared.

Returns: true if these sky parameters are equal to the passed parameters, false otherwise.

Definition at line 1248 of file GiLightTraits.h.

◆ redBlueShift()

double OdGiSkyParameters::redBlueShift ( ) const

inline

Retrieves a value that shows how much a color of the sky is shifted to red or blue.

Returns: a value in [-1..1] range where -1 represents a maximum shift to blue sky and 1 represents a maximum shift to red sky.

Definition at line 1385 of file GiLightTraits.h.

◆ saturation()

double OdGiSkyParameters::saturation ( ) const

inline

Retrieves sky saturation value.

Returns: sky saturation as value of the double type.

Definition at line 1393 of file GiLightTraits.h.

◆ setAerialPerspective()

void OdGiSkyParameters::setAerialPerspective ( bool apply )

inline

Specifies whether aerial perspective should be applied.

Parameters

apply [in] Flag that specifies whether aerial perspective should be applied.

Definition at line 1325 of file GiLightTraits.h.

◆ setDiskIntensity()

void OdGiSkyParameters::setDiskIntensity ( double intensity )

inline

Specifies intensity of the sun disk.

Parameters

intensity [in] Intensity of the sun disk.

Definition at line 1357 of file GiLightTraits.h.

◆ setDiskScale()

void OdGiSkyParameters::setDiskScale ( double scale )

inline

Specifies disk scale of sun.

Parameters

scale [in] Scale of the sun disk.

Definition at line 1341 of file GiLightTraits.h.

◆ setGlowIntensity()

void OdGiSkyParameters::setGlowIntensity ( double intensity )

inline

Specifies intensity of the sun glow.

Parameters

intensity [in] Intensity of the sun glow.

Definition at line 1349 of file GiLightTraits.h.

◆ setGroundColor()

void OdGiSkyParameters::setGroundColor ( const OdCmEntityColor & color )

inline

Specifies the color of the ground plane.

Parameters

color [in] Color of the ground plane.

Definition at line 1309 of file GiLightTraits.h.

◆ setHaze()

void OdGiSkyParameters::setHaze ( double haze )

inline

Specifies the turbulence of the atmosphere.

Parameters

haze	[in] Turbulence of the atmosphere.

Definition at line 1285 of file GiLightTraits.h.

◆ setHorizonBlur()

void OdGiSkyParameters::setHorizonBlur ( double blur )

inline

Specifies the amount of blur between ground plane and sky.

Parameters

blur	[in] The amount of blurring between ground plane and sky.

Definition at line 1301 of file GiLightTraits.h.

◆ setHorizonHeight()

void OdGiSkyParameters::setHorizonHeight ( double height )

inline

Specifies the height of the horizon plane.

Parameters

height [in] The world-space height of the horizon plane.

Definition at line 1293 of file GiLightTraits.h.

◆ setIllumination()

void OdGiSkyParameters::setIllumination ( bool enable )

inline

Specifies whether sky illumination should be enabled.

Parameters

enable [in] Flag that specifies whether sky illumination should be enabled.

Definition at line 1269 of file GiLightTraits.h.

◆ setIntensityFactor()

void OdGiSkyParameters::setIntensityFactor ( double intensity )

inline

Specifies intensity factor for the sky illumination.

Parameters

intensity [in] Intensity factor for the sky illumination.

Definition at line 1277 of file GiLightTraits.h.

◆ setNightColor()

void OdGiSkyParameters::setNightColor ( const OdCmEntityColor & color )

inline

Specifies the color of the night sky.

Parameters

color [in] Color of the night sky.

Definition at line 1317 of file GiLightTraits.h.

◆ setRedBlueShift()

void OdGiSkyParameters::setRedBlueShift ( double redBlueShift )

inline

Specifies how much a color of the sky is shifted to red or blue.

Parameters

redBlueShift [in] Value in [-1..1] range where -1 represents a maximum shift to blue sky, while 1 represents a maximum shift to red sky.

Definition at line 1381 of file GiLightTraits.h.

◆ setSaturation()

void OdGiSkyParameters::setSaturation ( double saturation )

inline

Specifies sky saturation.

Parameters

saturation [in] Sky saturation.

Definition at line 1389 of file GiLightTraits.h.

◆ setSolarDiskSamples()

void OdGiSkyParameters::setSolarDiskSamples ( OdUInt16 samples )

inline

Specifies a number of samples for the sun disk.

Parameters

samples [in] Sample quantity for the sun disk.

Definition at line 1365 of file GiLightTraits.h.

◆ setSunDirection()

void OdGiSkyParameters::setSunDirection ( const OdGeVector3d & sundir )

inline

Specifies a direction from the sun to a model.

Parameters

sundir [in] Vector that specifies the direction from the sun to a model.

Definition at line 1373 of file GiLightTraits.h.

◆ setVisibilityDistance()

void OdGiSkyParameters::setVisibilityDistance ( double distance )

inline

Specifies visibility haze distance.

Parameters

distance [in] Distance at which 10% haze occlusion results.

Definition at line 1333 of file GiLightTraits.h.

◆ solarDiskSamples()

OdUInt16 OdGiSkyParameters::solarDiskSamples ( ) const

inline

Retrieves a number of samples for the sun disk.

Returns: sample quantity for the sun disk as a value of the double type.

Definition at line 1369 of file GiLightTraits.h.

◆ sunDirection()

const OdGeVector3d & OdGiSkyParameters::sunDirection ( ) const

inline

Retrieves a direction from the sun to a model.

Returns: a vector that specifies the direction from the sun to a model.

Definition at line 1377 of file GiLightTraits.h.

◆ visibilityDistance()

double OdGiSkyParameters::visibilityDistance ( ) const

inline

Retrieves visibility haze distance.

Returns: distance at which 10% haze occlusion results.

Definition at line 1337 of file GiLightTraits.h.

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

GiLightTraits.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OdGiSkyParameters()

Member Function Documentation

◆ aerialPerspective()

◆ diskIntensity()

◆ diskScale()

◆ glowIntensity()

◆ groundColor()

◆ haze()

◆ horizonBlur()

◆ horizonHeight()

◆ illumination()

◆ intensityFactor()

◆ nightColor()

◆ operator==()

◆ redBlueShift()

◆ saturation()

◆ setAerialPerspective()

◆ setDiskIntensity()

◆ setDiskScale()

◆ setGlowIntensity()

◆ setGroundColor()

◆ setHaze()

◆ setHorizonBlur()

◆ setHorizonHeight()

◆ setIllumination()

◆ setIntensityFactor()

◆ setNightColor()

◆ setRedBlueShift()

◆ setSaturation()

◆ setSolarDiskSamples()

◆ setSunDirection()

◆ setVisibilityDistance()

◆ solarDiskSamples()

◆ sunDirection()

◆ visibilityDistance()