OdGiMaterialMap Class Reference

#include <GiMaterial.h>

Public Types
enum	Source { kScene = 0 , kFile = 1 , kProcedural = 2 }

Public Member Functions
	OdGiMaterialMap ()
void	setSource (Source source)
void	setSourceFileName (const OdString &filename)
void	setBlendFactor (double blendFactor)
void	setTexture (OdGiMaterialTexturePtr pTexture)
OdGiMapper &	mapper ()
Source	source () const
OdString	sourceFileName () const
double	blendFactor () const
const OdGiMapper &	mapper () const
void	setMapper (const OdGiMapper &mapper)
const OdGiMaterialTexturePtr	texture (void) const
bool	operator== (const OdGiMaterialMap &other) const
bool	operator!= (const OdGiMaterialMap &other) const
OdGiMaterialMap &	operator= (const OdGiMaterialMap &mmap)

Static Public Attributes
static ODGI_EXPORT_STATIC const OdGiMaterialMap	kNull

Detailed Description

This class implements material maps.

Remarks

Material maps define bitmapped images that are applied to object surfaces.

<group OdGi_Classes>

Definition at line 1361 of file GiMaterial.h.

Member Enumeration Documentation

Source

enum OdGiMaterialMap::Source

Describes the image source of this MaterialMap object.

Enumerator
kScene
kFile
kProcedural

Definition at line 1368 of file GiMaterial.h.

Constructor & Destructor Documentation

OdGiMaterialMap()

OdGiMaterialMap::OdGiMaterialMap ( )

inline

Definition at line 1572 of file GiMaterial.h.

Member Function Documentation

blendFactor()

double OdGiMaterialMap::blendFactor ( ) const

inline

Returns the blend factor for this MaterialMap object.

Remarks

A blend factor of 0.0 makes the MaterialMap invisible. A blend factor of 1.0 makes it opaque. In between, the MaterialMap is transparent.

Definition at line 1615 of file GiMaterial.h.

mapper() [1/2]

OdGiMapper & OdGiMaterialMap::mapper ( )

inline

Returns a reference to, or a copy of, the OdGiMapper for this MaterialMap object.

Remarks

The transform matrix defines mapping of an OdGiMaterialMap image when applied to the surface of an object.

Definition at line 1597 of file GiMaterial.h.

mapper() [2/2]

const OdGiMapper & OdGiMaterialMap::mapper ( ) const

inline

Returns a reference to the OdGiMapper for this MaterialMap object.

Definition at line 1621 of file GiMaterial.h.

operator!=()

bool OdGiMaterialMap::operator!= ( const OdGiMaterialMap &  other ) const

inline

Definition at line 1488 of file GiMaterial.h.

operator=()

OdGiMaterialMap& OdGiMaterialMap::operator= ( const OdGiMaterialMap &  mmap )

inline

Definition at line 1493 of file GiMaterial.h.

operator==()

bool OdGiMaterialMap::operator== ( const OdGiMaterialMap &  other ) const

inline

Definition at line 1474 of file GiMaterial.h.

setBlendFactor()

void OdGiMaterialMap::setBlendFactor ( double  blendFactor )

inline

Sets the blend factor for this MaterialMap object.

Parameters

blendFactor

[in] Blend factor.

Remarks

A blend factor of 0.0 makes the MaterialMap invisible. A blend factor of 1.0 makes it opaque. In between, the MaterialMap is transparent.

Definition at line 1591 of file GiMaterial.h.

setMapper()

void OdGiMaterialMap::setMapper ( const OdGiMapper &  mapper )

inline

Sets the OdGiMapper for this MaterialMap object.

Parameters

mapper

[in] OdGiMapper reference.

Definition at line 1627 of file GiMaterial.h.

setSource()

void OdGiMaterialMap::setSource ( Source  source )

inline

Sets the image source for this MaterialMap object.

Parameters

source

[in] Image source.

Remarks

Source must be one of the following:

Value Description kScene 0 Image is created from the current scene. kFile 1 Image is from a file. kProcedural 2 Image is procedurally generated.

Definition at line 1579 of file GiMaterial.h.

setSourceFileName()

void OdGiMaterialMap::setSourceFileName ( const OdString &  filename )

inline

Sets the source filename for this MaterialMap object.

Parameters

filename

[in] Source filename.

Definition at line 1585 of file GiMaterial.h.

setTexture()

void OdGiMaterialMap::setTexture ( OdGiMaterialTexturePtr  pTexture )

inline

Sets the material texture for this MaterialMap object.

Parameters

pTexture

[in] Material texture.

Definition at line 1633 of file GiMaterial.h.

source()

OdGiMaterialMap::Source OdGiMaterialMap::source ( ) const

inline

Returns the image source for this MaterialMap object.

Remarks

Source must be one of the following:

Value Description kScene 0 Image is created from the current scene. kFile 1 Image is from a file. kProcedural 2 Image is procedurally generated.

Definition at line 1603 of file GiMaterial.h.

sourceFileName()

OdString OdGiMaterialMap::sourceFileName ( ) const

inline

Returns the source filename for this MaterialMap object.

Definition at line 1609 of file GiMaterial.h.

texture()

const OdGiMaterialTexturePtr OdGiMaterialMap::texture ( void  ) const

inline

Returns the material texture for this MaterialMap object.

Definition at line 1639 of file GiMaterial.h.

Member Data Documentation

kNull

ODGI_EXPORT_STATIC const OdGiMaterialMap OdGiMaterialMap::kNull

static

Definition at line 1375 of file GiMaterial.h.

---

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

• GiMaterial.h