CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdGiCustomBackgroundTraitsData Class Reference

#include <GiEnvironmentTraitsData.h>

Inheritance diagram for OdGiCustomBackgroundTraitsData:
OdGiBackgroundTraitsData

Public Member Functions

 OdGiCustomBackgroundTraitsData ()
 
 ~OdGiCustomBackgroundTraitsData ()
 
void setProperty (const OdChar *pName, const OdGiVariant *pData)
 
const OdGiVariantproperty (const OdChar *pName) const
 
bool operator== (const OdGiCustomBackgroundTraitsData &data2) const
 
bool operator!= (const OdGiCustomBackgroundTraitsData &data2) const
 
- Public Member Functions inherited from OdGiBackgroundTraitsData
OdGiDrawable::DrawableType type () const
 
bool operator== (const OdGiBackgroundTraitsData &data2) const
 
bool operator!= (const OdGiBackgroundTraitsData &data2) const
 

Protected Member Functions

void clear ()
 
bool compare (const OdGiCustomBackgroundTraitsData &data2) const
 
- Protected Member Functions inherited from OdGiBackgroundTraitsData
 OdGiBackgroundTraitsData ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OdGiBackgroundTraitsData
static void deleteBackgroundTraitsData (OdGiBackgroundTraitsData *pBackgroundTraits)
 
- Protected Attributes inherited from OdGiBackgroundTraitsData
OdGiDrawable::DrawableType m_type
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1151 of file GiEnvironmentTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiCustomBackgroundTraitsData()

OdGiCustomBackgroundTraitsData::OdGiCustomBackgroundTraitsData ( )
inline

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

Definition at line 1162 of file GiEnvironmentTraitsData.h.

◆ ~OdGiCustomBackgroundTraitsData()

OdGiCustomBackgroundTraitsData::~OdGiCustomBackgroundTraitsData ( )
inline

Destructor for the OdGiCustomBackgroundTraitsData class.

Definition at line 1168 of file GiEnvironmentTraitsData.h.

Member Function Documentation

◆ clear()

void OdGiCustomBackgroundTraitsData::clear ( )
protected

◆ compare()

bool OdGiCustomBackgroundTraitsData::compare ( const OdGiCustomBackgroundTraitsData & data2) const
protected

◆ operator!=()

bool OdGiCustomBackgroundTraitsData::operator!= ( const OdGiCustomBackgroundTraitsData & 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 1210 of file GiEnvironmentTraitsData.h.

◆ operator==()

bool OdGiCustomBackgroundTraitsData::operator== ( const OdGiCustomBackgroundTraitsData & data2) const
inline

Checks whether the passed traits for custom 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 1196 of file GiEnvironmentTraitsData.h.

◆ property()

const OdGiVariant * OdGiCustomBackgroundTraitsData::property ( const OdChar * pName) const

Retrieves custom background property value.

Parameters
pName[in] Property name.
Returns
Property data.

◆ setProperty()

void OdGiCustomBackgroundTraitsData::setProperty ( const OdChar * pName,
const OdGiVariant * pData )

Sets custom background property.

Parameters
pName[in] Property name.
pData[in] Property data.

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