OdGiGroundPlaneBackgroundTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiGroundPlaneBackgroundTraitsData:

Public Member Functions
	OdGiGroundPlaneBackgroundTraitsData ()
OdCmEntityColor	colorSkyZenith () const
void	setColorSkyZenith (const OdCmEntityColor &color)
OdCmEntityColor	colorSkyHorizon () const
void	setColorSkyHorizon (const OdCmEntityColor &color)
OdCmEntityColor	colorUndergroundHorizon () const
void	setColorUndergroundHorizon (const OdCmEntityColor &color)
OdCmEntityColor	colorUndergroundAzimuth () const
void	setColorUndergroundAzimuth (const OdCmEntityColor &color)
OdCmEntityColor	colorGroundPlaneNear () const
void	setColorGroundPlaneNear (const OdCmEntityColor &color)
OdCmEntityColor	colorGroundPlaneFar () const
void	setColorGroundPlaneFar (const OdCmEntityColor &color)
bool	operator== (const OdGiGroundPlaneBackgroundTraitsData &data2) const
bool	operator!= (const OdGiGroundPlaneBackgroundTraitsData &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 546 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiGroundPlaneBackgroundTraitsData()

OdGiGroundPlaneBackgroundTraitsData::OdGiGroundPlaneBackgroundTraitsData ( )

inline

Default constructor for the OdGiGroundPlaneBackgroundTraitsData class. Sets the OdGiDrawable::kGroundPlaneBackground type for this object.

Definition at line 560 of file GiEnvironmentTraitsData.h.

Member Function Documentation

colorGroundPlaneFar()

OdCmEntityColor OdGiGroundPlaneBackgroundTraitsData::colorGroundPlaneFar ( ) const

inline

Retrieves a color of the far ground plane.

Returns

color of the far ground plane as OdCmEntityColor instance.

Definition at line 644 of file GiEnvironmentTraitsData.h.

colorGroundPlaneNear()

OdCmEntityColor OdGiGroundPlaneBackgroundTraitsData::colorGroundPlaneNear ( ) const

inline

Retrieves a color of the near ground plane.

Returns

color of the near ground plane as OdCmEntityColor instance.

Definition at line 629 of file GiEnvironmentTraitsData.h.

colorSkyHorizon()

OdCmEntityColor OdGiGroundPlaneBackgroundTraitsData::colorSkyHorizon ( ) const

inline

Retrieves a color of the sky horizon.

Returns

color of sky horizon as OdCmEntityColor instance.

Definition at line 584 of file GiEnvironmentTraitsData.h.

colorSkyZenith()

OdCmEntityColor OdGiGroundPlaneBackgroundTraitsData::colorSkyZenith ( ) const

inline

Retrieves a color of the sky zenith.

Returns

color of sky zenith as OdCmEntityColor instance.

Definition at line 569 of file GiEnvironmentTraitsData.h.

colorUndergroundAzimuth()

OdCmEntityColor OdGiGroundPlaneBackgroundTraitsData::colorUndergroundAzimuth ( ) const

inline

Retrieves a color of the underground azimuth.

Returns

color of underground azimuth as OdCmEntityColor instance.

Definition at line 614 of file GiEnvironmentTraitsData.h.

colorUndergroundHorizon()

OdCmEntityColor OdGiGroundPlaneBackgroundTraitsData::colorUndergroundHorizon ( ) const

inline

Retrieves a color of the underground horizon.

Returns

color of underground horizon as OdCmEntityColor instance.

Definition at line 599 of file GiEnvironmentTraitsData.h.

operator!=()

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

inline

Checks whether the passed traits for ground plane backgrounds are not equal to these traits. Traits are not equal if one of the following conditions fails: Colors of sky zeniths are equal; Colors of sky horizons are equal; Colors of underground horizons are equal; Colors of underground azimuths are equal; Colors of near ground planes are equal; Colors of far ground planes are equal;

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are not equal, false otherwise.

Definition at line 694 of file GiEnvironmentTraitsData.h.

operator==()

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

inline

Checks whether the passed traits for ground plane backgrounds are equal to these traits. Traits are considered equal if: Colors of sky zeniths are equal; Colors of sky horizons are equal; Colors of underground horizons are equal; Colors of underground azimuths are equal; Colors of near ground planes are equal; Colors of far ground planes are equal;

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are equal, false otherwise.

Definition at line 668 of file GiEnvironmentTraitsData.h.

setColorGroundPlaneFar()

void OdGiGroundPlaneBackgroundTraitsData::setColorGroundPlaneFar ( const OdCmEntityColor & color )

inline

Specifies a color of the far ground plane.

Parameters

color

[in] Color of the far ground plane.

Definition at line 651 of file GiEnvironmentTraitsData.h.

setColorGroundPlaneNear()

void OdGiGroundPlaneBackgroundTraitsData::setColorGroundPlaneNear ( const OdCmEntityColor & color )

inline

Specifies a color of the near ground plane.

Parameters

color

[in] Color of the near ground plane.

Definition at line 636 of file GiEnvironmentTraitsData.h.

setColorSkyHorizon()

void OdGiGroundPlaneBackgroundTraitsData::setColorSkyHorizon ( const OdCmEntityColor & color )

inline

Specifies a color of the sky horizon.

Parameters

color

[in] Color of the sky horizon.

Definition at line 591 of file GiEnvironmentTraitsData.h.

setColorSkyZenith()

void OdGiGroundPlaneBackgroundTraitsData::setColorSkyZenith ( const OdCmEntityColor & color )

inline

Specifies a color of the sky zenith.

Parameters

color

[in] Color of the sky zenith.

Definition at line 576 of file GiEnvironmentTraitsData.h.

setColorUndergroundAzimuth()

void OdGiGroundPlaneBackgroundTraitsData::setColorUndergroundAzimuth ( const OdCmEntityColor & color )

inline

Specifies a color of the underground azimuth.

Parameters

color

[in] Color of the underground azimuth.

Definition at line 621 of file GiEnvironmentTraitsData.h.

setColorUndergroundHorizon()

void OdGiGroundPlaneBackgroundTraitsData::setColorUndergroundHorizon ( const OdCmEntityColor & color )

inline

Specifies a color of the underground horizon.

Parameters

color

[in] Color of the underground horizon.

Definition at line 606 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h