OdGiMaterialTextureEntry Class Reference

#include <GiMaterialItem.h>

Inheritance diagram for OdGiMaterialTextureEntry:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiMaterialTextureEntry)
virtual OdGiMaterialTextureDataPtr	textureData () const =0
virtual bool	isTextureInitialized () const =0
virtual OdUInt32	proceduralTextureWidth () const =0
virtual void	setProceduralTextureWidth (OdUInt32 width)=0
virtual OdUInt32	proceduralTextureHeight () const =0
virtual void	setProceduralTextureHeight (OdUInt32 height)=0
virtual void	setProceduralTextureResolution (OdUInt32 width, OdUInt32 height)=0
virtual double	proceduralTextureQuality () const =0
virtual void	setProceduralTextureQuality (double coef)=0
virtual bool	setGiMaterialTexture (OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, const OdGiMaterialMap &matMap, OdGiMaterialTextureManager *pManager=NULL)=0
virtual bool	setGiMaterialTexture (OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, OdGiMaterialTexturePtr pTexture, OdGiMaterialTextureManager *pManager=NULL)=0
virtual bool	setGiMaterialTexture (OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, const OdString &fileName, OdGiMaterialTextureManager *pManager=NULL)=0
virtual bool	setGiMaterialTexture (OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, double opacity, OdGiMaterialTextureManager *pManager=NULL)=0
virtual void	setTextureData (OdGiMaterialTextureData *pTextureData, OdGiMaterialTextureManager *pManager=NULL)=0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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 OdRxClass *	desc ()

Detailed Description

Material texture entry that contains, generates, and loads texture data.

See also

TD_Gi

<group OdGi_Classes>

Definition at line 523 of file GiMaterialItem.h.

Member Function Documentation

isTextureInitialized()

virtual bool OdGiMaterialTextureEntry::isTextureInitialized ( ) const

pure virtual

Checks whether the texture data is initialized.

Returns

true if texture data is initialized, false otherwise.

ODRX_DECLARE_MEMBERS()

OdGiMaterialTextureEntry::ODRX_DECLARE_MEMBERS

(

OdGiMaterialTextureEntry

)

proceduralTextureHeight()

virtual OdUInt32 OdGiMaterialTextureEntry::proceduralTextureHeight ( ) const

pure virtual

Retrieves the height of procedurally generated textures.

Returns

height of procedurally generated textures as OdUInt32 value.

proceduralTextureQuality()

virtual double OdGiMaterialTextureEntry::proceduralTextureQuality ( ) const

pure virtual

Retrieves the procedural textures quality coefficient.

Returns

procedural textures quality coefficient as a value of the double type.

proceduralTextureWidth()

virtual OdUInt32 OdGiMaterialTextureEntry::proceduralTextureWidth ( ) const

pure virtual

Retrieves the width of procedurally generated textures.

Returns

width of procedurally generated textures as OdUInt32 value.

setGiMaterialTexture() [1/4]

virtual bool OdGiMaterialTextureEntry::setGiMaterialTexture ( OdGiMaterialTextureData::DevDataVariant  pDeviceInfo, OdRxClass *  pTexDataImpl, const OdGiContext &  giCtx, const OdGiMaterialMap &  matMap, OdGiMaterialTextureManager *  pManager = NULL  )

pure virtual

Load texture from material map.

Parameters

pDeviceInfo	[in] Optional external device information.
pTexDataImpl	[in] Description of texture data class implementation (must not be NULL)
giCtx	[in] Gi context.
matMap	[in] Input material map reference.
pManager	[in] Optional textures manager.

Returns

true if either procedural texture or texture from file is set successfully, false otherwise.

setGiMaterialTexture() [2/4]

virtual bool OdGiMaterialTextureEntry::setGiMaterialTexture ( OdGiMaterialTextureData::DevDataVariant  pDeviceInfo, OdRxClass *  pTexDataImpl, const OdGiContext &  giCtx, const OdString &  fileName, OdGiMaterialTextureManager *  pManager = NULL  )

pure virtual

Load texture from raster file.

Parameters

pDeviceInfo	[in] Optional external device information.
pTexDataImpl	[in] Description of texture data class implementation (must not be NULL).
giCtx	[in] Gi context.
fileName	[in] Name of file that contains raster image.
pManager	[in] Optional textures manager.

Returns

true if texture is set successfully from the image file, false otherwise.

setGiMaterialTexture() [3/4]

virtual bool OdGiMaterialTextureEntry::setGiMaterialTexture ( OdGiMaterialTextureData::DevDataVariant  pDeviceInfo, OdRxClass *  pTexDataImpl, const OdGiContext &  giCtx, double  opacity, OdGiMaterialTextureManager *  pManager = NULL  )

pure virtual

Generate texture from material opacity value.

Parameters

pDeviceInfo	[in] Optional external device information.
pTexDataImpl	[in] Description of texture data class implementation (must not be NULL).
giCtx	[in] Gi context.
opacity	[in] Material opacity value (0.0 - 1.0).
pManager	[in] Optional textures manager.

Returns

true if texture is set successfully set, false otherwise.

setGiMaterialTexture() [4/4]

virtual bool OdGiMaterialTextureEntry::setGiMaterialTexture ( OdGiMaterialTextureData::DevDataVariant  pDeviceInfo, OdRxClass *  pTexDataImpl, const OdGiContext &  giCtx, OdGiMaterialTexturePtr  pTexture, OdGiMaterialTextureManager *  pManager = NULL  )

pure virtual

Load texture from material texture pointer.

Parameters

pDeviceInfo	[in] Optional external device information.
pTexDataImpl	[in] Description of texture data class implementation (must not be NULL).
giCtx	[in] Gi context.
pTexture	[in] Pointer to material texture.
pManager	[in] Optional textures manager.

Returns

true if either procedural texture or texture from file is set successfully, false otherwise.

setProceduralTextureHeight()

virtual void OdGiMaterialTextureEntry::setProceduralTextureHeight ( OdUInt32  height )

pure virtual

Set height of procedurally generated textures.

Parameters

height

[in] height of the generated textures.

setProceduralTextureQuality()

virtual void OdGiMaterialTextureEntry::setProceduralTextureQuality ( double  coef )

pure virtual

Sets procedural textures quality coefficient.

Parameters

coef	[in] textures quality coefficient.

setProceduralTextureResolution()

virtual void OdGiMaterialTextureEntry::setProceduralTextureResolution ( OdUInt32  width, OdUInt32  height  )

pure virtual

Set width and height of procedurally generated textures.

Parameters

width	[in] width of the generated textures.
height	[in] height of the generated textures.

setProceduralTextureWidth()

virtual void OdGiMaterialTextureEntry::setProceduralTextureWidth ( OdUInt32  width )

pure virtual

Set width of procedurally generated textures.

Parameters

width

[in] width of the generated textures.

setTextureData()

virtual void OdGiMaterialTextureEntry::setTextureData ( OdGiMaterialTextureData *  pTextureData, OdGiMaterialTextureManager *  pManager = NULL  )

pure virtual

Sets texture data explicitly.

Parameters

pTextureData	[in] Pointer to texture data.
pManager	[in] Optional textures manager.

textureData()

virtual OdGiMaterialTextureDataPtr OdGiMaterialTextureEntry::textureData ( ) const

pure virtual

Retrieves pointer to device-dependent texture data container.

Returns

smart pointer to the material texture data.

---

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

• GiMaterialItem.h