CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiMaterialItem Class Referenceabstract

#include <GiMaterialItem.h>

Inheritance diagram for OdGiMaterialItem:
OdRxObject OdGiMaterialRenderItem

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiMaterialItem)
 
virtual OdGiMaterialTextureEntryPtr diffuseTexture () const =0
 
virtual OdGiMaterialTextureEntryPtr diffuseTexture ()=0
 
virtual OdGiMaterialTextureEntryPtr createDiffuseTexture ()=0
 
virtual void removeDiffuseTexture ()=0
 
virtual bool haveDiffuseTexture () const =0
 
virtual OdRxObjectPtr cachedData () const =0
 
virtual void setCachedData (OdRxObjectPtr data)=0
 
virtual const OdDbStub * materialId () const =0
 
virtual void setMaterialId (const OdDbStub *matId=NULL)=0
 
virtual bool isMaterialIdValid (const OdDbStub *matId)=0
 
- 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 ()
 

Detailed Description

Container item for material data storage.

See also
TD_Gi

<group OdGi_Classes>

Definition at line 652 of file GiMaterialItem.h.

Member Function Documentation

◆ cachedData()

virtual OdRxObjectPtr OdGiMaterialItem::cachedData ( ) const
pure virtual

Retrieves pointer to cached data object.

Returns
smart pointer to the OdRxObject cache.

◆ createDiffuseTexture()

virtual OdGiMaterialTextureEntryPtr OdGiMaterialItem::createDiffuseTexture ( )
pure virtual

Creates and returns diffuse texture pointer.

Returns
smart pointer to the created diffuse texture.

◆ diffuseTexture() [1/2]

virtual OdGiMaterialTextureEntryPtr OdGiMaterialItem::diffuseTexture ( ) const
pure virtual

Retrieves diffuse texture pointer.

Returns
smart pointer to the diffuse texture.

◆ diffuseTexture() [2/2]

virtual OdGiMaterialTextureEntryPtr OdGiMaterialItem::diffuseTexture ( )
pure virtual

Retrieves diffuse texture pointer.

Returns
smart pointer to the diffuse texture.

◆ haveDiffuseTexture()

virtual bool OdGiMaterialItem::haveDiffuseTexture ( ) const
pure virtual

Checks whether the diffuse texture is created.

Returns
true if this material item has a diffuse texture, false otherwise.

◆ isMaterialIdValid()

virtual bool OdGiMaterialItem::isMaterialIdValid ( const OdDbStub *  matId)
pure virtual

Checks whether stored material ID is equal to matId.

Returns
true if the specified material ID is equal to this material ID, false otherwise.

◆ materialId()

virtual const OdDbStub * OdGiMaterialItem::materialId ( ) const
pure virtual

Retrieves material ID.

Returns
pointer to the material identifier.

◆ ODRX_DECLARE_MEMBERS()

OdGiMaterialItem::ODRX_DECLARE_MEMBERS ( OdGiMaterialItem  )

◆ removeDiffuseTexture()

virtual void OdGiMaterialItem::removeDiffuseTexture ( )
pure virtual

Destroys diffuse texture.

◆ setCachedData()

virtual void OdGiMaterialItem::setCachedData ( OdRxObjectPtr  data)
pure virtual

Set pointer to cached data object.

Parameters
data[in] Pointer to cached data.

◆ setMaterialId()

virtual void OdGiMaterialItem::setMaterialId ( const OdDbStub *  matId = NULL)
pure virtual

Set material ID.

Parameters
matId[in] Pointer to the material identifier.

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