CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdGiEnvironmentBackgroundTraits Class Referenceabstract

#include <GiEnvironment.h>

Inheritance diagram for OdGiEnvironmentBackgroundTraits:
OdGiDrawableTraits OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiEnvironmentBackgroundTraits)
 
virtual void setRotation (double longRad, double latRad)=0
 
virtual double longitudeRotation () const =0
 
virtual double latitudeRotation () const =0
 
virtual void enableFovOverride (bool bEnable)=0
 
virtual bool fovOverride () const =0
 
virtual void setFovOverrideAngle (double fovRad)=0
 
virtual double fovOverrideAngle () 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

This class allows Gi classes to implement environment map backgrounds.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1811 of file GiEnvironment.h.

Member Function Documentation

◆ enableFovOverride()

virtual void OdGiEnvironmentBackgroundTraits::enableFovOverride ( bool bEnable)
pure virtual

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.

◆ fovOverride()

virtual bool OdGiEnvironmentBackgroundTraits::fovOverride ( ) const
pure virtual

Returns field of view angle override state.

Returns
Field of view angle override state.

◆ fovOverrideAngle()

virtual double OdGiEnvironmentBackgroundTraits::fovOverrideAngle ( ) const
pure virtual

Returns field of view override angle.

Returns
Field of view override angle.

◆ latitudeRotation()

virtual double OdGiEnvironmentBackgroundTraits::latitudeRotation ( ) const
pure virtual

Retrieves latitude rotation angle in radians.

Returns
Latitude rotation angle in radians.

◆ longitudeRotation()

virtual double OdGiEnvironmentBackgroundTraits::longitudeRotation ( ) const
pure virtual

Retrieves longitude rotation angle in radians.

Returns
Longitude rotation angle in radians.

◆ ODRX_DECLARE_MEMBERS()

OdGiEnvironmentBackgroundTraits::ODRX_DECLARE_MEMBERS ( OdGiEnvironmentBackgroundTraits )

◆ setFovOverrideAngle()

virtual void OdGiEnvironmentBackgroundTraits::setFovOverrideAngle ( double fovRad)
pure virtual

Sets field of view override angle.

Parameters
fovRad[in] Field of view override angle in radians.

◆ setRotation()

virtual void OdGiEnvironmentBackgroundTraits::setRotation ( double longRad,
double latRad )
pure virtual

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).

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