OdGiSkyBackgroundTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiSkyBackgroundTraitsData:

Public Member Functions
	OdGiSkyBackgroundTraitsData ()
void	skyParameters (OdGiSkyParameters &params) const
void	setSkyParameters (const OdGiSkyParameters &params)
bool	operator== (const OdGiSkyBackgroundTraitsData &data2) const
bool	operator!= (const OdGiSkyBackgroundTraitsData &data2) const
Public Member Functions inherited from OdGiBackgroundTraitsData
OdGiDrawable::DrawableType	type () const
bool	operator== (const OdGiBackgroundTraitsData &data2) const
bool	operator!= (const OdGiBackgroundTraitsData &data2) const

Additional Inherited Members
Static Public Member Functions inherited from OdGiBackgroundTraitsData
static void	deleteBackgroundTraitsData (OdGiBackgroundTraitsData *pBackgroundTraits)
Protected Member Functions inherited from OdGiBackgroundTraitsData
	OdGiBackgroundTraitsData ()
Protected Attributes inherited from OdGiBackgroundTraitsData
OdGiDrawable::DrawableType	m_type

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 698 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiSkyBackgroundTraitsData()

OdGiSkyBackgroundTraitsData::OdGiSkyBackgroundTraitsData ( )

inline

Default constructor for the OdGiSkyBackgroundTraitsData class. Sets the OdGiDrawable::kSkyBackground type for this object.

Definition at line 721 of file GiEnvironmentTraitsData.h.

Member Function Documentation

operator!=()

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

inline

Checks whether the passed traits for sky backgrounds are not equal to these traits. Traits are not equal if one of the following conditions fails: Statuses are equal; Intensity factors are equal; Haze (or turbulence) values are equal; Horizon heights are equal; Horizon blur values are equal; Ground colors are equal. Night colors are equal. Aerial perspective flags are equal. Visibility distances are equal. Sun disk scales are equal. Sun glow intensity values are equal. Sun disk intensity values are equal. Solar disk samples are equal; Sun direction vectors are equal; The red-blue shift factors are equal; Sky saturation values are equal;

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are not equal, false otherwise.

Definition at line 808 of file GiEnvironmentTraitsData.h.

operator==()

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

inline

Checks whether the passed traits for sky backgrounds are equal to these traits. Traits are considered equal if: Statuses are equal; Intensity factors are equal; Haze (or turbulence) values are equal; Horizon heights are equal; Horizon blur values are equal; Ground colors are equal. Night colors are equal. Aerial perspective flags are equal. Visibility distances are equal. Sun disk scales are equal. Sun glow intensity values are equal. Sun disk intensity values are equal. Solar disk samples are equal; Sun direction vectors are equal; The red-blue shift factors are equal; Sky saturation values are equal;

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are equal, false otherwise.

Definition at line 762 of file GiEnvironmentTraitsData.h.

setSkyParameters()

void OdGiSkyBackgroundTraitsData::setSkyParameters ( const OdGiSkyParameters &  params )

inline

Specifies sky parameters of this background.

Parameters

params

[in] Sky parameters.

Definition at line 834 of file GiEnvironmentTraitsData.h.

skyParameters()

void OdGiSkyBackgroundTraitsData::skyParameters ( OdGiSkyParameters &  params ) const

inline

Retrieves sky parameters of this background.

Parameters

params

[out] Receives sky parameters for this parameters.

Definition at line 814 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h