CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdGiBackgroundTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiBackgroundTraitsData:
OdGiGradientBackgroundTraitsData OdGiGroundPlaneBackgroundTraitsData OdGiIBLBackgroundTraitsData OdGiImageBackgroundTraitsData OdGiSkyBackgroundTraitsData OdGiSolidBackgroundTraitsData

Public Member Functions

OdGiDrawable::DrawableType type () const
 
bool operator== (const OdGiBackgroundTraitsData &data2) const
 
bool operator!= (const OdGiBackgroundTraitsData &data2) const
 

Static Public Member Functions

static void deleteBackgroundTraitsData (OdGiBackgroundTraitsData *pBackgroundTraits)
 

Protected Member Functions

 OdGiBackgroundTraitsData ()
 

Protected Attributes

OdGiDrawable::DrawableType m_type
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 37 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiBackgroundTraitsData()

OdGiBackgroundTraitsData::OdGiBackgroundTraitsData ( )
inlineprotected

Definition at line 43 of file GiEnvironmentTraitsData.h.

Member Function Documentation

◆ deleteBackgroundTraitsData()

void OdGiBackgroundTraitsData::deleteBackgroundTraitsData ( OdGiBackgroundTraitsData pBackgroundTraits)
inlinestatic

Removes the specified background traits.

Parameters
pBackgroundTraits[in] Pointer to background traits.

Definition at line 1005 of file GiEnvironmentTraitsData.h.

◆ operator!=()

bool OdGiBackgroundTraitsData::operator!= ( const OdGiBackgroundTraitsData data2) const
inline

Checks whether the passed background traits do not have the same type as these background traits.

Parameters
data2[in] Background traits to compare.
Returns
true if background traits are not equal, false otherwise.

Definition at line 84 of file GiEnvironmentTraitsData.h.

◆ operator==()

bool OdGiBackgroundTraitsData::operator== ( const OdGiBackgroundTraitsData data2) const
inline

Checks whether the passed background traits have the same type as these background traits.

Parameters
data2[in] Background traits to compare.
Returns
true if background traits are equal, false otherwise.

Definition at line 71 of file GiEnvironmentTraitsData.h.

◆ type()

OdGiDrawable::DrawableType OdGiBackgroundTraitsData::type ( ) const
inline

Retrieves drawable type.

Returns
drawable type as value from the OdGiDrawable::DrawableType enumeration.

Definition at line 54 of file GiEnvironmentTraitsData.h.

Member Data Documentation

◆ m_type

OdGiDrawable::DrawableType OdGiBackgroundTraitsData::m_type
protected

Definition at line 40 of file GiEnvironmentTraitsData.h.


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