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

#include <GiMaterial.h>

Inheritance diagram for OdGiGenericTexture:
OdGiProceduralTexture OdGiMaterialTexture OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiGenericTexture)
 
 OdGiGenericTexture ()
 
virtual Type type () const
 
virtual void setDefinition (const OdGiVariant &definition)
 
virtual OdGiVariantPtr definition () const
 
virtual void definition (OdGiVariantPtr &pDefinition) const
 
virtual bool operator== (const OdGiMaterialTexture &texture) const
 
OdGiGenericTextureoperator= (const OdGiGenericTexture &texture)
 
void copyFrom (const OdRxObject *pSource)
 
- Public Member Functions inherited from OdGiProceduralTexture
 ODRX_DECLARE_MEMBERS (OdGiProceduralTexture)
 
virtual Type type () const =0
 
- Public Member Functions inherited from OdGiMaterialTexture
 ODRX_DECLARE_MEMBERS (OdGiMaterialTexture)
 
virtual bool operator== (const OdGiMaterialTexture &texture) const
 
- 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

- Public Types inherited from OdGiProceduralTexture
enum  Type { kWood = 0 , kMarble = 1 , kGeneric = 2 }
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdGiProceduralTexture
 OdGiProceduralTexture ()
 
 ~OdGiProceduralTexture ()
 
- Protected Member Functions inherited from OdGiMaterialTexture
 OdGiMaterialTexture ()
 
 ~OdGiMaterialTexture ()
 

Detailed Description

This class defines generic procedural material textures. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1426 of file GiMaterial.h.

Constructor & Destructor Documentation

◆ OdGiGenericTexture()

OdGiGenericTexture::OdGiGenericTexture ( )
inline

Default constructor for the OdGiGenericTexture class.

Definition at line 2603 of file GiMaterial.h.

Member Function Documentation

◆ copyFrom()

void OdGiGenericTexture::copyFrom ( const OdRxObject pSource)
inlinevirtual

Copies the data of the source object to the current object.

Parameters
pSource[in] Input source object.

Reimplemented from OdRxObject.

Definition at line 2662 of file GiMaterial.h.

◆ definition() [1/2]

OdGiVariantPtr OdGiGenericTexture::definition ( ) const
inlinevirtual

Retrieves the pointer to the OdGiVariant object used to store the procedural texture data.

Returns
smart pointer to the OdGiVariant object that holds the procedural texture data.

Definition at line 2621 of file GiMaterial.h.

◆ definition() [2/2]

void OdGiGenericTexture::definition ( OdGiVariantPtr pDefinition) const
inlinevirtual

Retrieves a copy of the OdGiVariant object used to store the procedural texture data.

Parameters
pDefinition[in] Smart pointer to the object from which procedural texture data is copied.

Definition at line 2627 of file GiMaterial.h.

◆ ODRX_DECLARE_MEMBERS()

OdGiGenericTexture::ODRX_DECLARE_MEMBERS ( OdGiGenericTexture  )

◆ operator=()

OdGiGenericTexture & OdGiGenericTexture::operator= ( const OdGiGenericTexture texture)
inline

Assignment operator for the OdGiGenericTexture class.

Parameters
texture[in] Texture to be assigned.
Returns
a reference to this generic texture.

Definition at line 2653 of file GiMaterial.h.

◆ operator==()

bool OdGiGenericTexture::operator== ( const OdGiMaterialTexture texture) const
inlinevirtual

Equality operator for the OdGiGenericTexture class. Textures are equal if: the specified texture is generic texture underlaying definition object that store texture data are equal

Parameters
texture[in] Texture to be compared.
Returns
true if the specified texture is equal to this texture, false otherwise.

Reimplemented from OdGiMaterialTexture.

Definition at line 2640 of file GiMaterial.h.

◆ setDefinition()

void OdGiGenericTexture::setDefinition ( const OdGiVariant definition)
inlinevirtual

Sets the new OdGiVariant value to this generic texture.

Parameters
definition[in] New OdGiVariant value.

Definition at line 2608 of file GiMaterial.h.

◆ type()

virtual Type OdGiGenericTexture::type ( ) const
inlinevirtual

Retrieves the type of the procedural texture.

Returns
the kGeneric value from the Type enumeration.

Implements OdGiProceduralTexture.

Definition at line 1441 of file GiMaterial.h.


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