OdGiIBLBackgroundTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiIBLBackgroundTraitsData:

Public Member Functions
	OdGiIBLBackgroundTraitsData ()
bool	isEnabled () const
void	enable (bool bSet)
const OdString &	IBLFileName () const
void	setIBLFileName (const OdString &iblFileName)
double	rotation () const
void	setRotation (double angle)
bool	displayImage () const
void	setDisplayImage (bool bSet)
OdDbStub *	secondaryBackground () const
void	setSecondaryBackground (OdDbStub *secBkgndId)
bool	operator== (const OdGiIBLBackgroundTraitsData &data2) const
bool	operator!= (const OdGiIBLBackgroundTraitsData &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 878 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

OdGiIBLBackgroundTraitsData()

OdGiIBLBackgroundTraitsData::OdGiIBLBackgroundTraitsData ( )

inline

Default constructor for the OdGiIBLBackgroundTraitsData class. Sets the OdGiDrawable::kImageBasedLightingBackground type for this object.

Definition at line 892 of file GiEnvironmentTraitsData.h.

Member Function Documentation

displayImage()

bool OdGiIBLBackgroundTraitsData::displayImage ( ) const

inline

Checks whether the IBL image is displayed as the background.

Returns

true if the IBL image is displayed as the background, false otherwise.

Definition at line 950 of file GiEnvironmentTraitsData.h.

enable()

void OdGiIBLBackgroundTraitsData::enable ( bool bSet )

inline

Specifies whether image-based lighting background should be enabled.

Parameters

bSet	[in] Flag that specifies whether to activate IBL.

Definition at line 912 of file GiEnvironmentTraitsData.h.

IBLFileName()

const OdString & OdGiIBLBackgroundTraitsData::IBLFileName ( ) const

inline

Retrieves image file name for this image-based lighting background.

Returns

full path to an image file.

Definition at line 920 of file GiEnvironmentTraitsData.h.

isEnabled()

bool OdGiIBLBackgroundTraitsData::isEnabled ( ) const

inline

Checks whether image-based lighting is enabled.

Returns

true if image-based lighting is enabled, false otherwise.

Definition at line 905 of file GiEnvironmentTraitsData.h.

operator!=()

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

inline

Checks whether the passed traits for image-based lighting backgrounds are not equal to these traits. Traits are not equal if one of the following conditions fails: Image-based background lighting enable flags are equal; Full file paths are equal; Rotation values are equal; Display flags are equal; Secondary background identifiers are equal;

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are not equal, false otherwise.

Definition at line 1012 of file GiEnvironmentTraitsData.h.

operator==()

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

inline

Checks whether the passed traits for image-based lighting backgrounds are equal to these traits. Traits are considered equal if: Image-based background lighting enable flags are equal; Full file paths are equal; Rotation values are equal; Display flags are equal; Secondary background identifiers are equal;

Parameters

data2

[in] Background traits to compare.

Returns

true if background traits are equal, false otherwise.

Definition at line 988 of file GiEnvironmentTraitsData.h.

rotation()

double OdGiIBLBackgroundTraitsData::rotation ( ) const

inline

Retrieves rotation value for the IBL image.

Returns

rotation value for the IBL image in degrees.

Definition at line 935 of file GiEnvironmentTraitsData.h.

secondaryBackground()

OdDbStub * OdGiIBLBackgroundTraitsData::secondaryBackground ( ) const

inline

Retrieves a background identifier of a secondary background.

Returns

Pointer to an identifier of a secondary background.

Definition at line 965 of file GiEnvironmentTraitsData.h.

setDisplayImage()

void OdGiIBLBackgroundTraitsData::setDisplayImage ( bool bSet )

inline

Specifies whether to display the IBL image as the background.

Parameters

bSet	[in] Flag that specifies whether to display IBL image as a background.

Definition at line 957 of file GiEnvironmentTraitsData.h.

setIBLFileName()

void OdGiIBLBackgroundTraitsData::setIBLFileName ( const OdString & iblFileName )

inline

Specifies image file name for the image-based lighting background.

Parameters

iblFileName

[in] Full path to an image file.

Definition at line 927 of file GiEnvironmentTraitsData.h.

setRotation()

void OdGiIBLBackgroundTraitsData::setRotation ( double angle )

inline

Specifies rotation value for the IBL image in range [-180..180].

Parameters

angle

[in] Rotation value in degrees.

Definition at line 942 of file GiEnvironmentTraitsData.h.

setSecondaryBackground()

void OdGiIBLBackgroundTraitsData::setSecondaryBackground ( OdDbStub * secBkgndId )

inline

Specifies a background to display when false is passed to the DisplayImage() method.

Parameters

secBkgndId

[in] Pointer to a background identifier.

Definition at line 972 of file GiEnvironmentTraitsData.h.

---

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

• GiEnvironmentTraitsData.h