OdGiEnvironmentBackgroundTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiEnvironmentBackgroundTraitsData:

Public Member Functions
	OdGiEnvironmentBackgroundTraitsData ()
void	setRotation (double longRad, double latRad)
double	longitudeRotation () const
double	latitudeRotation () const
void	enableFovOverride (bool bEnable)
bool	fovOverride () const
void	setFovOverrideAngle (double fovRad)
double	fovOverrideAngle () const
bool	operator== (const OdGiEnvironmentBackgroundTraitsData &data2) const
bool	operator!= (const OdGiEnvironmentBackgroundTraitsData &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 1022 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiEnvironmentBackgroundTraitsData()

OdGiEnvironmentBackgroundTraitsData::OdGiEnvironmentBackgroundTraitsData ( )

inline

Default constructor for the OdGiEnvironmentBackgroundTraitsData class. Sets the OdGiDrawable::kEnvironmentBackground type for this object.

Definition at line 1033 of file GiEnvironmentTraitsData.h.

Member Function Documentation

enableFovOverride()

void OdGiEnvironmentBackgroundTraitsData::enableFovOverride ( bool bEnable )

inline

Enables or disables field of view angle override.

Parameters

bEnable

[in] New field of view angle override state.

Remarks

By default field of view angle override is disabled.

Definition at line 1081 of file GiEnvironmentTraitsData.h.

fovOverride()

bool OdGiEnvironmentBackgroundTraitsData::fovOverride ( ) const

inline

Returns field of view angle override state.

Returns

Field of view angle override state.

Definition at line 1092 of file GiEnvironmentTraitsData.h.

fovOverrideAngle()

double OdGiEnvironmentBackgroundTraitsData::fovOverrideAngle ( ) const

inline

Returns field of view override angle.

Returns

Field of view override angle.

Definition at line 1113 of file GiEnvironmentTraitsData.h.

latitudeRotation()

double OdGiEnvironmentBackgroundTraitsData::latitudeRotation ( ) const

inline

Retrieves latitude rotation angle in radians.

Returns

Latitude rotation angle in radians.

Definition at line 1068 of file GiEnvironmentTraitsData.h.

longitudeRotation()

double OdGiEnvironmentBackgroundTraitsData::longitudeRotation ( ) const

inline

Retrieves longitude rotation angle in radians.

Returns

Longitude rotation angle in radians.

Definition at line 1057 of file GiEnvironmentTraitsData.h.

operator!=()

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

inline

Checks whether the passed traits for environment backgrounds are not equal to these traits.

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are not equal, false otherwise.

Definition at line 1141 of file GiEnvironmentTraitsData.h.

operator==()

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

inline

Checks whether the passed traits for environment backgrounds are equal to these traits.

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are equal, false otherwise.

Definition at line 1126 of file GiEnvironmentTraitsData.h.

setFovOverrideAngle()

void OdGiEnvironmentBackgroundTraitsData::setFovOverrideAngle ( double fovRad )

inline

Sets field of view override angle.

Parameters

fovRad

[in] Field of view override angle in radians.

Definition at line 1102 of file GiEnvironmentTraitsData.h.

setRotation()

void OdGiEnvironmentBackgroundTraitsData::setRotation ( double longRad, double latRad )

inline

Specifies longitude and latitude background rotation angles.

Parameters

longRad	[in] Longitude rotation angle in radians.
latRad	[in] Latitude rotation angle in radians.

Remarks

Default rotation angles set to zeroes (no rotation).

Definition at line 1045 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h