OdGiIBLBackgroundTraits Class Reference

#include <GiEnvironment.h>

Inheritance diagram for OdGiIBLBackgroundTraits:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiIBLBackgroundTraits)
virtual void	setEnable (bool bEnable)=0
virtual bool	enable () const =0
virtual void	setIBLImageName (const OdString &filename)=0
virtual const OdString &	IBLImageName () const =0
virtual void	setRotation (double rotation)=0
virtual double	rotation () const =0
virtual void	setDisplayImage (bool bDisplay)=0
virtual bool	displayImage () const =0
virtual void	setSecondaryBackground (OdDbStub *bgId)=0
virtual OdDbStub *	secondaryBackground () const =0
Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class allows Gi classes to implement image base lighting backgrounds.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1707 of file GiEnvironment.h.

Member Function Documentation

displayImage()

virtual bool OdGiIBLBackgroundTraits::displayImage ( ) const

pure virtual

Checks whether the IBL image is displayed as the background.

Returns

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

enable()

virtual bool OdGiIBLBackgroundTraits::enable ( ) const

pure virtual

Checks whether image-based lighting is enabled.

Returns

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

IBLImageName()

virtual const OdString & OdGiIBLBackgroundTraits::IBLImageName ( ) const

pure virtual

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

Returns

full path to an image file.

ODRX_DECLARE_MEMBERS()

OdGiIBLBackgroundTraits::ODRX_DECLARE_MEMBERS

(

OdGiIBLBackgroundTraits

)

rotation()

virtual double OdGiIBLBackgroundTraits::rotation ( ) const

pure virtual

Retrieves rotation value for the IBL image.

Returns

rotation value for the IBL image in degrees.

secondaryBackground()

virtual OdDbStub * OdGiIBLBackgroundTraits::secondaryBackground ( ) const

pure virtual

Retrieves a background identifier of a secondary background.

Returns

Pointer to an identifier of a secondary background.

setDisplayImage()

virtual void OdGiIBLBackgroundTraits::setDisplayImage ( bool  bDisplay )

pure virtual

Specifies whether to display the IBL image as the background.

Parameters

bDisplay

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

setEnable()

virtual void OdGiIBLBackgroundTraits::setEnable ( bool  bEnable )

pure virtual

Specifies whether image-based lighting background should be enabled.

Parameters

bEnable

[in] Flag that specifies whether to activate IBL.

setIBLImageName()

virtual void OdGiIBLBackgroundTraits::setIBLImageName ( const OdString &  filename )

pure virtual

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

Parameters

filename

[in] Full path to an image file.

setRotation()

virtual void OdGiIBLBackgroundTraits::setRotation ( double  rotation )

pure virtual

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

Parameters

rotation

[in] Rotation value in degrees.

setSecondaryBackground()

virtual void OdGiIBLBackgroundTraits::setSecondaryBackground ( OdDbStub *  bgId )

pure virtual

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

Parameters

bgId	[in] Pointer to a background identifier.

---

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

• GiEnvironment.h